blob: af6f1816ae8c1f02f457f0ee9974ab5f3c649e82 [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;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010020import android.provider.MediaStore;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070021import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070022
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070023import org.xmlpull.v1.XmlPullParser;
24import org.xmlpull.v1.XmlPullParserException;
25
Tor Norbyed9273d62013-05-30 15:59:53 -070026import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070027import android.annotation.SdkConstant;
Jose Lima73915cf2014-07-29 17:16:31 -070028import android.annotation.SystemApi;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070029import android.annotation.SdkConstant.SdkConstantType;
30import android.content.pm.ActivityInfo;
Jose Lima73915cf2014-07-29 17:16:31 -070031
Nicolas Prevotd85fc722014-04-16 19:52:08 +010032import static android.content.ContentProvider.maybeAddUserId;
Jose Lima73915cf2014-07-29 17:16:31 -070033
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070034import android.content.pm.PackageManager;
35import android.content.pm.ResolveInfo;
36import android.content.res.Resources;
37import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080038import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039import android.net.Uri;
40import android.os.Bundle;
41import android.os.IBinder;
42import android.os.Parcel;
43import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070044import android.os.StrictMode;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +010045import android.os.UserHandle;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070046import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070047import android.provider.DocumentsProvider;
48import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070049import android.util.AttributeSet;
50import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080051
52import com.android.internal.util.XmlUtils;
Jose Lima73915cf2014-07-29 17:16:31 -070053
Craig Mautner21d24a22014-04-23 11:45:37 -070054import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070055
56import java.io.IOException;
57import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070058import java.lang.annotation.Retention;
59import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070060import java.net.URISyntaxException;
61import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070062import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080063import java.util.Locale;
Christopher Tate63d9ae12014-06-19 19:07:26 -070064import java.util.Objects;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070065import java.util.Set;
66
67/**
68 * An intent is an abstract description of an operation to be performed. It
69 * can be used with {@link Context#startActivity(Intent) startActivity} to
70 * launch an {@link android.app.Activity},
71 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
72 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
73 * and {@link android.content.Context#startService} or
74 * {@link android.content.Context#bindService} to communicate with a
75 * background {@link android.app.Service}.
76 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070077 * <p>An Intent provides a facility for performing late runtime binding between the code in
78 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070079 * can be thought of as the glue between activities. It is basically a passive data structure
80 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070081 *
82 * <div class="special reference">
83 * <h3>Developer Guides</h3>
84 * <p>For information about how to create and resolve intents, read the
85 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
86 * developer guide.</p>
87 * </div>
88 *
89 * <a name="IntentStructure"></a>
90 * <h3>Intent Structure</h3>
91 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070092 *
93 * <ul>
94 * <li> <p><b>action</b> -- The general action to be performed, such as
95 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
96 * etc.</p>
97 * </li>
98 * <li> <p><b>data</b> -- The data to operate on, such as a person record
99 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
100 * </li>
101 * </ul>
102 *
103 *
104 * <p>Some examples of action/data pairs are:</p>
105 *
106 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700107 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700108 * information about the person whose identifier is "1".</p>
109 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700110 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700111 * the phone dialer with the person filled in.</p>
112 * </li>
113 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
114 * the phone dialer with the given number filled in. Note how the
115 * VIEW action does what what is considered the most reasonable thing for
116 * a particular URI.</p>
117 * </li>
118 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
119 * the phone dialer with the given number filled in.</p>
120 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700121 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700122 * information about the person whose identifier is "1".</p>
123 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700124 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700125 * a list of people, which the user can browse through. This example is a
126 * typical top-level entry into the Contacts application, showing you the
127 * list of people. Selecting a particular person to view would result in a
128 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
129 * being used to start an activity to display that person.</p>
130 * </li>
131 * </ul>
132 *
133 * <p>In addition to these primary attributes, there are a number of secondary
134 * attributes that you can also include with an intent:</p>
135 *
136 * <ul>
137 * <li> <p><b>category</b> -- Gives additional information about the action
138 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
139 * appear in the Launcher as a top-level application, while
140 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
141 * of alternative actions the user can perform on a piece of data.</p>
142 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
143 * intent data. Normally the type is inferred from the data itself.
144 * By setting this attribute, you disable that evaluation and force
145 * an explicit type.</p>
146 * <li> <p><b>component</b> -- Specifies an explicit name of a component
147 * class to use for the intent. Normally this is determined by looking
148 * at the other information in the intent (the action, data/type, and
149 * categories) and matching that with a component that can handle it.
150 * If this attribute is set then none of the evaluation is performed,
151 * and this component is used exactly as is. By specifying this attribute,
152 * all of the other Intent attributes become optional.</p>
153 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
154 * This can be used to provide extended information to the component.
155 * For example, if we have a action to send an e-mail message, we could
156 * also include extra pieces of data here to supply a subject, body,
157 * etc.</p>
158 * </ul>
159 *
160 * <p>Here are some examples of other operations you can specify as intents
161 * using these additional parameters:</p>
162 *
163 * <ul>
164 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
165 * Launch the home screen.</p>
166 * </li>
167 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
168 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
169 * vnd.android.cursor.item/phone}</i></b>
170 * -- Display the list of people's phone numbers, allowing the user to
171 * browse through them and pick one and return it to the parent activity.</p>
172 * </li>
173 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
174 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
175 * -- Display all pickers for data that can be opened with
176 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
177 * allowing the user to pick one of them and then some data inside of it
178 * and returning the resulting URI to the caller. This can be used,
179 * for example, in an e-mail application to allow the user to pick some
180 * data to include as an attachment.</p>
181 * </li>
182 * </ul>
183 *
184 * <p>There are a variety of standard Intent action and category constants
185 * defined in the Intent class, but applications can also define their own.
186 * These strings use java style scoping, to ensure they are unique -- for
187 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700188 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700189 *
190 * <p>Put together, the set of actions, data types, categories, and extra data
191 * defines a language for the system allowing for the expression of phrases
192 * such as "call john smith's cell". As applications are added to the system,
193 * they can extend this language by adding new actions, types, and categories, or
194 * they can modify the behavior of existing phrases by supplying their own
195 * activities that handle them.</p>
196 *
197 * <a name="IntentResolution"></a>
198 * <h3>Intent Resolution</h3>
199 *
200 * <p>There are two primary forms of intents you will use.
201 *
202 * <ul>
203 * <li> <p><b>Explicit Intents</b> have specified a component (via
204 * {@link #setComponent} or {@link #setClass}), which provides the exact
205 * class to be run. Often these will not include any other information,
206 * simply being a way for an application to launch various internal
207 * activities it has as the user interacts with the application.
208 *
209 * <li> <p><b>Implicit Intents</b> have not specified a component;
210 * instead, they must include enough information for the system to
211 * determine which of the available components is best to run for that
212 * intent.
213 * </ul>
214 *
215 * <p>When using implicit intents, given such an arbitrary intent we need to
216 * know what to do with it. This is handled by the process of <em>Intent
217 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
218 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
219 * more activities/receivers) that can handle it.</p>
220 *
221 * <p>The intent resolution mechanism basically revolves around matching an
222 * Intent against all of the &lt;intent-filter&gt; descriptions in the
223 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
224 * objects explicitly registered with {@link Context#registerReceiver}.) More
225 * details on this can be found in the documentation on the {@link
226 * IntentFilter} class.</p>
227 *
228 * <p>There are three pieces of information in the Intent that are used for
229 * resolution: the action, type, and category. Using this information, a query
230 * is done on the {@link PackageManager} for a component that can handle the
231 * intent. The appropriate component is determined based on the intent
232 * information supplied in the <code>AndroidManifest.xml</code> file as
233 * follows:</p>
234 *
235 * <ul>
236 * <li> <p>The <b>action</b>, if given, must be listed by the component as
237 * one it handles.</p>
238 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
239 * already supplied in the Intent. Like the action, if a type is
240 * included in the intent (either explicitly or implicitly in its
241 * data), then this must be listed by the component as one it handles.</p>
242 * <li> For data that is not a <code>content:</code> URI and where no explicit
243 * type is included in the Intent, instead the <b>scheme</b> of the
244 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
245 * considered. Again like the action, if we are matching a scheme it
246 * must be listed by the component as one it can handle.
247 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
248 * by the activity as categories it handles. That is, if you include
249 * the categories {@link #CATEGORY_LAUNCHER} and
250 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
251 * with an intent that lists <em>both</em> of those categories.
252 * Activities will very often need to support the
253 * {@link #CATEGORY_DEFAULT} so that they can be found by
254 * {@link Context#startActivity Context.startActivity()}.</p>
255 * </ul>
256 *
257 * <p>For example, consider the Note Pad sample application that
258 * allows user to browse through a list of notes data and view details about
259 * individual items. Text in italics indicate places were you would replace a
260 * name with one specific to your own package.</p>
261 *
262 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
263 * package="<i>com.android.notepad</i>"&gt;
264 * &lt;application android:icon="@drawable/app_notes"
265 * android:label="@string/app_name"&gt;
266 *
267 * &lt;provider class=".NotePadProvider"
268 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
269 *
270 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
271 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700272 * &lt;action android:name="android.intent.action.MAIN" /&gt;
273 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700274 * &lt;/intent-filter&gt;
275 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700276 * &lt;action android:name="android.intent.action.VIEW" /&gt;
277 * &lt;action android:name="android.intent.action.EDIT" /&gt;
278 * &lt;action android:name="android.intent.action.PICK" /&gt;
279 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
280 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700281 * &lt;/intent-filter&gt;
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
284 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
285 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 * &lt;/activity&gt;
288 *
289 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
290 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700291 * &lt;action android:name="android.intent.action.VIEW" /&gt;
292 * &lt;action android:name="android.intent.action.EDIT" /&gt;
293 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 *
297 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700298 * &lt;action android:name="android.intent.action.INSERT" /&gt;
299 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
300 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700301 * &lt;/intent-filter&gt;
302 *
303 * &lt;/activity&gt;
304 *
305 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
306 * android:theme="@android:style/Theme.Dialog"&gt;
307 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
309 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
310 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
311 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
312 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700313 * &lt;/intent-filter&gt;
314 * &lt;/activity&gt;
315 *
316 * &lt;/application&gt;
317 * &lt;/manifest&gt;</pre>
318 *
319 * <p>The first activity,
320 * <code>com.android.notepad.NotesList</code>, serves as our main
321 * entry into the app. It can do three things as described by its three intent
322 * templates:
323 * <ol>
324 * <li><pre>
325 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700326 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
327 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700328 * &lt;/intent-filter&gt;</pre>
329 * <p>This provides a top-level entry into the NotePad application: the standard
330 * MAIN action is a main entry point (not requiring any other information in
331 * the Intent), and the LAUNCHER category says that this entry point should be
332 * listed in the application launcher.</p>
333 * <li><pre>
334 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700335 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
336 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
337 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
338 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
339 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700340 * &lt;/intent-filter&gt;</pre>
341 * <p>This declares the things that the activity can do on a directory of
342 * notes. The type being supported is given with the &lt;type&gt; tag, where
343 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
344 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
345 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
346 * The activity allows the user to view or edit the directory of data (via
347 * the VIEW and EDIT actions), or to pick a particular note and return it
348 * to the caller (via the PICK action). Note also the DEFAULT category
349 * supplied here: this is <em>required</em> for the
350 * {@link Context#startActivity Context.startActivity} method to resolve your
351 * activity when its component name is not explicitly specified.</p>
352 * <li><pre>
353 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700354 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
355 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
356 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700357 * &lt;/intent-filter&gt;</pre>
358 * <p>This filter describes the ability return to the caller a note selected by
359 * the user without needing to know where it came from. The data type
360 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
361 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
362 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
363 * The GET_CONTENT action is similar to the PICK action, where the activity
364 * will return to its caller a piece of data selected by the user. Here,
365 * however, the caller specifies the type of data they desire instead of
366 * the type of data the user will be picking from.</p>
367 * </ol>
368 *
369 * <p>Given these capabilities, the following intents will resolve to the
370 * NotesList activity:</p>
371 *
372 * <ul>
373 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
374 * activities that can be used as top-level entry points into an
375 * application.</p>
376 * <li> <p><b>{ action=android.app.action.MAIN,
377 * category=android.app.category.LAUNCHER }</b> is the actual intent
378 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700379 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700380 * data=content://com.google.provider.NotePad/notes }</b>
381 * displays a list of all the notes under
382 * "content://com.google.provider.NotePad/notes", which
383 * the user can browse through and see the details on.</p>
384 * <li> <p><b>{ action=android.app.action.PICK
385 * data=content://com.google.provider.NotePad/notes }</b>
386 * provides a list of the notes under
387 * "content://com.google.provider.NotePad/notes", from which
388 * the user can pick a note whose data URL is returned back to the caller.</p>
389 * <li> <p><b>{ action=android.app.action.GET_CONTENT
390 * type=vnd.android.cursor.item/vnd.google.note }</b>
391 * is similar to the pick action, but allows the caller to specify the
392 * kind of data they want back so that the system can find the appropriate
393 * activity to pick something of that data type.</p>
394 * </ul>
395 *
396 * <p>The second activity,
397 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
398 * note entry and allows them to edit it. It can do two things as described
399 * by its two intent templates:
400 * <ol>
401 * <li><pre>
402 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700403 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
404 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
405 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
406 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700407 * &lt;/intent-filter&gt;</pre>
408 * <p>The first, primary, purpose of this activity is to let the user interact
409 * with a single note, as decribed by the MIME type
410 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
411 * either VIEW a note or allow the user to EDIT it. Again we support the
412 * DEFAULT category to allow the activity to be launched without explicitly
413 * specifying its component.</p>
414 * <li><pre>
415 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700416 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
417 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
418 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700419 * &lt;/intent-filter&gt;</pre>
420 * <p>The secondary use of this activity is to insert a new note entry into
421 * an existing directory of notes. This is used when the user creates a new
422 * note: the INSERT action is executed on the directory of notes, causing
423 * this activity to run and have the user create the new note data which
424 * it then adds to the content provider.</p>
425 * </ol>
426 *
427 * <p>Given these capabilities, the following intents will resolve to the
428 * NoteEditor activity:</p>
429 *
430 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700431 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700432 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
433 * shows the user the content of note <var>{ID}</var>.</p>
434 * <li> <p><b>{ action=android.app.action.EDIT
435 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
436 * allows the user to edit the content of note <var>{ID}</var>.</p>
437 * <li> <p><b>{ action=android.app.action.INSERT
438 * data=content://com.google.provider.NotePad/notes }</b>
439 * creates a new, empty note in the notes list at
440 * "content://com.google.provider.NotePad/notes"
441 * and allows the user to edit it. If they keep their changes, the URI
442 * of the newly created note is returned to the caller.</p>
443 * </ul>
444 *
445 * <p>The last activity,
446 * <code>com.android.notepad.TitleEditor</code>, allows the user to
447 * edit the title of a note. This could be implemented as a class that the
448 * application directly invokes (by explicitly setting its component in
449 * the Intent), but here we show a way you can publish alternative
450 * operations on existing data:</p>
451 *
452 * <pre>
453 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700454 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
455 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
456 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
457 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
458 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700459 * &lt;/intent-filter&gt;</pre>
460 *
461 * <p>In the single intent template here, we
462 * have created our own private action called
463 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
464 * edit the title of a note. It must be invoked on a specific note
465 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
466 * view and edit actions, but here displays and edits the title contained
467 * in the note data.
468 *
469 * <p>In addition to supporting the default category as usual, our title editor
470 * also supports two other standard categories: ALTERNATIVE and
471 * SELECTED_ALTERNATIVE. Implementing
472 * these categories allows others to find the special action it provides
473 * without directly knowing about it, through the
474 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
475 * more often to build dynamic menu items with
476 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
477 * template here was also supply an explicit name for the template
478 * (via <code>android:label="@string/resolve_title"</code>) to better control
479 * what the user sees when presented with this activity as an alternative
480 * action to the data they are viewing.
481 *
482 * <p>Given these capabilities, the following intent will resolve to the
483 * TitleEditor activity:</p>
484 *
485 * <ul>
486 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
487 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
488 * displays and allows the user to edit the title associated
489 * with note <var>{ID}</var>.</p>
490 * </ul>
491 *
492 * <h3>Standard Activity Actions</h3>
493 *
494 * <p>These are the current standard actions that Intent defines for launching
495 * activities (usually through {@link Context#startActivity}. The most
496 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
497 * {@link #ACTION_EDIT}.
498 *
499 * <ul>
500 * <li> {@link #ACTION_MAIN}
501 * <li> {@link #ACTION_VIEW}
502 * <li> {@link #ACTION_ATTACH_DATA}
503 * <li> {@link #ACTION_EDIT}
504 * <li> {@link #ACTION_PICK}
505 * <li> {@link #ACTION_CHOOSER}
506 * <li> {@link #ACTION_GET_CONTENT}
507 * <li> {@link #ACTION_DIAL}
508 * <li> {@link #ACTION_CALL}
509 * <li> {@link #ACTION_SEND}
510 * <li> {@link #ACTION_SENDTO}
511 * <li> {@link #ACTION_ANSWER}
512 * <li> {@link #ACTION_INSERT}
513 * <li> {@link #ACTION_DELETE}
514 * <li> {@link #ACTION_RUN}
515 * <li> {@link #ACTION_SYNC}
516 * <li> {@link #ACTION_PICK_ACTIVITY}
517 * <li> {@link #ACTION_SEARCH}
518 * <li> {@link #ACTION_WEB_SEARCH}
519 * <li> {@link #ACTION_FACTORY_TEST}
520 * </ul>
521 *
522 * <h3>Standard Broadcast Actions</h3>
523 *
524 * <p>These are the current standard actions that Intent defines for receiving
525 * broadcasts (usually through {@link Context#registerReceiver} or a
526 * &lt;receiver&gt; tag in a manifest).
527 *
528 * <ul>
529 * <li> {@link #ACTION_TIME_TICK}
530 * <li> {@link #ACTION_TIME_CHANGED}
531 * <li> {@link #ACTION_TIMEZONE_CHANGED}
532 * <li> {@link #ACTION_BOOT_COMPLETED}
533 * <li> {@link #ACTION_PACKAGE_ADDED}
534 * <li> {@link #ACTION_PACKAGE_CHANGED}
535 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800536 * <li> {@link #ACTION_PACKAGE_RESTARTED}
537 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700538 * <li> {@link #ACTION_UID_REMOVED}
539 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700540 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700541 * <li> {@link #ACTION_POWER_DISCONNECTED}
542 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * </ul>
544 *
545 * <h3>Standard Categories</h3>
546 *
547 * <p>These are the current standard categories that can be used to further
548 * clarify an Intent via {@link #addCategory}.
549 *
550 * <ul>
551 * <li> {@link #CATEGORY_DEFAULT}
552 * <li> {@link #CATEGORY_BROWSABLE}
553 * <li> {@link #CATEGORY_TAB}
554 * <li> {@link #CATEGORY_ALTERNATIVE}
555 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
556 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800557 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700558 * <li> {@link #CATEGORY_HOME}
559 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700560 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400561 * <li> {@link #CATEGORY_CAR_DOCK}
562 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #CATEGORY_LE_DESK_DOCK}
564 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200565 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700566 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700567 * </ul>
568 *
569 * <h3>Standard Extra Data</h3>
570 *
571 * <p>These are the current standard fields that can be used as extra data via
572 * {@link #putExtra}.
573 *
574 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_ALARM_COUNT}
576 * <li> {@link #EXTRA_BCC}
577 * <li> {@link #EXTRA_CC}
578 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
579 * <li> {@link #EXTRA_DATA_REMOVED}
580 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500581 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
582 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_DOCK_STATE_CAR}
584 * <li> {@link #EXTRA_DOCK_STATE_DESK}
585 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
586 * <li> {@link #EXTRA_DONT_KILL_APP}
587 * <li> {@link #EXTRA_EMAIL}
588 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700589 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800590 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700591 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800592 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700593 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800594 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
595 * <li> {@link #EXTRA_REPLACING}
596 * <li> {@link #EXTRA_SHORTCUT_ICON}
597 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
598 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800600 * <li> {@link #EXTRA_SHORTCUT_NAME}
601 * <li> {@link #EXTRA_SUBJECT}
602 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700603 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800604 * <li> {@link #EXTRA_TITLE}
605 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 * </ul>
607 *
608 * <h3>Flags</h3>
609 *
610 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800611 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
612 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800614public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700615 private static final String ATTR_ACTION = "action";
616 private static final String TAG_CATEGORIES = "categories";
617 private static final String ATTR_CATEGORY = "category";
618 private static final String TAG_EXTRA = "extra";
619 private static final String ATTR_TYPE = "type";
620 private static final String ATTR_COMPONENT = "component";
621 private static final String ATTR_DATA = "data";
622 private static final String ATTR_FLAGS = "flags";
623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 // ---------------------------------------------------------------------
625 // ---------------------------------------------------------------------
626 // Standard intent activity actions (see action variable).
627
628 /**
629 * Activity Action: Start as a main entry point, does not expect to
630 * receive data.
631 * <p>Input: nothing
632 * <p>Output: nothing
633 */
634 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
635 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700637 /**
638 * Activity Action: Display the data to the user. This is the most common
639 * action performed on data -- it is the generic action you can use on
640 * a piece of data to get the most reasonable thing to occur. For example,
641 * when used on a contacts entry it will view the entry; when used on a
642 * mailto: URI it will bring up a compose window filled with the information
643 * supplied by the URI; when used with a tel: URI it will invoke the
644 * dialer.
645 * <p>Input: {@link #getData} is URI from which to retrieve data.
646 * <p>Output: nothing.
647 */
648 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
649 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800650
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700651 /**
652 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
653 * performed on a piece of data.
654 */
655 public static final String ACTION_DEFAULT = 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 * Used to indicate that some piece of data should be attached to some other
659 * place. For example, image data could be attached to a contact. It is up
660 * to the recipient to decide where the data should be attached; the intent
661 * does not specify the ultimate destination.
662 * <p>Input: {@link #getData} is URI of data to be attached.
663 * <p>Output: nothing.
664 */
665 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
666 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800667
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700668 /**
669 * Activity Action: Provide explicit editable access to the given data.
670 * <p>Input: {@link #getData} is URI of data to be edited.
671 * <p>Output: nothing.
672 */
673 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
674 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700676 /**
677 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
678 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
679 * The extras can contain type specific data to pass through to the editing/creating
680 * activity.
681 * <p>Output: The URI of the item that was picked. This must be a content:
682 * URI so that any receiver can access it.
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800686
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700687 /**
688 * Activity Action: Pick an item from the data, returning what was selected.
689 * <p>Input: {@link #getData} is URI containing a directory of data
690 * (vnd.android.cursor.dir/*) from which to pick an item.
691 * <p>Output: The URI of the item that was picked.
692 */
693 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
694 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800695
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700696 /**
697 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800698 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700699 * <p>Output: An Intent representing the shortcut. The intent must contain three
700 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
701 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800702 * (value: ShortcutIconResource).</p>
703 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700704 * @see #EXTRA_SHORTCUT_INTENT
705 * @see #EXTRA_SHORTCUT_NAME
706 * @see #EXTRA_SHORTCUT_ICON
707 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
708 * @see android.content.Intent.ShortcutIconResource
709 */
710 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
711 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
712
713 /**
714 * The name of the extra used to define the Intent of a shortcut.
715 *
716 * @see #ACTION_CREATE_SHORTCUT
717 */
718 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
719 /**
720 * The name of the extra used to define the name of a shortcut.
721 *
722 * @see #ACTION_CREATE_SHORTCUT
723 */
724 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
725 /**
726 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
727 *
728 * @see #ACTION_CREATE_SHORTCUT
729 */
730 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
731 /**
732 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
733 *
734 * @see #ACTION_CREATE_SHORTCUT
735 * @see android.content.Intent.ShortcutIconResource
736 */
737 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
738 "android.intent.extra.shortcut.ICON_RESOURCE";
739
740 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800741 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700742 *
743 * @see Intent#ACTION_CREATE_SHORTCUT
744 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800745 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
746 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700747 */
748 public static class ShortcutIconResource implements Parcelable {
749 /**
750 * The package name of the application containing the icon.
751 */
752 public String packageName;
753
754 /**
755 * The resource name of the icon, including package, name and type.
756 */
757 public String resourceName;
758
759 /**
760 * Creates a new ShortcutIconResource for the specified context and resource
761 * identifier.
762 *
763 * @param context The context of the application.
764 * @param resourceId The resource idenfitier for the icon.
765 * @return A new ShortcutIconResource with the specified's context package name
766 * and icon resource idenfitier.
767 */
768 public static ShortcutIconResource fromContext(Context context, int resourceId) {
769 ShortcutIconResource icon = new ShortcutIconResource();
770 icon.packageName = context.getPackageName();
771 icon.resourceName = context.getResources().getResourceName(resourceId);
772 return icon;
773 }
774
775 /**
776 * Used to read a ShortcutIconResource from a Parcel.
777 */
778 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
779 new Parcelable.Creator<ShortcutIconResource>() {
780
781 public ShortcutIconResource createFromParcel(Parcel source) {
782 ShortcutIconResource icon = new ShortcutIconResource();
783 icon.packageName = source.readString();
784 icon.resourceName = source.readString();
785 return icon;
786 }
787
788 public ShortcutIconResource[] newArray(int size) {
789 return new ShortcutIconResource[size];
790 }
791 };
792
793 /**
794 * No special parcel contents.
795 */
796 public int describeContents() {
797 return 0;
798 }
799
800 public void writeToParcel(Parcel dest, int flags) {
801 dest.writeString(packageName);
802 dest.writeString(resourceName);
803 }
804
805 @Override
806 public String toString() {
807 return resourceName;
808 }
809 }
810
811 /**
812 * Activity Action: Display an activity chooser, allowing the user to pick
813 * what they want to before proceeding. This can be used as an alternative
814 * to the standard activity picker that is displayed by the system when
815 * you try to start an activity with multiple possible matches, with these
816 * differences in behavior:
817 * <ul>
818 * <li>You can specify the title that will appear in the activity chooser.
819 * <li>The user does not have the option to make one of the matching
820 * activities a preferred activity, and all possible activities will
821 * always be shown even if one of them is currently marked as the
822 * preferred activity.
823 * </ul>
824 * <p>
825 * This action should be used when the user will naturally expect to
826 * select an activity in order to proceed. An example if when not to use
827 * it is when the user clicks on a "mailto:" link. They would naturally
828 * expect to go directly to their mail app, so startActivity() should be
829 * called directly: it will
830 * either launch the current preferred app, or put up a dialog allowing the
831 * user to pick an app to use and optionally marking that as preferred.
832 * <p>
833 * In contrast, if the user is selecting a menu item to send a picture
834 * they are viewing to someone else, there are many different things they
835 * may want to do at this point: send it through e-mail, upload it to a
836 * web service, etc. In this case the CHOOSER action should be used, to
837 * always present to the user a list of the things they can do, with a
838 * nice title given by the caller such as "Send this photo with:".
839 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700840 * If you need to grant URI permissions through a chooser, you must specify
841 * the permissions to be granted on the ACTION_CHOOSER Intent
842 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
843 * {@link #setClipData} to specify the URIs to be granted as well as
844 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
845 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
846 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700847 * As a convenience, an Intent of this form can be created with the
848 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700849 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700850 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700851 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
852 * and can optionally have a {@link #EXTRA_TITLE} field containing the
853 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700854 * <p>
855 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700856 */
857 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
858 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
859
860 /**
861 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
862 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700863 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
864 * target intent, also optionally supplying a title. If the target
865 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
866 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
867 * set in the returned chooser intent, with its ClipData set appropriately:
868 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500869 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700870 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700871 * @param target The Intent that the user will be selecting an activity
872 * to perform.
873 * @param title Optional title that will be displayed in the chooser.
874 * @return Return a new Intent object that you can hand to
875 * {@link Context#startActivity(Intent) Context.startActivity()} and
876 * related methods.
877 */
878 public static Intent createChooser(Intent target, CharSequence title) {
879 Intent intent = new Intent(ACTION_CHOOSER);
880 intent.putExtra(EXTRA_INTENT, target);
881 if (title != null) {
882 intent.putExtra(EXTRA_TITLE, title);
883 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700884
885 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700886 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
887 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
888 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700889 if (permFlags != 0) {
890 ClipData targetClipData = target.getClipData();
891 if (targetClipData == null && target.getData() != null) {
892 ClipData.Item item = new ClipData.Item(target.getData());
893 String[] mimeTypes;
894 if (target.getType() != null) {
895 mimeTypes = new String[] { target.getType() };
896 } else {
897 mimeTypes = new String[] { };
898 }
899 targetClipData = new ClipData(null, mimeTypes, item);
900 }
901 if (targetClipData != null) {
902 intent.setClipData(targetClipData);
903 intent.addFlags(permFlags);
904 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700905 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700906
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700907 return intent;
908 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700909
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 /**
911 * Activity Action: Allow the user to select a particular kind of data and
912 * return it. This is different than {@link #ACTION_PICK} in that here we
913 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800914 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700915 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900916 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700917 * etc.
918 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900919 * 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 -0700920 * of data, such as a person contact, you set the MIME type to the kind of
921 * data you want and launch it with {@link Context#startActivity(Intent)}.
922 * The system will then launch the best application to select that kind
923 * of data for you.
924 * <p>
925 * You may also be interested in any of a set of types of content the user
926 * can pick. For example, an e-mail application that wants to allow the
927 * user to add an attachment to an e-mail message can use this action to
928 * bring up a list of all of the types of content the user can attach.
929 * <p>
930 * In this case, you should wrap the GET_CONTENT intent with a chooser
931 * (through {@link #createChooser}), which will give the proper interface
932 * for the user to pick how to send your data and allow you to specify
933 * a prompt indicating what they are doing. You will usually specify a
934 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
935 * broad range of content types the user can select from.
936 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900937 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700938 * only pick from data that can be represented as a stream. This is
939 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
940 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800941 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900942 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800943 * is locally available on the device. For example, if this extra is set
944 * to true then an image picker should not show any pictures that are available
945 * from a remote server but not already on the local device (thus requiring
946 * they be downloaded when opened).
947 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800948 * If the caller can handle multiple returned items (the user performing
949 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
950 * to indicate this.
951 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700952 * Input: {@link #getType} is the desired MIME type to retrieve. Note
953 * that no URI is supplied in the intent, as there are no constraints on
954 * where the returned data originally comes from. You may also include the
955 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800956 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800957 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
958 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700959 * <p>
960 * Output: The URI of the item that was picked. This must be a content:
961 * URI so that any receiver can access it.
962 */
963 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
964 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
965 /**
966 * Activity Action: Dial a number as specified by the data. This shows a
967 * UI with the number being dialed, allowing the user to explicitly
968 * initiate the call.
969 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
970 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
971 * number.
972 * <p>Output: nothing.
973 */
974 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
975 public static final String ACTION_DIAL = "android.intent.action.DIAL";
976 /**
977 * Activity Action: Perform a call to someone specified by the data.
978 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
979 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
980 * number.
981 * <p>Output: nothing.
982 *
983 * <p>Note: there will be restrictions on which applications can initiate a
984 * call; most applications should use the {@link #ACTION_DIAL}.
985 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
986 * numbers. Applications can <strong>dial</strong> emergency numbers using
987 * {@link #ACTION_DIAL}, however.
988 */
989 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
990 public static final String ACTION_CALL = "android.intent.action.CALL";
991 /**
992 * Activity Action: Perform a call to an emergency number specified by the
993 * data.
994 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
995 * tel: URI of an explicit phone number.
996 * <p>Output: nothing.
997 * @hide
998 */
999 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
1000 /**
1001 * Activity action: Perform a call to any number (emergency or not)
1002 * specified by the data.
1003 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
1004 * tel: URI of an explicit phone number.
1005 * <p>Output: nothing.
1006 * @hide
1007 */
1008 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1009 /**
1010 * Activity Action: Send a message to someone specified by the data.
1011 * <p>Input: {@link #getData} is URI describing the target.
1012 * <p>Output: nothing.
1013 */
1014 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1015 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1016 /**
1017 * Activity Action: Deliver some data to someone else. Who the data is
1018 * being delivered to is not specified; it is up to the receiver of this
1019 * action to ask the user where the data should be sent.
1020 * <p>
1021 * When launching a SEND intent, you should usually wrap it in a chooser
1022 * (through {@link #createChooser}), which will give the proper interface
1023 * for the user to pick how to send your data and allow you to specify
1024 * a prompt indicating what they are doing.
1025 * <p>
1026 * Input: {@link #getType} is the MIME type of the data being sent.
1027 * get*Extra can have either a {@link #EXTRA_TEXT}
1028 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1029 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1030 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1031 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001032 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1033 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1034 * your text with HTML formatting.
1035 * <p>
1036 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1037 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1038 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1039 * content: URIs and other advanced features of {@link ClipData}. If
1040 * using this approach, you still must supply the same data through the
1041 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1042 * for compatibility with old applications. If you don't set a ClipData,
1043 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001044 * <p>
1045 * Optional standard extras, which may be interpreted by some recipients as
1046 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1047 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1048 * <p>
1049 * Output: nothing.
1050 */
1051 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1052 public static final String ACTION_SEND = "android.intent.action.SEND";
1053 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001054 * Activity Action: Deliver multiple data to someone else.
1055 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001056 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001057 * <p>
1058 * Input: {@link #getType} is the MIME type of the data being sent.
1059 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001060 * #EXTRA_STREAM} field, containing the data to be sent. If using
1061 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1062 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001063 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001064 * Multiple types are supported, and receivers should handle mixed types
1065 * whenever possible. The right way for the receiver to check them is to
1066 * use the content resolver on each URI. The intent sender should try to
1067 * put the most concrete mime type in the intent type, but it can fall
1068 * back to {@literal <type>/*} or {@literal *}/* as needed.
1069 * <p>
1070 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1071 * be image/jpg, but if you are sending image/jpg and image/png, then the
1072 * intent's type should be image/*.
1073 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001074 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1075 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1076 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1077 * content: URIs and other advanced features of {@link ClipData}. If
1078 * using this approach, you still must supply the same data through the
1079 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1080 * for compatibility with old applications. If you don't set a ClipData,
1081 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1082 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001083 * Optional standard extras, which may be interpreted by some recipients as
1084 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1085 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1086 * <p>
1087 * Output: nothing.
1088 */
1089 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1090 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1091 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001092 * Activity Action: Handle an incoming phone call.
1093 * <p>Input: nothing.
1094 * <p>Output: nothing.
1095 */
1096 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1097 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1098 /**
1099 * Activity Action: Insert an empty item into the given container.
1100 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1101 * in which to place the data.
1102 * <p>Output: URI of the new data that was created.
1103 */
1104 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1105 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1106 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001107 * Activity Action: Create a new item in the given container, initializing it
1108 * from the current contents of the clipboard.
1109 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1110 * in which to place the data.
1111 * <p>Output: URI of the new data that was created.
1112 */
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1114 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1115 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001116 * Activity Action: Delete the given data from its container.
1117 * <p>Input: {@link #getData} is URI of data to be deleted.
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1122 /**
1123 * Activity Action: Run the data, whatever that means.
1124 * <p>Input: ? (Note: this is currently specific to the test harness.)
1125 * <p>Output: nothing.
1126 */
1127 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1128 public static final String ACTION_RUN = "android.intent.action.RUN";
1129 /**
1130 * Activity Action: Perform a data synchronization.
1131 * <p>Input: ?
1132 * <p>Output: ?
1133 */
1134 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1135 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1136 /**
1137 * Activity Action: Pick an activity given an intent, returning the class
1138 * selected.
1139 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1140 * used with {@link PackageManager#queryIntentActivities} to determine the
1141 * set of activities from which to pick.
1142 * <p>Output: Class name of the activity that was selected.
1143 */
1144 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1145 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1146 /**
1147 * Activity Action: Perform a search.
1148 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1149 * is the text to search for. If empty, simply
1150 * enter your search results Activity with the search UI activated.
1151 * <p>Output: nothing.
1152 */
1153 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1154 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1155 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001156 * Activity Action: Start the platform-defined tutorial
1157 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1158 * is the text to search for. If empty, simply
1159 * enter your search results Activity with the search UI activated.
1160 * <p>Output: nothing.
1161 */
1162 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1163 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1164 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001165 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001166 * <p>
1167 * Input: {@link android.app.SearchManager#QUERY
1168 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1169 * a url starts with http or https, the site will be opened. If it is plain
1170 * text, Google search will be applied.
1171 * <p>
1172 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001173 */
1174 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1175 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001176
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001177 /**
Jim Miller07994402012-05-02 14:22:27 -07001178 * Activity Action: Perform assist action.
1179 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001180 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1181 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001182 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001183 * Output: nothing.
1184 */
1185 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1186 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001187
1188 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001189 * Activity Action: Perform voice assist action.
1190 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001191 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1192 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001193 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001194 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001195 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1199
1200 /**
Adam Skory7140a252013-09-11 12:04:58 +01001201 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1202 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001203 */
1204 public static final String EXTRA_ASSIST_PACKAGE
1205 = "android.intent.extra.ASSIST_PACKAGE";
1206
1207 /**
Adam Skory7140a252013-09-11 12:04:58 +01001208 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1209 * information supplied by the current foreground app at the time of the assist request.
1210 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001211 */
1212 public static final String EXTRA_ASSIST_CONTEXT
1213 = "android.intent.extra.ASSIST_CONTEXT";
1214
Jim Miller07994402012-05-02 14:22:27 -07001215 /**
Michael Wright8ab940a2014-09-01 11:01:27 -07001216 * An optional field on {@link #ACTION_ASSIST} suggesting that the user will likely use a
1217 * keyboard as the primary input device for assistance.
1218 */
1219 public static final String EXTRA_ASSIST_INPUT_HINT_KEYBOARD =
1220 "android.intent.extra.ASSIST_INPUT_HINT_KEYBOARD";
1221
1222 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001223 * Activity Action: List all available applications
1224 * <p>Input: Nothing.
1225 * <p>Output: nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1229 /**
1230 * Activity Action: Show settings for choosing wallpaper
1231 * <p>Input: Nothing.
1232 * <p>Output: Nothing.
1233 */
1234 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1235 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1236
1237 /**
1238 * Activity Action: Show activity for reporting a bug.
1239 * <p>Input: Nothing.
1240 * <p>Output: Nothing.
1241 */
1242 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1243 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1244
1245 /**
1246 * Activity Action: Main entry point for factory tests. Only used when
1247 * the device is booting in factory test node. The implementing package
1248 * must be installed in the system image.
1249 * <p>Input: nothing
1250 * <p>Output: nothing
1251 */
1252 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1253
1254 /**
1255 * Activity Action: The user pressed the "call" button to go to the dialer
1256 * or other appropriate UI for placing a call.
1257 * <p>Input: Nothing.
1258 * <p>Output: Nothing.
1259 */
1260 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1261 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1262
1263 /**
1264 * Activity Action: Start Voice Command.
1265 * <p>Input: Nothing.
1266 * <p>Output: Nothing.
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001270
1271 /**
1272 * Activity Action: Start action associated with long pressing on the
1273 * search key.
1274 * <p>Input: Nothing.
1275 * <p>Output: Nothing.
1276 */
1277 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1278 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001279
Jacek Surazski86b6c532009-05-13 14:38:28 +02001280 /**
1281 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1282 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001283 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001284 * <p>Input: No data is specified. The bug report is passed in using
1285 * an {@link #EXTRA_BUG_REPORT} field.
1286 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001287 *
1288 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001289 */
1290 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1291 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001292
1293 /**
1294 * Activity Action: Show power usage information to the user.
1295 * <p>Input: Nothing.
1296 * <p>Output: Nothing.
1297 */
1298 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1299 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001300
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001301 /**
1302 * Activity Action: Setup wizard to launch after a platform update. This
1303 * activity should have a string meta-data field associated with it,
1304 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1305 * the platform for setup. The activity will be launched only if
1306 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1307 * same value.
1308 * <p>Input: Nothing.
1309 * <p>Output: Nothing.
1310 * @hide
1311 */
1312 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1313 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001314
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001315 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001316 * Activity Action: Show settings for managing network data usage of a
1317 * specific application. Applications should define an activity that offers
1318 * options to control data usage.
1319 */
1320 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1321 public static final String ACTION_MANAGE_NETWORK_USAGE =
1322 "android.intent.action.MANAGE_NETWORK_USAGE";
1323
1324 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001325 * Activity Action: Launch application installer.
1326 * <p>
1327 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001328 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1329 * you can also use "package:<package-name>" to install an application for the
1330 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001331 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1332 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1333 * <p>
1334 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1335 * succeeded.
1336 *
1337 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1338 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1339 * @see #EXTRA_RETURN_RESULT
1340 */
1341 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1342 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1343
1344 /**
1345 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1346 * package. Specifies the installer package name; this package will receive the
1347 * {@link #ACTION_APP_ERROR} intent.
1348 */
1349 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1350 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1351
1352 /**
1353 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1354 * package. Specifies that the application being installed should not be
1355 * treated as coming from an unknown source, but as coming from the app
1356 * invoking the Intent. For this to work you must start the installer with
1357 * startActivityForResult().
1358 */
1359 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1360 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1361
1362 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001363 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1364 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001365 * data field originated from.
1366 */
rich cannings706e8ba2012-08-20 13:20:14 -07001367 public static final String EXTRA_ORIGINATING_URI
1368 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001369
1370 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001371 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1372 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1373 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001374 */
1375 public static final String EXTRA_REFERRER
1376 = "android.intent.extra.REFERRER";
1377
1378 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001379 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1380 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1381 * @hide
1382 */
1383 public static final String EXTRA_ORIGINATING_UID
1384 = "android.intent.extra.ORIGINATING_UID";
1385
1386 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001387 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1388 * package. Tells the installer UI to skip the confirmation with the user
1389 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001390 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1391 * will no longer show an interstitial message about updating existing
1392 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001393 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001394 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001395 public static final String EXTRA_ALLOW_REPLACE
1396 = "android.intent.extra.ALLOW_REPLACE";
1397
1398 /**
1399 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1400 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1401 * return to the application the result code of the install/uninstall. The returned result
1402 * code will be {@link android.app.Activity#RESULT_OK} on success or
1403 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1404 */
1405 public static final String EXTRA_RETURN_RESULT
1406 = "android.intent.extra.RETURN_RESULT";
1407
1408 /**
1409 * Package manager install result code. @hide because result codes are not
1410 * yet ready to be exposed.
1411 */
1412 public static final String EXTRA_INSTALL_RESULT
1413 = "android.intent.extra.INSTALL_RESULT";
1414
1415 /**
1416 * Activity Action: Launch application uninstaller.
1417 * <p>
1418 * Input: The data must be a package: URI whose scheme specific part is
1419 * the package name of the current installed package to be uninstalled.
1420 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1421 * <p>
1422 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1423 * succeeded.
1424 */
1425 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1426 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1427
1428 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001429 * Specify whether the package should be uninstalled for all users.
1430 * @hide because these should not be part of normal application flow.
1431 */
1432 public static final String EXTRA_UNINSTALL_ALL_USERS
1433 = "android.intent.extra.UNINSTALL_ALL_USERS";
1434
1435 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001436 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1437 * describing the last run version of the platform that was setup.
1438 * @hide
1439 */
1440 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1441
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001442 // ---------------------------------------------------------------------
1443 // ---------------------------------------------------------------------
1444 // Standard intent broadcast actions (see action variable).
1445
1446 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001447 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1448 * <p>
1449 * For historical reasons, the name of this broadcast action refers to the power
1450 * state of the screen but it is actually sent in response to changes in the
1451 * overall interactive state of the device.
1452 * </p><p>
1453 * This broadcast is sent when the device becomes non-interactive which may have
1454 * nothing to do with the screen turning off. To determine the
1455 * actual state of the screen, use {@link android.view.Display#getState}.
1456 * </p><p>
1457 * See {@link android.os.PowerManager#isInteractive} for details.
1458 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001459 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001460 * <p class="note">This is a protected intent that can only be sent
1461 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001462 */
1463 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1464 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001465
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001466 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001467 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1468 * <p>
1469 * For historical reasons, the name of this broadcast action refers to the power
1470 * state of the screen but it is actually sent in response to changes in the
1471 * overall interactive state of the device.
1472 * </p><p>
1473 * This broadcast is sent when the device becomes interactive which may have
1474 * nothing to do with the screen turning on. To determine the
1475 * actual state of the screen, use {@link android.view.Display#getState}.
1476 * </p><p>
1477 * See {@link android.os.PowerManager#isInteractive} for details.
1478 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001479 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001480 * <p class="note">This is a protected intent that can only be sent
1481 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001482 */
1483 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1484 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001485
1486 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001487 * Broadcast Action: Sent after the system stops dreaming.
1488 *
1489 * <p class="note">This is a protected intent that can only be sent by the system.
1490 * It is only sent to registered receivers.</p>
1491 */
1492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1493 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1494
1495 /**
1496 * Broadcast Action: Sent after the system starts dreaming.
1497 *
1498 * <p class="note">This is a protected intent that can only be sent by the system.
1499 * It is only sent to registered receivers.</p>
1500 */
1501 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1502 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1503
1504 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001505 * 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 -07001506 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001507 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001508 * <p class="note">This is a protected intent that can only be sent
1509 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001510 */
1511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001512 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001513
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001514 /**
1515 * Broadcast Action: The current time has changed. Sent every
1516 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001517 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001518 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1519 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001520 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001521 * <p class="note">This is a protected intent that can only be sent
1522 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001523 */
1524 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1525 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1526 /**
1527 * Broadcast Action: The time was set.
1528 */
1529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1530 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1531 /**
1532 * Broadcast Action: The date has changed.
1533 */
1534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1535 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1536 /**
1537 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1538 * <ul>
1539 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1540 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001541 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001542 * <p class="note">This is a protected intent that can only be sent
1543 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001544 */
1545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1546 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1547 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001548 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1549 * DNS entries should be tossed.
1550 * @hide
1551 */
1552 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1553 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1554 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001555 * Alarm Changed Action: This is broadcast when the AlarmClock
1556 * application's alarm is set or unset. It is used by the
1557 * AlarmClock application and the StatusBar service.
1558 * @hide
1559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1562 /**
1563 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1564 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1565 * @hide
1566 */
1567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1568 public static final String ACTION_SYNC_STATE_CHANGED
1569 = "android.intent.action.SYNC_STATE_CHANGED";
1570 /**
1571 * Broadcast Action: This is broadcast once, after the system has finished
1572 * booting. It can be used to perform application-specific initialization,
1573 * such as installing alarms. You must hold the
1574 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1575 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001576 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001577 * <p class="note">This is a protected intent that can only be sent
1578 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001579 */
1580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1581 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1582 /**
1583 * Broadcast Action: This is broadcast when a user action should request a
1584 * temporary system dialog to dismiss. Some examples of temporary system
1585 * dialogs are the notification window-shade and the recent tasks dialog.
1586 */
1587 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1588 /**
1589 * Broadcast Action: Trigger the download and eventual installation
1590 * of a package.
1591 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001592 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001593 * <p class="note">This is a protected intent that can only be sent
1594 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001595 *
1596 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001597 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001598 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001599 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1600 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1601 /**
1602 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001603 * device. The data contains the name of the package. Note that the
1604 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001605 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001606 * <ul>
1607 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1608 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1609 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1610 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001611 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001612 * <p class="note">This is a protected intent that can only be sent
1613 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001614 */
1615 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1616 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1617 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001618 * Broadcast Action: A new version of an application package has been
1619 * installed, replacing an existing version that was previously installed.
1620 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001621 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001622 * <ul>
1623 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1624 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001625 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001626 * <p class="note">This is a protected intent that can only be sent
1627 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001628 */
1629 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1630 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1631 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001632 * Broadcast Action: A new version of your application has been installed
1633 * over an existing one. This is only sent to the application that was
1634 * replaced. It does not contain any additional data; to receive it, just
1635 * use an intent filter for this action.
1636 *
1637 * <p class="note">This is a protected intent that can only be sent
1638 * by the system.
1639 */
1640 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1641 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1642 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001643 * Broadcast Action: An existing application package has been removed from
1644 * the device. The data contains the name of the package. The package
1645 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001646 * <ul>
1647 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1648 * to the package.
1649 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1650 * application -- data and code -- is being removed.
1651 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1652 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1653 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001654 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001655 * <p class="note">This is a protected intent that can only be sent
1656 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1660 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001661 * Broadcast Action: An existing application package has been completely
1662 * removed from the device. The data contains the name of the package.
1663 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1664 * {@link #EXTRA_DATA_REMOVED} is true and
1665 * {@link #EXTRA_REPLACING} is false of that broadcast.
1666 *
1667 * <ul>
1668 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1669 * to the package.
1670 * </ul>
1671 *
1672 * <p class="note">This is a protected intent that can only be sent
1673 * by the system.
1674 */
1675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1676 public static final String ACTION_PACKAGE_FULLY_REMOVED
1677 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1678 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001679 * Broadcast Action: An existing application package has been changed (e.g.
1680 * a component has been enabled or disabled). The data contains the name of
1681 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 * <ul>
1683 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001684 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001685 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001686 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1687 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001688 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001689 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001690 * <p class="note">This is a protected intent that can only be sent
1691 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001692 */
1693 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1694 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1695 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001696 * @hide
1697 * Broadcast Action: Ask system services if there is any reason to
1698 * restart the given package. The data contains the name of the
1699 * package.
1700 * <ul>
1701 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1702 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1703 * </ul>
1704 *
1705 * <p class="note">This is a protected intent that can only be sent
1706 * by the system.
1707 */
1708 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1709 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1710 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001711 * Broadcast Action: The user has restarted a package, and all of its
1712 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001713 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001714 * be removed. Note that the restarted package does <em>not</em>
1715 * receive this broadcast.
1716 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001717 * <ul>
1718 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1719 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001720 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001721 * <p class="note">This is a protected intent that can only be sent
1722 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001723 */
1724 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1725 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1726 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001727 * Broadcast Action: The user has cleared the data of a package. This should
1728 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001729 * its persistent data is erased and this broadcast sent.
1730 * Note that the cleared package does <em>not</em>
1731 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001732 * <ul>
1733 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1734 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001735 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001736 * <p class="note">This is a protected intent that can only be sent
1737 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001738 */
1739 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1740 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1741 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001742 * Broadcast Action: A user ID has been removed from the system. The user
1743 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001744 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001745 * <p class="note">This is a protected intent that can only be sent
1746 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1749 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001750
1751 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001752 * Broadcast Action: Sent to the installer package of an application
1753 * when that application is first launched (that is the first time it
1754 * is moved out of the stopped state). The data contains the name of the package.
1755 *
1756 * <p class="note">This is a protected intent that can only be sent
1757 * by the system.
1758 */
1759 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1760 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1761
1762 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001763 * Broadcast Action: Sent to the system package verifier when a package
1764 * needs to be verified. The data contains the package URI.
1765 * <p class="note">
1766 * This is a protected intent that can only be sent by the system.
1767 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001768 */
1769 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1770 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1771
1772 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001773 * Broadcast Action: Sent to the system package verifier when a package is
1774 * verified. The data contains the package URI.
1775 * <p class="note">
1776 * This is a protected intent that can only be sent by the system.
1777 */
1778 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1779 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1780
1781 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001782 * Broadcast Action: Resources for a set of packages (which were
1783 * previously unavailable) are currently
1784 * available since the media on which they exist is available.
1785 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1786 * list of packages whose availability changed.
1787 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1788 * list of uids of packages whose availability changed.
1789 * Note that the
1790 * packages in this list do <em>not</em> receive this broadcast.
1791 * The specified set of packages are now available on the system.
1792 * <p>Includes the following extras:
1793 * <ul>
1794 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1795 * whose resources(were previously unavailable) are currently available.
1796 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1797 * packages whose resources(were previously unavailable)
1798 * are currently available.
1799 * </ul>
1800 *
1801 * <p class="note">This is a protected intent that can only be sent
1802 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001803 */
1804 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001805 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1806 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001807
1808 /**
1809 * Broadcast Action: Resources for a set of packages are currently
1810 * unavailable since the media on which they exist is unavailable.
1811 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1812 * list of packages whose availability changed.
1813 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1814 * list of uids of packages whose availability changed.
1815 * The specified set of packages can no longer be
1816 * launched and are practically unavailable on the system.
1817 * <p>Inclues the following extras:
1818 * <ul>
1819 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1820 * whose resources are no longer available.
1821 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1822 * whose resources are no longer available.
1823 * </ul>
1824 *
1825 * <p class="note">This is a protected intent that can only be sent
1826 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001827 */
1828 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001829 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001830 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001831
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001832 /**
1833 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001834 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001835 * This should <em>only</em> be used to determine when the wallpaper
1836 * has changed to show the new wallpaper to the user. You should certainly
1837 * never, in response to this, change the wallpaper or other attributes of
1838 * it such as the suggested size. That would be crazy, right? You'd cause
1839 * all kinds of loops, especially if other apps are doing similar things,
1840 * right? Of course. So please don't do this.
1841 *
1842 * @deprecated Modern applications should use
1843 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1844 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1845 * shown behind their UI, rather than watching for this broadcast and
1846 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001847 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001848 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1850 /**
1851 * Broadcast Action: The current device {@link android.content.res.Configuration}
1852 * (orientation, locale, etc) has changed. When such a change happens, the
1853 * UIs (view hierarchy) will need to be rebuilt based on this new
1854 * information; for the most part, applications don't need to worry about
1855 * this, because the system will take care of stopping and restarting the
1856 * application to make sure it sees the new changes. Some system code that
1857 * can not be restarted will need to watch for this action and handle it
1858 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001859 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001860 * <p class="note">
1861 * You can <em>not</em> receive this through components declared
1862 * in manifests, only by explicitly registering for it with
1863 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1864 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001865 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001866 * <p class="note">This is a protected intent that can only be sent
1867 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001868 *
1869 * @see android.content.res.Configuration
1870 */
1871 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1872 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1873 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001874 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001875 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001876 * <p class="note">This is a protected intent that can only be sent
1877 * by the system.
1878 */
1879 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1880 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1881 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001882 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1883 * charging state, level, and other information about the battery.
1884 * See {@link android.os.BatteryManager} for documentation on the
1885 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001886 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001887 * <p class="note">
1888 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001889 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001890 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001891 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1892 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1893 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1894 * broadcasts that are sent and can be received through manifest
1895 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001896 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001897 * <p class="note">This is a protected intent that can only be sent
1898 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001899 */
1900 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1901 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1902 /**
1903 * Broadcast Action: Indicates low battery condition on the device.
1904 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001905 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001906 * <p class="note">This is a protected intent that can only be sent
1907 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001908 */
1909 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1910 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1911 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001912 * Broadcast Action: Indicates the battery is now okay after being low.
1913 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1914 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001915 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001916 * <p class="note">This is a protected intent that can only be sent
1917 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001918 */
1919 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1920 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1921 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001922 * Broadcast Action: External power has been connected to the device.
1923 * This is intended for applications that wish to register specifically to this notification.
1924 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1925 * stay active to receive this notification. This action can be used to implement actions
1926 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001927 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001928 * <p class="note">This is a protected intent that can only be sent
1929 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001930 */
1931 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001932 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001933 /**
1934 * Broadcast Action: External power has been removed from the device.
1935 * This is intended for applications that wish to register specifically to this notification.
1936 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1937 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001938 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001939 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001940 * <p class="note">This is a protected intent that can only be sent
1941 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001942 */
1943 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001944 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001945 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001946 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001947 * Broadcast Action: Device is shutting down.
1948 * This is broadcast when the device is being shut down (completely turned
1949 * off, not sleeping). Once the broadcast is complete, the final shutdown
1950 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001951 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001952 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001953 * <p class="note">This is a protected intent that can only be sent
1954 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001955 * <p>May include the following extras:
1956 * <ul>
1957 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1958 * shutdown is only for userspace processes. If not set, assumed to be false.
1959 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001960 */
1961 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001962 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001963 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001964 * Activity Action: Start this activity to request system shutdown.
1965 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1966 * to request confirmation from the user before shutting down.
1967 *
1968 * <p class="note">This is a protected intent that can only be sent
1969 * by the system.
1970 *
1971 * {@hide}
1972 */
1973 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1974 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001975 * Broadcast Action: A sticky broadcast that indicates low memory
1976 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001977 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001978 * <p class="note">This is a protected intent that can only be sent
1979 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1983 /**
1984 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001985 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001986 * <p class="note">This is a protected intent that can only be sent
1987 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1991 /**
Jake Hambybb371632010-08-23 18:16:48 -07001992 * Broadcast Action: A sticky broadcast that indicates a memory full
1993 * condition on the device. This is intended for activities that want
1994 * to be able to fill the data partition completely, leaving only
1995 * enough free space to prevent system-wide SQLite failures.
1996 *
1997 * <p class="note">This is a protected intent that can only be sent
1998 * by the system.
1999 *
2000 * {@hide}
2001 */
2002 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2003 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2004 /**
2005 * Broadcast Action: Indicates memory full condition on the device
2006 * no longer exists.
2007 *
2008 * <p class="note">This is a protected intent that can only be sent
2009 * by the system.
2010 *
2011 * {@hide}
2012 */
2013 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2014 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2017 * and package management should be started.
2018 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2019 * notification.
2020 */
2021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2022 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2023 /**
2024 * Broadcast Action: The device has entered USB Mass Storage mode.
2025 * This is used mainly for the USB Settings panel.
2026 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2027 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002028 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002029 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002030 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002031 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2032
2033 /**
2034 * Broadcast Action: The device has exited USB Mass Storage mode.
2035 * This is used mainly for the USB Settings panel.
2036 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2037 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002038 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002039 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002040 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002041 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2042
2043 /**
2044 * Broadcast Action: External media has been removed.
2045 * The path to the mount point for the removed media is contained in the Intent.mData field.
2046 */
2047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2049
2050 /**
2051 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002052 * 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 -07002053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2056
2057 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002058 * Broadcast Action: External media is present, and being disk-checked
2059 * 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 -08002060 */
2061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2063
2064 /**
2065 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2066 * 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 -08002067 */
2068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2070
2071 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002072 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002073 * 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 -07002074 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2075 * media was mounted read only.
2076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2079
2080 /**
2081 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002082 * 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 -07002083 */
2084 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2085 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2086
2087 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002088 * Broadcast Action: External media is no longer being shared via USB mass storage.
2089 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2090 *
2091 * @hide
2092 */
2093 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2094
2095 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002096 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2097 * The path to the mount point for the removed media is contained in the Intent.mData field.
2098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2101
2102 /**
2103 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002104 * 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 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2108
2109 /**
2110 * Broadcast Action: User has expressed the desire to remove the external storage media.
2111 * Applications should close all files they have open within the mount point when they receive this intent.
2112 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2116
2117 /**
2118 * Broadcast Action: The media scanner has started scanning a directory.
2119 * The path to the directory being scanned is contained in the Intent.mData field.
2120 */
2121 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2122 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2123
2124 /**
2125 * Broadcast Action: The media scanner has finished scanning a directory.
2126 * The path to the scanned directory is contained in the Intent.mData field.
2127 */
2128 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2129 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2130
2131 /**
2132 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2133 * The path to the file is contained in the Intent.mData field.
2134 */
2135 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2136 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2137
2138 /**
2139 * Broadcast Action: The "Media Button" was pressed. Includes a single
2140 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2141 * caused the broadcast.
2142 */
2143 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2144 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2145
2146 /**
2147 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2148 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2149 * caused the broadcast.
2150 */
2151 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2152 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2153
2154 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2155 // location; they are not general-purpose actions.
2156
2157 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002158 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002159 */
2160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2161 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2162 "android.intent.action.GTALK_CONNECTED";
2163
2164 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002165 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002166 */
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2169 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002170
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002171 /**
2172 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002173 */
2174 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2175 public static final String ACTION_INPUT_METHOD_CHANGED =
2176 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002177
2178 /**
2179 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2180 * more radios have been turned off or on. The intent will have the following extra value:</p>
2181 * <ul>
2182 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2183 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2184 * turned off</li>
2185 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002186 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002187 * <p class="note">This is a protected intent that can only be sent
2188 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002189 */
2190 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2191 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2192
2193 /**
2194 * Broadcast Action: Some content providers have parts of their namespace
2195 * where they publish new events or items that the user may be especially
2196 * interested in. For these things, they may broadcast this action when the
2197 * set of interesting items change.
2198 *
2199 * For example, GmailProvider sends this notification when the set of unread
2200 * mail in the inbox changes.
2201 *
2202 * <p>The data of the intent identifies which part of which provider
2203 * changed. When queried through the content resolver, the data URI will
2204 * return the data set in question.
2205 *
2206 * <p>The intent will have the following extra values:
2207 * <ul>
2208 * <li><em>count</em> - The number of items in the data set. This is the
2209 * same as the number of items in the cursor returned by querying the
2210 * data URI. </li>
2211 * </ul>
2212 *
2213 * This intent will be sent at boot (if the count is non-zero) and when the
2214 * data set changes. It is possible for the data set to change without the
2215 * count changing (for example, if a new unread message arrives in the same
2216 * sync operation in which a message is archived). The phone should still
2217 * ring/vibrate/etc as normal in this case.
2218 */
2219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2220 public static final String ACTION_PROVIDER_CHANGED =
2221 "android.intent.action.PROVIDER_CHANGED";
2222
2223 /**
2224 * Broadcast Action: Wired Headset plugged in or unplugged.
2225 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002226 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2227 * and documentation.
2228 * <p>If the minimum SDK version of your application is
Dianne Hackborn955d8d62014-10-07 20:17:19 -07002229 * {@link android.os.Build.VERSION_CODES#LOLLIPOP}, it is recommended to refer
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002230 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002231 */
2232 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002233 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002234
2235 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002236 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2237 * <ul>
2238 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2239 * </ul>
2240 *
2241 * <p class="note">This is a protected intent that can only be sent
2242 * by the system.
2243 *
2244 * @hide
2245 */
2246 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2247 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2248 = "android.intent.action.ADVANCED_SETTINGS";
2249
2250 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002251 * Broadcast Action: Sent after application restrictions are changed.
2252 *
2253 * <p class="note">This is a protected intent that can only be sent
2254 * by the system.</p>
2255 */
2256 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2257 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2258 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2259
2260 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002261 * Broadcast Action: An outgoing call is about to be placed.
2262 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002263 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002265 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002266 * the phone number originally intended to be dialed.</li>
2267 * </ul>
2268 * <p>Once the broadcast is finished, the resultData is used as the actual
2269 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002270 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 * outgoing call in turn: for example, a parental control application
2272 * might verify that the user is authorized to place the call at that
2273 * time, then a number-rewriting application might add an area code if
2274 * one was not specified.</p>
2275 * <p>For consistency, any receiver whose purpose is to prohibit phone
2276 * calls should have a priority of 0, to ensure it will see the final
2277 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002278 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002279 * should have a positive priority.
2280 * Negative priorities are reserved for the system for this broadcast;
2281 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002282 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2283 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002284 * <p>Emergency calls cannot be intercepted using this mechanism, and
2285 * other calls cannot be modified to call emergency numbers using this
2286 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002287 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2288 * call to use their own service instead. Those apps should first prevent
2289 * the call from being placed by setting resultData to <code>null</code>
2290 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002291 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002292 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2293 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002294 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002295 * <p class="note">This is a protected intent that can only be sent
2296 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002297 */
2298 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2299 public static final String ACTION_NEW_OUTGOING_CALL =
2300 "android.intent.action.NEW_OUTGOING_CALL";
2301
2302 /**
2303 * Broadcast Action: Have the device reboot. This is only for use by
2304 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002305 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002306 * <p class="note">This is a protected intent that can only be sent
2307 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002308 */
2309 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2310 public static final String ACTION_REBOOT =
2311 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002312
Wei Huang97ecc9c2009-05-11 17:44:20 -07002313 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002314 * Broadcast Action: A sticky broadcast for changes in the physical
2315 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002316 *
2317 * <p>The intent will have the following extra values:
2318 * <ul>
2319 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002320 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002321 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002322 * <p>This is intended for monitoring the current physical dock state.
2323 * See {@link android.app.UiModeManager} for the normal API dealing with
2324 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002325 */
2326 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2327 public static final String ACTION_DOCK_EVENT =
2328 "android.intent.action.DOCK_EVENT";
2329
2330 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002331 * Broadcast Action: A broadcast when idle maintenance can be started.
2332 * This means that the user is not interacting with the device and is
2333 * not expected to do so soon. Typical use of the idle maintenance is
2334 * to perform somehow expensive tasks that can be postponed at a moment
2335 * when they will not degrade user experience.
2336 * <p>
2337 * <p class="note">In order to keep the device responsive in case of an
2338 * unexpected user interaction, implementations of a maintenance task
2339 * should be interruptible. In such a scenario a broadcast with action
2340 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2341 * should not do the maintenance work in
2342 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2343 * maintenance service by {@link Context#startService(Intent)}. Also
2344 * you should hold a wake lock while your maintenance service is running
2345 * to prevent the device going to sleep.
2346 * </p>
2347 * <p>
2348 * <p class="note">This is a protected intent that can only be sent by
2349 * the system.
2350 * </p>
2351 *
2352 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002353 *
2354 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002355 */
2356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2357 public static final String ACTION_IDLE_MAINTENANCE_START =
2358 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2359
2360 /**
2361 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2362 * This means that the user was not interacting with the device as a result
2363 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2364 * was sent and now the user started interacting with the device. Typical
2365 * use of the idle maintenance is to perform somehow expensive tasks that
2366 * can be postponed at a moment when they will not degrade user experience.
2367 * <p>
2368 * <p class="note">In order to keep the device responsive in case of an
2369 * unexpected user interaction, implementations of a maintenance task
2370 * should be interruptible. Hence, on receiving a broadcast with this
2371 * action, the maintenance task should be interrupted as soon as possible.
2372 * In other words, you should not do the maintenance work in
2373 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2374 * maintenance service that was started on receiving of
2375 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2376 * lock you acquired when your maintenance service started.
2377 * </p>
2378 * <p class="note">This is a protected intent that can only be sent
2379 * by the system.
2380 *
2381 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002382 *
2383 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002384 */
2385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2386 public static final String ACTION_IDLE_MAINTENANCE_END =
2387 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2388
2389 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002390 * Broadcast Action: a remote intent is to be broadcasted.
2391 *
2392 * A remote intent is used for remote RPC between devices. The remote intent
2393 * is serialized and sent from one device to another device. The receiving
2394 * device parses the remote intent and broadcasts it. Note that anyone can
2395 * broadcast a remote intent. However, if the intent receiver of the remote intent
2396 * does not trust intent broadcasts from arbitrary intent senders, it should require
2397 * the sender to hold certain permissions so only trusted sender's broadcast will be
2398 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002399 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002400 */
2401 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002402 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002403
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002404 /**
2405 * Broadcast Action: hook for permforming cleanup after a system update.
2406 *
2407 * The broadcast is sent when the system is booting, before the
2408 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2409 * image. A receiver for this should do its work and then disable itself
2410 * so that it does not get run again at the next boot.
2411 * @hide
2412 */
2413 public static final String ACTION_PRE_BOOT_COMPLETED =
2414 "android.intent.action.PRE_BOOT_COMPLETED";
2415
Amith Yamasani13593602012-03-22 16:16:17 -07002416 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002417 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002418 * on restricted users. The broadcast intent contains an extra
2419 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2420 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2421 * String[] depending on the restriction type.<p/>
2422 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002423 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2424 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2425 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002426 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2427 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002428 * @see RestrictionEntry
2429 */
2430 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2431 "android.intent.action.GET_RESTRICTION_ENTRIES";
2432
2433 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002434 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002435 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002436 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2437 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2438 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002439 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2440 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2441 * challenge.<p/>
2442 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002443 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002444 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002445 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2446 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002447
2448 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002449 * Sent the first time a user is starting, to allow system apps to
2450 * perform one time initialization. (This will not be seen by third
2451 * party applications because a newly initialized user does not have any
2452 * third party applications installed for it.) This is sent early in
2453 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002454 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2455 * broadcast, since it is part of a visible user interaction; be as quick
2456 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002457 */
2458 public static final String ACTION_USER_INITIALIZE =
2459 "android.intent.action.USER_INITIALIZE";
2460
2461 /**
2462 * Sent when a user switch is happening, causing the process's user to be
2463 * brought to the foreground. This is only sent to receivers registered
2464 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2465 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002466 * foreground. This is sent as a foreground
2467 * broadcast, since it is part of a visible user interaction; be as quick
2468 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002469 */
2470 public static final String ACTION_USER_FOREGROUND =
2471 "android.intent.action.USER_FOREGROUND";
2472
2473 /**
2474 * Sent when a user switch is happening, causing the process's user to be
2475 * sent to the background. This is only sent to receivers registered
2476 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2477 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002478 * background. This is sent as a foreground
2479 * broadcast, since it is part of a visible user interaction; be as quick
2480 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002481 */
2482 public static final String ACTION_USER_BACKGROUND =
2483 "android.intent.action.USER_BACKGROUND";
2484
2485 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002486 * Broadcast sent to the system when a user is added. Carries an extra
2487 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2488 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002489 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002490 * @hide
2491 */
2492 public static final String ACTION_USER_ADDED =
2493 "android.intent.action.USER_ADDED";
2494
2495 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002496 * Broadcast sent by the system when a user is started. Carries an extra
2497 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002498 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002499 * that has been started. This is sent as a foreground
2500 * broadcast, since it is part of a visible user interaction; be as quick
2501 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002502 * @hide
2503 */
2504 public static final String ACTION_USER_STARTED =
2505 "android.intent.action.USER_STARTED";
2506
2507 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002508 * Broadcast sent when a user is in the process of starting. Carries an extra
2509 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2510 * sent to registered receivers, not manifest receivers. It is sent to all
2511 * users (including the one that is being started). You must hold
2512 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2513 * this broadcast. This is sent as a background broadcast, since
2514 * its result is not part of the primary UX flow; to safely keep track of
2515 * started/stopped state of a user you can use this in conjunction with
2516 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2517 * other user state broadcasts since those are foreground broadcasts so can
2518 * execute in a different order.
2519 * @hide
2520 */
2521 public static final String ACTION_USER_STARTING =
2522 "android.intent.action.USER_STARTING";
2523
2524 /**
2525 * Broadcast sent when a user is going to be stopped. Carries an extra
2526 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2527 * sent to registered receivers, not manifest receivers. It is sent to all
2528 * users (including the one that is being stopped). You must hold
2529 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2530 * this broadcast. The user will not stop until all receivers have
2531 * handled the broadcast. This is sent as a background broadcast, since
2532 * its result is not part of the primary UX flow; to safely keep track of
2533 * started/stopped state of a user you can use this in conjunction with
2534 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2535 * other user state broadcasts since those are foreground broadcasts so can
2536 * execute in a different order.
2537 * @hide
2538 */
2539 public static final String ACTION_USER_STOPPING =
2540 "android.intent.action.USER_STOPPING";
2541
2542 /**
2543 * Broadcast sent to the system when a user is stopped. Carries an extra
2544 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2545 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2546 * specific package. This is only sent to registered receivers, not manifest
2547 * receivers. It is sent to all running users <em>except</em> the one that
2548 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002549 * @hide
2550 */
2551 public static final String ACTION_USER_STOPPED =
2552 "android.intent.action.USER_STOPPED";
2553
2554 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002555 * 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 -07002556 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002557 * one that has been removed. The user will not be completely removed until all receivers have
2558 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002559 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002560 * @hide
2561 */
2562 public static final String ACTION_USER_REMOVED =
2563 "android.intent.action.USER_REMOVED";
2564
2565 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002566 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002567 * the userHandle of the user to become the current one. This is only sent to
2568 * registered receivers, not manifest receivers. It is sent to all running users.
2569 * You must hold
2570 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002571 * @hide
2572 */
2573 public static final String ACTION_USER_SWITCHED =
2574 "android.intent.action.USER_SWITCHED";
2575
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002576 /**
2577 * Broadcast sent to the system when a user's information changes. Carries an extra
2578 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002579 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002580 * @hide
2581 */
2582 public static final String ACTION_USER_INFO_CHANGED =
2583 "android.intent.action.USER_INFO_CHANGED";
2584
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002585 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002586 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2587 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002588 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2589 * that need to display merged content across both primary and managed profiles need to
2590 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002591 * not manifest receivers.
2592 */
2593 public static final String ACTION_MANAGED_PROFILE_ADDED =
2594 "android.intent.action.MANAGED_PROFILE_ADDED";
2595
2596 /**
2597 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002598 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2599 * Only applications (for example Launchers) that need to display merged content across both
2600 * primary and managed profiles need to worry about this broadcast. This is only sent to
2601 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002602 */
2603 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2604 "android.intent.action.MANAGED_PROFILE_REMOVED";
2605
2606 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002607 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2608 */
2609 public static final String ACTION_QUICK_CLOCK =
2610 "android.intent.action.QUICK_CLOCK";
2611
Michael Wright0087a142013-02-05 16:29:39 -08002612 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002613 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002614 * @hide
2615 */
2616 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2617 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2618
Justin Kohd378ad72013-04-01 12:18:26 -07002619 /**
2620 * Broadcast Action: A global button was pressed. Includes a single
2621 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2622 * caused the broadcast.
2623 * @hide
2624 */
2625 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2626
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002627 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002628 * Activity Action: Allow the user to select and return one or more existing
2629 * documents. When invoked, the system will display the various
2630 * {@link DocumentsProvider} instances installed on the device, letting the
2631 * user interactively navigate through them. These documents include local
2632 * media, such as photos and video, and documents provided by installed
2633 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002634 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002635 * Each document is represented as a {@code content://} URI backed by a
2636 * {@link DocumentsProvider}, which can be opened as a stream with
2637 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2638 * {@link android.provider.DocumentsContract.Document} metadata.
2639 * <p>
2640 * All selected documents are returned to the calling application with
2641 * persistable read and write permission grants. If you want to maintain
2642 * access to the documents across device reboots, you need to explicitly
2643 * take the persistable permissions using
2644 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2645 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002646 * Callers must indicate the acceptable document MIME types through
2647 * {@link #setType(String)}. For example, to select photos, use
2648 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2649 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2650 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002651 * <p>
2652 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002653 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2654 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002655 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002656 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2657 * returned URIs can be opened with
2658 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002659 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002660 * Output: The URI of the item that was picked, returned in
2661 * {@link #getData()}. This must be a {@code content://} URI so that any
2662 * receiver can access it. If multiple documents were selected, they are
2663 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002664 *
2665 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002666 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002667 * @see #ACTION_CREATE_DOCUMENT
2668 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002669 */
2670 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2671 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2672
2673 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002674 * Activity Action: Allow the user to create a new document. When invoked,
2675 * the system will display the various {@link DocumentsProvider} instances
2676 * installed on the device, letting the user navigate through them. The
2677 * returned document may be a newly created document with no content, or it
2678 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002679 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002680 * Each document is represented as a {@code content://} URI backed by a
2681 * {@link DocumentsProvider}, which can be opened as a stream with
2682 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2683 * {@link android.provider.DocumentsContract.Document} metadata.
2684 * <p>
2685 * Callers must indicate the concrete MIME type of the document being
2686 * created by setting {@link #setType(String)}. This MIME type cannot be
2687 * changed after the document is created.
2688 * <p>
2689 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2690 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002691 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002692 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2693 * returned URIs can be opened with
2694 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002695 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002696 * Output: The URI of the item that was created. This must be a
2697 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002698 *
2699 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002700 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002701 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002702 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002703 */
2704 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2705 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2706
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002707 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002708 * Activity Action: Allow the user to pick a directory subtree. When
2709 * invoked, the system will display the various {@link DocumentsProvider}
2710 * instances installed on the device, letting the user navigate through
2711 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002712 * <p>
2713 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002714 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2715 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2716 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002717 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002718 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002719 *
2720 * @see DocumentsContract
2721 */
2722 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002723 public static final String
2724 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002725
Jeff Sharkey004a4b22014-09-24 11:45:24 -07002726 /** {@hide} */
2727 public static final String ACTION_MASTER_CLEAR = "android.intent.action.MASTER_CLEAR";
2728
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002729 // ---------------------------------------------------------------------
2730 // ---------------------------------------------------------------------
2731 // Standard intent categories (see addCategory()).
2732
2733 /**
2734 * Set if the activity should be an option for the default action
2735 * (center press) to perform on a piece of data. Setting this will
2736 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002737 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002738 * Intent when initiating an action -- it is for use in intent filters
2739 * specified in packages.
2740 */
2741 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2742 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2743 /**
2744 * Activities that can be safely invoked from a browser must support this
2745 * category. For example, if the user is viewing a web page or an e-mail
2746 * and clicks on a link in the text, the Intent generated execute that
2747 * link will require the BROWSABLE category, so that only activities
2748 * supporting this category will be considered as possible actions. By
2749 * supporting this category, you are promising that there is nothing
2750 * damaging (without user intervention) that can happen by invoking any
2751 * matching Intent.
2752 */
2753 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2754 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2755 /**
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002756 * @hide
Dianne Hackborn91097de2014-04-04 18:02:06 -07002757 * Categories for activities that can participate in voice interaction.
2758 * An activity that supports this category must be prepared to run with
2759 * no UI shown at all (though in some case it may have a UI shown), and
2760 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2761 */
2762 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
Dianne Hackbornd7c03952014-08-29 17:32:04 -07002763 @SystemApi
Dianne Hackborn91097de2014-04-04 18:02:06 -07002764 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2765 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002766 * Set if the activity should be considered as an alternative action to
2767 * the data the user is currently viewing. See also
2768 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2769 * applies to the selection in a list of items.
2770 *
2771 * <p>Supporting this category means that you would like your activity to be
2772 * displayed in the set of alternative things the user can do, usually as
2773 * part of the current activity's options menu. You will usually want to
2774 * include a specific label in the &lt;intent-filter&gt; of this action
2775 * describing to the user what it does.
2776 *
2777 * <p>The action of IntentFilter with this category is important in that it
2778 * describes the specific action the target will perform. This generally
2779 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2780 * a specific name such as "com.android.camera.action.CROP. Only one
2781 * alternative of any particular action will be shown to the user, so using
2782 * a specific action like this makes sure that your alternative will be
2783 * displayed while also allowing other applications to provide their own
2784 * overrides of that particular action.
2785 */
2786 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2787 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2788 /**
2789 * Set if the activity should be considered as an alternative selection
2790 * action to the data the user has currently selected. This is like
2791 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2792 * of items from which the user can select, giving them alternatives to the
2793 * default action that will be performed on it.
2794 */
2795 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2796 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2797 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002798 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002799 */
2800 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2801 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2802 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002803 * Should be displayed in the top-level launcher.
2804 */
2805 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2806 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2807 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002808 * Indicates an activity optimized for Leanback mode, and that should
2809 * be displayed in the Leanback launcher.
2810 */
2811 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2812 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2813 /**
Jose Lima73915cf2014-07-29 17:16:31 -07002814 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
2815 * @hide
2816 */
2817 @SystemApi
2818 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
2819 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002820 * Provides information about the package it is in; typically used if
2821 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2822 * a front-door to the user without having to be shown in the all apps list.
2823 */
2824 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2825 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2826 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002827 * This is the home activity, that is the first activity that is displayed
2828 * when the device boots.
2829 */
2830 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2831 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2832 /**
2833 * This activity is a preference panel.
2834 */
2835 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2836 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2837 /**
2838 * This activity is a development preference panel.
2839 */
2840 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2841 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2842 /**
2843 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002844 */
2845 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2846 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2847 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002848 * This activity allows the user to browse and download new applications.
2849 */
2850 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2851 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2852 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002853 * This activity may be exercised by the monkey or other automated test tools.
2854 */
2855 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2856 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2857 /**
2858 * To be used as a test (not part of the normal user experience).
2859 */
2860 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2861 /**
2862 * To be used as a unit test (run through the Test Harness).
2863 */
2864 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2865 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002866 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002867 * experience).
2868 */
2869 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002870
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002871 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002872 * Used to indicate that an intent only wants URIs that can be opened with
2873 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2874 * must support at least the columns defined in {@link OpenableColumns} when
2875 * queried.
2876 *
2877 * @see #ACTION_GET_CONTENT
2878 * @see #ACTION_OPEN_DOCUMENT
2879 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002880 */
2881 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2882 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2883
2884 /**
2885 * To be used as code under test for framework instrumentation tests.
2886 */
2887 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2888 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002889 /**
2890 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002891 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2892 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002893 */
2894 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2895 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2896 /**
2897 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002898 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2899 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002900 */
2901 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2902 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002903 /**
2904 * An activity to run when device is inserted into a analog (low end) dock.
2905 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2906 * information, see {@link android.app.UiModeManager}.
2907 */
2908 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2909 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2910
2911 /**
2912 * An activity to run when device is inserted into a digital (high end) dock.
2913 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2914 * information, see {@link android.app.UiModeManager}.
2915 */
2916 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2917 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002918
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002919 /**
2920 * Used to indicate that the activity can be used in a car environment.
2921 */
2922 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2923 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2924
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002925 // ---------------------------------------------------------------------
2926 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002927 // Application launch intent categories (see addCategory()).
2928
2929 /**
2930 * Used with {@link #ACTION_MAIN} to launch the browser application.
2931 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002932 * <p>NOTE: This should not be used as the primary key of an Intent,
2933 * since it will not result in the app launching with the correct
2934 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002935 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002936 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002937 */
2938 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2939 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2940
2941 /**
2942 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2943 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002944 * <p>NOTE: This should not be used as the primary key of an Intent,
2945 * since it will not result in the app launching with the correct
2946 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002947 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002948 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002949 */
2950 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2951 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2952
2953 /**
2954 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2955 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002956 * <p>NOTE: This should not be used as the primary key of an Intent,
2957 * since it will not result in the app launching with the correct
2958 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002959 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002960 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002961 */
2962 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2963 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2964
2965 /**
2966 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2967 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002968 * <p>NOTE: This should not be used as the primary key of an Intent,
2969 * since it will not result in the app launching with the correct
2970 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002971 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002972 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002973 */
2974 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2975 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2976
2977 /**
2978 * Used with {@link #ACTION_MAIN} to launch the email application.
2979 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002980 * <p>NOTE: This should not be used as the primary key of an Intent,
2981 * since it will not result in the app launching with the correct
2982 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002983 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002984 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002985 */
2986 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2987 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2988
2989 /**
2990 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2991 * The activity should be able to view and manipulate image and video files
2992 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002993 * <p>NOTE: This should not be used as the primary key of an Intent,
2994 * since it will not result in the app launching with the correct
2995 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002996 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002997 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002998 */
2999 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3000 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3001
3002 /**
3003 * Used with {@link #ACTION_MAIN} to launch the maps application.
3004 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003005 * <p>NOTE: This should not be used as the primary key of an Intent,
3006 * since it will not result in the app launching with the correct
3007 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003008 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003009 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003010 */
3011 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3012 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3013
3014 /**
3015 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3016 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003017 * <p>NOTE: This should not be used as the primary key of an Intent,
3018 * since it will not result in the app launching with the correct
3019 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003020 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003021 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003022 */
3023 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3024 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3025
3026 /**
3027 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003028 * The activity should be able to play, browse, or manipulate music files
3029 * stored on the device.
3030 * <p>NOTE: This should not be used as the primary key of an Intent,
3031 * since it will not result in the app launching with the correct
3032 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003033 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003034 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003035 */
3036 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3037 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3038
3039 // ---------------------------------------------------------------------
3040 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003041 // Standard extra data keys.
3042
3043 /**
3044 * The initial data to place in a newly created record. Use with
3045 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3046 * fields as would be given to the underlying ContentProvider.insert()
3047 * call.
3048 */
3049 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3050
3051 /**
3052 * A constant CharSequence that is associated with the Intent, used with
3053 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3054 * this may be a styled CharSequence, so you must use
3055 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3056 * retrieve it.
3057 */
3058 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3059
3060 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003061 * A constant String that is associated with the Intent, used with
3062 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3063 * as HTML formatted text. Note that you <em>must</em> also supply
3064 * {@link #EXTRA_TEXT}.
3065 */
3066 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3067
3068 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003069 * A content: URI holding a stream of data associated with the Intent,
3070 * used with {@link #ACTION_SEND} to supply the data being sent.
3071 */
3072 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3073
3074 /**
3075 * A String[] holding e-mail addresses that should be delivered to.
3076 */
3077 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3078
3079 /**
3080 * A String[] holding e-mail addresses that should be carbon copied.
3081 */
3082 public static final String EXTRA_CC = "android.intent.extra.CC";
3083
3084 /**
3085 * A String[] holding e-mail addresses that should be blind carbon copied.
3086 */
3087 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3088
3089 /**
3090 * A constant string holding the desired subject line of a message.
3091 */
3092 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3093
3094 /**
3095 * An Intent describing the choices you would like shown with
3096 * {@link #ACTION_PICK_ACTIVITY}.
3097 */
3098 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3099
3100 /**
3101 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003102 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003103 */
3104 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3105
3106 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003107 * A Parcelable[] of {@link Intent} or
3108 * {@link android.content.pm.LabeledIntent} objects as set with
3109 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3110 * a the front of the list of choices, when shown to the user with a
3111 * {@link #ACTION_CHOOSER}.
3112 */
3113 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3114
3115 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003116 * A Bundle forming a mapping of potential target package names to different extras Bundles
3117 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3118 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3119 * be currently installed on the device.
3120 *
3121 * <p>An application may choose to provide alternate extras for the case where a user
3122 * selects an activity from a predetermined set of target packages. If the activity
3123 * the user selects from the chooser belongs to a package with its package name as
3124 * a key in this bundle, the corresponding extras for that package will be merged with
3125 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3126 * extra has the same key as an extra already present in the intent it will overwrite
3127 * the extra from the intent.</p>
3128 *
3129 * <p><em>Examples:</em>
3130 * <ul>
3131 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3132 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3133 * parameters for that target.</li>
3134 * <li>An application may offer additional metadata for known targets of a given intent
3135 * to pass along information only relevant to that target such as account or content
3136 * identifiers already known to that application.</li>
3137 * </ul></p>
3138 */
3139 public static final String EXTRA_REPLACEMENT_EXTRAS =
3140 "android.intent.extra.REPLACEMENT_EXTRAS";
3141
3142 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003143 * A {@link android.view.KeyEvent} object containing the event that
3144 * triggered the creation of the Intent it is in.
3145 */
3146 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3147
3148 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003149 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3150 * before shutting down.
3151 *
3152 * {@hide}
3153 */
3154 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3155
3156 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003157 * 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 -07003158 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3159 * of restarting the application.
3160 */
3161 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3162
3163 /**
3164 * A String holding the phone number originally entered in
3165 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3166 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3167 */
3168 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003169
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003170 /**
3171 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3172 * intents to supply the uid the package had been assigned. Also an optional
3173 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3174 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3175 * purpose.
3176 */
3177 public static final String EXTRA_UID = "android.intent.extra.UID";
3178
3179 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003180 * @hide String array of package names.
3181 */
3182 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3183
3184 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003185 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3186 * intents to indicate whether this represents a full uninstall (removing
3187 * both the code and its data) or a partial uninstall (leaving its data,
3188 * implying that this is an update).
3189 */
3190 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003191
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003192 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003193 * @hide
3194 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3195 * intents to indicate that at this point the package has been removed for
3196 * all users on the device.
3197 */
3198 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3199 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3200
3201 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003202 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3203 * intents to indicate that this is a replacement of the package, so this
3204 * broadcast will immediately be followed by an add broadcast for a
3205 * different version of the same package.
3206 */
3207 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003208
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003210 * Used as an int extra field in {@link android.app.AlarmManager} intents
3211 * to tell the application being invoked how many pending alarms are being
3212 * delievered with the intent. For one-shot alarms this will always be 1.
3213 * For recurring alarms, this might be greater than 1 if the device was
3214 * asleep or powered off at the time an earlier alarm would have been
3215 * delivered.
3216 */
3217 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003218
Jacek Surazski86b6c532009-05-13 14:38:28 +02003219 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003220 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3221 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003222 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3223 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003224 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3225 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3226 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003227 */
3228 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3229
3230 /**
3231 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3232 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003233 */
3234 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3235
3236 /**
3237 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3238 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003239 */
3240 public static final int EXTRA_DOCK_STATE_DESK = 1;
3241
3242 /**
3243 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3244 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003245 */
3246 public static final int EXTRA_DOCK_STATE_CAR = 2;
3247
3248 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003249 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3250 * to represent that the phone is in a analog (low end) dock.
3251 */
3252 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3253
3254 /**
3255 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3256 * to represent that the phone is in a digital (high end) dock.
3257 */
3258 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3259
3260 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003261 * Boolean that can be supplied as meta-data with a dock activity, to
3262 * indicate that the dock should take over the home key when it is active.
3263 */
3264 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003265
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003266 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003267 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3268 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003269 */
3270 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3271
3272 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003273 * Used in the extra field in the remote intent. It's astring token passed with the
3274 * remote intent.
3275 */
3276 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3277 "android.intent.extra.remote_intent_token";
3278
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003279 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003280 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003281 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003282 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003283 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003284 "android.intent.extra.changed_component_name";
3285
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003286 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003287 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003288 * and contains a string array of all of the components that have changed. If
3289 * the state of the overall package has changed, then it will contain an entry
3290 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003291 */
3292 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3293 "android.intent.extra.changed_component_name_list";
3294
3295 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003296 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003297 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3298 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003299 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003300 */
3301 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3302 "android.intent.extra.changed_package_list";
3303
3304 /**
3305 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003306 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3307 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003308 * and contains an integer array of uids of all of the components
3309 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003310 */
3311 public static final String EXTRA_CHANGED_UID_LIST =
3312 "android.intent.extra.changed_uid_list";
3313
3314 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003315 * @hide
3316 * Magic extra system code can use when binding, to give a label for
3317 * who it is that has bound to a service. This is an integer giving
3318 * a framework string resource that can be displayed to the user.
3319 */
3320 public static final String EXTRA_CLIENT_LABEL =
3321 "android.intent.extra.client_label";
3322
3323 /**
3324 * @hide
3325 * Magic extra system code can use when binding, to give a PendingIntent object
3326 * that can be launched for the user to disable the system's use of this
3327 * service.
3328 */
3329 public static final String EXTRA_CLIENT_INTENT =
3330 "android.intent.extra.client_intent";
3331
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003332 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003333 * Extra used to indicate that an intent should only return data that is on
3334 * the local device. This is a boolean extra; the default is false. If true,
3335 * an implementation should only allow the user to select data that is
3336 * already on the device, not requiring it be downloaded from a remote
3337 * service when opened.
3338 *
3339 * @see #ACTION_GET_CONTENT
3340 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003341 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003342 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003343 */
3344 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003345 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003346
Amith Yamasani13593602012-03-22 16:16:17 -07003347 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003348 * Extra used to indicate that an intent can allow the user to select and
3349 * return multiple items. This is a boolean extra; the default is false. If
3350 * true, an implementation is allowed to present the user with a UI where
3351 * they can pick multiple items that are all returned to the caller. When
3352 * this happens, they should be returned as the {@link #getClipData()} part
3353 * of the result Intent.
3354 *
3355 * @see #ACTION_GET_CONTENT
3356 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003357 */
3358 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003359 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003360
3361 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003362 * The integer userHandle carried with broadcast intents related to addition, removal and
3363 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3364 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3365 *
Amith Yamasani13593602012-03-22 16:16:17 -07003366 * @hide
3367 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003368 public static final String EXTRA_USER_HANDLE =
3369 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003370
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003371 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003372 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3373 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3374 */
3375 public static final String EXTRA_USER =
Alexandra Gherghina3315f6b2014-09-05 15:48:06 +01003376 "android.intent.extra.USER";
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003377
3378 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003379 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003380 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3381 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003382 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003383 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3384
3385 /**
3386 * Extra sent in the intent to the BroadcastReceiver that handles
3387 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3388 * the restrictions as key/value pairs.
3389 */
3390 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3391 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003392
Amith Yamasani86118ba2013-03-28 14:33:16 -07003393 /**
3394 * Extra used in the response from a BroadcastReceiver that handles
3395 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3396 */
3397 public static final String EXTRA_RESTRICTIONS_INTENT =
3398 "android.intent.extra.restrictions_intent";
3399
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003400 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003401 * Extra used to communicate a set of acceptable MIME types. The type of the
3402 * extra is {@code String[]}. Values may be a combination of concrete MIME
3403 * types (such as "image/png") and/or partial MIME types (such as
3404 * "audio/*").
3405 *
3406 * @see #ACTION_GET_CONTENT
3407 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003408 */
3409 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3410
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003411 /**
3412 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3413 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003414 * When this is true, hardware devices can use this information to determine that
3415 * they shouldn't do a complete shutdown of their device since this is not a
3416 * complete shutdown down to the kernel, but only user space restarting.
3417 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003418 */
3419 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3420 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3421
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003422 /**
3423 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3424 * user has set their time format preferences to the 24 hour format.
3425 *
3426 * @hide for internal use only.
3427 */
3428 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3429 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3430
Jeff Sharkey004a4b22014-09-24 11:45:24 -07003431 /** {@hide} */
3432 public static final String EXTRA_REASON = "android.intent.extra.REASON";
3433
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003434 // ---------------------------------------------------------------------
3435 // ---------------------------------------------------------------------
3436 // Intent flags (see mFlags variable).
3437
Tor Norbyed9273d62013-05-30 15:59:53 -07003438 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003439 @IntDef(flag = true, value = {
3440 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3441 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003442 @Retention(RetentionPolicy.SOURCE)
3443 public @interface GrantUriMode {}
3444
Jeff Sharkey846318a2014-04-04 12:12:41 -07003445 /** @hide */
3446 @IntDef(flag = true, value = {
3447 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3448 @Retention(RetentionPolicy.SOURCE)
3449 public @interface AccessUriMode {}
3450
3451 /**
3452 * Test if given mode flags specify an access mode, which must be at least
3453 * read and/or write.
3454 *
3455 * @hide
3456 */
3457 public static boolean isAccessUriMode(int modeFlags) {
3458 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3459 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3460 }
3461
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003462 /**
3463 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003464 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003465 * specified in its ClipData. When applying to an Intent's ClipData,
3466 * all URIs as well as recursive traversals through data or other ClipData
3467 * in Intent items will be granted; only the grant flags of the top-level
3468 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003469 */
3470 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3471 /**
3472 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003473 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003474 * specified in its ClipData. When applying to an Intent's ClipData,
3475 * all URIs as well as recursive traversals through data or other ClipData
3476 * in Intent items will be granted; only the grant flags of the top-level
3477 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003478 */
3479 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3480 /**
3481 * Can be set by the caller to indicate that this Intent is coming from
3482 * a background operation, not from direct user interaction.
3483 */
3484 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3485 /**
3486 * A flag you can enable for debugging: when set, log messages will be
3487 * printed during the resolution of this intent to show you what has
3488 * been found to create the final resolved list.
3489 */
3490 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003491 /**
3492 * If set, this intent will not match any components in packages that
3493 * are currently stopped. If this is not set, then the default behavior
3494 * is to include such applications in the result.
3495 */
3496 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3497 /**
3498 * If set, this intent will always match any components in packages that
3499 * are currently stopped. This is the default behavior when
3500 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3501 * flags are set, this one wins (it allows overriding of exclude for
3502 * places where the framework may automatically set the exclude flag).
3503 */
3504 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003505
3506 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003507 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003508 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003509 * persisted across device reboots until explicitly revoked with
3510 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3511 * grant for possible persisting; the receiving application must call
3512 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3513 * actually persist.
3514 *
3515 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3516 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3517 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003518 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003519 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003520 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003521
3522 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003523 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3524 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3525 * applies to any URI that is a prefix match against the original granted
3526 * URI. (Without this flag, the URI must match exactly for access to be
3527 * granted.) Another URI is considered a prefix match only when scheme,
3528 * authority, and all path segments defined by the prefix are an exact
3529 * match.
3530 */
3531 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3532
3533 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003534 * If set, the new activity is not kept in the history stack. As soon as
3535 * the user navigates away from it, the activity is finished. This may also
3536 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3537 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003538 */
3539 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3540 /**
3541 * If set, the activity will not be launched if it is already running
3542 * at the top of the history stack.
3543 */
3544 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3545 /**
3546 * If set, this activity will become the start of a new task on this
3547 * history stack. A task (from the activity that started it to the
3548 * next task activity) defines an atomic group of activities that the
3549 * user can move to. Tasks can be moved to the foreground and background;
3550 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003551 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003552 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3553 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003554 *
3555 * <p>This flag is generally used by activities that want
3556 * to present a "launcher" style behavior: they give the user a list of
3557 * separate things that can be done, which otherwise run completely
3558 * independently of the activity launching them.
3559 *
3560 * <p>When using this flag, if a task is already running for the activity
3561 * you are now starting, then a new activity will not be started; instead,
3562 * the current task will simply be brought to the front of the screen with
3563 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3564 * to disable this behavior.
3565 *
3566 * <p>This flag can not be used when the caller is requesting a result from
3567 * the activity being launched.
3568 */
3569 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3570 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003571 * This flag is used to create a new task and launch an activity into it.
3572 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3573 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3574 * search through existing tasks for ones matching this Intent. Only if no such
3575 * task is found would a new task be created. When paired with
3576 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3577 * the search for a matching task and unconditionally start a new task.
3578 *
3579 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3580 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003581 * top-level application launcher.</strong> Used in conjunction with
3582 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3583 * behavior of bringing an existing task to the foreground. When set,
3584 * a new task is <em>always</em> started to host the Activity for the
3585 * Intent, regardless of whether there is already an existing task running
3586 * the same thing.
3587 *
3588 * <p><strong>Because the default system does not include graphical task management,
3589 * you should not use this flag unless you provide some way for a user to
3590 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003591 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003592 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3593 * creating new document tasks.
3594 *
3595 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
Paul Soulos628cb742014-09-19 11:00:52 -07003596 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003597 *
Scott Main7aee61f2011-02-08 11:25:01 -08003598 * <p>See
3599 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3600 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003601 *
3602 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3603 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003604 */
3605 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3606 /**
3607 * If set, and the activity being launched is already running in the
3608 * current task, then instead of launching a new instance of that activity,
3609 * all of the other activities on top of it will be closed and this Intent
3610 * will be delivered to the (now on top) old activity as a new Intent.
3611 *
3612 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3613 * If D calls startActivity() with an Intent that resolves to the component
3614 * of activity B, then C and D will be finished and B receive the given
3615 * Intent, resulting in the stack now being: A, B.
3616 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003617 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003618 * either receive the new intent you are starting here in its
3619 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003620 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003621 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3622 * the same intent, then it will be finished and re-created; for all other
3623 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3624 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003625 *
3626 * <p>This launch mode can also be used to good effect in conjunction with
3627 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3628 * of a task, it will bring any currently running instance of that task
3629 * to the foreground, and then clear it to its root state. This is
3630 * especially useful, for example, when launching an activity from the
3631 * notification manager.
3632 *
Scott Main7aee61f2011-02-08 11:25:01 -08003633 * <p>See
3634 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3635 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003636 */
3637 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3638 /**
3639 * If set and this intent is being used to launch a new activity from an
3640 * existing one, then the reply target of the existing activity will be
3641 * transfered to the new activity. This way the new activity can call
3642 * {@link android.app.Activity#setResult} and have that result sent back to
3643 * the reply target of the original activity.
3644 */
3645 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3646 /**
3647 * If set and this intent is being used to launch a new activity from an
3648 * existing one, the current activity will not be counted as the top
3649 * activity for deciding whether the new intent should be delivered to
3650 * the top instead of starting a new one. The previous activity will
3651 * be used as the top, with the assumption being that the current activity
3652 * will finish itself immediately.
3653 */
3654 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3655 /**
3656 * If set, the new activity is not kept in the list of recently launched
3657 * activities.
3658 */
3659 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3660 /**
3661 * This flag is not normally set by application code, but set for you by
3662 * the system as described in the
3663 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3664 * launchMode} documentation for the singleTask mode.
3665 */
3666 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3667 /**
3668 * If set, and this activity is either being started in a new task or
3669 * bringing to the top an existing task, then it will be launched as
3670 * the front door of the task. This will result in the application of
3671 * any affinities needed to have that task in the proper state (either
3672 * moving activities to or from it), or simply resetting that task to
3673 * its initial state if needed.
3674 */
3675 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3676 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003677 * This flag is not normally set by application code, but set for you by
3678 * the system if this activity is being launched from history
3679 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003680 */
3681 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003682 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003683 * @deprecated As of API 21 this performs identically to
3684 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003685 */
3686 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003687 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003688 * This flag is used to open a document into a new task rooted at the activity launched
3689 * by this Intent. Through the use of this flag, or its equivalent attribute,
3690 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3691 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003692 *
Craig Mautner026596b2014-05-21 15:35:44 -07003693 * <p>The use of the activity attribute form of this,
3694 * {@link android.R.attr#documentLaunchMode}, is
3695 * preferred over the Intent flag described here. The attribute form allows the
3696 * Activity to specify multiple document behavior for all launchers of the Activity
3697 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003698 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003699 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3700 * it is kept after the activity is finished is different than the use of
3701 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
3702 * this flag is being used to create a new recents entry, then by default that entry
3703 * will be removed once the activity is finished. You can modify this behavior with
3704 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
3705 *
Craig Mautner026596b2014-05-21 15:35:44 -07003706 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3707 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3708 * equivalent of the Activity manifest specifying {@link
3709 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3710 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3711 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003712 *
Craig Mautner026596b2014-05-21 15:35:44 -07003713 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003714 *
Craig Mautner026596b2014-05-21 15:35:44 -07003715 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003716 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3717 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003718 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003719 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003720 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003721 * callback from occurring on the current frontmost activity before it is
3722 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003723 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003724 * <p>Typically, an activity can rely on that callback to indicate that an
3725 * explicit user action has caused their activity to be moved out of the
3726 * foreground. The callback marks an appropriate point in the activity's
3727 * lifecycle for it to dismiss any notifications that it intends to display
3728 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003729 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003730 * <p>If an activity is ever started via any non-user-driven events such as
3731 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3732 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003733 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003734 */
3735 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003736 /**
3737 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3738 * this flag will cause the launched activity to be brought to the front of its
3739 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003740 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003741 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3742 * If D calls startActivity() with an Intent that resolves to the component
3743 * of activity B, then B will be brought to the front of the history stack,
3744 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003745 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003746 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003747 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003748 */
3749 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003750 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003751 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3752 * this flag will prevent the system from applying an activity transition
3753 * animation to go to the next activity state. This doesn't mean an
3754 * animation will never run -- if another activity change happens that doesn't
3755 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003756 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003757 * when you are going to do a series of activity operations but the
3758 * animation seen by the user shouldn't be driven by the first activity
3759 * change but rather a later one.
3760 */
3761 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3762 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003763 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3764 * this flag will cause any existing task that would be associated with the
3765 * activity to be cleared before the activity is started. That is, the activity
3766 * becomes the new root of an otherwise empty task, and any old activities
3767 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3768 */
3769 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3770 /**
3771 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3772 * this flag will cause a newly launching task to be placed on top of the current
3773 * home activity task (if there is one). That is, pressing back from the task
3774 * will always return the user to home even if that was not the last activity they
3775 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3776 */
3777 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3778 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07003779 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
3780 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003781 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07003782 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003783 * this flag. When set and the task's activity is finished, the recents
3784 * entry will remain in the interface for the user to re-launch it, like a
3785 * recents entry for a top-level application.
3786 * <p>
3787 * The receiving activity can override this request with
3788 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
3789 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07003790 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07003791 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07003792 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07003793
3794 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003795 * If set, when sending a broadcast only registered receivers will be
3796 * called -- no BroadcastReceiver components will be launched.
3797 */
3798 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003799 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003800 * If set, when sending a broadcast the new broadcast will replace
3801 * any existing pending broadcast that matches it. Matching is defined
3802 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3803 * true for the intents of the two broadcasts. When a match is found,
3804 * the new broadcast (and receivers associated with it) will replace the
3805 * existing one in the pending broadcast list, remaining at the same
3806 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003807 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003808 * <p>This flag is most typically used with sticky broadcasts, which
3809 * only care about delivering the most recent values of the broadcast
3810 * to their receivers.
3811 */
3812 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3813 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003814 * If set, when sending a broadcast the recipient is allowed to run at
3815 * foreground priority, with a shorter timeout interval. During normal
3816 * broadcasts the receivers are not automatically hoisted out of the
3817 * background priority class.
3818 */
3819 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3820 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003821 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3822 * They can still propagate results through to later receivers, but they can not prevent
3823 * later receivers from seeing the broadcast.
3824 */
3825 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3826 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003827 * If set, when sending a broadcast <i>before boot has completed</i> only
3828 * registered receivers will be called -- no BroadcastReceiver components
3829 * will be launched. Sticky intent state will be recorded properly even
3830 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3831 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003832 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003833 * <p>This flag is only for use by system sevices as a convenience to
3834 * avoid having to implement a more complex mechanism around detection
3835 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003836 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003837 * @hide
3838 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003839 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003840 /**
3841 * Set when this broadcast is for a boot upgrade, a special mode that
3842 * allows the broadcast to be sent before the system is ready and launches
3843 * the app process with no providers running in it.
3844 * @hide
3845 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003846 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003847
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003848 /**
3849 * @hide Flags that can't be changed with PendingIntent.
3850 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003851 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3852 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3853 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003854
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003855 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003856 // ---------------------------------------------------------------------
3857 // toUri() and parseUri() options.
3858
3859 /**
3860 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3861 * always has the "intent:" scheme. This syntax can be used when you want
3862 * to later disambiguate between URIs that are intended to describe an
3863 * Intent vs. all others that should be treated as raw URIs. When used
3864 * with {@link #parseUri}, any other scheme will result in a generic
3865 * VIEW action for that raw URI.
3866 */
3867 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003868
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003869 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003870
3871 private String mAction;
3872 private Uri mData;
3873 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003874 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003875 private ComponentName mComponent;
3876 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003877 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003878 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003879 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003880 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003881 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003882 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003883
3884 // ---------------------------------------------------------------------
3885
3886 /**
3887 * Create an empty intent.
3888 */
3889 public Intent() {
3890 }
3891
3892 /**
3893 * Copy constructor.
3894 */
3895 public Intent(Intent o) {
3896 this.mAction = o.mAction;
3897 this.mData = o.mData;
3898 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003899 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003900 this.mComponent = o.mComponent;
3901 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003902 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003903 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003904 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003905 }
3906 if (o.mExtras != null) {
3907 this.mExtras = new Bundle(o.mExtras);
3908 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003909 if (o.mSourceBounds != null) {
3910 this.mSourceBounds = new Rect(o.mSourceBounds);
3911 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003912 if (o.mSelector != null) {
3913 this.mSelector = new Intent(o.mSelector);
3914 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003915 if (o.mClipData != null) {
3916 this.mClipData = new ClipData(o.mClipData);
3917 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003918 }
3919
3920 @Override
3921 public Object clone() {
3922 return new Intent(this);
3923 }
3924
3925 private Intent(Intent o, boolean all) {
3926 this.mAction = o.mAction;
3927 this.mData = o.mData;
3928 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003929 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003930 this.mComponent = o.mComponent;
3931 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003932 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003933 }
3934 }
3935
3936 /**
3937 * Make a clone of only the parts of the Intent that are relevant for
3938 * filter matching: the action, data, type, component, and categories.
3939 */
3940 public Intent cloneFilter() {
3941 return new Intent(this, false);
3942 }
3943
3944 /**
3945 * Create an intent with a given action. All other fields (data, type,
3946 * class) are null. Note that the action <em>must</em> be in a
3947 * namespace because Intents are used globally in the system -- for
3948 * example the system VIEW action is android.intent.action.VIEW; an
3949 * application's custom action would be something like
3950 * com.google.app.myapp.CUSTOM_ACTION.
3951 *
3952 * @param action The Intent action, such as ACTION_VIEW.
3953 */
3954 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003955 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003956 }
3957
3958 /**
3959 * Create an intent with a given action and for a given data url. Note
3960 * that the action <em>must</em> be in a namespace because Intents are
3961 * used globally in the system -- for example the system VIEW action is
3962 * android.intent.action.VIEW; an application's custom action would be
3963 * something like com.google.app.myapp.CUSTOM_ACTION.
3964 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003965 * <p><em>Note: scheme and host name matching in the Android framework is
3966 * case-sensitive, unlike the formal RFC. As a result,
3967 * you should always ensure that you write your Uri with these elements
3968 * using lower case letters, and normalize any Uris you receive from
3969 * outside of Android to ensure the scheme and host is lower case.</em></p>
3970 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003971 * @param action The Intent action, such as ACTION_VIEW.
3972 * @param uri The Intent data URI.
3973 */
3974 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003975 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003976 mData = uri;
3977 }
3978
3979 /**
3980 * Create an intent for a specific component. All other fields (action, data,
3981 * type, class) are null, though they can be modified later with explicit
3982 * calls. This provides a convenient way to create an intent that is
3983 * intended to execute a hard-coded class name, rather than relying on the
3984 * system to find an appropriate class for you; see {@link #setComponent}
3985 * for more information on the repercussions of this.
3986 *
3987 * @param packageContext A Context of the application package implementing
3988 * this class.
3989 * @param cls The component class that is to be used for the intent.
3990 *
3991 * @see #setClass
3992 * @see #setComponent
3993 * @see #Intent(String, android.net.Uri , Context, Class)
3994 */
3995 public Intent(Context packageContext, Class<?> cls) {
3996 mComponent = new ComponentName(packageContext, cls);
3997 }
3998
3999 /**
4000 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004001 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004002 * construct the Intent and then calling {@link #setClass} to set its
4003 * class.
4004 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004005 * <p><em>Note: scheme and host name matching in the Android framework is
4006 * case-sensitive, unlike the formal RFC. As a result,
4007 * you should always ensure that you write your Uri with these elements
4008 * using lower case letters, and normalize any Uris you receive from
4009 * outside of Android to ensure the scheme and host is lower case.</em></p>
4010 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004011 * @param action The Intent action, such as ACTION_VIEW.
4012 * @param uri The Intent data URI.
4013 * @param packageContext A Context of the application package implementing
4014 * this class.
4015 * @param cls The component class that is to be used for the intent.
4016 *
4017 * @see #Intent(String, android.net.Uri)
4018 * @see #Intent(Context, Class)
4019 * @see #setClass
4020 * @see #setComponent
4021 */
4022 public Intent(String action, Uri uri,
4023 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004024 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004025 mData = uri;
4026 mComponent = new ComponentName(packageContext, cls);
4027 }
4028
4029 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004030 * Create an intent to launch the main (root) activity of a task. This
4031 * is the Intent that is started when the application's is launched from
4032 * Home. For anything else that wants to launch an application in the
4033 * same way, it is important that they use an Intent structured the same
4034 * way, and can use this function to ensure this is the case.
4035 *
4036 * <p>The returned Intent has the given Activity component as its explicit
4037 * component, {@link #ACTION_MAIN} as its action, and includes the
4038 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4039 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4040 * to do that through {@link #addFlags(int)} on the returned Intent.
4041 *
4042 * @param mainActivity The main activity component that this Intent will
4043 * launch.
4044 * @return Returns a newly created Intent that can be used to launch the
4045 * activity as a main application entry.
4046 *
4047 * @see #setClass
4048 * @see #setComponent
4049 */
4050 public static Intent makeMainActivity(ComponentName mainActivity) {
4051 Intent intent = new Intent(ACTION_MAIN);
4052 intent.setComponent(mainActivity);
4053 intent.addCategory(CATEGORY_LAUNCHER);
4054 return intent;
4055 }
4056
4057 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004058 * Make an Intent for the main activity of an application, without
4059 * specifying a specific activity to run but giving a selector to find
4060 * the activity. This results in a final Intent that is structured
4061 * the same as when the application is launched from
4062 * Home. For anything else that wants to launch an application in the
4063 * same way, it is important that they use an Intent structured the same
4064 * way, and can use this function to ensure this is the case.
4065 *
4066 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4067 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4068 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4069 * to do that through {@link #addFlags(int)} on the returned Intent.
4070 *
4071 * @param selectorAction The action name of the Intent's selector.
4072 * @param selectorCategory The name of a category to add to the Intent's
4073 * selector.
4074 * @return Returns a newly created Intent that can be used to launch the
4075 * activity as a main application entry.
4076 *
4077 * @see #setSelector(Intent)
4078 */
4079 public static Intent makeMainSelectorActivity(String selectorAction,
4080 String selectorCategory) {
4081 Intent intent = new Intent(ACTION_MAIN);
4082 intent.addCategory(CATEGORY_LAUNCHER);
4083 Intent selector = new Intent();
4084 selector.setAction(selectorAction);
4085 selector.addCategory(selectorCategory);
4086 intent.setSelector(selector);
4087 return intent;
4088 }
4089
4090 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004091 * Make an Intent that can be used to re-launch an application's task
4092 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4093 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4094 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4095 *
4096 * @param mainActivity The activity component that is the root of the
4097 * task; this is the activity that has been published in the application's
4098 * manifest as the main launcher icon.
4099 *
4100 * @return Returns a newly created Intent that can be used to relaunch the
4101 * activity's task in its root state.
4102 */
4103 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4104 Intent intent = makeMainActivity(mainActivity);
4105 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4106 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4107 return intent;
4108 }
4109
4110 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004111 * Call {@link #parseUri} with 0 flags.
4112 * @deprecated Use {@link #parseUri} instead.
4113 */
4114 @Deprecated
4115 public static Intent getIntent(String uri) throws URISyntaxException {
4116 return parseUri(uri, 0);
4117 }
Tom Taylord4a47292009-12-21 13:59:18 -08004118
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004119 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004120 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004121 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004122 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004123 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004124 *
4125 * <p>The URI given here must not be relative -- that is, it must include
4126 * the scheme and full path.
4127 *
4128 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004129 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004130 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004131 *
4132 * @return Intent The newly created Intent object.
4133 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004134 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4135 * it bad (as parsed by the Uri class) or the Intent data within the
4136 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004137 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004138 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004139 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004140 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004141 int i = 0;
4142 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004143 // Validate intent scheme for if requested.
4144 if ((flags&URI_INTENT_SCHEME) != 0) {
4145 if (!uri.startsWith("intent:")) {
4146 Intent intent = new Intent(ACTION_VIEW);
4147 try {
4148 intent.setData(Uri.parse(uri));
4149 } catch (IllegalArgumentException e) {
4150 throw new URISyntaxException(uri, e.getMessage());
4151 }
4152 return intent;
4153 }
4154 }
Tom Taylord4a47292009-12-21 13:59:18 -08004155
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004156 // simple case
4157 i = uri.lastIndexOf("#");
4158 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4159
4160 // old format Intent URI
4161 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004162
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004163 // new format
4164 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004165 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004166
4167 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004168 String data = i >= 0 ? uri.substring(0, i) : null;
4169 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004170 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004171
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004172 // loop over contents of Intent, all name=value;
4173 while (!uri.startsWith("end", i)) {
4174 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004175 if (eq < 0) eq = i-1;
4176 int semi = uri.indexOf(';', i);
4177 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004178
4179 // action
4180 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004181 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004182 }
4183
4184 // categories
4185 else if (uri.startsWith("category=", i)) {
4186 intent.addCategory(value);
4187 }
4188
4189 // type
4190 else if (uri.startsWith("type=", i)) {
4191 intent.mType = value;
4192 }
4193
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004194 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004195 else if (uri.startsWith("launchFlags=", i)) {
4196 intent.mFlags = Integer.decode(value).intValue();
4197 }
4198
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004199 // package
4200 else if (uri.startsWith("package=", i)) {
4201 intent.mPackage = value;
4202 }
4203
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004204 // component
4205 else if (uri.startsWith("component=", i)) {
4206 intent.mComponent = ComponentName.unflattenFromString(value);
4207 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004208
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004209 // scheme
4210 else if (uri.startsWith("scheme=", i)) {
4211 scheme = value;
4212 }
4213
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004214 // source bounds
4215 else if (uri.startsWith("sourceBounds=", i)) {
4216 intent.mSourceBounds = Rect.unflattenFromString(value);
4217 }
4218
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004219 // selector
4220 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4221 intent = new Intent();
4222 }
4223
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004224 // extra
4225 else {
4226 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004227 // create Bundle if it doesn't already exist
4228 if (intent.mExtras == null) intent.mExtras = new Bundle();
4229 Bundle b = intent.mExtras;
4230 // add EXTRA
4231 if (uri.startsWith("S.", i)) b.putString(key, value);
4232 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4233 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4234 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4235 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4236 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4237 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4238 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4239 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4240 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4241 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004242
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004243 // move to the next item
4244 i = semi + 1;
4245 }
4246
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004247 if (intent != baseIntent) {
4248 // The Intent had a selector; fix it up.
4249 baseIntent.setSelector(intent);
4250 intent = baseIntent;
4251 }
4252
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004253 if (data != null) {
4254 if (data.startsWith("intent:")) {
4255 data = data.substring(7);
4256 if (scheme != null) {
4257 data = scheme + ':' + data;
4258 }
4259 }
Tom Taylord4a47292009-12-21 13:59:18 -08004260
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004261 if (data.length() > 0) {
4262 try {
4263 intent.mData = Uri.parse(data);
4264 } catch (IllegalArgumentException e) {
4265 throw new URISyntaxException(uri, e.getMessage());
4266 }
4267 }
4268 }
Tom Taylord4a47292009-12-21 13:59:18 -08004269
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004270 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004271
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004272 } catch (IndexOutOfBoundsException e) {
4273 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4274 }
4275 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004276
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004277 public static Intent getIntentOld(String uri) throws URISyntaxException {
4278 Intent intent;
4279
4280 int i = uri.lastIndexOf('#');
4281 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004282 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004283 final int intentFragmentStart = i;
4284 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004285
4286 i++;
4287
4288 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004289 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004290 i += 7;
4291 int j = uri.indexOf(')', i);
4292 action = uri.substring(i, j);
4293 i = j + 1;
4294 }
4295
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004296 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004297
4298 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004299 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004300 i += 11;
4301 int j = uri.indexOf(')', i);
4302 while (i < j) {
4303 int sep = uri.indexOf('!', i);
Alan Viverette0adf32b2014-09-18 12:53:16 -07004304 if (sep < 0 || sep > j) sep = j;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004305 if (i < sep) {
4306 intent.addCategory(uri.substring(i, sep));
4307 }
4308 i = sep + 1;
4309 }
4310 i = j + 1;
4311 }
4312
4313 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004314 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004315 i += 5;
4316 int j = uri.indexOf(')', i);
4317 intent.mType = uri.substring(i, j);
4318 i = j + 1;
4319 }
4320
4321 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004322 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004323 i += 12;
4324 int j = uri.indexOf(')', i);
4325 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4326 i = j + 1;
4327 }
4328
4329 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004330 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004331 i += 10;
4332 int j = uri.indexOf(')', i);
4333 int sep = uri.indexOf('!', i);
4334 if (sep >= 0 && sep < j) {
4335 String pkg = uri.substring(i, sep);
4336 String cls = uri.substring(sep + 1, j);
4337 intent.mComponent = new ComponentName(pkg, cls);
4338 }
4339 i = j + 1;
4340 }
4341
4342 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004343 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004344 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004345
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004346 final int closeParen = uri.indexOf(')', i);
4347 if (closeParen == -1) throw new URISyntaxException(uri,
4348 "EXTRA missing trailing ')'", i);
4349
4350 while (i < closeParen) {
4351 // fetch the key value
4352 int j = uri.indexOf('=', i);
4353 if (j <= i + 1 || i >= closeParen) {
4354 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4355 }
4356 char type = uri.charAt(i);
4357 i++;
4358 String key = uri.substring(i, j);
4359 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004360
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004361 // get type-value
4362 j = uri.indexOf('!', i);
4363 if (j == -1 || j >= closeParen) j = closeParen;
4364 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4365 String value = uri.substring(i, j);
4366 i = j;
4367
4368 // create Bundle if it doesn't already exist
4369 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004370
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004371 // add item to bundle
4372 try {
4373 switch (type) {
4374 case 'S':
4375 intent.mExtras.putString(key, Uri.decode(value));
4376 break;
4377 case 'B':
4378 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4379 break;
4380 case 'b':
4381 intent.mExtras.putByte(key, Byte.parseByte(value));
4382 break;
4383 case 'c':
4384 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4385 break;
4386 case 'd':
4387 intent.mExtras.putDouble(key, Double.parseDouble(value));
4388 break;
4389 case 'f':
4390 intent.mExtras.putFloat(key, Float.parseFloat(value));
4391 break;
4392 case 'i':
4393 intent.mExtras.putInt(key, Integer.parseInt(value));
4394 break;
4395 case 'l':
4396 intent.mExtras.putLong(key, Long.parseLong(value));
4397 break;
4398 case 's':
4399 intent.mExtras.putShort(key, Short.parseShort(value));
4400 break;
4401 default:
4402 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4403 }
4404 } catch (NumberFormatException e) {
4405 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4406 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004407
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004408 char ch = uri.charAt(i);
4409 if (ch == ')') break;
4410 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4411 i++;
4412 }
4413 }
4414
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004415 if (isIntentFragment) {
4416 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4417 } else {
4418 intent.mData = Uri.parse(uri);
4419 }
Tom Taylord4a47292009-12-21 13:59:18 -08004420
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004421 if (intent.mAction == null) {
4422 // By default, if no action is specified, then use VIEW.
4423 intent.mAction = ACTION_VIEW;
4424 }
4425
4426 } else {
4427 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4428 }
4429
4430 return intent;
4431 }
4432
4433 /**
4434 * Retrieve the general action to be performed, such as
4435 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4436 * the information in the intent should be interpreted -- most importantly,
4437 * what to do with the data returned by {@link #getData}.
4438 *
4439 * @return The action of this intent or null if none is specified.
4440 *
4441 * @see #setAction
4442 */
4443 public String getAction() {
4444 return mAction;
4445 }
4446
4447 /**
4448 * Retrieve data this intent is operating on. This URI specifies the name
4449 * of the data; often it uses the content: scheme, specifying data in a
4450 * content provider. Other schemes may be handled by specific activities,
4451 * such as http: by the web browser.
4452 *
4453 * @return The URI of the data this intent is targeting or null.
4454 *
4455 * @see #getScheme
4456 * @see #setData
4457 */
4458 public Uri getData() {
4459 return mData;
4460 }
4461
4462 /**
4463 * The same as {@link #getData()}, but returns the URI as an encoded
4464 * String.
4465 */
4466 public String getDataString() {
4467 return mData != null ? mData.toString() : null;
4468 }
4469
4470 /**
4471 * Return the scheme portion of the intent's data. If the data is null or
4472 * does not include a scheme, null is returned. Otherwise, the scheme
4473 * prefix without the final ':' is returned, i.e. "http".
4474 *
4475 * <p>This is the same as calling getData().getScheme() (and checking for
4476 * null data).
4477 *
4478 * @return The scheme of this intent.
4479 *
4480 * @see #getData
4481 */
4482 public String getScheme() {
4483 return mData != null ? mData.getScheme() : null;
4484 }
4485
4486 /**
4487 * Retrieve any explicit MIME type included in the intent. This is usually
4488 * null, as the type is determined by the intent data.
4489 *
4490 * @return If a type was manually set, it is returned; else null is
4491 * returned.
4492 *
4493 * @see #resolveType(ContentResolver)
4494 * @see #setType
4495 */
4496 public String getType() {
4497 return mType;
4498 }
4499
4500 /**
4501 * Return the MIME data type of this intent. If the type field is
4502 * explicitly set, that is simply returned. Otherwise, if the data is set,
4503 * the type of that data is returned. If neither fields are set, a null is
4504 * returned.
4505 *
4506 * @return The MIME type of this intent.
4507 *
4508 * @see #getType
4509 * @see #resolveType(ContentResolver)
4510 */
4511 public String resolveType(Context context) {
4512 return resolveType(context.getContentResolver());
4513 }
4514
4515 /**
4516 * Return the MIME data type of this intent. If the type field is
4517 * explicitly set, that is simply returned. Otherwise, if the data is set,
4518 * the type of that data is returned. If neither fields are set, a null is
4519 * returned.
4520 *
4521 * @param resolver A ContentResolver that can be used to determine the MIME
4522 * type of the intent's data.
4523 *
4524 * @return The MIME type of this intent.
4525 *
4526 * @see #getType
4527 * @see #resolveType(Context)
4528 */
4529 public String resolveType(ContentResolver resolver) {
4530 if (mType != null) {
4531 return mType;
4532 }
4533 if (mData != null) {
4534 if ("content".equals(mData.getScheme())) {
4535 return resolver.getType(mData);
4536 }
4537 }
4538 return null;
4539 }
4540
4541 /**
4542 * Return the MIME data type of this intent, only if it will be needed for
4543 * intent resolution. This is not generally useful for application code;
4544 * it is used by the frameworks for communicating with back-end system
4545 * services.
4546 *
4547 * @param resolver A ContentResolver that can be used to determine the MIME
4548 * type of the intent's data.
4549 *
4550 * @return The MIME type of this intent, or null if it is unknown or not
4551 * needed.
4552 */
4553 public String resolveTypeIfNeeded(ContentResolver resolver) {
4554 if (mComponent != null) {
4555 return mType;
4556 }
4557 return resolveType(resolver);
4558 }
4559
4560 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004561 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004562 *
4563 * @param category The category to check.
4564 *
4565 * @return boolean True if the intent contains the category, else false.
4566 *
4567 * @see #getCategories
4568 * @see #addCategory
4569 */
4570 public boolean hasCategory(String category) {
4571 return mCategories != null && mCategories.contains(category);
4572 }
4573
4574 /**
4575 * Return the set of all categories in the intent. If there are no categories,
4576 * returns NULL.
4577 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004578 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004579 *
4580 * @see #hasCategory
4581 * @see #addCategory
4582 */
4583 public Set<String> getCategories() {
4584 return mCategories;
4585 }
4586
4587 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004588 * Return the specific selector associated with this Intent. If there is
4589 * none, returns null. See {@link #setSelector} for more information.
4590 *
4591 * @see #setSelector
4592 */
4593 public Intent getSelector() {
4594 return mSelector;
4595 }
4596
4597 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004598 * Return the {@link ClipData} associated with this Intent. If there is
4599 * none, returns null. See {@link #setClipData} for more information.
4600 *
John Spurlock125d1332013-11-25 11:58:37 -05004601 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004602 */
4603 public ClipData getClipData() {
4604 return mClipData;
4605 }
4606
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004607 /** @hide */
4608 public int getContentUserHint() {
4609 return mContentUserHint;
4610 }
4611
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004612 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004613 * Sets the ClassLoader that will be used when unmarshalling
4614 * any Parcelable values from the extras of this Intent.
4615 *
4616 * @param loader a ClassLoader, or null to use the default loader
4617 * at the time of unmarshalling.
4618 */
4619 public void setExtrasClassLoader(ClassLoader loader) {
4620 if (mExtras != null) {
4621 mExtras.setClassLoader(loader);
4622 }
4623 }
4624
4625 /**
4626 * Returns true if an extra value is associated with the given name.
4627 * @param name the extra's name
4628 * @return true if the given extra is present.
4629 */
4630 public boolean hasExtra(String name) {
4631 return mExtras != null && mExtras.containsKey(name);
4632 }
4633
4634 /**
4635 * Returns true if the Intent's extras contain a parcelled file descriptor.
4636 * @return true if the Intent contains a parcelled file descriptor.
4637 */
4638 public boolean hasFileDescriptors() {
4639 return mExtras != null && mExtras.hasFileDescriptors();
4640 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004641
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004642 /** @hide */
4643 public void setAllowFds(boolean allowFds) {
4644 if (mExtras != null) {
4645 mExtras.setAllowFds(allowFds);
4646 }
4647 }
4648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004649 /**
4650 * Retrieve extended data from the intent.
4651 *
4652 * @param name The name of the desired item.
4653 *
4654 * @return the value of an item that previously added with putExtra()
4655 * or null if none was found.
4656 *
4657 * @deprecated
4658 * @hide
4659 */
4660 @Deprecated
4661 public Object getExtra(String name) {
4662 return getExtra(name, null);
4663 }
4664
4665 /**
4666 * Retrieve extended data from the intent.
4667 *
4668 * @param name The name of the desired item.
4669 * @param defaultValue the value to be returned if no value of the desired
4670 * type is stored with the given name.
4671 *
4672 * @return the value of an item that previously added with putExtra()
4673 * or the default value if none was found.
4674 *
4675 * @see #putExtra(String, boolean)
4676 */
4677 public boolean getBooleanExtra(String name, boolean defaultValue) {
4678 return mExtras == null ? defaultValue :
4679 mExtras.getBoolean(name, defaultValue);
4680 }
4681
4682 /**
4683 * Retrieve extended data from the intent.
4684 *
4685 * @param name The name of the desired item.
4686 * @param defaultValue the value to be returned if no value of the desired
4687 * type is stored with the given name.
4688 *
4689 * @return the value of an item that previously added with putExtra()
4690 * or the default value if none was found.
4691 *
4692 * @see #putExtra(String, byte)
4693 */
4694 public byte getByteExtra(String name, byte defaultValue) {
4695 return mExtras == null ? defaultValue :
4696 mExtras.getByte(name, defaultValue);
4697 }
4698
4699 /**
4700 * Retrieve extended data from the intent.
4701 *
4702 * @param name The name of the desired item.
4703 * @param defaultValue the value to be returned if no value of the desired
4704 * type is stored with the given name.
4705 *
4706 * @return the value of an item that previously added with putExtra()
4707 * or the default value if none was found.
4708 *
4709 * @see #putExtra(String, short)
4710 */
4711 public short getShortExtra(String name, short defaultValue) {
4712 return mExtras == null ? defaultValue :
4713 mExtras.getShort(name, defaultValue);
4714 }
4715
4716 /**
4717 * Retrieve extended data from the intent.
4718 *
4719 * @param name The name of the desired item.
4720 * @param defaultValue the value to be returned if no value of the desired
4721 * type is stored with the given name.
4722 *
4723 * @return the value of an item that previously added with putExtra()
4724 * or the default value if none was found.
4725 *
4726 * @see #putExtra(String, char)
4727 */
4728 public char getCharExtra(String name, char defaultValue) {
4729 return mExtras == null ? defaultValue :
4730 mExtras.getChar(name, defaultValue);
4731 }
4732
4733 /**
4734 * Retrieve extended data from the intent.
4735 *
4736 * @param name The name of the desired item.
4737 * @param defaultValue the value to be returned if no value of the desired
4738 * type is stored with the given name.
4739 *
4740 * @return the value of an item that previously added with putExtra()
4741 * or the default value if none was found.
4742 *
4743 * @see #putExtra(String, int)
4744 */
4745 public int getIntExtra(String name, int defaultValue) {
4746 return mExtras == null ? defaultValue :
4747 mExtras.getInt(name, defaultValue);
4748 }
4749
4750 /**
4751 * Retrieve extended data from the intent.
4752 *
4753 * @param name The name of the desired item.
4754 * @param defaultValue the value to be returned if no value of the desired
4755 * type is stored with the given name.
4756 *
4757 * @return the value of an item that previously added with putExtra()
4758 * or the default value if none was found.
4759 *
4760 * @see #putExtra(String, long)
4761 */
4762 public long getLongExtra(String name, long defaultValue) {
4763 return mExtras == null ? defaultValue :
4764 mExtras.getLong(name, defaultValue);
4765 }
4766
4767 /**
4768 * Retrieve extended data from the intent.
4769 *
4770 * @param name The name of the desired item.
4771 * @param defaultValue the value to be returned if no value of the desired
4772 * type is stored with the given name.
4773 *
4774 * @return the value of an item that previously added with putExtra(),
4775 * or the default value if no such item is present
4776 *
4777 * @see #putExtra(String, float)
4778 */
4779 public float getFloatExtra(String name, float defaultValue) {
4780 return mExtras == null ? defaultValue :
4781 mExtras.getFloat(name, defaultValue);
4782 }
4783
4784 /**
4785 * Retrieve extended data from the intent.
4786 *
4787 * @param name The name of the desired item.
4788 * @param defaultValue the value to be returned if no value of the desired
4789 * type is stored with the given name.
4790 *
4791 * @return the value of an item that previously added with putExtra()
4792 * or the default value if none was found.
4793 *
4794 * @see #putExtra(String, double)
4795 */
4796 public double getDoubleExtra(String name, double defaultValue) {
4797 return mExtras == null ? defaultValue :
4798 mExtras.getDouble(name, defaultValue);
4799 }
4800
4801 /**
4802 * Retrieve extended data from the intent.
4803 *
4804 * @param name The name of the desired item.
4805 *
4806 * @return the value of an item that previously added with putExtra()
4807 * or null if no String value was found.
4808 *
4809 * @see #putExtra(String, String)
4810 */
4811 public String getStringExtra(String name) {
4812 return mExtras == null ? null : mExtras.getString(name);
4813 }
4814
4815 /**
4816 * Retrieve extended data from the intent.
4817 *
4818 * @param name The name of the desired item.
4819 *
4820 * @return the value of an item that previously added with putExtra()
4821 * or null if no CharSequence value was found.
4822 *
4823 * @see #putExtra(String, CharSequence)
4824 */
4825 public CharSequence getCharSequenceExtra(String name) {
4826 return mExtras == null ? null : mExtras.getCharSequence(name);
4827 }
4828
4829 /**
4830 * Retrieve extended data from the intent.
4831 *
4832 * @param name The name of the desired item.
4833 *
4834 * @return the value of an item that previously added with putExtra()
4835 * or null if no Parcelable value was found.
4836 *
4837 * @see #putExtra(String, Parcelable)
4838 */
4839 public <T extends Parcelable> T getParcelableExtra(String name) {
4840 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4841 }
4842
4843 /**
4844 * Retrieve extended data from the intent.
4845 *
4846 * @param name The name of the desired item.
4847 *
4848 * @return the value of an item that previously added with putExtra()
4849 * or null if no Parcelable[] value was found.
4850 *
4851 * @see #putExtra(String, Parcelable[])
4852 */
4853 public Parcelable[] getParcelableArrayExtra(String name) {
4854 return mExtras == null ? null : mExtras.getParcelableArray(name);
4855 }
4856
4857 /**
4858 * Retrieve extended data from the intent.
4859 *
4860 * @param name The name of the desired item.
4861 *
4862 * @return the value of an item that previously added with putExtra()
4863 * or null if no ArrayList<Parcelable> value was found.
4864 *
4865 * @see #putParcelableArrayListExtra(String, ArrayList)
4866 */
4867 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4868 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4869 }
4870
4871 /**
4872 * Retrieve extended data from the intent.
4873 *
4874 * @param name The name of the desired item.
4875 *
4876 * @return the value of an item that previously added with putExtra()
4877 * or null if no Serializable value was found.
4878 *
4879 * @see #putExtra(String, Serializable)
4880 */
4881 public Serializable getSerializableExtra(String name) {
4882 return mExtras == null ? null : mExtras.getSerializable(name);
4883 }
4884
4885 /**
4886 * Retrieve extended data from the intent.
4887 *
4888 * @param name The name of the desired item.
4889 *
4890 * @return the value of an item that previously added with putExtra()
4891 * or null if no ArrayList<Integer> value was found.
4892 *
4893 * @see #putIntegerArrayListExtra(String, ArrayList)
4894 */
4895 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4896 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4897 }
4898
4899 /**
4900 * Retrieve extended data from the intent.
4901 *
4902 * @param name The name of the desired item.
4903 *
4904 * @return the value of an item that previously added with putExtra()
4905 * or null if no ArrayList<String> value was found.
4906 *
4907 * @see #putStringArrayListExtra(String, ArrayList)
4908 */
4909 public ArrayList<String> getStringArrayListExtra(String name) {
4910 return mExtras == null ? null : mExtras.getStringArrayList(name);
4911 }
4912
4913 /**
4914 * Retrieve extended data from the intent.
4915 *
4916 * @param name The name of the desired item.
4917 *
4918 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004919 * or null if no ArrayList<CharSequence> value was found.
4920 *
4921 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4922 */
4923 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4924 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4925 }
4926
4927 /**
4928 * Retrieve extended data from the intent.
4929 *
4930 * @param name The name of the desired item.
4931 *
4932 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004933 * or null if no boolean array value was found.
4934 *
4935 * @see #putExtra(String, boolean[])
4936 */
4937 public boolean[] getBooleanArrayExtra(String name) {
4938 return mExtras == null ? null : mExtras.getBooleanArray(name);
4939 }
4940
4941 /**
4942 * Retrieve extended data from the intent.
4943 *
4944 * @param name The name of the desired item.
4945 *
4946 * @return the value of an item that previously added with putExtra()
4947 * or null if no byte array value was found.
4948 *
4949 * @see #putExtra(String, byte[])
4950 */
4951 public byte[] getByteArrayExtra(String name) {
4952 return mExtras == null ? null : mExtras.getByteArray(name);
4953 }
4954
4955 /**
4956 * Retrieve extended data from the intent.
4957 *
4958 * @param name The name of the desired item.
4959 *
4960 * @return the value of an item that previously added with putExtra()
4961 * or null if no short array value was found.
4962 *
4963 * @see #putExtra(String, short[])
4964 */
4965 public short[] getShortArrayExtra(String name) {
4966 return mExtras == null ? null : mExtras.getShortArray(name);
4967 }
4968
4969 /**
4970 * Retrieve extended data from the intent.
4971 *
4972 * @param name The name of the desired item.
4973 *
4974 * @return the value of an item that previously added with putExtra()
4975 * or null if no char array value was found.
4976 *
4977 * @see #putExtra(String, char[])
4978 */
4979 public char[] getCharArrayExtra(String name) {
4980 return mExtras == null ? null : mExtras.getCharArray(name);
4981 }
4982
4983 /**
4984 * Retrieve extended data from the intent.
4985 *
4986 * @param name The name of the desired item.
4987 *
4988 * @return the value of an item that previously added with putExtra()
4989 * or null if no int array value was found.
4990 *
4991 * @see #putExtra(String, int[])
4992 */
4993 public int[] getIntArrayExtra(String name) {
4994 return mExtras == null ? null : mExtras.getIntArray(name);
4995 }
4996
4997 /**
4998 * Retrieve extended data from the intent.
4999 *
5000 * @param name The name of the desired item.
5001 *
5002 * @return the value of an item that previously added with putExtra()
5003 * or null if no long array value was found.
5004 *
5005 * @see #putExtra(String, long[])
5006 */
5007 public long[] getLongArrayExtra(String name) {
5008 return mExtras == null ? null : mExtras.getLongArray(name);
5009 }
5010
5011 /**
5012 * Retrieve extended data from the intent.
5013 *
5014 * @param name The name of the desired item.
5015 *
5016 * @return the value of an item that previously added with putExtra()
5017 * or null if no float array value was found.
5018 *
5019 * @see #putExtra(String, float[])
5020 */
5021 public float[] getFloatArrayExtra(String name) {
5022 return mExtras == null ? null : mExtras.getFloatArray(name);
5023 }
5024
5025 /**
5026 * Retrieve extended data from the intent.
5027 *
5028 * @param name The name of the desired item.
5029 *
5030 * @return the value of an item that previously added with putExtra()
5031 * or null if no double array value was found.
5032 *
5033 * @see #putExtra(String, double[])
5034 */
5035 public double[] getDoubleArrayExtra(String name) {
5036 return mExtras == null ? null : mExtras.getDoubleArray(name);
5037 }
5038
5039 /**
5040 * Retrieve extended data from the intent.
5041 *
5042 * @param name The name of the desired item.
5043 *
5044 * @return the value of an item that previously added with putExtra()
5045 * or null if no String array value was found.
5046 *
5047 * @see #putExtra(String, String[])
5048 */
5049 public String[] getStringArrayExtra(String name) {
5050 return mExtras == null ? null : mExtras.getStringArray(name);
5051 }
5052
5053 /**
5054 * Retrieve extended data from the intent.
5055 *
5056 * @param name The name of the desired item.
5057 *
5058 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005059 * or null if no CharSequence array value was found.
5060 *
5061 * @see #putExtra(String, CharSequence[])
5062 */
5063 public CharSequence[] getCharSequenceArrayExtra(String name) {
5064 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5065 }
5066
5067 /**
5068 * Retrieve extended data from the intent.
5069 *
5070 * @param name The name of the desired item.
5071 *
5072 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005073 * or null if no Bundle value was found.
5074 *
5075 * @see #putExtra(String, Bundle)
5076 */
5077 public Bundle getBundleExtra(String name) {
5078 return mExtras == null ? null : mExtras.getBundle(name);
5079 }
5080
5081 /**
5082 * Retrieve extended data from the intent.
5083 *
5084 * @param name The name of the desired item.
5085 *
5086 * @return the value of an item that previously added with putExtra()
5087 * or null if no IBinder value was found.
5088 *
5089 * @see #putExtra(String, IBinder)
5090 *
5091 * @deprecated
5092 * @hide
5093 */
5094 @Deprecated
5095 public IBinder getIBinderExtra(String name) {
5096 return mExtras == null ? null : mExtras.getIBinder(name);
5097 }
5098
5099 /**
5100 * Retrieve extended data from the intent.
5101 *
5102 * @param name The name of the desired item.
5103 * @param defaultValue The default value to return in case no item is
5104 * associated with the key 'name'
5105 *
5106 * @return the value of an item that previously added with putExtra()
5107 * or defaultValue if none was found.
5108 *
5109 * @see #putExtra
5110 *
5111 * @deprecated
5112 * @hide
5113 */
5114 @Deprecated
5115 public Object getExtra(String name, Object defaultValue) {
5116 Object result = defaultValue;
5117 if (mExtras != null) {
5118 Object result2 = mExtras.get(name);
5119 if (result2 != null) {
5120 result = result2;
5121 }
5122 }
5123
5124 return result;
5125 }
5126
5127 /**
5128 * Retrieves a map of extended data from the intent.
5129 *
5130 * @return the map of all extras previously added with putExtra(),
5131 * or null if none have been added.
5132 */
5133 public Bundle getExtras() {
5134 return (mExtras != null)
5135 ? new Bundle(mExtras)
5136 : null;
5137 }
5138
5139 /**
5140 * Retrieve any special flags associated with this intent. You will
5141 * normally just set them with {@link #setFlags} and let the system
5142 * take the appropriate action with them.
5143 *
5144 * @return int The currently set flags.
5145 *
5146 * @see #setFlags
5147 */
5148 public int getFlags() {
5149 return mFlags;
5150 }
5151
Dianne Hackborne7f97212011-02-24 14:40:20 -08005152 /** @hide */
5153 public boolean isExcludingStopped() {
5154 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5155 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5156 }
5157
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005158 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005159 * Retrieve the application package name this Intent is limited to. When
5160 * resolving an Intent, if non-null this limits the resolution to only
5161 * components in the given application package.
5162 *
5163 * @return The name of the application package for the Intent.
5164 *
5165 * @see #resolveActivity
5166 * @see #setPackage
5167 */
5168 public String getPackage() {
5169 return mPackage;
5170 }
5171
5172 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005173 * Retrieve the concrete component associated with the intent. When receiving
5174 * an intent, this is the component that was found to best handle it (that is,
5175 * yourself) and will always be non-null; in all other cases it will be
5176 * null unless explicitly set.
5177 *
5178 * @return The name of the application component to handle the intent.
5179 *
5180 * @see #resolveActivity
5181 * @see #setComponent
5182 */
5183 public ComponentName getComponent() {
5184 return mComponent;
5185 }
5186
5187 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005188 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5189 * used as a hint to the receiver for animations and the like. Null means that there
5190 * is no source bounds.
5191 */
5192 public Rect getSourceBounds() {
5193 return mSourceBounds;
5194 }
5195
5196 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005197 * Return the Activity component that should be used to handle this intent.
5198 * The appropriate component is determined based on the information in the
5199 * intent, evaluated as follows:
5200 *
5201 * <p>If {@link #getComponent} returns an explicit class, that is returned
5202 * without any further consideration.
5203 *
5204 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5205 * category to be considered.
5206 *
5207 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5208 * action.
5209 *
5210 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5211 * this type.
5212 *
5213 * <p>If {@link #addCategory} has added any categories, the activity must
5214 * handle ALL of the categories specified.
5215 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005216 * <p>If {@link #getPackage} is non-NULL, only activity components in
5217 * that application package will be considered.
5218 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005219 * <p>If there are no activities that satisfy all of these conditions, a
5220 * null string is returned.
5221 *
5222 * <p>If multiple activities are found to satisfy the intent, the one with
5223 * the highest priority will be used. If there are multiple activities
5224 * with the same priority, the system will either pick the best activity
5225 * based on user preference, or resolve to a system class that will allow
5226 * the user to pick an activity and forward from there.
5227 *
5228 * <p>This method is implemented simply by calling
5229 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5230 * true.</p>
5231 * <p> This API is called for you as part of starting an activity from an
5232 * intent. You do not normally need to call it yourself.</p>
5233 *
5234 * @param pm The package manager with which to resolve the Intent.
5235 *
5236 * @return Name of the component implementing an activity that can
5237 * display the intent.
5238 *
5239 * @see #setComponent
5240 * @see #getComponent
5241 * @see #resolveActivityInfo
5242 */
5243 public ComponentName resolveActivity(PackageManager pm) {
5244 if (mComponent != null) {
5245 return mComponent;
5246 }
5247
5248 ResolveInfo info = pm.resolveActivity(
5249 this, PackageManager.MATCH_DEFAULT_ONLY);
5250 if (info != null) {
5251 return new ComponentName(
5252 info.activityInfo.applicationInfo.packageName,
5253 info.activityInfo.name);
5254 }
5255
5256 return null;
5257 }
5258
5259 /**
5260 * Resolve the Intent into an {@link ActivityInfo}
5261 * describing the activity that should execute the intent. Resolution
5262 * follows the same rules as described for {@link #resolveActivity}, but
5263 * you get back the completely information about the resolved activity
5264 * instead of just its class name.
5265 *
5266 * @param pm The package manager with which to resolve the Intent.
5267 * @param flags Addition information to retrieve as per
5268 * {@link PackageManager#getActivityInfo(ComponentName, int)
5269 * PackageManager.getActivityInfo()}.
5270 *
5271 * @return PackageManager.ActivityInfo
5272 *
5273 * @see #resolveActivity
5274 */
5275 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5276 ActivityInfo ai = null;
5277 if (mComponent != null) {
5278 try {
5279 ai = pm.getActivityInfo(mComponent, flags);
5280 } catch (PackageManager.NameNotFoundException e) {
5281 // ignore
5282 }
5283 } else {
5284 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005285 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005286 if (info != null) {
5287 ai = info.activityInfo;
5288 }
5289 }
5290
5291 return ai;
5292 }
5293
5294 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005295 * Special function for use by the system to resolve service
5296 * intents to system apps. Throws an exception if there are
5297 * multiple potential matches to the Intent. Returns null if
5298 * there are no matches.
5299 * @hide
5300 */
5301 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5302 if (mComponent != null) {
5303 return mComponent;
5304 }
5305
5306 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5307 if (results == null) {
5308 return null;
5309 }
5310 ComponentName comp = null;
5311 for (int i=0; i<results.size(); i++) {
5312 ResolveInfo ri = results.get(i);
5313 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5314 continue;
5315 }
5316 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5317 ri.serviceInfo.name);
5318 if (comp != null) {
5319 throw new IllegalStateException("Multiple system services handle " + this
5320 + ": " + comp + ", " + foundComp);
5321 }
5322 comp = foundComp;
5323 }
5324 return comp;
5325 }
5326
5327 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005328 * Set the general action to be performed.
5329 *
5330 * @param action An action name, such as ACTION_VIEW. Application-specific
5331 * actions should be prefixed with the vendor's package name.
5332 *
5333 * @return Returns the same Intent object, for chaining multiple calls
5334 * into a single statement.
5335 *
5336 * @see #getAction
5337 */
5338 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005339 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005340 return this;
5341 }
5342
5343 /**
5344 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005345 * clears any type that was previously set by {@link #setType} or
5346 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005347 *
Nick Pellyccae4122012-01-09 14:12:58 -08005348 * <p><em>Note: scheme matching in the Android framework is
5349 * case-sensitive, unlike the formal RFC. As a result,
5350 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005351 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005352 * {@link #setDataAndNormalize}
5353 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005354 *
Nick Pellyccae4122012-01-09 14:12:58 -08005355 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005356 *
5357 * @return Returns the same Intent object, for chaining multiple calls
5358 * into a single statement.
5359 *
5360 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005361 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005362 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005363 */
5364 public Intent setData(Uri data) {
5365 mData = data;
5366 mType = null;
5367 return this;
5368 }
5369
5370 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005371 * Normalize and set the data this intent is operating on.
5372 *
5373 * <p>This method automatically clears any type that was
5374 * previously set (for example, by {@link #setType}).
5375 *
5376 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005377 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005378 * so really this is just a convenience method for
5379 * <pre>
5380 * setData(data.normalize())
5381 * </pre>
5382 *
5383 * @param data The Uri of the data this intent is now targeting.
5384 *
5385 * @return Returns the same Intent object, for chaining multiple calls
5386 * into a single statement.
5387 *
5388 * @see #getData
5389 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005390 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005391 */
5392 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005393 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005394 }
5395
5396 /**
5397 * Set an explicit MIME data type.
5398 *
5399 * <p>This is used to create intents that only specify a type and not data,
5400 * for example to indicate the type of data to return.
5401 *
5402 * <p>This method automatically clears any data that was
5403 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005404 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005405 * <p><em>Note: MIME type matching in the Android framework is
5406 * case-sensitive, unlike formal RFC MIME types. As a result,
5407 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005408 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5409 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005410 *
5411 * @param type The MIME type of the data being handled by this intent.
5412 *
5413 * @return Returns the same Intent object, for chaining multiple calls
5414 * into a single statement.
5415 *
5416 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005417 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005418 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005419 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005420 */
5421 public Intent setType(String type) {
5422 mData = null;
5423 mType = type;
5424 return this;
5425 }
5426
5427 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005428 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005429 *
Nick Pellyccae4122012-01-09 14:12:58 -08005430 * <p>This is used to create intents that only specify a type and not data,
5431 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005432 *
Nick Pellyccae4122012-01-09 14:12:58 -08005433 * <p>This method automatically clears any data that was
5434 * previously set (for example by {@link #setData}).
5435 *
5436 * <p>The MIME type is normalized using
5437 * {@link #normalizeMimeType} before it is set,
5438 * so really this is just a convenience method for
5439 * <pre>
5440 * setType(Intent.normalizeMimeType(type))
5441 * </pre>
5442 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005443 * @param type The MIME type of the data being handled by this intent.
5444 *
5445 * @return Returns the same Intent object, for chaining multiple calls
5446 * into a single statement.
5447 *
Nick Pellyccae4122012-01-09 14:12:58 -08005448 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005449 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005450 * @see #normalizeMimeType
5451 */
5452 public Intent setTypeAndNormalize(String type) {
5453 return setType(normalizeMimeType(type));
5454 }
5455
5456 /**
5457 * (Usually optional) Set the data for the intent along with an explicit
5458 * MIME data type. This method should very rarely be used -- it allows you
5459 * to override the MIME type that would ordinarily be inferred from the
5460 * data with your own type given here.
5461 *
5462 * <p><em>Note: MIME type and Uri scheme matching in the
5463 * Android framework is case-sensitive, unlike the formal RFC definitions.
5464 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005465 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005466 * {@link #setDataAndTypeAndNormalize}
5467 * to ensure that they are converted to lower case.</em>
5468 *
5469 * @param data The Uri of the data this intent is now targeting.
5470 * @param type The MIME type of the data being handled by this intent.
5471 *
5472 * @return Returns the same Intent object, for chaining multiple calls
5473 * into a single statement.
5474 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005475 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005476 * @see #setData
5477 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005478 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005479 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005480 */
5481 public Intent setDataAndType(Uri data, String type) {
5482 mData = data;
5483 mType = type;
5484 return this;
5485 }
5486
5487 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005488 * (Usually optional) Normalize and set both the data Uri and an explicit
5489 * MIME data type. This method should very rarely be used -- it allows you
5490 * to override the MIME type that would ordinarily be inferred from the
5491 * data with your own type given here.
5492 *
5493 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005494 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005495 * before they are set, so really this is just a convenience method for
5496 * <pre>
5497 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5498 * </pre>
5499 *
5500 * @param data The Uri of the data this intent is now targeting.
5501 * @param type The MIME type of the data being handled by this intent.
5502 *
5503 * @return Returns the same Intent object, for chaining multiple calls
5504 * into a single statement.
5505 *
5506 * @see #setType
5507 * @see #setData
5508 * @see #setDataAndType
5509 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005510 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005511 */
5512 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005513 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005514 }
5515
5516 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005517 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005518 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005519 * activities that provide <em>all</em> of the requested categories will be
5520 * used.
5521 *
5522 * @param category The desired category. This can be either one of the
5523 * predefined Intent categories, or a custom category in your own
5524 * namespace.
5525 *
5526 * @return Returns the same Intent object, for chaining multiple calls
5527 * into a single statement.
5528 *
5529 * @see #hasCategory
5530 * @see #removeCategory
5531 */
5532 public Intent addCategory(String category) {
5533 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005534 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005535 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005536 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005537 return this;
5538 }
5539
5540 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005541 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005542 *
5543 * @param category The category to remove.
5544 *
5545 * @see #addCategory
5546 */
5547 public void removeCategory(String category) {
5548 if (mCategories != null) {
5549 mCategories.remove(category);
5550 if (mCategories.size() == 0) {
5551 mCategories = null;
5552 }
5553 }
5554 }
5555
5556 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005557 * Set a selector for this Intent. This is a modification to the kinds of
5558 * things the Intent will match. If the selector is set, it will be used
5559 * when trying to find entities that can handle the Intent, instead of the
5560 * main contents of the Intent. This allows you build an Intent containing
5561 * a generic protocol while targeting it more specifically.
5562 *
5563 * <p>An example of where this may be used is with things like
5564 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5565 * Intent that will launch the Browser application. However, the correct
5566 * main entry point of an application is actually {@link #ACTION_MAIN}
5567 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5568 * used to specify the actual Activity to launch. If you launch the browser
5569 * with something different, undesired behavior may happen if the user has
5570 * previously or later launches it the normal way, since they do not match.
5571 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5572 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5573 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5574 *
5575 * <p>Setting a selector does not impact the behavior of
5576 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5577 * desired behavior of a selector -- it does not impact the base meaning
5578 * of the Intent, just what kinds of things will be matched against it
5579 * when determining who can handle it.</p>
5580 *
5581 * <p>You can not use both a selector and {@link #setPackage(String)} on
5582 * the same base Intent.</p>
5583 *
5584 * @param selector The desired selector Intent; set to null to not use
5585 * a special selector.
5586 */
5587 public void setSelector(Intent selector) {
5588 if (selector == this) {
5589 throw new IllegalArgumentException(
5590 "Intent being set as a selector of itself");
5591 }
5592 if (selector != null && mPackage != null) {
5593 throw new IllegalArgumentException(
5594 "Can't set selector when package name is already set");
5595 }
5596 mSelector = selector;
5597 }
5598
5599 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005600 * Set a {@link ClipData} associated with this Intent. This replaces any
5601 * previously set ClipData.
5602 *
5603 * <p>The ClipData in an intent is not used for Intent matching or other
5604 * such operations. Semantically it is like extras, used to transmit
5605 * additional data with the Intent. The main feature of using this over
5606 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5607 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5608 * items included in the clip data. This is useful, in particular, if
5609 * you want to transmit an Intent containing multiple <code>content:</code>
5610 * URIs for which the recipient may not have global permission to access the
5611 * content provider.
5612 *
5613 * <p>If the ClipData contains items that are themselves Intents, any
5614 * grant flags in those Intents will be ignored. Only the top-level flags
5615 * of the main Intent are respected, and will be applied to all Uri or
5616 * Intent items in the clip (or sub-items of the clip).
5617 *
5618 * <p>The MIME type, label, and icon in the ClipData object are not
5619 * directly used by Intent. Applications should generally rely on the
5620 * MIME type of the Intent itself, not what it may find in the ClipData.
5621 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005622 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005623 *
5624 * @param clip The new clip to set. May be null to clear the current clip.
5625 */
5626 public void setClipData(ClipData clip) {
5627 mClipData = clip;
5628 }
5629
5630 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005631 * This is NOT a secure mechanism to identify the user who sent the intent.
5632 * When the intent is sent to a different user, it is used to fix uris by adding the userId
5633 * who sent the intent.
5634 * @hide
5635 */
5636 public void setContentUserHint(int contentUserHint) {
5637 mContentUserHint = contentUserHint;
5638 }
5639
5640 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005641 * Add extended data to the intent. The name must include a package
5642 * prefix, for example the app com.android.contacts would use names
5643 * like "com.android.contacts.ShowAll".
5644 *
5645 * @param name The name of the extra data, with package prefix.
5646 * @param value The boolean data value.
5647 *
5648 * @return Returns the same Intent object, for chaining multiple calls
5649 * into a single statement.
5650 *
5651 * @see #putExtras
5652 * @see #removeExtra
5653 * @see #getBooleanExtra(String, boolean)
5654 */
5655 public Intent putExtra(String name, boolean value) {
5656 if (mExtras == null) {
5657 mExtras = new Bundle();
5658 }
5659 mExtras.putBoolean(name, value);
5660 return this;
5661 }
5662
5663 /**
5664 * Add extended data to the intent. The name must include a package
5665 * prefix, for example the app com.android.contacts would use names
5666 * like "com.android.contacts.ShowAll".
5667 *
5668 * @param name The name of the extra data, with package prefix.
5669 * @param value The byte data value.
5670 *
5671 * @return Returns the same Intent object, for chaining multiple calls
5672 * into a single statement.
5673 *
5674 * @see #putExtras
5675 * @see #removeExtra
5676 * @see #getByteExtra(String, byte)
5677 */
5678 public Intent putExtra(String name, byte value) {
5679 if (mExtras == null) {
5680 mExtras = new Bundle();
5681 }
5682 mExtras.putByte(name, value);
5683 return this;
5684 }
5685
5686 /**
5687 * Add extended data to the intent. The name must include a package
5688 * prefix, for example the app com.android.contacts would use names
5689 * like "com.android.contacts.ShowAll".
5690 *
5691 * @param name The name of the extra data, with package prefix.
5692 * @param value The char data value.
5693 *
5694 * @return Returns the same Intent object, for chaining multiple calls
5695 * into a single statement.
5696 *
5697 * @see #putExtras
5698 * @see #removeExtra
5699 * @see #getCharExtra(String, char)
5700 */
5701 public Intent putExtra(String name, char value) {
5702 if (mExtras == null) {
5703 mExtras = new Bundle();
5704 }
5705 mExtras.putChar(name, value);
5706 return this;
5707 }
5708
5709 /**
5710 * Add extended data to the intent. The name must include a package
5711 * prefix, for example the app com.android.contacts would use names
5712 * like "com.android.contacts.ShowAll".
5713 *
5714 * @param name The name of the extra data, with package prefix.
5715 * @param value The short data value.
5716 *
5717 * @return Returns the same Intent object, for chaining multiple calls
5718 * into a single statement.
5719 *
5720 * @see #putExtras
5721 * @see #removeExtra
5722 * @see #getShortExtra(String, short)
5723 */
5724 public Intent putExtra(String name, short value) {
5725 if (mExtras == null) {
5726 mExtras = new Bundle();
5727 }
5728 mExtras.putShort(name, value);
5729 return this;
5730 }
5731
5732 /**
5733 * Add extended data to the intent. The name must include a package
5734 * prefix, for example the app com.android.contacts would use names
5735 * like "com.android.contacts.ShowAll".
5736 *
5737 * @param name The name of the extra data, with package prefix.
5738 * @param value The integer data value.
5739 *
5740 * @return Returns the same Intent object, for chaining multiple calls
5741 * into a single statement.
5742 *
5743 * @see #putExtras
5744 * @see #removeExtra
5745 * @see #getIntExtra(String, int)
5746 */
5747 public Intent putExtra(String name, int value) {
5748 if (mExtras == null) {
5749 mExtras = new Bundle();
5750 }
5751 mExtras.putInt(name, value);
5752 return this;
5753 }
5754
5755 /**
5756 * Add extended data to the intent. The name must include a package
5757 * prefix, for example the app com.android.contacts would use names
5758 * like "com.android.contacts.ShowAll".
5759 *
5760 * @param name The name of the extra data, with package prefix.
5761 * @param value The long data value.
5762 *
5763 * @return Returns the same Intent object, for chaining multiple calls
5764 * into a single statement.
5765 *
5766 * @see #putExtras
5767 * @see #removeExtra
5768 * @see #getLongExtra(String, long)
5769 */
5770 public Intent putExtra(String name, long value) {
5771 if (mExtras == null) {
5772 mExtras = new Bundle();
5773 }
5774 mExtras.putLong(name, value);
5775 return this;
5776 }
5777
5778 /**
5779 * Add extended data to the intent. The name must include a package
5780 * prefix, for example the app com.android.contacts would use names
5781 * like "com.android.contacts.ShowAll".
5782 *
5783 * @param name The name of the extra data, with package prefix.
5784 * @param value The float data value.
5785 *
5786 * @return Returns the same Intent object, for chaining multiple calls
5787 * into a single statement.
5788 *
5789 * @see #putExtras
5790 * @see #removeExtra
5791 * @see #getFloatExtra(String, float)
5792 */
5793 public Intent putExtra(String name, float value) {
5794 if (mExtras == null) {
5795 mExtras = new Bundle();
5796 }
5797 mExtras.putFloat(name, value);
5798 return this;
5799 }
5800
5801 /**
5802 * Add extended data to the intent. The name must include a package
5803 * prefix, for example the app com.android.contacts would use names
5804 * like "com.android.contacts.ShowAll".
5805 *
5806 * @param name The name of the extra data, with package prefix.
5807 * @param value The double data value.
5808 *
5809 * @return Returns the same Intent object, for chaining multiple calls
5810 * into a single statement.
5811 *
5812 * @see #putExtras
5813 * @see #removeExtra
5814 * @see #getDoubleExtra(String, double)
5815 */
5816 public Intent putExtra(String name, double value) {
5817 if (mExtras == null) {
5818 mExtras = new Bundle();
5819 }
5820 mExtras.putDouble(name, value);
5821 return this;
5822 }
5823
5824 /**
5825 * Add extended data to the intent. The name must include a package
5826 * prefix, for example the app com.android.contacts would use names
5827 * like "com.android.contacts.ShowAll".
5828 *
5829 * @param name The name of the extra data, with package prefix.
5830 * @param value The String data value.
5831 *
5832 * @return Returns the same Intent object, for chaining multiple calls
5833 * into a single statement.
5834 *
5835 * @see #putExtras
5836 * @see #removeExtra
5837 * @see #getStringExtra(String)
5838 */
5839 public Intent putExtra(String name, String value) {
5840 if (mExtras == null) {
5841 mExtras = new Bundle();
5842 }
5843 mExtras.putString(name, value);
5844 return this;
5845 }
5846
5847 /**
5848 * Add extended data to the intent. The name must include a package
5849 * prefix, for example the app com.android.contacts would use names
5850 * like "com.android.contacts.ShowAll".
5851 *
5852 * @param name The name of the extra data, with package prefix.
5853 * @param value The CharSequence data value.
5854 *
5855 * @return Returns the same Intent object, for chaining multiple calls
5856 * into a single statement.
5857 *
5858 * @see #putExtras
5859 * @see #removeExtra
5860 * @see #getCharSequenceExtra(String)
5861 */
5862 public Intent putExtra(String name, CharSequence value) {
5863 if (mExtras == null) {
5864 mExtras = new Bundle();
5865 }
5866 mExtras.putCharSequence(name, value);
5867 return this;
5868 }
5869
5870 /**
5871 * Add extended data to the intent. The name must include a package
5872 * prefix, for example the app com.android.contacts would use names
5873 * like "com.android.contacts.ShowAll".
5874 *
5875 * @param name The name of the extra data, with package prefix.
5876 * @param value The Parcelable data value.
5877 *
5878 * @return Returns the same Intent object, for chaining multiple calls
5879 * into a single statement.
5880 *
5881 * @see #putExtras
5882 * @see #removeExtra
5883 * @see #getParcelableExtra(String)
5884 */
5885 public Intent putExtra(String name, Parcelable value) {
5886 if (mExtras == null) {
5887 mExtras = new Bundle();
5888 }
5889 mExtras.putParcelable(name, value);
5890 return this;
5891 }
5892
5893 /**
5894 * Add extended data to the intent. The name must include a package
5895 * prefix, for example the app com.android.contacts would use names
5896 * like "com.android.contacts.ShowAll".
5897 *
5898 * @param name The name of the extra data, with package prefix.
5899 * @param value The Parcelable[] data value.
5900 *
5901 * @return Returns the same Intent object, for chaining multiple calls
5902 * into a single statement.
5903 *
5904 * @see #putExtras
5905 * @see #removeExtra
5906 * @see #getParcelableArrayExtra(String)
5907 */
5908 public Intent putExtra(String name, Parcelable[] value) {
5909 if (mExtras == null) {
5910 mExtras = new Bundle();
5911 }
5912 mExtras.putParcelableArray(name, value);
5913 return this;
5914 }
5915
5916 /**
5917 * Add extended data to the intent. The name must include a package
5918 * prefix, for example the app com.android.contacts would use names
5919 * like "com.android.contacts.ShowAll".
5920 *
5921 * @param name The name of the extra data, with package prefix.
5922 * @param value The ArrayList<Parcelable> data value.
5923 *
5924 * @return Returns the same Intent object, for chaining multiple calls
5925 * into a single statement.
5926 *
5927 * @see #putExtras
5928 * @see #removeExtra
5929 * @see #getParcelableArrayListExtra(String)
5930 */
5931 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5932 if (mExtras == null) {
5933 mExtras = new Bundle();
5934 }
5935 mExtras.putParcelableArrayList(name, value);
5936 return this;
5937 }
5938
5939 /**
5940 * Add extended data to the intent. The name must include a package
5941 * prefix, for example the app com.android.contacts would use names
5942 * like "com.android.contacts.ShowAll".
5943 *
5944 * @param name The name of the extra data, with package prefix.
5945 * @param value The ArrayList<Integer> data value.
5946 *
5947 * @return Returns the same Intent object, for chaining multiple calls
5948 * into a single statement.
5949 *
5950 * @see #putExtras
5951 * @see #removeExtra
5952 * @see #getIntegerArrayListExtra(String)
5953 */
5954 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5955 if (mExtras == null) {
5956 mExtras = new Bundle();
5957 }
5958 mExtras.putIntegerArrayList(name, value);
5959 return this;
5960 }
5961
5962 /**
5963 * Add extended data to the intent. The name must include a package
5964 * prefix, for example the app com.android.contacts would use names
5965 * like "com.android.contacts.ShowAll".
5966 *
5967 * @param name The name of the extra data, with package prefix.
5968 * @param value The ArrayList<String> data value.
5969 *
5970 * @return Returns the same Intent object, for chaining multiple calls
5971 * into a single statement.
5972 *
5973 * @see #putExtras
5974 * @see #removeExtra
5975 * @see #getStringArrayListExtra(String)
5976 */
5977 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5978 if (mExtras == null) {
5979 mExtras = new Bundle();
5980 }
5981 mExtras.putStringArrayList(name, value);
5982 return this;
5983 }
5984
5985 /**
5986 * Add extended data to the intent. The name must include a package
5987 * prefix, for example the app com.android.contacts would use names
5988 * like "com.android.contacts.ShowAll".
5989 *
5990 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005991 * @param value The ArrayList<CharSequence> data value.
5992 *
5993 * @return Returns the same Intent object, for chaining multiple calls
5994 * into a single statement.
5995 *
5996 * @see #putExtras
5997 * @see #removeExtra
5998 * @see #getCharSequenceArrayListExtra(String)
5999 */
6000 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6001 if (mExtras == null) {
6002 mExtras = new Bundle();
6003 }
6004 mExtras.putCharSequenceArrayList(name, value);
6005 return this;
6006 }
6007
6008 /**
6009 * Add extended data to the intent. The name must include a package
6010 * prefix, for example the app com.android.contacts would use names
6011 * like "com.android.contacts.ShowAll".
6012 *
6013 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006014 * @param value The Serializable data value.
6015 *
6016 * @return Returns the same Intent object, for chaining multiple calls
6017 * into a single statement.
6018 *
6019 * @see #putExtras
6020 * @see #removeExtra
6021 * @see #getSerializableExtra(String)
6022 */
6023 public Intent putExtra(String name, Serializable value) {
6024 if (mExtras == null) {
6025 mExtras = new Bundle();
6026 }
6027 mExtras.putSerializable(name, value);
6028 return this;
6029 }
6030
6031 /**
6032 * Add extended data to the intent. The name must include a package
6033 * prefix, for example the app com.android.contacts would use names
6034 * like "com.android.contacts.ShowAll".
6035 *
6036 * @param name The name of the extra data, with package prefix.
6037 * @param value The boolean array data value.
6038 *
6039 * @return Returns the same Intent object, for chaining multiple calls
6040 * into a single statement.
6041 *
6042 * @see #putExtras
6043 * @see #removeExtra
6044 * @see #getBooleanArrayExtra(String)
6045 */
6046 public Intent putExtra(String name, boolean[] value) {
6047 if (mExtras == null) {
6048 mExtras = new Bundle();
6049 }
6050 mExtras.putBooleanArray(name, value);
6051 return this;
6052 }
6053
6054 /**
6055 * Add extended data to the intent. The name must include a package
6056 * prefix, for example the app com.android.contacts would use names
6057 * like "com.android.contacts.ShowAll".
6058 *
6059 * @param name The name of the extra data, with package prefix.
6060 * @param value The byte array data value.
6061 *
6062 * @return Returns the same Intent object, for chaining multiple calls
6063 * into a single statement.
6064 *
6065 * @see #putExtras
6066 * @see #removeExtra
6067 * @see #getByteArrayExtra(String)
6068 */
6069 public Intent putExtra(String name, byte[] value) {
6070 if (mExtras == null) {
6071 mExtras = new Bundle();
6072 }
6073 mExtras.putByteArray(name, value);
6074 return this;
6075 }
6076
6077 /**
6078 * Add extended data to the intent. The name must include a package
6079 * prefix, for example the app com.android.contacts would use names
6080 * like "com.android.contacts.ShowAll".
6081 *
6082 * @param name The name of the extra data, with package prefix.
6083 * @param value The short array data value.
6084 *
6085 * @return Returns the same Intent object, for chaining multiple calls
6086 * into a single statement.
6087 *
6088 * @see #putExtras
6089 * @see #removeExtra
6090 * @see #getShortArrayExtra(String)
6091 */
6092 public Intent putExtra(String name, short[] value) {
6093 if (mExtras == null) {
6094 mExtras = new Bundle();
6095 }
6096 mExtras.putShortArray(name, value);
6097 return this;
6098 }
6099
6100 /**
6101 * Add extended data to the intent. The name must include a package
6102 * prefix, for example the app com.android.contacts would use names
6103 * like "com.android.contacts.ShowAll".
6104 *
6105 * @param name The name of the extra data, with package prefix.
6106 * @param value The char array data value.
6107 *
6108 * @return Returns the same Intent object, for chaining multiple calls
6109 * into a single statement.
6110 *
6111 * @see #putExtras
6112 * @see #removeExtra
6113 * @see #getCharArrayExtra(String)
6114 */
6115 public Intent putExtra(String name, char[] value) {
6116 if (mExtras == null) {
6117 mExtras = new Bundle();
6118 }
6119 mExtras.putCharArray(name, value);
6120 return this;
6121 }
6122
6123 /**
6124 * Add extended data to the intent. The name must include a package
6125 * prefix, for example the app com.android.contacts would use names
6126 * like "com.android.contacts.ShowAll".
6127 *
6128 * @param name The name of the extra data, with package prefix.
6129 * @param value The int array data value.
6130 *
6131 * @return Returns the same Intent object, for chaining multiple calls
6132 * into a single statement.
6133 *
6134 * @see #putExtras
6135 * @see #removeExtra
6136 * @see #getIntArrayExtra(String)
6137 */
6138 public Intent putExtra(String name, int[] value) {
6139 if (mExtras == null) {
6140 mExtras = new Bundle();
6141 }
6142 mExtras.putIntArray(name, value);
6143 return this;
6144 }
6145
6146 /**
6147 * Add extended data to the intent. The name must include a package
6148 * prefix, for example the app com.android.contacts would use names
6149 * like "com.android.contacts.ShowAll".
6150 *
6151 * @param name The name of the extra data, with package prefix.
6152 * @param value The byte array data value.
6153 *
6154 * @return Returns the same Intent object, for chaining multiple calls
6155 * into a single statement.
6156 *
6157 * @see #putExtras
6158 * @see #removeExtra
6159 * @see #getLongArrayExtra(String)
6160 */
6161 public Intent putExtra(String name, long[] value) {
6162 if (mExtras == null) {
6163 mExtras = new Bundle();
6164 }
6165 mExtras.putLongArray(name, value);
6166 return this;
6167 }
6168
6169 /**
6170 * Add extended data to the intent. The name must include a package
6171 * prefix, for example the app com.android.contacts would use names
6172 * like "com.android.contacts.ShowAll".
6173 *
6174 * @param name The name of the extra data, with package prefix.
6175 * @param value The float array data value.
6176 *
6177 * @return Returns the same Intent object, for chaining multiple calls
6178 * into a single statement.
6179 *
6180 * @see #putExtras
6181 * @see #removeExtra
6182 * @see #getFloatArrayExtra(String)
6183 */
6184 public Intent putExtra(String name, float[] value) {
6185 if (mExtras == null) {
6186 mExtras = new Bundle();
6187 }
6188 mExtras.putFloatArray(name, value);
6189 return this;
6190 }
6191
6192 /**
6193 * Add extended data to the intent. The name must include a package
6194 * prefix, for example the app com.android.contacts would use names
6195 * like "com.android.contacts.ShowAll".
6196 *
6197 * @param name The name of the extra data, with package prefix.
6198 * @param value The double array data value.
6199 *
6200 * @return Returns the same Intent object, for chaining multiple calls
6201 * into a single statement.
6202 *
6203 * @see #putExtras
6204 * @see #removeExtra
6205 * @see #getDoubleArrayExtra(String)
6206 */
6207 public Intent putExtra(String name, double[] value) {
6208 if (mExtras == null) {
6209 mExtras = new Bundle();
6210 }
6211 mExtras.putDoubleArray(name, value);
6212 return this;
6213 }
6214
6215 /**
6216 * Add extended data to the intent. The name must include a package
6217 * prefix, for example the app com.android.contacts would use names
6218 * like "com.android.contacts.ShowAll".
6219 *
6220 * @param name The name of the extra data, with package prefix.
6221 * @param value The String array data value.
6222 *
6223 * @return Returns the same Intent object, for chaining multiple calls
6224 * into a single statement.
6225 *
6226 * @see #putExtras
6227 * @see #removeExtra
6228 * @see #getStringArrayExtra(String)
6229 */
6230 public Intent putExtra(String name, String[] value) {
6231 if (mExtras == null) {
6232 mExtras = new Bundle();
6233 }
6234 mExtras.putStringArray(name, value);
6235 return this;
6236 }
6237
6238 /**
6239 * Add extended data to the intent. The name must include a package
6240 * prefix, for example the app com.android.contacts would use names
6241 * like "com.android.contacts.ShowAll".
6242 *
6243 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006244 * @param value The CharSequence array data value.
6245 *
6246 * @return Returns the same Intent object, for chaining multiple calls
6247 * into a single statement.
6248 *
6249 * @see #putExtras
6250 * @see #removeExtra
6251 * @see #getCharSequenceArrayExtra(String)
6252 */
6253 public Intent putExtra(String name, CharSequence[] value) {
6254 if (mExtras == null) {
6255 mExtras = new Bundle();
6256 }
6257 mExtras.putCharSequenceArray(name, value);
6258 return this;
6259 }
6260
6261 /**
6262 * Add extended data to the intent. The name must include a package
6263 * prefix, for example the app com.android.contacts would use names
6264 * like "com.android.contacts.ShowAll".
6265 *
6266 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006267 * @param value The Bundle data value.
6268 *
6269 * @return Returns the same Intent object, for chaining multiple calls
6270 * into a single statement.
6271 *
6272 * @see #putExtras
6273 * @see #removeExtra
6274 * @see #getBundleExtra(String)
6275 */
6276 public Intent putExtra(String name, Bundle value) {
6277 if (mExtras == null) {
6278 mExtras = new Bundle();
6279 }
6280 mExtras.putBundle(name, value);
6281 return this;
6282 }
6283
6284 /**
6285 * Add extended data to the intent. The name must include a package
6286 * prefix, for example the app com.android.contacts would use names
6287 * like "com.android.contacts.ShowAll".
6288 *
6289 * @param name The name of the extra data, with package prefix.
6290 * @param value The IBinder data value.
6291 *
6292 * @return Returns the same Intent object, for chaining multiple calls
6293 * into a single statement.
6294 *
6295 * @see #putExtras
6296 * @see #removeExtra
6297 * @see #getIBinderExtra(String)
6298 *
6299 * @deprecated
6300 * @hide
6301 */
6302 @Deprecated
6303 public Intent putExtra(String name, IBinder value) {
6304 if (mExtras == null) {
6305 mExtras = new Bundle();
6306 }
6307 mExtras.putIBinder(name, value);
6308 return this;
6309 }
6310
6311 /**
6312 * Copy all extras in 'src' in to this intent.
6313 *
6314 * @param src Contains the extras to copy.
6315 *
6316 * @see #putExtra
6317 */
6318 public Intent putExtras(Intent src) {
6319 if (src.mExtras != null) {
6320 if (mExtras == null) {
6321 mExtras = new Bundle(src.mExtras);
6322 } else {
6323 mExtras.putAll(src.mExtras);
6324 }
6325 }
6326 return this;
6327 }
6328
6329 /**
6330 * Add a set of extended data to the intent. The keys must include a package
6331 * prefix, for example the app com.android.contacts would use names
6332 * like "com.android.contacts.ShowAll".
6333 *
6334 * @param extras The Bundle of extras to add to this intent.
6335 *
6336 * @see #putExtra
6337 * @see #removeExtra
6338 */
6339 public Intent putExtras(Bundle extras) {
6340 if (mExtras == null) {
6341 mExtras = new Bundle();
6342 }
6343 mExtras.putAll(extras);
6344 return this;
6345 }
6346
6347 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006348 * Completely replace the extras in the Intent with the extras in the
6349 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006350 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006351 * @param src The exact extras contained in this Intent are copied
6352 * into the target intent, replacing any that were previously there.
6353 */
6354 public Intent replaceExtras(Intent src) {
6355 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6356 return this;
6357 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006358
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006359 /**
6360 * Completely replace the extras in the Intent with the given Bundle of
6361 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006362 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006363 * @param extras The new set of extras in the Intent, or null to erase
6364 * all extras.
6365 */
6366 public Intent replaceExtras(Bundle extras) {
6367 mExtras = extras != null ? new Bundle(extras) : null;
6368 return this;
6369 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006370
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006371 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006372 * Remove extended data from the intent.
6373 *
6374 * @see #putExtra
6375 */
6376 public void removeExtra(String name) {
6377 if (mExtras != null) {
6378 mExtras.remove(name);
6379 if (mExtras.size() == 0) {
6380 mExtras = null;
6381 }
6382 }
6383 }
6384
6385 /**
6386 * Set special flags controlling how this intent is handled. Most values
6387 * here depend on the type of component being executed by the Intent,
6388 * specifically the FLAG_ACTIVITY_* flags are all for use with
6389 * {@link Context#startActivity Context.startActivity()} and the
6390 * FLAG_RECEIVER_* flags are all for use with
6391 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6392 *
Scott Main7aee61f2011-02-08 11:25:01 -08006393 * <p>See the
6394 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6395 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006396 * the behavior of your application.
6397 *
6398 * @param flags The desired flags.
6399 *
6400 * @return Returns the same Intent object, for chaining multiple calls
6401 * into a single statement.
6402 *
6403 * @see #getFlags
6404 * @see #addFlags
6405 *
6406 * @see #FLAG_GRANT_READ_URI_PERMISSION
6407 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006408 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6409 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006410 * @see #FLAG_DEBUG_LOG_RESOLUTION
6411 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006412 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006413 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006414 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006415 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006416 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6417 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006418 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006419 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006420 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006421 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006422 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006424 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006425 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6426 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006427 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006428 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006429 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006430 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6431 */
6432 public Intent setFlags(int flags) {
6433 mFlags = flags;
6434 return this;
6435 }
6436
6437 /**
6438 * Add additional flags to the intent (or with existing flags
6439 * value).
6440 *
6441 * @param flags The new flags to set.
6442 *
6443 * @return Returns the same Intent object, for chaining multiple calls
6444 * into a single statement.
6445 *
6446 * @see #setFlags
6447 */
6448 public Intent addFlags(int flags) {
6449 mFlags |= flags;
6450 return this;
6451 }
6452
6453 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006454 * (Usually optional) Set an explicit application package name that limits
6455 * the components this Intent will resolve to. If left to the default
6456 * value of null, all components in all applications will considered.
6457 * If non-null, the Intent can only match the components in the given
6458 * application package.
6459 *
6460 * @param packageName The name of the application package to handle the
6461 * intent, or null to allow any application package.
6462 *
6463 * @return Returns the same Intent object, for chaining multiple calls
6464 * into a single statement.
6465 *
6466 * @see #getPackage
6467 * @see #resolveActivity
6468 */
6469 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006470 if (packageName != null && mSelector != null) {
6471 throw new IllegalArgumentException(
6472 "Can't set package name when selector is already set");
6473 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006474 mPackage = packageName;
6475 return this;
6476 }
6477
6478 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006479 * (Usually optional) Explicitly set the component to handle the intent.
6480 * If left with the default value of null, the system will determine the
6481 * appropriate class to use based on the other fields (action, data,
6482 * type, categories) in the Intent. If this class is defined, the
6483 * specified class will always be used regardless of the other fields. You
6484 * should only set this value when you know you absolutely want a specific
6485 * class to be used; otherwise it is better to let the system find the
6486 * appropriate class so that you will respect the installed applications
6487 * and user preferences.
6488 *
6489 * @param component The name of the application component to handle the
6490 * intent, or null to let the system find one for you.
6491 *
6492 * @return Returns the same Intent object, for chaining multiple calls
6493 * into a single statement.
6494 *
6495 * @see #setClass
6496 * @see #setClassName(Context, String)
6497 * @see #setClassName(String, String)
6498 * @see #getComponent
6499 * @see #resolveActivity
6500 */
6501 public Intent setComponent(ComponentName component) {
6502 mComponent = component;
6503 return this;
6504 }
6505
6506 /**
6507 * Convenience for calling {@link #setComponent} with an
6508 * explicit class name.
6509 *
6510 * @param packageContext A Context of the application package implementing
6511 * this class.
6512 * @param className The name of a class inside of the application package
6513 * that will be used as the component for this Intent.
6514 *
6515 * @return Returns the same Intent object, for chaining multiple calls
6516 * into a single statement.
6517 *
6518 * @see #setComponent
6519 * @see #setClass
6520 */
6521 public Intent setClassName(Context packageContext, String className) {
6522 mComponent = new ComponentName(packageContext, className);
6523 return this;
6524 }
6525
6526 /**
6527 * Convenience for calling {@link #setComponent} with an
6528 * explicit application package name and class name.
6529 *
6530 * @param packageName The name of the package implementing the desired
6531 * component.
6532 * @param className The name of a class inside of the application package
6533 * that will be used as the component for this Intent.
6534 *
6535 * @return Returns the same Intent object, for chaining multiple calls
6536 * into a single statement.
6537 *
6538 * @see #setComponent
6539 * @see #setClass
6540 */
6541 public Intent setClassName(String packageName, String className) {
6542 mComponent = new ComponentName(packageName, className);
6543 return this;
6544 }
6545
6546 /**
6547 * Convenience for calling {@link #setComponent(ComponentName)} with the
6548 * name returned by a {@link Class} object.
6549 *
6550 * @param packageContext A Context of the application package implementing
6551 * this class.
6552 * @param cls The class name to set, equivalent to
6553 * <code>setClassName(context, cls.getName())</code>.
6554 *
6555 * @return Returns the same Intent object, for chaining multiple calls
6556 * into a single statement.
6557 *
6558 * @see #setComponent
6559 */
6560 public Intent setClass(Context packageContext, Class<?> cls) {
6561 mComponent = new ComponentName(packageContext, cls);
6562 return this;
6563 }
6564
6565 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006566 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6567 * used as a hint to the receiver for animations and the like. Null means that there
6568 * is no source bounds.
6569 */
6570 public void setSourceBounds(Rect r) {
6571 if (r != null) {
6572 mSourceBounds = new Rect(r);
6573 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006574 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006575 }
6576 }
6577
Tor Norbyed9273d62013-05-30 15:59:53 -07006578 /** @hide */
6579 @IntDef(flag = true,
6580 value = {
6581 FILL_IN_ACTION,
6582 FILL_IN_DATA,
6583 FILL_IN_CATEGORIES,
6584 FILL_IN_COMPONENT,
6585 FILL_IN_PACKAGE,
6586 FILL_IN_SOURCE_BOUNDS,
6587 FILL_IN_SELECTOR,
6588 FILL_IN_CLIP_DATA
6589 })
6590 @Retention(RetentionPolicy.SOURCE)
6591 public @interface FillInFlags {}
6592
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006593 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006594 * Use with {@link #fillIn} to allow the current action value to be
6595 * overwritten, even if it is already set.
6596 */
6597 public static final int FILL_IN_ACTION = 1<<0;
6598
6599 /**
6600 * Use with {@link #fillIn} to allow the current data or type value
6601 * overwritten, even if it is already set.
6602 */
6603 public static final int FILL_IN_DATA = 1<<1;
6604
6605 /**
6606 * Use with {@link #fillIn} to allow the current categories to be
6607 * overwritten, even if they are already set.
6608 */
6609 public static final int FILL_IN_CATEGORIES = 1<<2;
6610
6611 /**
6612 * Use with {@link #fillIn} to allow the current component value to be
6613 * overwritten, even if it is already set.
6614 */
6615 public static final int FILL_IN_COMPONENT = 1<<3;
6616
6617 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006618 * Use with {@link #fillIn} to allow the current package value to be
6619 * overwritten, even if it is already set.
6620 */
6621 public static final int FILL_IN_PACKAGE = 1<<4;
6622
6623 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006624 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006625 * overwritten, even if it is already set.
6626 */
6627 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6628
6629 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006630 * Use with {@link #fillIn} to allow the current selector to be
6631 * overwritten, even if it is already set.
6632 */
6633 public static final int FILL_IN_SELECTOR = 1<<6;
6634
6635 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006636 * Use with {@link #fillIn} to allow the current ClipData to be
6637 * overwritten, even if it is already set.
6638 */
6639 public static final int FILL_IN_CLIP_DATA = 1<<7;
6640
6641 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006642 * Copy the contents of <var>other</var> in to this object, but only
6643 * where fields are not defined by this object. For purposes of a field
6644 * being defined, the following pieces of data in the Intent are
6645 * considered to be separate fields:
6646 *
6647 * <ul>
6648 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006649 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006650 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6651 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006652 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006653 * <li> component, as set by {@link #setComponent(ComponentName)} or
6654 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006655 * <li> source bounds, as set by {@link #setSourceBounds}.
6656 * <li> selector, as set by {@link #setSelector(Intent)}.
6657 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006658 * <li> each top-level name in the associated extras.
6659 * </ul>
6660 *
6661 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006662 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006663 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6664 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6665 * the restriction where the corresponding field will not be replaced if
6666 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006667 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006668 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6669 * is explicitly specified. The selector will only be copied if
6670 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006671 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006672 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6673 * and Intent B with {action="gotit", data-type="some/thing",
6674 * categories="one","two"}.
6675 *
6676 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6677 * containing: {action="gotit", data-type="some/thing",
6678 * categories="bar"}.
6679 *
6680 * @param other Another Intent whose values are to be used to fill in
6681 * the current one.
6682 * @param flags Options to control which fields can be filled in.
6683 *
6684 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006685 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006686 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6687 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6688 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006689 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006690 @FillInFlags
6691 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006692 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006693 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006694 if (other.mAction != null
6695 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006696 mAction = other.mAction;
6697 changes |= FILL_IN_ACTION;
6698 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006699 if ((other.mData != null || other.mType != null)
6700 && ((mData == null && mType == null)
6701 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006702 mData = other.mData;
6703 mType = other.mType;
6704 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006705 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006706 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006707 if (other.mCategories != null
6708 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006709 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006710 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006711 }
6712 changes |= FILL_IN_CATEGORIES;
6713 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006714 if (other.mPackage != null
6715 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006716 // Only do this if mSelector is not set.
6717 if (mSelector == null) {
6718 mPackage = other.mPackage;
6719 changes |= FILL_IN_PACKAGE;
6720 }
6721 }
6722 // Selector is special: it can only be set if explicitly allowed,
6723 // for the same reason as the component name.
6724 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6725 if (mPackage == null) {
6726 mSelector = new Intent(other.mSelector);
6727 mPackage = null;
6728 changes |= FILL_IN_SELECTOR;
6729 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006730 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006731 if (other.mClipData != null
6732 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6733 mClipData = other.mClipData;
6734 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006735 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006736 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006737 // Component is special: it can -only- be set if explicitly allowed,
6738 // since otherwise the sender could force the intent somewhere the
6739 // originator didn't intend.
6740 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006741 mComponent = other.mComponent;
6742 changes |= FILL_IN_COMPONENT;
6743 }
6744 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006745 if (other.mSourceBounds != null
6746 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6747 mSourceBounds = new Rect(other.mSourceBounds);
6748 changes |= FILL_IN_SOURCE_BOUNDS;
6749 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006750 if (mExtras == null) {
6751 if (other.mExtras != null) {
6752 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006753 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006754 }
6755 } else if (other.mExtras != null) {
6756 try {
6757 Bundle newb = new Bundle(other.mExtras);
6758 newb.putAll(mExtras);
6759 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006760 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006761 } catch (RuntimeException e) {
6762 // Modifying the extras can cause us to unparcel the contents
6763 // of the bundle, and if we do this in the system process that
6764 // may fail. We really should handle this (i.e., the Bundle
6765 // impl shouldn't be on top of a plain map), but for now just
6766 // ignore it and keep the original contents. :(
6767 Log.w("Intent", "Failure filling in extras", e);
6768 }
6769 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006770 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
6771 && other.mContentUserHint != UserHandle.USER_CURRENT) {
6772 mContentUserHint = other.mContentUserHint;
6773 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006774 return changes;
6775 }
6776
6777 /**
6778 * Wrapper class holding an Intent and implementing comparisons on it for
6779 * the purpose of filtering. The class implements its
6780 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6781 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6782 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6783 * on the wrapped Intent.
6784 */
6785 public static final class FilterComparison {
6786 private final Intent mIntent;
6787 private final int mHashCode;
6788
6789 public FilterComparison(Intent intent) {
6790 mIntent = intent;
6791 mHashCode = intent.filterHashCode();
6792 }
6793
6794 /**
6795 * Return the Intent that this FilterComparison represents.
6796 * @return Returns the Intent held by the FilterComparison. Do
6797 * not modify!
6798 */
6799 public Intent getIntent() {
6800 return mIntent;
6801 }
6802
6803 @Override
6804 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006805 if (obj instanceof FilterComparison) {
6806 Intent other = ((FilterComparison)obj).mIntent;
6807 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006808 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006809 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006810 }
6811
6812 @Override
6813 public int hashCode() {
6814 return mHashCode;
6815 }
6816 }
6817
6818 /**
6819 * Determine if two intents are the same for the purposes of intent
6820 * resolution (filtering). That is, if their action, data, type,
6821 * class, and categories are the same. This does <em>not</em> compare
6822 * any extra data included in the intents.
6823 *
6824 * @param other The other Intent to compare against.
6825 *
6826 * @return Returns true if action, data, type, class, and categories
6827 * are the same.
6828 */
6829 public boolean filterEquals(Intent other) {
6830 if (other == null) {
6831 return false;
6832 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07006833 if (!Objects.equals(this.mAction, other.mAction)) return false;
6834 if (!Objects.equals(this.mData, other.mData)) return false;
6835 if (!Objects.equals(this.mType, other.mType)) return false;
6836 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
6837 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
6838 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006839
6840 return true;
6841 }
6842
6843 /**
6844 * Generate hash code that matches semantics of filterEquals().
6845 *
6846 * @return Returns the hash value of the action, data, type, class, and
6847 * categories.
6848 *
6849 * @see #filterEquals
6850 */
6851 public int filterHashCode() {
6852 int code = 0;
6853 if (mAction != null) {
6854 code += mAction.hashCode();
6855 }
6856 if (mData != null) {
6857 code += mData.hashCode();
6858 }
6859 if (mType != null) {
6860 code += mType.hashCode();
6861 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006862 if (mPackage != null) {
6863 code += mPackage.hashCode();
6864 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006865 if (mComponent != null) {
6866 code += mComponent.hashCode();
6867 }
6868 if (mCategories != null) {
6869 code += mCategories.hashCode();
6870 }
6871 return code;
6872 }
6873
6874 @Override
6875 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006876 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006877
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006878 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006879 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006880 b.append(" }");
6881
6882 return b.toString();
6883 }
6884
6885 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006886 public String toInsecureString() {
6887 StringBuilder b = new StringBuilder(128);
6888
6889 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006890 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006891 b.append(" }");
6892
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006893 return b.toString();
6894 }
Romain Guy4969af72009-06-17 10:53:19 -07006895
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006896 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006897 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006898 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006899
6900 b.append("Intent { ");
6901 toShortString(b, false, true, true, true);
6902 b.append(" }");
6903
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006904 return b.toString();
6905 }
6906
6907 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006908 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6909 StringBuilder b = new StringBuilder(128);
6910 toShortString(b, secure, comp, extras, clip);
6911 return b.toString();
6912 }
6913
6914 /** @hide */
6915 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6916 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006917 boolean first = true;
6918 if (mAction != null) {
6919 b.append("act=").append(mAction);
6920 first = false;
6921 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006922 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006923 if (!first) {
6924 b.append(' ');
6925 }
6926 first = false;
6927 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006928 for (int i=0; i<mCategories.size(); i++) {
6929 if (i > 0) b.append(',');
6930 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006931 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006932 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006933 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006934 if (mData != null) {
6935 if (!first) {
6936 b.append(' ');
6937 }
6938 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006939 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006940 if (secure) {
6941 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006942 } else {
6943 b.append(mData);
6944 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006945 }
6946 if (mType != null) {
6947 if (!first) {
6948 b.append(' ');
6949 }
6950 first = false;
6951 b.append("typ=").append(mType);
6952 }
6953 if (mFlags != 0) {
6954 if (!first) {
6955 b.append(' ');
6956 }
6957 first = false;
6958 b.append("flg=0x").append(Integer.toHexString(mFlags));
6959 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006960 if (mPackage != null) {
6961 if (!first) {
6962 b.append(' ');
6963 }
6964 first = false;
6965 b.append("pkg=").append(mPackage);
6966 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006967 if (comp && mComponent != null) {
6968 if (!first) {
6969 b.append(' ');
6970 }
6971 first = false;
6972 b.append("cmp=").append(mComponent.flattenToShortString());
6973 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006974 if (mSourceBounds != null) {
6975 if (!first) {
6976 b.append(' ');
6977 }
6978 first = false;
6979 b.append("bnds=").append(mSourceBounds.toShortString());
6980 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006981 if (mClipData != null) {
6982 if (!first) {
6983 b.append(' ');
6984 }
6985 first = false;
6986 if (clip) {
6987 b.append("clip={");
6988 mClipData.toShortString(b);
6989 b.append('}');
6990 } else {
6991 b.append("(has clip)");
6992 }
6993 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006994 if (extras && mExtras != null) {
6995 if (!first) {
6996 b.append(' ');
6997 }
6998 first = false;
6999 b.append("(has extras)");
7000 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007001 if (mContentUserHint != UserHandle.USER_CURRENT) {
7002 if (!first) {
7003 b.append(' ');
7004 }
7005 first = false;
7006 b.append("u=").append(mContentUserHint);
7007 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007008 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007009 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007010 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007011 b.append("}");
7012 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007013 }
7014
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007015 /**
7016 * Call {@link #toUri} with 0 flags.
7017 * @deprecated Use {@link #toUri} instead.
7018 */
7019 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007020 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007021 return toUri(0);
7022 }
7023
7024 /**
7025 * Convert this Intent into a String holding a URI representation of it.
7026 * The returned URI string has been properly URI encoded, so it can be
7027 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7028 * Intent's data as the base URI, with an additional fragment describing
7029 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007030 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007031 * <p>You can convert the returned string back to an Intent with
7032 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007033 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007034 * @param flags Additional operating flags. Either 0 or
7035 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007036 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007037 * @return Returns a URI encoding URI string describing the entire contents
7038 * of the Intent.
7039 */
7040 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007041 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007042 String scheme = null;
7043 if (mData != null) {
7044 String data = mData.toString();
7045 if ((flags&URI_INTENT_SCHEME) != 0) {
7046 final int N = data.length();
7047 for (int i=0; i<N; i++) {
7048 char c = data.charAt(i);
7049 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7050 || c == '.' || c == '-') {
7051 continue;
7052 }
7053 if (c == ':' && i > 0) {
7054 // Valid scheme.
7055 scheme = data.substring(0, i);
7056 uri.append("intent:");
7057 data = data.substring(i+1);
7058 break;
7059 }
Tom Taylord4a47292009-12-21 13:59:18 -08007060
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007061 // No scheme.
7062 break;
7063 }
7064 }
7065 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007066
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007067 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7068 uri.append("intent:");
7069 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007070
7071 uri.append("#Intent;");
7072
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007073 toUriInner(uri, scheme, flags);
7074 if (mSelector != null) {
7075 uri.append("SEL;");
7076 // Note that for now we are not going to try to handle the
7077 // data part; not clear how to represent this as a URI, and
7078 // not much utility in it.
7079 mSelector.toUriInner(uri, null, flags);
7080 }
7081
7082 uri.append("end");
7083
7084 return uri.toString();
7085 }
7086
7087 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007088 if (scheme != null) {
7089 uri.append("scheme=").append(scheme).append(';');
7090 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007091 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007092 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007093 }
7094 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007095 for (int i=0; i<mCategories.size(); i++) {
7096 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007097 }
7098 }
7099 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007100 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007101 }
7102 if (mFlags != 0) {
7103 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7104 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007105 if (mPackage != null) {
7106 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7107 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007108 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007109 uri.append("component=").append(Uri.encode(
7110 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007111 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007112 if (mSourceBounds != null) {
7113 uri.append("sourceBounds=")
7114 .append(Uri.encode(mSourceBounds.flattenToString()))
7115 .append(';');
7116 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007117 if (mExtras != null) {
7118 for (String key : mExtras.keySet()) {
7119 final Object value = mExtras.get(key);
7120 char entryType =
7121 value instanceof String ? 'S' :
7122 value instanceof Boolean ? 'B' :
7123 value instanceof Byte ? 'b' :
7124 value instanceof Character ? 'c' :
7125 value instanceof Double ? 'd' :
7126 value instanceof Float ? 'f' :
7127 value instanceof Integer ? 'i' :
7128 value instanceof Long ? 'l' :
7129 value instanceof Short ? 's' :
7130 '\0';
7131
7132 if (entryType != '\0') {
7133 uri.append(entryType);
7134 uri.append('.');
7135 uri.append(Uri.encode(key));
7136 uri.append('=');
7137 uri.append(Uri.encode(value.toString()));
7138 uri.append(';');
7139 }
7140 }
7141 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007142 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007143
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007144 public int describeContents() {
7145 return (mExtras != null) ? mExtras.describeContents() : 0;
7146 }
7147
7148 public void writeToParcel(Parcel out, int flags) {
7149 out.writeString(mAction);
7150 Uri.writeToParcel(out, mData);
7151 out.writeString(mType);
7152 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007153 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007154 ComponentName.writeToParcel(mComponent, out);
7155
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007156 if (mSourceBounds != null) {
7157 out.writeInt(1);
7158 mSourceBounds.writeToParcel(out, flags);
7159 } else {
7160 out.writeInt(0);
7161 }
7162
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007163 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007164 final int N = mCategories.size();
7165 out.writeInt(N);
7166 for (int i=0; i<N; i++) {
7167 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007168 }
7169 } else {
7170 out.writeInt(0);
7171 }
7172
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007173 if (mSelector != null) {
7174 out.writeInt(1);
7175 mSelector.writeToParcel(out, flags);
7176 } else {
7177 out.writeInt(0);
7178 }
7179
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007180 if (mClipData != null) {
7181 out.writeInt(1);
7182 mClipData.writeToParcel(out, flags);
7183 } else {
7184 out.writeInt(0);
7185 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007186 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007187 out.writeBundle(mExtras);
7188 }
7189
7190 public static final Parcelable.Creator<Intent> CREATOR
7191 = new Parcelable.Creator<Intent>() {
7192 public Intent createFromParcel(Parcel in) {
7193 return new Intent(in);
7194 }
7195 public Intent[] newArray(int size) {
7196 return new Intent[size];
7197 }
7198 };
7199
Dianne Hackborneb034652009-09-07 00:49:58 -07007200 /** @hide */
7201 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007202 readFromParcel(in);
7203 }
7204
7205 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007206 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007207 mData = Uri.CREATOR.createFromParcel(in);
7208 mType = in.readString();
7209 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007210 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007211 mComponent = ComponentName.readFromParcel(in);
7212
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007213 if (in.readInt() != 0) {
7214 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7215 }
7216
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007217 int N = in.readInt();
7218 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007219 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007220 int i;
7221 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007222 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007223 }
7224 } else {
7225 mCategories = null;
7226 }
7227
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007228 if (in.readInt() != 0) {
7229 mSelector = new Intent(in);
7230 }
7231
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007232 if (in.readInt() != 0) {
7233 mClipData = new ClipData(in);
7234 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007235 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007236 mExtras = in.readBundle();
7237 }
7238
7239 /**
7240 * Parses the "intent" element (and its children) from XML and instantiates
7241 * an Intent object. The given XML parser should be located at the tag
7242 * where parsing should start (often named "intent"), from which the
7243 * basic action, data, type, and package and class name will be
7244 * retrieved. The function will then parse in to any child elements,
7245 * looking for <category android:name="xxx"> tags to add categories and
7246 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7247 * to the intent.
7248 *
7249 * @param resources The Resources to use when inflating resources.
7250 * @param parser The XML parser pointing at an "intent" tag.
7251 * @param attrs The AttributeSet interface for retrieving extended
7252 * attribute data at the current <var>parser</var> location.
7253 * @return An Intent object matching the XML data.
7254 * @throws XmlPullParserException If there was an XML parsing error.
7255 * @throws IOException If there was an I/O error.
7256 */
7257 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7258 throws XmlPullParserException, IOException {
7259 Intent intent = new Intent();
7260
7261 TypedArray sa = resources.obtainAttributes(attrs,
7262 com.android.internal.R.styleable.Intent);
7263
7264 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7265
7266 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7267 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7268 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7269
7270 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7271 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7272 if (packageName != null && className != null) {
7273 intent.setComponent(new ComponentName(packageName, className));
7274 }
7275
7276 sa.recycle();
7277
7278 int outerDepth = parser.getDepth();
7279 int type;
7280 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7281 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7282 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7283 continue;
7284 }
7285
7286 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007287 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007288 sa = resources.obtainAttributes(attrs,
7289 com.android.internal.R.styleable.IntentCategory);
7290 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7291 sa.recycle();
7292
7293 if (cat != null) {
7294 intent.addCategory(cat);
7295 }
7296 XmlUtils.skipCurrentTag(parser);
7297
Craig Mautner21d24a22014-04-23 11:45:37 -07007298 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007299 if (intent.mExtras == null) {
7300 intent.mExtras = new Bundle();
7301 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007302 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007303 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007304
7305 } else {
7306 XmlUtils.skipCurrentTag(parser);
7307 }
7308 }
7309
7310 return intent;
7311 }
Nick Pellyccae4122012-01-09 14:12:58 -08007312
Craig Mautner21d24a22014-04-23 11:45:37 -07007313 /** @hide */
7314 public void saveToXml(XmlSerializer out) throws IOException {
7315 if (mAction != null) {
7316 out.attribute(null, ATTR_ACTION, mAction);
7317 }
7318 if (mData != null) {
7319 out.attribute(null, ATTR_DATA, mData.toString());
7320 }
7321 if (mType != null) {
7322 out.attribute(null, ATTR_TYPE, mType);
7323 }
7324 if (mComponent != null) {
7325 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7326 }
7327 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7328
7329 if (mCategories != null) {
7330 out.startTag(null, TAG_CATEGORIES);
7331 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7332 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7333 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007334 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007335 }
7336 }
7337
7338 /** @hide */
7339 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7340 XmlPullParserException {
7341 Intent intent = new Intent();
7342 final int outerDepth = in.getDepth();
7343
7344 int attrCount = in.getAttributeCount();
7345 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7346 final String attrName = in.getAttributeName(attrNdx);
7347 final String attrValue = in.getAttributeValue(attrNdx);
7348 if (ATTR_ACTION.equals(attrName)) {
7349 intent.setAction(attrValue);
7350 } else if (ATTR_DATA.equals(attrName)) {
7351 intent.setData(Uri.parse(attrValue));
7352 } else if (ATTR_TYPE.equals(attrName)) {
7353 intent.setType(attrValue);
7354 } else if (ATTR_COMPONENT.equals(attrName)) {
7355 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7356 } else if (ATTR_FLAGS.equals(attrName)) {
7357 intent.setFlags(Integer.valueOf(attrValue, 16));
7358 } else {
7359 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7360 }
7361 }
7362
7363 int event;
7364 String name;
7365 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7366 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7367 if (event == XmlPullParser.START_TAG) {
7368 name = in.getName();
7369 if (TAG_CATEGORIES.equals(name)) {
7370 attrCount = in.getAttributeCount();
7371 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7372 intent.addCategory(in.getAttributeValue(attrNdx));
7373 }
7374 } else {
7375 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7376 XmlUtils.skipCurrentTag(in);
7377 }
7378 }
7379 }
7380
7381 return intent;
7382 }
7383
Nick Pellyccae4122012-01-09 14:12:58 -08007384 /**
7385 * Normalize a MIME data type.
7386 *
7387 * <p>A normalized MIME type has white-space trimmed,
7388 * content-type parameters removed, and is lower-case.
7389 * This aligns the type with Android best practices for
7390 * intent filtering.
7391 *
7392 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7393 * "text/x-vCard" becomes "text/x-vcard".
7394 *
7395 * <p>All MIME types received from outside Android (such as user input,
7396 * or external sources like Bluetooth, NFC, or the Internet) should
7397 * be normalized before they are used to create an Intent.
7398 *
7399 * @param type MIME data type to normalize
7400 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007401 * @see #setType
7402 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007403 */
7404 public static String normalizeMimeType(String type) {
7405 if (type == null) {
7406 return null;
7407 }
7408
Elliott Hughescb64d432013-08-02 10:00:44 -07007409 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007410
7411 final int semicolonIndex = type.indexOf(';');
7412 if (semicolonIndex != -1) {
7413 type = type.substring(0, semicolonIndex);
7414 }
7415 return type;
7416 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007417
7418 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007419 * Prepare this {@link Intent} to leave an app process.
7420 *
7421 * @hide
7422 */
7423 public void prepareToLeaveProcess() {
7424 setAllowFds(false);
7425
7426 if (mSelector != null) {
7427 mSelector.prepareToLeaveProcess();
7428 }
7429 if (mClipData != null) {
7430 mClipData.prepareToLeaveProcess();
7431 }
7432
7433 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7434 // There are several ACTION_MEDIA_* broadcasts that send file://
7435 // Uris, so only check common actions.
7436 if (ACTION_VIEW.equals(mAction) ||
7437 ACTION_EDIT.equals(mAction) ||
7438 ACTION_ATTACH_DATA.equals(mAction)) {
7439 mData.checkFileUriExposed("Intent.getData()");
7440 }
7441 }
7442 }
7443
7444 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007445 * @hide
7446 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007447 public void prepareToEnterProcess() {
7448 if (mContentUserHint != UserHandle.USER_CURRENT) {
7449 fixUris(mContentUserHint);
7450 mContentUserHint = UserHandle.USER_CURRENT;
7451 }
7452 }
7453
7454 /**
7455 * @hide
7456 */
7457 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007458 Uri data = getData();
7459 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007460 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007461 }
7462 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007463 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007464 }
7465 String action = getAction();
7466 if (ACTION_SEND.equals(action)) {
7467 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7468 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007469 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007470 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007471 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007472 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7473 if (streams != null) {
7474 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7475 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007476 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007477 }
7478 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7479 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007480 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7481 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7482 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7483 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7484 if (output != null) {
7485 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
7486 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007487 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007488 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007489
7490 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007491 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007492 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7493 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007494 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007495 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007496 * @hide
7497 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007498 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007499 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007500 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007501
7502 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007503 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007504
7505 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007506 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007507 // Inspect contained intents to see if we need to migrate extras. We
7508 // don't promote ClipData to the parent, since ChooserActivity will
7509 // already start the picked item as the caller, and we can't combine
7510 // the flags in a safe way.
7511
7512 boolean migrated = false;
Jeff Sharkey1c297002012-05-18 13:55:47 -07007513 try {
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007514 final Intent intent = getParcelableExtra(EXTRA_INTENT);
7515 if (intent != null) {
7516 migrated |= intent.migrateExtraStreamToClipData();
Jeff Sharkey1c297002012-05-18 13:55:47 -07007517 }
7518 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007519 }
Jeff Sharkeyc004eef2014-09-23 16:40:50 -07007520 try {
7521 final Parcelable[] intents = getParcelableArrayExtra(EXTRA_INITIAL_INTENTS);
7522 if (intents != null) {
7523 for (int i = 0; i < intents.length; i++) {
7524 final Intent intent = (Intent) intents[i];
7525 if (intent != null) {
7526 migrated |= intent.migrateExtraStreamToClipData();
7527 }
7528 }
7529 }
7530 } catch (ClassCastException e) {
7531 }
7532 return migrated;
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007533
7534 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007535 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007536 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7537 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7538 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7539 if (stream != null || text != null || htmlText != null) {
7540 final ClipData clipData = new ClipData(
7541 null, new String[] { getType() },
7542 new ClipData.Item(text, htmlText, null, stream));
7543 setClipData(clipData);
7544 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007545 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007546 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007547 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007548 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007549
7550 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007551 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007552 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7553 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7554 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7555 int num = -1;
7556 if (streams != null) {
7557 num = streams.size();
7558 }
7559 if (texts != null) {
7560 if (num >= 0 && num != texts.size()) {
7561 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007562 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007563 }
7564 num = texts.size();
7565 }
7566 if (htmlTexts != null) {
7567 if (num >= 0 && num != htmlTexts.size()) {
7568 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007569 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007570 }
7571 num = htmlTexts.size();
7572 }
7573 if (num > 0) {
7574 final ClipData clipData = new ClipData(
7575 null, new String[] { getType() },
7576 makeClipItem(streams, texts, htmlTexts, 0));
7577
7578 for (int i = 1; i < num; i++) {
7579 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7580 }
7581
7582 setClipData(clipData);
7583 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007584 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007585 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007586 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007587 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007588 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7589 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7590 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7591 final Uri output;
7592 try {
7593 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7594 } catch (ClassCastException e) {
7595 return false;
7596 }
7597 if (output != null) {
7598 setClipData(ClipData.newRawUri("", output));
7599 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
7600 return true;
7601 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007602 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007603
7604 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007605 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007606
7607 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7608 ArrayList<String> htmlTexts, int which) {
7609 Uri uri = streams != null ? streams.get(which) : null;
7610 CharSequence text = texts != null ? texts.get(which) : null;
7611 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7612 return new ClipData.Item(text, htmlText, null, uri);
7613 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007614
7615 /** @hide */
7616 public boolean isDocument() {
7617 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7618 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007619}