blob: dd57af94c199d6eb530cfdda90b987e511c3b927 [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 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001216 * Activity Action: List all available applications
1217 * <p>Input: Nothing.
1218 * <p>Output: nothing.
1219 */
1220 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1221 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1222 /**
1223 * Activity Action: Show settings for choosing wallpaper
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1229
1230 /**
1231 * Activity Action: Show activity for reporting a bug.
1232 * <p>Input: Nothing.
1233 * <p>Output: Nothing.
1234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1237
1238 /**
1239 * Activity Action: Main entry point for factory tests. Only used when
1240 * the device is booting in factory test node. The implementing package
1241 * must be installed in the system image.
1242 * <p>Input: nothing
1243 * <p>Output: nothing
1244 */
1245 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1246
1247 /**
1248 * Activity Action: The user pressed the "call" button to go to the dialer
1249 * or other appropriate UI for placing a call.
1250 * <p>Input: Nothing.
1251 * <p>Output: Nothing.
1252 */
1253 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1254 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1255
1256 /**
1257 * Activity Action: Start Voice Command.
1258 * <p>Input: Nothing.
1259 * <p>Output: Nothing.
1260 */
1261 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1262 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001263
1264 /**
1265 * Activity Action: Start action associated with long pressing on the
1266 * search key.
1267 * <p>Input: Nothing.
1268 * <p>Output: Nothing.
1269 */
1270 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1271 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001272
Jacek Surazski86b6c532009-05-13 14:38:28 +02001273 /**
1274 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1275 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001276 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001277 * <p>Input: No data is specified. The bug report is passed in using
1278 * an {@link #EXTRA_BUG_REPORT} field.
1279 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001280 *
1281 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001282 */
1283 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1284 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001285
1286 /**
1287 * Activity Action: Show power usage information to the user.
1288 * <p>Input: Nothing.
1289 * <p>Output: Nothing.
1290 */
1291 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1292 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001293
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001294 /**
1295 * Activity Action: Setup wizard to launch after a platform update. This
1296 * activity should have a string meta-data field associated with it,
1297 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1298 * the platform for setup. The activity will be launched only if
1299 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1300 * same value.
1301 * <p>Input: Nothing.
1302 * <p>Output: Nothing.
1303 * @hide
1304 */
1305 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1306 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001307
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001308 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001309 * Activity Action: Show settings for managing network data usage of a
1310 * specific application. Applications should define an activity that offers
1311 * options to control data usage.
1312 */
1313 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1314 public static final String ACTION_MANAGE_NETWORK_USAGE =
1315 "android.intent.action.MANAGE_NETWORK_USAGE";
1316
1317 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001318 * Activity Action: Launch application installer.
1319 * <p>
1320 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001321 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1322 * you can also use "package:<package-name>" to install an application for the
1323 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001324 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1325 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1326 * <p>
1327 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1328 * succeeded.
1329 *
1330 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1331 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1332 * @see #EXTRA_RETURN_RESULT
1333 */
1334 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1335 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1336
1337 /**
1338 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1339 * package. Specifies the installer package name; this package will receive the
1340 * {@link #ACTION_APP_ERROR} intent.
1341 */
1342 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1343 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1344
1345 /**
1346 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1347 * package. Specifies that the application being installed should not be
1348 * treated as coming from an unknown source, but as coming from the app
1349 * invoking the Intent. For this to work you must start the installer with
1350 * startActivityForResult().
1351 */
1352 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1353 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1354
1355 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001356 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1357 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001358 * data field originated from.
1359 */
rich cannings706e8ba2012-08-20 13:20:14 -07001360 public static final String EXTRA_ORIGINATING_URI
1361 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001362
1363 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001364 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1365 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1366 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001367 */
1368 public static final String EXTRA_REFERRER
1369 = "android.intent.extra.REFERRER";
1370
1371 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001372 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1373 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1374 * @hide
1375 */
1376 public static final String EXTRA_ORIGINATING_UID
1377 = "android.intent.extra.ORIGINATING_UID";
1378
1379 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001380 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1381 * package. Tells the installer UI to skip the confirmation with the user
1382 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001383 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1384 * will no longer show an interstitial message about updating existing
1385 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001386 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001387 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001388 public static final String EXTRA_ALLOW_REPLACE
1389 = "android.intent.extra.ALLOW_REPLACE";
1390
1391 /**
1392 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1393 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1394 * return to the application the result code of the install/uninstall. The returned result
1395 * code will be {@link android.app.Activity#RESULT_OK} on success or
1396 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1397 */
1398 public static final String EXTRA_RETURN_RESULT
1399 = "android.intent.extra.RETURN_RESULT";
1400
1401 /**
1402 * Package manager install result code. @hide because result codes are not
1403 * yet ready to be exposed.
1404 */
1405 public static final String EXTRA_INSTALL_RESULT
1406 = "android.intent.extra.INSTALL_RESULT";
1407
1408 /**
1409 * Activity Action: Launch application uninstaller.
1410 * <p>
1411 * Input: The data must be a package: URI whose scheme specific part is
1412 * the package name of the current installed package to be uninstalled.
1413 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1414 * <p>
1415 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1416 * succeeded.
1417 */
1418 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1419 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1420
1421 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001422 * Specify whether the package should be uninstalled for all users.
1423 * @hide because these should not be part of normal application flow.
1424 */
1425 public static final String EXTRA_UNINSTALL_ALL_USERS
1426 = "android.intent.extra.UNINSTALL_ALL_USERS";
1427
1428 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001429 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1430 * describing the last run version of the platform that was setup.
1431 * @hide
1432 */
1433 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1434
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001435 // ---------------------------------------------------------------------
1436 // ---------------------------------------------------------------------
1437 // Standard intent broadcast actions (see action variable).
1438
1439 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001440 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1441 * <p>
1442 * For historical reasons, the name of this broadcast action refers to the power
1443 * state of the screen but it is actually sent in response to changes in the
1444 * overall interactive state of the device.
1445 * </p><p>
1446 * This broadcast is sent when the device becomes non-interactive which may have
1447 * nothing to do with the screen turning off. To determine the
1448 * actual state of the screen, use {@link android.view.Display#getState}.
1449 * </p><p>
1450 * See {@link android.os.PowerManager#isInteractive} for details.
1451 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001452 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001453 * <p class="note">This is a protected intent that can only be sent
1454 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001455 */
1456 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1457 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001459 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001460 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1461 * <p>
1462 * For historical reasons, the name of this broadcast action refers to the power
1463 * state of the screen but it is actually sent in response to changes in the
1464 * overall interactive state of the device.
1465 * </p><p>
1466 * This broadcast is sent when the device becomes interactive which may have
1467 * nothing to do with the screen turning on. To determine the
1468 * actual state of the screen, use {@link android.view.Display#getState}.
1469 * </p><p>
1470 * See {@link android.os.PowerManager#isInteractive} for details.
1471 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001472 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001473 * <p class="note">This is a protected intent that can only be sent
1474 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001475 */
1476 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1477 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001478
1479 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001480 * Broadcast Action: Sent after the system stops dreaming.
1481 *
1482 * <p class="note">This is a protected intent that can only be sent by the system.
1483 * It is only sent to registered receivers.</p>
1484 */
1485 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1486 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1487
1488 /**
1489 * Broadcast Action: Sent after the system starts dreaming.
1490 *
1491 * <p class="note">This is a protected intent that can only be sent by the system.
1492 * It is only sent to registered receivers.</p>
1493 */
1494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1495 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1496
1497 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001498 * 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 -07001499 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001500 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001501 * <p class="note">This is a protected intent that can only be sent
1502 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001503 */
1504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001505 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001506
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001507 /**
1508 * Broadcast Action: The current time has changed. Sent every
1509 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001510 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001511 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1512 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001513 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001514 * <p class="note">This is a protected intent that can only be sent
1515 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001516 */
1517 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1518 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1519 /**
1520 * Broadcast Action: The time was set.
1521 */
1522 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1523 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1524 /**
1525 * Broadcast Action: The date has changed.
1526 */
1527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1528 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1529 /**
1530 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1531 * <ul>
1532 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1533 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001534 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001535 * <p class="note">This is a protected intent that can only be sent
1536 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1540 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001541 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1542 * DNS entries should be tossed.
1543 * @hide
1544 */
1545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1546 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1547 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001548 * Alarm Changed Action: This is broadcast when the AlarmClock
1549 * application's alarm is set or unset. It is used by the
1550 * AlarmClock application and the StatusBar service.
1551 * @hide
1552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1555 /**
1556 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1557 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1558 * @hide
1559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_SYNC_STATE_CHANGED
1562 = "android.intent.action.SYNC_STATE_CHANGED";
1563 /**
1564 * Broadcast Action: This is broadcast once, after the system has finished
1565 * booting. It can be used to perform application-specific initialization,
1566 * such as installing alarms. You must hold the
1567 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1568 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001569 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001570 * <p class="note">This is a protected intent that can only be sent
1571 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001572 */
1573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1574 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1575 /**
1576 * Broadcast Action: This is broadcast when a user action should request a
1577 * temporary system dialog to dismiss. Some examples of temporary system
1578 * dialogs are the notification window-shade and the recent tasks dialog.
1579 */
1580 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1581 /**
1582 * Broadcast Action: Trigger the download and eventual installation
1583 * of a package.
1584 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001585 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001586 * <p class="note">This is a protected intent that can only be sent
1587 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001588 *
1589 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001590 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001591 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001592 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1593 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1594 /**
1595 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001596 * device. The data contains the name of the package. Note that the
1597 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001598 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001599 * <ul>
1600 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1601 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1602 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1603 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001604 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001605 * <p class="note">This is a protected intent that can only be sent
1606 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001607 */
1608 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1609 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1610 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001611 * Broadcast Action: A new version of an application package has been
1612 * installed, replacing an existing version that was previously installed.
1613 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001614 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001615 * <ul>
1616 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1617 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001618 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001619 * <p class="note">This is a protected intent that can only be sent
1620 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001621 */
1622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1623 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1624 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001625 * Broadcast Action: A new version of your application has been installed
1626 * over an existing one. This is only sent to the application that was
1627 * replaced. It does not contain any additional data; to receive it, just
1628 * use an intent filter for this action.
1629 *
1630 * <p class="note">This is a protected intent that can only be sent
1631 * by the system.
1632 */
1633 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1634 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1635 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001636 * Broadcast Action: An existing application package has been removed from
1637 * the device. The data contains the name of the package. The package
1638 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001639 * <ul>
1640 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1641 * to the package.
1642 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1643 * application -- data and code -- is being removed.
1644 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1645 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1646 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001647 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001648 * <p class="note">This is a protected intent that can only be sent
1649 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001650 */
1651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1652 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1653 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001654 * Broadcast Action: An existing application package has been completely
1655 * removed from the device. The data contains the name of the package.
1656 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1657 * {@link #EXTRA_DATA_REMOVED} is true and
1658 * {@link #EXTRA_REPLACING} is false of that broadcast.
1659 *
1660 * <ul>
1661 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1662 * to the package.
1663 * </ul>
1664 *
1665 * <p class="note">This is a protected intent that can only be sent
1666 * by the system.
1667 */
1668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1669 public static final String ACTION_PACKAGE_FULLY_REMOVED
1670 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1671 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001672 * Broadcast Action: An existing application package has been changed (e.g.
1673 * a component has been enabled or disabled). The data contains the name of
1674 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001675 * <ul>
1676 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001677 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001678 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001679 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1680 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001681 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001682 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001683 * <p class="note">This is a protected intent that can only be sent
1684 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001685 */
1686 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1687 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1688 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001689 * @hide
1690 * Broadcast Action: Ask system services if there is any reason to
1691 * restart the given package. The data contains the name of the
1692 * package.
1693 * <ul>
1694 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1695 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1696 * </ul>
1697 *
1698 * <p class="note">This is a protected intent that can only be sent
1699 * by the system.
1700 */
1701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1702 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1703 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001704 * Broadcast Action: The user has restarted a package, and all of its
1705 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001706 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001707 * be removed. Note that the restarted package does <em>not</em>
1708 * receive this broadcast.
1709 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001710 * <ul>
1711 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1712 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001713 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001714 * <p class="note">This is a protected intent that can only be sent
1715 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001716 */
1717 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1718 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1719 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001720 * Broadcast Action: The user has cleared the data of a package. This should
1721 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001722 * its persistent data is erased and this broadcast sent.
1723 * Note that the cleared package does <em>not</em>
1724 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001725 * <ul>
1726 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1727 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001728 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001729 * <p class="note">This is a protected intent that can only be sent
1730 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001731 */
1732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1733 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1734 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001735 * Broadcast Action: A user ID has been removed from the system. The user
1736 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001737 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001738 * <p class="note">This is a protected intent that can only be sent
1739 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001740 */
1741 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1742 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001743
1744 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001745 * Broadcast Action: Sent to the installer package of an application
1746 * when that application is first launched (that is the first time it
1747 * is moved out of the stopped state). The data contains the name of the package.
1748 *
1749 * <p class="note">This is a protected intent that can only be sent
1750 * by the system.
1751 */
1752 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1753 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1754
1755 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001756 * Broadcast Action: Sent to the system package verifier when a package
1757 * needs to be verified. The data contains the package URI.
1758 * <p class="note">
1759 * This is a protected intent that can only be sent by the system.
1760 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001761 */
1762 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1763 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1764
1765 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001766 * Broadcast Action: Sent to the system package verifier when a package is
1767 * verified. The data contains the package URI.
1768 * <p class="note">
1769 * This is a protected intent that can only be sent by the system.
1770 */
1771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1772 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1773
1774 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001775 * Broadcast Action: Resources for a set of packages (which were
1776 * previously unavailable) are currently
1777 * available since the media on which they exist is available.
1778 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1779 * list of packages whose availability changed.
1780 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1781 * list of uids of packages whose availability changed.
1782 * Note that the
1783 * packages in this list do <em>not</em> receive this broadcast.
1784 * The specified set of packages are now available on the system.
1785 * <p>Includes the following extras:
1786 * <ul>
1787 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1788 * whose resources(were previously unavailable) are currently available.
1789 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1790 * packages whose resources(were previously unavailable)
1791 * are currently available.
1792 * </ul>
1793 *
1794 * <p class="note">This is a protected intent that can only be sent
1795 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001796 */
1797 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001798 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1799 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001800
1801 /**
1802 * Broadcast Action: Resources for a set of packages are currently
1803 * unavailable since the media on which they exist is unavailable.
1804 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1805 * list of packages whose availability changed.
1806 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1807 * list of uids of packages whose availability changed.
1808 * The specified set of packages can no longer be
1809 * launched and are practically unavailable on the system.
1810 * <p>Inclues the following extras:
1811 * <ul>
1812 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1813 * whose resources are no longer available.
1814 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1815 * whose resources are no longer available.
1816 * </ul>
1817 *
1818 * <p class="note">This is a protected intent that can only be sent
1819 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001820 */
1821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001822 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001823 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001824
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001825 /**
1826 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001827 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001828 * This should <em>only</em> be used to determine when the wallpaper
1829 * has changed to show the new wallpaper to the user. You should certainly
1830 * never, in response to this, change the wallpaper or other attributes of
1831 * it such as the suggested size. That would be crazy, right? You'd cause
1832 * all kinds of loops, especially if other apps are doing similar things,
1833 * right? Of course. So please don't do this.
1834 *
1835 * @deprecated Modern applications should use
1836 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1837 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1838 * shown behind their UI, rather than watching for this broadcast and
1839 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001841 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001842 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1843 /**
1844 * Broadcast Action: The current device {@link android.content.res.Configuration}
1845 * (orientation, locale, etc) has changed. When such a change happens, the
1846 * UIs (view hierarchy) will need to be rebuilt based on this new
1847 * information; for the most part, applications don't need to worry about
1848 * this, because the system will take care of stopping and restarting the
1849 * application to make sure it sees the new changes. Some system code that
1850 * can not be restarted will need to watch for this action and handle it
1851 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001853 * <p class="note">
1854 * You can <em>not</em> receive this through components declared
1855 * in manifests, only by explicitly registering for it with
1856 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1857 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001858 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001859 * <p class="note">This is a protected intent that can only be sent
1860 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001861 *
1862 * @see android.content.res.Configuration
1863 */
1864 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1865 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1866 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001867 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001868 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001869 * <p class="note">This is a protected intent that can only be sent
1870 * by the system.
1871 */
1872 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1873 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1874 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001875 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1876 * charging state, level, and other information about the battery.
1877 * See {@link android.os.BatteryManager} for documentation on the
1878 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001879 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001880 * <p class="note">
1881 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001882 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001883 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001884 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1885 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1886 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1887 * broadcasts that are sent and can be received through manifest
1888 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001889 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001890 * <p class="note">This is a protected intent that can only be sent
1891 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001892 */
1893 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1894 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1895 /**
1896 * Broadcast Action: Indicates low battery condition on the device.
1897 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001898 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001899 * <p class="note">This is a protected intent that can only be sent
1900 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001901 */
1902 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1903 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1904 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001905 * Broadcast Action: Indicates the battery is now okay after being low.
1906 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1907 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001908 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001909 * <p class="note">This is a protected intent that can only be sent
1910 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001911 */
1912 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1913 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1914 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001915 * Broadcast Action: External power has been connected to the device.
1916 * This is intended for applications that wish to register specifically to this notification.
1917 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1918 * stay active to receive this notification. This action can be used to implement actions
1919 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001920 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001921 * <p class="note">This is a protected intent that can only be sent
1922 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001923 */
1924 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001925 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001926 /**
1927 * Broadcast Action: External power has been removed from the device.
1928 * This is intended for applications that wish to register specifically to this notification.
1929 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1930 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001931 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001932 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001933 * <p class="note">This is a protected intent that can only be sent
1934 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001935 */
1936 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001937 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001938 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001939 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001940 * Broadcast Action: Device is shutting down.
1941 * This is broadcast when the device is being shut down (completely turned
1942 * off, not sleeping). Once the broadcast is complete, the final shutdown
1943 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001944 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001945 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001946 * <p class="note">This is a protected intent that can only be sent
1947 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001948 * <p>May include the following extras:
1949 * <ul>
1950 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1951 * shutdown is only for userspace processes. If not set, assumed to be false.
1952 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001953 */
1954 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001955 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001956 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001957 * Activity Action: Start this activity to request system shutdown.
1958 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1959 * to request confirmation from the user before shutting down.
1960 *
1961 * <p class="note">This is a protected intent that can only be sent
1962 * by the system.
1963 *
1964 * {@hide}
1965 */
1966 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1967 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001968 * Broadcast Action: A sticky broadcast that indicates low memory
1969 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001970 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001971 * <p class="note">This is a protected intent that can only be sent
1972 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 */
1974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1975 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1976 /**
1977 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001978 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001979 * <p class="note">This is a protected intent that can only be sent
1980 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 */
1982 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1983 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1984 /**
Jake Hambybb371632010-08-23 18:16:48 -07001985 * Broadcast Action: A sticky broadcast that indicates a memory full
1986 * condition on the device. This is intended for activities that want
1987 * to be able to fill the data partition completely, leaving only
1988 * enough free space to prevent system-wide SQLite failures.
1989 *
1990 * <p class="note">This is a protected intent that can only be sent
1991 * by the system.
1992 *
1993 * {@hide}
1994 */
1995 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1996 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1997 /**
1998 * Broadcast Action: Indicates memory full condition on the device
1999 * no longer exists.
2000 *
2001 * <p class="note">This is a protected intent that can only be sent
2002 * by the system.
2003 *
2004 * {@hide}
2005 */
2006 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2007 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2008 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002009 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2010 * and package management should be started.
2011 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2012 * notification.
2013 */
2014 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2015 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2016 /**
2017 * Broadcast Action: The device has entered USB Mass Storage mode.
2018 * This is used mainly for the USB Settings panel.
2019 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2020 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002021 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002022 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002023 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002024 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2025
2026 /**
2027 * Broadcast Action: The device has exited USB Mass Storage mode.
2028 * This is used mainly for the USB Settings panel.
2029 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2030 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002031 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002032 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002033 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002034 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2035
2036 /**
2037 * Broadcast Action: External media has been removed.
2038 * The path to the mount point for the removed media is contained in the Intent.mData field.
2039 */
2040 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2041 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2042
2043 /**
2044 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002045 * 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 -07002046 */
2047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2049
2050 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002051 * Broadcast Action: External media is present, and being disk-checked
2052 * 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 -08002053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2056
2057 /**
2058 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
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_NOFS = "android.intent.action.MEDIA_NOFS";
2063
2064 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002065 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002066 * 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 -07002067 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2068 * media was mounted read only.
2069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2072
2073 /**
2074 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002075 * 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 -07002076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2079
2080 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002081 * Broadcast Action: External media is no longer being shared via USB mass storage.
2082 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2083 *
2084 * @hide
2085 */
2086 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2087
2088 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002089 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2090 * The path to the mount point for the removed media is contained in the Intent.mData field.
2091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2094
2095 /**
2096 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002097 * 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 -07002098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2101
2102 /**
2103 * Broadcast Action: User has expressed the desire to remove the external storage media.
2104 * Applications should close all files they have open within the mount point when they receive this intent.
2105 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2106 */
2107 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2108 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2109
2110 /**
2111 * Broadcast Action: The media scanner has started scanning a directory.
2112 * The path to the directory being scanned is contained in the Intent.mData field.
2113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2116
2117 /**
2118 * Broadcast Action: The media scanner has finished scanning a directory.
2119 * The path to the scanned directory is contained in the Intent.mData field.
2120 */
2121 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2122 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2123
2124 /**
2125 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2126 * The path to the file is contained in the Intent.mData field.
2127 */
2128 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2129 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2130
2131 /**
2132 * Broadcast Action: The "Media Button" was pressed. Includes a single
2133 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2134 * caused the broadcast.
2135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2138
2139 /**
2140 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2141 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2142 * caused the broadcast.
2143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2146
2147 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2148 // location; they are not general-purpose actions.
2149
2150 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002151 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2155 "android.intent.action.GTALK_CONNECTED";
2156
2157 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002158 * Broadcast Action: A GTalk connection has been disconnected.
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_DISCONNECTED =
2162 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002163
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002164 /**
2165 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002166 */
2167 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2168 public static final String ACTION_INPUT_METHOD_CHANGED =
2169 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002170
2171 /**
2172 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2173 * more radios have been turned off or on. The intent will have the following extra value:</p>
2174 * <ul>
2175 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2176 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2177 * turned off</li>
2178 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002179 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002180 * <p class="note">This is a protected intent that can only be sent
2181 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002182 */
2183 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2184 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2185
2186 /**
2187 * Broadcast Action: Some content providers have parts of their namespace
2188 * where they publish new events or items that the user may be especially
2189 * interested in. For these things, they may broadcast this action when the
2190 * set of interesting items change.
2191 *
2192 * For example, GmailProvider sends this notification when the set of unread
2193 * mail in the inbox changes.
2194 *
2195 * <p>The data of the intent identifies which part of which provider
2196 * changed. When queried through the content resolver, the data URI will
2197 * return the data set in question.
2198 *
2199 * <p>The intent will have the following extra values:
2200 * <ul>
2201 * <li><em>count</em> - The number of items in the data set. This is the
2202 * same as the number of items in the cursor returned by querying the
2203 * data URI. </li>
2204 * </ul>
2205 *
2206 * This intent will be sent at boot (if the count is non-zero) and when the
2207 * data set changes. It is possible for the data set to change without the
2208 * count changing (for example, if a new unread message arrives in the same
2209 * sync operation in which a message is archived). The phone should still
2210 * ring/vibrate/etc as normal in this case.
2211 */
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_PROVIDER_CHANGED =
2214 "android.intent.action.PROVIDER_CHANGED";
2215
2216 /**
2217 * Broadcast Action: Wired Headset plugged in or unplugged.
2218 *
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002219 * Same as {@link android.media.AudioManager#ACTION_HEADSET_PLUG}, to be consulted for value
2220 * and documentation.
2221 * <p>If the minimum SDK version of your application is
2222 * {@link android.os.Build.VERSION_CODES#L}, it is recommended to refer
2223 * to the <code>AudioManager</code> constant in your receiver registration code instead.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002224 */
2225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Michel Trivic5258432014-08-27 15:46:54 -07002226 public static final String ACTION_HEADSET_PLUG = android.media.AudioManager.ACTION_HEADSET_PLUG;
Eric Laurent59f48272012-04-05 19:42:21 -07002227
2228 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002229 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2230 * <ul>
2231 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2232 * </ul>
2233 *
2234 * <p class="note">This is a protected intent that can only be sent
2235 * by the system.
2236 *
2237 * @hide
2238 */
2239 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2240 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2241 = "android.intent.action.ADVANCED_SETTINGS";
2242
2243 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002244 * Broadcast Action: Sent after application restrictions are changed.
2245 *
2246 * <p class="note">This is a protected intent that can only be sent
2247 * by the system.</p>
2248 */
2249 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2250 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2251 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2252
2253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002254 * Broadcast Action: An outgoing call is about to be placed.
2255 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002256 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002257 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002258 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002259 * the phone number originally intended to be dialed.</li>
2260 * </ul>
2261 * <p>Once the broadcast is finished, the resultData is used as the actual
2262 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002263 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 * outgoing call in turn: for example, a parental control application
2265 * might verify that the user is authorized to place the call at that
2266 * time, then a number-rewriting application might add an area code if
2267 * one was not specified.</p>
2268 * <p>For consistency, any receiver whose purpose is to prohibit phone
2269 * calls should have a priority of 0, to ensure it will see the final
2270 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002271 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002272 * should have a positive priority.
2273 * Negative priorities are reserved for the system for this broadcast;
2274 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002275 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2276 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002277 * <p>Emergency calls cannot be intercepted using this mechanism, and
2278 * other calls cannot be modified to call emergency numbers using this
2279 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002280 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2281 * call to use their own service instead. Those apps should first prevent
2282 * the call from being placed by setting resultData to <code>null</code>
2283 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002284 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002285 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2286 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002287 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002288 * <p class="note">This is a protected intent that can only be sent
2289 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002290 */
2291 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2292 public static final String ACTION_NEW_OUTGOING_CALL =
2293 "android.intent.action.NEW_OUTGOING_CALL";
2294
2295 /**
2296 * Broadcast Action: Have the device reboot. This is only for use by
2297 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002298 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002299 * <p class="note">This is a protected intent that can only be sent
2300 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002301 */
2302 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2303 public static final String ACTION_REBOOT =
2304 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002305
Wei Huang97ecc9c2009-05-11 17:44:20 -07002306 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002307 * Broadcast Action: A sticky broadcast for changes in the physical
2308 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002309 *
2310 * <p>The intent will have the following extra values:
2311 * <ul>
2312 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002313 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002314 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002315 * <p>This is intended for monitoring the current physical dock state.
2316 * See {@link android.app.UiModeManager} for the normal API dealing with
2317 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002318 */
2319 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2320 public static final String ACTION_DOCK_EVENT =
2321 "android.intent.action.DOCK_EVENT";
2322
2323 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002324 * Broadcast Action: A broadcast when idle maintenance can be started.
2325 * This means that the user is not interacting with the device and is
2326 * not expected to do so soon. Typical use of the idle maintenance is
2327 * to perform somehow expensive tasks that can be postponed at a moment
2328 * when they will not degrade user experience.
2329 * <p>
2330 * <p class="note">In order to keep the device responsive in case of an
2331 * unexpected user interaction, implementations of a maintenance task
2332 * should be interruptible. In such a scenario a broadcast with action
2333 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2334 * should not do the maintenance work in
2335 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2336 * maintenance service by {@link Context#startService(Intent)}. Also
2337 * you should hold a wake lock while your maintenance service is running
2338 * to prevent the device going to sleep.
2339 * </p>
2340 * <p>
2341 * <p class="note">This is a protected intent that can only be sent by
2342 * the system.
2343 * </p>
2344 *
2345 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002346 *
2347 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002348 */
2349 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2350 public static final String ACTION_IDLE_MAINTENANCE_START =
2351 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2352
2353 /**
2354 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2355 * This means that the user was not interacting with the device as a result
2356 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2357 * was sent and now the user started interacting with the device. Typical
2358 * use of the idle maintenance is to perform somehow expensive tasks that
2359 * can be postponed at a moment when they will not degrade user experience.
2360 * <p>
2361 * <p class="note">In order to keep the device responsive in case of an
2362 * unexpected user interaction, implementations of a maintenance task
2363 * should be interruptible. Hence, on receiving a broadcast with this
2364 * action, the maintenance task should be interrupted as soon as possible.
2365 * In other words, you should not do the maintenance work in
2366 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2367 * maintenance service that was started on receiving of
2368 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2369 * lock you acquired when your maintenance service started.
2370 * </p>
2371 * <p class="note">This is a protected intent that can only be sent
2372 * by the system.
2373 *
2374 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002375 *
2376 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002377 */
2378 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2379 public static final String ACTION_IDLE_MAINTENANCE_END =
2380 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2381
2382 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002383 * Broadcast Action: a remote intent is to be broadcasted.
2384 *
2385 * A remote intent is used for remote RPC between devices. The remote intent
2386 * is serialized and sent from one device to another device. The receiving
2387 * device parses the remote intent and broadcasts it. Note that anyone can
2388 * broadcast a remote intent. However, if the intent receiver of the remote intent
2389 * does not trust intent broadcasts from arbitrary intent senders, it should require
2390 * the sender to hold certain permissions so only trusted sender's broadcast will be
2391 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002392 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002393 */
2394 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002395 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002396
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002397 /**
2398 * Broadcast Action: hook for permforming cleanup after a system update.
2399 *
2400 * The broadcast is sent when the system is booting, before the
2401 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2402 * image. A receiver for this should do its work and then disable itself
2403 * so that it does not get run again at the next boot.
2404 * @hide
2405 */
2406 public static final String ACTION_PRE_BOOT_COMPLETED =
2407 "android.intent.action.PRE_BOOT_COMPLETED";
2408
Amith Yamasani13593602012-03-22 16:16:17 -07002409 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002410 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002411 * on restricted users. The broadcast intent contains an extra
2412 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2413 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2414 * String[] depending on the restriction type.<p/>
2415 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002416 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2417 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2418 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002419 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2420 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002421 * @see RestrictionEntry
2422 */
2423 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2424 "android.intent.action.GET_RESTRICTION_ENTRIES";
2425
2426 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002427 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002428 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002429 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2430 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2431 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002432 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2433 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2434 * challenge.<p/>
2435 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002436 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002437 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002438 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2439 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002440
2441 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002442 * Sent the first time a user is starting, to allow system apps to
2443 * perform one time initialization. (This will not be seen by third
2444 * party applications because a newly initialized user does not have any
2445 * third party applications installed for it.) This is sent early in
2446 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002447 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2448 * broadcast, since it is part of a visible user interaction; be as quick
2449 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002450 */
2451 public static final String ACTION_USER_INITIALIZE =
2452 "android.intent.action.USER_INITIALIZE";
2453
2454 /**
2455 * Sent when a user switch is happening, causing the process's user to be
2456 * brought to the foreground. This is only sent to receivers registered
2457 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2458 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002459 * foreground. This is sent as a foreground
2460 * broadcast, since it is part of a visible user interaction; be as quick
2461 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002462 */
2463 public static final String ACTION_USER_FOREGROUND =
2464 "android.intent.action.USER_FOREGROUND";
2465
2466 /**
2467 * Sent when a user switch is happening, causing the process's user to be
2468 * sent to the background. This is only sent to receivers registered
2469 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2470 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002471 * background. This is sent as a foreground
2472 * broadcast, since it is part of a visible user interaction; be as quick
2473 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002474 */
2475 public static final String ACTION_USER_BACKGROUND =
2476 "android.intent.action.USER_BACKGROUND";
2477
2478 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002479 * Broadcast sent to the system when a user is added. Carries an extra
2480 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2481 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002482 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002483 * @hide
2484 */
2485 public static final String ACTION_USER_ADDED =
2486 "android.intent.action.USER_ADDED";
2487
2488 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002489 * Broadcast sent by the system when a user is started. Carries an extra
2490 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002491 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002492 * that has been started. This is sent as a foreground
2493 * broadcast, since it is part of a visible user interaction; be as quick
2494 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002495 * @hide
2496 */
2497 public static final String ACTION_USER_STARTED =
2498 "android.intent.action.USER_STARTED";
2499
2500 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002501 * Broadcast sent when a user is in the process of starting. Carries an extra
2502 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2503 * sent to registered receivers, not manifest receivers. It is sent to all
2504 * users (including the one that is being started). You must hold
2505 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2506 * this broadcast. This is sent as a background broadcast, since
2507 * its result is not part of the primary UX flow; to safely keep track of
2508 * started/stopped state of a user you can use this in conjunction with
2509 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2510 * other user state broadcasts since those are foreground broadcasts so can
2511 * execute in a different order.
2512 * @hide
2513 */
2514 public static final String ACTION_USER_STARTING =
2515 "android.intent.action.USER_STARTING";
2516
2517 /**
2518 * Broadcast sent when a user is going to be stopped. Carries an extra
2519 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2520 * sent to registered receivers, not manifest receivers. It is sent to all
2521 * users (including the one that is being stopped). You must hold
2522 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2523 * this broadcast. The user will not stop until all receivers have
2524 * handled the broadcast. This is sent as a background broadcast, since
2525 * its result is not part of the primary UX flow; to safely keep track of
2526 * started/stopped state of a user you can use this in conjunction with
2527 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2528 * other user state broadcasts since those are foreground broadcasts so can
2529 * execute in a different order.
2530 * @hide
2531 */
2532 public static final String ACTION_USER_STOPPING =
2533 "android.intent.action.USER_STOPPING";
2534
2535 /**
2536 * Broadcast sent to the system when a user is stopped. Carries an extra
2537 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2538 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2539 * specific package. This is only sent to registered receivers, not manifest
2540 * receivers. It is sent to all running users <em>except</em> the one that
2541 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002542 * @hide
2543 */
2544 public static final String ACTION_USER_STOPPED =
2545 "android.intent.action.USER_STOPPED";
2546
2547 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002548 * 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 -07002549 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002550 * one that has been removed. The user will not be completely removed until all receivers have
2551 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002552 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002553 * @hide
2554 */
2555 public static final String ACTION_USER_REMOVED =
2556 "android.intent.action.USER_REMOVED";
2557
2558 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002559 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002560 * the userHandle of the user to become the current one. This is only sent to
2561 * registered receivers, not manifest receivers. It is sent to all running users.
2562 * You must hold
2563 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002564 * @hide
2565 */
2566 public static final String ACTION_USER_SWITCHED =
2567 "android.intent.action.USER_SWITCHED";
2568
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002569 /**
2570 * Broadcast sent to the system when a user's information changes. Carries an extra
2571 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002572 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002573 * @hide
2574 */
2575 public static final String ACTION_USER_INFO_CHANGED =
2576 "android.intent.action.USER_INFO_CHANGED";
2577
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002578 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002579 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2580 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002581 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2582 * that need to display merged content across both primary and managed profiles need to
2583 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002584 * not manifest receivers.
2585 */
2586 public static final String ACTION_MANAGED_PROFILE_ADDED =
2587 "android.intent.action.MANAGED_PROFILE_ADDED";
2588
2589 /**
2590 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002591 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2592 * Only applications (for example Launchers) that need to display merged content across both
2593 * primary and managed profiles need to worry about this broadcast. This is only sent to
2594 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002595 */
2596 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2597 "android.intent.action.MANAGED_PROFILE_REMOVED";
2598
2599 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002600 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2601 */
2602 public static final String ACTION_QUICK_CLOCK =
2603 "android.intent.action.QUICK_CLOCK";
2604
Michael Wright0087a142013-02-05 16:29:39 -08002605 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002606 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002607 * @hide
2608 */
2609 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2610 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2611
Justin Kohd378ad72013-04-01 12:18:26 -07002612 /**
2613 * Broadcast Action: A global button was pressed. Includes a single
2614 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2615 * caused the broadcast.
2616 * @hide
2617 */
2618 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2619
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002620 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002621 * Activity Action: Allow the user to select and return one or more existing
2622 * documents. When invoked, the system will display the various
2623 * {@link DocumentsProvider} instances installed on the device, letting the
2624 * user interactively navigate through them. These documents include local
2625 * media, such as photos and video, and documents provided by installed
2626 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002627 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002628 * Each document is represented as a {@code content://} URI backed by a
2629 * {@link DocumentsProvider}, which can be opened as a stream with
2630 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2631 * {@link android.provider.DocumentsContract.Document} metadata.
2632 * <p>
2633 * All selected documents are returned to the calling application with
2634 * persistable read and write permission grants. If you want to maintain
2635 * access to the documents across device reboots, you need to explicitly
2636 * take the persistable permissions using
2637 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2638 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002639 * Callers must indicate the acceptable document MIME types through
2640 * {@link #setType(String)}. For example, to select photos, use
2641 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2642 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2643 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002644 * <p>
2645 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002646 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2647 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002648 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002649 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2650 * returned URIs can be opened with
2651 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002652 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002653 * Output: The URI of the item that was picked, returned in
2654 * {@link #getData()}. This must be a {@code content://} URI so that any
2655 * receiver can access it. If multiple documents were selected, they are
2656 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002657 *
2658 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002659 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002660 * @see #ACTION_CREATE_DOCUMENT
2661 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002662 */
2663 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2664 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2665
2666 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002667 * Activity Action: Allow the user to create a new document. When invoked,
2668 * the system will display the various {@link DocumentsProvider} instances
2669 * installed on the device, letting the user navigate through them. The
2670 * returned document may be a newly created document with no content, or it
2671 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002672 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002673 * Each document is represented as a {@code content://} URI backed by a
2674 * {@link DocumentsProvider}, which can be opened as a stream with
2675 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2676 * {@link android.provider.DocumentsContract.Document} metadata.
2677 * <p>
2678 * Callers must indicate the concrete MIME type of the document being
2679 * created by setting {@link #setType(String)}. This MIME type cannot be
2680 * changed after the document is created.
2681 * <p>
2682 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2683 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002684 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002685 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2686 * returned URIs can be opened with
2687 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002688 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002689 * Output: The URI of the item that was created. This must be a
2690 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002691 *
2692 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002693 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002694 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002695 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002696 */
2697 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2698 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2699
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002700 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002701 * Activity Action: Allow the user to pick a directory subtree. When
2702 * invoked, the system will display the various {@link DocumentsProvider}
2703 * instances installed on the device, letting the user navigate through
2704 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002705 * <p>
2706 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002707 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2708 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2709 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002710 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002711 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002712 *
2713 * @see DocumentsContract
2714 */
2715 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002716 public static final String
2717 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002718
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002719 // ---------------------------------------------------------------------
2720 // ---------------------------------------------------------------------
2721 // Standard intent categories (see addCategory()).
2722
2723 /**
2724 * Set if the activity should be an option for the default action
2725 * (center press) to perform on a piece of data. Setting this will
2726 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002727 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002728 * Intent when initiating an action -- it is for use in intent filters
2729 * specified in packages.
2730 */
2731 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2732 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2733 /**
2734 * Activities that can be safely invoked from a browser must support this
2735 * category. For example, if the user is viewing a web page or an e-mail
2736 * and clicks on a link in the text, the Intent generated execute that
2737 * link will require the BROWSABLE category, so that only activities
2738 * supporting this category will be considered as possible actions. By
2739 * supporting this category, you are promising that there is nothing
2740 * damaging (without user intervention) that can happen by invoking any
2741 * matching Intent.
2742 */
2743 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2744 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2745 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07002746 * Categories for activities that can participate in voice interaction.
2747 * An activity that supports this category must be prepared to run with
2748 * no UI shown at all (though in some case it may have a UI shown), and
2749 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2750 */
2751 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2752 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2753 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002754 * Set if the activity should be considered as an alternative action to
2755 * the data the user is currently viewing. See also
2756 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2757 * applies to the selection in a list of items.
2758 *
2759 * <p>Supporting this category means that you would like your activity to be
2760 * displayed in the set of alternative things the user can do, usually as
2761 * part of the current activity's options menu. You will usually want to
2762 * include a specific label in the &lt;intent-filter&gt; of this action
2763 * describing to the user what it does.
2764 *
2765 * <p>The action of IntentFilter with this category is important in that it
2766 * describes the specific action the target will perform. This generally
2767 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2768 * a specific name such as "com.android.camera.action.CROP. Only one
2769 * alternative of any particular action will be shown to the user, so using
2770 * a specific action like this makes sure that your alternative will be
2771 * displayed while also allowing other applications to provide their own
2772 * overrides of that particular action.
2773 */
2774 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2775 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2776 /**
2777 * Set if the activity should be considered as an alternative selection
2778 * action to the data the user has currently selected. This is like
2779 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2780 * of items from which the user can select, giving them alternatives to the
2781 * default action that will be performed on it.
2782 */
2783 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2784 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2785 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002786 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002787 */
2788 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2789 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2790 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002791 * Should be displayed in the top-level launcher.
2792 */
2793 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2794 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2795 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002796 * Indicates an activity optimized for Leanback mode, and that should
2797 * be displayed in the Leanback launcher.
2798 */
2799 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2800 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2801 /**
Jose Lima73915cf2014-07-29 17:16:31 -07002802 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
2803 * @hide
2804 */
2805 @SystemApi
2806 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
2807 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002808 * Provides information about the package it is in; typically used if
2809 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2810 * a front-door to the user without having to be shown in the all apps list.
2811 */
2812 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2813 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2814 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002815 * This is the home activity, that is the first activity that is displayed
2816 * when the device boots.
2817 */
2818 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2819 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2820 /**
2821 * This activity is a preference panel.
2822 */
2823 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2824 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2825 /**
2826 * This activity is a development preference panel.
2827 */
2828 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2829 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2830 /**
2831 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002832 */
2833 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2834 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2835 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002836 * This activity allows the user to browse and download new applications.
2837 */
2838 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2839 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2840 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002841 * This activity may be exercised by the monkey or other automated test tools.
2842 */
2843 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2844 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2845 /**
2846 * To be used as a test (not part of the normal user experience).
2847 */
2848 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2849 /**
2850 * To be used as a unit test (run through the Test Harness).
2851 */
2852 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2853 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002854 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002855 * experience).
2856 */
2857 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002858
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002860 * Used to indicate that an intent only wants URIs that can be opened with
2861 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2862 * must support at least the columns defined in {@link OpenableColumns} when
2863 * queried.
2864 *
2865 * @see #ACTION_GET_CONTENT
2866 * @see #ACTION_OPEN_DOCUMENT
2867 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002868 */
2869 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2870 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2871
2872 /**
2873 * To be used as code under test for framework instrumentation tests.
2874 */
2875 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2876 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002877 /**
2878 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002879 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2880 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002881 */
2882 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2883 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2884 /**
2885 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002886 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2887 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002888 */
2889 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2890 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002891 /**
2892 * An activity to run when device is inserted into a analog (low end) dock.
2893 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2894 * information, see {@link android.app.UiModeManager}.
2895 */
2896 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2897 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2898
2899 /**
2900 * An activity to run when device is inserted into a digital (high end) dock.
2901 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2902 * information, see {@link android.app.UiModeManager}.
2903 */
2904 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2905 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002906
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002907 /**
2908 * Used to indicate that the activity can be used in a car environment.
2909 */
2910 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2911 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2912
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002913 // ---------------------------------------------------------------------
2914 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002915 // Application launch intent categories (see addCategory()).
2916
2917 /**
2918 * Used with {@link #ACTION_MAIN} to launch the browser application.
2919 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002920 * <p>NOTE: This should not be used as the primary key of an Intent,
2921 * since it will not result in the app launching with the correct
2922 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002923 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002924 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002925 */
2926 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2927 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2928
2929 /**
2930 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2931 * The activity should be able to perform standard arithmetic operations.
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_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2940
2941 /**
2942 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2943 * The activity should be able to view and manipulate calendar entries.
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_CALENDAR = "android.intent.category.APP_CALENDAR";
2952
2953 /**
2954 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2955 * The activity should be able to view and manipulate address book 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_CONTACTS = "android.intent.category.APP_CONTACTS";
2964
2965 /**
2966 * Used with {@link #ACTION_MAIN} to launch the email application.
2967 * The activity should be able to send and receive email.
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_EMAIL = "android.intent.category.APP_EMAIL";
2976
2977 /**
2978 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2979 * The activity should be able to view and manipulate image and video files
2980 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002981 * <p>NOTE: This should not be used as the primary key of an Intent,
2982 * since it will not result in the app launching with the correct
2983 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002984 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002985 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002986 */
2987 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2988 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2989
2990 /**
2991 * Used with {@link #ACTION_MAIN} to launch the maps application.
2992 * The activity should be able to show the user's current location and surroundings.
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_MAPS = "android.intent.category.APP_MAPS";
3001
3002 /**
3003 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3004 * The activity should be able to send and receive text messages.
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_MESSAGING = "android.intent.category.APP_MESSAGING";
3013
3014 /**
3015 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003016 * The activity should be able to play, browse, or manipulate music files
3017 * stored on the device.
3018 * <p>NOTE: This should not be used as the primary key of an Intent,
3019 * since it will not result in the app launching with the correct
3020 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003021 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003022 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003023 */
3024 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3025 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3026
3027 // ---------------------------------------------------------------------
3028 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003029 // Standard extra data keys.
3030
3031 /**
3032 * The initial data to place in a newly created record. Use with
3033 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3034 * fields as would be given to the underlying ContentProvider.insert()
3035 * call.
3036 */
3037 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3038
3039 /**
3040 * A constant CharSequence that is associated with the Intent, used with
3041 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3042 * this may be a styled CharSequence, so you must use
3043 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3044 * retrieve it.
3045 */
3046 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3047
3048 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003049 * A constant String that is associated with the Intent, used with
3050 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3051 * as HTML formatted text. Note that you <em>must</em> also supply
3052 * {@link #EXTRA_TEXT}.
3053 */
3054 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3055
3056 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003057 * A content: URI holding a stream of data associated with the Intent,
3058 * used with {@link #ACTION_SEND} to supply the data being sent.
3059 */
3060 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3061
3062 /**
3063 * A String[] holding e-mail addresses that should be delivered to.
3064 */
3065 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3066
3067 /**
3068 * A String[] holding e-mail addresses that should be carbon copied.
3069 */
3070 public static final String EXTRA_CC = "android.intent.extra.CC";
3071
3072 /**
3073 * A String[] holding e-mail addresses that should be blind carbon copied.
3074 */
3075 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3076
3077 /**
3078 * A constant string holding the desired subject line of a message.
3079 */
3080 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3081
3082 /**
3083 * An Intent describing the choices you would like shown with
3084 * {@link #ACTION_PICK_ACTIVITY}.
3085 */
3086 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3087
3088 /**
3089 * A CharSequence dialog title to provide to the user when used with a
Jim Miller4d64746d2014-08-13 21:08:41 +00003090 * {@link #ACTION_CHOOSER}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003091 */
3092 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3093
3094 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003095 * A Parcelable[] of {@link Intent} or
3096 * {@link android.content.pm.LabeledIntent} objects as set with
3097 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3098 * a the front of the list of choices, when shown to the user with a
3099 * {@link #ACTION_CHOOSER}.
3100 */
3101 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3102
3103 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003104 * A Bundle forming a mapping of potential target package names to different extras Bundles
3105 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3106 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3107 * be currently installed on the device.
3108 *
3109 * <p>An application may choose to provide alternate extras for the case where a user
3110 * selects an activity from a predetermined set of target packages. If the activity
3111 * the user selects from the chooser belongs to a package with its package name as
3112 * a key in this bundle, the corresponding extras for that package will be merged with
3113 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3114 * extra has the same key as an extra already present in the intent it will overwrite
3115 * the extra from the intent.</p>
3116 *
3117 * <p><em>Examples:</em>
3118 * <ul>
3119 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3120 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3121 * parameters for that target.</li>
3122 * <li>An application may offer additional metadata for known targets of a given intent
3123 * to pass along information only relevant to that target such as account or content
3124 * identifiers already known to that application.</li>
3125 * </ul></p>
3126 */
3127 public static final String EXTRA_REPLACEMENT_EXTRAS =
3128 "android.intent.extra.REPLACEMENT_EXTRAS";
3129
3130 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003131 * A {@link android.view.KeyEvent} object containing the event that
3132 * triggered the creation of the Intent it is in.
3133 */
3134 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3135
3136 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003137 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3138 * before shutting down.
3139 *
3140 * {@hide}
3141 */
3142 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3143
3144 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003145 * 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 -07003146 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3147 * of restarting the application.
3148 */
3149 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3150
3151 /**
3152 * A String holding the phone number originally entered in
3153 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3154 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3155 */
3156 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003157
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003158 /**
3159 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3160 * intents to supply the uid the package had been assigned. Also an optional
3161 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3162 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3163 * purpose.
3164 */
3165 public static final String EXTRA_UID = "android.intent.extra.UID";
3166
3167 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003168 * @hide String array of package names.
3169 */
3170 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3171
3172 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003173 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3174 * intents to indicate whether this represents a full uninstall (removing
3175 * both the code and its data) or a partial uninstall (leaving its data,
3176 * implying that this is an update).
3177 */
3178 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003179
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003180 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003181 * @hide
3182 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3183 * intents to indicate that at this point the package has been removed for
3184 * all users on the device.
3185 */
3186 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3187 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3188
3189 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003190 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3191 * intents to indicate that this is a replacement of the package, so this
3192 * broadcast will immediately be followed by an add broadcast for a
3193 * different version of the same package.
3194 */
3195 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003196
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003197 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003198 * Used as an int extra field in {@link android.app.AlarmManager} intents
3199 * to tell the application being invoked how many pending alarms are being
3200 * delievered with the intent. For one-shot alarms this will always be 1.
3201 * For recurring alarms, this might be greater than 1 if the device was
3202 * asleep or powered off at the time an earlier alarm would have been
3203 * delivered.
3204 */
3205 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003206
Jacek Surazski86b6c532009-05-13 14:38:28 +02003207 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003208 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3209 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003210 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3211 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003212 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3213 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3214 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003215 */
3216 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3217
3218 /**
3219 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3220 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003221 */
3222 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3223
3224 /**
3225 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3226 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003227 */
3228 public static final int EXTRA_DOCK_STATE_DESK = 1;
3229
3230 /**
3231 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3232 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003233 */
3234 public static final int EXTRA_DOCK_STATE_CAR = 2;
3235
3236 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003237 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3238 * to represent that the phone is in a analog (low end) dock.
3239 */
3240 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
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 digital (high end) dock.
3245 */
3246 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3247
3248 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003249 * Boolean that can be supplied as meta-data with a dock activity, to
3250 * indicate that the dock should take over the home key when it is active.
3251 */
3252 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003253
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003254 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003255 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3256 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003257 */
3258 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3259
3260 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003261 * Used in the extra field in the remote intent. It's astring token passed with the
3262 * remote intent.
3263 */
3264 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3265 "android.intent.extra.remote_intent_token";
3266
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003267 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003268 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003269 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003270 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003271 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003272 "android.intent.extra.changed_component_name";
3273
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003274 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003275 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003276 * and contains a string array of all of the components that have changed. If
3277 * the state of the overall package has changed, then it will contain an entry
3278 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003279 */
3280 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3281 "android.intent.extra.changed_component_name_list";
3282
3283 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003284 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003285 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3286 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003287 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003288 */
3289 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3290 "android.intent.extra.changed_package_list";
3291
3292 /**
3293 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003294 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3295 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003296 * and contains an integer array of uids of all of the components
3297 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003298 */
3299 public static final String EXTRA_CHANGED_UID_LIST =
3300 "android.intent.extra.changed_uid_list";
3301
3302 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003303 * @hide
3304 * Magic extra system code can use when binding, to give a label for
3305 * who it is that has bound to a service. This is an integer giving
3306 * a framework string resource that can be displayed to the user.
3307 */
3308 public static final String EXTRA_CLIENT_LABEL =
3309 "android.intent.extra.client_label";
3310
3311 /**
3312 * @hide
3313 * Magic extra system code can use when binding, to give a PendingIntent object
3314 * that can be launched for the user to disable the system's use of this
3315 * service.
3316 */
3317 public static final String EXTRA_CLIENT_INTENT =
3318 "android.intent.extra.client_intent";
3319
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003320 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003321 * Extra used to indicate that an intent should only return data that is on
3322 * the local device. This is a boolean extra; the default is false. If true,
3323 * an implementation should only allow the user to select data that is
3324 * already on the device, not requiring it be downloaded from a remote
3325 * service when opened.
3326 *
3327 * @see #ACTION_GET_CONTENT
3328 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003329 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003330 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003331 */
3332 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003333 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003334
Amith Yamasani13593602012-03-22 16:16:17 -07003335 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003336 * Extra used to indicate that an intent can allow the user to select and
3337 * return multiple items. This is a boolean extra; the default is false. If
3338 * true, an implementation is allowed to present the user with a UI where
3339 * they can pick multiple items that are all returned to the caller. When
3340 * this happens, they should be returned as the {@link #getClipData()} part
3341 * of the result Intent.
3342 *
3343 * @see #ACTION_GET_CONTENT
3344 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003345 */
3346 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003347 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003348
3349 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003350 * The integer userHandle carried with broadcast intents related to addition, removal and
3351 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3352 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3353 *
Amith Yamasani13593602012-03-22 16:16:17 -07003354 * @hide
3355 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003356 public static final String EXTRA_USER_HANDLE =
3357 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003358
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003359 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003360 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3361 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3362 */
3363 public static final String EXTRA_USER =
3364 "android.intent.extra.user";
3365
3366 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003367 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003368 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3369 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003370 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003371 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3372
3373 /**
3374 * Extra sent in the intent to the BroadcastReceiver that handles
3375 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3376 * the restrictions as key/value pairs.
3377 */
3378 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3379 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003380
Amith Yamasani86118ba2013-03-28 14:33:16 -07003381 /**
3382 * Extra used in the response from a BroadcastReceiver that handles
3383 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3384 */
3385 public static final String EXTRA_RESTRICTIONS_INTENT =
3386 "android.intent.extra.restrictions_intent";
3387
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003388 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003389 * Extra used to communicate a set of acceptable MIME types. The type of the
3390 * extra is {@code String[]}. Values may be a combination of concrete MIME
3391 * types (such as "image/png") and/or partial MIME types (such as
3392 * "audio/*").
3393 *
3394 * @see #ACTION_GET_CONTENT
3395 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003396 */
3397 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3398
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003399 /**
3400 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3401 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003402 * When this is true, hardware devices can use this information to determine that
3403 * they shouldn't do a complete shutdown of their device since this is not a
3404 * complete shutdown down to the kernel, but only user space restarting.
3405 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003406 */
3407 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3408 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3409
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003410 /**
3411 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3412 * user has set their time format preferences to the 24 hour format.
3413 *
3414 * @hide for internal use only.
3415 */
3416 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3417 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3418
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003419 // ---------------------------------------------------------------------
3420 // ---------------------------------------------------------------------
3421 // Intent flags (see mFlags variable).
3422
Tor Norbyed9273d62013-05-30 15:59:53 -07003423 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003424 @IntDef(flag = true, value = {
3425 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3426 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003427 @Retention(RetentionPolicy.SOURCE)
3428 public @interface GrantUriMode {}
3429
Jeff Sharkey846318a2014-04-04 12:12:41 -07003430 /** @hide */
3431 @IntDef(flag = true, value = {
3432 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3433 @Retention(RetentionPolicy.SOURCE)
3434 public @interface AccessUriMode {}
3435
3436 /**
3437 * Test if given mode flags specify an access mode, which must be at least
3438 * read and/or write.
3439 *
3440 * @hide
3441 */
3442 public static boolean isAccessUriMode(int modeFlags) {
3443 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3444 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3445 }
3446
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003447 /**
3448 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003449 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003450 * specified in its ClipData. When applying to an Intent's ClipData,
3451 * all URIs as well as recursive traversals through data or other ClipData
3452 * in Intent items will be granted; only the grant flags of the top-level
3453 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003454 */
3455 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3456 /**
3457 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003458 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003459 * specified in its ClipData. When applying to an Intent's ClipData,
3460 * all URIs as well as recursive traversals through data or other ClipData
3461 * in Intent items will be granted; only the grant flags of the top-level
3462 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003463 */
3464 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3465 /**
3466 * Can be set by the caller to indicate that this Intent is coming from
3467 * a background operation, not from direct user interaction.
3468 */
3469 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3470 /**
3471 * A flag you can enable for debugging: when set, log messages will be
3472 * printed during the resolution of this intent to show you what has
3473 * been found to create the final resolved list.
3474 */
3475 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003476 /**
3477 * If set, this intent will not match any components in packages that
3478 * are currently stopped. If this is not set, then the default behavior
3479 * is to include such applications in the result.
3480 */
3481 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3482 /**
3483 * If set, this intent will always match any components in packages that
3484 * are currently stopped. This is the default behavior when
3485 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3486 * flags are set, this one wins (it allows overriding of exclude for
3487 * places where the framework may automatically set the exclude flag).
3488 */
3489 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003490
3491 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003492 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003493 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003494 * persisted across device reboots until explicitly revoked with
3495 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3496 * grant for possible persisting; the receiving application must call
3497 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3498 * actually persist.
3499 *
3500 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3501 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3502 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003503 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003504 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003505 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003506
3507 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003508 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3509 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3510 * applies to any URI that is a prefix match against the original granted
3511 * URI. (Without this flag, the URI must match exactly for access to be
3512 * granted.) Another URI is considered a prefix match only when scheme,
3513 * authority, and all path segments defined by the prefix are an exact
3514 * match.
3515 */
3516 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3517
3518 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003519 * If set, the new activity is not kept in the history stack. As soon as
3520 * the user navigates away from it, the activity is finished. This may also
3521 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3522 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003523 */
3524 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3525 /**
3526 * If set, the activity will not be launched if it is already running
3527 * at the top of the history stack.
3528 */
3529 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3530 /**
3531 * If set, this activity will become the start of a new task on this
3532 * history stack. A task (from the activity that started it to the
3533 * next task activity) defines an atomic group of activities that the
3534 * user can move to. Tasks can be moved to the foreground and background;
3535 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003536 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003537 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3538 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003539 *
3540 * <p>This flag is generally used by activities that want
3541 * to present a "launcher" style behavior: they give the user a list of
3542 * separate things that can be done, which otherwise run completely
3543 * independently of the activity launching them.
3544 *
3545 * <p>When using this flag, if a task is already running for the activity
3546 * you are now starting, then a new activity will not be started; instead,
3547 * the current task will simply be brought to the front of the screen with
3548 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3549 * to disable this behavior.
3550 *
3551 * <p>This flag can not be used when the caller is requesting a result from
3552 * the activity being launched.
3553 */
3554 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3555 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003556 * This flag is used to create a new task and launch an activity into it.
3557 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3558 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3559 * search through existing tasks for ones matching this Intent. Only if no such
3560 * task is found would a new task be created. When paired with
3561 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3562 * the search for a matching task and unconditionally start a new task.
3563 *
3564 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3565 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003566 * top-level application launcher.</strong> Used in conjunction with
3567 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3568 * behavior of bringing an existing task to the foreground. When set,
3569 * a new task is <em>always</em> started to host the Activity for the
3570 * Intent, regardless of whether there is already an existing task running
3571 * the same thing.
3572 *
3573 * <p><strong>Because the default system does not include graphical task management,
3574 * you should not use this flag unless you provide some way for a user to
3575 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003576 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003577 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3578 * creating new document tasks.
3579 *
3580 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3581 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003582 *
Scott Main7aee61f2011-02-08 11:25:01 -08003583 * <p>See
3584 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3585 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003586 *
3587 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3588 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003589 */
3590 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3591 /**
3592 * If set, and the activity being launched is already running in the
3593 * current task, then instead of launching a new instance of that activity,
3594 * all of the other activities on top of it will be closed and this Intent
3595 * will be delivered to the (now on top) old activity as a new Intent.
3596 *
3597 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3598 * If D calls startActivity() with an Intent that resolves to the component
3599 * of activity B, then C and D will be finished and B receive the given
3600 * Intent, resulting in the stack now being: A, B.
3601 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003602 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003603 * either receive the new intent you are starting here in its
3604 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003605 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003606 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3607 * the same intent, then it will be finished and re-created; for all other
3608 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3609 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003610 *
3611 * <p>This launch mode can also be used to good effect in conjunction with
3612 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3613 * of a task, it will bring any currently running instance of that task
3614 * to the foreground, and then clear it to its root state. This is
3615 * especially useful, for example, when launching an activity from the
3616 * notification manager.
3617 *
Scott Main7aee61f2011-02-08 11:25:01 -08003618 * <p>See
3619 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3620 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003621 */
3622 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3623 /**
3624 * If set and this intent is being used to launch a new activity from an
3625 * existing one, then the reply target of the existing activity will be
3626 * transfered to the new activity. This way the new activity can call
3627 * {@link android.app.Activity#setResult} and have that result sent back to
3628 * the reply target of the original activity.
3629 */
3630 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3631 /**
3632 * If set and this intent is being used to launch a new activity from an
3633 * existing one, the current activity will not be counted as the top
3634 * activity for deciding whether the new intent should be delivered to
3635 * the top instead of starting a new one. The previous activity will
3636 * be used as the top, with the assumption being that the current activity
3637 * will finish itself immediately.
3638 */
3639 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3640 /**
3641 * If set, the new activity is not kept in the list of recently launched
3642 * activities.
3643 */
3644 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3645 /**
3646 * This flag is not normally set by application code, but set for you by
3647 * the system as described in the
3648 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3649 * launchMode} documentation for the singleTask mode.
3650 */
3651 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3652 /**
3653 * If set, and this activity is either being started in a new task or
3654 * bringing to the top an existing task, then it will be launched as
3655 * the front door of the task. This will result in the application of
3656 * any affinities needed to have that task in the proper state (either
3657 * moving activities to or from it), or simply resetting that task to
3658 * its initial state if needed.
3659 */
3660 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3661 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003662 * This flag is not normally set by application code, but set for you by
3663 * the system if this activity is being launched from history
3664 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003665 */
3666 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003667 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003668 * @deprecated As of API 21 this performs identically to
3669 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003670 */
3671 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003672 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003673 * This flag is used to open a document into a new task rooted at the activity launched
3674 * by this Intent. Through the use of this flag, or its equivalent attribute,
3675 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3676 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003677 *
Craig Mautner026596b2014-05-21 15:35:44 -07003678 * <p>The use of the activity attribute form of this,
3679 * {@link android.R.attr#documentLaunchMode}, is
3680 * preferred over the Intent flag described here. The attribute form allows the
3681 * Activity to specify multiple document behavior for all launchers of the Activity
3682 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003683 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003684 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3685 * it is kept after the activity is finished is different than the use of
3686 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
3687 * this flag is being used to create a new recents entry, then by default that entry
3688 * will be removed once the activity is finished. You can modify this behavior with
3689 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
3690 *
Craig Mautner026596b2014-05-21 15:35:44 -07003691 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3692 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3693 * equivalent of the Activity manifest specifying {@link
3694 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3695 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3696 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003697 *
Craig Mautner026596b2014-05-21 15:35:44 -07003698 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003699 *
Craig Mautner026596b2014-05-21 15:35:44 -07003700 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003701 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3702 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003703 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003704 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003705 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003706 * callback from occurring on the current frontmost activity before it is
3707 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003708 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003709 * <p>Typically, an activity can rely on that callback to indicate that an
3710 * explicit user action has caused their activity to be moved out of the
3711 * foreground. The callback marks an appropriate point in the activity's
3712 * lifecycle for it to dismiss any notifications that it intends to display
3713 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003714 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003715 * <p>If an activity is ever started via any non-user-driven events such as
3716 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3717 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003718 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003719 */
3720 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003721 /**
3722 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3723 * this flag will cause the launched activity to be brought to the front of its
3724 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003725 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003726 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3727 * If D calls startActivity() with an Intent that resolves to the component
3728 * of activity B, then B will be brought to the front of the history stack,
3729 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003730 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003731 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003732 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003733 */
3734 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003735 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003736 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3737 * this flag will prevent the system from applying an activity transition
3738 * animation to go to the next activity state. This doesn't mean an
3739 * animation will never run -- if another activity change happens that doesn't
3740 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003741 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003742 * when you are going to do a series of activity operations but the
3743 * animation seen by the user shouldn't be driven by the first activity
3744 * change but rather a later one.
3745 */
3746 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3747 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003748 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3749 * this flag will cause any existing task that would be associated with the
3750 * activity to be cleared before the activity is started. That is, the activity
3751 * becomes the new root of an otherwise empty task, and any old activities
3752 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3753 */
3754 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3755 /**
3756 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3757 * this flag will cause a newly launching task to be placed on top of the current
3758 * home activity task (if there is one). That is, pressing back from the task
3759 * will always return the user to home even if that was not the last activity they
3760 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3761 */
3762 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3763 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07003764 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
3765 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003766 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07003767 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003768 * this flag. When set and the task's activity is finished, the recents
3769 * entry will remain in the interface for the user to re-launch it, like a
3770 * recents entry for a top-level application.
3771 * <p>
3772 * The receiving activity can override this request with
3773 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
3774 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07003775 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07003776 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07003777 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07003778
3779 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003780 * If set, when sending a broadcast only registered receivers will be
3781 * called -- no BroadcastReceiver components will be launched.
3782 */
3783 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003784 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003785 * If set, when sending a broadcast the new broadcast will replace
3786 * any existing pending broadcast that matches it. Matching is defined
3787 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3788 * true for the intents of the two broadcasts. When a match is found,
3789 * the new broadcast (and receivers associated with it) will replace the
3790 * existing one in the pending broadcast list, remaining at the same
3791 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003792 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003793 * <p>This flag is most typically used with sticky broadcasts, which
3794 * only care about delivering the most recent values of the broadcast
3795 * to their receivers.
3796 */
3797 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3798 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003799 * If set, when sending a broadcast the recipient is allowed to run at
3800 * foreground priority, with a shorter timeout interval. During normal
3801 * broadcasts the receivers are not automatically hoisted out of the
3802 * background priority class.
3803 */
3804 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3805 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003806 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3807 * They can still propagate results through to later receivers, but they can not prevent
3808 * later receivers from seeing the broadcast.
3809 */
3810 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3811 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003812 * If set, when sending a broadcast <i>before boot has completed</i> only
3813 * registered receivers will be called -- no BroadcastReceiver components
3814 * will be launched. Sticky intent state will be recorded properly even
3815 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3816 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003817 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003818 * <p>This flag is only for use by system sevices as a convenience to
3819 * avoid having to implement a more complex mechanism around detection
3820 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003821 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003822 * @hide
3823 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003824 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003825 /**
3826 * Set when this broadcast is for a boot upgrade, a special mode that
3827 * allows the broadcast to be sent before the system is ready and launches
3828 * the app process with no providers running in it.
3829 * @hide
3830 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003831 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003832
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003833 /**
3834 * @hide Flags that can't be changed with PendingIntent.
3835 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003836 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3837 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3838 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003839
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003840 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003841 // ---------------------------------------------------------------------
3842 // toUri() and parseUri() options.
3843
3844 /**
3845 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3846 * always has the "intent:" scheme. This syntax can be used when you want
3847 * to later disambiguate between URIs that are intended to describe an
3848 * Intent vs. all others that should be treated as raw URIs. When used
3849 * with {@link #parseUri}, any other scheme will result in a generic
3850 * VIEW action for that raw URI.
3851 */
3852 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003853
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003854 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003855
3856 private String mAction;
3857 private Uri mData;
3858 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003859 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003860 private ComponentName mComponent;
3861 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003862 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003863 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003864 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003865 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003866 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003867 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003868
3869 // ---------------------------------------------------------------------
3870
3871 /**
3872 * Create an empty intent.
3873 */
3874 public Intent() {
3875 }
3876
3877 /**
3878 * Copy constructor.
3879 */
3880 public Intent(Intent o) {
3881 this.mAction = o.mAction;
3882 this.mData = o.mData;
3883 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003884 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003885 this.mComponent = o.mComponent;
3886 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003887 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003888 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003889 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003890 }
3891 if (o.mExtras != null) {
3892 this.mExtras = new Bundle(o.mExtras);
3893 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003894 if (o.mSourceBounds != null) {
3895 this.mSourceBounds = new Rect(o.mSourceBounds);
3896 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003897 if (o.mSelector != null) {
3898 this.mSelector = new Intent(o.mSelector);
3899 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003900 if (o.mClipData != null) {
3901 this.mClipData = new ClipData(o.mClipData);
3902 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003903 }
3904
3905 @Override
3906 public Object clone() {
3907 return new Intent(this);
3908 }
3909
3910 private Intent(Intent o, boolean all) {
3911 this.mAction = o.mAction;
3912 this.mData = o.mData;
3913 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003914 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003915 this.mComponent = o.mComponent;
3916 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003917 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003918 }
3919 }
3920
3921 /**
3922 * Make a clone of only the parts of the Intent that are relevant for
3923 * filter matching: the action, data, type, component, and categories.
3924 */
3925 public Intent cloneFilter() {
3926 return new Intent(this, false);
3927 }
3928
3929 /**
3930 * Create an intent with a given action. All other fields (data, type,
3931 * class) are null. Note that the action <em>must</em> be in a
3932 * namespace because Intents are used globally in the system -- for
3933 * example the system VIEW action is android.intent.action.VIEW; an
3934 * application's custom action would be something like
3935 * com.google.app.myapp.CUSTOM_ACTION.
3936 *
3937 * @param action The Intent action, such as ACTION_VIEW.
3938 */
3939 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003940 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003941 }
3942
3943 /**
3944 * Create an intent with a given action and for a given data url. Note
3945 * that the action <em>must</em> be in a namespace because Intents are
3946 * used globally in the system -- for example the system VIEW action is
3947 * android.intent.action.VIEW; an application's custom action would be
3948 * something like com.google.app.myapp.CUSTOM_ACTION.
3949 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003950 * <p><em>Note: scheme and host name matching in the Android framework is
3951 * case-sensitive, unlike the formal RFC. As a result,
3952 * you should always ensure that you write your Uri with these elements
3953 * using lower case letters, and normalize any Uris you receive from
3954 * outside of Android to ensure the scheme and host is lower case.</em></p>
3955 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003956 * @param action The Intent action, such as ACTION_VIEW.
3957 * @param uri The Intent data URI.
3958 */
3959 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003960 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003961 mData = uri;
3962 }
3963
3964 /**
3965 * Create an intent for a specific component. All other fields (action, data,
3966 * type, class) are null, though they can be modified later with explicit
3967 * calls. This provides a convenient way to create an intent that is
3968 * intended to execute a hard-coded class name, rather than relying on the
3969 * system to find an appropriate class for you; see {@link #setComponent}
3970 * for more information on the repercussions of this.
3971 *
3972 * @param packageContext A Context of the application package implementing
3973 * this class.
3974 * @param cls The component class that is to be used for the intent.
3975 *
3976 * @see #setClass
3977 * @see #setComponent
3978 * @see #Intent(String, android.net.Uri , Context, Class)
3979 */
3980 public Intent(Context packageContext, Class<?> cls) {
3981 mComponent = new ComponentName(packageContext, cls);
3982 }
3983
3984 /**
3985 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07003986 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003987 * construct the Intent and then calling {@link #setClass} to set its
3988 * class.
3989 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003990 * <p><em>Note: scheme and host name matching in the Android framework is
3991 * case-sensitive, unlike the formal RFC. As a result,
3992 * you should always ensure that you write your Uri with these elements
3993 * using lower case letters, and normalize any Uris you receive from
3994 * outside of Android to ensure the scheme and host is lower case.</em></p>
3995 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003996 * @param action The Intent action, such as ACTION_VIEW.
3997 * @param uri The Intent data URI.
3998 * @param packageContext A Context of the application package implementing
3999 * this class.
4000 * @param cls The component class that is to be used for the intent.
4001 *
4002 * @see #Intent(String, android.net.Uri)
4003 * @see #Intent(Context, Class)
4004 * @see #setClass
4005 * @see #setComponent
4006 */
4007 public Intent(String action, Uri uri,
4008 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004009 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004010 mData = uri;
4011 mComponent = new ComponentName(packageContext, cls);
4012 }
4013
4014 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004015 * Create an intent to launch the main (root) activity of a task. This
4016 * is the Intent that is started when the application's is launched from
4017 * Home. For anything else that wants to launch an application in the
4018 * same way, it is important that they use an Intent structured the same
4019 * way, and can use this function to ensure this is the case.
4020 *
4021 * <p>The returned Intent has the given Activity component as its explicit
4022 * component, {@link #ACTION_MAIN} as its action, and includes the
4023 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4024 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4025 * to do that through {@link #addFlags(int)} on the returned Intent.
4026 *
4027 * @param mainActivity The main activity component that this Intent will
4028 * launch.
4029 * @return Returns a newly created Intent that can be used to launch the
4030 * activity as a main application entry.
4031 *
4032 * @see #setClass
4033 * @see #setComponent
4034 */
4035 public static Intent makeMainActivity(ComponentName mainActivity) {
4036 Intent intent = new Intent(ACTION_MAIN);
4037 intent.setComponent(mainActivity);
4038 intent.addCategory(CATEGORY_LAUNCHER);
4039 return intent;
4040 }
4041
4042 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004043 * Make an Intent for the main activity of an application, without
4044 * specifying a specific activity to run but giving a selector to find
4045 * the activity. This results in a final Intent that is structured
4046 * the same as when the application is launched from
4047 * Home. For anything else that wants to launch an application in the
4048 * same way, it is important that they use an Intent structured the same
4049 * way, and can use this function to ensure this is the case.
4050 *
4051 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4052 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4053 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4054 * to do that through {@link #addFlags(int)} on the returned Intent.
4055 *
4056 * @param selectorAction The action name of the Intent's selector.
4057 * @param selectorCategory The name of a category to add to the Intent's
4058 * selector.
4059 * @return Returns a newly created Intent that can be used to launch the
4060 * activity as a main application entry.
4061 *
4062 * @see #setSelector(Intent)
4063 */
4064 public static Intent makeMainSelectorActivity(String selectorAction,
4065 String selectorCategory) {
4066 Intent intent = new Intent(ACTION_MAIN);
4067 intent.addCategory(CATEGORY_LAUNCHER);
4068 Intent selector = new Intent();
4069 selector.setAction(selectorAction);
4070 selector.addCategory(selectorCategory);
4071 intent.setSelector(selector);
4072 return intent;
4073 }
4074
4075 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004076 * Make an Intent that can be used to re-launch an application's task
4077 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4078 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4079 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4080 *
4081 * @param mainActivity The activity component that is the root of the
4082 * task; this is the activity that has been published in the application's
4083 * manifest as the main launcher icon.
4084 *
4085 * @return Returns a newly created Intent that can be used to relaunch the
4086 * activity's task in its root state.
4087 */
4088 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4089 Intent intent = makeMainActivity(mainActivity);
4090 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4091 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4092 return intent;
4093 }
4094
4095 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004096 * Call {@link #parseUri} with 0 flags.
4097 * @deprecated Use {@link #parseUri} instead.
4098 */
4099 @Deprecated
4100 public static Intent getIntent(String uri) throws URISyntaxException {
4101 return parseUri(uri, 0);
4102 }
Tom Taylord4a47292009-12-21 13:59:18 -08004103
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004104 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004105 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004106 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004107 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004108 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004109 *
4110 * <p>The URI given here must not be relative -- that is, it must include
4111 * the scheme and full path.
4112 *
4113 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004114 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004115 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004116 *
4117 * @return Intent The newly created Intent object.
4118 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004119 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4120 * it bad (as parsed by the Uri class) or the Intent data within the
4121 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004122 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004123 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004124 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004125 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004126 int i = 0;
4127 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004128 // Validate intent scheme for if requested.
4129 if ((flags&URI_INTENT_SCHEME) != 0) {
4130 if (!uri.startsWith("intent:")) {
4131 Intent intent = new Intent(ACTION_VIEW);
4132 try {
4133 intent.setData(Uri.parse(uri));
4134 } catch (IllegalArgumentException e) {
4135 throw new URISyntaxException(uri, e.getMessage());
4136 }
4137 return intent;
4138 }
4139 }
Tom Taylord4a47292009-12-21 13:59:18 -08004140
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004141 // simple case
4142 i = uri.lastIndexOf("#");
4143 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4144
4145 // old format Intent URI
4146 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004147
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004148 // new format
4149 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004150 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004151
4152 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004153 String data = i >= 0 ? uri.substring(0, i) : null;
4154 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004155 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004156
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004157 // loop over contents of Intent, all name=value;
4158 while (!uri.startsWith("end", i)) {
4159 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004160 if (eq < 0) eq = i-1;
4161 int semi = uri.indexOf(';', i);
4162 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004163
4164 // action
4165 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004166 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004167 }
4168
4169 // categories
4170 else if (uri.startsWith("category=", i)) {
4171 intent.addCategory(value);
4172 }
4173
4174 // type
4175 else if (uri.startsWith("type=", i)) {
4176 intent.mType = value;
4177 }
4178
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004179 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004180 else if (uri.startsWith("launchFlags=", i)) {
4181 intent.mFlags = Integer.decode(value).intValue();
4182 }
4183
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004184 // package
4185 else if (uri.startsWith("package=", i)) {
4186 intent.mPackage = value;
4187 }
4188
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004189 // component
4190 else if (uri.startsWith("component=", i)) {
4191 intent.mComponent = ComponentName.unflattenFromString(value);
4192 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004193
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004194 // scheme
4195 else if (uri.startsWith("scheme=", i)) {
4196 scheme = value;
4197 }
4198
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004199 // source bounds
4200 else if (uri.startsWith("sourceBounds=", i)) {
4201 intent.mSourceBounds = Rect.unflattenFromString(value);
4202 }
4203
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004204 // selector
4205 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4206 intent = new Intent();
4207 }
4208
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004209 // extra
4210 else {
4211 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004212 // create Bundle if it doesn't already exist
4213 if (intent.mExtras == null) intent.mExtras = new Bundle();
4214 Bundle b = intent.mExtras;
4215 // add EXTRA
4216 if (uri.startsWith("S.", i)) b.putString(key, value);
4217 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4218 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4219 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4220 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4221 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4222 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4223 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4224 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4225 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4226 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004227
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004228 // move to the next item
4229 i = semi + 1;
4230 }
4231
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004232 if (intent != baseIntent) {
4233 // The Intent had a selector; fix it up.
4234 baseIntent.setSelector(intent);
4235 intent = baseIntent;
4236 }
4237
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004238 if (data != null) {
4239 if (data.startsWith("intent:")) {
4240 data = data.substring(7);
4241 if (scheme != null) {
4242 data = scheme + ':' + data;
4243 }
4244 }
Tom Taylord4a47292009-12-21 13:59:18 -08004245
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004246 if (data.length() > 0) {
4247 try {
4248 intent.mData = Uri.parse(data);
4249 } catch (IllegalArgumentException e) {
4250 throw new URISyntaxException(uri, e.getMessage());
4251 }
4252 }
4253 }
Tom Taylord4a47292009-12-21 13:59:18 -08004254
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004255 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004256
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004257 } catch (IndexOutOfBoundsException e) {
4258 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4259 }
4260 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004261
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004262 public static Intent getIntentOld(String uri) throws URISyntaxException {
4263 Intent intent;
4264
4265 int i = uri.lastIndexOf('#');
4266 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004267 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004268 final int intentFragmentStart = i;
4269 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004270
4271 i++;
4272
4273 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004274 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004275 i += 7;
4276 int j = uri.indexOf(')', i);
4277 action = uri.substring(i, j);
4278 i = j + 1;
4279 }
4280
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004281 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004282
4283 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004284 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004285 i += 11;
4286 int j = uri.indexOf(')', i);
4287 while (i < j) {
4288 int sep = uri.indexOf('!', i);
4289 if (sep < 0) sep = j;
4290 if (i < sep) {
4291 intent.addCategory(uri.substring(i, sep));
4292 }
4293 i = sep + 1;
4294 }
4295 i = j + 1;
4296 }
4297
4298 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004299 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004300 i += 5;
4301 int j = uri.indexOf(')', i);
4302 intent.mType = uri.substring(i, j);
4303 i = j + 1;
4304 }
4305
4306 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004307 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004308 i += 12;
4309 int j = uri.indexOf(')', i);
4310 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4311 i = j + 1;
4312 }
4313
4314 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004315 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004316 i += 10;
4317 int j = uri.indexOf(')', i);
4318 int sep = uri.indexOf('!', i);
4319 if (sep >= 0 && sep < j) {
4320 String pkg = uri.substring(i, sep);
4321 String cls = uri.substring(sep + 1, j);
4322 intent.mComponent = new ComponentName(pkg, cls);
4323 }
4324 i = j + 1;
4325 }
4326
4327 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004328 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004329 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004330
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004331 final int closeParen = uri.indexOf(')', i);
4332 if (closeParen == -1) throw new URISyntaxException(uri,
4333 "EXTRA missing trailing ')'", i);
4334
4335 while (i < closeParen) {
4336 // fetch the key value
4337 int j = uri.indexOf('=', i);
4338 if (j <= i + 1 || i >= closeParen) {
4339 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4340 }
4341 char type = uri.charAt(i);
4342 i++;
4343 String key = uri.substring(i, j);
4344 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004345
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004346 // get type-value
4347 j = uri.indexOf('!', i);
4348 if (j == -1 || j >= closeParen) j = closeParen;
4349 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4350 String value = uri.substring(i, j);
4351 i = j;
4352
4353 // create Bundle if it doesn't already exist
4354 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004355
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004356 // add item to bundle
4357 try {
4358 switch (type) {
4359 case 'S':
4360 intent.mExtras.putString(key, Uri.decode(value));
4361 break;
4362 case 'B':
4363 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4364 break;
4365 case 'b':
4366 intent.mExtras.putByte(key, Byte.parseByte(value));
4367 break;
4368 case 'c':
4369 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4370 break;
4371 case 'd':
4372 intent.mExtras.putDouble(key, Double.parseDouble(value));
4373 break;
4374 case 'f':
4375 intent.mExtras.putFloat(key, Float.parseFloat(value));
4376 break;
4377 case 'i':
4378 intent.mExtras.putInt(key, Integer.parseInt(value));
4379 break;
4380 case 'l':
4381 intent.mExtras.putLong(key, Long.parseLong(value));
4382 break;
4383 case 's':
4384 intent.mExtras.putShort(key, Short.parseShort(value));
4385 break;
4386 default:
4387 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4388 }
4389 } catch (NumberFormatException e) {
4390 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4391 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004392
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004393 char ch = uri.charAt(i);
4394 if (ch == ')') break;
4395 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4396 i++;
4397 }
4398 }
4399
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004400 if (isIntentFragment) {
4401 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4402 } else {
4403 intent.mData = Uri.parse(uri);
4404 }
Tom Taylord4a47292009-12-21 13:59:18 -08004405
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004406 if (intent.mAction == null) {
4407 // By default, if no action is specified, then use VIEW.
4408 intent.mAction = ACTION_VIEW;
4409 }
4410
4411 } else {
4412 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4413 }
4414
4415 return intent;
4416 }
4417
4418 /**
4419 * Retrieve the general action to be performed, such as
4420 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4421 * the information in the intent should be interpreted -- most importantly,
4422 * what to do with the data returned by {@link #getData}.
4423 *
4424 * @return The action of this intent or null if none is specified.
4425 *
4426 * @see #setAction
4427 */
4428 public String getAction() {
4429 return mAction;
4430 }
4431
4432 /**
4433 * Retrieve data this intent is operating on. This URI specifies the name
4434 * of the data; often it uses the content: scheme, specifying data in a
4435 * content provider. Other schemes may be handled by specific activities,
4436 * such as http: by the web browser.
4437 *
4438 * @return The URI of the data this intent is targeting or null.
4439 *
4440 * @see #getScheme
4441 * @see #setData
4442 */
4443 public Uri getData() {
4444 return mData;
4445 }
4446
4447 /**
4448 * The same as {@link #getData()}, but returns the URI as an encoded
4449 * String.
4450 */
4451 public String getDataString() {
4452 return mData != null ? mData.toString() : null;
4453 }
4454
4455 /**
4456 * Return the scheme portion of the intent's data. If the data is null or
4457 * does not include a scheme, null is returned. Otherwise, the scheme
4458 * prefix without the final ':' is returned, i.e. "http".
4459 *
4460 * <p>This is the same as calling getData().getScheme() (and checking for
4461 * null data).
4462 *
4463 * @return The scheme of this intent.
4464 *
4465 * @see #getData
4466 */
4467 public String getScheme() {
4468 return mData != null ? mData.getScheme() : null;
4469 }
4470
4471 /**
4472 * Retrieve any explicit MIME type included in the intent. This is usually
4473 * null, as the type is determined by the intent data.
4474 *
4475 * @return If a type was manually set, it is returned; else null is
4476 * returned.
4477 *
4478 * @see #resolveType(ContentResolver)
4479 * @see #setType
4480 */
4481 public String getType() {
4482 return mType;
4483 }
4484
4485 /**
4486 * Return the MIME data type of this intent. If the type field is
4487 * explicitly set, that is simply returned. Otherwise, if the data is set,
4488 * the type of that data is returned. If neither fields are set, a null is
4489 * returned.
4490 *
4491 * @return The MIME type of this intent.
4492 *
4493 * @see #getType
4494 * @see #resolveType(ContentResolver)
4495 */
4496 public String resolveType(Context context) {
4497 return resolveType(context.getContentResolver());
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 * @param resolver A ContentResolver that can be used to determine the MIME
4507 * type of the intent's data.
4508 *
4509 * @return The MIME type of this intent.
4510 *
4511 * @see #getType
4512 * @see #resolveType(Context)
4513 */
4514 public String resolveType(ContentResolver resolver) {
4515 if (mType != null) {
4516 return mType;
4517 }
4518 if (mData != null) {
4519 if ("content".equals(mData.getScheme())) {
4520 return resolver.getType(mData);
4521 }
4522 }
4523 return null;
4524 }
4525
4526 /**
4527 * Return the MIME data type of this intent, only if it will be needed for
4528 * intent resolution. This is not generally useful for application code;
4529 * it is used by the frameworks for communicating with back-end system
4530 * services.
4531 *
4532 * @param resolver A ContentResolver that can be used to determine the MIME
4533 * type of the intent's data.
4534 *
4535 * @return The MIME type of this intent, or null if it is unknown or not
4536 * needed.
4537 */
4538 public String resolveTypeIfNeeded(ContentResolver resolver) {
4539 if (mComponent != null) {
4540 return mType;
4541 }
4542 return resolveType(resolver);
4543 }
4544
4545 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004546 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004547 *
4548 * @param category The category to check.
4549 *
4550 * @return boolean True if the intent contains the category, else false.
4551 *
4552 * @see #getCategories
4553 * @see #addCategory
4554 */
4555 public boolean hasCategory(String category) {
4556 return mCategories != null && mCategories.contains(category);
4557 }
4558
4559 /**
4560 * Return the set of all categories in the intent. If there are no categories,
4561 * returns NULL.
4562 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004563 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004564 *
4565 * @see #hasCategory
4566 * @see #addCategory
4567 */
4568 public Set<String> getCategories() {
4569 return mCategories;
4570 }
4571
4572 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004573 * Return the specific selector associated with this Intent. If there is
4574 * none, returns null. See {@link #setSelector} for more information.
4575 *
4576 * @see #setSelector
4577 */
4578 public Intent getSelector() {
4579 return mSelector;
4580 }
4581
4582 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004583 * Return the {@link ClipData} associated with this Intent. If there is
4584 * none, returns null. See {@link #setClipData} for more information.
4585 *
John Spurlock125d1332013-11-25 11:58:37 -05004586 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004587 */
4588 public ClipData getClipData() {
4589 return mClipData;
4590 }
4591
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004592 /** @hide */
4593 public int getContentUserHint() {
4594 return mContentUserHint;
4595 }
4596
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004597 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004598 * Sets the ClassLoader that will be used when unmarshalling
4599 * any Parcelable values from the extras of this Intent.
4600 *
4601 * @param loader a ClassLoader, or null to use the default loader
4602 * at the time of unmarshalling.
4603 */
4604 public void setExtrasClassLoader(ClassLoader loader) {
4605 if (mExtras != null) {
4606 mExtras.setClassLoader(loader);
4607 }
4608 }
4609
4610 /**
4611 * Returns true if an extra value is associated with the given name.
4612 * @param name the extra's name
4613 * @return true if the given extra is present.
4614 */
4615 public boolean hasExtra(String name) {
4616 return mExtras != null && mExtras.containsKey(name);
4617 }
4618
4619 /**
4620 * Returns true if the Intent's extras contain a parcelled file descriptor.
4621 * @return true if the Intent contains a parcelled file descriptor.
4622 */
4623 public boolean hasFileDescriptors() {
4624 return mExtras != null && mExtras.hasFileDescriptors();
4625 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004626
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004627 /** @hide */
4628 public void setAllowFds(boolean allowFds) {
4629 if (mExtras != null) {
4630 mExtras.setAllowFds(allowFds);
4631 }
4632 }
4633
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004634 /**
4635 * Retrieve extended data from the intent.
4636 *
4637 * @param name The name of the desired item.
4638 *
4639 * @return the value of an item that previously added with putExtra()
4640 * or null if none was found.
4641 *
4642 * @deprecated
4643 * @hide
4644 */
4645 @Deprecated
4646 public Object getExtra(String name) {
4647 return getExtra(name, null);
4648 }
4649
4650 /**
4651 * Retrieve extended data from the intent.
4652 *
4653 * @param name The name of the desired item.
4654 * @param defaultValue the value to be returned if no value of the desired
4655 * type is stored with the given name.
4656 *
4657 * @return the value of an item that previously added with putExtra()
4658 * or the default value if none was found.
4659 *
4660 * @see #putExtra(String, boolean)
4661 */
4662 public boolean getBooleanExtra(String name, boolean defaultValue) {
4663 return mExtras == null ? defaultValue :
4664 mExtras.getBoolean(name, defaultValue);
4665 }
4666
4667 /**
4668 * Retrieve extended data from the intent.
4669 *
4670 * @param name The name of the desired item.
4671 * @param defaultValue the value to be returned if no value of the desired
4672 * type is stored with the given name.
4673 *
4674 * @return the value of an item that previously added with putExtra()
4675 * or the default value if none was found.
4676 *
4677 * @see #putExtra(String, byte)
4678 */
4679 public byte getByteExtra(String name, byte defaultValue) {
4680 return mExtras == null ? defaultValue :
4681 mExtras.getByte(name, defaultValue);
4682 }
4683
4684 /**
4685 * Retrieve extended data from the intent.
4686 *
4687 * @param name The name of the desired item.
4688 * @param defaultValue the value to be returned if no value of the desired
4689 * type is stored with the given name.
4690 *
4691 * @return the value of an item that previously added with putExtra()
4692 * or the default value if none was found.
4693 *
4694 * @see #putExtra(String, short)
4695 */
4696 public short getShortExtra(String name, short defaultValue) {
4697 return mExtras == null ? defaultValue :
4698 mExtras.getShort(name, defaultValue);
4699 }
4700
4701 /**
4702 * Retrieve extended data from the intent.
4703 *
4704 * @param name The name of the desired item.
4705 * @param defaultValue the value to be returned if no value of the desired
4706 * type is stored with the given name.
4707 *
4708 * @return the value of an item that previously added with putExtra()
4709 * or the default value if none was found.
4710 *
4711 * @see #putExtra(String, char)
4712 */
4713 public char getCharExtra(String name, char defaultValue) {
4714 return mExtras == null ? defaultValue :
4715 mExtras.getChar(name, defaultValue);
4716 }
4717
4718 /**
4719 * Retrieve extended data from the intent.
4720 *
4721 * @param name The name of the desired item.
4722 * @param defaultValue the value to be returned if no value of the desired
4723 * type is stored with the given name.
4724 *
4725 * @return the value of an item that previously added with putExtra()
4726 * or the default value if none was found.
4727 *
4728 * @see #putExtra(String, int)
4729 */
4730 public int getIntExtra(String name, int defaultValue) {
4731 return mExtras == null ? defaultValue :
4732 mExtras.getInt(name, defaultValue);
4733 }
4734
4735 /**
4736 * Retrieve extended data from the intent.
4737 *
4738 * @param name The name of the desired item.
4739 * @param defaultValue the value to be returned if no value of the desired
4740 * type is stored with the given name.
4741 *
4742 * @return the value of an item that previously added with putExtra()
4743 * or the default value if none was found.
4744 *
4745 * @see #putExtra(String, long)
4746 */
4747 public long getLongExtra(String name, long defaultValue) {
4748 return mExtras == null ? defaultValue :
4749 mExtras.getLong(name, defaultValue);
4750 }
4751
4752 /**
4753 * Retrieve extended data from the intent.
4754 *
4755 * @param name The name of the desired item.
4756 * @param defaultValue the value to be returned if no value of the desired
4757 * type is stored with the given name.
4758 *
4759 * @return the value of an item that previously added with putExtra(),
4760 * or the default value if no such item is present
4761 *
4762 * @see #putExtra(String, float)
4763 */
4764 public float getFloatExtra(String name, float defaultValue) {
4765 return mExtras == null ? defaultValue :
4766 mExtras.getFloat(name, defaultValue);
4767 }
4768
4769 /**
4770 * Retrieve extended data from the intent.
4771 *
4772 * @param name The name of the desired item.
4773 * @param defaultValue the value to be returned if no value of the desired
4774 * type is stored with the given name.
4775 *
4776 * @return the value of an item that previously added with putExtra()
4777 * or the default value if none was found.
4778 *
4779 * @see #putExtra(String, double)
4780 */
4781 public double getDoubleExtra(String name, double defaultValue) {
4782 return mExtras == null ? defaultValue :
4783 mExtras.getDouble(name, defaultValue);
4784 }
4785
4786 /**
4787 * Retrieve extended data from the intent.
4788 *
4789 * @param name The name of the desired item.
4790 *
4791 * @return the value of an item that previously added with putExtra()
4792 * or null if no String value was found.
4793 *
4794 * @see #putExtra(String, String)
4795 */
4796 public String getStringExtra(String name) {
4797 return mExtras == null ? null : mExtras.getString(name);
4798 }
4799
4800 /**
4801 * Retrieve extended data from the intent.
4802 *
4803 * @param name The name of the desired item.
4804 *
4805 * @return the value of an item that previously added with putExtra()
4806 * or null if no CharSequence value was found.
4807 *
4808 * @see #putExtra(String, CharSequence)
4809 */
4810 public CharSequence getCharSequenceExtra(String name) {
4811 return mExtras == null ? null : mExtras.getCharSequence(name);
4812 }
4813
4814 /**
4815 * Retrieve extended data from the intent.
4816 *
4817 * @param name The name of the desired item.
4818 *
4819 * @return the value of an item that previously added with putExtra()
4820 * or null if no Parcelable value was found.
4821 *
4822 * @see #putExtra(String, Parcelable)
4823 */
4824 public <T extends Parcelable> T getParcelableExtra(String name) {
4825 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4826 }
4827
4828 /**
4829 * Retrieve extended data from the intent.
4830 *
4831 * @param name The name of the desired item.
4832 *
4833 * @return the value of an item that previously added with putExtra()
4834 * or null if no Parcelable[] value was found.
4835 *
4836 * @see #putExtra(String, Parcelable[])
4837 */
4838 public Parcelable[] getParcelableArrayExtra(String name) {
4839 return mExtras == null ? null : mExtras.getParcelableArray(name);
4840 }
4841
4842 /**
4843 * Retrieve extended data from the intent.
4844 *
4845 * @param name The name of the desired item.
4846 *
4847 * @return the value of an item that previously added with putExtra()
4848 * or null if no ArrayList<Parcelable> value was found.
4849 *
4850 * @see #putParcelableArrayListExtra(String, ArrayList)
4851 */
4852 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4853 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4854 }
4855
4856 /**
4857 * Retrieve extended data from the intent.
4858 *
4859 * @param name The name of the desired item.
4860 *
4861 * @return the value of an item that previously added with putExtra()
4862 * or null if no Serializable value was found.
4863 *
4864 * @see #putExtra(String, Serializable)
4865 */
4866 public Serializable getSerializableExtra(String name) {
4867 return mExtras == null ? null : mExtras.getSerializable(name);
4868 }
4869
4870 /**
4871 * Retrieve extended data from the intent.
4872 *
4873 * @param name The name of the desired item.
4874 *
4875 * @return the value of an item that previously added with putExtra()
4876 * or null if no ArrayList<Integer> value was found.
4877 *
4878 * @see #putIntegerArrayListExtra(String, ArrayList)
4879 */
4880 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4881 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4882 }
4883
4884 /**
4885 * Retrieve extended data from the intent.
4886 *
4887 * @param name The name of the desired item.
4888 *
4889 * @return the value of an item that previously added with putExtra()
4890 * or null if no ArrayList<String> value was found.
4891 *
4892 * @see #putStringArrayListExtra(String, ArrayList)
4893 */
4894 public ArrayList<String> getStringArrayListExtra(String name) {
4895 return mExtras == null ? null : mExtras.getStringArrayList(name);
4896 }
4897
4898 /**
4899 * Retrieve extended data from the intent.
4900 *
4901 * @param name The name of the desired item.
4902 *
4903 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004904 * or null if no ArrayList<CharSequence> value was found.
4905 *
4906 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4907 */
4908 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4909 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4910 }
4911
4912 /**
4913 * Retrieve extended data from the intent.
4914 *
4915 * @param name The name of the desired item.
4916 *
4917 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004918 * or null if no boolean array value was found.
4919 *
4920 * @see #putExtra(String, boolean[])
4921 */
4922 public boolean[] getBooleanArrayExtra(String name) {
4923 return mExtras == null ? null : mExtras.getBooleanArray(name);
4924 }
4925
4926 /**
4927 * Retrieve extended data from the intent.
4928 *
4929 * @param name The name of the desired item.
4930 *
4931 * @return the value of an item that previously added with putExtra()
4932 * or null if no byte array value was found.
4933 *
4934 * @see #putExtra(String, byte[])
4935 */
4936 public byte[] getByteArrayExtra(String name) {
4937 return mExtras == null ? null : mExtras.getByteArray(name);
4938 }
4939
4940 /**
4941 * Retrieve extended data from the intent.
4942 *
4943 * @param name The name of the desired item.
4944 *
4945 * @return the value of an item that previously added with putExtra()
4946 * or null if no short array value was found.
4947 *
4948 * @see #putExtra(String, short[])
4949 */
4950 public short[] getShortArrayExtra(String name) {
4951 return mExtras == null ? null : mExtras.getShortArray(name);
4952 }
4953
4954 /**
4955 * Retrieve extended data from the intent.
4956 *
4957 * @param name The name of the desired item.
4958 *
4959 * @return the value of an item that previously added with putExtra()
4960 * or null if no char array value was found.
4961 *
4962 * @see #putExtra(String, char[])
4963 */
4964 public char[] getCharArrayExtra(String name) {
4965 return mExtras == null ? null : mExtras.getCharArray(name);
4966 }
4967
4968 /**
4969 * Retrieve extended data from the intent.
4970 *
4971 * @param name The name of the desired item.
4972 *
4973 * @return the value of an item that previously added with putExtra()
4974 * or null if no int array value was found.
4975 *
4976 * @see #putExtra(String, int[])
4977 */
4978 public int[] getIntArrayExtra(String name) {
4979 return mExtras == null ? null : mExtras.getIntArray(name);
4980 }
4981
4982 /**
4983 * Retrieve extended data from the intent.
4984 *
4985 * @param name The name of the desired item.
4986 *
4987 * @return the value of an item that previously added with putExtra()
4988 * or null if no long array value was found.
4989 *
4990 * @see #putExtra(String, long[])
4991 */
4992 public long[] getLongArrayExtra(String name) {
4993 return mExtras == null ? null : mExtras.getLongArray(name);
4994 }
4995
4996 /**
4997 * Retrieve extended data from the intent.
4998 *
4999 * @param name The name of the desired item.
5000 *
5001 * @return the value of an item that previously added with putExtra()
5002 * or null if no float array value was found.
5003 *
5004 * @see #putExtra(String, float[])
5005 */
5006 public float[] getFloatArrayExtra(String name) {
5007 return mExtras == null ? null : mExtras.getFloatArray(name);
5008 }
5009
5010 /**
5011 * Retrieve extended data from the intent.
5012 *
5013 * @param name The name of the desired item.
5014 *
5015 * @return the value of an item that previously added with putExtra()
5016 * or null if no double array value was found.
5017 *
5018 * @see #putExtra(String, double[])
5019 */
5020 public double[] getDoubleArrayExtra(String name) {
5021 return mExtras == null ? null : mExtras.getDoubleArray(name);
5022 }
5023
5024 /**
5025 * Retrieve extended data from the intent.
5026 *
5027 * @param name The name of the desired item.
5028 *
5029 * @return the value of an item that previously added with putExtra()
5030 * or null if no String array value was found.
5031 *
5032 * @see #putExtra(String, String[])
5033 */
5034 public String[] getStringArrayExtra(String name) {
5035 return mExtras == null ? null : mExtras.getStringArray(name);
5036 }
5037
5038 /**
5039 * Retrieve extended data from the intent.
5040 *
5041 * @param name The name of the desired item.
5042 *
5043 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005044 * or null if no CharSequence array value was found.
5045 *
5046 * @see #putExtra(String, CharSequence[])
5047 */
5048 public CharSequence[] getCharSequenceArrayExtra(String name) {
5049 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5050 }
5051
5052 /**
5053 * Retrieve extended data from the intent.
5054 *
5055 * @param name The name of the desired item.
5056 *
5057 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005058 * or null if no Bundle value was found.
5059 *
5060 * @see #putExtra(String, Bundle)
5061 */
5062 public Bundle getBundleExtra(String name) {
5063 return mExtras == null ? null : mExtras.getBundle(name);
5064 }
5065
5066 /**
5067 * Retrieve extended data from the intent.
5068 *
5069 * @param name The name of the desired item.
5070 *
5071 * @return the value of an item that previously added with putExtra()
5072 * or null if no IBinder value was found.
5073 *
5074 * @see #putExtra(String, IBinder)
5075 *
5076 * @deprecated
5077 * @hide
5078 */
5079 @Deprecated
5080 public IBinder getIBinderExtra(String name) {
5081 return mExtras == null ? null : mExtras.getIBinder(name);
5082 }
5083
5084 /**
5085 * Retrieve extended data from the intent.
5086 *
5087 * @param name The name of the desired item.
5088 * @param defaultValue The default value to return in case no item is
5089 * associated with the key 'name'
5090 *
5091 * @return the value of an item that previously added with putExtra()
5092 * or defaultValue if none was found.
5093 *
5094 * @see #putExtra
5095 *
5096 * @deprecated
5097 * @hide
5098 */
5099 @Deprecated
5100 public Object getExtra(String name, Object defaultValue) {
5101 Object result = defaultValue;
5102 if (mExtras != null) {
5103 Object result2 = mExtras.get(name);
5104 if (result2 != null) {
5105 result = result2;
5106 }
5107 }
5108
5109 return result;
5110 }
5111
5112 /**
5113 * Retrieves a map of extended data from the intent.
5114 *
5115 * @return the map of all extras previously added with putExtra(),
5116 * or null if none have been added.
5117 */
5118 public Bundle getExtras() {
5119 return (mExtras != null)
5120 ? new Bundle(mExtras)
5121 : null;
5122 }
5123
5124 /**
5125 * Retrieve any special flags associated with this intent. You will
5126 * normally just set them with {@link #setFlags} and let the system
5127 * take the appropriate action with them.
5128 *
5129 * @return int The currently set flags.
5130 *
5131 * @see #setFlags
5132 */
5133 public int getFlags() {
5134 return mFlags;
5135 }
5136
Dianne Hackborne7f97212011-02-24 14:40:20 -08005137 /** @hide */
5138 public boolean isExcludingStopped() {
5139 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5140 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5141 }
5142
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005143 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005144 * Retrieve the application package name this Intent is limited to. When
5145 * resolving an Intent, if non-null this limits the resolution to only
5146 * components in the given application package.
5147 *
5148 * @return The name of the application package for the Intent.
5149 *
5150 * @see #resolveActivity
5151 * @see #setPackage
5152 */
5153 public String getPackage() {
5154 return mPackage;
5155 }
5156
5157 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005158 * Retrieve the concrete component associated with the intent. When receiving
5159 * an intent, this is the component that was found to best handle it (that is,
5160 * yourself) and will always be non-null; in all other cases it will be
5161 * null unless explicitly set.
5162 *
5163 * @return The name of the application component to handle the intent.
5164 *
5165 * @see #resolveActivity
5166 * @see #setComponent
5167 */
5168 public ComponentName getComponent() {
5169 return mComponent;
5170 }
5171
5172 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005173 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5174 * used as a hint to the receiver for animations and the like. Null means that there
5175 * is no source bounds.
5176 */
5177 public Rect getSourceBounds() {
5178 return mSourceBounds;
5179 }
5180
5181 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005182 * Return the Activity component that should be used to handle this intent.
5183 * The appropriate component is determined based on the information in the
5184 * intent, evaluated as follows:
5185 *
5186 * <p>If {@link #getComponent} returns an explicit class, that is returned
5187 * without any further consideration.
5188 *
5189 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5190 * category to be considered.
5191 *
5192 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5193 * action.
5194 *
5195 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5196 * this type.
5197 *
5198 * <p>If {@link #addCategory} has added any categories, the activity must
5199 * handle ALL of the categories specified.
5200 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005201 * <p>If {@link #getPackage} is non-NULL, only activity components in
5202 * that application package will be considered.
5203 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005204 * <p>If there are no activities that satisfy all of these conditions, a
5205 * null string is returned.
5206 *
5207 * <p>If multiple activities are found to satisfy the intent, the one with
5208 * the highest priority will be used. If there are multiple activities
5209 * with the same priority, the system will either pick the best activity
5210 * based on user preference, or resolve to a system class that will allow
5211 * the user to pick an activity and forward from there.
5212 *
5213 * <p>This method is implemented simply by calling
5214 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5215 * true.</p>
5216 * <p> This API is called for you as part of starting an activity from an
5217 * intent. You do not normally need to call it yourself.</p>
5218 *
5219 * @param pm The package manager with which to resolve the Intent.
5220 *
5221 * @return Name of the component implementing an activity that can
5222 * display the intent.
5223 *
5224 * @see #setComponent
5225 * @see #getComponent
5226 * @see #resolveActivityInfo
5227 */
5228 public ComponentName resolveActivity(PackageManager pm) {
5229 if (mComponent != null) {
5230 return mComponent;
5231 }
5232
5233 ResolveInfo info = pm.resolveActivity(
5234 this, PackageManager.MATCH_DEFAULT_ONLY);
5235 if (info != null) {
5236 return new ComponentName(
5237 info.activityInfo.applicationInfo.packageName,
5238 info.activityInfo.name);
5239 }
5240
5241 return null;
5242 }
5243
5244 /**
5245 * Resolve the Intent into an {@link ActivityInfo}
5246 * describing the activity that should execute the intent. Resolution
5247 * follows the same rules as described for {@link #resolveActivity}, but
5248 * you get back the completely information about the resolved activity
5249 * instead of just its class name.
5250 *
5251 * @param pm The package manager with which to resolve the Intent.
5252 * @param flags Addition information to retrieve as per
5253 * {@link PackageManager#getActivityInfo(ComponentName, int)
5254 * PackageManager.getActivityInfo()}.
5255 *
5256 * @return PackageManager.ActivityInfo
5257 *
5258 * @see #resolveActivity
5259 */
5260 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5261 ActivityInfo ai = null;
5262 if (mComponent != null) {
5263 try {
5264 ai = pm.getActivityInfo(mComponent, flags);
5265 } catch (PackageManager.NameNotFoundException e) {
5266 // ignore
5267 }
5268 } else {
5269 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005270 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005271 if (info != null) {
5272 ai = info.activityInfo;
5273 }
5274 }
5275
5276 return ai;
5277 }
5278
5279 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005280 * Special function for use by the system to resolve service
5281 * intents to system apps. Throws an exception if there are
5282 * multiple potential matches to the Intent. Returns null if
5283 * there are no matches.
5284 * @hide
5285 */
5286 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5287 if (mComponent != null) {
5288 return mComponent;
5289 }
5290
5291 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5292 if (results == null) {
5293 return null;
5294 }
5295 ComponentName comp = null;
5296 for (int i=0; i<results.size(); i++) {
5297 ResolveInfo ri = results.get(i);
5298 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5299 continue;
5300 }
5301 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5302 ri.serviceInfo.name);
5303 if (comp != null) {
5304 throw new IllegalStateException("Multiple system services handle " + this
5305 + ": " + comp + ", " + foundComp);
5306 }
5307 comp = foundComp;
5308 }
5309 return comp;
5310 }
5311
5312 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005313 * Set the general action to be performed.
5314 *
5315 * @param action An action name, such as ACTION_VIEW. Application-specific
5316 * actions should be prefixed with the vendor's package name.
5317 *
5318 * @return Returns the same Intent object, for chaining multiple calls
5319 * into a single statement.
5320 *
5321 * @see #getAction
5322 */
5323 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005324 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005325 return this;
5326 }
5327
5328 /**
5329 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005330 * clears any type that was previously set by {@link #setType} or
5331 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005332 *
Nick Pellyccae4122012-01-09 14:12:58 -08005333 * <p><em>Note: scheme matching in the Android framework is
5334 * case-sensitive, unlike the formal RFC. As a result,
5335 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005336 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005337 * {@link #setDataAndNormalize}
5338 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005339 *
Nick Pellyccae4122012-01-09 14:12:58 -08005340 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005341 *
5342 * @return Returns the same Intent object, for chaining multiple calls
5343 * into a single statement.
5344 *
5345 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005346 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005347 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005348 */
5349 public Intent setData(Uri data) {
5350 mData = data;
5351 mType = null;
5352 return this;
5353 }
5354
5355 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005356 * Normalize and set the data this intent is operating on.
5357 *
5358 * <p>This method automatically clears any type that was
5359 * previously set (for example, by {@link #setType}).
5360 *
5361 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005362 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005363 * so really this is just a convenience method for
5364 * <pre>
5365 * setData(data.normalize())
5366 * </pre>
5367 *
5368 * @param data The Uri of the data this intent is now targeting.
5369 *
5370 * @return Returns the same Intent object, for chaining multiple calls
5371 * into a single statement.
5372 *
5373 * @see #getData
5374 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005375 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005376 */
5377 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005378 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005379 }
5380
5381 /**
5382 * Set an explicit MIME data type.
5383 *
5384 * <p>This is used to create intents that only specify a type and not data,
5385 * for example to indicate the type of data to return.
5386 *
5387 * <p>This method automatically clears any data that was
5388 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005389 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005390 * <p><em>Note: MIME type matching in the Android framework is
5391 * case-sensitive, unlike formal RFC MIME types. As a result,
5392 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005393 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5394 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005395 *
5396 * @param type The MIME type of the data being handled by this intent.
5397 *
5398 * @return Returns the same Intent object, for chaining multiple calls
5399 * into a single statement.
5400 *
5401 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005402 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005403 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005404 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005405 */
5406 public Intent setType(String type) {
5407 mData = null;
5408 mType = type;
5409 return this;
5410 }
5411
5412 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005413 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005414 *
Nick Pellyccae4122012-01-09 14:12:58 -08005415 * <p>This is used to create intents that only specify a type and not data,
5416 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005417 *
Nick Pellyccae4122012-01-09 14:12:58 -08005418 * <p>This method automatically clears any data that was
5419 * previously set (for example by {@link #setData}).
5420 *
5421 * <p>The MIME type is normalized using
5422 * {@link #normalizeMimeType} before it is set,
5423 * so really this is just a convenience method for
5424 * <pre>
5425 * setType(Intent.normalizeMimeType(type))
5426 * </pre>
5427 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005428 * @param type The MIME type of the data being handled by this intent.
5429 *
5430 * @return Returns the same Intent object, for chaining multiple calls
5431 * into a single statement.
5432 *
Nick Pellyccae4122012-01-09 14:12:58 -08005433 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005434 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005435 * @see #normalizeMimeType
5436 */
5437 public Intent setTypeAndNormalize(String type) {
5438 return setType(normalizeMimeType(type));
5439 }
5440
5441 /**
5442 * (Usually optional) Set the data for the intent along with an explicit
5443 * MIME data type. This method should very rarely be used -- it allows you
5444 * to override the MIME type that would ordinarily be inferred from the
5445 * data with your own type given here.
5446 *
5447 * <p><em>Note: MIME type and Uri scheme matching in the
5448 * Android framework is case-sensitive, unlike the formal RFC definitions.
5449 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005450 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005451 * {@link #setDataAndTypeAndNormalize}
5452 * to ensure that they are converted to lower case.</em>
5453 *
5454 * @param data The Uri of the data this intent is now targeting.
5455 * @param type The MIME type of the data being handled by this intent.
5456 *
5457 * @return Returns the same Intent object, for chaining multiple calls
5458 * into a single statement.
5459 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005460 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005461 * @see #setData
5462 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005463 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005464 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005465 */
5466 public Intent setDataAndType(Uri data, String type) {
5467 mData = data;
5468 mType = type;
5469 return this;
5470 }
5471
5472 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005473 * (Usually optional) Normalize and set both the data Uri and an explicit
5474 * MIME data type. This method should very rarely be used -- it allows you
5475 * to override the MIME type that would ordinarily be inferred from the
5476 * data with your own type given here.
5477 *
5478 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005479 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005480 * before they are set, so really this is just a convenience method for
5481 * <pre>
5482 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5483 * </pre>
5484 *
5485 * @param data The Uri of the data this intent is now targeting.
5486 * @param type The MIME type of the data being handled by this intent.
5487 *
5488 * @return Returns the same Intent object, for chaining multiple calls
5489 * into a single statement.
5490 *
5491 * @see #setType
5492 * @see #setData
5493 * @see #setDataAndType
5494 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005495 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005496 */
5497 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005498 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005499 }
5500
5501 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005502 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005503 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005504 * activities that provide <em>all</em> of the requested categories will be
5505 * used.
5506 *
5507 * @param category The desired category. This can be either one of the
5508 * predefined Intent categories, or a custom category in your own
5509 * namespace.
5510 *
5511 * @return Returns the same Intent object, for chaining multiple calls
5512 * into a single statement.
5513 *
5514 * @see #hasCategory
5515 * @see #removeCategory
5516 */
5517 public Intent addCategory(String category) {
5518 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005519 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005520 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005521 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005522 return this;
5523 }
5524
5525 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005526 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005527 *
5528 * @param category The category to remove.
5529 *
5530 * @see #addCategory
5531 */
5532 public void removeCategory(String category) {
5533 if (mCategories != null) {
5534 mCategories.remove(category);
5535 if (mCategories.size() == 0) {
5536 mCategories = null;
5537 }
5538 }
5539 }
5540
5541 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005542 * Set a selector for this Intent. This is a modification to the kinds of
5543 * things the Intent will match. If the selector is set, it will be used
5544 * when trying to find entities that can handle the Intent, instead of the
5545 * main contents of the Intent. This allows you build an Intent containing
5546 * a generic protocol while targeting it more specifically.
5547 *
5548 * <p>An example of where this may be used is with things like
5549 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5550 * Intent that will launch the Browser application. However, the correct
5551 * main entry point of an application is actually {@link #ACTION_MAIN}
5552 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5553 * used to specify the actual Activity to launch. If you launch the browser
5554 * with something different, undesired behavior may happen if the user has
5555 * previously or later launches it the normal way, since they do not match.
5556 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5557 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5558 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5559 *
5560 * <p>Setting a selector does not impact the behavior of
5561 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5562 * desired behavior of a selector -- it does not impact the base meaning
5563 * of the Intent, just what kinds of things will be matched against it
5564 * when determining who can handle it.</p>
5565 *
5566 * <p>You can not use both a selector and {@link #setPackage(String)} on
5567 * the same base Intent.</p>
5568 *
5569 * @param selector The desired selector Intent; set to null to not use
5570 * a special selector.
5571 */
5572 public void setSelector(Intent selector) {
5573 if (selector == this) {
5574 throw new IllegalArgumentException(
5575 "Intent being set as a selector of itself");
5576 }
5577 if (selector != null && mPackage != null) {
5578 throw new IllegalArgumentException(
5579 "Can't set selector when package name is already set");
5580 }
5581 mSelector = selector;
5582 }
5583
5584 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005585 * Set a {@link ClipData} associated with this Intent. This replaces any
5586 * previously set ClipData.
5587 *
5588 * <p>The ClipData in an intent is not used for Intent matching or other
5589 * such operations. Semantically it is like extras, used to transmit
5590 * additional data with the Intent. The main feature of using this over
5591 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5592 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5593 * items included in the clip data. This is useful, in particular, if
5594 * you want to transmit an Intent containing multiple <code>content:</code>
5595 * URIs for which the recipient may not have global permission to access the
5596 * content provider.
5597 *
5598 * <p>If the ClipData contains items that are themselves Intents, any
5599 * grant flags in those Intents will be ignored. Only the top-level flags
5600 * of the main Intent are respected, and will be applied to all Uri or
5601 * Intent items in the clip (or sub-items of the clip).
5602 *
5603 * <p>The MIME type, label, and icon in the ClipData object are not
5604 * directly used by Intent. Applications should generally rely on the
5605 * MIME type of the Intent itself, not what it may find in the ClipData.
5606 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005607 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005608 *
5609 * @param clip The new clip to set. May be null to clear the current clip.
5610 */
5611 public void setClipData(ClipData clip) {
5612 mClipData = clip;
5613 }
5614
5615 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005616 * This is NOT a secure mechanism to identify the user who sent the intent.
5617 * When the intent is sent to a different user, it is used to fix uris by adding the userId
5618 * who sent the intent.
5619 * @hide
5620 */
5621 public void setContentUserHint(int contentUserHint) {
5622 mContentUserHint = contentUserHint;
5623 }
5624
5625 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005626 * Add extended data to the intent. The name must include a package
5627 * prefix, for example the app com.android.contacts would use names
5628 * like "com.android.contacts.ShowAll".
5629 *
5630 * @param name The name of the extra data, with package prefix.
5631 * @param value The boolean data value.
5632 *
5633 * @return Returns the same Intent object, for chaining multiple calls
5634 * into a single statement.
5635 *
5636 * @see #putExtras
5637 * @see #removeExtra
5638 * @see #getBooleanExtra(String, boolean)
5639 */
5640 public Intent putExtra(String name, boolean value) {
5641 if (mExtras == null) {
5642 mExtras = new Bundle();
5643 }
5644 mExtras.putBoolean(name, value);
5645 return this;
5646 }
5647
5648 /**
5649 * Add extended data to the intent. The name must include a package
5650 * prefix, for example the app com.android.contacts would use names
5651 * like "com.android.contacts.ShowAll".
5652 *
5653 * @param name The name of the extra data, with package prefix.
5654 * @param value The byte data value.
5655 *
5656 * @return Returns the same Intent object, for chaining multiple calls
5657 * into a single statement.
5658 *
5659 * @see #putExtras
5660 * @see #removeExtra
5661 * @see #getByteExtra(String, byte)
5662 */
5663 public Intent putExtra(String name, byte value) {
5664 if (mExtras == null) {
5665 mExtras = new Bundle();
5666 }
5667 mExtras.putByte(name, value);
5668 return this;
5669 }
5670
5671 /**
5672 * Add extended data to the intent. The name must include a package
5673 * prefix, for example the app com.android.contacts would use names
5674 * like "com.android.contacts.ShowAll".
5675 *
5676 * @param name The name of the extra data, with package prefix.
5677 * @param value The char data value.
5678 *
5679 * @return Returns the same Intent object, for chaining multiple calls
5680 * into a single statement.
5681 *
5682 * @see #putExtras
5683 * @see #removeExtra
5684 * @see #getCharExtra(String, char)
5685 */
5686 public Intent putExtra(String name, char value) {
5687 if (mExtras == null) {
5688 mExtras = new Bundle();
5689 }
5690 mExtras.putChar(name, value);
5691 return this;
5692 }
5693
5694 /**
5695 * Add extended data to the intent. The name must include a package
5696 * prefix, for example the app com.android.contacts would use names
5697 * like "com.android.contacts.ShowAll".
5698 *
5699 * @param name The name of the extra data, with package prefix.
5700 * @param value The short data value.
5701 *
5702 * @return Returns the same Intent object, for chaining multiple calls
5703 * into a single statement.
5704 *
5705 * @see #putExtras
5706 * @see #removeExtra
5707 * @see #getShortExtra(String, short)
5708 */
5709 public Intent putExtra(String name, short value) {
5710 if (mExtras == null) {
5711 mExtras = new Bundle();
5712 }
5713 mExtras.putShort(name, value);
5714 return this;
5715 }
5716
5717 /**
5718 * Add extended data to the intent. The name must include a package
5719 * prefix, for example the app com.android.contacts would use names
5720 * like "com.android.contacts.ShowAll".
5721 *
5722 * @param name The name of the extra data, with package prefix.
5723 * @param value The integer data value.
5724 *
5725 * @return Returns the same Intent object, for chaining multiple calls
5726 * into a single statement.
5727 *
5728 * @see #putExtras
5729 * @see #removeExtra
5730 * @see #getIntExtra(String, int)
5731 */
5732 public Intent putExtra(String name, int value) {
5733 if (mExtras == null) {
5734 mExtras = new Bundle();
5735 }
5736 mExtras.putInt(name, value);
5737 return this;
5738 }
5739
5740 /**
5741 * Add extended data to the intent. The name must include a package
5742 * prefix, for example the app com.android.contacts would use names
5743 * like "com.android.contacts.ShowAll".
5744 *
5745 * @param name The name of the extra data, with package prefix.
5746 * @param value The long data value.
5747 *
5748 * @return Returns the same Intent object, for chaining multiple calls
5749 * into a single statement.
5750 *
5751 * @see #putExtras
5752 * @see #removeExtra
5753 * @see #getLongExtra(String, long)
5754 */
5755 public Intent putExtra(String name, long value) {
5756 if (mExtras == null) {
5757 mExtras = new Bundle();
5758 }
5759 mExtras.putLong(name, value);
5760 return this;
5761 }
5762
5763 /**
5764 * Add extended data to the intent. The name must include a package
5765 * prefix, for example the app com.android.contacts would use names
5766 * like "com.android.contacts.ShowAll".
5767 *
5768 * @param name The name of the extra data, with package prefix.
5769 * @param value The float data value.
5770 *
5771 * @return Returns the same Intent object, for chaining multiple calls
5772 * into a single statement.
5773 *
5774 * @see #putExtras
5775 * @see #removeExtra
5776 * @see #getFloatExtra(String, float)
5777 */
5778 public Intent putExtra(String name, float value) {
5779 if (mExtras == null) {
5780 mExtras = new Bundle();
5781 }
5782 mExtras.putFloat(name, value);
5783 return this;
5784 }
5785
5786 /**
5787 * Add extended data to the intent. The name must include a package
5788 * prefix, for example the app com.android.contacts would use names
5789 * like "com.android.contacts.ShowAll".
5790 *
5791 * @param name The name of the extra data, with package prefix.
5792 * @param value The double data value.
5793 *
5794 * @return Returns the same Intent object, for chaining multiple calls
5795 * into a single statement.
5796 *
5797 * @see #putExtras
5798 * @see #removeExtra
5799 * @see #getDoubleExtra(String, double)
5800 */
5801 public Intent putExtra(String name, double value) {
5802 if (mExtras == null) {
5803 mExtras = new Bundle();
5804 }
5805 mExtras.putDouble(name, value);
5806 return this;
5807 }
5808
5809 /**
5810 * Add extended data to the intent. The name must include a package
5811 * prefix, for example the app com.android.contacts would use names
5812 * like "com.android.contacts.ShowAll".
5813 *
5814 * @param name The name of the extra data, with package prefix.
5815 * @param value The String data value.
5816 *
5817 * @return Returns the same Intent object, for chaining multiple calls
5818 * into a single statement.
5819 *
5820 * @see #putExtras
5821 * @see #removeExtra
5822 * @see #getStringExtra(String)
5823 */
5824 public Intent putExtra(String name, String value) {
5825 if (mExtras == null) {
5826 mExtras = new Bundle();
5827 }
5828 mExtras.putString(name, value);
5829 return this;
5830 }
5831
5832 /**
5833 * Add extended data to the intent. The name must include a package
5834 * prefix, for example the app com.android.contacts would use names
5835 * like "com.android.contacts.ShowAll".
5836 *
5837 * @param name The name of the extra data, with package prefix.
5838 * @param value The CharSequence data value.
5839 *
5840 * @return Returns the same Intent object, for chaining multiple calls
5841 * into a single statement.
5842 *
5843 * @see #putExtras
5844 * @see #removeExtra
5845 * @see #getCharSequenceExtra(String)
5846 */
5847 public Intent putExtra(String name, CharSequence value) {
5848 if (mExtras == null) {
5849 mExtras = new Bundle();
5850 }
5851 mExtras.putCharSequence(name, value);
5852 return this;
5853 }
5854
5855 /**
5856 * Add extended data to the intent. The name must include a package
5857 * prefix, for example the app com.android.contacts would use names
5858 * like "com.android.contacts.ShowAll".
5859 *
5860 * @param name The name of the extra data, with package prefix.
5861 * @param value The Parcelable data value.
5862 *
5863 * @return Returns the same Intent object, for chaining multiple calls
5864 * into a single statement.
5865 *
5866 * @see #putExtras
5867 * @see #removeExtra
5868 * @see #getParcelableExtra(String)
5869 */
5870 public Intent putExtra(String name, Parcelable value) {
5871 if (mExtras == null) {
5872 mExtras = new Bundle();
5873 }
5874 mExtras.putParcelable(name, value);
5875 return this;
5876 }
5877
5878 /**
5879 * Add extended data to the intent. The name must include a package
5880 * prefix, for example the app com.android.contacts would use names
5881 * like "com.android.contacts.ShowAll".
5882 *
5883 * @param name The name of the extra data, with package prefix.
5884 * @param value The Parcelable[] data value.
5885 *
5886 * @return Returns the same Intent object, for chaining multiple calls
5887 * into a single statement.
5888 *
5889 * @see #putExtras
5890 * @see #removeExtra
5891 * @see #getParcelableArrayExtra(String)
5892 */
5893 public Intent putExtra(String name, Parcelable[] value) {
5894 if (mExtras == null) {
5895 mExtras = new Bundle();
5896 }
5897 mExtras.putParcelableArray(name, value);
5898 return this;
5899 }
5900
5901 /**
5902 * Add extended data to the intent. The name must include a package
5903 * prefix, for example the app com.android.contacts would use names
5904 * like "com.android.contacts.ShowAll".
5905 *
5906 * @param name The name of the extra data, with package prefix.
5907 * @param value The ArrayList<Parcelable> data value.
5908 *
5909 * @return Returns the same Intent object, for chaining multiple calls
5910 * into a single statement.
5911 *
5912 * @see #putExtras
5913 * @see #removeExtra
5914 * @see #getParcelableArrayListExtra(String)
5915 */
5916 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5917 if (mExtras == null) {
5918 mExtras = new Bundle();
5919 }
5920 mExtras.putParcelableArrayList(name, value);
5921 return this;
5922 }
5923
5924 /**
5925 * Add extended data to the intent. The name must include a package
5926 * prefix, for example the app com.android.contacts would use names
5927 * like "com.android.contacts.ShowAll".
5928 *
5929 * @param name The name of the extra data, with package prefix.
5930 * @param value The ArrayList<Integer> data value.
5931 *
5932 * @return Returns the same Intent object, for chaining multiple calls
5933 * into a single statement.
5934 *
5935 * @see #putExtras
5936 * @see #removeExtra
5937 * @see #getIntegerArrayListExtra(String)
5938 */
5939 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5940 if (mExtras == null) {
5941 mExtras = new Bundle();
5942 }
5943 mExtras.putIntegerArrayList(name, value);
5944 return this;
5945 }
5946
5947 /**
5948 * Add extended data to the intent. The name must include a package
5949 * prefix, for example the app com.android.contacts would use names
5950 * like "com.android.contacts.ShowAll".
5951 *
5952 * @param name The name of the extra data, with package prefix.
5953 * @param value The ArrayList<String> data value.
5954 *
5955 * @return Returns the same Intent object, for chaining multiple calls
5956 * into a single statement.
5957 *
5958 * @see #putExtras
5959 * @see #removeExtra
5960 * @see #getStringArrayListExtra(String)
5961 */
5962 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5963 if (mExtras == null) {
5964 mExtras = new Bundle();
5965 }
5966 mExtras.putStringArrayList(name, value);
5967 return this;
5968 }
5969
5970 /**
5971 * Add extended data to the intent. The name must include a package
5972 * prefix, for example the app com.android.contacts would use names
5973 * like "com.android.contacts.ShowAll".
5974 *
5975 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005976 * @param value The ArrayList<CharSequence> data value.
5977 *
5978 * @return Returns the same Intent object, for chaining multiple calls
5979 * into a single statement.
5980 *
5981 * @see #putExtras
5982 * @see #removeExtra
5983 * @see #getCharSequenceArrayListExtra(String)
5984 */
5985 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5986 if (mExtras == null) {
5987 mExtras = new Bundle();
5988 }
5989 mExtras.putCharSequenceArrayList(name, value);
5990 return this;
5991 }
5992
5993 /**
5994 * Add extended data to the intent. The name must include a package
5995 * prefix, for example the app com.android.contacts would use names
5996 * like "com.android.contacts.ShowAll".
5997 *
5998 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005999 * @param value The Serializable data value.
6000 *
6001 * @return Returns the same Intent object, for chaining multiple calls
6002 * into a single statement.
6003 *
6004 * @see #putExtras
6005 * @see #removeExtra
6006 * @see #getSerializableExtra(String)
6007 */
6008 public Intent putExtra(String name, Serializable value) {
6009 if (mExtras == null) {
6010 mExtras = new Bundle();
6011 }
6012 mExtras.putSerializable(name, value);
6013 return this;
6014 }
6015
6016 /**
6017 * Add extended data to the intent. The name must include a package
6018 * prefix, for example the app com.android.contacts would use names
6019 * like "com.android.contacts.ShowAll".
6020 *
6021 * @param name The name of the extra data, with package prefix.
6022 * @param value The boolean array data value.
6023 *
6024 * @return Returns the same Intent object, for chaining multiple calls
6025 * into a single statement.
6026 *
6027 * @see #putExtras
6028 * @see #removeExtra
6029 * @see #getBooleanArrayExtra(String)
6030 */
6031 public Intent putExtra(String name, boolean[] value) {
6032 if (mExtras == null) {
6033 mExtras = new Bundle();
6034 }
6035 mExtras.putBooleanArray(name, value);
6036 return this;
6037 }
6038
6039 /**
6040 * Add extended data to the intent. The name must include a package
6041 * prefix, for example the app com.android.contacts would use names
6042 * like "com.android.contacts.ShowAll".
6043 *
6044 * @param name The name of the extra data, with package prefix.
6045 * @param value The byte array data value.
6046 *
6047 * @return Returns the same Intent object, for chaining multiple calls
6048 * into a single statement.
6049 *
6050 * @see #putExtras
6051 * @see #removeExtra
6052 * @see #getByteArrayExtra(String)
6053 */
6054 public Intent putExtra(String name, byte[] value) {
6055 if (mExtras == null) {
6056 mExtras = new Bundle();
6057 }
6058 mExtras.putByteArray(name, value);
6059 return this;
6060 }
6061
6062 /**
6063 * Add extended data to the intent. The name must include a package
6064 * prefix, for example the app com.android.contacts would use names
6065 * like "com.android.contacts.ShowAll".
6066 *
6067 * @param name The name of the extra data, with package prefix.
6068 * @param value The short array data value.
6069 *
6070 * @return Returns the same Intent object, for chaining multiple calls
6071 * into a single statement.
6072 *
6073 * @see #putExtras
6074 * @see #removeExtra
6075 * @see #getShortArrayExtra(String)
6076 */
6077 public Intent putExtra(String name, short[] value) {
6078 if (mExtras == null) {
6079 mExtras = new Bundle();
6080 }
6081 mExtras.putShortArray(name, value);
6082 return this;
6083 }
6084
6085 /**
6086 * Add extended data to the intent. The name must include a package
6087 * prefix, for example the app com.android.contacts would use names
6088 * like "com.android.contacts.ShowAll".
6089 *
6090 * @param name The name of the extra data, with package prefix.
6091 * @param value The char array data value.
6092 *
6093 * @return Returns the same Intent object, for chaining multiple calls
6094 * into a single statement.
6095 *
6096 * @see #putExtras
6097 * @see #removeExtra
6098 * @see #getCharArrayExtra(String)
6099 */
6100 public Intent putExtra(String name, char[] value) {
6101 if (mExtras == null) {
6102 mExtras = new Bundle();
6103 }
6104 mExtras.putCharArray(name, value);
6105 return this;
6106 }
6107
6108 /**
6109 * Add extended data to the intent. The name must include a package
6110 * prefix, for example the app com.android.contacts would use names
6111 * like "com.android.contacts.ShowAll".
6112 *
6113 * @param name The name of the extra data, with package prefix.
6114 * @param value The int array data value.
6115 *
6116 * @return Returns the same Intent object, for chaining multiple calls
6117 * into a single statement.
6118 *
6119 * @see #putExtras
6120 * @see #removeExtra
6121 * @see #getIntArrayExtra(String)
6122 */
6123 public Intent putExtra(String name, int[] value) {
6124 if (mExtras == null) {
6125 mExtras = new Bundle();
6126 }
6127 mExtras.putIntArray(name, value);
6128 return this;
6129 }
6130
6131 /**
6132 * Add extended data to the intent. The name must include a package
6133 * prefix, for example the app com.android.contacts would use names
6134 * like "com.android.contacts.ShowAll".
6135 *
6136 * @param name The name of the extra data, with package prefix.
6137 * @param value The byte array data value.
6138 *
6139 * @return Returns the same Intent object, for chaining multiple calls
6140 * into a single statement.
6141 *
6142 * @see #putExtras
6143 * @see #removeExtra
6144 * @see #getLongArrayExtra(String)
6145 */
6146 public Intent putExtra(String name, long[] value) {
6147 if (mExtras == null) {
6148 mExtras = new Bundle();
6149 }
6150 mExtras.putLongArray(name, value);
6151 return this;
6152 }
6153
6154 /**
6155 * Add extended data to the intent. The name must include a package
6156 * prefix, for example the app com.android.contacts would use names
6157 * like "com.android.contacts.ShowAll".
6158 *
6159 * @param name The name of the extra data, with package prefix.
6160 * @param value The float array data value.
6161 *
6162 * @return Returns the same Intent object, for chaining multiple calls
6163 * into a single statement.
6164 *
6165 * @see #putExtras
6166 * @see #removeExtra
6167 * @see #getFloatArrayExtra(String)
6168 */
6169 public Intent putExtra(String name, float[] value) {
6170 if (mExtras == null) {
6171 mExtras = new Bundle();
6172 }
6173 mExtras.putFloatArray(name, value);
6174 return this;
6175 }
6176
6177 /**
6178 * Add extended data to the intent. The name must include a package
6179 * prefix, for example the app com.android.contacts would use names
6180 * like "com.android.contacts.ShowAll".
6181 *
6182 * @param name The name of the extra data, with package prefix.
6183 * @param value The double array data value.
6184 *
6185 * @return Returns the same Intent object, for chaining multiple calls
6186 * into a single statement.
6187 *
6188 * @see #putExtras
6189 * @see #removeExtra
6190 * @see #getDoubleArrayExtra(String)
6191 */
6192 public Intent putExtra(String name, double[] value) {
6193 if (mExtras == null) {
6194 mExtras = new Bundle();
6195 }
6196 mExtras.putDoubleArray(name, value);
6197 return this;
6198 }
6199
6200 /**
6201 * Add extended data to the intent. The name must include a package
6202 * prefix, for example the app com.android.contacts would use names
6203 * like "com.android.contacts.ShowAll".
6204 *
6205 * @param name The name of the extra data, with package prefix.
6206 * @param value The String array data value.
6207 *
6208 * @return Returns the same Intent object, for chaining multiple calls
6209 * into a single statement.
6210 *
6211 * @see #putExtras
6212 * @see #removeExtra
6213 * @see #getStringArrayExtra(String)
6214 */
6215 public Intent putExtra(String name, String[] value) {
6216 if (mExtras == null) {
6217 mExtras = new Bundle();
6218 }
6219 mExtras.putStringArray(name, value);
6220 return this;
6221 }
6222
6223 /**
6224 * Add extended data to the intent. The name must include a package
6225 * prefix, for example the app com.android.contacts would use names
6226 * like "com.android.contacts.ShowAll".
6227 *
6228 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006229 * @param value The CharSequence array data value.
6230 *
6231 * @return Returns the same Intent object, for chaining multiple calls
6232 * into a single statement.
6233 *
6234 * @see #putExtras
6235 * @see #removeExtra
6236 * @see #getCharSequenceArrayExtra(String)
6237 */
6238 public Intent putExtra(String name, CharSequence[] value) {
6239 if (mExtras == null) {
6240 mExtras = new Bundle();
6241 }
6242 mExtras.putCharSequenceArray(name, value);
6243 return this;
6244 }
6245
6246 /**
6247 * Add extended data to the intent. The name must include a package
6248 * prefix, for example the app com.android.contacts would use names
6249 * like "com.android.contacts.ShowAll".
6250 *
6251 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006252 * @param value The Bundle data value.
6253 *
6254 * @return Returns the same Intent object, for chaining multiple calls
6255 * into a single statement.
6256 *
6257 * @see #putExtras
6258 * @see #removeExtra
6259 * @see #getBundleExtra(String)
6260 */
6261 public Intent putExtra(String name, Bundle value) {
6262 if (mExtras == null) {
6263 mExtras = new Bundle();
6264 }
6265 mExtras.putBundle(name, value);
6266 return this;
6267 }
6268
6269 /**
6270 * Add extended data to the intent. The name must include a package
6271 * prefix, for example the app com.android.contacts would use names
6272 * like "com.android.contacts.ShowAll".
6273 *
6274 * @param name The name of the extra data, with package prefix.
6275 * @param value The IBinder data value.
6276 *
6277 * @return Returns the same Intent object, for chaining multiple calls
6278 * into a single statement.
6279 *
6280 * @see #putExtras
6281 * @see #removeExtra
6282 * @see #getIBinderExtra(String)
6283 *
6284 * @deprecated
6285 * @hide
6286 */
6287 @Deprecated
6288 public Intent putExtra(String name, IBinder value) {
6289 if (mExtras == null) {
6290 mExtras = new Bundle();
6291 }
6292 mExtras.putIBinder(name, value);
6293 return this;
6294 }
6295
6296 /**
6297 * Copy all extras in 'src' in to this intent.
6298 *
6299 * @param src Contains the extras to copy.
6300 *
6301 * @see #putExtra
6302 */
6303 public Intent putExtras(Intent src) {
6304 if (src.mExtras != null) {
6305 if (mExtras == null) {
6306 mExtras = new Bundle(src.mExtras);
6307 } else {
6308 mExtras.putAll(src.mExtras);
6309 }
6310 }
6311 return this;
6312 }
6313
6314 /**
6315 * Add a set of extended data to the intent. The keys must include a package
6316 * prefix, for example the app com.android.contacts would use names
6317 * like "com.android.contacts.ShowAll".
6318 *
6319 * @param extras The Bundle of extras to add to this intent.
6320 *
6321 * @see #putExtra
6322 * @see #removeExtra
6323 */
6324 public Intent putExtras(Bundle extras) {
6325 if (mExtras == null) {
6326 mExtras = new Bundle();
6327 }
6328 mExtras.putAll(extras);
6329 return this;
6330 }
6331
6332 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006333 * Completely replace the extras in the Intent with the extras in the
6334 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006335 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006336 * @param src The exact extras contained in this Intent are copied
6337 * into the target intent, replacing any that were previously there.
6338 */
6339 public Intent replaceExtras(Intent src) {
6340 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6341 return this;
6342 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006343
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006344 /**
6345 * Completely replace the extras in the Intent with the given Bundle of
6346 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006347 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006348 * @param extras The new set of extras in the Intent, or null to erase
6349 * all extras.
6350 */
6351 public Intent replaceExtras(Bundle extras) {
6352 mExtras = extras != null ? new Bundle(extras) : null;
6353 return this;
6354 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006355
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006356 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006357 * Remove extended data from the intent.
6358 *
6359 * @see #putExtra
6360 */
6361 public void removeExtra(String name) {
6362 if (mExtras != null) {
6363 mExtras.remove(name);
6364 if (mExtras.size() == 0) {
6365 mExtras = null;
6366 }
6367 }
6368 }
6369
6370 /**
6371 * Set special flags controlling how this intent is handled. Most values
6372 * here depend on the type of component being executed by the Intent,
6373 * specifically the FLAG_ACTIVITY_* flags are all for use with
6374 * {@link Context#startActivity Context.startActivity()} and the
6375 * FLAG_RECEIVER_* flags are all for use with
6376 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6377 *
Scott Main7aee61f2011-02-08 11:25:01 -08006378 * <p>See the
6379 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6380 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006381 * the behavior of your application.
6382 *
6383 * @param flags The desired flags.
6384 *
6385 * @return Returns the same Intent object, for chaining multiple calls
6386 * into a single statement.
6387 *
6388 * @see #getFlags
6389 * @see #addFlags
6390 *
6391 * @see #FLAG_GRANT_READ_URI_PERMISSION
6392 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006393 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6394 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006395 * @see #FLAG_DEBUG_LOG_RESOLUTION
6396 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006397 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006398 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006399 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006400 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006401 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6402 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006403 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006405 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006406 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006407 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006408 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006409 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006410 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6411 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006412 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006413 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006414 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006415 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6416 */
6417 public Intent setFlags(int flags) {
6418 mFlags = flags;
6419 return this;
6420 }
6421
6422 /**
6423 * Add additional flags to the intent (or with existing flags
6424 * value).
6425 *
6426 * @param flags The new flags to set.
6427 *
6428 * @return Returns the same Intent object, for chaining multiple calls
6429 * into a single statement.
6430 *
6431 * @see #setFlags
6432 */
6433 public Intent addFlags(int flags) {
6434 mFlags |= flags;
6435 return this;
6436 }
6437
6438 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006439 * (Usually optional) Set an explicit application package name that limits
6440 * the components this Intent will resolve to. If left to the default
6441 * value of null, all components in all applications will considered.
6442 * If non-null, the Intent can only match the components in the given
6443 * application package.
6444 *
6445 * @param packageName The name of the application package to handle the
6446 * intent, or null to allow any application package.
6447 *
6448 * @return Returns the same Intent object, for chaining multiple calls
6449 * into a single statement.
6450 *
6451 * @see #getPackage
6452 * @see #resolveActivity
6453 */
6454 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006455 if (packageName != null && mSelector != null) {
6456 throw new IllegalArgumentException(
6457 "Can't set package name when selector is already set");
6458 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006459 mPackage = packageName;
6460 return this;
6461 }
6462
6463 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006464 * (Usually optional) Explicitly set the component to handle the intent.
6465 * If left with the default value of null, the system will determine the
6466 * appropriate class to use based on the other fields (action, data,
6467 * type, categories) in the Intent. If this class is defined, the
6468 * specified class will always be used regardless of the other fields. You
6469 * should only set this value when you know you absolutely want a specific
6470 * class to be used; otherwise it is better to let the system find the
6471 * appropriate class so that you will respect the installed applications
6472 * and user preferences.
6473 *
6474 * @param component The name of the application component to handle the
6475 * intent, or null to let the system find one for you.
6476 *
6477 * @return Returns the same Intent object, for chaining multiple calls
6478 * into a single statement.
6479 *
6480 * @see #setClass
6481 * @see #setClassName(Context, String)
6482 * @see #setClassName(String, String)
6483 * @see #getComponent
6484 * @see #resolveActivity
6485 */
6486 public Intent setComponent(ComponentName component) {
6487 mComponent = component;
6488 return this;
6489 }
6490
6491 /**
6492 * Convenience for calling {@link #setComponent} with an
6493 * explicit class name.
6494 *
6495 * @param packageContext A Context of the application package implementing
6496 * this class.
6497 * @param className The name of a class inside of the application package
6498 * that will be used as the component for this Intent.
6499 *
6500 * @return Returns the same Intent object, for chaining multiple calls
6501 * into a single statement.
6502 *
6503 * @see #setComponent
6504 * @see #setClass
6505 */
6506 public Intent setClassName(Context packageContext, String className) {
6507 mComponent = new ComponentName(packageContext, className);
6508 return this;
6509 }
6510
6511 /**
6512 * Convenience for calling {@link #setComponent} with an
6513 * explicit application package name and class name.
6514 *
6515 * @param packageName The name of the package implementing the desired
6516 * component.
6517 * @param className The name of a class inside of the application package
6518 * that will be used as the component for this Intent.
6519 *
6520 * @return Returns the same Intent object, for chaining multiple calls
6521 * into a single statement.
6522 *
6523 * @see #setComponent
6524 * @see #setClass
6525 */
6526 public Intent setClassName(String packageName, String className) {
6527 mComponent = new ComponentName(packageName, className);
6528 return this;
6529 }
6530
6531 /**
6532 * Convenience for calling {@link #setComponent(ComponentName)} with the
6533 * name returned by a {@link Class} object.
6534 *
6535 * @param packageContext A Context of the application package implementing
6536 * this class.
6537 * @param cls The class name to set, equivalent to
6538 * <code>setClassName(context, cls.getName())</code>.
6539 *
6540 * @return Returns the same Intent object, for chaining multiple calls
6541 * into a single statement.
6542 *
6543 * @see #setComponent
6544 */
6545 public Intent setClass(Context packageContext, Class<?> cls) {
6546 mComponent = new ComponentName(packageContext, cls);
6547 return this;
6548 }
6549
6550 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006551 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6552 * used as a hint to the receiver for animations and the like. Null means that there
6553 * is no source bounds.
6554 */
6555 public void setSourceBounds(Rect r) {
6556 if (r != null) {
6557 mSourceBounds = new Rect(r);
6558 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006559 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006560 }
6561 }
6562
Tor Norbyed9273d62013-05-30 15:59:53 -07006563 /** @hide */
6564 @IntDef(flag = true,
6565 value = {
6566 FILL_IN_ACTION,
6567 FILL_IN_DATA,
6568 FILL_IN_CATEGORIES,
6569 FILL_IN_COMPONENT,
6570 FILL_IN_PACKAGE,
6571 FILL_IN_SOURCE_BOUNDS,
6572 FILL_IN_SELECTOR,
6573 FILL_IN_CLIP_DATA
6574 })
6575 @Retention(RetentionPolicy.SOURCE)
6576 public @interface FillInFlags {}
6577
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006578 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006579 * Use with {@link #fillIn} to allow the current action value to be
6580 * overwritten, even if it is already set.
6581 */
6582 public static final int FILL_IN_ACTION = 1<<0;
6583
6584 /**
6585 * Use with {@link #fillIn} to allow the current data or type value
6586 * overwritten, even if it is already set.
6587 */
6588 public static final int FILL_IN_DATA = 1<<1;
6589
6590 /**
6591 * Use with {@link #fillIn} to allow the current categories to be
6592 * overwritten, even if they are already set.
6593 */
6594 public static final int FILL_IN_CATEGORIES = 1<<2;
6595
6596 /**
6597 * Use with {@link #fillIn} to allow the current component value to be
6598 * overwritten, even if it is already set.
6599 */
6600 public static final int FILL_IN_COMPONENT = 1<<3;
6601
6602 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006603 * Use with {@link #fillIn} to allow the current package value to be
6604 * overwritten, even if it is already set.
6605 */
6606 public static final int FILL_IN_PACKAGE = 1<<4;
6607
6608 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006609 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006610 * overwritten, even if it is already set.
6611 */
6612 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6613
6614 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006615 * Use with {@link #fillIn} to allow the current selector to be
6616 * overwritten, even if it is already set.
6617 */
6618 public static final int FILL_IN_SELECTOR = 1<<6;
6619
6620 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006621 * Use with {@link #fillIn} to allow the current ClipData to be
6622 * overwritten, even if it is already set.
6623 */
6624 public static final int FILL_IN_CLIP_DATA = 1<<7;
6625
6626 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006627 * Copy the contents of <var>other</var> in to this object, but only
6628 * where fields are not defined by this object. For purposes of a field
6629 * being defined, the following pieces of data in the Intent are
6630 * considered to be separate fields:
6631 *
6632 * <ul>
6633 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006634 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006635 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6636 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006637 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006638 * <li> component, as set by {@link #setComponent(ComponentName)} or
6639 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006640 * <li> source bounds, as set by {@link #setSourceBounds}.
6641 * <li> selector, as set by {@link #setSelector(Intent)}.
6642 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006643 * <li> each top-level name in the associated extras.
6644 * </ul>
6645 *
6646 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006647 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006648 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6649 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6650 * the restriction where the corresponding field will not be replaced if
6651 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006652 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006653 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6654 * is explicitly specified. The selector will only be copied if
6655 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006656 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006657 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6658 * and Intent B with {action="gotit", data-type="some/thing",
6659 * categories="one","two"}.
6660 *
6661 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6662 * containing: {action="gotit", data-type="some/thing",
6663 * categories="bar"}.
6664 *
6665 * @param other Another Intent whose values are to be used to fill in
6666 * the current one.
6667 * @param flags Options to control which fields can be filled in.
6668 *
6669 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006670 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006671 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6672 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6673 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006674 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006675 @FillInFlags
6676 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006677 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006678 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006679 if (other.mAction != null
6680 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006681 mAction = other.mAction;
6682 changes |= FILL_IN_ACTION;
6683 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006684 if ((other.mData != null || other.mType != null)
6685 && ((mData == null && mType == null)
6686 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006687 mData = other.mData;
6688 mType = other.mType;
6689 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006690 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006691 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006692 if (other.mCategories != null
6693 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006694 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006695 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006696 }
6697 changes |= FILL_IN_CATEGORIES;
6698 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006699 if (other.mPackage != null
6700 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006701 // Only do this if mSelector is not set.
6702 if (mSelector == null) {
6703 mPackage = other.mPackage;
6704 changes |= FILL_IN_PACKAGE;
6705 }
6706 }
6707 // Selector is special: it can only be set if explicitly allowed,
6708 // for the same reason as the component name.
6709 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6710 if (mPackage == null) {
6711 mSelector = new Intent(other.mSelector);
6712 mPackage = null;
6713 changes |= FILL_IN_SELECTOR;
6714 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006715 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006716 if (other.mClipData != null
6717 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6718 mClipData = other.mClipData;
6719 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006720 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006721 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006722 // Component is special: it can -only- be set if explicitly allowed,
6723 // since otherwise the sender could force the intent somewhere the
6724 // originator didn't intend.
6725 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006726 mComponent = other.mComponent;
6727 changes |= FILL_IN_COMPONENT;
6728 }
6729 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006730 if (other.mSourceBounds != null
6731 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6732 mSourceBounds = new Rect(other.mSourceBounds);
6733 changes |= FILL_IN_SOURCE_BOUNDS;
6734 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006735 if (mExtras == null) {
6736 if (other.mExtras != null) {
6737 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006738 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006739 }
6740 } else if (other.mExtras != null) {
6741 try {
6742 Bundle newb = new Bundle(other.mExtras);
6743 newb.putAll(mExtras);
6744 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006745 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006746 } catch (RuntimeException e) {
6747 // Modifying the extras can cause us to unparcel the contents
6748 // of the bundle, and if we do this in the system process that
6749 // may fail. We really should handle this (i.e., the Bundle
6750 // impl shouldn't be on top of a plain map), but for now just
6751 // ignore it and keep the original contents. :(
6752 Log.w("Intent", "Failure filling in extras", e);
6753 }
6754 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006755 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
6756 && other.mContentUserHint != UserHandle.USER_CURRENT) {
6757 mContentUserHint = other.mContentUserHint;
6758 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006759 return changes;
6760 }
6761
6762 /**
6763 * Wrapper class holding an Intent and implementing comparisons on it for
6764 * the purpose of filtering. The class implements its
6765 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6766 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6767 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6768 * on the wrapped Intent.
6769 */
6770 public static final class FilterComparison {
6771 private final Intent mIntent;
6772 private final int mHashCode;
6773
6774 public FilterComparison(Intent intent) {
6775 mIntent = intent;
6776 mHashCode = intent.filterHashCode();
6777 }
6778
6779 /**
6780 * Return the Intent that this FilterComparison represents.
6781 * @return Returns the Intent held by the FilterComparison. Do
6782 * not modify!
6783 */
6784 public Intent getIntent() {
6785 return mIntent;
6786 }
6787
6788 @Override
6789 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006790 if (obj instanceof FilterComparison) {
6791 Intent other = ((FilterComparison)obj).mIntent;
6792 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006793 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006794 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006795 }
6796
6797 @Override
6798 public int hashCode() {
6799 return mHashCode;
6800 }
6801 }
6802
6803 /**
6804 * Determine if two intents are the same for the purposes of intent
6805 * resolution (filtering). That is, if their action, data, type,
6806 * class, and categories are the same. This does <em>not</em> compare
6807 * any extra data included in the intents.
6808 *
6809 * @param other The other Intent to compare against.
6810 *
6811 * @return Returns true if action, data, type, class, and categories
6812 * are the same.
6813 */
6814 public boolean filterEquals(Intent other) {
6815 if (other == null) {
6816 return false;
6817 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07006818 if (!Objects.equals(this.mAction, other.mAction)) return false;
6819 if (!Objects.equals(this.mData, other.mData)) return false;
6820 if (!Objects.equals(this.mType, other.mType)) return false;
6821 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
6822 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
6823 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006824
6825 return true;
6826 }
6827
6828 /**
6829 * Generate hash code that matches semantics of filterEquals().
6830 *
6831 * @return Returns the hash value of the action, data, type, class, and
6832 * categories.
6833 *
6834 * @see #filterEquals
6835 */
6836 public int filterHashCode() {
6837 int code = 0;
6838 if (mAction != null) {
6839 code += mAction.hashCode();
6840 }
6841 if (mData != null) {
6842 code += mData.hashCode();
6843 }
6844 if (mType != null) {
6845 code += mType.hashCode();
6846 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006847 if (mPackage != null) {
6848 code += mPackage.hashCode();
6849 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006850 if (mComponent != null) {
6851 code += mComponent.hashCode();
6852 }
6853 if (mCategories != null) {
6854 code += mCategories.hashCode();
6855 }
6856 return code;
6857 }
6858
6859 @Override
6860 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006861 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006862
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006863 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006864 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006865 b.append(" }");
6866
6867 return b.toString();
6868 }
6869
6870 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006871 public String toInsecureString() {
6872 StringBuilder b = new StringBuilder(128);
6873
6874 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006875 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006876 b.append(" }");
6877
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006878 return b.toString();
6879 }
Romain Guy4969af72009-06-17 10:53:19 -07006880
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006881 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006882 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006883 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006884
6885 b.append("Intent { ");
6886 toShortString(b, false, true, true, true);
6887 b.append(" }");
6888
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006889 return b.toString();
6890 }
6891
6892 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006893 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6894 StringBuilder b = new StringBuilder(128);
6895 toShortString(b, secure, comp, extras, clip);
6896 return b.toString();
6897 }
6898
6899 /** @hide */
6900 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6901 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006902 boolean first = true;
6903 if (mAction != null) {
6904 b.append("act=").append(mAction);
6905 first = false;
6906 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006907 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006908 if (!first) {
6909 b.append(' ');
6910 }
6911 first = false;
6912 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006913 for (int i=0; i<mCategories.size(); i++) {
6914 if (i > 0) b.append(',');
6915 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006916 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006917 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006918 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006919 if (mData != null) {
6920 if (!first) {
6921 b.append(' ');
6922 }
6923 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006924 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006925 if (secure) {
6926 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006927 } else {
6928 b.append(mData);
6929 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006930 }
6931 if (mType != null) {
6932 if (!first) {
6933 b.append(' ');
6934 }
6935 first = false;
6936 b.append("typ=").append(mType);
6937 }
6938 if (mFlags != 0) {
6939 if (!first) {
6940 b.append(' ');
6941 }
6942 first = false;
6943 b.append("flg=0x").append(Integer.toHexString(mFlags));
6944 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006945 if (mPackage != null) {
6946 if (!first) {
6947 b.append(' ');
6948 }
6949 first = false;
6950 b.append("pkg=").append(mPackage);
6951 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006952 if (comp && mComponent != null) {
6953 if (!first) {
6954 b.append(' ');
6955 }
6956 first = false;
6957 b.append("cmp=").append(mComponent.flattenToShortString());
6958 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006959 if (mSourceBounds != null) {
6960 if (!first) {
6961 b.append(' ');
6962 }
6963 first = false;
6964 b.append("bnds=").append(mSourceBounds.toShortString());
6965 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006966 if (mClipData != null) {
6967 if (!first) {
6968 b.append(' ');
6969 }
6970 first = false;
6971 if (clip) {
6972 b.append("clip={");
6973 mClipData.toShortString(b);
6974 b.append('}');
6975 } else {
6976 b.append("(has clip)");
6977 }
6978 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006979 if (extras && mExtras != null) {
6980 if (!first) {
6981 b.append(' ');
6982 }
6983 first = false;
6984 b.append("(has extras)");
6985 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006986 if (mContentUserHint != UserHandle.USER_CURRENT) {
6987 if (!first) {
6988 b.append(' ');
6989 }
6990 first = false;
6991 b.append("u=").append(mContentUserHint);
6992 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006993 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006994 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006995 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006996 b.append("}");
6997 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006998 }
6999
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007000 /**
7001 * Call {@link #toUri} with 0 flags.
7002 * @deprecated Use {@link #toUri} instead.
7003 */
7004 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007005 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007006 return toUri(0);
7007 }
7008
7009 /**
7010 * Convert this Intent into a String holding a URI representation of it.
7011 * The returned URI string has been properly URI encoded, so it can be
7012 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7013 * Intent's data as the base URI, with an additional fragment describing
7014 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007015 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007016 * <p>You can convert the returned string back to an Intent with
7017 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007018 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007019 * @param flags Additional operating flags. Either 0 or
7020 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007021 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007022 * @return Returns a URI encoding URI string describing the entire contents
7023 * of the Intent.
7024 */
7025 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007026 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007027 String scheme = null;
7028 if (mData != null) {
7029 String data = mData.toString();
7030 if ((flags&URI_INTENT_SCHEME) != 0) {
7031 final int N = data.length();
7032 for (int i=0; i<N; i++) {
7033 char c = data.charAt(i);
7034 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7035 || c == '.' || c == '-') {
7036 continue;
7037 }
7038 if (c == ':' && i > 0) {
7039 // Valid scheme.
7040 scheme = data.substring(0, i);
7041 uri.append("intent:");
7042 data = data.substring(i+1);
7043 break;
7044 }
Tom Taylord4a47292009-12-21 13:59:18 -08007045
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007046 // No scheme.
7047 break;
7048 }
7049 }
7050 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007051
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007052 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7053 uri.append("intent:");
7054 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007055
7056 uri.append("#Intent;");
7057
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007058 toUriInner(uri, scheme, flags);
7059 if (mSelector != null) {
7060 uri.append("SEL;");
7061 // Note that for now we are not going to try to handle the
7062 // data part; not clear how to represent this as a URI, and
7063 // not much utility in it.
7064 mSelector.toUriInner(uri, null, flags);
7065 }
7066
7067 uri.append("end");
7068
7069 return uri.toString();
7070 }
7071
7072 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007073 if (scheme != null) {
7074 uri.append("scheme=").append(scheme).append(';');
7075 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007076 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007077 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007078 }
7079 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007080 for (int i=0; i<mCategories.size(); i++) {
7081 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007082 }
7083 }
7084 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007085 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007086 }
7087 if (mFlags != 0) {
7088 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7089 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007090 if (mPackage != null) {
7091 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7092 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007093 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007094 uri.append("component=").append(Uri.encode(
7095 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007096 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007097 if (mSourceBounds != null) {
7098 uri.append("sourceBounds=")
7099 .append(Uri.encode(mSourceBounds.flattenToString()))
7100 .append(';');
7101 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007102 if (mExtras != null) {
7103 for (String key : mExtras.keySet()) {
7104 final Object value = mExtras.get(key);
7105 char entryType =
7106 value instanceof String ? 'S' :
7107 value instanceof Boolean ? 'B' :
7108 value instanceof Byte ? 'b' :
7109 value instanceof Character ? 'c' :
7110 value instanceof Double ? 'd' :
7111 value instanceof Float ? 'f' :
7112 value instanceof Integer ? 'i' :
7113 value instanceof Long ? 'l' :
7114 value instanceof Short ? 's' :
7115 '\0';
7116
7117 if (entryType != '\0') {
7118 uri.append(entryType);
7119 uri.append('.');
7120 uri.append(Uri.encode(key));
7121 uri.append('=');
7122 uri.append(Uri.encode(value.toString()));
7123 uri.append(';');
7124 }
7125 }
7126 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007127 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007128
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007129 public int describeContents() {
7130 return (mExtras != null) ? mExtras.describeContents() : 0;
7131 }
7132
7133 public void writeToParcel(Parcel out, int flags) {
7134 out.writeString(mAction);
7135 Uri.writeToParcel(out, mData);
7136 out.writeString(mType);
7137 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007138 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007139 ComponentName.writeToParcel(mComponent, out);
7140
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007141 if (mSourceBounds != null) {
7142 out.writeInt(1);
7143 mSourceBounds.writeToParcel(out, flags);
7144 } else {
7145 out.writeInt(0);
7146 }
7147
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007148 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007149 final int N = mCategories.size();
7150 out.writeInt(N);
7151 for (int i=0; i<N; i++) {
7152 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007153 }
7154 } else {
7155 out.writeInt(0);
7156 }
7157
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007158 if (mSelector != null) {
7159 out.writeInt(1);
7160 mSelector.writeToParcel(out, flags);
7161 } else {
7162 out.writeInt(0);
7163 }
7164
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007165 if (mClipData != null) {
7166 out.writeInt(1);
7167 mClipData.writeToParcel(out, flags);
7168 } else {
7169 out.writeInt(0);
7170 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007171 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007172 out.writeBundle(mExtras);
7173 }
7174
7175 public static final Parcelable.Creator<Intent> CREATOR
7176 = new Parcelable.Creator<Intent>() {
7177 public Intent createFromParcel(Parcel in) {
7178 return new Intent(in);
7179 }
7180 public Intent[] newArray(int size) {
7181 return new Intent[size];
7182 }
7183 };
7184
Dianne Hackborneb034652009-09-07 00:49:58 -07007185 /** @hide */
7186 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007187 readFromParcel(in);
7188 }
7189
7190 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007191 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007192 mData = Uri.CREATOR.createFromParcel(in);
7193 mType = in.readString();
7194 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007195 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007196 mComponent = ComponentName.readFromParcel(in);
7197
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007198 if (in.readInt() != 0) {
7199 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7200 }
7201
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007202 int N = in.readInt();
7203 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007204 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007205 int i;
7206 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007207 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007208 }
7209 } else {
7210 mCategories = null;
7211 }
7212
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007213 if (in.readInt() != 0) {
7214 mSelector = new Intent(in);
7215 }
7216
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007217 if (in.readInt() != 0) {
7218 mClipData = new ClipData(in);
7219 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007220 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007221 mExtras = in.readBundle();
7222 }
7223
7224 /**
7225 * Parses the "intent" element (and its children) from XML and instantiates
7226 * an Intent object. The given XML parser should be located at the tag
7227 * where parsing should start (often named "intent"), from which the
7228 * basic action, data, type, and package and class name will be
7229 * retrieved. The function will then parse in to any child elements,
7230 * looking for <category android:name="xxx"> tags to add categories and
7231 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7232 * to the intent.
7233 *
7234 * @param resources The Resources to use when inflating resources.
7235 * @param parser The XML parser pointing at an "intent" tag.
7236 * @param attrs The AttributeSet interface for retrieving extended
7237 * attribute data at the current <var>parser</var> location.
7238 * @return An Intent object matching the XML data.
7239 * @throws XmlPullParserException If there was an XML parsing error.
7240 * @throws IOException If there was an I/O error.
7241 */
7242 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7243 throws XmlPullParserException, IOException {
7244 Intent intent = new Intent();
7245
7246 TypedArray sa = resources.obtainAttributes(attrs,
7247 com.android.internal.R.styleable.Intent);
7248
7249 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7250
7251 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7252 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7253 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7254
7255 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7256 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7257 if (packageName != null && className != null) {
7258 intent.setComponent(new ComponentName(packageName, className));
7259 }
7260
7261 sa.recycle();
7262
7263 int outerDepth = parser.getDepth();
7264 int type;
7265 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7266 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7267 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7268 continue;
7269 }
7270
7271 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007272 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007273 sa = resources.obtainAttributes(attrs,
7274 com.android.internal.R.styleable.IntentCategory);
7275 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7276 sa.recycle();
7277
7278 if (cat != null) {
7279 intent.addCategory(cat);
7280 }
7281 XmlUtils.skipCurrentTag(parser);
7282
Craig Mautner21d24a22014-04-23 11:45:37 -07007283 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007284 if (intent.mExtras == null) {
7285 intent.mExtras = new Bundle();
7286 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007287 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007288 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007289
7290 } else {
7291 XmlUtils.skipCurrentTag(parser);
7292 }
7293 }
7294
7295 return intent;
7296 }
Nick Pellyccae4122012-01-09 14:12:58 -08007297
Craig Mautner21d24a22014-04-23 11:45:37 -07007298 /** @hide */
7299 public void saveToXml(XmlSerializer out) throws IOException {
7300 if (mAction != null) {
7301 out.attribute(null, ATTR_ACTION, mAction);
7302 }
7303 if (mData != null) {
7304 out.attribute(null, ATTR_DATA, mData.toString());
7305 }
7306 if (mType != null) {
7307 out.attribute(null, ATTR_TYPE, mType);
7308 }
7309 if (mComponent != null) {
7310 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7311 }
7312 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7313
7314 if (mCategories != null) {
7315 out.startTag(null, TAG_CATEGORIES);
7316 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7317 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7318 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007319 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007320 }
7321 }
7322
7323 /** @hide */
7324 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7325 XmlPullParserException {
7326 Intent intent = new Intent();
7327 final int outerDepth = in.getDepth();
7328
7329 int attrCount = in.getAttributeCount();
7330 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7331 final String attrName = in.getAttributeName(attrNdx);
7332 final String attrValue = in.getAttributeValue(attrNdx);
7333 if (ATTR_ACTION.equals(attrName)) {
7334 intent.setAction(attrValue);
7335 } else if (ATTR_DATA.equals(attrName)) {
7336 intent.setData(Uri.parse(attrValue));
7337 } else if (ATTR_TYPE.equals(attrName)) {
7338 intent.setType(attrValue);
7339 } else if (ATTR_COMPONENT.equals(attrName)) {
7340 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7341 } else if (ATTR_FLAGS.equals(attrName)) {
7342 intent.setFlags(Integer.valueOf(attrValue, 16));
7343 } else {
7344 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7345 }
7346 }
7347
7348 int event;
7349 String name;
7350 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7351 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7352 if (event == XmlPullParser.START_TAG) {
7353 name = in.getName();
7354 if (TAG_CATEGORIES.equals(name)) {
7355 attrCount = in.getAttributeCount();
7356 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7357 intent.addCategory(in.getAttributeValue(attrNdx));
7358 }
7359 } else {
7360 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7361 XmlUtils.skipCurrentTag(in);
7362 }
7363 }
7364 }
7365
7366 return intent;
7367 }
7368
Nick Pellyccae4122012-01-09 14:12:58 -08007369 /**
7370 * Normalize a MIME data type.
7371 *
7372 * <p>A normalized MIME type has white-space trimmed,
7373 * content-type parameters removed, and is lower-case.
7374 * This aligns the type with Android best practices for
7375 * intent filtering.
7376 *
7377 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7378 * "text/x-vCard" becomes "text/x-vcard".
7379 *
7380 * <p>All MIME types received from outside Android (such as user input,
7381 * or external sources like Bluetooth, NFC, or the Internet) should
7382 * be normalized before they are used to create an Intent.
7383 *
7384 * @param type MIME data type to normalize
7385 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007386 * @see #setType
7387 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007388 */
7389 public static String normalizeMimeType(String type) {
7390 if (type == null) {
7391 return null;
7392 }
7393
Elliott Hughescb64d432013-08-02 10:00:44 -07007394 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007395
7396 final int semicolonIndex = type.indexOf(';');
7397 if (semicolonIndex != -1) {
7398 type = type.substring(0, semicolonIndex);
7399 }
7400 return type;
7401 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007402
7403 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007404 * Prepare this {@link Intent} to leave an app process.
7405 *
7406 * @hide
7407 */
7408 public void prepareToLeaveProcess() {
7409 setAllowFds(false);
7410
7411 if (mSelector != null) {
7412 mSelector.prepareToLeaveProcess();
7413 }
7414 if (mClipData != null) {
7415 mClipData.prepareToLeaveProcess();
7416 }
7417
7418 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7419 // There are several ACTION_MEDIA_* broadcasts that send file://
7420 // Uris, so only check common actions.
7421 if (ACTION_VIEW.equals(mAction) ||
7422 ACTION_EDIT.equals(mAction) ||
7423 ACTION_ATTACH_DATA.equals(mAction)) {
7424 mData.checkFileUriExposed("Intent.getData()");
7425 }
7426 }
7427 }
7428
7429 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007430 * @hide
7431 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007432 public void prepareToEnterProcess() {
7433 if (mContentUserHint != UserHandle.USER_CURRENT) {
7434 fixUris(mContentUserHint);
7435 mContentUserHint = UserHandle.USER_CURRENT;
7436 }
7437 }
7438
7439 /**
7440 * @hide
7441 */
7442 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007443 Uri data = getData();
7444 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007445 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007446 }
7447 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007448 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007449 }
7450 String action = getAction();
7451 if (ACTION_SEND.equals(action)) {
7452 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7453 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007454 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007455 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007456 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007457 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7458 if (streams != null) {
7459 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7460 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007461 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007462 }
7463 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7464 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007465 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7466 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7467 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7468 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7469 if (output != null) {
7470 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
7471 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007472 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007473 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007474
7475 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007476 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007477 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7478 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007479 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007480 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007481 * @hide
7482 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007483 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007484 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007485 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007486
7487 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007488 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007489
7490 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007491 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007492 try {
7493 // Inspect target intent to see if we need to migrate
7494 final Intent target = getParcelableExtra(EXTRA_INTENT);
7495 if (target != null && target.migrateExtraStreamToClipData()) {
7496 // Since we migrated in child, we need to promote ClipData
7497 // and flags to ourselves to grant.
7498 setClipData(target.getClipData());
Jeff Sharkey846318a2014-04-04 12:12:41 -07007499 addFlags(target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
7500 | FLAG_GRANT_WRITE_URI_PERMISSION
7501 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7502 | FLAG_GRANT_PREFIX_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007503 return true;
7504 } else {
7505 return false;
7506 }
7507 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007508 }
7509
7510 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007511 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007512 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7513 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7514 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7515 if (stream != null || text != null || htmlText != null) {
7516 final ClipData clipData = new ClipData(
7517 null, new String[] { getType() },
7518 new ClipData.Item(text, htmlText, null, stream));
7519 setClipData(clipData);
7520 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007521 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007522 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007523 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007524 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007525
7526 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007527 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007528 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7529 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7530 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7531 int num = -1;
7532 if (streams != null) {
7533 num = streams.size();
7534 }
7535 if (texts != null) {
7536 if (num >= 0 && num != texts.size()) {
7537 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007538 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007539 }
7540 num = texts.size();
7541 }
7542 if (htmlTexts != null) {
7543 if (num >= 0 && num != htmlTexts.size()) {
7544 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007545 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007546 }
7547 num = htmlTexts.size();
7548 }
7549 if (num > 0) {
7550 final ClipData clipData = new ClipData(
7551 null, new String[] { getType() },
7552 makeClipItem(streams, texts, htmlTexts, 0));
7553
7554 for (int i = 1; i < num; i++) {
7555 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7556 }
7557
7558 setClipData(clipData);
7559 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007560 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007561 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007562 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007563 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007564 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7565 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7566 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7567 final Uri output;
7568 try {
7569 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7570 } catch (ClassCastException e) {
7571 return false;
7572 }
7573 if (output != null) {
7574 setClipData(ClipData.newRawUri("", output));
7575 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
7576 return true;
7577 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007578 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007579
7580 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007581 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007582
7583 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7584 ArrayList<String> htmlTexts, int which) {
7585 Uri uri = streams != null ? streams.get(which) : null;
7586 CharSequence text = texts != null ? texts.get(which) : null;
7587 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7588 return new ClipData.Item(text, htmlText, null, uri);
7589 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007590
7591 /** @hide */
7592 public boolean isDocument() {
7593 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7594 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007595}