blob: abe4f0a190013984f98a8350d32530ef7a780352 [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 /**
Jay Civelli42feda42014-07-11 14:56:46 -07001422 * Activity Action: Prompt the user to confirm credentials (pin, pattern or password)
1423 * for the current user of the device. Launch this activity using
1424 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
1425 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
1426 * challenge.<p/>
1427 * This intent is handled by the system at a high priority and applications cannot intercept
1428 * it.<p/>
Ying Wang749bd5d2014-07-14 23:21:52 -07001429 * You can use {@link android.app.KeyguardManager#isKeyguardSecure()} to determine if the user will be
Jay Civelli42feda42014-07-11 14:56:46 -07001430 * prompted.
1431 */
Ying Wangaf8cf372014-07-14 20:36:08 -07001432 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jay Civelli42feda42014-07-11 14:56:46 -07001433 public static final String ACTION_CONFIRM_DEVICE_CREDENTIAL = "android.intent.action.CONFIRM_DEVICE_CREDENTIAL";
1434
1435
1436 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001437 * Specify whether the package should be uninstalled for all users.
1438 * @hide because these should not be part of normal application flow.
1439 */
1440 public static final String EXTRA_UNINSTALL_ALL_USERS
1441 = "android.intent.extra.UNINSTALL_ALL_USERS";
1442
1443 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001444 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1445 * describing the last run version of the platform that was setup.
1446 * @hide
1447 */
1448 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1449
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001450 // ---------------------------------------------------------------------
1451 // ---------------------------------------------------------------------
1452 // Standard intent broadcast actions (see action variable).
1453
1454 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001455 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1456 * <p>
1457 * For historical reasons, the name of this broadcast action refers to the power
1458 * state of the screen but it is actually sent in response to changes in the
1459 * overall interactive state of the device.
1460 * </p><p>
1461 * This broadcast is sent when the device becomes non-interactive which may have
1462 * nothing to do with the screen turning off. To determine the
1463 * actual state of the screen, use {@link android.view.Display#getState}.
1464 * </p><p>
1465 * See {@link android.os.PowerManager#isInteractive} for details.
1466 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001467 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001468 * <p class="note">This is a protected intent that can only be sent
1469 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001470 */
1471 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1472 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001473
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001474 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001475 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1476 * <p>
1477 * For historical reasons, the name of this broadcast action refers to the power
1478 * state of the screen but it is actually sent in response to changes in the
1479 * overall interactive state of the device.
1480 * </p><p>
1481 * This broadcast is sent when the device becomes interactive which may have
1482 * nothing to do with the screen turning on. To determine the
1483 * actual state of the screen, use {@link android.view.Display#getState}.
1484 * </p><p>
1485 * See {@link android.os.PowerManager#isInteractive} for details.
1486 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001487 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001488 * <p class="note">This is a protected intent that can only be sent
1489 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001490 */
1491 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1492 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001493
1494 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001495 * Broadcast Action: Sent after the system stops dreaming.
1496 *
1497 * <p class="note">This is a protected intent that can only be sent by the system.
1498 * It is only sent to registered receivers.</p>
1499 */
1500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1501 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1502
1503 /**
1504 * Broadcast Action: Sent after the system starts dreaming.
1505 *
1506 * <p class="note">This is a protected intent that can only be sent by the system.
1507 * It is only sent to registered receivers.</p>
1508 */
1509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1510 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1511
1512 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001513 * 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 -07001514 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001515 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001516 * <p class="note">This is a protected intent that can only be sent
1517 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001518 */
1519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001520 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001521
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001522 /**
1523 * Broadcast Action: The current time has changed. Sent every
1524 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001525 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001526 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1527 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001528 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001529 * <p class="note">This is a protected intent that can only be sent
1530 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001531 */
1532 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1533 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1534 /**
1535 * Broadcast Action: The time was set.
1536 */
1537 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1538 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1539 /**
1540 * Broadcast Action: The date has changed.
1541 */
1542 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1543 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1544 /**
1545 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1546 * <ul>
1547 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1548 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001549 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001550 * <p class="note">This is a protected intent that can only be sent
1551 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1555 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001556 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1557 * DNS entries should be tossed.
1558 * @hide
1559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1562 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001563 * Alarm Changed Action: This is broadcast when the AlarmClock
1564 * application's alarm is set or unset. It is used by the
1565 * AlarmClock application and the StatusBar service.
1566 * @hide
1567 */
1568 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1569 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1570 /**
1571 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1572 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1573 * @hide
1574 */
1575 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1576 public static final String ACTION_SYNC_STATE_CHANGED
1577 = "android.intent.action.SYNC_STATE_CHANGED";
1578 /**
1579 * Broadcast Action: This is broadcast once, after the system has finished
1580 * booting. It can be used to perform application-specific initialization,
1581 * such as installing alarms. You must hold the
1582 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1583 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001584 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001585 * <p class="note">This is a protected intent that can only be sent
1586 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001587 */
1588 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1589 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1590 /**
1591 * Broadcast Action: This is broadcast when a user action should request a
1592 * temporary system dialog to dismiss. Some examples of temporary system
1593 * dialogs are the notification window-shade and the recent tasks dialog.
1594 */
1595 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1596 /**
1597 * Broadcast Action: Trigger the download and eventual installation
1598 * of a package.
1599 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001600 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001601 * <p class="note">This is a protected intent that can only be sent
1602 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001603 *
1604 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001605 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001606 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001607 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1608 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1609 /**
1610 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001611 * device. The data contains the name of the package. Note that the
1612 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001613 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001614 * <ul>
1615 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1616 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1617 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1618 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001619 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001620 * <p class="note">This is a protected intent that can only be sent
1621 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001622 */
1623 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1624 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1625 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001626 * Broadcast Action: A new version of an application package has been
1627 * installed, replacing an existing version that was previously installed.
1628 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001629 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001630 * <ul>
1631 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1632 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001633 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001634 * <p class="note">This is a protected intent that can only be sent
1635 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1639 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001640 * Broadcast Action: A new version of your application has been installed
1641 * over an existing one. This is only sent to the application that was
1642 * replaced. It does not contain any additional data; to receive it, just
1643 * use an intent filter for this action.
1644 *
1645 * <p class="note">This is a protected intent that can only be sent
1646 * by the system.
1647 */
1648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1649 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1650 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001651 * Broadcast Action: An existing application package has been removed from
1652 * the device. The data contains the name of the package. The package
1653 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001654 * <ul>
1655 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1656 * to the package.
1657 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1658 * application -- data and code -- is being removed.
1659 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1660 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1661 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001662 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001663 * <p class="note">This is a protected intent that can only be sent
1664 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001665 */
1666 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1667 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1668 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001669 * Broadcast Action: An existing application package has been completely
1670 * removed from the device. The data contains the name of the package.
1671 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1672 * {@link #EXTRA_DATA_REMOVED} is true and
1673 * {@link #EXTRA_REPLACING} is false of that broadcast.
1674 *
1675 * <ul>
1676 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1677 * to the package.
1678 * </ul>
1679 *
1680 * <p class="note">This is a protected intent that can only be sent
1681 * by the system.
1682 */
1683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1684 public static final String ACTION_PACKAGE_FULLY_REMOVED
1685 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1686 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001687 * Broadcast Action: An existing application package has been changed (e.g.
1688 * a component has been enabled or disabled). The data contains the name of
1689 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001690 * <ul>
1691 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001692 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001693 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001694 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1695 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001696 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001697 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001698 * <p class="note">This is a protected intent that can only be sent
1699 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001700 */
1701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1702 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1703 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001704 * @hide
1705 * Broadcast Action: Ask system services if there is any reason to
1706 * restart the given package. The data contains the name of the
1707 * package.
1708 * <ul>
1709 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1710 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1711 * </ul>
1712 *
1713 * <p class="note">This is a protected intent that can only be sent
1714 * by the system.
1715 */
1716 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1717 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1718 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001719 * Broadcast Action: The user has restarted a package, and all of its
1720 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001721 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001722 * be removed. Note that the restarted package does <em>not</em>
1723 * receive this broadcast.
1724 * 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 Project54b6cfa2008-10-21 07:00:00 -07001731 */
1732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1733 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1734 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001735 * Broadcast Action: The user has cleared the data of a package. This should
1736 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001737 * its persistent data is erased and this broadcast sent.
1738 * Note that the cleared package does <em>not</em>
1739 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001740 * <ul>
1741 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1742 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001743 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001744 * <p class="note">This is a protected intent that can only be sent
1745 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001746 */
1747 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1748 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1749 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001750 * Broadcast Action: A user ID has been removed from the system. The user
1751 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001752 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001753 * <p class="note">This is a protected intent that can only be sent
1754 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001755 */
1756 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1757 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001758
1759 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001760 * Broadcast Action: Sent to the installer package of an application
1761 * when that application is first launched (that is the first time it
1762 * is moved out of the stopped state). The data contains the name of the package.
1763 *
1764 * <p class="note">This is a protected intent that can only be sent
1765 * by the system.
1766 */
1767 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1768 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1769
1770 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001771 * Broadcast Action: Sent to the system package verifier when a package
1772 * needs to be verified. The data contains the package URI.
1773 * <p class="note">
1774 * This is a protected intent that can only be sent by the system.
1775 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001776 */
1777 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1778 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1779
1780 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001781 * Broadcast Action: Sent to the system package verifier when a package is
1782 * verified. The data contains the package URI.
1783 * <p class="note">
1784 * This is a protected intent that can only be sent by the system.
1785 */
1786 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1787 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1788
1789 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001790 * Broadcast Action: Resources for a set of packages (which were
1791 * previously unavailable) are currently
1792 * available since the media on which they exist is available.
1793 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1794 * list of packages whose availability changed.
1795 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1796 * list of uids of packages whose availability changed.
1797 * Note that the
1798 * packages in this list do <em>not</em> receive this broadcast.
1799 * The specified set of packages are now available on the system.
1800 * <p>Includes the following extras:
1801 * <ul>
1802 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1803 * whose resources(were previously unavailable) are currently available.
1804 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1805 * packages whose resources(were previously unavailable)
1806 * are currently available.
1807 * </ul>
1808 *
1809 * <p class="note">This is a protected intent that can only be sent
1810 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001811 */
1812 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001813 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1814 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001815
1816 /**
1817 * Broadcast Action: Resources for a set of packages are currently
1818 * unavailable since the media on which they exist is unavailable.
1819 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1820 * list of packages whose availability changed.
1821 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1822 * list of uids of packages whose availability changed.
1823 * The specified set of packages can no longer be
1824 * launched and are practically unavailable on the system.
1825 * <p>Inclues the following extras:
1826 * <ul>
1827 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1828 * whose resources are no longer available.
1829 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1830 * whose resources are no longer available.
1831 * </ul>
1832 *
1833 * <p class="note">This is a protected intent that can only be sent
1834 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001835 */
1836 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001837 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001838 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001839
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001840 /**
1841 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001842 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001843 * This should <em>only</em> be used to determine when the wallpaper
1844 * has changed to show the new wallpaper to the user. You should certainly
1845 * never, in response to this, change the wallpaper or other attributes of
1846 * it such as the suggested size. That would be crazy, right? You'd cause
1847 * all kinds of loops, especially if other apps are doing similar things,
1848 * right? Of course. So please don't do this.
1849 *
1850 * @deprecated Modern applications should use
1851 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1852 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1853 * shown behind their UI, rather than watching for this broadcast and
1854 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001856 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001857 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1858 /**
1859 * Broadcast Action: The current device {@link android.content.res.Configuration}
1860 * (orientation, locale, etc) has changed. When such a change happens, the
1861 * UIs (view hierarchy) will need to be rebuilt based on this new
1862 * information; for the most part, applications don't need to worry about
1863 * this, because the system will take care of stopping and restarting the
1864 * application to make sure it sees the new changes. Some system code that
1865 * can not be restarted will need to watch for this action and handle it
1866 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001867 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001868 * <p class="note">
1869 * You can <em>not</em> receive this through components declared
1870 * in manifests, only by explicitly registering for it with
1871 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1872 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001873 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001874 * <p class="note">This is a protected intent that can only be sent
1875 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001876 *
1877 * @see android.content.res.Configuration
1878 */
1879 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1880 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1881 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001882 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001883 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001884 * <p class="note">This is a protected intent that can only be sent
1885 * by the system.
1886 */
1887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1888 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1889 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001890 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1891 * charging state, level, and other information about the battery.
1892 * See {@link android.os.BatteryManager} for documentation on the
1893 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001894 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001895 * <p class="note">
1896 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001897 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001898 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001899 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1900 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1901 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1902 * broadcasts that are sent and can be received through manifest
1903 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001904 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001905 * <p class="note">This is a protected intent that can only be sent
1906 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001907 */
1908 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1909 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1910 /**
1911 * Broadcast Action: Indicates low battery condition on the device.
1912 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001913 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001914 * <p class="note">This is a protected intent that can only be sent
1915 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001916 */
1917 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1918 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1919 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001920 * Broadcast Action: Indicates the battery is now okay after being low.
1921 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1922 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001923 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001924 * <p class="note">This is a protected intent that can only be sent
1925 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1929 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001930 * Broadcast Action: External power has been connected to the device.
1931 * This is intended for applications that wish to register specifically to this notification.
1932 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1933 * stay active to receive this notification. This action can be used to implement actions
1934 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001935 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001938 */
1939 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001940 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001941 /**
1942 * Broadcast Action: External power has been removed from the device.
1943 * This is intended for applications that wish to register specifically to this notification.
1944 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1945 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001946 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001947 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001948 * <p class="note">This is a protected intent that can only be sent
1949 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001950 */
1951 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001952 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001953 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001954 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001955 * Broadcast Action: Device is shutting down.
1956 * This is broadcast when the device is being shut down (completely turned
1957 * off, not sleeping). Once the broadcast is complete, the final shutdown
1958 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001959 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001960 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001961 * <p class="note">This is a protected intent that can only be sent
1962 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001963 * <p>May include the following extras:
1964 * <ul>
1965 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1966 * shutdown is only for userspace processes. If not set, assumed to be false.
1967 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001968 */
1969 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001970 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001971 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001972 * Activity Action: Start this activity to request system shutdown.
1973 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1974 * to request confirmation from the user before shutting down.
1975 *
1976 * <p class="note">This is a protected intent that can only be sent
1977 * by the system.
1978 *
1979 * {@hide}
1980 */
1981 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1982 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001983 * Broadcast Action: A sticky broadcast that indicates low memory
1984 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001985 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001986 * <p class="note">This is a protected intent that can only be sent
1987 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1991 /**
1992 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001993 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001994 * <p class="note">This is a protected intent that can only be sent
1995 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001996 */
1997 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1998 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1999 /**
Jake Hambybb371632010-08-23 18:16:48 -07002000 * Broadcast Action: A sticky broadcast that indicates a memory full
2001 * condition on the device. This is intended for activities that want
2002 * to be able to fill the data partition completely, leaving only
2003 * enough free space to prevent system-wide SQLite failures.
2004 *
2005 * <p class="note">This is a protected intent that can only be sent
2006 * by the system.
2007 *
2008 * {@hide}
2009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
2012 /**
2013 * Broadcast Action: Indicates memory full condition on the device
2014 * no longer exists.
2015 *
2016 * <p class="note">This is a protected intent that can only be sent
2017 * by the system.
2018 *
2019 * {@hide}
2020 */
2021 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2022 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2023 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002024 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2025 * and package management should be started.
2026 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2027 * notification.
2028 */
2029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2030 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2031 /**
2032 * Broadcast Action: The device has entered USB Mass Storage mode.
2033 * This is used mainly for the USB Settings panel.
2034 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2035 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002036 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002037 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002038 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002039 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2040
2041 /**
2042 * Broadcast Action: The device has exited USB Mass Storage mode.
2043 * This is used mainly for the USB Settings panel.
2044 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2045 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002046 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002047 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002048 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002049 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2050
2051 /**
2052 * Broadcast Action: External media has been removed.
2053 * The path to the mount point for the removed media is contained in the Intent.mData field.
2054 */
2055 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2056 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2057
2058 /**
2059 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002060 * 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 -07002061 */
2062 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2063 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2064
2065 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002066 * Broadcast Action: External media is present, and being disk-checked
2067 * 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 -08002068 */
2069 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2070 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2071
2072 /**
2073 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2074 * 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 -08002075 */
2076 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2077 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2078
2079 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002080 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002081 * 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 -07002082 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2083 * media was mounted read only.
2084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2087
2088 /**
2089 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002090 * 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 -07002091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2094
2095 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002096 * Broadcast Action: External media is no longer being shared via USB mass storage.
2097 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2098 *
2099 * @hide
2100 */
2101 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2102
2103 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002104 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2105 * The path to the mount point for the removed media is contained in the Intent.mData field.
2106 */
2107 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2108 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2109
2110 /**
2111 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002112 * 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 -07002113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2116
2117 /**
2118 * Broadcast Action: User has expressed the desire to remove the external storage media.
2119 * Applications should close all files they have open within the mount point when they receive this intent.
2120 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2121 */
2122 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2123 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2124
2125 /**
2126 * Broadcast Action: The media scanner has started scanning a directory.
2127 * The path to the directory being scanned is contained in the Intent.mData field.
2128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2131
2132 /**
2133 * Broadcast Action: The media scanner has finished scanning a directory.
2134 * The path to the scanned directory is contained in the Intent.mData field.
2135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2138
2139 /**
2140 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2141 * The path to the file is contained in the Intent.mData field.
2142 */
2143 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2144 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2145
2146 /**
2147 * Broadcast Action: The "Media Button" was pressed. Includes a single
2148 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2149 * caused the broadcast.
2150 */
2151 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2152 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2153
2154 /**
2155 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2156 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2157 * caused the broadcast.
2158 */
2159 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2160 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2161
2162 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2163 // location; they are not general-purpose actions.
2164
2165 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002166 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002167 */
2168 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2169 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2170 "android.intent.action.GTALK_CONNECTED";
2171
2172 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002173 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002174 */
2175 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2176 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2177 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002178
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002179 /**
2180 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002181 */
2182 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2183 public static final String ACTION_INPUT_METHOD_CHANGED =
2184 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002185
2186 /**
2187 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2188 * more radios have been turned off or on. The intent will have the following extra value:</p>
2189 * <ul>
2190 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2191 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2192 * turned off</li>
2193 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002194 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002195 * <p class="note">This is a protected intent that can only be sent
2196 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002197 */
2198 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2199 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2200
2201 /**
2202 * Broadcast Action: Some content providers have parts of their namespace
2203 * where they publish new events or items that the user may be especially
2204 * interested in. For these things, they may broadcast this action when the
2205 * set of interesting items change.
2206 *
2207 * For example, GmailProvider sends this notification when the set of unread
2208 * mail in the inbox changes.
2209 *
2210 * <p>The data of the intent identifies which part of which provider
2211 * changed. When queried through the content resolver, the data URI will
2212 * return the data set in question.
2213 *
2214 * <p>The intent will have the following extra values:
2215 * <ul>
2216 * <li><em>count</em> - The number of items in the data set. This is the
2217 * same as the number of items in the cursor returned by querying the
2218 * data URI. </li>
2219 * </ul>
2220 *
2221 * This intent will be sent at boot (if the count is non-zero) and when the
2222 * data set changes. It is possible for the data set to change without the
2223 * count changing (for example, if a new unread message arrives in the same
2224 * sync operation in which a message is archived). The phone should still
2225 * ring/vibrate/etc as normal in this case.
2226 */
2227 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2228 public static final String ACTION_PROVIDER_CHANGED =
2229 "android.intent.action.PROVIDER_CHANGED";
2230
2231 /**
2232 * Broadcast Action: Wired Headset plugged in or unplugged.
2233 *
Matt Casey79867f52014-03-26 15:20:25 -07002234 * You <em>cannot</em> receive this through components declared
2235 * in manifests, only by explicitly registering for it with
2236 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2237 * Context.registerReceiver()}.
2238 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002239 * <p>The intent will have the following extra values:
2240 * <ul>
2241 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2242 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002243 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002244 * </ul>
2245 * </ul>
2246 */
2247 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2248 public static final String ACTION_HEADSET_PLUG =
2249 "android.intent.action.HEADSET_PLUG";
2250
2251 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002252 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2253 *
2254 * <p>The intent will have the following extra values:
2255 * <ul>
2256 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2257 * <li><em>name</em> - Headset type, human readable string </li>
2258 * </ul>
2259 * </ul>
2260 * @hide
2261 */
2262 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002263 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2264 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002265
2266 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002267 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002268 *
2269 * <p>The intent will have the following extra values:
2270 * <ul>
2271 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2272 * <li><em>name</em> - Headset type, human readable string </li>
2273 * </ul>
2274 * </ul>
2275 * @hide
2276 */
2277 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002278 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2279 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002280
2281 /**
Jean-Michel Trivi37d78042014-08-10 14:59:15 -07002282 * Broadcast Action: A sticky broadcast indicating an HMDI cable was plugged or unplugged
Praveen Bharathi26e37342010-11-02 19:23:30 -07002283 *
2284 * <p>The intent will have the following extra values:
2285 * <ul>
2286 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2287 * <li><em>name</em> - HDMI cable, human readable string </li>
Jean-Michel Trivi37d78042014-08-10 14:59:15 -07002288 * <li><em>maxChannelCount</em> - the maximum number of output channels supported by the
2289 * connected HDMI device, only available when <i>state</i> is 1.</li>
2290 * <li><em>encodings</em> - an array of formats supported by the connected HDMI device,
2291 * only available when <i>state</i> is 1. Encoding values are defined in
2292 * {@link android.media.AudioFormat} (for instance see
2293 * {@link android.media.AudioFormat#ENCODING_PCM_16BIT}). Use
2294 * {@link #getIntArrayExtra(String)} to retrieve the encoding values.</li>
Praveen Bharathi26e37342010-11-02 19:23:30 -07002295 * </ul>
Praveen Bharathi26e37342010-11-02 19:23:30 -07002296 */
2297 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2298 public static final String ACTION_HDMI_AUDIO_PLUG =
2299 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002300
2301 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002302 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2303 *
2304 * <p>The intent will have the following extra values:
2305 * <ul>
2306 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2307 * <li><em>card</em> - ALSA card number (integer) </li>
2308 * <li><em>device</em> - ALSA device number (integer) </li>
2309 * </ul>
2310 * </ul>
2311 * @hide
2312 */
2313 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2314 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2315 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2316
2317 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002318 * Broadcast Action: A USB audio device was plugged in or unplugged.
2319 *
2320 * <p>The intent will have the following extra values:
2321 * <ul>
2322 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2323 * <li><em>card</em> - ALSA card number (integer) </li>
2324 * <li><em>device</em> - ALSA device number (integer) </li>
2325 * </ul>
2326 * </ul>
2327 * @hide
2328 */
2329 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2330 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2331 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2332
2333 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002334 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2335 * <ul>
2336 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2337 * </ul>
2338 *
2339 * <p class="note">This is a protected intent that can only be sent
2340 * by the system.
2341 *
2342 * @hide
2343 */
2344 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2345 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2346 = "android.intent.action.ADVANCED_SETTINGS";
2347
2348 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002349 * Broadcast Action: Sent after application restrictions are changed.
2350 *
2351 * <p class="note">This is a protected intent that can only be sent
2352 * by the system.</p>
2353 */
2354 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2355 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2356 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2357
2358 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002359 * Broadcast Action: An outgoing call is about to be placed.
2360 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002361 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002362 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002363 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002364 * the phone number originally intended to be dialed.</li>
2365 * </ul>
2366 * <p>Once the broadcast is finished, the resultData is used as the actual
2367 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002368 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002369 * outgoing call in turn: for example, a parental control application
2370 * might verify that the user is authorized to place the call at that
2371 * time, then a number-rewriting application might add an area code if
2372 * one was not specified.</p>
2373 * <p>For consistency, any receiver whose purpose is to prohibit phone
2374 * calls should have a priority of 0, to ensure it will see the final
2375 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002376 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002377 * should have a positive priority.
2378 * Negative priorities are reserved for the system for this broadcast;
2379 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002380 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2381 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002382 * <p>Emergency calls cannot be intercepted using this mechanism, and
2383 * other calls cannot be modified to call emergency numbers using this
2384 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002385 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2386 * call to use their own service instead. Those apps should first prevent
2387 * the call from being placed by setting resultData to <code>null</code>
2388 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002389 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002390 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2391 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002392 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002393 * <p class="note">This is a protected intent that can only be sent
2394 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002395 */
2396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2397 public static final String ACTION_NEW_OUTGOING_CALL =
2398 "android.intent.action.NEW_OUTGOING_CALL";
2399
2400 /**
2401 * Broadcast Action: Have the device reboot. This is only for use by
2402 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002403 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002404 * <p class="note">This is a protected intent that can only be sent
2405 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002406 */
2407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2408 public static final String ACTION_REBOOT =
2409 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002410
Wei Huang97ecc9c2009-05-11 17:44:20 -07002411 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002412 * Broadcast Action: A sticky broadcast for changes in the physical
2413 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002414 *
2415 * <p>The intent will have the following extra values:
2416 * <ul>
2417 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002418 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002419 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002420 * <p>This is intended for monitoring the current physical dock state.
2421 * See {@link android.app.UiModeManager} for the normal API dealing with
2422 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002423 */
2424 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2425 public static final String ACTION_DOCK_EVENT =
2426 "android.intent.action.DOCK_EVENT";
2427
2428 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002429 * Broadcast Action: A broadcast when idle maintenance can be started.
2430 * This means that the user is not interacting with the device and is
2431 * not expected to do so soon. Typical use of the idle maintenance is
2432 * to perform somehow expensive tasks that can be postponed at a moment
2433 * when they will not degrade user experience.
2434 * <p>
2435 * <p class="note">In order to keep the device responsive in case of an
2436 * unexpected user interaction, implementations of a maintenance task
2437 * should be interruptible. In such a scenario a broadcast with action
2438 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2439 * should not do the maintenance work in
2440 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2441 * maintenance service by {@link Context#startService(Intent)}. Also
2442 * you should hold a wake lock while your maintenance service is running
2443 * to prevent the device going to sleep.
2444 * </p>
2445 * <p>
2446 * <p class="note">This is a protected intent that can only be sent by
2447 * the system.
2448 * </p>
2449 *
2450 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002451 *
2452 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002453 */
2454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2455 public static final String ACTION_IDLE_MAINTENANCE_START =
2456 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2457
2458 /**
2459 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2460 * This means that the user was not interacting with the device as a result
2461 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2462 * was sent and now the user started interacting with the device. Typical
2463 * use of the idle maintenance is to perform somehow expensive tasks that
2464 * can be postponed at a moment when they will not degrade user experience.
2465 * <p>
2466 * <p class="note">In order to keep the device responsive in case of an
2467 * unexpected user interaction, implementations of a maintenance task
2468 * should be interruptible. Hence, on receiving a broadcast with this
2469 * action, the maintenance task should be interrupted as soon as possible.
2470 * In other words, you should not do the maintenance work in
2471 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2472 * maintenance service that was started on receiving of
2473 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2474 * lock you acquired when your maintenance service started.
2475 * </p>
2476 * <p class="note">This is a protected intent that can only be sent
2477 * by the system.
2478 *
2479 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002480 *
2481 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002482 */
2483 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2484 public static final String ACTION_IDLE_MAINTENANCE_END =
2485 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2486
2487 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002488 * Broadcast Action: a remote intent is to be broadcasted.
2489 *
2490 * A remote intent is used for remote RPC between devices. The remote intent
2491 * is serialized and sent from one device to another device. The receiving
2492 * device parses the remote intent and broadcasts it. Note that anyone can
2493 * broadcast a remote intent. However, if the intent receiver of the remote intent
2494 * does not trust intent broadcasts from arbitrary intent senders, it should require
2495 * the sender to hold certain permissions so only trusted sender's broadcast will be
2496 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002497 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002498 */
2499 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002500 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002501
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002502 /**
2503 * Broadcast Action: hook for permforming cleanup after a system update.
2504 *
2505 * The broadcast is sent when the system is booting, before the
2506 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2507 * image. A receiver for this should do its work and then disable itself
2508 * so that it does not get run again at the next boot.
2509 * @hide
2510 */
2511 public static final String ACTION_PRE_BOOT_COMPLETED =
2512 "android.intent.action.PRE_BOOT_COMPLETED";
2513
Amith Yamasani13593602012-03-22 16:16:17 -07002514 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002515 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002516 * on restricted users. The broadcast intent contains an extra
2517 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2518 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2519 * String[] depending on the restriction type.<p/>
2520 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002521 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2522 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2523 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002524 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2525 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002526 * @see RestrictionEntry
2527 */
2528 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2529 "android.intent.action.GET_RESTRICTION_ENTRIES";
2530
2531 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002532 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002533 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002534 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2535 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2536 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002537 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2538 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2539 * challenge.<p/>
2540 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002541 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002542 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002543 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2544 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002545
2546 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002547 * Sent the first time a user is starting, to allow system apps to
2548 * perform one time initialization. (This will not be seen by third
2549 * party applications because a newly initialized user does not have any
2550 * third party applications installed for it.) This is sent early in
2551 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002552 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2553 * broadcast, since it is part of a visible user interaction; be as quick
2554 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002555 */
2556 public static final String ACTION_USER_INITIALIZE =
2557 "android.intent.action.USER_INITIALIZE";
2558
2559 /**
2560 * Sent when a user switch is happening, causing the process's user to be
2561 * brought to the foreground. This is only sent to receivers registered
2562 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2563 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002564 * foreground. This is sent as a foreground
2565 * broadcast, since it is part of a visible user interaction; be as quick
2566 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002567 */
2568 public static final String ACTION_USER_FOREGROUND =
2569 "android.intent.action.USER_FOREGROUND";
2570
2571 /**
2572 * Sent when a user switch is happening, causing the process's user to be
2573 * sent to the background. This is only sent to receivers registered
2574 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2575 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002576 * background. This is sent as a foreground
2577 * broadcast, since it is part of a visible user interaction; be as quick
2578 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002579 */
2580 public static final String ACTION_USER_BACKGROUND =
2581 "android.intent.action.USER_BACKGROUND";
2582
2583 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002584 * Broadcast sent to the system when a user is added. Carries an extra
2585 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2586 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002587 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002588 * @hide
2589 */
2590 public static final String ACTION_USER_ADDED =
2591 "android.intent.action.USER_ADDED";
2592
2593 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002594 * Broadcast sent by the system when a user is started. Carries an extra
2595 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002596 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002597 * that has been started. This is sent as a foreground
2598 * broadcast, since it is part of a visible user interaction; be as quick
2599 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002600 * @hide
2601 */
2602 public static final String ACTION_USER_STARTED =
2603 "android.intent.action.USER_STARTED";
2604
2605 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002606 * Broadcast sent when a user is in the process of starting. Carries an extra
2607 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2608 * sent to registered receivers, not manifest receivers. It is sent to all
2609 * users (including the one that is being started). You must hold
2610 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2611 * this broadcast. This is sent as a background broadcast, since
2612 * its result is not part of the primary UX flow; to safely keep track of
2613 * started/stopped state of a user you can use this in conjunction with
2614 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2615 * other user state broadcasts since those are foreground broadcasts so can
2616 * execute in a different order.
2617 * @hide
2618 */
2619 public static final String ACTION_USER_STARTING =
2620 "android.intent.action.USER_STARTING";
2621
2622 /**
2623 * Broadcast sent when a user is going to be stopped. Carries an extra
2624 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2625 * sent to registered receivers, not manifest receivers. It is sent to all
2626 * users (including the one that is being stopped). You must hold
2627 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2628 * this broadcast. The user will not stop until all receivers have
2629 * handled the broadcast. This is sent as a background broadcast, since
2630 * its result is not part of the primary UX flow; to safely keep track of
2631 * started/stopped state of a user you can use this in conjunction with
2632 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2633 * other user state broadcasts since those are foreground broadcasts so can
2634 * execute in a different order.
2635 * @hide
2636 */
2637 public static final String ACTION_USER_STOPPING =
2638 "android.intent.action.USER_STOPPING";
2639
2640 /**
2641 * Broadcast sent to the system when a user is stopped. Carries an extra
2642 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2643 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2644 * specific package. This is only sent to registered receivers, not manifest
2645 * receivers. It is sent to all running users <em>except</em> the one that
2646 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002647 * @hide
2648 */
2649 public static final String ACTION_USER_STOPPED =
2650 "android.intent.action.USER_STOPPED";
2651
2652 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002653 * 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 -07002654 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002655 * one that has been removed. The user will not be completely removed until all receivers have
2656 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002657 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002658 * @hide
2659 */
2660 public static final String ACTION_USER_REMOVED =
2661 "android.intent.action.USER_REMOVED";
2662
2663 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002664 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002665 * the userHandle of the user to become the current one. This is only sent to
2666 * registered receivers, not manifest receivers. It is sent to all running users.
2667 * You must hold
2668 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002669 * @hide
2670 */
2671 public static final String ACTION_USER_SWITCHED =
2672 "android.intent.action.USER_SWITCHED";
2673
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002674 /**
2675 * Broadcast sent to the system when a user's information changes. Carries an extra
2676 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002677 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002678 * @hide
2679 */
2680 public static final String ACTION_USER_INFO_CHANGED =
2681 "android.intent.action.USER_INFO_CHANGED";
2682
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002683 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002684 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2685 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
Adam Connorsd4b584e2014-06-09 13:55:47 +01002686 * the UserHandle of the profile that was added. Only applications (for example Launchers)
2687 * that need to display merged content across both primary and managed profiles need to
2688 * worry about this broadcast. This is only sent to registered receivers,
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002689 * not manifest receivers.
2690 */
2691 public static final String ACTION_MANAGED_PROFILE_ADDED =
2692 "android.intent.action.MANAGED_PROFILE_ADDED";
2693
2694 /**
2695 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
Adam Connorsd4b584e2014-06-09 13:55:47 +01002696 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed.
2697 * Only applications (for example Launchers) that need to display merged content across both
2698 * primary and managed profiles need to worry about this broadcast. This is only sent to
2699 * registered receivers, not manifest receivers.
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002700 */
2701 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2702 "android.intent.action.MANAGED_PROFILE_REMOVED";
2703
2704 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002705 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2706 */
2707 public static final String ACTION_QUICK_CLOCK =
2708 "android.intent.action.QUICK_CLOCK";
2709
Michael Wright0087a142013-02-05 16:29:39 -08002710 /**
Alan Viverette5a399492014-07-14 16:19:38 -07002711 * Activity Action: Shows the brightness setting dialog.
Michael Wright0087a142013-02-05 16:29:39 -08002712 * @hide
2713 */
2714 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2715 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2716
Justin Kohd378ad72013-04-01 12:18:26 -07002717 /**
2718 * Broadcast Action: A global button was pressed. Includes a single
2719 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2720 * caused the broadcast.
2721 * @hide
2722 */
2723 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2724
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002725 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002726 * Activity Action: Allow the user to select and return one or more existing
2727 * documents. When invoked, the system will display the various
2728 * {@link DocumentsProvider} instances installed on the device, letting the
2729 * user interactively navigate through them. These documents include local
2730 * media, such as photos and video, and documents provided by installed
2731 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002732 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002733 * Each document is represented as a {@code content://} URI backed by a
2734 * {@link DocumentsProvider}, which can be opened as a stream with
2735 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2736 * {@link android.provider.DocumentsContract.Document} metadata.
2737 * <p>
2738 * All selected documents are returned to the calling application with
2739 * persistable read and write permission grants. If you want to maintain
2740 * access to the documents across device reboots, you need to explicitly
2741 * take the persistable permissions using
2742 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2743 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002744 * Callers must indicate the acceptable document MIME types through
2745 * {@link #setType(String)}. For example, to select photos, use
2746 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2747 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2748 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002749 * <p>
2750 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002751 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2752 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002753 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002754 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2755 * returned URIs can be opened with
2756 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002757 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002758 * Output: The URI of the item that was picked, returned in
2759 * {@link #getData()}. This must be a {@code content://} URI so that any
2760 * receiver can access it. If multiple documents were selected, they are
2761 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002762 *
2763 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002764 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002765 * @see #ACTION_CREATE_DOCUMENT
2766 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002767 */
2768 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2769 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2770
2771 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002772 * Activity Action: Allow the user to create a new document. When invoked,
2773 * the system will display the various {@link DocumentsProvider} instances
2774 * installed on the device, letting the user navigate through them. The
2775 * returned document may be a newly created document with no content, or it
2776 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002777 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002778 * Each document is represented as a {@code content://} URI backed by a
2779 * {@link DocumentsProvider}, which can be opened as a stream with
2780 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2781 * {@link android.provider.DocumentsContract.Document} metadata.
2782 * <p>
2783 * Callers must indicate the concrete MIME type of the document being
2784 * created by setting {@link #setType(String)}. This MIME type cannot be
2785 * changed after the document is created.
2786 * <p>
2787 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2788 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002789 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002790 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2791 * returned URIs can be opened with
2792 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002793 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002794 * Output: The URI of the item that was created. This must be a
2795 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002796 *
2797 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002798 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002799 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002800 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002801 */
2802 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2803 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2804
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002805 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002806 * Activity Action: Allow the user to pick a directory subtree. When
2807 * invoked, the system will display the various {@link DocumentsProvider}
2808 * instances installed on the device, letting the user navigate through
2809 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002810 * <p>
2811 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002812 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2813 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2814 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002815 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002816 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002817 *
2818 * @see DocumentsContract
2819 */
2820 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002821 public static final String
2822 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002823
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002824 // ---------------------------------------------------------------------
2825 // ---------------------------------------------------------------------
2826 // Standard intent categories (see addCategory()).
2827
2828 /**
2829 * Set if the activity should be an option for the default action
2830 * (center press) to perform on a piece of data. Setting this will
2831 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002832 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002833 * Intent when initiating an action -- it is for use in intent filters
2834 * specified in packages.
2835 */
2836 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2837 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2838 /**
2839 * Activities that can be safely invoked from a browser must support this
2840 * category. For example, if the user is viewing a web page or an e-mail
2841 * and clicks on a link in the text, the Intent generated execute that
2842 * link will require the BROWSABLE category, so that only activities
2843 * supporting this category will be considered as possible actions. By
2844 * supporting this category, you are promising that there is nothing
2845 * damaging (without user intervention) that can happen by invoking any
2846 * matching Intent.
2847 */
2848 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2849 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2850 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07002851 * Categories for activities that can participate in voice interaction.
2852 * An activity that supports this category must be prepared to run with
2853 * no UI shown at all (though in some case it may have a UI shown), and
2854 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2855 */
2856 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2857 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2858 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 * Set if the activity should be considered as an alternative action to
2860 * the data the user is currently viewing. See also
2861 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2862 * applies to the selection in a list of items.
2863 *
2864 * <p>Supporting this category means that you would like your activity to be
2865 * displayed in the set of alternative things the user can do, usually as
2866 * part of the current activity's options menu. You will usually want to
2867 * include a specific label in the &lt;intent-filter&gt; of this action
2868 * describing to the user what it does.
2869 *
2870 * <p>The action of IntentFilter with this category is important in that it
2871 * describes the specific action the target will perform. This generally
2872 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2873 * a specific name such as "com.android.camera.action.CROP. Only one
2874 * alternative of any particular action will be shown to the user, so using
2875 * a specific action like this makes sure that your alternative will be
2876 * displayed while also allowing other applications to provide their own
2877 * overrides of that particular action.
2878 */
2879 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2880 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2881 /**
2882 * Set if the activity should be considered as an alternative selection
2883 * action to the data the user has currently selected. This is like
2884 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2885 * of items from which the user can select, giving them alternatives to the
2886 * default action that will be performed on it.
2887 */
2888 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2889 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2890 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002891 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002892 */
2893 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2894 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2895 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002896 * Should be displayed in the top-level launcher.
2897 */
2898 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2899 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2900 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002901 * Indicates an activity optimized for Leanback mode, and that should
2902 * be displayed in the Leanback launcher.
2903 */
2904 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2905 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2906 /**
Jose Lima73915cf2014-07-29 17:16:31 -07002907 * Indicates a Leanback settings activity to be displayed in the Leanback launcher.
2908 * @hide
2909 */
2910 @SystemApi
2911 public static final String CATEGORY_LEANBACK_SETTINGS = "android.intent.category.LEANBACK_SETTINGS";
2912 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002913 * Provides information about the package it is in; typically used if
2914 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2915 * a front-door to the user without having to be shown in the all apps list.
2916 */
2917 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2918 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2919 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002920 * This is the home activity, that is the first activity that is displayed
2921 * when the device boots.
2922 */
2923 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2924 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2925 /**
2926 * This activity is a preference panel.
2927 */
2928 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2929 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2930 /**
2931 * This activity is a development preference panel.
2932 */
2933 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2934 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2935 /**
2936 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002937 */
2938 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2939 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2940 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002941 * This activity allows the user to browse and download new applications.
2942 */
2943 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2944 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2945 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002946 * This activity may be exercised by the monkey or other automated test tools.
2947 */
2948 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2949 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2950 /**
2951 * To be used as a test (not part of the normal user experience).
2952 */
2953 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2954 /**
2955 * To be used as a unit test (run through the Test Harness).
2956 */
2957 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2958 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002959 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002960 * experience).
2961 */
2962 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002963
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002964 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002965 * Used to indicate that an intent only wants URIs that can be opened with
2966 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2967 * must support at least the columns defined in {@link OpenableColumns} when
2968 * queried.
2969 *
2970 * @see #ACTION_GET_CONTENT
2971 * @see #ACTION_OPEN_DOCUMENT
2972 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002973 */
2974 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2975 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2976
2977 /**
2978 * To be used as code under test for framework instrumentation tests.
2979 */
2980 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2981 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002982 /**
2983 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002984 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2985 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002986 */
2987 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2988 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2989 /**
2990 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002991 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2992 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002993 */
2994 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2995 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002996 /**
2997 * An activity to run when device is inserted into a analog (low end) dock.
2998 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2999 * information, see {@link android.app.UiModeManager}.
3000 */
3001 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3002 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
3003
3004 /**
3005 * An activity to run when device is inserted into a digital (high end) dock.
3006 * Used with {@link #ACTION_MAIN} to launch an activity. For more
3007 * information, see {@link android.app.UiModeManager}.
3008 */
3009 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3010 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003011
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003012 /**
3013 * Used to indicate that the activity can be used in a car environment.
3014 */
3015 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3016 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
3017
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003018 // ---------------------------------------------------------------------
3019 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08003020 // Application launch intent categories (see addCategory()).
3021
3022 /**
3023 * Used with {@link #ACTION_MAIN} to launch the browser application.
3024 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003025 * <p>NOTE: This should not be used as the primary key of an Intent,
3026 * since it will not result in the app launching with the correct
3027 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003028 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003029 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003030 */
3031 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3032 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
3033
3034 /**
3035 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3036 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003037 * <p>NOTE: This should not be used as the primary key of an Intent,
3038 * since it will not result in the app launching with the correct
3039 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003040 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003041 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003042 */
3043 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3044 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3045
3046 /**
3047 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3048 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003049 * <p>NOTE: This should not be used as the primary key of an Intent,
3050 * since it will not result in the app launching with the correct
3051 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003052 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003053 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003054 */
3055 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3056 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3057
3058 /**
3059 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3060 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003061 * <p>NOTE: This should not be used as the primary key of an Intent,
3062 * since it will not result in the app launching with the correct
3063 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003064 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003065 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003066 */
3067 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3068 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
3069
3070 /**
3071 * Used with {@link #ACTION_MAIN} to launch the email application.
3072 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003073 * <p>NOTE: This should not be used as the primary key of an Intent,
3074 * since it will not result in the app launching with the correct
3075 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003076 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003077 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003078 */
3079 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3080 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
3081
3082 /**
3083 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3084 * The activity should be able to view and manipulate image and video files
3085 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003086 * <p>NOTE: This should not be used as the primary key of an Intent,
3087 * since it will not result in the app launching with the correct
3088 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003089 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003090 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003091 */
3092 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3093 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3094
3095 /**
3096 * Used with {@link #ACTION_MAIN} to launch the maps application.
3097 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003098 * <p>NOTE: This should not be used as the primary key of an Intent,
3099 * since it will not result in the app launching with the correct
3100 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003101 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003102 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003103 */
3104 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3105 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3106
3107 /**
3108 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3109 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003110 * <p>NOTE: This should not be used as the primary key of an Intent,
3111 * since it will not result in the app launching with the correct
3112 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003113 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003114 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003115 */
3116 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3117 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3118
3119 /**
3120 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003121 * The activity should be able to play, browse, or manipulate music files
3122 * stored on the device.
3123 * <p>NOTE: This should not be used as the primary key of an Intent,
3124 * since it will not result in the app launching with the correct
3125 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003126 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003127 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003128 */
3129 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3130 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3131
3132 // ---------------------------------------------------------------------
3133 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003134 // Standard extra data keys.
3135
3136 /**
3137 * The initial data to place in a newly created record. Use with
3138 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3139 * fields as would be given to the underlying ContentProvider.insert()
3140 * call.
3141 */
3142 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3143
3144 /**
3145 * A constant CharSequence that is associated with the Intent, used with
3146 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3147 * this may be a styled CharSequence, so you must use
3148 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3149 * retrieve it.
3150 */
3151 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3152
3153 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003154 * A constant String that is associated with the Intent, used with
3155 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3156 * as HTML formatted text. Note that you <em>must</em> also supply
3157 * {@link #EXTRA_TEXT}.
3158 */
3159 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3160
3161 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003162 * A content: URI holding a stream of data associated with the Intent,
3163 * used with {@link #ACTION_SEND} to supply the data being sent.
3164 */
3165 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3166
3167 /**
3168 * A String[] holding e-mail addresses that should be delivered to.
3169 */
3170 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3171
3172 /**
3173 * A String[] holding e-mail addresses that should be carbon copied.
3174 */
3175 public static final String EXTRA_CC = "android.intent.extra.CC";
3176
3177 /**
3178 * A String[] holding e-mail addresses that should be blind carbon copied.
3179 */
3180 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3181
3182 /**
3183 * A constant string holding the desired subject line of a message.
3184 */
3185 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3186
3187 /**
3188 * An Intent describing the choices you would like shown with
3189 * {@link #ACTION_PICK_ACTIVITY}.
3190 */
3191 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3192
3193 /**
3194 * A CharSequence dialog title to provide to the user when used with a
Jay Civelli42feda42014-07-11 14:56:46 -07003195 * {@link #ACTION_CHOOSER} or {@link #ACTION_CONFIRM_DEVICE_CREDENTIAL}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003196 */
3197 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3198
3199 /**
Jay Civelli42feda42014-07-11 14:56:46 -07003200 * A CharSequence description to provide to the user when used with
3201 * {@link #ACTION_CONFIRM_DEVICE_CREDENTIAL}.
3202 */
3203 public static final String EXTRA_DETAILS = "android.intent.extra.DETAILS";
3204
3205 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003206 * A Parcelable[] of {@link Intent} or
3207 * {@link android.content.pm.LabeledIntent} objects as set with
3208 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3209 * a the front of the list of choices, when shown to the user with a
3210 * {@link #ACTION_CHOOSER}.
3211 */
3212 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3213
3214 /**
Adam Powelle49d9392014-07-17 18:45:19 -07003215 * A Bundle forming a mapping of potential target package names to different extras Bundles
3216 * to add to the default intent extras in {@link #EXTRA_INTENT} when used with
3217 * {@link #ACTION_CHOOSER}. Each key should be a package name. The package need not
3218 * be currently installed on the device.
3219 *
3220 * <p>An application may choose to provide alternate extras for the case where a user
3221 * selects an activity from a predetermined set of target packages. If the activity
3222 * the user selects from the chooser belongs to a package with its package name as
3223 * a key in this bundle, the corresponding extras for that package will be merged with
3224 * the extras already present in the intent at {@link #EXTRA_INTENT}. If a replacement
3225 * extra has the same key as an extra already present in the intent it will overwrite
3226 * the extra from the intent.</p>
3227 *
3228 * <p><em>Examples:</em>
3229 * <ul>
3230 * <li>An application may offer different {@link #EXTRA_TEXT} to an application
3231 * when sharing with it via {@link #ACTION_SEND}, augmenting a link with additional query
3232 * parameters for that target.</li>
3233 * <li>An application may offer additional metadata for known targets of a given intent
3234 * to pass along information only relevant to that target such as account or content
3235 * identifiers already known to that application.</li>
3236 * </ul></p>
3237 */
3238 public static final String EXTRA_REPLACEMENT_EXTRAS =
3239 "android.intent.extra.REPLACEMENT_EXTRAS";
3240
3241 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003242 * A {@link android.view.KeyEvent} object containing the event that
3243 * triggered the creation of the Intent it is in.
3244 */
3245 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3246
3247 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003248 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3249 * before shutting down.
3250 *
3251 * {@hide}
3252 */
3253 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3254
3255 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003256 * 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 -07003257 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3258 * of restarting the application.
3259 */
3260 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3261
3262 /**
3263 * A String holding the phone number originally entered in
3264 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3265 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3266 */
3267 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003268
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003269 /**
3270 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3271 * intents to supply the uid the package had been assigned. Also an optional
3272 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3273 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3274 * purpose.
3275 */
3276 public static final String EXTRA_UID = "android.intent.extra.UID";
3277
3278 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003279 * @hide String array of package names.
3280 */
3281 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3282
3283 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003284 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3285 * intents to indicate whether this represents a full uninstall (removing
3286 * both the code and its data) or a partial uninstall (leaving its data,
3287 * implying that this is an update).
3288 */
3289 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003290
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003291 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003292 * @hide
3293 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3294 * intents to indicate that at this point the package has been removed for
3295 * all users on the device.
3296 */
3297 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3298 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3299
3300 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003301 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3302 * intents to indicate that this is a replacement of the package, so this
3303 * broadcast will immediately be followed by an add broadcast for a
3304 * different version of the same package.
3305 */
3306 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003307
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003308 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003309 * Used as an int extra field in {@link android.app.AlarmManager} intents
3310 * to tell the application being invoked how many pending alarms are being
3311 * delievered with the intent. For one-shot alarms this will always be 1.
3312 * For recurring alarms, this might be greater than 1 if the device was
3313 * asleep or powered off at the time an earlier alarm would have been
3314 * delivered.
3315 */
3316 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003317
Jacek Surazski86b6c532009-05-13 14:38:28 +02003318 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003319 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3320 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003321 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3322 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003323 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3324 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3325 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003326 */
3327 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3328
3329 /**
3330 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3331 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003332 */
3333 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3334
3335 /**
3336 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3337 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003338 */
3339 public static final int EXTRA_DOCK_STATE_DESK = 1;
3340
3341 /**
3342 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3343 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003344 */
3345 public static final int EXTRA_DOCK_STATE_CAR = 2;
3346
3347 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003348 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3349 * to represent that the phone is in a analog (low end) dock.
3350 */
3351 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3352
3353 /**
3354 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3355 * to represent that the phone is in a digital (high end) dock.
3356 */
3357 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3358
3359 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003360 * Boolean that can be supplied as meta-data with a dock activity, to
3361 * indicate that the dock should take over the home key when it is active.
3362 */
3363 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003364
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003365 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003366 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3367 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003368 */
3369 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3370
3371 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003372 * Used in the extra field in the remote intent. It's astring token passed with the
3373 * remote intent.
3374 */
3375 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3376 "android.intent.extra.remote_intent_token";
3377
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003378 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003379 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003380 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003381 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003382 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003383 "android.intent.extra.changed_component_name";
3384
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003385 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003386 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003387 * and contains a string array of all of the components that have changed. If
3388 * the state of the overall package has changed, then it will contain an entry
3389 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003390 */
3391 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3392 "android.intent.extra.changed_component_name_list";
3393
3394 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003395 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003396 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3397 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003398 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003399 */
3400 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3401 "android.intent.extra.changed_package_list";
3402
3403 /**
3404 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003405 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3406 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003407 * and contains an integer array of uids of all of the components
3408 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003409 */
3410 public static final String EXTRA_CHANGED_UID_LIST =
3411 "android.intent.extra.changed_uid_list";
3412
3413 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003414 * @hide
3415 * Magic extra system code can use when binding, to give a label for
3416 * who it is that has bound to a service. This is an integer giving
3417 * a framework string resource that can be displayed to the user.
3418 */
3419 public static final String EXTRA_CLIENT_LABEL =
3420 "android.intent.extra.client_label";
3421
3422 /**
3423 * @hide
3424 * Magic extra system code can use when binding, to give a PendingIntent object
3425 * that can be launched for the user to disable the system's use of this
3426 * service.
3427 */
3428 public static final String EXTRA_CLIENT_INTENT =
3429 "android.intent.extra.client_intent";
3430
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003431 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003432 * Extra used to indicate that an intent should only return data that is on
3433 * the local device. This is a boolean extra; the default is false. If true,
3434 * an implementation should only allow the user to select data that is
3435 * already on the device, not requiring it be downloaded from a remote
3436 * service when opened.
3437 *
3438 * @see #ACTION_GET_CONTENT
3439 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003440 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003441 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003442 */
3443 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003444 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003445
Amith Yamasani13593602012-03-22 16:16:17 -07003446 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003447 * Extra used to indicate that an intent can allow the user to select and
3448 * return multiple items. This is a boolean extra; the default is false. If
3449 * true, an implementation is allowed to present the user with a UI where
3450 * they can pick multiple items that are all returned to the caller. When
3451 * this happens, they should be returned as the {@link #getClipData()} part
3452 * of the result Intent.
3453 *
3454 * @see #ACTION_GET_CONTENT
3455 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003456 */
3457 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003458 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003459
3460 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003461 * The integer userHandle carried with broadcast intents related to addition, removal and
3462 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3463 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3464 *
Amith Yamasani13593602012-03-22 16:16:17 -07003465 * @hide
3466 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003467 public static final String EXTRA_USER_HANDLE =
3468 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003469
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003470 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003471 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3472 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3473 */
3474 public static final String EXTRA_USER =
3475 "android.intent.extra.user";
3476
3477 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003478 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003479 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3480 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003481 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003482 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3483
3484 /**
3485 * Extra sent in the intent to the BroadcastReceiver that handles
3486 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3487 * the restrictions as key/value pairs.
3488 */
3489 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3490 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003491
Amith Yamasani86118ba2013-03-28 14:33:16 -07003492 /**
3493 * Extra used in the response from a BroadcastReceiver that handles
3494 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3495 */
3496 public static final String EXTRA_RESTRICTIONS_INTENT =
3497 "android.intent.extra.restrictions_intent";
3498
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003499 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003500 * Extra used to communicate a set of acceptable MIME types. The type of the
3501 * extra is {@code String[]}. Values may be a combination of concrete MIME
3502 * types (such as "image/png") and/or partial MIME types (such as
3503 * "audio/*").
3504 *
3505 * @see #ACTION_GET_CONTENT
3506 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003507 */
3508 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3509
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003510 /**
3511 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3512 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003513 * When this is true, hardware devices can use this information to determine that
3514 * they shouldn't do a complete shutdown of their device since this is not a
3515 * complete shutdown down to the kernel, but only user space restarting.
3516 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003517 */
3518 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3519 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3520
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003521 /**
3522 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3523 * user has set their time format preferences to the 24 hour format.
3524 *
3525 * @hide for internal use only.
3526 */
3527 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3528 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3529
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003530 // ---------------------------------------------------------------------
3531 // ---------------------------------------------------------------------
3532 // Intent flags (see mFlags variable).
3533
Tor Norbyed9273d62013-05-30 15:59:53 -07003534 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003535 @IntDef(flag = true, value = {
3536 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3537 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003538 @Retention(RetentionPolicy.SOURCE)
3539 public @interface GrantUriMode {}
3540
Jeff Sharkey846318a2014-04-04 12:12:41 -07003541 /** @hide */
3542 @IntDef(flag = true, value = {
3543 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3544 @Retention(RetentionPolicy.SOURCE)
3545 public @interface AccessUriMode {}
3546
3547 /**
3548 * Test if given mode flags specify an access mode, which must be at least
3549 * read and/or write.
3550 *
3551 * @hide
3552 */
3553 public static boolean isAccessUriMode(int modeFlags) {
3554 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3555 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3556 }
3557
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003558 /**
3559 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003560 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003561 * specified in its ClipData. When applying to an Intent's ClipData,
3562 * all URIs as well as recursive traversals through data or other ClipData
3563 * in Intent items will be granted; only the grant flags of the top-level
3564 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003565 */
3566 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3567 /**
3568 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003569 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003570 * specified in its ClipData. When applying to an Intent's ClipData,
3571 * all URIs as well as recursive traversals through data or other ClipData
3572 * in Intent items will be granted; only the grant flags of the top-level
3573 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003574 */
3575 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3576 /**
3577 * Can be set by the caller to indicate that this Intent is coming from
3578 * a background operation, not from direct user interaction.
3579 */
3580 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3581 /**
3582 * A flag you can enable for debugging: when set, log messages will be
3583 * printed during the resolution of this intent to show you what has
3584 * been found to create the final resolved list.
3585 */
3586 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003587 /**
3588 * If set, this intent will not match any components in packages that
3589 * are currently stopped. If this is not set, then the default behavior
3590 * is to include such applications in the result.
3591 */
3592 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3593 /**
3594 * If set, this intent will always match any components in packages that
3595 * are currently stopped. This is the default behavior when
3596 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3597 * flags are set, this one wins (it allows overriding of exclude for
3598 * places where the framework may automatically set the exclude flag).
3599 */
3600 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003601
3602 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003603 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003604 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003605 * persisted across device reboots until explicitly revoked with
3606 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3607 * grant for possible persisting; the receiving application must call
3608 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3609 * actually persist.
3610 *
3611 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3612 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3613 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003614 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003615 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003616 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003617
3618 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003619 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3620 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3621 * applies to any URI that is a prefix match against the original granted
3622 * URI. (Without this flag, the URI must match exactly for access to be
3623 * granted.) Another URI is considered a prefix match only when scheme,
3624 * authority, and all path segments defined by the prefix are an exact
3625 * match.
3626 */
3627 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3628
3629 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003630 * If set, the new activity is not kept in the history stack. As soon as
3631 * the user navigates away from it, the activity is finished. This may also
3632 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3633 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 */
3635 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3636 /**
3637 * If set, the activity will not be launched if it is already running
3638 * at the top of the history stack.
3639 */
3640 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3641 /**
3642 * If set, this activity will become the start of a new task on this
3643 * history stack. A task (from the activity that started it to the
3644 * next task activity) defines an atomic group of activities that the
3645 * user can move to. Tasks can be moved to the foreground and background;
3646 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003647 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003648 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3649 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003650 *
3651 * <p>This flag is generally used by activities that want
3652 * to present a "launcher" style behavior: they give the user a list of
3653 * separate things that can be done, which otherwise run completely
3654 * independently of the activity launching them.
3655 *
3656 * <p>When using this flag, if a task is already running for the activity
3657 * you are now starting, then a new activity will not be started; instead,
3658 * the current task will simply be brought to the front of the screen with
3659 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3660 * to disable this behavior.
3661 *
3662 * <p>This flag can not be used when the caller is requesting a result from
3663 * the activity being launched.
3664 */
3665 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3666 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003667 * This flag is used to create a new task and launch an activity into it.
3668 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3669 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3670 * search through existing tasks for ones matching this Intent. Only if no such
3671 * task is found would a new task be created. When paired with
3672 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3673 * the search for a matching task and unconditionally start a new task.
3674 *
3675 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3676 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677 * top-level application launcher.</strong> Used in conjunction with
3678 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3679 * behavior of bringing an existing task to the foreground. When set,
3680 * a new task is <em>always</em> started to host the Activity for the
3681 * Intent, regardless of whether there is already an existing task running
3682 * the same thing.
3683 *
3684 * <p><strong>Because the default system does not include graphical task management,
3685 * you should not use this flag unless you provide some way for a user to
3686 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003687 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003688 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3689 * creating new document tasks.
3690 *
3691 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3692 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003693 *
Scott Main7aee61f2011-02-08 11:25:01 -08003694 * <p>See
3695 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3696 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003697 *
3698 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3699 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003700 */
3701 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3702 /**
3703 * If set, and the activity being launched is already running in the
3704 * current task, then instead of launching a new instance of that activity,
3705 * all of the other activities on top of it will be closed and this Intent
3706 * will be delivered to the (now on top) old activity as a new Intent.
3707 *
3708 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3709 * If D calls startActivity() with an Intent that resolves to the component
3710 * of activity B, then C and D will be finished and B receive the given
3711 * Intent, resulting in the stack now being: A, B.
3712 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003713 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003714 * either receive the new intent you are starting here in its
3715 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003716 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003717 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3718 * the same intent, then it will be finished and re-created; for all other
3719 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3720 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003721 *
3722 * <p>This launch mode can also be used to good effect in conjunction with
3723 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3724 * of a task, it will bring any currently running instance of that task
3725 * to the foreground, and then clear it to its root state. This is
3726 * especially useful, for example, when launching an activity from the
3727 * notification manager.
3728 *
Scott Main7aee61f2011-02-08 11:25:01 -08003729 * <p>See
3730 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3731 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003732 */
3733 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3734 /**
3735 * If set and this intent is being used to launch a new activity from an
3736 * existing one, then the reply target of the existing activity will be
3737 * transfered to the new activity. This way the new activity can call
3738 * {@link android.app.Activity#setResult} and have that result sent back to
3739 * the reply target of the original activity.
3740 */
3741 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3742 /**
3743 * If set and this intent is being used to launch a new activity from an
3744 * existing one, the current activity will not be counted as the top
3745 * activity for deciding whether the new intent should be delivered to
3746 * the top instead of starting a new one. The previous activity will
3747 * be used as the top, with the assumption being that the current activity
3748 * will finish itself immediately.
3749 */
3750 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3751 /**
3752 * If set, the new activity is not kept in the list of recently launched
3753 * activities.
3754 */
3755 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3756 /**
3757 * This flag is not normally set by application code, but set for you by
3758 * the system as described in the
3759 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3760 * launchMode} documentation for the singleTask mode.
3761 */
3762 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3763 /**
3764 * If set, and this activity is either being started in a new task or
3765 * bringing to the top an existing task, then it will be launched as
3766 * the front door of the task. This will result in the application of
3767 * any affinities needed to have that task in the proper state (either
3768 * moving activities to or from it), or simply resetting that task to
3769 * its initial state if needed.
3770 */
3771 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3772 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003773 * This flag is not normally set by application code, but set for you by
3774 * the system if this activity is being launched from history
3775 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003776 */
3777 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003778 /**
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003779 * @deprecated As of API 21 this performs identically to
3780 * {@link #FLAG_ACTIVITY_NEW_DOCUMENT} which should be used instead of this.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003781 */
3782 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003783 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003784 * This flag is used to open a document into a new task rooted at the activity launched
3785 * by this Intent. Through the use of this flag, or its equivalent attribute,
3786 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3787 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003788 *
Craig Mautner026596b2014-05-21 15:35:44 -07003789 * <p>The use of the activity attribute form of this,
3790 * {@link android.R.attr#documentLaunchMode}, is
3791 * preferred over the Intent flag described here. The attribute form allows the
3792 * Activity to specify multiple document behavior for all launchers of the Activity
3793 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003794 *
Dianne Hackborn13420f22014-07-18 15:43:56 -07003795 * <p>Note that the default semantics of this flag w.r.t. whether the recents entry for
3796 * it is kept after the activity is finished is different than the use of
3797 * {@link #FLAG_ACTIVITY_NEW_TASK} and {@link android.R.attr#documentLaunchMode} -- if
3798 * this flag is being used to create a new recents entry, then by default that entry
3799 * will be removed once the activity is finished. You can modify this behavior with
3800 * {@link #FLAG_ACTIVITY_RETAIN_IN_RECENTS}.
3801 *
Craig Mautner026596b2014-05-21 15:35:44 -07003802 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3803 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3804 * equivalent of the Activity manifest specifying {@link
3805 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3806 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3807 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003808 *
Craig Mautner026596b2014-05-21 15:35:44 -07003809 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003810 *
Craig Mautner026596b2014-05-21 15:35:44 -07003811 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003812 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3813 */
Craig Mautnerf357c0c2014-06-09 09:23:27 -07003814 public static final int FLAG_ACTIVITY_NEW_DOCUMENT = FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET;
Craig Mautnerd00f4742014-03-12 14:17:26 -07003815 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003816 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003817 * callback from occurring on the current frontmost activity before it is
3818 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003819 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003820 * <p>Typically, an activity can rely on that callback to indicate that an
3821 * explicit user action has caused their activity to be moved out of the
3822 * foreground. The callback marks an appropriate point in the activity's
3823 * lifecycle for it to dismiss any notifications that it intends to display
3824 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003825 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003826 * <p>If an activity is ever started via any non-user-driven events such as
3827 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3828 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003829 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003830 */
3831 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003832 /**
3833 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3834 * this flag will cause the launched activity to be brought to the front of its
3835 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003836 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003837 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3838 * If D calls startActivity() with an Intent that resolves to the component
3839 * of activity B, then B will be brought to the front of the history stack,
3840 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003841 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003842 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003843 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003844 */
3845 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003846 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003847 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3848 * this flag will prevent the system from applying an activity transition
3849 * animation to go to the next activity state. This doesn't mean an
3850 * animation will never run -- if another activity change happens that doesn't
3851 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003852 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003853 * when you are going to do a series of activity operations but the
3854 * animation seen by the user shouldn't be driven by the first activity
3855 * change but rather a later one.
3856 */
3857 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3858 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003859 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3860 * this flag will cause any existing task that would be associated with the
3861 * activity to be cleared before the activity is started. That is, the activity
3862 * becomes the new root of an otherwise empty task, and any old activities
3863 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3864 */
3865 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3866 /**
3867 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3868 * this flag will cause a newly launching task to be placed on top of the current
3869 * home activity task (if there is one). That is, pressing back from the task
3870 * will always return the user to home even if that was not the last activity they
3871 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3872 */
3873 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3874 /**
Dianne Hackborn13420f22014-07-18 15:43:56 -07003875 * By default a document created by {@link #FLAG_ACTIVITY_NEW_DOCUMENT} will
3876 * have its entry in recent tasks removed when the user closes it (with back
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003877 * or however else it may finish()). If you would like to instead allow the
Dianne Hackborn13420f22014-07-18 15:43:56 -07003878 * document to be kept in recents so that it can be re-launched, you can use
Jeff Sharkey9f991a22014-08-13 11:37:41 -07003879 * this flag. When set and the task's activity is finished, the recents
3880 * entry will remain in the interface for the user to re-launch it, like a
3881 * recents entry for a top-level application.
3882 * <p>
3883 * The receiving activity can override this request with
3884 * {@link android.R.attr#autoRemoveFromRecents} or by explcitly calling
3885 * {@link android.app.Activity#finishAndRemoveTask()
Dianne Hackborn13420f22014-07-18 15:43:56 -07003886 * Activity.finishAndRemoveTask()}.
Craig Mautner2dac0562014-05-06 09:06:44 -07003887 */
Dianne Hackborn13420f22014-07-18 15:43:56 -07003888 public static final int FLAG_ACTIVITY_RETAIN_IN_RECENTS = 0x00002000;
Craig Mautnera228ae92014-07-09 05:44:55 -07003889
3890 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003891 * If set, when sending a broadcast only registered receivers will be
3892 * called -- no BroadcastReceiver components will be launched.
3893 */
3894 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003895 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003896 * If set, when sending a broadcast the new broadcast will replace
3897 * any existing pending broadcast that matches it. Matching is defined
3898 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3899 * true for the intents of the two broadcasts. When a match is found,
3900 * the new broadcast (and receivers associated with it) will replace the
3901 * existing one in the pending broadcast list, remaining at the same
3902 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003903 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003904 * <p>This flag is most typically used with sticky broadcasts, which
3905 * only care about delivering the most recent values of the broadcast
3906 * to their receivers.
3907 */
3908 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3909 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003910 * If set, when sending a broadcast the recipient is allowed to run at
3911 * foreground priority, with a shorter timeout interval. During normal
3912 * broadcasts the receivers are not automatically hoisted out of the
3913 * background priority class.
3914 */
3915 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3916 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003917 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3918 * They can still propagate results through to later receivers, but they can not prevent
3919 * later receivers from seeing the broadcast.
3920 */
3921 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3922 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003923 * If set, when sending a broadcast <i>before boot has completed</i> only
3924 * registered receivers will be called -- no BroadcastReceiver components
3925 * will be launched. Sticky intent state will be recorded properly even
3926 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3927 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003928 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003929 * <p>This flag is only for use by system sevices as a convenience to
3930 * avoid having to implement a more complex mechanism around detection
3931 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003932 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003933 * @hide
3934 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003935 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003936 /**
3937 * Set when this broadcast is for a boot upgrade, a special mode that
3938 * allows the broadcast to be sent before the system is ready and launches
3939 * the app process with no providers running in it.
3940 * @hide
3941 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003942 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003943
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003944 /**
3945 * @hide Flags that can't be changed with PendingIntent.
3946 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003947 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3948 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3949 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003950
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003951 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003952 // ---------------------------------------------------------------------
3953 // toUri() and parseUri() options.
3954
3955 /**
3956 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3957 * always has the "intent:" scheme. This syntax can be used when you want
3958 * to later disambiguate between URIs that are intended to describe an
3959 * Intent vs. all others that should be treated as raw URIs. When used
3960 * with {@link #parseUri}, any other scheme will result in a generic
3961 * VIEW action for that raw URI.
3962 */
3963 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003964
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003965 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003966
3967 private String mAction;
3968 private Uri mData;
3969 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003970 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003971 private ComponentName mComponent;
3972 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003973 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003974 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003975 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003976 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003977 private ClipData mClipData;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003978 private int mContentUserHint = UserHandle.USER_CURRENT;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003979
3980 // ---------------------------------------------------------------------
3981
3982 /**
3983 * Create an empty intent.
3984 */
3985 public Intent() {
3986 }
3987
3988 /**
3989 * Copy constructor.
3990 */
3991 public Intent(Intent o) {
3992 this.mAction = o.mAction;
3993 this.mData = o.mData;
3994 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003995 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003996 this.mComponent = o.mComponent;
3997 this.mFlags = o.mFlags;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01003998 this.mContentUserHint = o.mContentUserHint;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003999 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004000 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004001 }
4002 if (o.mExtras != null) {
4003 this.mExtras = new Bundle(o.mExtras);
4004 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004005 if (o.mSourceBounds != null) {
4006 this.mSourceBounds = new Rect(o.mSourceBounds);
4007 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004008 if (o.mSelector != null) {
4009 this.mSelector = new Intent(o.mSelector);
4010 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004011 if (o.mClipData != null) {
4012 this.mClipData = new ClipData(o.mClipData);
4013 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004014 }
4015
4016 @Override
4017 public Object clone() {
4018 return new Intent(this);
4019 }
4020
4021 private Intent(Intent o, boolean all) {
4022 this.mAction = o.mAction;
4023 this.mData = o.mData;
4024 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004025 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004026 this.mComponent = o.mComponent;
4027 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07004028 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004029 }
4030 }
4031
4032 /**
4033 * Make a clone of only the parts of the Intent that are relevant for
4034 * filter matching: the action, data, type, component, and categories.
4035 */
4036 public Intent cloneFilter() {
4037 return new Intent(this, false);
4038 }
4039
4040 /**
4041 * Create an intent with a given action. All other fields (data, type,
4042 * class) are null. Note that the action <em>must</em> be in a
4043 * namespace because Intents are used globally in the system -- for
4044 * example the system VIEW action is android.intent.action.VIEW; an
4045 * application's custom action would be something like
4046 * com.google.app.myapp.CUSTOM_ACTION.
4047 *
4048 * @param action The Intent action, such as ACTION_VIEW.
4049 */
4050 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004051 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004052 }
4053
4054 /**
4055 * Create an intent with a given action and for a given data url. Note
4056 * that the action <em>must</em> be in a namespace because Intents are
4057 * used globally in the system -- for example the system VIEW action is
4058 * android.intent.action.VIEW; an application's custom action would be
4059 * something like com.google.app.myapp.CUSTOM_ACTION.
4060 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004061 * <p><em>Note: scheme and host name matching in the Android framework is
4062 * case-sensitive, unlike the formal RFC. As a result,
4063 * you should always ensure that you write your Uri with these elements
4064 * using lower case letters, and normalize any Uris you receive from
4065 * outside of Android to ensure the scheme and host is lower case.</em></p>
4066 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004067 * @param action The Intent action, such as ACTION_VIEW.
4068 * @param uri The Intent data URI.
4069 */
4070 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004071 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004072 mData = uri;
4073 }
4074
4075 /**
4076 * Create an intent for a specific component. All other fields (action, data,
4077 * type, class) are null, though they can be modified later with explicit
4078 * calls. This provides a convenient way to create an intent that is
4079 * intended to execute a hard-coded class name, rather than relying on the
4080 * system to find an appropriate class for you; see {@link #setComponent}
4081 * for more information on the repercussions of this.
4082 *
4083 * @param packageContext A Context of the application package implementing
4084 * this class.
4085 * @param cls The component class that is to be used for the intent.
4086 *
4087 * @see #setClass
4088 * @see #setComponent
4089 * @see #Intent(String, android.net.Uri , Context, Class)
4090 */
4091 public Intent(Context packageContext, Class<?> cls) {
4092 mComponent = new ComponentName(packageContext, cls);
4093 }
4094
4095 /**
4096 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004097 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004098 * construct the Intent and then calling {@link #setClass} to set its
4099 * class.
4100 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004101 * <p><em>Note: scheme and host name matching in the Android framework is
4102 * case-sensitive, unlike the formal RFC. As a result,
4103 * you should always ensure that you write your Uri with these elements
4104 * using lower case letters, and normalize any Uris you receive from
4105 * outside of Android to ensure the scheme and host is lower case.</em></p>
4106 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004107 * @param action The Intent action, such as ACTION_VIEW.
4108 * @param uri The Intent data URI.
4109 * @param packageContext A Context of the application package implementing
4110 * this class.
4111 * @param cls The component class that is to be used for the intent.
4112 *
4113 * @see #Intent(String, android.net.Uri)
4114 * @see #Intent(Context, Class)
4115 * @see #setClass
4116 * @see #setComponent
4117 */
4118 public Intent(String action, Uri uri,
4119 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004120 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004121 mData = uri;
4122 mComponent = new ComponentName(packageContext, cls);
4123 }
4124
4125 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004126 * Create an intent to launch the main (root) activity of a task. This
4127 * is the Intent that is started when the application's is launched from
4128 * Home. For anything else that wants to launch an application in the
4129 * same way, it is important that they use an Intent structured the same
4130 * way, and can use this function to ensure this is the case.
4131 *
4132 * <p>The returned Intent has the given Activity component as its explicit
4133 * component, {@link #ACTION_MAIN} as its action, and includes the
4134 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4135 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4136 * to do that through {@link #addFlags(int)} on the returned Intent.
4137 *
4138 * @param mainActivity The main activity component that this Intent will
4139 * launch.
4140 * @return Returns a newly created Intent that can be used to launch the
4141 * activity as a main application entry.
4142 *
4143 * @see #setClass
4144 * @see #setComponent
4145 */
4146 public static Intent makeMainActivity(ComponentName mainActivity) {
4147 Intent intent = new Intent(ACTION_MAIN);
4148 intent.setComponent(mainActivity);
4149 intent.addCategory(CATEGORY_LAUNCHER);
4150 return intent;
4151 }
4152
4153 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004154 * Make an Intent for the main activity of an application, without
4155 * specifying a specific activity to run but giving a selector to find
4156 * the activity. This results in a final Intent that is structured
4157 * the same as when the application is launched from
4158 * Home. For anything else that wants to launch an application in the
4159 * same way, it is important that they use an Intent structured the same
4160 * way, and can use this function to ensure this is the case.
4161 *
4162 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4163 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4164 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4165 * to do that through {@link #addFlags(int)} on the returned Intent.
4166 *
4167 * @param selectorAction The action name of the Intent's selector.
4168 * @param selectorCategory The name of a category to add to the Intent's
4169 * selector.
4170 * @return Returns a newly created Intent that can be used to launch the
4171 * activity as a main application entry.
4172 *
4173 * @see #setSelector(Intent)
4174 */
4175 public static Intent makeMainSelectorActivity(String selectorAction,
4176 String selectorCategory) {
4177 Intent intent = new Intent(ACTION_MAIN);
4178 intent.addCategory(CATEGORY_LAUNCHER);
4179 Intent selector = new Intent();
4180 selector.setAction(selectorAction);
4181 selector.addCategory(selectorCategory);
4182 intent.setSelector(selector);
4183 return intent;
4184 }
4185
4186 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004187 * Make an Intent that can be used to re-launch an application's task
4188 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4189 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4190 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4191 *
4192 * @param mainActivity The activity component that is the root of the
4193 * task; this is the activity that has been published in the application's
4194 * manifest as the main launcher icon.
4195 *
4196 * @return Returns a newly created Intent that can be used to relaunch the
4197 * activity's task in its root state.
4198 */
4199 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4200 Intent intent = makeMainActivity(mainActivity);
4201 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4202 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4203 return intent;
4204 }
4205
4206 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004207 * Call {@link #parseUri} with 0 flags.
4208 * @deprecated Use {@link #parseUri} instead.
4209 */
4210 @Deprecated
4211 public static Intent getIntent(String uri) throws URISyntaxException {
4212 return parseUri(uri, 0);
4213 }
Tom Taylord4a47292009-12-21 13:59:18 -08004214
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004215 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004216 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004217 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004218 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004219 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004220 *
4221 * <p>The URI given here must not be relative -- that is, it must include
4222 * the scheme and full path.
4223 *
4224 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004225 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004226 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004227 *
4228 * @return Intent The newly created Intent object.
4229 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004230 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4231 * it bad (as parsed by the Uri class) or the Intent data within the
4232 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004233 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004234 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004235 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004236 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004237 int i = 0;
4238 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004239 // Validate intent scheme for if requested.
4240 if ((flags&URI_INTENT_SCHEME) != 0) {
4241 if (!uri.startsWith("intent:")) {
4242 Intent intent = new Intent(ACTION_VIEW);
4243 try {
4244 intent.setData(Uri.parse(uri));
4245 } catch (IllegalArgumentException e) {
4246 throw new URISyntaxException(uri, e.getMessage());
4247 }
4248 return intent;
4249 }
4250 }
Tom Taylord4a47292009-12-21 13:59:18 -08004251
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004252 // simple case
4253 i = uri.lastIndexOf("#");
4254 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4255
4256 // old format Intent URI
4257 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004258
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004259 // new format
4260 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004261 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004262
4263 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004264 String data = i >= 0 ? uri.substring(0, i) : null;
4265 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004266 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004267
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004268 // loop over contents of Intent, all name=value;
4269 while (!uri.startsWith("end", i)) {
4270 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004271 if (eq < 0) eq = i-1;
4272 int semi = uri.indexOf(';', i);
4273 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004274
4275 // action
4276 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004277 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004278 }
4279
4280 // categories
4281 else if (uri.startsWith("category=", i)) {
4282 intent.addCategory(value);
4283 }
4284
4285 // type
4286 else if (uri.startsWith("type=", i)) {
4287 intent.mType = value;
4288 }
4289
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004290 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004291 else if (uri.startsWith("launchFlags=", i)) {
4292 intent.mFlags = Integer.decode(value).intValue();
4293 }
4294
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004295 // package
4296 else if (uri.startsWith("package=", i)) {
4297 intent.mPackage = value;
4298 }
4299
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004300 // component
4301 else if (uri.startsWith("component=", i)) {
4302 intent.mComponent = ComponentName.unflattenFromString(value);
4303 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004304
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004305 // scheme
4306 else if (uri.startsWith("scheme=", i)) {
4307 scheme = value;
4308 }
4309
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004310 // source bounds
4311 else if (uri.startsWith("sourceBounds=", i)) {
4312 intent.mSourceBounds = Rect.unflattenFromString(value);
4313 }
4314
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004315 // selector
4316 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4317 intent = new Intent();
4318 }
4319
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004320 // extra
4321 else {
4322 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004323 // create Bundle if it doesn't already exist
4324 if (intent.mExtras == null) intent.mExtras = new Bundle();
4325 Bundle b = intent.mExtras;
4326 // add EXTRA
4327 if (uri.startsWith("S.", i)) b.putString(key, value);
4328 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4329 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4330 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4331 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4332 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4333 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4334 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4335 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4336 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4337 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004338
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004339 // move to the next item
4340 i = semi + 1;
4341 }
4342
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004343 if (intent != baseIntent) {
4344 // The Intent had a selector; fix it up.
4345 baseIntent.setSelector(intent);
4346 intent = baseIntent;
4347 }
4348
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004349 if (data != null) {
4350 if (data.startsWith("intent:")) {
4351 data = data.substring(7);
4352 if (scheme != null) {
4353 data = scheme + ':' + data;
4354 }
4355 }
Tom Taylord4a47292009-12-21 13:59:18 -08004356
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004357 if (data.length() > 0) {
4358 try {
4359 intent.mData = Uri.parse(data);
4360 } catch (IllegalArgumentException e) {
4361 throw new URISyntaxException(uri, e.getMessage());
4362 }
4363 }
4364 }
Tom Taylord4a47292009-12-21 13:59:18 -08004365
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004366 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004367
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004368 } catch (IndexOutOfBoundsException e) {
4369 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4370 }
4371 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004372
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004373 public static Intent getIntentOld(String uri) throws URISyntaxException {
4374 Intent intent;
4375
4376 int i = uri.lastIndexOf('#');
4377 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004378 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004379 final int intentFragmentStart = i;
4380 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004381
4382 i++;
4383
4384 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004385 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004386 i += 7;
4387 int j = uri.indexOf(')', i);
4388 action = uri.substring(i, j);
4389 i = j + 1;
4390 }
4391
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004392 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004393
4394 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004395 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004396 i += 11;
4397 int j = uri.indexOf(')', i);
4398 while (i < j) {
4399 int sep = uri.indexOf('!', i);
4400 if (sep < 0) sep = j;
4401 if (i < sep) {
4402 intent.addCategory(uri.substring(i, sep));
4403 }
4404 i = sep + 1;
4405 }
4406 i = j + 1;
4407 }
4408
4409 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004410 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004411 i += 5;
4412 int j = uri.indexOf(')', i);
4413 intent.mType = uri.substring(i, j);
4414 i = j + 1;
4415 }
4416
4417 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004418 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004419 i += 12;
4420 int j = uri.indexOf(')', i);
4421 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4422 i = j + 1;
4423 }
4424
4425 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004426 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004427 i += 10;
4428 int j = uri.indexOf(')', i);
4429 int sep = uri.indexOf('!', i);
4430 if (sep >= 0 && sep < j) {
4431 String pkg = uri.substring(i, sep);
4432 String cls = uri.substring(sep + 1, j);
4433 intent.mComponent = new ComponentName(pkg, cls);
4434 }
4435 i = j + 1;
4436 }
4437
4438 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004439 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004440 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004441
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004442 final int closeParen = uri.indexOf(')', i);
4443 if (closeParen == -1) throw new URISyntaxException(uri,
4444 "EXTRA missing trailing ')'", i);
4445
4446 while (i < closeParen) {
4447 // fetch the key value
4448 int j = uri.indexOf('=', i);
4449 if (j <= i + 1 || i >= closeParen) {
4450 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4451 }
4452 char type = uri.charAt(i);
4453 i++;
4454 String key = uri.substring(i, j);
4455 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004456
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004457 // get type-value
4458 j = uri.indexOf('!', i);
4459 if (j == -1 || j >= closeParen) j = closeParen;
4460 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4461 String value = uri.substring(i, j);
4462 i = j;
4463
4464 // create Bundle if it doesn't already exist
4465 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004466
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004467 // add item to bundle
4468 try {
4469 switch (type) {
4470 case 'S':
4471 intent.mExtras.putString(key, Uri.decode(value));
4472 break;
4473 case 'B':
4474 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4475 break;
4476 case 'b':
4477 intent.mExtras.putByte(key, Byte.parseByte(value));
4478 break;
4479 case 'c':
4480 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4481 break;
4482 case 'd':
4483 intent.mExtras.putDouble(key, Double.parseDouble(value));
4484 break;
4485 case 'f':
4486 intent.mExtras.putFloat(key, Float.parseFloat(value));
4487 break;
4488 case 'i':
4489 intent.mExtras.putInt(key, Integer.parseInt(value));
4490 break;
4491 case 'l':
4492 intent.mExtras.putLong(key, Long.parseLong(value));
4493 break;
4494 case 's':
4495 intent.mExtras.putShort(key, Short.parseShort(value));
4496 break;
4497 default:
4498 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4499 }
4500 } catch (NumberFormatException e) {
4501 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4502 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004503
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004504 char ch = uri.charAt(i);
4505 if (ch == ')') break;
4506 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4507 i++;
4508 }
4509 }
4510
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004511 if (isIntentFragment) {
4512 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4513 } else {
4514 intent.mData = Uri.parse(uri);
4515 }
Tom Taylord4a47292009-12-21 13:59:18 -08004516
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004517 if (intent.mAction == null) {
4518 // By default, if no action is specified, then use VIEW.
4519 intent.mAction = ACTION_VIEW;
4520 }
4521
4522 } else {
4523 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4524 }
4525
4526 return intent;
4527 }
4528
4529 /**
4530 * Retrieve the general action to be performed, such as
4531 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4532 * the information in the intent should be interpreted -- most importantly,
4533 * what to do with the data returned by {@link #getData}.
4534 *
4535 * @return The action of this intent or null if none is specified.
4536 *
4537 * @see #setAction
4538 */
4539 public String getAction() {
4540 return mAction;
4541 }
4542
4543 /**
4544 * Retrieve data this intent is operating on. This URI specifies the name
4545 * of the data; often it uses the content: scheme, specifying data in a
4546 * content provider. Other schemes may be handled by specific activities,
4547 * such as http: by the web browser.
4548 *
4549 * @return The URI of the data this intent is targeting or null.
4550 *
4551 * @see #getScheme
4552 * @see #setData
4553 */
4554 public Uri getData() {
4555 return mData;
4556 }
4557
4558 /**
4559 * The same as {@link #getData()}, but returns the URI as an encoded
4560 * String.
4561 */
4562 public String getDataString() {
4563 return mData != null ? mData.toString() : null;
4564 }
4565
4566 /**
4567 * Return the scheme portion of the intent's data. If the data is null or
4568 * does not include a scheme, null is returned. Otherwise, the scheme
4569 * prefix without the final ':' is returned, i.e. "http".
4570 *
4571 * <p>This is the same as calling getData().getScheme() (and checking for
4572 * null data).
4573 *
4574 * @return The scheme of this intent.
4575 *
4576 * @see #getData
4577 */
4578 public String getScheme() {
4579 return mData != null ? mData.getScheme() : null;
4580 }
4581
4582 /**
4583 * Retrieve any explicit MIME type included in the intent. This is usually
4584 * null, as the type is determined by the intent data.
4585 *
4586 * @return If a type was manually set, it is returned; else null is
4587 * returned.
4588 *
4589 * @see #resolveType(ContentResolver)
4590 * @see #setType
4591 */
4592 public String getType() {
4593 return mType;
4594 }
4595
4596 /**
4597 * Return the MIME data type of this intent. If the type field is
4598 * explicitly set, that is simply returned. Otherwise, if the data is set,
4599 * the type of that data is returned. If neither fields are set, a null is
4600 * returned.
4601 *
4602 * @return The MIME type of this intent.
4603 *
4604 * @see #getType
4605 * @see #resolveType(ContentResolver)
4606 */
4607 public String resolveType(Context context) {
4608 return resolveType(context.getContentResolver());
4609 }
4610
4611 /**
4612 * Return the MIME data type of this intent. If the type field is
4613 * explicitly set, that is simply returned. Otherwise, if the data is set,
4614 * the type of that data is returned. If neither fields are set, a null is
4615 * returned.
4616 *
4617 * @param resolver A ContentResolver that can be used to determine the MIME
4618 * type of the intent's data.
4619 *
4620 * @return The MIME type of this intent.
4621 *
4622 * @see #getType
4623 * @see #resolveType(Context)
4624 */
4625 public String resolveType(ContentResolver resolver) {
4626 if (mType != null) {
4627 return mType;
4628 }
4629 if (mData != null) {
4630 if ("content".equals(mData.getScheme())) {
4631 return resolver.getType(mData);
4632 }
4633 }
4634 return null;
4635 }
4636
4637 /**
4638 * Return the MIME data type of this intent, only if it will be needed for
4639 * intent resolution. This is not generally useful for application code;
4640 * it is used by the frameworks for communicating with back-end system
4641 * services.
4642 *
4643 * @param resolver A ContentResolver that can be used to determine the MIME
4644 * type of the intent's data.
4645 *
4646 * @return The MIME type of this intent, or null if it is unknown or not
4647 * needed.
4648 */
4649 public String resolveTypeIfNeeded(ContentResolver resolver) {
4650 if (mComponent != null) {
4651 return mType;
4652 }
4653 return resolveType(resolver);
4654 }
4655
4656 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004657 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004658 *
4659 * @param category The category to check.
4660 *
4661 * @return boolean True if the intent contains the category, else false.
4662 *
4663 * @see #getCategories
4664 * @see #addCategory
4665 */
4666 public boolean hasCategory(String category) {
4667 return mCategories != null && mCategories.contains(category);
4668 }
4669
4670 /**
4671 * Return the set of all categories in the intent. If there are no categories,
4672 * returns NULL.
4673 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004674 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004675 *
4676 * @see #hasCategory
4677 * @see #addCategory
4678 */
4679 public Set<String> getCategories() {
4680 return mCategories;
4681 }
4682
4683 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004684 * Return the specific selector associated with this Intent. If there is
4685 * none, returns null. See {@link #setSelector} for more information.
4686 *
4687 * @see #setSelector
4688 */
4689 public Intent getSelector() {
4690 return mSelector;
4691 }
4692
4693 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004694 * Return the {@link ClipData} associated with this Intent. If there is
4695 * none, returns null. See {@link #setClipData} for more information.
4696 *
John Spurlock125d1332013-11-25 11:58:37 -05004697 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004698 */
4699 public ClipData getClipData() {
4700 return mClipData;
4701 }
4702
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01004703 /** @hide */
4704 public int getContentUserHint() {
4705 return mContentUserHint;
4706 }
4707
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004708 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004709 * Sets the ClassLoader that will be used when unmarshalling
4710 * any Parcelable values from the extras of this Intent.
4711 *
4712 * @param loader a ClassLoader, or null to use the default loader
4713 * at the time of unmarshalling.
4714 */
4715 public void setExtrasClassLoader(ClassLoader loader) {
4716 if (mExtras != null) {
4717 mExtras.setClassLoader(loader);
4718 }
4719 }
4720
4721 /**
4722 * Returns true if an extra value is associated with the given name.
4723 * @param name the extra's name
4724 * @return true if the given extra is present.
4725 */
4726 public boolean hasExtra(String name) {
4727 return mExtras != null && mExtras.containsKey(name);
4728 }
4729
4730 /**
4731 * Returns true if the Intent's extras contain a parcelled file descriptor.
4732 * @return true if the Intent contains a parcelled file descriptor.
4733 */
4734 public boolean hasFileDescriptors() {
4735 return mExtras != null && mExtras.hasFileDescriptors();
4736 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004737
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004738 /** @hide */
4739 public void setAllowFds(boolean allowFds) {
4740 if (mExtras != null) {
4741 mExtras.setAllowFds(allowFds);
4742 }
4743 }
4744
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004745 /**
4746 * Retrieve extended data from the intent.
4747 *
4748 * @param name The name of the desired item.
4749 *
4750 * @return the value of an item that previously added with putExtra()
4751 * or null if none was found.
4752 *
4753 * @deprecated
4754 * @hide
4755 */
4756 @Deprecated
4757 public Object getExtra(String name) {
4758 return getExtra(name, null);
4759 }
4760
4761 /**
4762 * Retrieve extended data from the intent.
4763 *
4764 * @param name The name of the desired item.
4765 * @param defaultValue the value to be returned if no value of the desired
4766 * type is stored with the given name.
4767 *
4768 * @return the value of an item that previously added with putExtra()
4769 * or the default value if none was found.
4770 *
4771 * @see #putExtra(String, boolean)
4772 */
4773 public boolean getBooleanExtra(String name, boolean defaultValue) {
4774 return mExtras == null ? defaultValue :
4775 mExtras.getBoolean(name, defaultValue);
4776 }
4777
4778 /**
4779 * Retrieve extended data from the intent.
4780 *
4781 * @param name The name of the desired item.
4782 * @param defaultValue the value to be returned if no value of the desired
4783 * type is stored with the given name.
4784 *
4785 * @return the value of an item that previously added with putExtra()
4786 * or the default value if none was found.
4787 *
4788 * @see #putExtra(String, byte)
4789 */
4790 public byte getByteExtra(String name, byte defaultValue) {
4791 return mExtras == null ? defaultValue :
4792 mExtras.getByte(name, defaultValue);
4793 }
4794
4795 /**
4796 * Retrieve extended data from the intent.
4797 *
4798 * @param name The name of the desired item.
4799 * @param defaultValue the value to be returned if no value of the desired
4800 * type is stored with the given name.
4801 *
4802 * @return the value of an item that previously added with putExtra()
4803 * or the default value if none was found.
4804 *
4805 * @see #putExtra(String, short)
4806 */
4807 public short getShortExtra(String name, short defaultValue) {
4808 return mExtras == null ? defaultValue :
4809 mExtras.getShort(name, defaultValue);
4810 }
4811
4812 /**
4813 * Retrieve extended data from the intent.
4814 *
4815 * @param name The name of the desired item.
4816 * @param defaultValue the value to be returned if no value of the desired
4817 * type is stored with the given name.
4818 *
4819 * @return the value of an item that previously added with putExtra()
4820 * or the default value if none was found.
4821 *
4822 * @see #putExtra(String, char)
4823 */
4824 public char getCharExtra(String name, char defaultValue) {
4825 return mExtras == null ? defaultValue :
4826 mExtras.getChar(name, defaultValue);
4827 }
4828
4829 /**
4830 * Retrieve extended data from the intent.
4831 *
4832 * @param name The name of the desired item.
4833 * @param defaultValue the value to be returned if no value of the desired
4834 * type is stored with the given name.
4835 *
4836 * @return the value of an item that previously added with putExtra()
4837 * or the default value if none was found.
4838 *
4839 * @see #putExtra(String, int)
4840 */
4841 public int getIntExtra(String name, int defaultValue) {
4842 return mExtras == null ? defaultValue :
4843 mExtras.getInt(name, defaultValue);
4844 }
4845
4846 /**
4847 * Retrieve extended data from the intent.
4848 *
4849 * @param name The name of the desired item.
4850 * @param defaultValue the value to be returned if no value of the desired
4851 * type is stored with the given name.
4852 *
4853 * @return the value of an item that previously added with putExtra()
4854 * or the default value if none was found.
4855 *
4856 * @see #putExtra(String, long)
4857 */
4858 public long getLongExtra(String name, long defaultValue) {
4859 return mExtras == null ? defaultValue :
4860 mExtras.getLong(name, defaultValue);
4861 }
4862
4863 /**
4864 * Retrieve extended data from the intent.
4865 *
4866 * @param name The name of the desired item.
4867 * @param defaultValue the value to be returned if no value of the desired
4868 * type is stored with the given name.
4869 *
4870 * @return the value of an item that previously added with putExtra(),
4871 * or the default value if no such item is present
4872 *
4873 * @see #putExtra(String, float)
4874 */
4875 public float getFloatExtra(String name, float defaultValue) {
4876 return mExtras == null ? defaultValue :
4877 mExtras.getFloat(name, defaultValue);
4878 }
4879
4880 /**
4881 * Retrieve extended data from the intent.
4882 *
4883 * @param name The name of the desired item.
4884 * @param defaultValue the value to be returned if no value of the desired
4885 * type is stored with the given name.
4886 *
4887 * @return the value of an item that previously added with putExtra()
4888 * or the default value if none was found.
4889 *
4890 * @see #putExtra(String, double)
4891 */
4892 public double getDoubleExtra(String name, double defaultValue) {
4893 return mExtras == null ? defaultValue :
4894 mExtras.getDouble(name, defaultValue);
4895 }
4896
4897 /**
4898 * Retrieve extended data from the intent.
4899 *
4900 * @param name The name of the desired item.
4901 *
4902 * @return the value of an item that previously added with putExtra()
4903 * or null if no String value was found.
4904 *
4905 * @see #putExtra(String, String)
4906 */
4907 public String getStringExtra(String name) {
4908 return mExtras == null ? null : mExtras.getString(name);
4909 }
4910
4911 /**
4912 * Retrieve extended data from the intent.
4913 *
4914 * @param name The name of the desired item.
4915 *
4916 * @return the value of an item that previously added with putExtra()
4917 * or null if no CharSequence value was found.
4918 *
4919 * @see #putExtra(String, CharSequence)
4920 */
4921 public CharSequence getCharSequenceExtra(String name) {
4922 return mExtras == null ? null : mExtras.getCharSequence(name);
4923 }
4924
4925 /**
4926 * Retrieve extended data from the intent.
4927 *
4928 * @param name The name of the desired item.
4929 *
4930 * @return the value of an item that previously added with putExtra()
4931 * or null if no Parcelable value was found.
4932 *
4933 * @see #putExtra(String, Parcelable)
4934 */
4935 public <T extends Parcelable> T getParcelableExtra(String name) {
4936 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4937 }
4938
4939 /**
4940 * Retrieve extended data from the intent.
4941 *
4942 * @param name The name of the desired item.
4943 *
4944 * @return the value of an item that previously added with putExtra()
4945 * or null if no Parcelable[] value was found.
4946 *
4947 * @see #putExtra(String, Parcelable[])
4948 */
4949 public Parcelable[] getParcelableArrayExtra(String name) {
4950 return mExtras == null ? null : mExtras.getParcelableArray(name);
4951 }
4952
4953 /**
4954 * Retrieve extended data from the intent.
4955 *
4956 * @param name The name of the desired item.
4957 *
4958 * @return the value of an item that previously added with putExtra()
4959 * or null if no ArrayList<Parcelable> value was found.
4960 *
4961 * @see #putParcelableArrayListExtra(String, ArrayList)
4962 */
4963 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4964 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4965 }
4966
4967 /**
4968 * Retrieve extended data from the intent.
4969 *
4970 * @param name The name of the desired item.
4971 *
4972 * @return the value of an item that previously added with putExtra()
4973 * or null if no Serializable value was found.
4974 *
4975 * @see #putExtra(String, Serializable)
4976 */
4977 public Serializable getSerializableExtra(String name) {
4978 return mExtras == null ? null : mExtras.getSerializable(name);
4979 }
4980
4981 /**
4982 * Retrieve extended data from the intent.
4983 *
4984 * @param name The name of the desired item.
4985 *
4986 * @return the value of an item that previously added with putExtra()
4987 * or null if no ArrayList<Integer> value was found.
4988 *
4989 * @see #putIntegerArrayListExtra(String, ArrayList)
4990 */
4991 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4992 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4993 }
4994
4995 /**
4996 * Retrieve extended data from the intent.
4997 *
4998 * @param name The name of the desired item.
4999 *
5000 * @return the value of an item that previously added with putExtra()
5001 * or null if no ArrayList<String> value was found.
5002 *
5003 * @see #putStringArrayListExtra(String, ArrayList)
5004 */
5005 public ArrayList<String> getStringArrayListExtra(String name) {
5006 return mExtras == null ? null : mExtras.getStringArrayList(name);
5007 }
5008
5009 /**
5010 * Retrieve extended data from the intent.
5011 *
5012 * @param name The name of the desired item.
5013 *
5014 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005015 * or null if no ArrayList<CharSequence> value was found.
5016 *
5017 * @see #putCharSequenceArrayListExtra(String, ArrayList)
5018 */
5019 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
5020 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
5021 }
5022
5023 /**
5024 * Retrieve extended data from the intent.
5025 *
5026 * @param name The name of the desired item.
5027 *
5028 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005029 * or null if no boolean array value was found.
5030 *
5031 * @see #putExtra(String, boolean[])
5032 */
5033 public boolean[] getBooleanArrayExtra(String name) {
5034 return mExtras == null ? null : mExtras.getBooleanArray(name);
5035 }
5036
5037 /**
5038 * Retrieve extended data from the intent.
5039 *
5040 * @param name The name of the desired item.
5041 *
5042 * @return the value of an item that previously added with putExtra()
5043 * or null if no byte array value was found.
5044 *
5045 * @see #putExtra(String, byte[])
5046 */
5047 public byte[] getByteArrayExtra(String name) {
5048 return mExtras == null ? null : mExtras.getByteArray(name);
5049 }
5050
5051 /**
5052 * Retrieve extended data from the intent.
5053 *
5054 * @param name The name of the desired item.
5055 *
5056 * @return the value of an item that previously added with putExtra()
5057 * or null if no short array value was found.
5058 *
5059 * @see #putExtra(String, short[])
5060 */
5061 public short[] getShortArrayExtra(String name) {
5062 return mExtras == null ? null : mExtras.getShortArray(name);
5063 }
5064
5065 /**
5066 * Retrieve extended data from the intent.
5067 *
5068 * @param name The name of the desired item.
5069 *
5070 * @return the value of an item that previously added with putExtra()
5071 * or null if no char array value was found.
5072 *
5073 * @see #putExtra(String, char[])
5074 */
5075 public char[] getCharArrayExtra(String name) {
5076 return mExtras == null ? null : mExtras.getCharArray(name);
5077 }
5078
5079 /**
5080 * Retrieve extended data from the intent.
5081 *
5082 * @param name The name of the desired item.
5083 *
5084 * @return the value of an item that previously added with putExtra()
5085 * or null if no int array value was found.
5086 *
5087 * @see #putExtra(String, int[])
5088 */
5089 public int[] getIntArrayExtra(String name) {
5090 return mExtras == null ? null : mExtras.getIntArray(name);
5091 }
5092
5093 /**
5094 * Retrieve extended data from the intent.
5095 *
5096 * @param name The name of the desired item.
5097 *
5098 * @return the value of an item that previously added with putExtra()
5099 * or null if no long array value was found.
5100 *
5101 * @see #putExtra(String, long[])
5102 */
5103 public long[] getLongArrayExtra(String name) {
5104 return mExtras == null ? null : mExtras.getLongArray(name);
5105 }
5106
5107 /**
5108 * Retrieve extended data from the intent.
5109 *
5110 * @param name The name of the desired item.
5111 *
5112 * @return the value of an item that previously added with putExtra()
5113 * or null if no float array value was found.
5114 *
5115 * @see #putExtra(String, float[])
5116 */
5117 public float[] getFloatArrayExtra(String name) {
5118 return mExtras == null ? null : mExtras.getFloatArray(name);
5119 }
5120
5121 /**
5122 * Retrieve extended data from the intent.
5123 *
5124 * @param name The name of the desired item.
5125 *
5126 * @return the value of an item that previously added with putExtra()
5127 * or null if no double array value was found.
5128 *
5129 * @see #putExtra(String, double[])
5130 */
5131 public double[] getDoubleArrayExtra(String name) {
5132 return mExtras == null ? null : mExtras.getDoubleArray(name);
5133 }
5134
5135 /**
5136 * Retrieve extended data from the intent.
5137 *
5138 * @param name The name of the desired item.
5139 *
5140 * @return the value of an item that previously added with putExtra()
5141 * or null if no String array value was found.
5142 *
5143 * @see #putExtra(String, String[])
5144 */
5145 public String[] getStringArrayExtra(String name) {
5146 return mExtras == null ? null : mExtras.getStringArray(name);
5147 }
5148
5149 /**
5150 * Retrieve extended data from the intent.
5151 *
5152 * @param name The name of the desired item.
5153 *
5154 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005155 * or null if no CharSequence array value was found.
5156 *
5157 * @see #putExtra(String, CharSequence[])
5158 */
5159 public CharSequence[] getCharSequenceArrayExtra(String name) {
5160 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5161 }
5162
5163 /**
5164 * Retrieve extended data from the intent.
5165 *
5166 * @param name The name of the desired item.
5167 *
5168 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005169 * or null if no Bundle value was found.
5170 *
5171 * @see #putExtra(String, Bundle)
5172 */
5173 public Bundle getBundleExtra(String name) {
5174 return mExtras == null ? null : mExtras.getBundle(name);
5175 }
5176
5177 /**
5178 * Retrieve extended data from the intent.
5179 *
5180 * @param name The name of the desired item.
5181 *
5182 * @return the value of an item that previously added with putExtra()
5183 * or null if no IBinder value was found.
5184 *
5185 * @see #putExtra(String, IBinder)
5186 *
5187 * @deprecated
5188 * @hide
5189 */
5190 @Deprecated
5191 public IBinder getIBinderExtra(String name) {
5192 return mExtras == null ? null : mExtras.getIBinder(name);
5193 }
5194
5195 /**
5196 * Retrieve extended data from the intent.
5197 *
5198 * @param name The name of the desired item.
5199 * @param defaultValue The default value to return in case no item is
5200 * associated with the key 'name'
5201 *
5202 * @return the value of an item that previously added with putExtra()
5203 * or defaultValue if none was found.
5204 *
5205 * @see #putExtra
5206 *
5207 * @deprecated
5208 * @hide
5209 */
5210 @Deprecated
5211 public Object getExtra(String name, Object defaultValue) {
5212 Object result = defaultValue;
5213 if (mExtras != null) {
5214 Object result2 = mExtras.get(name);
5215 if (result2 != null) {
5216 result = result2;
5217 }
5218 }
5219
5220 return result;
5221 }
5222
5223 /**
5224 * Retrieves a map of extended data from the intent.
5225 *
5226 * @return the map of all extras previously added with putExtra(),
5227 * or null if none have been added.
5228 */
5229 public Bundle getExtras() {
5230 return (mExtras != null)
5231 ? new Bundle(mExtras)
5232 : null;
5233 }
5234
5235 /**
5236 * Retrieve any special flags associated with this intent. You will
5237 * normally just set them with {@link #setFlags} and let the system
5238 * take the appropriate action with them.
5239 *
5240 * @return int The currently set flags.
5241 *
5242 * @see #setFlags
5243 */
5244 public int getFlags() {
5245 return mFlags;
5246 }
5247
Dianne Hackborne7f97212011-02-24 14:40:20 -08005248 /** @hide */
5249 public boolean isExcludingStopped() {
5250 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5251 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5252 }
5253
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005254 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005255 * Retrieve the application package name this Intent is limited to. When
5256 * resolving an Intent, if non-null this limits the resolution to only
5257 * components in the given application package.
5258 *
5259 * @return The name of the application package for the Intent.
5260 *
5261 * @see #resolveActivity
5262 * @see #setPackage
5263 */
5264 public String getPackage() {
5265 return mPackage;
5266 }
5267
5268 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005269 * Retrieve the concrete component associated with the intent. When receiving
5270 * an intent, this is the component that was found to best handle it (that is,
5271 * yourself) and will always be non-null; in all other cases it will be
5272 * null unless explicitly set.
5273 *
5274 * @return The name of the application component to handle the intent.
5275 *
5276 * @see #resolveActivity
5277 * @see #setComponent
5278 */
5279 public ComponentName getComponent() {
5280 return mComponent;
5281 }
5282
5283 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005284 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5285 * used as a hint to the receiver for animations and the like. Null means that there
5286 * is no source bounds.
5287 */
5288 public Rect getSourceBounds() {
5289 return mSourceBounds;
5290 }
5291
5292 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005293 * Return the Activity component that should be used to handle this intent.
5294 * The appropriate component is determined based on the information in the
5295 * intent, evaluated as follows:
5296 *
5297 * <p>If {@link #getComponent} returns an explicit class, that is returned
5298 * without any further consideration.
5299 *
5300 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5301 * category to be considered.
5302 *
5303 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5304 * action.
5305 *
5306 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5307 * this type.
5308 *
5309 * <p>If {@link #addCategory} has added any categories, the activity must
5310 * handle ALL of the categories specified.
5311 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005312 * <p>If {@link #getPackage} is non-NULL, only activity components in
5313 * that application package will be considered.
5314 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005315 * <p>If there are no activities that satisfy all of these conditions, a
5316 * null string is returned.
5317 *
5318 * <p>If multiple activities are found to satisfy the intent, the one with
5319 * the highest priority will be used. If there are multiple activities
5320 * with the same priority, the system will either pick the best activity
5321 * based on user preference, or resolve to a system class that will allow
5322 * the user to pick an activity and forward from there.
5323 *
5324 * <p>This method is implemented simply by calling
5325 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5326 * true.</p>
5327 * <p> This API is called for you as part of starting an activity from an
5328 * intent. You do not normally need to call it yourself.</p>
5329 *
5330 * @param pm The package manager with which to resolve the Intent.
5331 *
5332 * @return Name of the component implementing an activity that can
5333 * display the intent.
5334 *
5335 * @see #setComponent
5336 * @see #getComponent
5337 * @see #resolveActivityInfo
5338 */
5339 public ComponentName resolveActivity(PackageManager pm) {
5340 if (mComponent != null) {
5341 return mComponent;
5342 }
5343
5344 ResolveInfo info = pm.resolveActivity(
5345 this, PackageManager.MATCH_DEFAULT_ONLY);
5346 if (info != null) {
5347 return new ComponentName(
5348 info.activityInfo.applicationInfo.packageName,
5349 info.activityInfo.name);
5350 }
5351
5352 return null;
5353 }
5354
5355 /**
5356 * Resolve the Intent into an {@link ActivityInfo}
5357 * describing the activity that should execute the intent. Resolution
5358 * follows the same rules as described for {@link #resolveActivity}, but
5359 * you get back the completely information about the resolved activity
5360 * instead of just its class name.
5361 *
5362 * @param pm The package manager with which to resolve the Intent.
5363 * @param flags Addition information to retrieve as per
5364 * {@link PackageManager#getActivityInfo(ComponentName, int)
5365 * PackageManager.getActivityInfo()}.
5366 *
5367 * @return PackageManager.ActivityInfo
5368 *
5369 * @see #resolveActivity
5370 */
5371 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5372 ActivityInfo ai = null;
5373 if (mComponent != null) {
5374 try {
5375 ai = pm.getActivityInfo(mComponent, flags);
5376 } catch (PackageManager.NameNotFoundException e) {
5377 // ignore
5378 }
5379 } else {
5380 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005381 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005382 if (info != null) {
5383 ai = info.activityInfo;
5384 }
5385 }
5386
5387 return ai;
5388 }
5389
5390 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005391 * Special function for use by the system to resolve service
5392 * intents to system apps. Throws an exception if there are
5393 * multiple potential matches to the Intent. Returns null if
5394 * there are no matches.
5395 * @hide
5396 */
5397 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5398 if (mComponent != null) {
5399 return mComponent;
5400 }
5401
5402 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5403 if (results == null) {
5404 return null;
5405 }
5406 ComponentName comp = null;
5407 for (int i=0; i<results.size(); i++) {
5408 ResolveInfo ri = results.get(i);
5409 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5410 continue;
5411 }
5412 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5413 ri.serviceInfo.name);
5414 if (comp != null) {
5415 throw new IllegalStateException("Multiple system services handle " + this
5416 + ": " + comp + ", " + foundComp);
5417 }
5418 comp = foundComp;
5419 }
5420 return comp;
5421 }
5422
5423 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005424 * Set the general action to be performed.
5425 *
5426 * @param action An action name, such as ACTION_VIEW. Application-specific
5427 * actions should be prefixed with the vendor's package name.
5428 *
5429 * @return Returns the same Intent object, for chaining multiple calls
5430 * into a single statement.
5431 *
5432 * @see #getAction
5433 */
5434 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005435 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005436 return this;
5437 }
5438
5439 /**
5440 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005441 * clears any type that was previously set by {@link #setType} or
5442 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005443 *
Nick Pellyccae4122012-01-09 14:12:58 -08005444 * <p><em>Note: scheme matching in the Android framework is
5445 * case-sensitive, unlike the formal RFC. As a result,
5446 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005447 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005448 * {@link #setDataAndNormalize}
5449 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005450 *
Nick Pellyccae4122012-01-09 14:12:58 -08005451 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005452 *
5453 * @return Returns the same Intent object, for chaining multiple calls
5454 * into a single statement.
5455 *
5456 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005457 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005458 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005459 */
5460 public Intent setData(Uri data) {
5461 mData = data;
5462 mType = null;
5463 return this;
5464 }
5465
5466 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005467 * Normalize and set the data this intent is operating on.
5468 *
5469 * <p>This method automatically clears any type that was
5470 * previously set (for example, by {@link #setType}).
5471 *
5472 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005473 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005474 * so really this is just a convenience method for
5475 * <pre>
5476 * setData(data.normalize())
5477 * </pre>
5478 *
5479 * @param data The Uri of the data this intent is now targeting.
5480 *
5481 * @return Returns the same Intent object, for chaining multiple calls
5482 * into a single statement.
5483 *
5484 * @see #getData
5485 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005486 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005487 */
5488 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005489 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005490 }
5491
5492 /**
5493 * Set an explicit MIME data type.
5494 *
5495 * <p>This is used to create intents that only specify a type and not data,
5496 * for example to indicate the type of data to return.
5497 *
5498 * <p>This method automatically clears any data that was
5499 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005500 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005501 * <p><em>Note: MIME type matching in the Android framework is
5502 * case-sensitive, unlike formal RFC MIME types. As a result,
5503 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005504 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5505 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005506 *
5507 * @param type The MIME type of the data being handled by this intent.
5508 *
5509 * @return Returns the same Intent object, for chaining multiple calls
5510 * into a single statement.
5511 *
5512 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005513 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005514 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005515 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005516 */
5517 public Intent setType(String type) {
5518 mData = null;
5519 mType = type;
5520 return this;
5521 }
5522
5523 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005524 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005525 *
Nick Pellyccae4122012-01-09 14:12:58 -08005526 * <p>This is used to create intents that only specify a type and not data,
5527 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005528 *
Nick Pellyccae4122012-01-09 14:12:58 -08005529 * <p>This method automatically clears any data that was
5530 * previously set (for example by {@link #setData}).
5531 *
5532 * <p>The MIME type is normalized using
5533 * {@link #normalizeMimeType} before it is set,
5534 * so really this is just a convenience method for
5535 * <pre>
5536 * setType(Intent.normalizeMimeType(type))
5537 * </pre>
5538 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005539 * @param type The MIME type of the data being handled by this intent.
5540 *
5541 * @return Returns the same Intent object, for chaining multiple calls
5542 * into a single statement.
5543 *
Nick Pellyccae4122012-01-09 14:12:58 -08005544 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005545 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005546 * @see #normalizeMimeType
5547 */
5548 public Intent setTypeAndNormalize(String type) {
5549 return setType(normalizeMimeType(type));
5550 }
5551
5552 /**
5553 * (Usually optional) Set the data for the intent along with an explicit
5554 * MIME data type. This method should very rarely be used -- it allows you
5555 * to override the MIME type that would ordinarily be inferred from the
5556 * data with your own type given here.
5557 *
5558 * <p><em>Note: MIME type and Uri scheme matching in the
5559 * Android framework is case-sensitive, unlike the formal RFC definitions.
5560 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005561 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005562 * {@link #setDataAndTypeAndNormalize}
5563 * to ensure that they are converted to lower case.</em>
5564 *
5565 * @param data The Uri of the data this intent is now targeting.
5566 * @param type The MIME type of the data being handled by this intent.
5567 *
5568 * @return Returns the same Intent object, for chaining multiple calls
5569 * into a single statement.
5570 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005571 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005572 * @see #setData
5573 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005574 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005575 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005576 */
5577 public Intent setDataAndType(Uri data, String type) {
5578 mData = data;
5579 mType = type;
5580 return this;
5581 }
5582
5583 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005584 * (Usually optional) Normalize and set both the data Uri and an explicit
5585 * MIME data type. This method should very rarely be used -- it allows you
5586 * to override the MIME type that would ordinarily be inferred from the
5587 * data with your own type given here.
5588 *
5589 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005590 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005591 * before they are set, so really this is just a convenience method for
5592 * <pre>
5593 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5594 * </pre>
5595 *
5596 * @param data The Uri of the data this intent is now targeting.
5597 * @param type The MIME type of the data being handled by this intent.
5598 *
5599 * @return Returns the same Intent object, for chaining multiple calls
5600 * into a single statement.
5601 *
5602 * @see #setType
5603 * @see #setData
5604 * @see #setDataAndType
5605 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005606 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005607 */
5608 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005609 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005610 }
5611
5612 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005613 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005614 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005615 * activities that provide <em>all</em> of the requested categories will be
5616 * used.
5617 *
5618 * @param category The desired category. This can be either one of the
5619 * predefined Intent categories, or a custom category in your own
5620 * namespace.
5621 *
5622 * @return Returns the same Intent object, for chaining multiple calls
5623 * into a single statement.
5624 *
5625 * @see #hasCategory
5626 * @see #removeCategory
5627 */
5628 public Intent addCategory(String category) {
5629 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005630 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005631 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005632 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005633 return this;
5634 }
5635
5636 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005637 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005638 *
5639 * @param category The category to remove.
5640 *
5641 * @see #addCategory
5642 */
5643 public void removeCategory(String category) {
5644 if (mCategories != null) {
5645 mCategories.remove(category);
5646 if (mCategories.size() == 0) {
5647 mCategories = null;
5648 }
5649 }
5650 }
5651
5652 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005653 * Set a selector for this Intent. This is a modification to the kinds of
5654 * things the Intent will match. If the selector is set, it will be used
5655 * when trying to find entities that can handle the Intent, instead of the
5656 * main contents of the Intent. This allows you build an Intent containing
5657 * a generic protocol while targeting it more specifically.
5658 *
5659 * <p>An example of where this may be used is with things like
5660 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5661 * Intent that will launch the Browser application. However, the correct
5662 * main entry point of an application is actually {@link #ACTION_MAIN}
5663 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5664 * used to specify the actual Activity to launch. If you launch the browser
5665 * with something different, undesired behavior may happen if the user has
5666 * previously or later launches it the normal way, since they do not match.
5667 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5668 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5669 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5670 *
5671 * <p>Setting a selector does not impact the behavior of
5672 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5673 * desired behavior of a selector -- it does not impact the base meaning
5674 * of the Intent, just what kinds of things will be matched against it
5675 * when determining who can handle it.</p>
5676 *
5677 * <p>You can not use both a selector and {@link #setPackage(String)} on
5678 * the same base Intent.</p>
5679 *
5680 * @param selector The desired selector Intent; set to null to not use
5681 * a special selector.
5682 */
5683 public void setSelector(Intent selector) {
5684 if (selector == this) {
5685 throw new IllegalArgumentException(
5686 "Intent being set as a selector of itself");
5687 }
5688 if (selector != null && mPackage != null) {
5689 throw new IllegalArgumentException(
5690 "Can't set selector when package name is already set");
5691 }
5692 mSelector = selector;
5693 }
5694
5695 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005696 * Set a {@link ClipData} associated with this Intent. This replaces any
5697 * previously set ClipData.
5698 *
5699 * <p>The ClipData in an intent is not used for Intent matching or other
5700 * such operations. Semantically it is like extras, used to transmit
5701 * additional data with the Intent. The main feature of using this over
5702 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5703 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5704 * items included in the clip data. This is useful, in particular, if
5705 * you want to transmit an Intent containing multiple <code>content:</code>
5706 * URIs for which the recipient may not have global permission to access the
5707 * content provider.
5708 *
5709 * <p>If the ClipData contains items that are themselves Intents, any
5710 * grant flags in those Intents will be ignored. Only the top-level flags
5711 * of the main Intent are respected, and will be applied to all Uri or
5712 * Intent items in the clip (or sub-items of the clip).
5713 *
5714 * <p>The MIME type, label, and icon in the ClipData object are not
5715 * directly used by Intent. Applications should generally rely on the
5716 * MIME type of the Intent itself, not what it may find in the ClipData.
5717 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005718 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005719 *
5720 * @param clip The new clip to set. May be null to clear the current clip.
5721 */
5722 public void setClipData(ClipData clip) {
5723 mClipData = clip;
5724 }
5725
5726 /**
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01005727 * This is NOT a secure mechanism to identify the user who sent the intent.
5728 * When the intent is sent to a different user, it is used to fix uris by adding the userId
5729 * who sent the intent.
5730 * @hide
5731 */
5732 public void setContentUserHint(int contentUserHint) {
5733 mContentUserHint = contentUserHint;
5734 }
5735
5736 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005737 * Add extended data to the intent. The name must include a package
5738 * prefix, for example the app com.android.contacts would use names
5739 * like "com.android.contacts.ShowAll".
5740 *
5741 * @param name The name of the extra data, with package prefix.
5742 * @param value The boolean data value.
5743 *
5744 * @return Returns the same Intent object, for chaining multiple calls
5745 * into a single statement.
5746 *
5747 * @see #putExtras
5748 * @see #removeExtra
5749 * @see #getBooleanExtra(String, boolean)
5750 */
5751 public Intent putExtra(String name, boolean value) {
5752 if (mExtras == null) {
5753 mExtras = new Bundle();
5754 }
5755 mExtras.putBoolean(name, value);
5756 return this;
5757 }
5758
5759 /**
5760 * Add extended data to the intent. The name must include a package
5761 * prefix, for example the app com.android.contacts would use names
5762 * like "com.android.contacts.ShowAll".
5763 *
5764 * @param name The name of the extra data, with package prefix.
5765 * @param value The byte data value.
5766 *
5767 * @return Returns the same Intent object, for chaining multiple calls
5768 * into a single statement.
5769 *
5770 * @see #putExtras
5771 * @see #removeExtra
5772 * @see #getByteExtra(String, byte)
5773 */
5774 public Intent putExtra(String name, byte value) {
5775 if (mExtras == null) {
5776 mExtras = new Bundle();
5777 }
5778 mExtras.putByte(name, value);
5779 return this;
5780 }
5781
5782 /**
5783 * Add extended data to the intent. The name must include a package
5784 * prefix, for example the app com.android.contacts would use names
5785 * like "com.android.contacts.ShowAll".
5786 *
5787 * @param name The name of the extra data, with package prefix.
5788 * @param value The char data value.
5789 *
5790 * @return Returns the same Intent object, for chaining multiple calls
5791 * into a single statement.
5792 *
5793 * @see #putExtras
5794 * @see #removeExtra
5795 * @see #getCharExtra(String, char)
5796 */
5797 public Intent putExtra(String name, char value) {
5798 if (mExtras == null) {
5799 mExtras = new Bundle();
5800 }
5801 mExtras.putChar(name, value);
5802 return this;
5803 }
5804
5805 /**
5806 * Add extended data to the intent. The name must include a package
5807 * prefix, for example the app com.android.contacts would use names
5808 * like "com.android.contacts.ShowAll".
5809 *
5810 * @param name The name of the extra data, with package prefix.
5811 * @param value The short data value.
5812 *
5813 * @return Returns the same Intent object, for chaining multiple calls
5814 * into a single statement.
5815 *
5816 * @see #putExtras
5817 * @see #removeExtra
5818 * @see #getShortExtra(String, short)
5819 */
5820 public Intent putExtra(String name, short value) {
5821 if (mExtras == null) {
5822 mExtras = new Bundle();
5823 }
5824 mExtras.putShort(name, value);
5825 return this;
5826 }
5827
5828 /**
5829 * Add extended data to the intent. The name must include a package
5830 * prefix, for example the app com.android.contacts would use names
5831 * like "com.android.contacts.ShowAll".
5832 *
5833 * @param name The name of the extra data, with package prefix.
5834 * @param value The integer data value.
5835 *
5836 * @return Returns the same Intent object, for chaining multiple calls
5837 * into a single statement.
5838 *
5839 * @see #putExtras
5840 * @see #removeExtra
5841 * @see #getIntExtra(String, int)
5842 */
5843 public Intent putExtra(String name, int value) {
5844 if (mExtras == null) {
5845 mExtras = new Bundle();
5846 }
5847 mExtras.putInt(name, value);
5848 return this;
5849 }
5850
5851 /**
5852 * Add extended data to the intent. The name must include a package
5853 * prefix, for example the app com.android.contacts would use names
5854 * like "com.android.contacts.ShowAll".
5855 *
5856 * @param name The name of the extra data, with package prefix.
5857 * @param value The long data value.
5858 *
5859 * @return Returns the same Intent object, for chaining multiple calls
5860 * into a single statement.
5861 *
5862 * @see #putExtras
5863 * @see #removeExtra
5864 * @see #getLongExtra(String, long)
5865 */
5866 public Intent putExtra(String name, long value) {
5867 if (mExtras == null) {
5868 mExtras = new Bundle();
5869 }
5870 mExtras.putLong(name, value);
5871 return this;
5872 }
5873
5874 /**
5875 * Add extended data to the intent. The name must include a package
5876 * prefix, for example the app com.android.contacts would use names
5877 * like "com.android.contacts.ShowAll".
5878 *
5879 * @param name The name of the extra data, with package prefix.
5880 * @param value The float data value.
5881 *
5882 * @return Returns the same Intent object, for chaining multiple calls
5883 * into a single statement.
5884 *
5885 * @see #putExtras
5886 * @see #removeExtra
5887 * @see #getFloatExtra(String, float)
5888 */
5889 public Intent putExtra(String name, float value) {
5890 if (mExtras == null) {
5891 mExtras = new Bundle();
5892 }
5893 mExtras.putFloat(name, value);
5894 return this;
5895 }
5896
5897 /**
5898 * Add extended data to the intent. The name must include a package
5899 * prefix, for example the app com.android.contacts would use names
5900 * like "com.android.contacts.ShowAll".
5901 *
5902 * @param name The name of the extra data, with package prefix.
5903 * @param value The double data value.
5904 *
5905 * @return Returns the same Intent object, for chaining multiple calls
5906 * into a single statement.
5907 *
5908 * @see #putExtras
5909 * @see #removeExtra
5910 * @see #getDoubleExtra(String, double)
5911 */
5912 public Intent putExtra(String name, double value) {
5913 if (mExtras == null) {
5914 mExtras = new Bundle();
5915 }
5916 mExtras.putDouble(name, value);
5917 return this;
5918 }
5919
5920 /**
5921 * Add extended data to the intent. The name must include a package
5922 * prefix, for example the app com.android.contacts would use names
5923 * like "com.android.contacts.ShowAll".
5924 *
5925 * @param name The name of the extra data, with package prefix.
5926 * @param value The String data value.
5927 *
5928 * @return Returns the same Intent object, for chaining multiple calls
5929 * into a single statement.
5930 *
5931 * @see #putExtras
5932 * @see #removeExtra
5933 * @see #getStringExtra(String)
5934 */
5935 public Intent putExtra(String name, String value) {
5936 if (mExtras == null) {
5937 mExtras = new Bundle();
5938 }
5939 mExtras.putString(name, value);
5940 return this;
5941 }
5942
5943 /**
5944 * Add extended data to the intent. The name must include a package
5945 * prefix, for example the app com.android.contacts would use names
5946 * like "com.android.contacts.ShowAll".
5947 *
5948 * @param name The name of the extra data, with package prefix.
5949 * @param value The CharSequence data value.
5950 *
5951 * @return Returns the same Intent object, for chaining multiple calls
5952 * into a single statement.
5953 *
5954 * @see #putExtras
5955 * @see #removeExtra
5956 * @see #getCharSequenceExtra(String)
5957 */
5958 public Intent putExtra(String name, CharSequence value) {
5959 if (mExtras == null) {
5960 mExtras = new Bundle();
5961 }
5962 mExtras.putCharSequence(name, value);
5963 return this;
5964 }
5965
5966 /**
5967 * Add extended data to the intent. The name must include a package
5968 * prefix, for example the app com.android.contacts would use names
5969 * like "com.android.contacts.ShowAll".
5970 *
5971 * @param name The name of the extra data, with package prefix.
5972 * @param value The Parcelable data value.
5973 *
5974 * @return Returns the same Intent object, for chaining multiple calls
5975 * into a single statement.
5976 *
5977 * @see #putExtras
5978 * @see #removeExtra
5979 * @see #getParcelableExtra(String)
5980 */
5981 public Intent putExtra(String name, Parcelable value) {
5982 if (mExtras == null) {
5983 mExtras = new Bundle();
5984 }
5985 mExtras.putParcelable(name, value);
5986 return this;
5987 }
5988
5989 /**
5990 * Add extended data to the intent. The name must include a package
5991 * prefix, for example the app com.android.contacts would use names
5992 * like "com.android.contacts.ShowAll".
5993 *
5994 * @param name The name of the extra data, with package prefix.
5995 * @param value The Parcelable[] data value.
5996 *
5997 * @return Returns the same Intent object, for chaining multiple calls
5998 * into a single statement.
5999 *
6000 * @see #putExtras
6001 * @see #removeExtra
6002 * @see #getParcelableArrayExtra(String)
6003 */
6004 public Intent putExtra(String name, Parcelable[] value) {
6005 if (mExtras == null) {
6006 mExtras = new Bundle();
6007 }
6008 mExtras.putParcelableArray(name, value);
6009 return this;
6010 }
6011
6012 /**
6013 * Add extended data to the intent. The name must include a package
6014 * prefix, for example the app com.android.contacts would use names
6015 * like "com.android.contacts.ShowAll".
6016 *
6017 * @param name The name of the extra data, with package prefix.
6018 * @param value The ArrayList<Parcelable> data value.
6019 *
6020 * @return Returns the same Intent object, for chaining multiple calls
6021 * into a single statement.
6022 *
6023 * @see #putExtras
6024 * @see #removeExtra
6025 * @see #getParcelableArrayListExtra(String)
6026 */
6027 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
6028 if (mExtras == null) {
6029 mExtras = new Bundle();
6030 }
6031 mExtras.putParcelableArrayList(name, value);
6032 return this;
6033 }
6034
6035 /**
6036 * Add extended data to the intent. The name must include a package
6037 * prefix, for example the app com.android.contacts would use names
6038 * like "com.android.contacts.ShowAll".
6039 *
6040 * @param name The name of the extra data, with package prefix.
6041 * @param value The ArrayList<Integer> data value.
6042 *
6043 * @return Returns the same Intent object, for chaining multiple calls
6044 * into a single statement.
6045 *
6046 * @see #putExtras
6047 * @see #removeExtra
6048 * @see #getIntegerArrayListExtra(String)
6049 */
6050 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
6051 if (mExtras == null) {
6052 mExtras = new Bundle();
6053 }
6054 mExtras.putIntegerArrayList(name, value);
6055 return this;
6056 }
6057
6058 /**
6059 * Add extended data to the intent. The name must include a package
6060 * prefix, for example the app com.android.contacts would use names
6061 * like "com.android.contacts.ShowAll".
6062 *
6063 * @param name The name of the extra data, with package prefix.
6064 * @param value The ArrayList<String> data value.
6065 *
6066 * @return Returns the same Intent object, for chaining multiple calls
6067 * into a single statement.
6068 *
6069 * @see #putExtras
6070 * @see #removeExtra
6071 * @see #getStringArrayListExtra(String)
6072 */
6073 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
6074 if (mExtras == null) {
6075 mExtras = new Bundle();
6076 }
6077 mExtras.putStringArrayList(name, value);
6078 return this;
6079 }
6080
6081 /**
6082 * Add extended data to the intent. The name must include a package
6083 * prefix, for example the app com.android.contacts would use names
6084 * like "com.android.contacts.ShowAll".
6085 *
6086 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006087 * @param value The ArrayList<CharSequence> data value.
6088 *
6089 * @return Returns the same Intent object, for chaining multiple calls
6090 * into a single statement.
6091 *
6092 * @see #putExtras
6093 * @see #removeExtra
6094 * @see #getCharSequenceArrayListExtra(String)
6095 */
6096 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6097 if (mExtras == null) {
6098 mExtras = new Bundle();
6099 }
6100 mExtras.putCharSequenceArrayList(name, value);
6101 return this;
6102 }
6103
6104 /**
6105 * Add extended data to the intent. The name must include a package
6106 * prefix, for example the app com.android.contacts would use names
6107 * like "com.android.contacts.ShowAll".
6108 *
6109 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006110 * @param value The Serializable data value.
6111 *
6112 * @return Returns the same Intent object, for chaining multiple calls
6113 * into a single statement.
6114 *
6115 * @see #putExtras
6116 * @see #removeExtra
6117 * @see #getSerializableExtra(String)
6118 */
6119 public Intent putExtra(String name, Serializable value) {
6120 if (mExtras == null) {
6121 mExtras = new Bundle();
6122 }
6123 mExtras.putSerializable(name, value);
6124 return this;
6125 }
6126
6127 /**
6128 * Add extended data to the intent. The name must include a package
6129 * prefix, for example the app com.android.contacts would use names
6130 * like "com.android.contacts.ShowAll".
6131 *
6132 * @param name The name of the extra data, with package prefix.
6133 * @param value The boolean array data value.
6134 *
6135 * @return Returns the same Intent object, for chaining multiple calls
6136 * into a single statement.
6137 *
6138 * @see #putExtras
6139 * @see #removeExtra
6140 * @see #getBooleanArrayExtra(String)
6141 */
6142 public Intent putExtra(String name, boolean[] value) {
6143 if (mExtras == null) {
6144 mExtras = new Bundle();
6145 }
6146 mExtras.putBooleanArray(name, value);
6147 return this;
6148 }
6149
6150 /**
6151 * Add extended data to the intent. The name must include a package
6152 * prefix, for example the app com.android.contacts would use names
6153 * like "com.android.contacts.ShowAll".
6154 *
6155 * @param name The name of the extra data, with package prefix.
6156 * @param value The byte array data value.
6157 *
6158 * @return Returns the same Intent object, for chaining multiple calls
6159 * into a single statement.
6160 *
6161 * @see #putExtras
6162 * @see #removeExtra
6163 * @see #getByteArrayExtra(String)
6164 */
6165 public Intent putExtra(String name, byte[] value) {
6166 if (mExtras == null) {
6167 mExtras = new Bundle();
6168 }
6169 mExtras.putByteArray(name, value);
6170 return this;
6171 }
6172
6173 /**
6174 * Add extended data to the intent. The name must include a package
6175 * prefix, for example the app com.android.contacts would use names
6176 * like "com.android.contacts.ShowAll".
6177 *
6178 * @param name The name of the extra data, with package prefix.
6179 * @param value The short array data value.
6180 *
6181 * @return Returns the same Intent object, for chaining multiple calls
6182 * into a single statement.
6183 *
6184 * @see #putExtras
6185 * @see #removeExtra
6186 * @see #getShortArrayExtra(String)
6187 */
6188 public Intent putExtra(String name, short[] value) {
6189 if (mExtras == null) {
6190 mExtras = new Bundle();
6191 }
6192 mExtras.putShortArray(name, value);
6193 return this;
6194 }
6195
6196 /**
6197 * Add extended data to the intent. The name must include a package
6198 * prefix, for example the app com.android.contacts would use names
6199 * like "com.android.contacts.ShowAll".
6200 *
6201 * @param name The name of the extra data, with package prefix.
6202 * @param value The char array data value.
6203 *
6204 * @return Returns the same Intent object, for chaining multiple calls
6205 * into a single statement.
6206 *
6207 * @see #putExtras
6208 * @see #removeExtra
6209 * @see #getCharArrayExtra(String)
6210 */
6211 public Intent putExtra(String name, char[] value) {
6212 if (mExtras == null) {
6213 mExtras = new Bundle();
6214 }
6215 mExtras.putCharArray(name, value);
6216 return this;
6217 }
6218
6219 /**
6220 * Add extended data to the intent. The name must include a package
6221 * prefix, for example the app com.android.contacts would use names
6222 * like "com.android.contacts.ShowAll".
6223 *
6224 * @param name The name of the extra data, with package prefix.
6225 * @param value The int array data value.
6226 *
6227 * @return Returns the same Intent object, for chaining multiple calls
6228 * into a single statement.
6229 *
6230 * @see #putExtras
6231 * @see #removeExtra
6232 * @see #getIntArrayExtra(String)
6233 */
6234 public Intent putExtra(String name, int[] value) {
6235 if (mExtras == null) {
6236 mExtras = new Bundle();
6237 }
6238 mExtras.putIntArray(name, value);
6239 return this;
6240 }
6241
6242 /**
6243 * Add extended data to the intent. The name must include a package
6244 * prefix, for example the app com.android.contacts would use names
6245 * like "com.android.contacts.ShowAll".
6246 *
6247 * @param name The name of the extra data, with package prefix.
6248 * @param value The byte array data value.
6249 *
6250 * @return Returns the same Intent object, for chaining multiple calls
6251 * into a single statement.
6252 *
6253 * @see #putExtras
6254 * @see #removeExtra
6255 * @see #getLongArrayExtra(String)
6256 */
6257 public Intent putExtra(String name, long[] value) {
6258 if (mExtras == null) {
6259 mExtras = new Bundle();
6260 }
6261 mExtras.putLongArray(name, value);
6262 return this;
6263 }
6264
6265 /**
6266 * Add extended data to the intent. The name must include a package
6267 * prefix, for example the app com.android.contacts would use names
6268 * like "com.android.contacts.ShowAll".
6269 *
6270 * @param name The name of the extra data, with package prefix.
6271 * @param value The float array data value.
6272 *
6273 * @return Returns the same Intent object, for chaining multiple calls
6274 * into a single statement.
6275 *
6276 * @see #putExtras
6277 * @see #removeExtra
6278 * @see #getFloatArrayExtra(String)
6279 */
6280 public Intent putExtra(String name, float[] value) {
6281 if (mExtras == null) {
6282 mExtras = new Bundle();
6283 }
6284 mExtras.putFloatArray(name, value);
6285 return this;
6286 }
6287
6288 /**
6289 * Add extended data to the intent. The name must include a package
6290 * prefix, for example the app com.android.contacts would use names
6291 * like "com.android.contacts.ShowAll".
6292 *
6293 * @param name The name of the extra data, with package prefix.
6294 * @param value The double array data value.
6295 *
6296 * @return Returns the same Intent object, for chaining multiple calls
6297 * into a single statement.
6298 *
6299 * @see #putExtras
6300 * @see #removeExtra
6301 * @see #getDoubleArrayExtra(String)
6302 */
6303 public Intent putExtra(String name, double[] value) {
6304 if (mExtras == null) {
6305 mExtras = new Bundle();
6306 }
6307 mExtras.putDoubleArray(name, value);
6308 return this;
6309 }
6310
6311 /**
6312 * Add extended data to the intent. The name must include a package
6313 * prefix, for example the app com.android.contacts would use names
6314 * like "com.android.contacts.ShowAll".
6315 *
6316 * @param name The name of the extra data, with package prefix.
6317 * @param value The String array data value.
6318 *
6319 * @return Returns the same Intent object, for chaining multiple calls
6320 * into a single statement.
6321 *
6322 * @see #putExtras
6323 * @see #removeExtra
6324 * @see #getStringArrayExtra(String)
6325 */
6326 public Intent putExtra(String name, String[] value) {
6327 if (mExtras == null) {
6328 mExtras = new Bundle();
6329 }
6330 mExtras.putStringArray(name, value);
6331 return this;
6332 }
6333
6334 /**
6335 * Add extended data to the intent. The name must include a package
6336 * prefix, for example the app com.android.contacts would use names
6337 * like "com.android.contacts.ShowAll".
6338 *
6339 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006340 * @param value The CharSequence array data value.
6341 *
6342 * @return Returns the same Intent object, for chaining multiple calls
6343 * into a single statement.
6344 *
6345 * @see #putExtras
6346 * @see #removeExtra
6347 * @see #getCharSequenceArrayExtra(String)
6348 */
6349 public Intent putExtra(String name, CharSequence[] value) {
6350 if (mExtras == null) {
6351 mExtras = new Bundle();
6352 }
6353 mExtras.putCharSequenceArray(name, value);
6354 return this;
6355 }
6356
6357 /**
6358 * Add extended data to the intent. The name must include a package
6359 * prefix, for example the app com.android.contacts would use names
6360 * like "com.android.contacts.ShowAll".
6361 *
6362 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006363 * @param value The Bundle data value.
6364 *
6365 * @return Returns the same Intent object, for chaining multiple calls
6366 * into a single statement.
6367 *
6368 * @see #putExtras
6369 * @see #removeExtra
6370 * @see #getBundleExtra(String)
6371 */
6372 public Intent putExtra(String name, Bundle value) {
6373 if (mExtras == null) {
6374 mExtras = new Bundle();
6375 }
6376 mExtras.putBundle(name, value);
6377 return this;
6378 }
6379
6380 /**
6381 * Add extended data to the intent. The name must include a package
6382 * prefix, for example the app com.android.contacts would use names
6383 * like "com.android.contacts.ShowAll".
6384 *
6385 * @param name The name of the extra data, with package prefix.
6386 * @param value The IBinder data value.
6387 *
6388 * @return Returns the same Intent object, for chaining multiple calls
6389 * into a single statement.
6390 *
6391 * @see #putExtras
6392 * @see #removeExtra
6393 * @see #getIBinderExtra(String)
6394 *
6395 * @deprecated
6396 * @hide
6397 */
6398 @Deprecated
6399 public Intent putExtra(String name, IBinder value) {
6400 if (mExtras == null) {
6401 mExtras = new Bundle();
6402 }
6403 mExtras.putIBinder(name, value);
6404 return this;
6405 }
6406
6407 /**
6408 * Copy all extras in 'src' in to this intent.
6409 *
6410 * @param src Contains the extras to copy.
6411 *
6412 * @see #putExtra
6413 */
6414 public Intent putExtras(Intent src) {
6415 if (src.mExtras != null) {
6416 if (mExtras == null) {
6417 mExtras = new Bundle(src.mExtras);
6418 } else {
6419 mExtras.putAll(src.mExtras);
6420 }
6421 }
6422 return this;
6423 }
6424
6425 /**
6426 * Add a set of extended data to the intent. The keys must include a package
6427 * prefix, for example the app com.android.contacts would use names
6428 * like "com.android.contacts.ShowAll".
6429 *
6430 * @param extras The Bundle of extras to add to this intent.
6431 *
6432 * @see #putExtra
6433 * @see #removeExtra
6434 */
6435 public Intent putExtras(Bundle extras) {
6436 if (mExtras == null) {
6437 mExtras = new Bundle();
6438 }
6439 mExtras.putAll(extras);
6440 return this;
6441 }
6442
6443 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006444 * Completely replace the extras in the Intent with the extras in the
6445 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006446 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006447 * @param src The exact extras contained in this Intent are copied
6448 * into the target intent, replacing any that were previously there.
6449 */
6450 public Intent replaceExtras(Intent src) {
6451 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6452 return this;
6453 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006454
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006455 /**
6456 * Completely replace the extras in the Intent with the given Bundle of
6457 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006458 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006459 * @param extras The new set of extras in the Intent, or null to erase
6460 * all extras.
6461 */
6462 public Intent replaceExtras(Bundle extras) {
6463 mExtras = extras != null ? new Bundle(extras) : null;
6464 return this;
6465 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006466
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006467 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006468 * Remove extended data from the intent.
6469 *
6470 * @see #putExtra
6471 */
6472 public void removeExtra(String name) {
6473 if (mExtras != null) {
6474 mExtras.remove(name);
6475 if (mExtras.size() == 0) {
6476 mExtras = null;
6477 }
6478 }
6479 }
6480
6481 /**
6482 * Set special flags controlling how this intent is handled. Most values
6483 * here depend on the type of component being executed by the Intent,
6484 * specifically the FLAG_ACTIVITY_* flags are all for use with
6485 * {@link Context#startActivity Context.startActivity()} and the
6486 * FLAG_RECEIVER_* flags are all for use with
6487 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6488 *
Scott Main7aee61f2011-02-08 11:25:01 -08006489 * <p>See the
6490 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6491 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006492 * the behavior of your application.
6493 *
6494 * @param flags The desired flags.
6495 *
6496 * @return Returns the same Intent object, for chaining multiple calls
6497 * into a single statement.
6498 *
6499 * @see #getFlags
6500 * @see #addFlags
6501 *
6502 * @see #FLAG_GRANT_READ_URI_PERMISSION
6503 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006504 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6505 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006506 * @see #FLAG_DEBUG_LOG_RESOLUTION
6507 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006508 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006509 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006510 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006511 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006512 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6513 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006514 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006515 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006516 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006517 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006518 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006519 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006520 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006521 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6522 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006523 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006524 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006525 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006526 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6527 */
6528 public Intent setFlags(int flags) {
6529 mFlags = flags;
6530 return this;
6531 }
6532
6533 /**
6534 * Add additional flags to the intent (or with existing flags
6535 * value).
6536 *
6537 * @param flags The new flags to set.
6538 *
6539 * @return Returns the same Intent object, for chaining multiple calls
6540 * into a single statement.
6541 *
6542 * @see #setFlags
6543 */
6544 public Intent addFlags(int flags) {
6545 mFlags |= flags;
6546 return this;
6547 }
6548
6549 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006550 * (Usually optional) Set an explicit application package name that limits
6551 * the components this Intent will resolve to. If left to the default
6552 * value of null, all components in all applications will considered.
6553 * If non-null, the Intent can only match the components in the given
6554 * application package.
6555 *
6556 * @param packageName The name of the application package to handle the
6557 * intent, or null to allow any application package.
6558 *
6559 * @return Returns the same Intent object, for chaining multiple calls
6560 * into a single statement.
6561 *
6562 * @see #getPackage
6563 * @see #resolveActivity
6564 */
6565 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006566 if (packageName != null && mSelector != null) {
6567 throw new IllegalArgumentException(
6568 "Can't set package name when selector is already set");
6569 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006570 mPackage = packageName;
6571 return this;
6572 }
6573
6574 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006575 * (Usually optional) Explicitly set the component to handle the intent.
6576 * If left with the default value of null, the system will determine the
6577 * appropriate class to use based on the other fields (action, data,
6578 * type, categories) in the Intent. If this class is defined, the
6579 * specified class will always be used regardless of the other fields. You
6580 * should only set this value when you know you absolutely want a specific
6581 * class to be used; otherwise it is better to let the system find the
6582 * appropriate class so that you will respect the installed applications
6583 * and user preferences.
6584 *
6585 * @param component The name of the application component to handle the
6586 * intent, or null to let the system find one for you.
6587 *
6588 * @return Returns the same Intent object, for chaining multiple calls
6589 * into a single statement.
6590 *
6591 * @see #setClass
6592 * @see #setClassName(Context, String)
6593 * @see #setClassName(String, String)
6594 * @see #getComponent
6595 * @see #resolveActivity
6596 */
6597 public Intent setComponent(ComponentName component) {
6598 mComponent = component;
6599 return this;
6600 }
6601
6602 /**
6603 * Convenience for calling {@link #setComponent} with an
6604 * explicit class name.
6605 *
6606 * @param packageContext A Context of the application package implementing
6607 * this class.
6608 * @param className The name of a class inside of the application package
6609 * that will be used as the component for this Intent.
6610 *
6611 * @return Returns the same Intent object, for chaining multiple calls
6612 * into a single statement.
6613 *
6614 * @see #setComponent
6615 * @see #setClass
6616 */
6617 public Intent setClassName(Context packageContext, String className) {
6618 mComponent = new ComponentName(packageContext, className);
6619 return this;
6620 }
6621
6622 /**
6623 * Convenience for calling {@link #setComponent} with an
6624 * explicit application package name and class name.
6625 *
6626 * @param packageName The name of the package implementing the desired
6627 * component.
6628 * @param className The name of a class inside of the application package
6629 * that will be used as the component for this Intent.
6630 *
6631 * @return Returns the same Intent object, for chaining multiple calls
6632 * into a single statement.
6633 *
6634 * @see #setComponent
6635 * @see #setClass
6636 */
6637 public Intent setClassName(String packageName, String className) {
6638 mComponent = new ComponentName(packageName, className);
6639 return this;
6640 }
6641
6642 /**
6643 * Convenience for calling {@link #setComponent(ComponentName)} with the
6644 * name returned by a {@link Class} object.
6645 *
6646 * @param packageContext A Context of the application package implementing
6647 * this class.
6648 * @param cls The class name to set, equivalent to
6649 * <code>setClassName(context, cls.getName())</code>.
6650 *
6651 * @return Returns the same Intent object, for chaining multiple calls
6652 * into a single statement.
6653 *
6654 * @see #setComponent
6655 */
6656 public Intent setClass(Context packageContext, Class<?> cls) {
6657 mComponent = new ComponentName(packageContext, cls);
6658 return this;
6659 }
6660
6661 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006662 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6663 * used as a hint to the receiver for animations and the like. Null means that there
6664 * is no source bounds.
6665 */
6666 public void setSourceBounds(Rect r) {
6667 if (r != null) {
6668 mSourceBounds = new Rect(r);
6669 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006670 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006671 }
6672 }
6673
Tor Norbyed9273d62013-05-30 15:59:53 -07006674 /** @hide */
6675 @IntDef(flag = true,
6676 value = {
6677 FILL_IN_ACTION,
6678 FILL_IN_DATA,
6679 FILL_IN_CATEGORIES,
6680 FILL_IN_COMPONENT,
6681 FILL_IN_PACKAGE,
6682 FILL_IN_SOURCE_BOUNDS,
6683 FILL_IN_SELECTOR,
6684 FILL_IN_CLIP_DATA
6685 })
6686 @Retention(RetentionPolicy.SOURCE)
6687 public @interface FillInFlags {}
6688
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006689 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006690 * Use with {@link #fillIn} to allow the current action value to be
6691 * overwritten, even if it is already set.
6692 */
6693 public static final int FILL_IN_ACTION = 1<<0;
6694
6695 /**
6696 * Use with {@link #fillIn} to allow the current data or type value
6697 * overwritten, even if it is already set.
6698 */
6699 public static final int FILL_IN_DATA = 1<<1;
6700
6701 /**
6702 * Use with {@link #fillIn} to allow the current categories to be
6703 * overwritten, even if they are already set.
6704 */
6705 public static final int FILL_IN_CATEGORIES = 1<<2;
6706
6707 /**
6708 * Use with {@link #fillIn} to allow the current component value to be
6709 * overwritten, even if it is already set.
6710 */
6711 public static final int FILL_IN_COMPONENT = 1<<3;
6712
6713 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006714 * Use with {@link #fillIn} to allow the current package value to be
6715 * overwritten, even if it is already set.
6716 */
6717 public static final int FILL_IN_PACKAGE = 1<<4;
6718
6719 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006720 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006721 * overwritten, even if it is already set.
6722 */
6723 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6724
6725 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006726 * Use with {@link #fillIn} to allow the current selector to be
6727 * overwritten, even if it is already set.
6728 */
6729 public static final int FILL_IN_SELECTOR = 1<<6;
6730
6731 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006732 * Use with {@link #fillIn} to allow the current ClipData to be
6733 * overwritten, even if it is already set.
6734 */
6735 public static final int FILL_IN_CLIP_DATA = 1<<7;
6736
6737 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006738 * Copy the contents of <var>other</var> in to this object, but only
6739 * where fields are not defined by this object. For purposes of a field
6740 * being defined, the following pieces of data in the Intent are
6741 * considered to be separate fields:
6742 *
6743 * <ul>
6744 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006745 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006746 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6747 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006748 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006749 * <li> component, as set by {@link #setComponent(ComponentName)} or
6750 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006751 * <li> source bounds, as set by {@link #setSourceBounds}.
6752 * <li> selector, as set by {@link #setSelector(Intent)}.
6753 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006754 * <li> each top-level name in the associated extras.
6755 * </ul>
6756 *
6757 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006758 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006759 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6760 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6761 * the restriction where the corresponding field will not be replaced if
6762 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006763 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006764 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6765 * is explicitly specified. The selector will only be copied if
6766 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006767 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006768 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6769 * and Intent B with {action="gotit", data-type="some/thing",
6770 * categories="one","two"}.
6771 *
6772 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6773 * containing: {action="gotit", data-type="some/thing",
6774 * categories="bar"}.
6775 *
6776 * @param other Another Intent whose values are to be used to fill in
6777 * the current one.
6778 * @param flags Options to control which fields can be filled in.
6779 *
6780 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006781 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006782 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6783 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6784 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006785 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006786 @FillInFlags
6787 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006788 int changes = 0;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006789 boolean mayHaveCopiedUris = false;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006790 if (other.mAction != null
6791 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006792 mAction = other.mAction;
6793 changes |= FILL_IN_ACTION;
6794 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006795 if ((other.mData != null || other.mType != null)
6796 && ((mData == null && mType == null)
6797 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006798 mData = other.mData;
6799 mType = other.mType;
6800 changes |= FILL_IN_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006801 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006802 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006803 if (other.mCategories != null
6804 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006805 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006806 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006807 }
6808 changes |= FILL_IN_CATEGORIES;
6809 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006810 if (other.mPackage != null
6811 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006812 // Only do this if mSelector is not set.
6813 if (mSelector == null) {
6814 mPackage = other.mPackage;
6815 changes |= FILL_IN_PACKAGE;
6816 }
6817 }
6818 // Selector is special: it can only be set if explicitly allowed,
6819 // for the same reason as the component name.
6820 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6821 if (mPackage == null) {
6822 mSelector = new Intent(other.mSelector);
6823 mPackage = null;
6824 changes |= FILL_IN_SELECTOR;
6825 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006826 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006827 if (other.mClipData != null
6828 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6829 mClipData = other.mClipData;
6830 changes |= FILL_IN_CLIP_DATA;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006831 mayHaveCopiedUris = true;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006832 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006833 // Component is special: it can -only- be set if explicitly allowed,
6834 // since otherwise the sender could force the intent somewhere the
6835 // originator didn't intend.
6836 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006837 mComponent = other.mComponent;
6838 changes |= FILL_IN_COMPONENT;
6839 }
6840 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006841 if (other.mSourceBounds != null
6842 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6843 mSourceBounds = new Rect(other.mSourceBounds);
6844 changes |= FILL_IN_SOURCE_BOUNDS;
6845 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006846 if (mExtras == null) {
6847 if (other.mExtras != null) {
6848 mExtras = new Bundle(other.mExtras);
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006849 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006850 }
6851 } else if (other.mExtras != null) {
6852 try {
6853 Bundle newb = new Bundle(other.mExtras);
6854 newb.putAll(mExtras);
6855 mExtras = newb;
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006856 mayHaveCopiedUris = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006857 } catch (RuntimeException e) {
6858 // Modifying the extras can cause us to unparcel the contents
6859 // of the bundle, and if we do this in the system process that
6860 // may fail. We really should handle this (i.e., the Bundle
6861 // impl shouldn't be on top of a plain map), but for now just
6862 // ignore it and keep the original contents. :(
6863 Log.w("Intent", "Failure filling in extras", e);
6864 }
6865 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01006866 if (mayHaveCopiedUris && mContentUserHint == UserHandle.USER_CURRENT
6867 && other.mContentUserHint != UserHandle.USER_CURRENT) {
6868 mContentUserHint = other.mContentUserHint;
6869 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006870 return changes;
6871 }
6872
6873 /**
6874 * Wrapper class holding an Intent and implementing comparisons on it for
6875 * the purpose of filtering. The class implements its
6876 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6877 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6878 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6879 * on the wrapped Intent.
6880 */
6881 public static final class FilterComparison {
6882 private final Intent mIntent;
6883 private final int mHashCode;
6884
6885 public FilterComparison(Intent intent) {
6886 mIntent = intent;
6887 mHashCode = intent.filterHashCode();
6888 }
6889
6890 /**
6891 * Return the Intent that this FilterComparison represents.
6892 * @return Returns the Intent held by the FilterComparison. Do
6893 * not modify!
6894 */
6895 public Intent getIntent() {
6896 return mIntent;
6897 }
6898
6899 @Override
6900 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006901 if (obj instanceof FilterComparison) {
6902 Intent other = ((FilterComparison)obj).mIntent;
6903 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006904 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006905 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006906 }
6907
6908 @Override
6909 public int hashCode() {
6910 return mHashCode;
6911 }
6912 }
6913
6914 /**
6915 * Determine if two intents are the same for the purposes of intent
6916 * resolution (filtering). That is, if their action, data, type,
6917 * class, and categories are the same. This does <em>not</em> compare
6918 * any extra data included in the intents.
6919 *
6920 * @param other The other Intent to compare against.
6921 *
6922 * @return Returns true if action, data, type, class, and categories
6923 * are the same.
6924 */
6925 public boolean filterEquals(Intent other) {
6926 if (other == null) {
6927 return false;
6928 }
Christopher Tate63d9ae12014-06-19 19:07:26 -07006929 if (!Objects.equals(this.mAction, other.mAction)) return false;
6930 if (!Objects.equals(this.mData, other.mData)) return false;
6931 if (!Objects.equals(this.mType, other.mType)) return false;
6932 if (!Objects.equals(this.mPackage, other.mPackage)) return false;
6933 if (!Objects.equals(this.mComponent, other.mComponent)) return false;
6934 if (!Objects.equals(this.mCategories, other.mCategories)) return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006935
6936 return true;
6937 }
6938
6939 /**
6940 * Generate hash code that matches semantics of filterEquals().
6941 *
6942 * @return Returns the hash value of the action, data, type, class, and
6943 * categories.
6944 *
6945 * @see #filterEquals
6946 */
6947 public int filterHashCode() {
6948 int code = 0;
6949 if (mAction != null) {
6950 code += mAction.hashCode();
6951 }
6952 if (mData != null) {
6953 code += mData.hashCode();
6954 }
6955 if (mType != null) {
6956 code += mType.hashCode();
6957 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006958 if (mPackage != null) {
6959 code += mPackage.hashCode();
6960 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006961 if (mComponent != null) {
6962 code += mComponent.hashCode();
6963 }
6964 if (mCategories != null) {
6965 code += mCategories.hashCode();
6966 }
6967 return code;
6968 }
6969
6970 @Override
6971 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006972 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006973
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006974 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006975 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006976 b.append(" }");
6977
6978 return b.toString();
6979 }
6980
6981 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006982 public String toInsecureString() {
6983 StringBuilder b = new StringBuilder(128);
6984
6985 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006986 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006987 b.append(" }");
6988
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006989 return b.toString();
6990 }
Romain Guy4969af72009-06-17 10:53:19 -07006991
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006992 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006993 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006994 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006995
6996 b.append("Intent { ");
6997 toShortString(b, false, true, true, true);
6998 b.append(" }");
6999
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007000 return b.toString();
7001 }
7002
7003 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007004 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
7005 StringBuilder b = new StringBuilder(128);
7006 toShortString(b, secure, comp, extras, clip);
7007 return b.toString();
7008 }
7009
7010 /** @hide */
7011 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
7012 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007013 boolean first = true;
7014 if (mAction != null) {
7015 b.append("act=").append(mAction);
7016 first = false;
7017 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007018 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007019 if (!first) {
7020 b.append(' ');
7021 }
7022 first = false;
7023 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007024 for (int i=0; i<mCategories.size(); i++) {
7025 if (i > 0) b.append(',');
7026 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007027 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007028 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007029 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007030 if (mData != null) {
7031 if (!first) {
7032 b.append(' ');
7033 }
7034 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007035 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007036 if (secure) {
7037 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007038 } else {
7039 b.append(mData);
7040 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007041 }
7042 if (mType != null) {
7043 if (!first) {
7044 b.append(' ');
7045 }
7046 first = false;
7047 b.append("typ=").append(mType);
7048 }
7049 if (mFlags != 0) {
7050 if (!first) {
7051 b.append(' ');
7052 }
7053 first = false;
7054 b.append("flg=0x").append(Integer.toHexString(mFlags));
7055 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007056 if (mPackage != null) {
7057 if (!first) {
7058 b.append(' ');
7059 }
7060 first = false;
7061 b.append("pkg=").append(mPackage);
7062 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007063 if (comp && mComponent != null) {
7064 if (!first) {
7065 b.append(' ');
7066 }
7067 first = false;
7068 b.append("cmp=").append(mComponent.flattenToShortString());
7069 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007070 if (mSourceBounds != null) {
7071 if (!first) {
7072 b.append(' ');
7073 }
7074 first = false;
7075 b.append("bnds=").append(mSourceBounds.toShortString());
7076 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007077 if (mClipData != null) {
7078 if (!first) {
7079 b.append(' ');
7080 }
7081 first = false;
7082 if (clip) {
7083 b.append("clip={");
7084 mClipData.toShortString(b);
7085 b.append('}');
7086 } else {
7087 b.append("(has clip)");
7088 }
7089 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007090 if (extras && mExtras != null) {
7091 if (!first) {
7092 b.append(' ');
7093 }
7094 first = false;
7095 b.append("(has extras)");
7096 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007097 if (mContentUserHint != UserHandle.USER_CURRENT) {
7098 if (!first) {
7099 b.append(' ');
7100 }
7101 first = false;
7102 b.append("u=").append(mContentUserHint);
7103 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007104 if (mSelector != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007105 b.append(" sel=");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007106 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007107 b.append("}");
7108 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007109 }
7110
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007111 /**
7112 * Call {@link #toUri} with 0 flags.
7113 * @deprecated Use {@link #toUri} instead.
7114 */
7115 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007116 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007117 return toUri(0);
7118 }
7119
7120 /**
7121 * Convert this Intent into a String holding a URI representation of it.
7122 * The returned URI string has been properly URI encoded, so it can be
7123 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7124 * Intent's data as the base URI, with an additional fragment describing
7125 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007126 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007127 * <p>You can convert the returned string back to an Intent with
7128 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007129 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007130 * @param flags Additional operating flags. Either 0 or
7131 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007132 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007133 * @return Returns a URI encoding URI string describing the entire contents
7134 * of the Intent.
7135 */
7136 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007137 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007138 String scheme = null;
7139 if (mData != null) {
7140 String data = mData.toString();
7141 if ((flags&URI_INTENT_SCHEME) != 0) {
7142 final int N = data.length();
7143 for (int i=0; i<N; i++) {
7144 char c = data.charAt(i);
7145 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7146 || c == '.' || c == '-') {
7147 continue;
7148 }
7149 if (c == ':' && i > 0) {
7150 // Valid scheme.
7151 scheme = data.substring(0, i);
7152 uri.append("intent:");
7153 data = data.substring(i+1);
7154 break;
7155 }
Tom Taylord4a47292009-12-21 13:59:18 -08007156
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007157 // No scheme.
7158 break;
7159 }
7160 }
7161 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007162
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007163 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7164 uri.append("intent:");
7165 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007166
7167 uri.append("#Intent;");
7168
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007169 toUriInner(uri, scheme, flags);
7170 if (mSelector != null) {
7171 uri.append("SEL;");
7172 // Note that for now we are not going to try to handle the
7173 // data part; not clear how to represent this as a URI, and
7174 // not much utility in it.
7175 mSelector.toUriInner(uri, null, flags);
7176 }
7177
7178 uri.append("end");
7179
7180 return uri.toString();
7181 }
7182
7183 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007184 if (scheme != null) {
7185 uri.append("scheme=").append(scheme).append(';');
7186 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007187 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007188 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007189 }
7190 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007191 for (int i=0; i<mCategories.size(); i++) {
7192 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007193 }
7194 }
7195 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007196 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007197 }
7198 if (mFlags != 0) {
7199 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7200 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007201 if (mPackage != null) {
7202 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7203 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007204 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007205 uri.append("component=").append(Uri.encode(
7206 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007207 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007208 if (mSourceBounds != null) {
7209 uri.append("sourceBounds=")
7210 .append(Uri.encode(mSourceBounds.flattenToString()))
7211 .append(';');
7212 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007213 if (mExtras != null) {
7214 for (String key : mExtras.keySet()) {
7215 final Object value = mExtras.get(key);
7216 char entryType =
7217 value instanceof String ? 'S' :
7218 value instanceof Boolean ? 'B' :
7219 value instanceof Byte ? 'b' :
7220 value instanceof Character ? 'c' :
7221 value instanceof Double ? 'd' :
7222 value instanceof Float ? 'f' :
7223 value instanceof Integer ? 'i' :
7224 value instanceof Long ? 'l' :
7225 value instanceof Short ? 's' :
7226 '\0';
7227
7228 if (entryType != '\0') {
7229 uri.append(entryType);
7230 uri.append('.');
7231 uri.append(Uri.encode(key));
7232 uri.append('=');
7233 uri.append(Uri.encode(value.toString()));
7234 uri.append(';');
7235 }
7236 }
7237 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007238 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007239
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007240 public int describeContents() {
7241 return (mExtras != null) ? mExtras.describeContents() : 0;
7242 }
7243
7244 public void writeToParcel(Parcel out, int flags) {
7245 out.writeString(mAction);
7246 Uri.writeToParcel(out, mData);
7247 out.writeString(mType);
7248 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007249 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007250 ComponentName.writeToParcel(mComponent, out);
7251
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007252 if (mSourceBounds != null) {
7253 out.writeInt(1);
7254 mSourceBounds.writeToParcel(out, flags);
7255 } else {
7256 out.writeInt(0);
7257 }
7258
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007259 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007260 final int N = mCategories.size();
7261 out.writeInt(N);
7262 for (int i=0; i<N; i++) {
7263 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007264 }
7265 } else {
7266 out.writeInt(0);
7267 }
7268
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007269 if (mSelector != null) {
7270 out.writeInt(1);
7271 mSelector.writeToParcel(out, flags);
7272 } else {
7273 out.writeInt(0);
7274 }
7275
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007276 if (mClipData != null) {
7277 out.writeInt(1);
7278 mClipData.writeToParcel(out, flags);
7279 } else {
7280 out.writeInt(0);
7281 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007282 out.writeInt(mContentUserHint);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007283 out.writeBundle(mExtras);
7284 }
7285
7286 public static final Parcelable.Creator<Intent> CREATOR
7287 = new Parcelable.Creator<Intent>() {
7288 public Intent createFromParcel(Parcel in) {
7289 return new Intent(in);
7290 }
7291 public Intent[] newArray(int size) {
7292 return new Intent[size];
7293 }
7294 };
7295
Dianne Hackborneb034652009-09-07 00:49:58 -07007296 /** @hide */
7297 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007298 readFromParcel(in);
7299 }
7300
7301 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007302 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007303 mData = Uri.CREATOR.createFromParcel(in);
7304 mType = in.readString();
7305 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007306 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007307 mComponent = ComponentName.readFromParcel(in);
7308
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007309 if (in.readInt() != 0) {
7310 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7311 }
7312
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007313 int N = in.readInt();
7314 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007315 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007316 int i;
7317 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007318 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007319 }
7320 } else {
7321 mCategories = null;
7322 }
7323
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007324 if (in.readInt() != 0) {
7325 mSelector = new Intent(in);
7326 }
7327
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007328 if (in.readInt() != 0) {
7329 mClipData = new ClipData(in);
7330 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007331 mContentUserHint = in.readInt();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007332 mExtras = in.readBundle();
7333 }
7334
7335 /**
7336 * Parses the "intent" element (and its children) from XML and instantiates
7337 * an Intent object. The given XML parser should be located at the tag
7338 * where parsing should start (often named "intent"), from which the
7339 * basic action, data, type, and package and class name will be
7340 * retrieved. The function will then parse in to any child elements,
7341 * looking for <category android:name="xxx"> tags to add categories and
7342 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7343 * to the intent.
7344 *
7345 * @param resources The Resources to use when inflating resources.
7346 * @param parser The XML parser pointing at an "intent" tag.
7347 * @param attrs The AttributeSet interface for retrieving extended
7348 * attribute data at the current <var>parser</var> location.
7349 * @return An Intent object matching the XML data.
7350 * @throws XmlPullParserException If there was an XML parsing error.
7351 * @throws IOException If there was an I/O error.
7352 */
7353 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7354 throws XmlPullParserException, IOException {
7355 Intent intent = new Intent();
7356
7357 TypedArray sa = resources.obtainAttributes(attrs,
7358 com.android.internal.R.styleable.Intent);
7359
7360 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7361
7362 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7363 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7364 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7365
7366 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7367 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7368 if (packageName != null && className != null) {
7369 intent.setComponent(new ComponentName(packageName, className));
7370 }
7371
7372 sa.recycle();
7373
7374 int outerDepth = parser.getDepth();
7375 int type;
7376 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7377 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7378 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7379 continue;
7380 }
7381
7382 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007383 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007384 sa = resources.obtainAttributes(attrs,
7385 com.android.internal.R.styleable.IntentCategory);
7386 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7387 sa.recycle();
7388
7389 if (cat != null) {
7390 intent.addCategory(cat);
7391 }
7392 XmlUtils.skipCurrentTag(parser);
7393
Craig Mautner21d24a22014-04-23 11:45:37 -07007394 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007395 if (intent.mExtras == null) {
7396 intent.mExtras = new Bundle();
7397 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007398 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007399 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007400
7401 } else {
7402 XmlUtils.skipCurrentTag(parser);
7403 }
7404 }
7405
7406 return intent;
7407 }
Nick Pellyccae4122012-01-09 14:12:58 -08007408
Craig Mautner21d24a22014-04-23 11:45:37 -07007409 /** @hide */
7410 public void saveToXml(XmlSerializer out) throws IOException {
7411 if (mAction != null) {
7412 out.attribute(null, ATTR_ACTION, mAction);
7413 }
7414 if (mData != null) {
7415 out.attribute(null, ATTR_DATA, mData.toString());
7416 }
7417 if (mType != null) {
7418 out.attribute(null, ATTR_TYPE, mType);
7419 }
7420 if (mComponent != null) {
7421 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7422 }
7423 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7424
7425 if (mCategories != null) {
7426 out.startTag(null, TAG_CATEGORIES);
7427 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7428 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7429 }
Craig Mautner43e52ed2014-06-16 17:18:52 -07007430 out.endTag(null, TAG_CATEGORIES);
Craig Mautner21d24a22014-04-23 11:45:37 -07007431 }
7432 }
7433
7434 /** @hide */
7435 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7436 XmlPullParserException {
7437 Intent intent = new Intent();
7438 final int outerDepth = in.getDepth();
7439
7440 int attrCount = in.getAttributeCount();
7441 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7442 final String attrName = in.getAttributeName(attrNdx);
7443 final String attrValue = in.getAttributeValue(attrNdx);
7444 if (ATTR_ACTION.equals(attrName)) {
7445 intent.setAction(attrValue);
7446 } else if (ATTR_DATA.equals(attrName)) {
7447 intent.setData(Uri.parse(attrValue));
7448 } else if (ATTR_TYPE.equals(attrName)) {
7449 intent.setType(attrValue);
7450 } else if (ATTR_COMPONENT.equals(attrName)) {
7451 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7452 } else if (ATTR_FLAGS.equals(attrName)) {
7453 intent.setFlags(Integer.valueOf(attrValue, 16));
7454 } else {
7455 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7456 }
7457 }
7458
7459 int event;
7460 String name;
7461 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7462 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7463 if (event == XmlPullParser.START_TAG) {
7464 name = in.getName();
7465 if (TAG_CATEGORIES.equals(name)) {
7466 attrCount = in.getAttributeCount();
7467 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7468 intent.addCategory(in.getAttributeValue(attrNdx));
7469 }
7470 } else {
7471 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7472 XmlUtils.skipCurrentTag(in);
7473 }
7474 }
7475 }
7476
7477 return intent;
7478 }
7479
Nick Pellyccae4122012-01-09 14:12:58 -08007480 /**
7481 * Normalize a MIME data type.
7482 *
7483 * <p>A normalized MIME type has white-space trimmed,
7484 * content-type parameters removed, and is lower-case.
7485 * This aligns the type with Android best practices for
7486 * intent filtering.
7487 *
7488 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7489 * "text/x-vCard" becomes "text/x-vcard".
7490 *
7491 * <p>All MIME types received from outside Android (such as user input,
7492 * or external sources like Bluetooth, NFC, or the Internet) should
7493 * be normalized before they are used to create an Intent.
7494 *
7495 * @param type MIME data type to normalize
7496 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007497 * @see #setType
7498 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007499 */
7500 public static String normalizeMimeType(String type) {
7501 if (type == null) {
7502 return null;
7503 }
7504
Elliott Hughescb64d432013-08-02 10:00:44 -07007505 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007506
7507 final int semicolonIndex = type.indexOf(';');
7508 if (semicolonIndex != -1) {
7509 type = type.substring(0, semicolonIndex);
7510 }
7511 return type;
7512 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007513
7514 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007515 * Prepare this {@link Intent} to leave an app process.
7516 *
7517 * @hide
7518 */
7519 public void prepareToLeaveProcess() {
7520 setAllowFds(false);
7521
7522 if (mSelector != null) {
7523 mSelector.prepareToLeaveProcess();
7524 }
7525 if (mClipData != null) {
7526 mClipData.prepareToLeaveProcess();
7527 }
7528
7529 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7530 // There are several ACTION_MEDIA_* broadcasts that send file://
7531 // Uris, so only check common actions.
7532 if (ACTION_VIEW.equals(mAction) ||
7533 ACTION_EDIT.equals(mAction) ||
7534 ACTION_ATTACH_DATA.equals(mAction)) {
7535 mData.checkFileUriExposed("Intent.getData()");
7536 }
7537 }
7538 }
7539
7540 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007541 * @hide
7542 */
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007543 public void prepareToEnterProcess() {
7544 if (mContentUserHint != UserHandle.USER_CURRENT) {
7545 fixUris(mContentUserHint);
7546 mContentUserHint = UserHandle.USER_CURRENT;
7547 }
7548 }
7549
7550 /**
7551 * @hide
7552 */
7553 public void fixUris(int contentUserHint) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007554 Uri data = getData();
7555 if (data != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007556 mData = maybeAddUserId(data, contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007557 }
7558 if (mClipData != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007559 mClipData.fixUris(contentUserHint);
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007560 }
7561 String action = getAction();
7562 if (ACTION_SEND.equals(action)) {
7563 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7564 if (stream != null) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007565 putExtra(EXTRA_STREAM, maybeAddUserId(stream, contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007566 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007567 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007568 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7569 if (streams != null) {
7570 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7571 for (int i = 0; i < streams.size(); i++) {
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007572 newStreams.add(maybeAddUserId(streams.get(i), contentUserHint));
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007573 }
7574 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7575 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007576 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7577 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7578 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7579 final Uri output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7580 if (output != null) {
7581 putExtra(MediaStore.EXTRA_OUTPUT, maybeAddUserId(output, contentUserHint));
7582 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007583 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007584 }
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007585
7586 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007587 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007588 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7589 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007590 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007591 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007592 * @hide
7593 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007594 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007595 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007596 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007597
7598 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007599 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007600
7601 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007602 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007603 try {
7604 // Inspect target intent to see if we need to migrate
7605 final Intent target = getParcelableExtra(EXTRA_INTENT);
7606 if (target != null && target.migrateExtraStreamToClipData()) {
7607 // Since we migrated in child, we need to promote ClipData
7608 // and flags to ourselves to grant.
7609 setClipData(target.getClipData());
Jeff Sharkey846318a2014-04-04 12:12:41 -07007610 addFlags(target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
7611 | FLAG_GRANT_WRITE_URI_PERMISSION
7612 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7613 | FLAG_GRANT_PREFIX_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007614 return true;
7615 } else {
7616 return false;
7617 }
7618 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007619 }
7620
7621 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007622 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007623 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7624 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7625 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7626 if (stream != null || text != null || htmlText != null) {
7627 final ClipData clipData = new ClipData(
7628 null, new String[] { getType() },
7629 new ClipData.Item(text, htmlText, null, stream));
7630 setClipData(clipData);
7631 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007632 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007633 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007634 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007635 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007636
7637 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007638 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007639 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7640 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7641 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7642 int num = -1;
7643 if (streams != null) {
7644 num = streams.size();
7645 }
7646 if (texts != null) {
7647 if (num >= 0 && num != texts.size()) {
7648 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007649 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007650 }
7651 num = texts.size();
7652 }
7653 if (htmlTexts != null) {
7654 if (num >= 0 && num != htmlTexts.size()) {
7655 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007656 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007657 }
7658 num = htmlTexts.size();
7659 }
7660 if (num > 0) {
7661 final ClipData clipData = new ClipData(
7662 null, new String[] { getType() },
7663 makeClipItem(streams, texts, htmlTexts, 0));
7664
7665 for (int i = 1; i < num; i++) {
7666 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7667 }
7668
7669 setClipData(clipData);
7670 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007671 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007672 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007673 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007674 }
Nicolas Prevotd1c99b12014-07-04 16:56:17 +01007675 } else if (MediaStore.ACTION_IMAGE_CAPTURE.equals(action)
7676 || MediaStore.ACTION_IMAGE_CAPTURE_SECURE.equals(action)
7677 || MediaStore.ACTION_VIDEO_CAPTURE.equals(action)) {
7678 final Uri output;
7679 try {
7680 output = getParcelableExtra(MediaStore.EXTRA_OUTPUT);
7681 } catch (ClassCastException e) {
7682 return false;
7683 }
7684 if (output != null) {
7685 setClipData(ClipData.newRawUri("", output));
7686 addFlags(FLAG_GRANT_WRITE_URI_PERMISSION|FLAG_GRANT_READ_URI_PERMISSION);
7687 return true;
7688 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007689 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007690
7691 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007692 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007693
7694 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7695 ArrayList<String> htmlTexts, int which) {
7696 Uri uri = streams != null ? streams.get(which) : null;
7697 CharSequence text = texts != null ? texts.get(which) : null;
7698 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7699 return new ClipData.Item(text, htmlText, null, uri);
7700 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007701
7702 /** @hide */
7703 public boolean isDocument() {
7704 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7705 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007706}