blob: cd0de1223451cb5801b58a6910c896bf757303ce [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;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070020import android.util.ArraySet;
Jeff Sharkey846318a2014-04-04 12:12:41 -070021
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070022import org.xmlpull.v1.XmlPullParser;
23import org.xmlpull.v1.XmlPullParserException;
24
Tor Norbyed9273d62013-05-30 15:59:53 -070025import android.annotation.IntDef;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070026import android.annotation.SdkConstant;
27import android.annotation.SdkConstant.SdkConstantType;
28import android.content.pm.ActivityInfo;
Nicolas Prevotd85fc722014-04-16 19:52:08 +010029import static android.content.ContentProvider.maybeAddUserId;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.content.pm.PackageManager;
31import android.content.pm.ResolveInfo;
32import android.content.res.Resources;
33import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080034import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070035import android.net.Uri;
36import android.os.Bundle;
37import android.os.IBinder;
38import android.os.Parcel;
39import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070040import android.os.StrictMode;
Jeff Sharkeybd3b9022013-08-20 15:20:04 -070041import android.provider.DocumentsContract;
Jeff Sharkeyadef88a2013-10-15 13:54:44 -070042import android.provider.DocumentsProvider;
43import android.provider.OpenableColumns;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070044import android.util.AttributeSet;
45import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080046
47import com.android.internal.util.XmlUtils;
Craig Mautner21d24a22014-04-23 11:45:37 -070048import org.xmlpull.v1.XmlSerializer;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070049
50import java.io.IOException;
51import java.io.Serializable;
Tor Norbyed9273d62013-05-30 15:59:53 -070052import java.lang.annotation.Retention;
53import java.lang.annotation.RetentionPolicy;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070054import java.net.URISyntaxException;
55import java.util.ArrayList;
Dianne Hackborn221ea892013-08-04 16:50:16 -070056import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080057import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070058import java.util.Set;
59
60/**
61 * An intent is an abstract description of an operation to be performed. It
62 * can be used with {@link Context#startActivity(Intent) startActivity} to
63 * launch an {@link android.app.Activity},
64 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
65 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
66 * and {@link android.content.Context#startService} or
67 * {@link android.content.Context#bindService} to communicate with a
68 * background {@link android.app.Service}.
69 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070070 * <p>An Intent provides a facility for performing late runtime binding between the code in
71 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070072 * can be thought of as the glue between activities. It is basically a passive data structure
73 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070074 *
75 * <div class="special reference">
76 * <h3>Developer Guides</h3>
77 * <p>For information about how to create and resolve intents, read the
78 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
79 * developer guide.</p>
80 * </div>
81 *
82 * <a name="IntentStructure"></a>
83 * <h3>Intent Structure</h3>
84 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070085 *
86 * <ul>
87 * <li> <p><b>action</b> -- The general action to be performed, such as
88 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
89 * etc.</p>
90 * </li>
91 * <li> <p><b>data</b> -- The data to operate on, such as a person record
92 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
93 * </li>
94 * </ul>
95 *
96 *
97 * <p>Some examples of action/data pairs are:</p>
98 *
99 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700100 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700101 * information about the person whose identifier is "1".</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * the phone dialer with the person filled in.</p>
105 * </li>
106 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
107 * the phone dialer with the given number filled in. Note how the
108 * VIEW action does what what is considered the most reasonable thing for
109 * a particular URI.</p>
110 * </li>
111 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
112 * the phone dialer with the given number filled in.</p>
113 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700114 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700115 * information about the person whose identifier is "1".</p>
116 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700117 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700118 * a list of people, which the user can browse through. This example is a
119 * typical top-level entry into the Contacts application, showing you the
120 * list of people. Selecting a particular person to view would result in a
121 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
122 * being used to start an activity to display that person.</p>
123 * </li>
124 * </ul>
125 *
126 * <p>In addition to these primary attributes, there are a number of secondary
127 * attributes that you can also include with an intent:</p>
128 *
129 * <ul>
130 * <li> <p><b>category</b> -- Gives additional information about the action
131 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
132 * appear in the Launcher as a top-level application, while
133 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
134 * of alternative actions the user can perform on a piece of data.</p>
135 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
136 * intent data. Normally the type is inferred from the data itself.
137 * By setting this attribute, you disable that evaluation and force
138 * an explicit type.</p>
139 * <li> <p><b>component</b> -- Specifies an explicit name of a component
140 * class to use for the intent. Normally this is determined by looking
141 * at the other information in the intent (the action, data/type, and
142 * categories) and matching that with a component that can handle it.
143 * If this attribute is set then none of the evaluation is performed,
144 * and this component is used exactly as is. By specifying this attribute,
145 * all of the other Intent attributes become optional.</p>
146 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
147 * This can be used to provide extended information to the component.
148 * For example, if we have a action to send an e-mail message, we could
149 * also include extra pieces of data here to supply a subject, body,
150 * etc.</p>
151 * </ul>
152 *
153 * <p>Here are some examples of other operations you can specify as intents
154 * using these additional parameters:</p>
155 *
156 * <ul>
157 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
158 * Launch the home screen.</p>
159 * </li>
160 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
161 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
162 * vnd.android.cursor.item/phone}</i></b>
163 * -- Display the list of people's phone numbers, allowing the user to
164 * browse through them and pick one and return it to the parent activity.</p>
165 * </li>
166 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
167 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
168 * -- Display all pickers for data that can be opened with
169 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
170 * allowing the user to pick one of them and then some data inside of it
171 * and returning the resulting URI to the caller. This can be used,
172 * for example, in an e-mail application to allow the user to pick some
173 * data to include as an attachment.</p>
174 * </li>
175 * </ul>
176 *
177 * <p>There are a variety of standard Intent action and category constants
178 * defined in the Intent class, but applications can also define their own.
179 * These strings use java style scoping, to ensure they are unique -- for
180 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700181 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700182 *
183 * <p>Put together, the set of actions, data types, categories, and extra data
184 * defines a language for the system allowing for the expression of phrases
185 * such as "call john smith's cell". As applications are added to the system,
186 * they can extend this language by adding new actions, types, and categories, or
187 * they can modify the behavior of existing phrases by supplying their own
188 * activities that handle them.</p>
189 *
190 * <a name="IntentResolution"></a>
191 * <h3>Intent Resolution</h3>
192 *
193 * <p>There are two primary forms of intents you will use.
194 *
195 * <ul>
196 * <li> <p><b>Explicit Intents</b> have specified a component (via
197 * {@link #setComponent} or {@link #setClass}), which provides the exact
198 * class to be run. Often these will not include any other information,
199 * simply being a way for an application to launch various internal
200 * activities it has as the user interacts with the application.
201 *
202 * <li> <p><b>Implicit Intents</b> have not specified a component;
203 * instead, they must include enough information for the system to
204 * determine which of the available components is best to run for that
205 * intent.
206 * </ul>
207 *
208 * <p>When using implicit intents, given such an arbitrary intent we need to
209 * know what to do with it. This is handled by the process of <em>Intent
210 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
211 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
212 * more activities/receivers) that can handle it.</p>
213 *
214 * <p>The intent resolution mechanism basically revolves around matching an
215 * Intent against all of the &lt;intent-filter&gt; descriptions in the
216 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
217 * objects explicitly registered with {@link Context#registerReceiver}.) More
218 * details on this can be found in the documentation on the {@link
219 * IntentFilter} class.</p>
220 *
221 * <p>There are three pieces of information in the Intent that are used for
222 * resolution: the action, type, and category. Using this information, a query
223 * is done on the {@link PackageManager} for a component that can handle the
224 * intent. The appropriate component is determined based on the intent
225 * information supplied in the <code>AndroidManifest.xml</code> file as
226 * follows:</p>
227 *
228 * <ul>
229 * <li> <p>The <b>action</b>, if given, must be listed by the component as
230 * one it handles.</p>
231 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
232 * already supplied in the Intent. Like the action, if a type is
233 * included in the intent (either explicitly or implicitly in its
234 * data), then this must be listed by the component as one it handles.</p>
235 * <li> For data that is not a <code>content:</code> URI and where no explicit
236 * type is included in the Intent, instead the <b>scheme</b> of the
237 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
238 * considered. Again like the action, if we are matching a scheme it
239 * must be listed by the component as one it can handle.
240 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
241 * by the activity as categories it handles. That is, if you include
242 * the categories {@link #CATEGORY_LAUNCHER} and
243 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
244 * with an intent that lists <em>both</em> of those categories.
245 * Activities will very often need to support the
246 * {@link #CATEGORY_DEFAULT} so that they can be found by
247 * {@link Context#startActivity Context.startActivity()}.</p>
248 * </ul>
249 *
250 * <p>For example, consider the Note Pad sample application that
251 * allows user to browse through a list of notes data and view details about
252 * individual items. Text in italics indicate places were you would replace a
253 * name with one specific to your own package.</p>
254 *
255 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
256 * package="<i>com.android.notepad</i>"&gt;
257 * &lt;application android:icon="@drawable/app_notes"
258 * android:label="@string/app_name"&gt;
259 *
260 * &lt;provider class=".NotePadProvider"
261 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
262 *
263 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.MAIN" /&gt;
266 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700267 * &lt;/intent-filter&gt;
268 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700269 * &lt;action android:name="android.intent.action.VIEW" /&gt;
270 * &lt;action android:name="android.intent.action.EDIT" /&gt;
271 * &lt;action android:name="android.intent.action.PICK" /&gt;
272 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
273 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&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.GET_CONTENT" /&gt;
277 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
278 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700279 * &lt;/intent-filter&gt;
280 * &lt;/activity&gt;
281 *
282 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
283 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700284 * &lt;action android:name="android.intent.action.VIEW" /&gt;
285 * &lt;action android:name="android.intent.action.EDIT" /&gt;
286 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
287 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700288 * &lt;/intent-filter&gt;
289 *
290 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700291 * &lt;action android:name="android.intent.action.INSERT" /&gt;
292 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
293 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700294 * &lt;/intent-filter&gt;
295 *
296 * &lt;/activity&gt;
297 *
298 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
299 * android:theme="@android:style/Theme.Dialog"&gt;
300 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700301 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
302 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
303 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
304 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
305 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700306 * &lt;/intent-filter&gt;
307 * &lt;/activity&gt;
308 *
309 * &lt;/application&gt;
310 * &lt;/manifest&gt;</pre>
311 *
312 * <p>The first activity,
313 * <code>com.android.notepad.NotesList</code>, serves as our main
314 * entry into the app. It can do three things as described by its three intent
315 * templates:
316 * <ol>
317 * <li><pre>
318 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700319 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700321 * &lt;/intent-filter&gt;</pre>
322 * <p>This provides a top-level entry into the NotePad application: the standard
323 * MAIN action is a main entry point (not requiring any other information in
324 * the Intent), and the LAUNCHER category says that this entry point should be
325 * listed in the application launcher.</p>
326 * <li><pre>
327 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700328 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
329 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
330 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
331 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
332 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700333 * &lt;/intent-filter&gt;</pre>
334 * <p>This declares the things that the activity can do on a directory of
335 * notes. The type being supported is given with the &lt;type&gt; tag, where
336 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
337 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
338 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
339 * The activity allows the user to view or edit the directory of data (via
340 * the VIEW and EDIT actions), or to pick a particular note and return it
341 * to the caller (via the PICK action). Note also the DEFAULT category
342 * supplied here: this is <em>required</em> for the
343 * {@link Context#startActivity Context.startActivity} method to resolve your
344 * activity when its component name is not explicitly specified.</p>
345 * <li><pre>
346 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700347 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
348 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
349 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700350 * &lt;/intent-filter&gt;</pre>
351 * <p>This filter describes the ability return to the caller a note selected by
352 * the user without needing to know where it came from. The data type
353 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
354 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
355 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
356 * The GET_CONTENT action is similar to the PICK action, where the activity
357 * will return to its caller a piece of data selected by the user. Here,
358 * however, the caller specifies the type of data they desire instead of
359 * the type of data the user will be picking from.</p>
360 * </ol>
361 *
362 * <p>Given these capabilities, the following intents will resolve to the
363 * NotesList activity:</p>
364 *
365 * <ul>
366 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
367 * activities that can be used as top-level entry points into an
368 * application.</p>
369 * <li> <p><b>{ action=android.app.action.MAIN,
370 * category=android.app.category.LAUNCHER }</b> is the actual intent
371 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700372 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700373 * data=content://com.google.provider.NotePad/notes }</b>
374 * displays a list of all the notes under
375 * "content://com.google.provider.NotePad/notes", which
376 * the user can browse through and see the details on.</p>
377 * <li> <p><b>{ action=android.app.action.PICK
378 * data=content://com.google.provider.NotePad/notes }</b>
379 * provides a list of the notes under
380 * "content://com.google.provider.NotePad/notes", from which
381 * the user can pick a note whose data URL is returned back to the caller.</p>
382 * <li> <p><b>{ action=android.app.action.GET_CONTENT
383 * type=vnd.android.cursor.item/vnd.google.note }</b>
384 * is similar to the pick action, but allows the caller to specify the
385 * kind of data they want back so that the system can find the appropriate
386 * activity to pick something of that data type.</p>
387 * </ul>
388 *
389 * <p>The second activity,
390 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
391 * note entry and allows them to edit it. It can do two things as described
392 * by its two intent templates:
393 * <ol>
394 * <li><pre>
395 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700396 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
397 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
398 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
399 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700400 * &lt;/intent-filter&gt;</pre>
401 * <p>The first, primary, purpose of this activity is to let the user interact
402 * with a single note, as decribed by the MIME type
403 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
404 * either VIEW a note or allow the user to EDIT it. Again we support the
405 * DEFAULT category to allow the activity to be launched without explicitly
406 * specifying its component.</p>
407 * <li><pre>
408 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700409 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
410 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
411 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700412 * &lt;/intent-filter&gt;</pre>
413 * <p>The secondary use of this activity is to insert a new note entry into
414 * an existing directory of notes. This is used when the user creates a new
415 * note: the INSERT action is executed on the directory of notes, causing
416 * this activity to run and have the user create the new note data which
417 * it then adds to the content provider.</p>
418 * </ol>
419 *
420 * <p>Given these capabilities, the following intents will resolve to the
421 * NoteEditor activity:</p>
422 *
423 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700424 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700425 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
426 * shows the user the content of note <var>{ID}</var>.</p>
427 * <li> <p><b>{ action=android.app.action.EDIT
428 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
429 * allows the user to edit the content of note <var>{ID}</var>.</p>
430 * <li> <p><b>{ action=android.app.action.INSERT
431 * data=content://com.google.provider.NotePad/notes }</b>
432 * creates a new, empty note in the notes list at
433 * "content://com.google.provider.NotePad/notes"
434 * and allows the user to edit it. If they keep their changes, the URI
435 * of the newly created note is returned to the caller.</p>
436 * </ul>
437 *
438 * <p>The last activity,
439 * <code>com.android.notepad.TitleEditor</code>, allows the user to
440 * edit the title of a note. This could be implemented as a class that the
441 * application directly invokes (by explicitly setting its component in
442 * the Intent), but here we show a way you can publish alternative
443 * operations on existing data:</p>
444 *
445 * <pre>
446 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700447 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
448 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
449 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
450 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
451 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700452 * &lt;/intent-filter&gt;</pre>
453 *
454 * <p>In the single intent template here, we
455 * have created our own private action called
456 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
457 * edit the title of a note. It must be invoked on a specific note
458 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
459 * view and edit actions, but here displays and edits the title contained
460 * in the note data.
461 *
462 * <p>In addition to supporting the default category as usual, our title editor
463 * also supports two other standard categories: ALTERNATIVE and
464 * SELECTED_ALTERNATIVE. Implementing
465 * these categories allows others to find the special action it provides
466 * without directly knowing about it, through the
467 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
468 * more often to build dynamic menu items with
469 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
470 * template here was also supply an explicit name for the template
471 * (via <code>android:label="@string/resolve_title"</code>) to better control
472 * what the user sees when presented with this activity as an alternative
473 * action to the data they are viewing.
474 *
475 * <p>Given these capabilities, the following intent will resolve to the
476 * TitleEditor activity:</p>
477 *
478 * <ul>
479 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
480 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
481 * displays and allows the user to edit the title associated
482 * with note <var>{ID}</var>.</p>
483 * </ul>
484 *
485 * <h3>Standard Activity Actions</h3>
486 *
487 * <p>These are the current standard actions that Intent defines for launching
488 * activities (usually through {@link Context#startActivity}. The most
489 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
490 * {@link #ACTION_EDIT}.
491 *
492 * <ul>
493 * <li> {@link #ACTION_MAIN}
494 * <li> {@link #ACTION_VIEW}
495 * <li> {@link #ACTION_ATTACH_DATA}
496 * <li> {@link #ACTION_EDIT}
497 * <li> {@link #ACTION_PICK}
498 * <li> {@link #ACTION_CHOOSER}
499 * <li> {@link #ACTION_GET_CONTENT}
500 * <li> {@link #ACTION_DIAL}
501 * <li> {@link #ACTION_CALL}
502 * <li> {@link #ACTION_SEND}
503 * <li> {@link #ACTION_SENDTO}
504 * <li> {@link #ACTION_ANSWER}
505 * <li> {@link #ACTION_INSERT}
506 * <li> {@link #ACTION_DELETE}
507 * <li> {@link #ACTION_RUN}
508 * <li> {@link #ACTION_SYNC}
509 * <li> {@link #ACTION_PICK_ACTIVITY}
510 * <li> {@link #ACTION_SEARCH}
511 * <li> {@link #ACTION_WEB_SEARCH}
512 * <li> {@link #ACTION_FACTORY_TEST}
513 * </ul>
514 *
515 * <h3>Standard Broadcast Actions</h3>
516 *
517 * <p>These are the current standard actions that Intent defines for receiving
518 * broadcasts (usually through {@link Context#registerReceiver} or a
519 * &lt;receiver&gt; tag in a manifest).
520 *
521 * <ul>
522 * <li> {@link #ACTION_TIME_TICK}
523 * <li> {@link #ACTION_TIME_CHANGED}
524 * <li> {@link #ACTION_TIMEZONE_CHANGED}
525 * <li> {@link #ACTION_BOOT_COMPLETED}
526 * <li> {@link #ACTION_PACKAGE_ADDED}
527 * <li> {@link #ACTION_PACKAGE_CHANGED}
528 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800529 * <li> {@link #ACTION_PACKAGE_RESTARTED}
530 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700531 * <li> {@link #ACTION_UID_REMOVED}
532 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700533 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700534 * <li> {@link #ACTION_POWER_DISCONNECTED}
535 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700536 * </ul>
537 *
538 * <h3>Standard Categories</h3>
539 *
540 * <p>These are the current standard categories that can be used to further
541 * clarify an Intent via {@link #addCategory}.
542 *
543 * <ul>
544 * <li> {@link #CATEGORY_DEFAULT}
545 * <li> {@link #CATEGORY_BROWSABLE}
546 * <li> {@link #CATEGORY_TAB}
547 * <li> {@link #CATEGORY_ALTERNATIVE}
548 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
549 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800550 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700551 * <li> {@link #CATEGORY_HOME}
552 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700553 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400554 * <li> {@link #CATEGORY_CAR_DOCK}
555 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500556 * <li> {@link #CATEGORY_LE_DESK_DOCK}
557 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200558 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700559 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700560 * </ul>
561 *
562 * <h3>Standard Extra Data</h3>
563 *
564 * <p>These are the current standard fields that can be used as extra data via
565 * {@link #putExtra}.
566 *
567 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800568 * <li> {@link #EXTRA_ALARM_COUNT}
569 * <li> {@link #EXTRA_BCC}
570 * <li> {@link #EXTRA_CC}
571 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
572 * <li> {@link #EXTRA_DATA_REMOVED}
573 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500574 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
575 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_DOCK_STATE_CAR}
577 * <li> {@link #EXTRA_DOCK_STATE_DESK}
578 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
579 * <li> {@link #EXTRA_DONT_KILL_APP}
580 * <li> {@link #EXTRA_EMAIL}
581 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700582 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700584 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800585 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700586 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800587 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
588 * <li> {@link #EXTRA_REPLACING}
589 * <li> {@link #EXTRA_SHORTCUT_ICON}
590 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
591 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700592 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800593 * <li> {@link #EXTRA_SHORTCUT_NAME}
594 * <li> {@link #EXTRA_SUBJECT}
595 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700596 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800597 * <li> {@link #EXTRA_TITLE}
598 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 * </ul>
600 *
601 * <h3>Flags</h3>
602 *
603 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800604 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
605 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800607public class Intent implements Parcelable, Cloneable {
Craig Mautner21d24a22014-04-23 11:45:37 -0700608 private static final String ATTR_ACTION = "action";
609 private static final String TAG_CATEGORIES = "categories";
610 private static final String ATTR_CATEGORY = "category";
611 private static final String TAG_EXTRA = "extra";
612 private static final String ATTR_TYPE = "type";
613 private static final String ATTR_COMPONENT = "component";
614 private static final String ATTR_DATA = "data";
615 private static final String ATTR_FLAGS = "flags";
616
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700617 // ---------------------------------------------------------------------
618 // ---------------------------------------------------------------------
619 // Standard intent activity actions (see action variable).
620
621 /**
622 * Activity Action: Start as a main entry point, does not expect to
623 * receive data.
624 * <p>Input: nothing
625 * <p>Output: nothing
626 */
627 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
628 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Activity Action: Display the data to the user. This is the most common
632 * action performed on data -- it is the generic action you can use on
633 * a piece of data to get the most reasonable thing to occur. For example,
634 * when used on a contacts entry it will view the entry; when used on a
635 * mailto: URI it will bring up a compose window filled with the information
636 * supplied by the URI; when used with a tel: URI it will invoke the
637 * dialer.
638 * <p>Input: {@link #getData} is URI from which to retrieve data.
639 * <p>Output: nothing.
640 */
641 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
642 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800643
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700644 /**
645 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
646 * performed on a piece of data.
647 */
648 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700650 /**
651 * Used to indicate that some piece of data should be attached to some other
652 * place. For example, image data could be attached to a contact. It is up
653 * to the recipient to decide where the data should be attached; the intent
654 * does not specify the ultimate destination.
655 * <p>Input: {@link #getData} is URI of data to be attached.
656 * <p>Output: nothing.
657 */
658 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
659 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700661 /**
662 * Activity Action: Provide explicit editable access to the given data.
663 * <p>Input: {@link #getData} is URI of data to be edited.
664 * <p>Output: nothing.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
671 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
672 * The extras can contain type specific data to pass through to the editing/creating
673 * activity.
674 * <p>Output: The URI of the item that was picked. This must be a content:
675 * URI so that any receiver can access it.
676 */
677 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
678 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800679
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700680 /**
681 * Activity Action: Pick an item from the data, returning what was selected.
682 * <p>Input: {@link #getData} is URI containing a directory of data
683 * (vnd.android.cursor.dir/*) from which to pick an item.
684 * <p>Output: The URI of the item that was picked.
685 */
686 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
687 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700689 /**
690 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800691 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700692 * <p>Output: An Intent representing the shortcut. The intent must contain three
693 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
694 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800695 * (value: ShortcutIconResource).</p>
696 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700697 * @see #EXTRA_SHORTCUT_INTENT
698 * @see #EXTRA_SHORTCUT_NAME
699 * @see #EXTRA_SHORTCUT_ICON
700 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
701 * @see android.content.Intent.ShortcutIconResource
702 */
703 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
704 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
705
706 /**
707 * The name of the extra used to define the Intent of a shortcut.
708 *
709 * @see #ACTION_CREATE_SHORTCUT
710 */
711 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
712 /**
713 * The name of the extra used to define the name of a shortcut.
714 *
715 * @see #ACTION_CREATE_SHORTCUT
716 */
717 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
718 /**
719 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
720 *
721 * @see #ACTION_CREATE_SHORTCUT
722 */
723 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
724 /**
725 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
726 *
727 * @see #ACTION_CREATE_SHORTCUT
728 * @see android.content.Intent.ShortcutIconResource
729 */
730 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
731 "android.intent.extra.shortcut.ICON_RESOURCE";
732
733 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800734 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700735 *
736 * @see Intent#ACTION_CREATE_SHORTCUT
737 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800738 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
739 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700740 */
741 public static class ShortcutIconResource implements Parcelable {
742 /**
743 * The package name of the application containing the icon.
744 */
745 public String packageName;
746
747 /**
748 * The resource name of the icon, including package, name and type.
749 */
750 public String resourceName;
751
752 /**
753 * Creates a new ShortcutIconResource for the specified context and resource
754 * identifier.
755 *
756 * @param context The context of the application.
757 * @param resourceId The resource idenfitier for the icon.
758 * @return A new ShortcutIconResource with the specified's context package name
759 * and icon resource idenfitier.
760 */
761 public static ShortcutIconResource fromContext(Context context, int resourceId) {
762 ShortcutIconResource icon = new ShortcutIconResource();
763 icon.packageName = context.getPackageName();
764 icon.resourceName = context.getResources().getResourceName(resourceId);
765 return icon;
766 }
767
768 /**
769 * Used to read a ShortcutIconResource from a Parcel.
770 */
771 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
772 new Parcelable.Creator<ShortcutIconResource>() {
773
774 public ShortcutIconResource createFromParcel(Parcel source) {
775 ShortcutIconResource icon = new ShortcutIconResource();
776 icon.packageName = source.readString();
777 icon.resourceName = source.readString();
778 return icon;
779 }
780
781 public ShortcutIconResource[] newArray(int size) {
782 return new ShortcutIconResource[size];
783 }
784 };
785
786 /**
787 * No special parcel contents.
788 */
789 public int describeContents() {
790 return 0;
791 }
792
793 public void writeToParcel(Parcel dest, int flags) {
794 dest.writeString(packageName);
795 dest.writeString(resourceName);
796 }
797
798 @Override
799 public String toString() {
800 return resourceName;
801 }
802 }
803
804 /**
805 * Activity Action: Display an activity chooser, allowing the user to pick
806 * what they want to before proceeding. This can be used as an alternative
807 * to the standard activity picker that is displayed by the system when
808 * you try to start an activity with multiple possible matches, with these
809 * differences in behavior:
810 * <ul>
811 * <li>You can specify the title that will appear in the activity chooser.
812 * <li>The user does not have the option to make one of the matching
813 * activities a preferred activity, and all possible activities will
814 * always be shown even if one of them is currently marked as the
815 * preferred activity.
816 * </ul>
817 * <p>
818 * This action should be used when the user will naturally expect to
819 * select an activity in order to proceed. An example if when not to use
820 * it is when the user clicks on a "mailto:" link. They would naturally
821 * expect to go directly to their mail app, so startActivity() should be
822 * called directly: it will
823 * either launch the current preferred app, or put up a dialog allowing the
824 * user to pick an app to use and optionally marking that as preferred.
825 * <p>
826 * In contrast, if the user is selecting a menu item to send a picture
827 * they are viewing to someone else, there are many different things they
828 * may want to do at this point: send it through e-mail, upload it to a
829 * web service, etc. In this case the CHOOSER action should be used, to
830 * always present to the user a list of the things they can do, with a
831 * nice title given by the caller such as "Send this photo with:".
832 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700833 * If you need to grant URI permissions through a chooser, you must specify
834 * the permissions to be granted on the ACTION_CHOOSER Intent
835 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
836 * {@link #setClipData} to specify the URIs to be granted as well as
837 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
838 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
839 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700840 * As a convenience, an Intent of this form can be created with the
841 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700842 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700843 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
845 * and can optionally have a {@link #EXTRA_TITLE} field containing the
846 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700847 * <p>
848 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700849 */
850 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
851 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
852
853 /**
854 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
855 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700856 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
857 * target intent, also optionally supplying a title. If the target
858 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
859 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
860 * set in the returned chooser intent, with its ClipData set appropriately:
861 * either a direct reflection of {@link #getClipData()} if that is non-null,
John Spurlock33900182014-01-02 11:04:18 -0500862 * or a new ClipData built from {@link #getData()}.
Dianne Hackborne302a162012-05-15 14:58:32 -0700863 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700864 * @param target The Intent that the user will be selecting an activity
865 * to perform.
866 * @param title Optional title that will be displayed in the chooser.
867 * @return Return a new Intent object that you can hand to
868 * {@link Context#startActivity(Intent) Context.startActivity()} and
869 * related methods.
870 */
871 public static Intent createChooser(Intent target, CharSequence title) {
872 Intent intent = new Intent(ACTION_CHOOSER);
873 intent.putExtra(EXTRA_INTENT, target);
874 if (title != null) {
875 intent.putExtra(EXTRA_TITLE, title);
876 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877
878 // Migrate any clip data and flags from target.
Jeff Sharkey846318a2014-04-04 12:12:41 -0700879 int permFlags = target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
880 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
881 | FLAG_GRANT_PREFIX_URI_PERMISSION);
Dianne Hackborne302a162012-05-15 14:58:32 -0700882 if (permFlags != 0) {
883 ClipData targetClipData = target.getClipData();
884 if (targetClipData == null && target.getData() != null) {
885 ClipData.Item item = new ClipData.Item(target.getData());
886 String[] mimeTypes;
887 if (target.getType() != null) {
888 mimeTypes = new String[] { target.getType() };
889 } else {
890 mimeTypes = new String[] { };
891 }
892 targetClipData = new ClipData(null, mimeTypes, item);
893 }
894 if (targetClipData != null) {
895 intent.setClipData(targetClipData);
896 intent.addFlags(permFlags);
897 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700898 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700899
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700900 return intent;
901 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700902
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700903 /**
904 * Activity Action: Allow the user to select a particular kind of data and
905 * return it. This is different than {@link #ACTION_PICK} in that here we
906 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800907 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700908 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900909 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * etc.
911 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900912 * 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 -0700913 * of data, such as a person contact, you set the MIME type to the kind of
914 * data you want and launch it with {@link Context#startActivity(Intent)}.
915 * The system will then launch the best application to select that kind
916 * of data for you.
917 * <p>
918 * You may also be interested in any of a set of types of content the user
919 * can pick. For example, an e-mail application that wants to allow the
920 * user to add an attachment to an e-mail message can use this action to
921 * bring up a list of all of the types of content the user can attach.
922 * <p>
923 * In this case, you should wrap the GET_CONTENT intent with a chooser
924 * (through {@link #createChooser}), which will give the proper interface
925 * for the user to pick how to send your data and allow you to specify
926 * a prompt indicating what they are doing. You will usually specify a
927 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
928 * broad range of content types the user can select from.
929 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900930 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700931 * only pick from data that can be represented as a stream. This is
932 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
933 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800934 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900935 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800936 * is locally available on the device. For example, if this extra is set
937 * to true then an image picker should not show any pictures that are available
938 * from a remote server but not already on the local device (thus requiring
939 * they be downloaded when opened).
940 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800941 * If the caller can handle multiple returned items (the user performing
942 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
943 * to indicate this.
944 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700945 * Input: {@link #getType} is the desired MIME type to retrieve. Note
946 * that no URI is supplied in the intent, as there are no constraints on
947 * where the returned data originally comes from. You may also include the
948 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800949 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800950 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
951 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700952 * <p>
953 * Output: The URI of the item that was picked. This must be a content:
954 * URI so that any receiver can access it.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
958 /**
959 * Activity Action: Dial a number as specified by the data. This shows a
960 * UI with the number being dialed, allowing the user to explicitly
961 * initiate the call.
962 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
963 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
964 * number.
965 * <p>Output: nothing.
966 */
967 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
968 public static final String ACTION_DIAL = "android.intent.action.DIAL";
969 /**
970 * Activity Action: Perform a call to someone specified by the data.
971 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
972 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
973 * number.
974 * <p>Output: nothing.
975 *
976 * <p>Note: there will be restrictions on which applications can initiate a
977 * call; most applications should use the {@link #ACTION_DIAL}.
978 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
979 * numbers. Applications can <strong>dial</strong> emergency numbers using
980 * {@link #ACTION_DIAL}, however.
981 */
982 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
983 public static final String ACTION_CALL = "android.intent.action.CALL";
984 /**
985 * Activity Action: Perform a call to an emergency number specified by the
986 * data.
987 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
988 * tel: URI of an explicit phone number.
989 * <p>Output: nothing.
990 * @hide
991 */
992 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
993 /**
994 * Activity action: Perform a call to any number (emergency or not)
995 * specified by the data.
996 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
997 * tel: URI of an explicit phone number.
998 * <p>Output: nothing.
999 * @hide
1000 */
1001 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
1002 /**
1003 * Activity Action: Send a message to someone specified by the data.
1004 * <p>Input: {@link #getData} is URI describing the target.
1005 * <p>Output: nothing.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
1009 /**
1010 * Activity Action: Deliver some data to someone else. Who the data is
1011 * being delivered to is not specified; it is up to the receiver of this
1012 * action to ask the user where the data should be sent.
1013 * <p>
1014 * When launching a SEND intent, you should usually wrap it in a chooser
1015 * (through {@link #createChooser}), which will give the proper interface
1016 * for the user to pick how to send your data and allow you to specify
1017 * a prompt indicating what they are doing.
1018 * <p>
1019 * Input: {@link #getType} is the MIME type of the data being sent.
1020 * get*Extra can have either a {@link #EXTRA_TEXT}
1021 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1022 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1023 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1024 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001025 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1026 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1027 * your text with HTML formatting.
1028 * <p>
1029 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1030 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1031 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1032 * content: URIs and other advanced features of {@link ClipData}. If
1033 * using this approach, you still must supply the same data through the
1034 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1035 * for compatibility with old applications. If you don't set a ClipData,
1036 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001037 * <p>
1038 * Optional standard extras, which may be interpreted by some recipients as
1039 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1040 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1041 * <p>
1042 * Output: nothing.
1043 */
1044 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1045 public static final String ACTION_SEND = "android.intent.action.SEND";
1046 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001047 * Activity Action: Deliver multiple data to someone else.
1048 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001049 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001050 * <p>
1051 * Input: {@link #getType} is the MIME type of the data being sent.
1052 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001053 * #EXTRA_STREAM} field, containing the data to be sent. If using
1054 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1055 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001056 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001057 * Multiple types are supported, and receivers should handle mixed types
1058 * whenever possible. The right way for the receiver to check them is to
1059 * use the content resolver on each URI. The intent sender should try to
1060 * put the most concrete mime type in the intent type, but it can fall
1061 * back to {@literal <type>/*} or {@literal *}/* as needed.
1062 * <p>
1063 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1064 * be image/jpg, but if you are sending image/jpg and image/png, then the
1065 * intent's type should be image/*.
1066 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001067 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1068 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1069 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1070 * content: URIs and other advanced features of {@link ClipData}. If
1071 * using this approach, you still must supply the same data through the
1072 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1073 * for compatibility with old applications. If you don't set a ClipData,
1074 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1075 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001076 * Optional standard extras, which may be interpreted by some recipients as
1077 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1078 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1079 * <p>
1080 * Output: nothing.
1081 */
1082 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1083 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1084 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001085 * Activity Action: Handle an incoming phone call.
1086 * <p>Input: nothing.
1087 * <p>Output: nothing.
1088 */
1089 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1090 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1091 /**
1092 * Activity Action: Insert an empty item into the given container.
1093 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1094 * in which to place the data.
1095 * <p>Output: URI of the new data that was created.
1096 */
1097 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1098 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1099 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001100 * Activity Action: Create a new item in the given container, initializing it
1101 * from the current contents of the clipboard.
1102 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1103 * in which to place the data.
1104 * <p>Output: URI of the new data that was created.
1105 */
1106 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1107 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1108 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001109 * Activity Action: Delete the given data from its container.
1110 * <p>Input: {@link #getData} is URI of data to be deleted.
1111 * <p>Output: nothing.
1112 */
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1114 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1115 /**
1116 * Activity Action: Run the data, whatever that means.
1117 * <p>Input: ? (Note: this is currently specific to the test harness.)
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_RUN = "android.intent.action.RUN";
1122 /**
1123 * Activity Action: Perform a data synchronization.
1124 * <p>Input: ?
1125 * <p>Output: ?
1126 */
1127 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1128 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1129 /**
1130 * Activity Action: Pick an activity given an intent, returning the class
1131 * selected.
1132 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1133 * used with {@link PackageManager#queryIntentActivities} to determine the
1134 * set of activities from which to pick.
1135 * <p>Output: Class name of the activity that was selected.
1136 */
1137 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1138 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1139 /**
1140 * Activity Action: Perform a search.
1141 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1142 * is the text to search for. If empty, simply
1143 * enter your search results Activity with the search UI activated.
1144 * <p>Output: nothing.
1145 */
1146 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1147 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1148 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001149 * Activity Action: Start the platform-defined tutorial
1150 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1151 * is the text to search for. If empty, simply
1152 * enter your search results Activity with the search UI activated.
1153 * <p>Output: nothing.
1154 */
1155 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1156 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1157 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001158 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001159 * <p>
1160 * Input: {@link android.app.SearchManager#QUERY
1161 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1162 * a url starts with http or https, the site will be opened. If it is plain
1163 * text, Google search will be applied.
1164 * <p>
1165 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001166 */
1167 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1168 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001169
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001170 /**
Jim Miller07994402012-05-02 14:22:27 -07001171 * Activity Action: Perform assist action.
1172 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001173 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1174 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001175 * requested the assist.
Jim Miller07994402012-05-02 14:22:27 -07001176 * Output: nothing.
1177 */
1178 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1179 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001180
1181 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001182 * Activity Action: Perform voice assist action.
1183 * <p>
Adam Skory7140a252013-09-11 12:04:58 +01001184 * Input: {@link #EXTRA_ASSIST_PACKAGE}, {@link #EXTRA_ASSIST_CONTEXT}, can provide
1185 * additional optional contextual information about where the user was when they
Adam Skorydfc7fd72013-08-05 19:23:41 -07001186 * requested the voice assist.
Bjorn Bringertbc086862013-03-01 12:59:24 +00001187 * Output: nothing.
Adam Skory7140a252013-09-11 12:04:58 +01001188 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001189 */
1190 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1191 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1192
1193 /**
Adam Skory7140a252013-09-11 12:04:58 +01001194 * An optional field on {@link #ACTION_ASSIST} containing the name of the current foreground
1195 * application package at the time the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001196 */
1197 public static final String EXTRA_ASSIST_PACKAGE
1198 = "android.intent.extra.ASSIST_PACKAGE";
1199
1200 /**
Adam Skory7140a252013-09-11 12:04:58 +01001201 * An optional field on {@link #ACTION_ASSIST} and containing additional contextual
1202 * information supplied by the current foreground app at the time of the assist request.
1203 * This is a {@link Bundle} of additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001204 */
1205 public static final String EXTRA_ASSIST_CONTEXT
1206 = "android.intent.extra.ASSIST_CONTEXT";
1207
Jim Miller07994402012-05-02 14:22:27 -07001208 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001209 * Activity Action: List all available applications
1210 * <p>Input: Nothing.
1211 * <p>Output: nothing.
1212 */
1213 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1214 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1215 /**
1216 * Activity Action: Show settings for choosing wallpaper
1217 * <p>Input: Nothing.
1218 * <p>Output: Nothing.
1219 */
1220 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1221 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1222
1223 /**
1224 * Activity Action: Show activity for reporting a bug.
1225 * <p>Input: Nothing.
1226 * <p>Output: Nothing.
1227 */
1228 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1229 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1230
1231 /**
1232 * Activity Action: Main entry point for factory tests. Only used when
1233 * the device is booting in factory test node. The implementing package
1234 * must be installed in the system image.
1235 * <p>Input: nothing
1236 * <p>Output: nothing
1237 */
1238 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1239
1240 /**
1241 * Activity Action: The user pressed the "call" button to go to the dialer
1242 * or other appropriate UI for placing a call.
1243 * <p>Input: Nothing.
1244 * <p>Output: Nothing.
1245 */
1246 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1247 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1248
1249 /**
1250 * Activity Action: Start Voice Command.
1251 * <p>Input: Nothing.
1252 * <p>Output: Nothing.
1253 */
1254 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1255 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001256
1257 /**
1258 * Activity Action: Start action associated with long pressing on the
1259 * search key.
1260 * <p>Input: Nothing.
1261 * <p>Output: Nothing.
1262 */
1263 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1264 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001265
Jacek Surazski86b6c532009-05-13 14:38:28 +02001266 /**
1267 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1268 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001269 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001270 * <p>Input: No data is specified. The bug report is passed in using
1271 * an {@link #EXTRA_BUG_REPORT} field.
1272 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001273 *
1274 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001275 */
1276 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1277 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001278
1279 /**
1280 * Activity Action: Show power usage information to the user.
1281 * <p>Input: Nothing.
1282 * <p>Output: Nothing.
1283 */
1284 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1285 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001286
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001287 /**
1288 * Activity Action: Setup wizard to launch after a platform update. This
1289 * activity should have a string meta-data field associated with it,
1290 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1291 * the platform for setup. The activity will be launched only if
1292 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1293 * same value.
1294 * <p>Input: Nothing.
1295 * <p>Output: Nothing.
1296 * @hide
1297 */
1298 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1299 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001300
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001301 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001302 * Activity Action: Show settings for managing network data usage of a
1303 * specific application. Applications should define an activity that offers
1304 * options to control data usage.
1305 */
1306 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1307 public static final String ACTION_MANAGE_NETWORK_USAGE =
1308 "android.intent.action.MANAGE_NETWORK_USAGE";
1309
1310 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001311 * Activity Action: Launch application installer.
1312 * <p>
1313 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001314 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1315 * you can also use "package:<package-name>" to install an application for the
1316 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001317 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1318 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1319 * <p>
1320 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1321 * succeeded.
1322 *
1323 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1324 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1325 * @see #EXTRA_RETURN_RESULT
1326 */
1327 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1328 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1329
1330 /**
1331 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1332 * package. Specifies the installer package name; this package will receive the
1333 * {@link #ACTION_APP_ERROR} intent.
1334 */
1335 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1336 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1337
1338 /**
1339 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1340 * package. Specifies that the application being installed should not be
1341 * treated as coming from an unknown source, but as coming from the app
1342 * invoking the Intent. For this to work you must start the installer with
1343 * startActivityForResult().
1344 */
1345 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1346 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1347
1348 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001349 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1350 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001351 * data field originated from.
1352 */
rich cannings706e8ba2012-08-20 13:20:14 -07001353 public static final String EXTRA_ORIGINATING_URI
1354 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001355
1356 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001357 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1358 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1359 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001360 */
1361 public static final String EXTRA_REFERRER
1362 = "android.intent.extra.REFERRER";
1363
1364 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001365 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1366 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1367 * @hide
1368 */
1369 public static final String EXTRA_ORIGINATING_UID
1370 = "android.intent.extra.ORIGINATING_UID";
1371
1372 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001373 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1374 * package. Tells the installer UI to skip the confirmation with the user
1375 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001376 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1377 * will no longer show an interstitial message about updating existing
1378 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001379 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001380 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001381 public static final String EXTRA_ALLOW_REPLACE
1382 = "android.intent.extra.ALLOW_REPLACE";
1383
1384 /**
1385 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1386 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1387 * return to the application the result code of the install/uninstall. The returned result
1388 * code will be {@link android.app.Activity#RESULT_OK} on success or
1389 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1390 */
1391 public static final String EXTRA_RETURN_RESULT
1392 = "android.intent.extra.RETURN_RESULT";
1393
1394 /**
1395 * Package manager install result code. @hide because result codes are not
1396 * yet ready to be exposed.
1397 */
1398 public static final String EXTRA_INSTALL_RESULT
1399 = "android.intent.extra.INSTALL_RESULT";
1400
1401 /**
1402 * Activity Action: Launch application uninstaller.
1403 * <p>
1404 * Input: The data must be a package: URI whose scheme specific part is
1405 * the package name of the current installed package to be uninstalled.
1406 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1407 * <p>
1408 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1409 * succeeded.
1410 */
1411 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1412 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1413
1414 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001415 * Specify whether the package should be uninstalled for all users.
1416 * @hide because these should not be part of normal application flow.
1417 */
1418 public static final String EXTRA_UNINSTALL_ALL_USERS
1419 = "android.intent.extra.UNINSTALL_ALL_USERS";
1420
1421 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001422 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1423 * describing the last run version of the platform that was setup.
1424 * @hide
1425 */
1426 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1427
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001428 // ---------------------------------------------------------------------
1429 // ---------------------------------------------------------------------
1430 // Standard intent broadcast actions (see action variable).
1431
1432 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001433 * Broadcast Action: Sent when the device goes to sleep and becomes non-interactive.
1434 * <p>
1435 * For historical reasons, the name of this broadcast action refers to the power
1436 * state of the screen but it is actually sent in response to changes in the
1437 * overall interactive state of the device.
1438 * </p><p>
1439 * This broadcast is sent when the device becomes non-interactive which may have
1440 * nothing to do with the screen turning off. To determine the
1441 * actual state of the screen, use {@link android.view.Display#getState}.
1442 * </p><p>
1443 * See {@link android.os.PowerManager#isInteractive} for details.
1444 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001445 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001446 * <p class="note">This is a protected intent that can only be sent
1447 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001448 */
1449 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1450 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
Jeff Brown037c33e2014-04-09 00:31:55 -07001451
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001452 /**
Jeff Brown037c33e2014-04-09 00:31:55 -07001453 * Broadcast Action: Sent when the device wakes up and becomes interactive.
1454 * <p>
1455 * For historical reasons, the name of this broadcast action refers to the power
1456 * state of the screen but it is actually sent in response to changes in the
1457 * overall interactive state of the device.
1458 * </p><p>
1459 * This broadcast is sent when the device becomes interactive which may have
1460 * nothing to do with the screen turning on. To determine the
1461 * actual state of the screen, use {@link android.view.Display#getState}.
1462 * </p><p>
1463 * See {@link android.os.PowerManager#isInteractive} for details.
1464 * </p>
Tom Taylord4a47292009-12-21 13:59:18 -08001465 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001466 * <p class="note">This is a protected intent that can only be sent
1467 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001468 */
1469 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1470 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001471
1472 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001473 * Broadcast Action: Sent after the system stops dreaming.
1474 *
1475 * <p class="note">This is a protected intent that can only be sent by the system.
1476 * It is only sent to registered receivers.</p>
1477 */
1478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1479 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1480
1481 /**
1482 * Broadcast Action: Sent after the system starts dreaming.
1483 *
1484 * <p class="note">This is a protected intent that can only be sent by the system.
1485 * It is only sent to registered receivers.</p>
1486 */
1487 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1488 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1489
1490 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001491 * 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 -07001492 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001493 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001494 * <p class="note">This is a protected intent that can only be sent
1495 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001496 */
1497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001498 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001499
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001500 /**
1501 * Broadcast Action: The current time has changed. Sent every
1502 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001503 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001504 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1505 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001506 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001507 * <p class="note">This is a protected intent that can only be sent
1508 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001509 */
1510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1511 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1512 /**
1513 * Broadcast Action: The time was set.
1514 */
1515 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1516 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1517 /**
1518 * Broadcast Action: The date has changed.
1519 */
1520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1521 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1522 /**
1523 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1524 * <ul>
1525 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1526 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001527 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001528 * <p class="note">This is a protected intent that can only be sent
1529 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001530 */
1531 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1532 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1533 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001534 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1535 * DNS entries should be tossed.
1536 * @hide
1537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1540 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001541 * Alarm Changed Action: This is broadcast when the AlarmClock
1542 * application's alarm is set or unset. It is used by the
1543 * AlarmClock application and the StatusBar service.
1544 * @hide
1545 */
1546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1547 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1548 /**
1549 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1550 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1551 * @hide
1552 */
1553 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1554 public static final String ACTION_SYNC_STATE_CHANGED
1555 = "android.intent.action.SYNC_STATE_CHANGED";
1556 /**
1557 * Broadcast Action: This is broadcast once, after the system has finished
1558 * booting. It can be used to perform application-specific initialization,
1559 * such as installing alarms. You must hold the
1560 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1561 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001562 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001563 * <p class="note">This is a protected intent that can only be sent
1564 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001565 */
1566 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1567 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1568 /**
1569 * Broadcast Action: This is broadcast when a user action should request a
1570 * temporary system dialog to dismiss. Some examples of temporary system
1571 * dialogs are the notification window-shade and the recent tasks dialog.
1572 */
1573 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1574 /**
1575 * Broadcast Action: Trigger the download and eventual installation
1576 * of a package.
1577 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001578 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001579 * <p class="note">This is a protected intent that can only be sent
1580 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001581 *
1582 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001583 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001584 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1586 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1587 /**
1588 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001589 * device. The data contains the name of the package. Note that the
1590 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001591 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001592 * <ul>
1593 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1594 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1595 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1596 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001597 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001598 * <p class="note">This is a protected intent that can only be sent
1599 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001600 */
1601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1602 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1603 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001604 * Broadcast Action: A new version of an application package has been
1605 * installed, replacing an existing version that was previously installed.
1606 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001607 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001608 * <ul>
1609 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1610 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001611 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001612 * <p class="note">This is a protected intent that can only be sent
1613 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001614 */
1615 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1616 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1617 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001618 * Broadcast Action: A new version of your application has been installed
1619 * over an existing one. This is only sent to the application that was
1620 * replaced. It does not contain any additional data; to receive it, just
1621 * use an intent filter for this action.
1622 *
1623 * <p class="note">This is a protected intent that can only be sent
1624 * by the system.
1625 */
1626 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1627 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1628 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001629 * Broadcast Action: An existing application package has been removed from
1630 * the device. The data contains the name of the package. The package
1631 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001632 * <ul>
1633 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1634 * to the package.
1635 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1636 * application -- data and code -- is being removed.
1637 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1638 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1639 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001640 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001641 * <p class="note">This is a protected intent that can only be sent
1642 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001643 */
1644 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1645 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1646 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001647 * Broadcast Action: An existing application package has been completely
1648 * removed from the device. The data contains the name of the package.
1649 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1650 * {@link #EXTRA_DATA_REMOVED} is true and
1651 * {@link #EXTRA_REPLACING} is false of that broadcast.
1652 *
1653 * <ul>
1654 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1655 * to the package.
1656 * </ul>
1657 *
1658 * <p class="note">This is a protected intent that can only be sent
1659 * by the system.
1660 */
1661 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1662 public static final String ACTION_PACKAGE_FULLY_REMOVED
1663 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1664 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001665 * Broadcast Action: An existing application package has been changed (e.g.
1666 * a component has been enabled or disabled). The data contains the name of
1667 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001668 * <ul>
1669 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001670 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001671 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001672 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1673 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001674 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001675 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001676 * <p class="note">This is a protected intent that can only be sent
1677 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001678 */
1679 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1680 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1681 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001682 * @hide
1683 * Broadcast Action: Ask system services if there is any reason to
1684 * restart the given package. The data contains the name of the
1685 * package.
1686 * <ul>
1687 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1688 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1689 * </ul>
1690 *
1691 * <p class="note">This is a protected intent that can only be sent
1692 * by the system.
1693 */
1694 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1695 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1696 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001697 * Broadcast Action: The user has restarted a package, and all of its
1698 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001699 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001700 * be removed. Note that the restarted package does <em>not</em>
1701 * receive this broadcast.
1702 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001703 * <ul>
1704 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1705 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001706 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001707 * <p class="note">This is a protected intent that can only be sent
1708 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001709 */
1710 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1711 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1712 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001713 * Broadcast Action: The user has cleared the data of a package. This should
1714 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001715 * its persistent data is erased and this broadcast sent.
1716 * Note that the cleared package does <em>not</em>
1717 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001718 * <ul>
1719 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1720 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001721 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001722 * <p class="note">This is a protected intent that can only be sent
1723 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001724 */
1725 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1726 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1727 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001728 * Broadcast Action: A user ID has been removed from the system. The user
1729 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001730 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001733 */
1734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1735 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001736
1737 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001738 * Broadcast Action: Sent to the installer package of an application
1739 * when that application is first launched (that is the first time it
1740 * is moved out of the stopped state). The data contains the name of the package.
1741 *
1742 * <p class="note">This is a protected intent that can only be sent
1743 * by the system.
1744 */
1745 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1746 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1747
1748 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001749 * Broadcast Action: Sent to the system package verifier when a package
1750 * needs to be verified. The data contains the package URI.
1751 * <p class="note">
1752 * This is a protected intent that can only be sent by the system.
1753 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001754 */
1755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1756 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1757
1758 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001759 * Broadcast Action: Sent to the system package verifier when a package is
1760 * verified. The data contains the package URI.
1761 * <p class="note">
1762 * This is a protected intent that can only be sent by the system.
1763 */
1764 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1765 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1766
1767 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001768 * Broadcast Action: Resources for a set of packages (which were
1769 * previously unavailable) are currently
1770 * available since the media on which they exist is available.
1771 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1772 * list of packages whose availability changed.
1773 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1774 * list of uids of packages whose availability changed.
1775 * Note that the
1776 * packages in this list do <em>not</em> receive this broadcast.
1777 * The specified set of packages are now available on the system.
1778 * <p>Includes the following extras:
1779 * <ul>
1780 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1781 * whose resources(were previously unavailable) are currently available.
1782 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1783 * packages whose resources(were previously unavailable)
1784 * are currently available.
1785 * </ul>
1786 *
1787 * <p class="note">This is a protected intent that can only be sent
1788 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001789 */
1790 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001791 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1792 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001793
1794 /**
1795 * Broadcast Action: Resources for a set of packages are currently
1796 * unavailable since the media on which they exist is unavailable.
1797 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1798 * list of packages whose availability changed.
1799 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1800 * list of uids of packages whose availability changed.
1801 * The specified set of packages can no longer be
1802 * launched and are practically unavailable on the system.
1803 * <p>Inclues the following extras:
1804 * <ul>
1805 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1806 * whose resources are no longer available.
1807 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1808 * whose resources are no longer available.
1809 * </ul>
1810 *
1811 * <p class="note">This is a protected intent that can only be sent
1812 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001815 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001816 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001817
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001818 /**
1819 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001820 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001821 * This should <em>only</em> be used to determine when the wallpaper
1822 * has changed to show the new wallpaper to the user. You should certainly
1823 * never, in response to this, change the wallpaper or other attributes of
1824 * it such as the suggested size. That would be crazy, right? You'd cause
1825 * all kinds of loops, especially if other apps are doing similar things,
1826 * right? Of course. So please don't do this.
1827 *
1828 * @deprecated Modern applications should use
1829 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1830 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1831 * shown behind their UI, rather than watching for this broadcast and
1832 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001833 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001834 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001835 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1836 /**
1837 * Broadcast Action: The current device {@link android.content.res.Configuration}
1838 * (orientation, locale, etc) has changed. When such a change happens, the
1839 * UIs (view hierarchy) will need to be rebuilt based on this new
1840 * information; for the most part, applications don't need to worry about
1841 * this, because the system will take care of stopping and restarting the
1842 * application to make sure it sees the new changes. Some system code that
1843 * can not be restarted will need to watch for this action and handle it
1844 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001845 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001846 * <p class="note">
1847 * You can <em>not</em> receive this through components declared
1848 * in manifests, only by explicitly registering for it with
1849 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1850 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001851 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001852 * <p class="note">This is a protected intent that can only be sent
1853 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001854 *
1855 * @see android.content.res.Configuration
1856 */
1857 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1858 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1859 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001860 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001861 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001862 * <p class="note">This is a protected intent that can only be sent
1863 * by the system.
1864 */
1865 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1866 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1867 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001868 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1869 * charging state, level, and other information about the battery.
1870 * See {@link android.os.BatteryManager} for documentation on the
1871 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001872 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001873 * <p class="note">
1874 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001875 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001876 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001877 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1878 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1879 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1880 * broadcasts that are sent and can be received through manifest
1881 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001882 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001883 * <p class="note">This is a protected intent that can only be sent
1884 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001885 */
1886 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1887 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1888 /**
1889 * Broadcast Action: Indicates low battery condition on the device.
1890 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001891 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001892 * <p class="note">This is a protected intent that can only be sent
1893 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001894 */
1895 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1896 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1897 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001898 * Broadcast Action: Indicates the battery is now okay after being low.
1899 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1900 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001901 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001902 * <p class="note">This is a protected intent that can only be sent
1903 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001904 */
1905 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1906 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1907 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001908 * Broadcast Action: External power has been connected to the device.
1909 * This is intended for applications that wish to register specifically to this notification.
1910 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1911 * stay active to receive this notification. This action can be used to implement actions
1912 * that wait until power is available to trigger.
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.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001916 */
1917 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001918 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001919 /**
1920 * Broadcast Action: External power has been removed from the device.
1921 * This is intended for applications that wish to register specifically to this notification.
1922 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1923 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001924 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001925 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001926 * <p class="note">This is a protected intent that can only be sent
1927 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001930 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001931 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001932 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001933 * Broadcast Action: Device is shutting down.
1934 * This is broadcast when the device is being shut down (completely turned
1935 * off, not sleeping). Once the broadcast is complete, the final shutdown
1936 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001937 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001938 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001939 * <p class="note">This is a protected intent that can only be sent
1940 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001941 * <p>May include the following extras:
1942 * <ul>
1943 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1944 * shutdown is only for userspace processes. If not set, assumed to be false.
1945 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001946 */
1947 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001948 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001949 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001950 * Activity Action: Start this activity to request system shutdown.
1951 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1952 * to request confirmation from the user before shutting down.
1953 *
1954 * <p class="note">This is a protected intent that can only be sent
1955 * by the system.
1956 *
1957 * {@hide}
1958 */
1959 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1960 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001961 * Broadcast Action: A sticky broadcast that indicates low memory
1962 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001963 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001964 * <p class="note">This is a protected intent that can only be sent
1965 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001966 */
1967 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1968 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1969 /**
1970 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001971 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001972 * <p class="note">This is a protected intent that can only be sent
1973 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001974 */
1975 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1976 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1977 /**
Jake Hambybb371632010-08-23 18:16:48 -07001978 * Broadcast Action: A sticky broadcast that indicates a memory full
1979 * condition on the device. This is intended for activities that want
1980 * to be able to fill the data partition completely, leaving only
1981 * enough free space to prevent system-wide SQLite failures.
1982 *
1983 * <p class="note">This is a protected intent that can only be sent
1984 * by the system.
1985 *
1986 * {@hide}
1987 */
1988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1989 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1990 /**
1991 * Broadcast Action: Indicates memory full condition on the device
1992 * no longer exists.
1993 *
1994 * <p class="note">This is a protected intent that can only be sent
1995 * by the system.
1996 *
1997 * {@hide}
1998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2000 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
2001 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002002 * Broadcast Action: Indicates low memory condition notification acknowledged by user
2003 * and package management should be started.
2004 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
2005 * notification.
2006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
2009 /**
2010 * Broadcast Action: The device has entered USB Mass Storage mode.
2011 * This is used mainly for the USB Settings panel.
2012 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2013 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002014 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002015 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002016 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002017 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
2018
2019 /**
2020 * Broadcast Action: The device has exited USB Mass Storage mode.
2021 * This is used mainly for the USB Settings panel.
2022 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
2023 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07002024 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002025 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07002026 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002027 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
2028
2029 /**
2030 * Broadcast Action: External media has been removed.
2031 * The path to the mount point for the removed media is contained in the Intent.mData field.
2032 */
2033 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2034 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
2035
2036 /**
2037 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002038 * 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 -07002039 */
2040 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2041 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2042
2043 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002044 * Broadcast Action: External media is present, and being disk-checked
2045 * 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 -08002046 */
2047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2049
2050 /**
2051 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2052 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2056
2057 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002058 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002059 * 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 -07002060 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2061 * media was mounted read only.
2062 */
2063 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2064 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2065
2066 /**
2067 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002068 * 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 -07002069 */
2070 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2071 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2072
2073 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002074 * Broadcast Action: External media is no longer being shared via USB mass storage.
2075 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2076 *
2077 * @hide
2078 */
2079 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2080
2081 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002082 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2083 * The path to the mount point for the removed media is contained in the Intent.mData field.
2084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2087
2088 /**
2089 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002090 * 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 -07002091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2094
2095 /**
2096 * Broadcast Action: User has expressed the desire to remove the external storage media.
2097 * Applications should close all files they have open within the mount point when they receive this intent.
2098 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2102
2103 /**
2104 * Broadcast Action: The media scanner has started scanning a directory.
2105 * The path to the directory being scanned is contained in the Intent.mData field.
2106 */
2107 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2108 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2109
2110 /**
2111 * Broadcast Action: The media scanner has finished scanning a directory.
2112 * The path to the scanned directory is contained in the Intent.mData field.
2113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2116
2117 /**
2118 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2119 * The path to the file is contained in the Intent.mData field.
2120 */
2121 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2122 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2123
2124 /**
2125 * Broadcast Action: The "Media Button" was pressed. Includes a single
2126 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2127 * caused the broadcast.
2128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2131
2132 /**
2133 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2134 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2135 * caused the broadcast.
2136 */
2137 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2138 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2139
2140 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2141 // location; they are not general-purpose actions.
2142
2143 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002144 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002145 */
2146 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2147 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2148 "android.intent.action.GTALK_CONNECTED";
2149
2150 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002151 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002152 */
2153 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2154 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2155 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002156
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002157 /**
2158 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002159 */
2160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2161 public static final String ACTION_INPUT_METHOD_CHANGED =
2162 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002163
2164 /**
2165 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2166 * more radios have been turned off or on. The intent will have the following extra value:</p>
2167 * <ul>
2168 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2169 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2170 * turned off</li>
2171 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002172 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002173 * <p class="note">This is a protected intent that can only be sent
2174 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002175 */
2176 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2177 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2178
2179 /**
2180 * Broadcast Action: Some content providers have parts of their namespace
2181 * where they publish new events or items that the user may be especially
2182 * interested in. For these things, they may broadcast this action when the
2183 * set of interesting items change.
2184 *
2185 * For example, GmailProvider sends this notification when the set of unread
2186 * mail in the inbox changes.
2187 *
2188 * <p>The data of the intent identifies which part of which provider
2189 * changed. When queried through the content resolver, the data URI will
2190 * return the data set in question.
2191 *
2192 * <p>The intent will have the following extra values:
2193 * <ul>
2194 * <li><em>count</em> - The number of items in the data set. This is the
2195 * same as the number of items in the cursor returned by querying the
2196 * data URI. </li>
2197 * </ul>
2198 *
2199 * This intent will be sent at boot (if the count is non-zero) and when the
2200 * data set changes. It is possible for the data set to change without the
2201 * count changing (for example, if a new unread message arrives in the same
2202 * sync operation in which a message is archived). The phone should still
2203 * ring/vibrate/etc as normal in this case.
2204 */
2205 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2206 public static final String ACTION_PROVIDER_CHANGED =
2207 "android.intent.action.PROVIDER_CHANGED";
2208
2209 /**
2210 * Broadcast Action: Wired Headset plugged in or unplugged.
2211 *
Matt Casey79867f52014-03-26 15:20:25 -07002212 * You <em>cannot</em> receive this through components declared
2213 * in manifests, only by explicitly registering for it with
2214 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2215 * Context.registerReceiver()}.
2216 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002217 * <p>The intent will have the following extra values:
2218 * <ul>
2219 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2220 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002221 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002222 * </ul>
2223 * </ul>
2224 */
2225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2226 public static final String ACTION_HEADSET_PLUG =
2227 "android.intent.action.HEADSET_PLUG";
2228
2229 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002230 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2231 *
2232 * <p>The intent will have the following extra values:
2233 * <ul>
2234 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2235 * <li><em>name</em> - Headset type, human readable string </li>
2236 * </ul>
2237 * </ul>
2238 * @hide
2239 */
2240 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002241 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2242 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002243
2244 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002245 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002246 *
2247 * <p>The intent will have the following extra values:
2248 * <ul>
2249 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2250 * <li><em>name</em> - Headset type, human readable string </li>
2251 * </ul>
2252 * </ul>
2253 * @hide
2254 */
2255 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002256 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2257 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002258
2259 /**
2260 * Broadcast Action: A HMDI cable was plugged or unplugged
2261 *
2262 * <p>The intent will have the following extra values:
2263 * <ul>
2264 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2265 * <li><em>name</em> - HDMI cable, human readable string </li>
2266 * </ul>
2267 * </ul>
2268 * @hide
2269 */
2270 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2271 public static final String ACTION_HDMI_AUDIO_PLUG =
2272 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002273
2274 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002275 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2276 *
2277 * <p>The intent will have the following extra values:
2278 * <ul>
2279 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2280 * <li><em>card</em> - ALSA card number (integer) </li>
2281 * <li><em>device</em> - ALSA device number (integer) </li>
2282 * </ul>
2283 * </ul>
2284 * @hide
2285 */
2286 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2287 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2288 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2289
2290 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002291 * Broadcast Action: A USB audio device was plugged in or unplugged.
2292 *
2293 * <p>The intent will have the following extra values:
2294 * <ul>
2295 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2296 * <li><em>card</em> - ALSA card number (integer) </li>
2297 * <li><em>device</em> - ALSA device number (integer) </li>
2298 * </ul>
2299 * </ul>
2300 * @hide
2301 */
2302 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2303 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2304 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2305
2306 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002307 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2308 * <ul>
2309 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2310 * </ul>
2311 *
2312 * <p class="note">This is a protected intent that can only be sent
2313 * by the system.
2314 *
2315 * @hide
2316 */
2317 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2318 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2319 = "android.intent.action.ADVANCED_SETTINGS";
2320
2321 /**
Robin Lee66e5d962014-04-09 16:44:21 +01002322 * Broadcast Action: Sent after application restrictions are changed.
2323 *
2324 * <p class="note">This is a protected intent that can only be sent
2325 * by the system.</p>
2326 */
2327 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2328 public static final String ACTION_APPLICATION_RESTRICTIONS_CHANGED =
2329 "android.intent.action.APPLICATION_RESTRICTIONS_CHANGED";
2330
2331 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002332 * Broadcast Action: An outgoing call is about to be placed.
2333 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002334 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002335 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002336 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002337 * the phone number originally intended to be dialed.</li>
2338 * </ul>
2339 * <p>Once the broadcast is finished, the resultData is used as the actual
2340 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002341 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002342 * outgoing call in turn: for example, a parental control application
2343 * might verify that the user is authorized to place the call at that
2344 * time, then a number-rewriting application might add an area code if
2345 * one was not specified.</p>
2346 * <p>For consistency, any receiver whose purpose is to prohibit phone
2347 * calls should have a priority of 0, to ensure it will see the final
2348 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002349 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002350 * should have a positive priority.
2351 * Negative priorities are reserved for the system for this broadcast;
2352 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002353 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2354 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002355 * <p>Emergency calls cannot be intercepted using this mechanism, and
2356 * other calls cannot be modified to call emergency numbers using this
2357 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002358 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2359 * call to use their own service instead. Those apps should first prevent
2360 * the call from being placed by setting resultData to <code>null</code>
2361 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002362 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002363 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2364 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002365 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002366 * <p class="note">This is a protected intent that can only be sent
2367 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002368 */
2369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2370 public static final String ACTION_NEW_OUTGOING_CALL =
2371 "android.intent.action.NEW_OUTGOING_CALL";
2372
2373 /**
2374 * Broadcast Action: Have the device reboot. This is only for use by
2375 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002376 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002377 * <p class="note">This is a protected intent that can only be sent
2378 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002379 */
2380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2381 public static final String ACTION_REBOOT =
2382 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002383
Wei Huang97ecc9c2009-05-11 17:44:20 -07002384 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002385 * Broadcast Action: A sticky broadcast for changes in the physical
2386 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002387 *
2388 * <p>The intent will have the following extra values:
2389 * <ul>
2390 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002391 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002392 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002393 * <p>This is intended for monitoring the current physical dock state.
2394 * See {@link android.app.UiModeManager} for the normal API dealing with
2395 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002396 */
2397 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2398 public static final String ACTION_DOCK_EVENT =
2399 "android.intent.action.DOCK_EVENT";
2400
2401 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002402 * Broadcast Action: A broadcast when idle maintenance can be started.
2403 * This means that the user is not interacting with the device and is
2404 * not expected to do so soon. Typical use of the idle maintenance is
2405 * to perform somehow expensive tasks that can be postponed at a moment
2406 * when they will not degrade user experience.
2407 * <p>
2408 * <p class="note">In order to keep the device responsive in case of an
2409 * unexpected user interaction, implementations of a maintenance task
2410 * should be interruptible. In such a scenario a broadcast with action
2411 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2412 * should not do the maintenance work in
2413 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2414 * maintenance service by {@link Context#startService(Intent)}. Also
2415 * you should hold a wake lock while your maintenance service is running
2416 * to prevent the device going to sleep.
2417 * </p>
2418 * <p>
2419 * <p class="note">This is a protected intent that can only be sent by
2420 * the system.
2421 * </p>
2422 *
2423 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002424 *
2425 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002426 */
2427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2428 public static final String ACTION_IDLE_MAINTENANCE_START =
2429 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2430
2431 /**
2432 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2433 * This means that the user was not interacting with the device as a result
2434 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2435 * was sent and now the user started interacting with the device. Typical
2436 * use of the idle maintenance is to perform somehow expensive tasks that
2437 * can be postponed at a moment when they will not degrade user experience.
2438 * <p>
2439 * <p class="note">In order to keep the device responsive in case of an
2440 * unexpected user interaction, implementations of a maintenance task
2441 * should be interruptible. Hence, on receiving a broadcast with this
2442 * action, the maintenance task should be interrupted as soon as possible.
2443 * In other words, you should not do the maintenance work in
2444 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2445 * maintenance service that was started on receiving of
2446 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2447 * lock you acquired when your maintenance service started.
2448 * </p>
2449 * <p class="note">This is a protected intent that can only be sent
2450 * by the system.
2451 *
2452 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002453 *
2454 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002455 */
2456 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2457 public static final String ACTION_IDLE_MAINTENANCE_END =
2458 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2459
2460 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002461 * Broadcast Action: a remote intent is to be broadcasted.
2462 *
2463 * A remote intent is used for remote RPC between devices. The remote intent
2464 * is serialized and sent from one device to another device. The receiving
2465 * device parses the remote intent and broadcasts it. Note that anyone can
2466 * broadcast a remote intent. However, if the intent receiver of the remote intent
2467 * does not trust intent broadcasts from arbitrary intent senders, it should require
2468 * the sender to hold certain permissions so only trusted sender's broadcast will be
2469 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002470 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002471 */
2472 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002473 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002474
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002475 /**
2476 * Broadcast Action: hook for permforming cleanup after a system update.
2477 *
2478 * The broadcast is sent when the system is booting, before the
2479 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2480 * image. A receiver for this should do its work and then disable itself
2481 * so that it does not get run again at the next boot.
2482 * @hide
2483 */
2484 public static final String ACTION_PRE_BOOT_COMPLETED =
2485 "android.intent.action.PRE_BOOT_COMPLETED";
2486
Amith Yamasani13593602012-03-22 16:16:17 -07002487 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002488 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002489 * on restricted users. The broadcast intent contains an extra
2490 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2491 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2492 * String[] depending on the restriction type.<p/>
2493 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002494 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2495 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2496 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002497 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2498 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002499 * @see RestrictionEntry
2500 */
2501 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2502 "android.intent.action.GET_RESTRICTION_ENTRIES";
2503
2504 /**
Amith Yamasanid304af62013-09-05 09:30:23 -07002505 * @hide
Amith Yamasani655d0e22013-06-12 14:19:10 -07002506 * Activity to challenge the user for a PIN that was configured when setting up
Amith Yamasanid304af62013-09-05 09:30:23 -07002507 * restrictions. Restrictions include blocking of apps and preventing certain user operations,
2508 * controlled by {@link android.os.UserManager#setUserRestrictions(Bundle).
2509 * Launch the activity using
Amith Yamasani655d0e22013-06-12 14:19:10 -07002510 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2511 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2512 * challenge.<p/>
2513 * Before launching this activity, make sure that there is a PIN in effect, by calling
Amith Yamasanid304af62013-09-05 09:30:23 -07002514 * {@link android.os.UserManager#hasRestrictionsChallenge()}.
Amith Yamasani655d0e22013-06-12 14:19:10 -07002515 */
Amith Yamasanid304af62013-09-05 09:30:23 -07002516 public static final String ACTION_RESTRICTIONS_CHALLENGE =
2517 "android.intent.action.RESTRICTIONS_CHALLENGE";
Amith Yamasani655d0e22013-06-12 14:19:10 -07002518
2519 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002520 * Sent the first time a user is starting, to allow system apps to
2521 * perform one time initialization. (This will not be seen by third
2522 * party applications because a newly initialized user does not have any
2523 * third party applications installed for it.) This is sent early in
2524 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002525 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2526 * broadcast, since it is part of a visible user interaction; be as quick
2527 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002528 */
2529 public static final String ACTION_USER_INITIALIZE =
2530 "android.intent.action.USER_INITIALIZE";
2531
2532 /**
2533 * Sent when a user switch is happening, causing the process's user to be
2534 * brought to the foreground. This is only sent to receivers registered
2535 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2536 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002537 * foreground. This is sent as a foreground
2538 * broadcast, since it is part of a visible user interaction; be as quick
2539 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002540 */
2541 public static final String ACTION_USER_FOREGROUND =
2542 "android.intent.action.USER_FOREGROUND";
2543
2544 /**
2545 * Sent when a user switch is happening, causing the process's user to be
2546 * sent to the background. This is only sent to receivers registered
2547 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2548 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002549 * background. This is sent as a foreground
2550 * broadcast, since it is part of a visible user interaction; be as quick
2551 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002552 */
2553 public static final String ACTION_USER_BACKGROUND =
2554 "android.intent.action.USER_BACKGROUND";
2555
2556 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002557 * Broadcast sent to the system when a user is added. Carries an extra
2558 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2559 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002560 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002561 * @hide
2562 */
2563 public static final String ACTION_USER_ADDED =
2564 "android.intent.action.USER_ADDED";
2565
2566 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002567 * Broadcast sent by the system when a user is started. Carries an extra
2568 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002569 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002570 * that has been started. This is sent as a foreground
2571 * broadcast, since it is part of a visible user interaction; be as quick
2572 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002573 * @hide
2574 */
2575 public static final String ACTION_USER_STARTED =
2576 "android.intent.action.USER_STARTED";
2577
2578 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002579 * Broadcast sent when a user is in the process of starting. Carries an extra
2580 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2581 * sent to registered receivers, not manifest receivers. It is sent to all
2582 * users (including the one that is being started). You must hold
2583 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2584 * this broadcast. This is sent as a background broadcast, since
2585 * its result is not part of the primary UX flow; to safely keep track of
2586 * started/stopped state of a user you can use this in conjunction with
2587 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2588 * other user state broadcasts since those are foreground broadcasts so can
2589 * execute in a different order.
2590 * @hide
2591 */
2592 public static final String ACTION_USER_STARTING =
2593 "android.intent.action.USER_STARTING";
2594
2595 /**
2596 * Broadcast sent when a user is going to be stopped. Carries an extra
2597 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2598 * sent to registered receivers, not manifest receivers. It is sent to all
2599 * users (including the one that is being stopped). You must hold
2600 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2601 * this broadcast. The user will not stop until all receivers have
2602 * handled the broadcast. This is sent as a background broadcast, since
2603 * its result is not part of the primary UX flow; to safely keep track of
2604 * started/stopped state of a user you can use this in conjunction with
2605 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2606 * other user state broadcasts since those are foreground broadcasts so can
2607 * execute in a different order.
2608 * @hide
2609 */
2610 public static final String ACTION_USER_STOPPING =
2611 "android.intent.action.USER_STOPPING";
2612
2613 /**
2614 * Broadcast sent to the system when a user is stopped. Carries an extra
2615 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2616 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2617 * specific package. This is only sent to registered receivers, not manifest
2618 * receivers. It is sent to all running users <em>except</em> the one that
2619 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002620 * @hide
2621 */
2622 public static final String ACTION_USER_STOPPED =
2623 "android.intent.action.USER_STOPPED";
2624
2625 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002626 * 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 -07002627 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002628 * one that has been removed. The user will not be completely removed until all receivers have
2629 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002630 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002631 * @hide
2632 */
2633 public static final String ACTION_USER_REMOVED =
2634 "android.intent.action.USER_REMOVED";
2635
2636 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002637 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002638 * the userHandle of the user to become the current one. This is only sent to
2639 * registered receivers, not manifest receivers. It is sent to all running users.
2640 * You must hold
2641 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002642 * @hide
2643 */
2644 public static final String ACTION_USER_SWITCHED =
2645 "android.intent.action.USER_SWITCHED";
2646
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002647 /**
2648 * Broadcast sent to the system when a user's information changes. Carries an extra
2649 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002650 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002651 * @hide
2652 */
2653 public static final String ACTION_USER_INFO_CHANGED =
2654 "android.intent.action.USER_INFO_CHANGED";
2655
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002656 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01002657 * Broadcast sent to the primary user when an associated managed profile is added (the profile
2658 * was created and is ready to be used). Carries an extra {@link #EXTRA_USER} that specifies
2659 * the UserHandle of the profile that was added. This is only sent to registered receivers,
2660 * not manifest receivers.
2661 */
2662 public static final String ACTION_MANAGED_PROFILE_ADDED =
2663 "android.intent.action.MANAGED_PROFILE_ADDED";
2664
2665 /**
2666 * Broadcast sent to the primary user when an associated managed profile is removed. Carries an
2667 * extra {@link #EXTRA_USER} that specifies the UserHandle of the profile that was removed. This
2668 * is only sent to registered receivers, not manifest receivers.
2669 */
2670 public static final String ACTION_MANAGED_PROFILE_REMOVED =
2671 "android.intent.action.MANAGED_PROFILE_REMOVED";
2672
2673 /**
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002674 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2675 */
2676 public static final String ACTION_QUICK_CLOCK =
2677 "android.intent.action.QUICK_CLOCK";
2678
Michael Wright0087a142013-02-05 16:29:39 -08002679 /**
2680 * Broadcast Action: This is broadcast when a user action should request the
2681 * brightness setting dialog.
2682 * @hide
2683 */
2684 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2685 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2686
Justin Kohd378ad72013-04-01 12:18:26 -07002687 /**
2688 * Broadcast Action: A global button was pressed. Includes a single
2689 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2690 * caused the broadcast.
2691 * @hide
2692 */
2693 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2694
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002695 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002696 * Activity Action: Allow the user to select and return one or more existing
2697 * documents. When invoked, the system will display the various
2698 * {@link DocumentsProvider} instances installed on the device, letting the
2699 * user interactively navigate through them. These documents include local
2700 * media, such as photos and video, and documents provided by installed
2701 * cloud storage providers.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002702 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002703 * Each document is represented as a {@code content://} URI backed by a
2704 * {@link DocumentsProvider}, which can be opened as a stream with
2705 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2706 * {@link android.provider.DocumentsContract.Document} metadata.
2707 * <p>
2708 * All selected documents are returned to the calling application with
2709 * persistable read and write permission grants. If you want to maintain
2710 * access to the documents across device reboots, you need to explicitly
2711 * take the persistable permissions using
2712 * {@link ContentResolver#takePersistableUriPermission(Uri, int)}.
2713 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002714 * Callers must indicate the acceptable document MIME types through
2715 * {@link #setType(String)}. For example, to select photos, use
2716 * {@code image/*}. If multiple disjoint MIME types are acceptable, define
2717 * them in {@link #EXTRA_MIME_TYPES} and {@link #setType(String)} to
2718 * {@literal *}/*.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002719 * <p>
2720 * If the caller can handle multiple returned items (the user performing
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002721 * multiple selection), then you can specify {@link #EXTRA_ALLOW_MULTIPLE}
2722 * to indicate this.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002723 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002724 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2725 * returned URIs can be opened with
2726 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002727 * <p>
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002728 * Output: The URI of the item that was picked, returned in
2729 * {@link #getData()}. This must be a {@code content://} URI so that any
2730 * receiver can access it. If multiple documents were selected, they are
2731 * returned in {@link #getClipData()}.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002732 *
2733 * @see DocumentsContract
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002734 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002735 * @see #ACTION_CREATE_DOCUMENT
2736 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002737 */
2738 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2739 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2740
2741 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002742 * Activity Action: Allow the user to create a new document. When invoked,
2743 * the system will display the various {@link DocumentsProvider} instances
2744 * installed on the device, letting the user navigate through them. The
2745 * returned document may be a newly created document with no content, or it
2746 * may be an existing document with the requested MIME type.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002747 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002748 * Each document is represented as a {@code content://} URI backed by a
2749 * {@link DocumentsProvider}, which can be opened as a stream with
2750 * {@link ContentResolver#openFileDescriptor(Uri, String)}, or queried for
2751 * {@link android.provider.DocumentsContract.Document} metadata.
2752 * <p>
2753 * Callers must indicate the concrete MIME type of the document being
2754 * created by setting {@link #setType(String)}. This MIME type cannot be
2755 * changed after the document is created.
2756 * <p>
2757 * Callers can provide an initial display name through {@link #EXTRA_TITLE},
2758 * but the user may change this value before creating the file.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002759 * <p>
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002760 * Callers must include {@link #CATEGORY_OPENABLE} in the Intent so that
2761 * returned URIs can be opened with
2762 * {@link ContentResolver#openFileDescriptor(Uri, String)}.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002763 * <p>
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002764 * Output: The URI of the item that was created. This must be a
2765 * {@code content://} URI so that any receiver can access it.
Jeff Sharkeybd3b9022013-08-20 15:20:04 -07002766 *
2767 * @see DocumentsContract
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002768 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002769 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002770 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002771 */
2772 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2773 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2774
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002775 /**
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002776 * Activity Action: Allow the user to pick a directory subtree. When
2777 * invoked, the system will display the various {@link DocumentsProvider}
2778 * instances installed on the device, letting the user navigate through
2779 * them. Apps can fully manage documents within the returned directory.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002780 * <p>
2781 * To gain access to descendant (child, grandchild, etc) documents, use
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002782 * {@link DocumentsContract#buildDocumentUriUsingTree(Uri, String)} and
2783 * {@link DocumentsContract#buildChildDocumentsUriUsingTree(Uri, String)}
2784 * with the returned URI.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002785 * <p>
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002786 * Output: The URI representing the selected directory tree.
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002787 *
2788 * @see DocumentsContract
2789 */
2790 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07002791 public static final String
2792 ACTION_OPEN_DOCUMENT_TREE = "android.intent.action.OPEN_DOCUMENT_TREE";
Jeff Sharkey21de56a2014-04-05 19:05:24 -07002793
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002794 // ---------------------------------------------------------------------
2795 // ---------------------------------------------------------------------
2796 // Standard intent categories (see addCategory()).
2797
2798 /**
2799 * Set if the activity should be an option for the default action
2800 * (center press) to perform on a piece of data. Setting this will
2801 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002802 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002803 * Intent when initiating an action -- it is for use in intent filters
2804 * specified in packages.
2805 */
2806 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2807 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2808 /**
2809 * Activities that can be safely invoked from a browser must support this
2810 * category. For example, if the user is viewing a web page or an e-mail
2811 * and clicks on a link in the text, the Intent generated execute that
2812 * link will require the BROWSABLE category, so that only activities
2813 * supporting this category will be considered as possible actions. By
2814 * supporting this category, you are promising that there is nothing
2815 * damaging (without user intervention) that can happen by invoking any
2816 * matching Intent.
2817 */
2818 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2819 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2820 /**
Dianne Hackborn91097de2014-04-04 18:02:06 -07002821 * Categories for activities that can participate in voice interaction.
2822 * An activity that supports this category must be prepared to run with
2823 * no UI shown at all (though in some case it may have a UI shown), and
2824 * rely on {@link android.app.VoiceInteractor} to interact with the user.
2825 */
2826 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2827 public static final String CATEGORY_VOICE = "android.intent.category.VOICE";
2828 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002829 * Set if the activity should be considered as an alternative action to
2830 * the data the user is currently viewing. See also
2831 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2832 * applies to the selection in a list of items.
2833 *
2834 * <p>Supporting this category means that you would like your activity to be
2835 * displayed in the set of alternative things the user can do, usually as
2836 * part of the current activity's options menu. You will usually want to
2837 * include a specific label in the &lt;intent-filter&gt; of this action
2838 * describing to the user what it does.
2839 *
2840 * <p>The action of IntentFilter with this category is important in that it
2841 * describes the specific action the target will perform. This generally
2842 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2843 * a specific name such as "com.android.camera.action.CROP. Only one
2844 * alternative of any particular action will be shown to the user, so using
2845 * a specific action like this makes sure that your alternative will be
2846 * displayed while also allowing other applications to provide their own
2847 * overrides of that particular action.
2848 */
2849 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2850 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2851 /**
2852 * Set if the activity should be considered as an alternative selection
2853 * action to the data the user has currently selected. This is like
2854 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2855 * of items from which the user can select, giving them alternatives to the
2856 * default action that will be performed on it.
2857 */
2858 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2859 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2860 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002861 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002862 */
2863 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2864 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2865 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002866 * Should be displayed in the top-level launcher.
2867 */
2868 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2869 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2870 /**
Jose Lima38b75b62014-03-11 10:41:39 -07002871 * Indicates an activity optimized for Leanback mode, and that should
2872 * be displayed in the Leanback launcher.
2873 */
2874 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2875 public static final String CATEGORY_LEANBACK_LAUNCHER = "android.intent.category.LEANBACK_LAUNCHER";
2876 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002877 * Provides information about the package it is in; typically used if
2878 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2879 * a front-door to the user without having to be shown in the all apps list.
2880 */
2881 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2882 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2883 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002884 * This is the home activity, that is the first activity that is displayed
2885 * when the device boots.
2886 */
2887 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2888 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2889 /**
2890 * This activity is a preference panel.
2891 */
2892 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2893 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2894 /**
2895 * This activity is a development preference panel.
2896 */
2897 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2898 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2899 /**
2900 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002901 */
2902 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2903 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2904 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002905 * This activity allows the user to browse and download new applications.
2906 */
2907 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2908 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2909 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002910 * This activity may be exercised by the monkey or other automated test tools.
2911 */
2912 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2913 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2914 /**
2915 * To be used as a test (not part of the normal user experience).
2916 */
2917 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2918 /**
2919 * To be used as a unit test (run through the Test Harness).
2920 */
2921 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2922 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002923 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002924 * experience).
2925 */
2926 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002927
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002928 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07002929 * Used to indicate that an intent only wants URIs that can be opened with
2930 * {@link ContentResolver#openFileDescriptor(Uri, String)}. Openable URIs
2931 * must support at least the columns defined in {@link OpenableColumns} when
2932 * queried.
2933 *
2934 * @see #ACTION_GET_CONTENT
2935 * @see #ACTION_OPEN_DOCUMENT
2936 * @see #ACTION_CREATE_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002937 */
2938 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2939 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2940
2941 /**
2942 * To be used as code under test for framework instrumentation tests.
2943 */
2944 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2945 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002946 /**
2947 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002948 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2949 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002950 */
2951 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2952 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2953 /**
2954 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002955 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2956 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002957 */
2958 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2959 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002960 /**
2961 * An activity to run when device is inserted into a analog (low end) dock.
2962 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2963 * information, see {@link android.app.UiModeManager}.
2964 */
2965 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2966 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2967
2968 /**
2969 * An activity to run when device is inserted into a digital (high end) dock.
2970 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2971 * information, see {@link android.app.UiModeManager}.
2972 */
2973 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2974 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002975
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002976 /**
2977 * Used to indicate that the activity can be used in a car environment.
2978 */
2979 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2980 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002982 // ---------------------------------------------------------------------
2983 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002984 // Application launch intent categories (see addCategory()).
2985
2986 /**
2987 * Used with {@link #ACTION_MAIN} to launch the browser application.
2988 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002989 * <p>NOTE: This should not be used as the primary key of an Intent,
2990 * since it will not result in the app launching with the correct
2991 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002992 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002993 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002994 */
2995 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2996 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2997
2998 /**
2999 * Used with {@link #ACTION_MAIN} to launch the calculator application.
3000 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003001 * <p>NOTE: This should not be used as the primary key of an Intent,
3002 * since it will not result in the app launching with the correct
3003 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003004 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003005 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003006 */
3007 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3008 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
3009
3010 /**
3011 * Used with {@link #ACTION_MAIN} to launch the calendar application.
3012 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003013 * <p>NOTE: This should not be used as the primary key of an Intent,
3014 * since it will not result in the app launching with the correct
3015 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003016 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003017 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003018 */
3019 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3020 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
3021
3022 /**
3023 * Used with {@link #ACTION_MAIN} to launch the contacts application.
3024 * The activity should be able to view and manipulate address book entries.
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_CONTACTS = "android.intent.category.APP_CONTACTS";
3033
3034 /**
3035 * Used with {@link #ACTION_MAIN} to launch the email application.
3036 * The activity should be able to send and receive email.
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_EMAIL = "android.intent.category.APP_EMAIL";
3045
3046 /**
3047 * Used with {@link #ACTION_MAIN} to launch the gallery application.
3048 * The activity should be able to view and manipulate image and video files
3049 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003050 * <p>NOTE: This should not be used as the primary key of an Intent,
3051 * since it will not result in the app launching with the correct
3052 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003053 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003054 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003055 */
3056 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3057 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
3058
3059 /**
3060 * Used with {@link #ACTION_MAIN} to launch the maps application.
3061 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003062 * <p>NOTE: This should not be used as the primary key of an Intent,
3063 * since it will not result in the app launching with the correct
3064 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003065 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003066 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003067 */
3068 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3069 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
3070
3071 /**
3072 * Used with {@link #ACTION_MAIN} to launch the messaging application.
3073 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003074 * <p>NOTE: This should not be used as the primary key of an Intent,
3075 * since it will not result in the app launching with the correct
3076 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003077 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003078 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003079 */
3080 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3081 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
3082
3083 /**
3084 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003085 * The activity should be able to play, browse, or manipulate music files
3086 * stored on the device.
3087 * <p>NOTE: This should not be used as the primary key of an Intent,
3088 * since it will not result in the app launching with the correct
3089 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08003090 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003091 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08003092 */
3093 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
3094 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
3095
3096 // ---------------------------------------------------------------------
3097 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003098 // Standard extra data keys.
3099
3100 /**
3101 * The initial data to place in a newly created record. Use with
3102 * {@link #ACTION_INSERT}. The data here is a Map containing the same
3103 * fields as would be given to the underlying ContentProvider.insert()
3104 * call.
3105 */
3106 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
3107
3108 /**
3109 * A constant CharSequence that is associated with the Intent, used with
3110 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
3111 * this may be a styled CharSequence, so you must use
3112 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
3113 * retrieve it.
3114 */
3115 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
3116
3117 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07003118 * A constant String that is associated with the Intent, used with
3119 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
3120 * as HTML formatted text. Note that you <em>must</em> also supply
3121 * {@link #EXTRA_TEXT}.
3122 */
3123 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
3124
3125 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003126 * A content: URI holding a stream of data associated with the Intent,
3127 * used with {@link #ACTION_SEND} to supply the data being sent.
3128 */
3129 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
3130
3131 /**
3132 * A String[] holding e-mail addresses that should be delivered to.
3133 */
3134 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
3135
3136 /**
3137 * A String[] holding e-mail addresses that should be carbon copied.
3138 */
3139 public static final String EXTRA_CC = "android.intent.extra.CC";
3140
3141 /**
3142 * A String[] holding e-mail addresses that should be blind carbon copied.
3143 */
3144 public static final String EXTRA_BCC = "android.intent.extra.BCC";
3145
3146 /**
3147 * A constant string holding the desired subject line of a message.
3148 */
3149 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
3150
3151 /**
3152 * An Intent describing the choices you would like shown with
3153 * {@link #ACTION_PICK_ACTIVITY}.
3154 */
3155 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3156
3157 /**
3158 * A CharSequence dialog title to provide to the user when used with a
3159 * {@link #ACTION_CHOOSER}.
3160 */
3161 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3162
3163 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003164 * A Parcelable[] of {@link Intent} or
3165 * {@link android.content.pm.LabeledIntent} objects as set with
3166 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3167 * a the front of the list of choices, when shown to the user with a
3168 * {@link #ACTION_CHOOSER}.
3169 */
3170 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3171
3172 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003173 * A {@link android.view.KeyEvent} object containing the event that
3174 * triggered the creation of the Intent it is in.
3175 */
3176 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3177
3178 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003179 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3180 * before shutting down.
3181 *
3182 * {@hide}
3183 */
3184 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3185
3186 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003187 * 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 -07003188 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3189 * of restarting the application.
3190 */
3191 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3192
3193 /**
3194 * A String holding the phone number originally entered in
3195 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3196 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3197 */
3198 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003199
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003200 /**
3201 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3202 * intents to supply the uid the package had been assigned. Also an optional
3203 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3204 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3205 * purpose.
3206 */
3207 public static final String EXTRA_UID = "android.intent.extra.UID";
3208
3209 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003210 * @hide String array of package names.
3211 */
3212 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3213
3214 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003215 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3216 * intents to indicate whether this represents a full uninstall (removing
3217 * both the code and its data) or a partial uninstall (leaving its data,
3218 * implying that this is an update).
3219 */
3220 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003221
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003222 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003223 * @hide
3224 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3225 * intents to indicate that at this point the package has been removed for
3226 * all users on the device.
3227 */
3228 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3229 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3230
3231 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003232 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3233 * intents to indicate that this is a replacement of the package, so this
3234 * broadcast will immediately be followed by an add broadcast for a
3235 * different version of the same package.
3236 */
3237 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003238
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003239 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003240 * Used as an int extra field in {@link android.app.AlarmManager} intents
3241 * to tell the application being invoked how many pending alarms are being
3242 * delievered with the intent. For one-shot alarms this will always be 1.
3243 * For recurring alarms, this might be greater than 1 if the device was
3244 * asleep or powered off at the time an earlier alarm would have been
3245 * delivered.
3246 */
3247 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003248
Jacek Surazski86b6c532009-05-13 14:38:28 +02003249 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003250 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3251 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003252 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3253 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003254 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3255 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3256 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003257 */
3258 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3259
3260 /**
3261 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3262 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003263 */
3264 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3265
3266 /**
3267 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3268 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003269 */
3270 public static final int EXTRA_DOCK_STATE_DESK = 1;
3271
3272 /**
3273 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3274 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003275 */
3276 public static final int EXTRA_DOCK_STATE_CAR = 2;
3277
3278 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003279 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3280 * to represent that the phone is in a analog (low end) dock.
3281 */
3282 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3283
3284 /**
3285 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3286 * to represent that the phone is in a digital (high end) dock.
3287 */
3288 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3289
3290 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003291 * Boolean that can be supplied as meta-data with a dock activity, to
3292 * indicate that the dock should take over the home key when it is active.
3293 */
3294 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003295
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003296 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003297 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3298 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003299 */
3300 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3301
3302 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003303 * Used in the extra field in the remote intent. It's astring token passed with the
3304 * remote intent.
3305 */
3306 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3307 "android.intent.extra.remote_intent_token";
3308
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003309 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003310 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003311 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003312 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003313 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003314 "android.intent.extra.changed_component_name";
3315
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003316 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003317 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003318 * and contains a string array of all of the components that have changed. If
3319 * the state of the overall package has changed, then it will contain an entry
3320 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003321 */
3322 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3323 "android.intent.extra.changed_component_name_list";
3324
3325 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003326 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003327 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3328 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003329 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003330 */
3331 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3332 "android.intent.extra.changed_package_list";
3333
3334 /**
3335 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003336 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3337 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003338 * and contains an integer array of uids of all of the components
3339 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003340 */
3341 public static final String EXTRA_CHANGED_UID_LIST =
3342 "android.intent.extra.changed_uid_list";
3343
3344 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003345 * @hide
3346 * Magic extra system code can use when binding, to give a label for
3347 * who it is that has bound to a service. This is an integer giving
3348 * a framework string resource that can be displayed to the user.
3349 */
3350 public static final String EXTRA_CLIENT_LABEL =
3351 "android.intent.extra.client_label";
3352
3353 /**
3354 * @hide
3355 * Magic extra system code can use when binding, to give a PendingIntent object
3356 * that can be launched for the user to disable the system's use of this
3357 * service.
3358 */
3359 public static final String EXTRA_CLIENT_INTENT =
3360 "android.intent.extra.client_intent";
3361
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003362 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003363 * Extra used to indicate that an intent should only return data that is on
3364 * the local device. This is a boolean extra; the default is false. If true,
3365 * an implementation should only allow the user to select data that is
3366 * already on the device, not requiring it be downloaded from a remote
3367 * service when opened.
3368 *
3369 * @see #ACTION_GET_CONTENT
3370 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkeyb9fbb722014-06-04 16:42:47 -07003371 * @see #ACTION_OPEN_DOCUMENT_TREE
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003372 * @see #ACTION_CREATE_DOCUMENT
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003373 */
3374 public static final String EXTRA_LOCAL_ONLY =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003375 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003376
Amith Yamasani13593602012-03-22 16:16:17 -07003377 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003378 * Extra used to indicate that an intent can allow the user to select and
3379 * return multiple items. This is a boolean extra; the default is false. If
3380 * true, an implementation is allowed to present the user with a UI where
3381 * they can pick multiple items that are all returned to the caller. When
3382 * this happens, they should be returned as the {@link #getClipData()} part
3383 * of the result Intent.
3384 *
3385 * @see #ACTION_GET_CONTENT
3386 * @see #ACTION_OPEN_DOCUMENT
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003387 */
3388 public static final String EXTRA_ALLOW_MULTIPLE =
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003389 "android.intent.extra.ALLOW_MULTIPLE";
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003390
3391 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003392 * The integer userHandle carried with broadcast intents related to addition, removal and
3393 * switching of users and managed profiles - {@link #ACTION_USER_ADDED},
3394 * {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3395 *
Amith Yamasani13593602012-03-22 16:16:17 -07003396 * @hide
3397 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003398 public static final String EXTRA_USER_HANDLE =
3399 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003400
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003401 /**
Alexandra Gherghinac17d7e02014-04-04 16:27:28 +01003402 * The UserHandle carried with broadcasts intents related to addition and removal of managed
3403 * profiles - {@link #ACTION_MANAGED_PROFILE_ADDED} and {@link #ACTION_MANAGED_PROFILE_REMOVED}.
3404 */
3405 public static final String EXTRA_USER =
3406 "android.intent.extra.user";
3407
3408 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003409 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003410 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3411 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003412 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003413 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3414
3415 /**
3416 * Extra sent in the intent to the BroadcastReceiver that handles
3417 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3418 * the restrictions as key/value pairs.
3419 */
3420 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3421 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003422
Amith Yamasani86118ba2013-03-28 14:33:16 -07003423 /**
3424 * Extra used in the response from a BroadcastReceiver that handles
3425 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3426 */
3427 public static final String EXTRA_RESTRICTIONS_INTENT =
3428 "android.intent.extra.restrictions_intent";
3429
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003430 /**
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003431 * Extra used to communicate a set of acceptable MIME types. The type of the
3432 * extra is {@code String[]}. Values may be a combination of concrete MIME
3433 * types (such as "image/png") and/or partial MIME types (such as
3434 * "audio/*").
3435 *
3436 * @see #ACTION_GET_CONTENT
3437 * @see #ACTION_OPEN_DOCUMENT
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003438 */
3439 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3440
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003441 /**
3442 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3443 * this shutdown is only for the user space of the system, not a complete shutdown.
Dianne Hackbornd318e0b2013-09-03 14:34:12 -07003444 * When this is true, hardware devices can use this information to determine that
3445 * they shouldn't do a complete shutdown of their device since this is not a
3446 * complete shutdown down to the kernel, but only user space restarting.
3447 * The default if not supplied is false.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003448 */
3449 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3450 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3451
Narayan Kamathccb2a0862013-12-19 14:49:36 +00003452 /**
3453 * Optional boolean extra for {@link #ACTION_TIME_CHANGED} that indicates the
3454 * user has set their time format preferences to the 24 hour format.
3455 *
3456 * @hide for internal use only.
3457 */
3458 public static final String EXTRA_TIME_PREF_24_HOUR_FORMAT =
3459 "android.intent.extra.TIME_PREF_24_HOUR_FORMAT";
3460
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003461 // ---------------------------------------------------------------------
3462 // ---------------------------------------------------------------------
3463 // Intent flags (see mFlags variable).
3464
Tor Norbyed9273d62013-05-30 15:59:53 -07003465 /** @hide */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003466 @IntDef(flag = true, value = {
3467 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION,
3468 FLAG_GRANT_PERSISTABLE_URI_PERMISSION, FLAG_GRANT_PREFIX_URI_PERMISSION })
Tor Norbyed9273d62013-05-30 15:59:53 -07003469 @Retention(RetentionPolicy.SOURCE)
3470 public @interface GrantUriMode {}
3471
Jeff Sharkey846318a2014-04-04 12:12:41 -07003472 /** @hide */
3473 @IntDef(flag = true, value = {
3474 FLAG_GRANT_READ_URI_PERMISSION, FLAG_GRANT_WRITE_URI_PERMISSION })
3475 @Retention(RetentionPolicy.SOURCE)
3476 public @interface AccessUriMode {}
3477
3478 /**
3479 * Test if given mode flags specify an access mode, which must be at least
3480 * read and/or write.
3481 *
3482 * @hide
3483 */
3484 public static boolean isAccessUriMode(int modeFlags) {
3485 return (modeFlags & (Intent.FLAG_GRANT_READ_URI_PERMISSION
3486 | Intent.FLAG_GRANT_WRITE_URI_PERMISSION)) != 0;
3487 }
3488
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003489 /**
3490 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003491 * perform read operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003492 * specified in its ClipData. When applying to an Intent's ClipData,
3493 * all URIs as well as recursive traversals through data or other ClipData
3494 * in Intent items will be granted; only the grant flags of the top-level
3495 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003496 */
3497 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3498 /**
3499 * If set, the recipient of this Intent will be granted permission to
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003500 * perform write operations on the URI in the Intent's data and any URIs
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003501 * specified in its ClipData. When applying to an Intent's ClipData,
3502 * all URIs as well as recursive traversals through data or other ClipData
3503 * in Intent items will be granted; only the grant flags of the top-level
3504 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003505 */
3506 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3507 /**
3508 * Can be set by the caller to indicate that this Intent is coming from
3509 * a background operation, not from direct user interaction.
3510 */
3511 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3512 /**
3513 * A flag you can enable for debugging: when set, log messages will be
3514 * printed during the resolution of this intent to show you what has
3515 * been found to create the final resolved list.
3516 */
3517 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003518 /**
3519 * If set, this intent will not match any components in packages that
3520 * are currently stopped. If this is not set, then the default behavior
3521 * is to include such applications in the result.
3522 */
3523 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3524 /**
3525 * If set, this intent will always match any components in packages that
3526 * are currently stopped. This is the default behavior when
3527 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3528 * flags are set, this one wins (it allows overriding of exclude for
3529 * places where the framework may automatically set the exclude flag).
3530 */
3531 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003532
3533 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003534 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003535 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant can be
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003536 * persisted across device reboots until explicitly revoked with
3537 * {@link Context#revokeUriPermission(Uri, int)}. This flag only offers the
3538 * grant for possible persisting; the receiving application must call
3539 * {@link ContentResolver#takePersistableUriPermission(Uri, int)} to
3540 * actually persist.
3541 *
3542 * @see ContentResolver#takePersistableUriPermission(Uri, int)
3543 * @see ContentResolver#releasePersistableUriPermission(Uri, int)
3544 * @see ContentResolver#getPersistedUriPermissions()
Jeff Sharkeyadef88a2013-10-15 13:54:44 -07003545 * @see ContentResolver#getOutgoingPersistedUriPermissions()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003546 */
Jeff Sharkeye66c1772013-09-20 14:30:59 -07003547 public static final int FLAG_GRANT_PERSISTABLE_URI_PERMISSION = 0x00000040;
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003548
3549 /**
Jeff Sharkey846318a2014-04-04 12:12:41 -07003550 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3551 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the URI permission grant
3552 * applies to any URI that is a prefix match against the original granted
3553 * URI. (Without this flag, the URI must match exactly for access to be
3554 * granted.) Another URI is considered a prefix match only when scheme,
3555 * authority, and all path segments defined by the prefix are an exact
3556 * match.
3557 */
3558 public static final int FLAG_GRANT_PREFIX_URI_PERMISSION = 0x00000080;
3559
3560 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003561 * If set, the new activity is not kept in the history stack. As soon as
3562 * the user navigates away from it, the activity is finished. This may also
3563 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3564 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003565 */
3566 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3567 /**
3568 * If set, the activity will not be launched if it is already running
3569 * at the top of the history stack.
3570 */
3571 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3572 /**
3573 * If set, this activity will become the start of a new task on this
3574 * history stack. A task (from the activity that started it to the
3575 * next task activity) defines an atomic group of activities that the
3576 * user can move to. Tasks can be moved to the foreground and background;
3577 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003578 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003579 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3580 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003581 *
3582 * <p>This flag is generally used by activities that want
3583 * to present a "launcher" style behavior: they give the user a list of
3584 * separate things that can be done, which otherwise run completely
3585 * independently of the activity launching them.
3586 *
3587 * <p>When using this flag, if a task is already running for the activity
3588 * you are now starting, then a new activity will not be started; instead,
3589 * the current task will simply be brought to the front of the screen with
3590 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3591 * to disable this behavior.
3592 *
3593 * <p>This flag can not be used when the caller is requesting a result from
3594 * the activity being launched.
3595 */
3596 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3597 /**
Craig Mautnerd00f4742014-03-12 14:17:26 -07003598 * This flag is used to create a new task and launch an activity into it.
3599 * This flag is always paired with either {@link #FLAG_ACTIVITY_NEW_DOCUMENT}
3600 * or {@link #FLAG_ACTIVITY_NEW_TASK}. In both cases these flags alone would
3601 * search through existing tasks for ones matching this Intent. Only if no such
3602 * task is found would a new task be created. When paired with
3603 * FLAG_ACTIVITY_MULTIPLE_TASK both of these behaviors are modified to skip
3604 * the search for a matching task and unconditionally start a new task.
3605 *
3606 * <strong>When used with {@link #FLAG_ACTIVITY_NEW_TASK} do not use this
3607 * flag unless you are implementing your own
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003608 * top-level application launcher.</strong> Used in conjunction with
3609 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3610 * behavior of bringing an existing task to the foreground. When set,
3611 * a new task is <em>always</em> started to host the Activity for the
3612 * Intent, regardless of whether there is already an existing task running
3613 * the same thing.
3614 *
3615 * <p><strong>Because the default system does not include graphical task management,
3616 * you should not use this flag unless you provide some way for a user to
3617 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003618 *
Craig Mautnerd00f4742014-03-12 14:17:26 -07003619 * See {@link #FLAG_ACTIVITY_NEW_DOCUMENT} for details of this flag's use for
3620 * creating new document tasks.
3621 *
3622 * <p>This flag is ignored if one of {@link #FLAG_ACTIVITY_NEW_TASK} or
3623 * {@link #FLAG_ACTIVITY_NEW_TASK} is not also set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003624 *
Scott Main7aee61f2011-02-08 11:25:01 -08003625 * <p>See
3626 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3627 * Stack</a> for more information about tasks.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003628 *
3629 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
3630 * @see #FLAG_ACTIVITY_NEW_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003631 */
3632 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3633 /**
3634 * If set, and the activity being launched is already running in the
3635 * current task, then instead of launching a new instance of that activity,
3636 * all of the other activities on top of it will be closed and this Intent
3637 * will be delivered to the (now on top) old activity as a new Intent.
3638 *
3639 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3640 * If D calls startActivity() with an Intent that resolves to the component
3641 * of activity B, then C and D will be finished and B receive the given
3642 * Intent, resulting in the stack now being: A, B.
3643 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003644 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003645 * either receive the new intent you are starting here in its
3646 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003647 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003648 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3649 * the same intent, then it will be finished and re-created; for all other
3650 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3651 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003652 *
3653 * <p>This launch mode can also be used to good effect in conjunction with
3654 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3655 * of a task, it will bring any currently running instance of that task
3656 * to the foreground, and then clear it to its root state. This is
3657 * especially useful, for example, when launching an activity from the
3658 * notification manager.
3659 *
Scott Main7aee61f2011-02-08 11:25:01 -08003660 * <p>See
3661 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3662 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663 */
3664 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3665 /**
3666 * If set and this intent is being used to launch a new activity from an
3667 * existing one, then the reply target of the existing activity will be
3668 * transfered to the new activity. This way the new activity can call
3669 * {@link android.app.Activity#setResult} and have that result sent back to
3670 * the reply target of the original activity.
3671 */
3672 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3673 /**
3674 * If set and this intent is being used to launch a new activity from an
3675 * existing one, the current activity will not be counted as the top
3676 * activity for deciding whether the new intent should be delivered to
3677 * the top instead of starting a new one. The previous activity will
3678 * be used as the top, with the assumption being that the current activity
3679 * will finish itself immediately.
3680 */
3681 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3682 /**
3683 * If set, the new activity is not kept in the list of recently launched
3684 * activities.
3685 */
3686 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3687 /**
3688 * This flag is not normally set by application code, but set for you by
3689 * the system as described in the
3690 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3691 * launchMode} documentation for the singleTask mode.
3692 */
3693 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3694 /**
3695 * If set, and this activity is either being started in a new task or
3696 * bringing to the top an existing task, then it will be launched as
3697 * the front door of the task. This will result in the application of
3698 * any affinities needed to have that task in the proper state (either
3699 * moving activities to or from it), or simply resetting that task to
3700 * its initial state if needed.
3701 */
3702 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3703 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003704 * This flag is not normally set by application code, but set for you by
3705 * the system if this activity is being launched from history
3706 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003707 */
3708 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003709 /**
3710 * If set, this marks a point in the task's activity stack that should
3711 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003712 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003713 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3714 * the user re-launching it from home), this activity and all on top of
3715 * it will be finished so that the user does not return to them, but
3716 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003717 *
Craig Mautnere1f3fa22014-01-24 18:02:10 -08003718 * <p>When this flag is assigned to the root activity all activities up
3719 * to, but not including the root activity, will be cleared. This prevents
3720 * this flag from being used to finish all activities in a task and thereby
3721 * ending the task.
3722 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003723 * <p>This is useful for cases where you have a logical break in your
3724 * application. For example, an e-mail application may have a command
3725 * to view an attachment, which launches an image view activity to
3726 * display it. This activity should be part of the e-mail application's
3727 * task, since it is a part of the task the user is involved in. However,
3728 * if the user leaves that task, and later selects the e-mail app from
3729 * home, we may like them to return to the conversation they were
3730 * viewing, not the picture attachment, since that is confusing. By
3731 * setting this flag when launching the image viewer, that viewer and
3732 * any activities it starts will be removed the next time the user returns
3733 * to mail.
3734 */
3735 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003736 /**
Craig Mautner026596b2014-05-21 15:35:44 -07003737 * This flag is used to open a document into a new task rooted at the activity launched
3738 * by this Intent. Through the use of this flag, or its equivalent attribute,
3739 * {@link android.R.attr#documentLaunchMode} multiple instances of the same activity
3740 * containing different douments will appear in the recent tasks list.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003741 *
Craig Mautner026596b2014-05-21 15:35:44 -07003742 * <p>The use of the activity attribute form of this,
3743 * {@link android.R.attr#documentLaunchMode}, is
3744 * preferred over the Intent flag described here. The attribute form allows the
3745 * Activity to specify multiple document behavior for all launchers of the Activity
3746 * whereas using this flag requires each Intent that launches the Activity to specify it.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003747 *
Craig Mautner026596b2014-05-21 15:35:44 -07003748 * <p>FLAG_ACTIVITY_NEW_DOCUMENT may be used in conjunction with {@link
3749 * #FLAG_ACTIVITY_MULTIPLE_TASK}. When used alone it is the
3750 * equivalent of the Activity manifest specifying {@link
3751 * android.R.attr#documentLaunchMode}="intoExisting". When used with
3752 * FLAG_ACTIVITY_MULTIPLE_TASK it is the equivalent of the Activity manifest specifying
3753 * {@link android.R.attr#documentLaunchMode}="always".
Craig Mautnerd00f4742014-03-12 14:17:26 -07003754 *
Craig Mautner026596b2014-05-21 15:35:44 -07003755 * Refer to {@link android.R.attr#documentLaunchMode} for more information.
Craig Mautnerd00f4742014-03-12 14:17:26 -07003756 *
Craig Mautner026596b2014-05-21 15:35:44 -07003757 * @see android.R.attr#documentLaunchMode
Craig Mautnerd00f4742014-03-12 14:17:26 -07003758 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
3759 */
3760 public static final int FLAG_ACTIVITY_NEW_DOCUMENT =
3761 FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET | FLAG_ACTIVITY_NEW_TASK;
3762 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003763 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003764 * callback from occurring on the current frontmost activity before it is
3765 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003766 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003767 * <p>Typically, an activity can rely on that callback to indicate that an
3768 * explicit user action has caused their activity to be moved out of the
3769 * foreground. The callback marks an appropriate point in the activity's
3770 * lifecycle for it to dismiss any notifications that it intends to display
3771 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003772 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003773 * <p>If an activity is ever started via any non-user-driven events such as
3774 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3775 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003776 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003777 */
3778 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003779 /**
3780 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3781 * this flag will cause the launched activity to be brought to the front of its
3782 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003783 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003784 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3785 * If D calls startActivity() with an Intent that resolves to the component
3786 * of activity B, then B will be brought to the front of the history stack,
3787 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003788 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003789 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003790 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003791 */
3792 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003793 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003794 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3795 * this flag will prevent the system from applying an activity transition
3796 * animation to go to the next activity state. This doesn't mean an
3797 * animation will never run -- if another activity change happens that doesn't
3798 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003799 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003800 * when you are going to do a series of activity operations but the
3801 * animation seen by the user shouldn't be driven by the first activity
3802 * change but rather a later one.
3803 */
3804 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3805 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003806 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3807 * this flag will cause any existing task that would be associated with the
3808 * activity to be cleared before the activity is started. That is, the activity
3809 * becomes the new root of an otherwise empty task, and any old activities
3810 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3811 */
3812 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3813 /**
3814 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3815 * this flag will cause a newly launching task to be placed on top of the current
3816 * home activity task (if there is one). That is, pressing back from the task
3817 * will always return the user to home even if that was not the last activity they
3818 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3819 */
3820 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3821 /**
Craig Mautner2dac0562014-05-06 09:06:44 -07003822 * If set and the new activity is the root of a new task, then the task
3823 * will remain in the list of recently launched tasks only until all of
3824 * the activities in it are finished.
3825 *
3826 * <p>This is equivalent to the attribute
3827 * {@link android.R.styleable#AndroidManifestActivity_autoRemoveFromRecents}.
3828 */
3829 public static final int FLAG_ACTIVITY_AUTO_REMOVE_FROM_RECENTS = 0x00002000;
3830 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003831 * If set, when sending a broadcast only registered receivers will be
3832 * called -- no BroadcastReceiver components will be launched.
3833 */
3834 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003835 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003836 * If set, when sending a broadcast the new broadcast will replace
3837 * any existing pending broadcast that matches it. Matching is defined
3838 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3839 * true for the intents of the two broadcasts. When a match is found,
3840 * the new broadcast (and receivers associated with it) will replace the
3841 * existing one in the pending broadcast list, remaining at the same
3842 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003843 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003844 * <p>This flag is most typically used with sticky broadcasts, which
3845 * only care about delivering the most recent values of the broadcast
3846 * to their receivers.
3847 */
3848 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3849 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003850 * If set, when sending a broadcast the recipient is allowed to run at
3851 * foreground priority, with a shorter timeout interval. During normal
3852 * broadcasts the receivers are not automatically hoisted out of the
3853 * background priority class.
3854 */
3855 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3856 /**
Dianne Hackborn6285a322013-09-18 12:09:47 -07003857 * If this is an ordered broadcast, don't allow receivers to abort the broadcast.
3858 * They can still propagate results through to later receivers, but they can not prevent
3859 * later receivers from seeing the broadcast.
3860 */
3861 public static final int FLAG_RECEIVER_NO_ABORT = 0x08000000;
3862 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003863 * If set, when sending a broadcast <i>before boot has completed</i> only
3864 * registered receivers will be called -- no BroadcastReceiver components
3865 * will be launched. Sticky intent state will be recorded properly even
3866 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3867 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003868 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003869 * <p>This flag is only for use by system sevices as a convenience to
3870 * avoid having to implement a more complex mechanism around detection
3871 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003872 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003873 * @hide
3874 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003875 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x04000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003876 /**
3877 * Set when this broadcast is for a boot upgrade, a special mode that
3878 * allows the broadcast to be sent before the system is ready and launches
3879 * the app process with no providers running in it.
3880 * @hide
3881 */
Dianne Hackborn6285a322013-09-18 12:09:47 -07003882 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x02000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003883
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003884 /**
3885 * @hide Flags that can't be changed with PendingIntent.
3886 */
Jeff Sharkey846318a2014-04-04 12:12:41 -07003887 public static final int IMMUTABLE_FLAGS = FLAG_GRANT_READ_URI_PERMISSION
3888 | FLAG_GRANT_WRITE_URI_PERMISSION | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
3889 | FLAG_GRANT_PREFIX_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003890
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003891 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003892 // ---------------------------------------------------------------------
3893 // toUri() and parseUri() options.
3894
3895 /**
3896 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3897 * always has the "intent:" scheme. This syntax can be used when you want
3898 * to later disambiguate between URIs that are intended to describe an
3899 * Intent vs. all others that should be treated as raw URIs. When used
3900 * with {@link #parseUri}, any other scheme will result in a generic
3901 * VIEW action for that raw URI.
3902 */
3903 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003904
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003905 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003906
3907 private String mAction;
3908 private Uri mData;
3909 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003910 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003911 private ComponentName mComponent;
3912 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003913 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003914 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003915 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003916 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003917 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003918
3919 // ---------------------------------------------------------------------
3920
3921 /**
3922 * Create an empty intent.
3923 */
3924 public Intent() {
3925 }
3926
3927 /**
3928 * Copy constructor.
3929 */
3930 public Intent(Intent o) {
3931 this.mAction = o.mAction;
3932 this.mData = o.mData;
3933 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003934 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003935 this.mComponent = o.mComponent;
3936 this.mFlags = o.mFlags;
3937 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003938 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003939 }
3940 if (o.mExtras != null) {
3941 this.mExtras = new Bundle(o.mExtras);
3942 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003943 if (o.mSourceBounds != null) {
3944 this.mSourceBounds = new Rect(o.mSourceBounds);
3945 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003946 if (o.mSelector != null) {
3947 this.mSelector = new Intent(o.mSelector);
3948 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003949 if (o.mClipData != null) {
3950 this.mClipData = new ClipData(o.mClipData);
3951 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003952 }
3953
3954 @Override
3955 public Object clone() {
3956 return new Intent(this);
3957 }
3958
3959 private Intent(Intent o, boolean all) {
3960 this.mAction = o.mAction;
3961 this.mData = o.mData;
3962 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003963 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003964 this.mComponent = o.mComponent;
3965 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003966 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003967 }
3968 }
3969
3970 /**
3971 * Make a clone of only the parts of the Intent that are relevant for
3972 * filter matching: the action, data, type, component, and categories.
3973 */
3974 public Intent cloneFilter() {
3975 return new Intent(this, false);
3976 }
3977
3978 /**
3979 * Create an intent with a given action. All other fields (data, type,
3980 * class) are null. Note that the action <em>must</em> be in a
3981 * namespace because Intents are used globally in the system -- for
3982 * example the system VIEW action is android.intent.action.VIEW; an
3983 * application's custom action would be something like
3984 * com.google.app.myapp.CUSTOM_ACTION.
3985 *
3986 * @param action The Intent action, such as ACTION_VIEW.
3987 */
3988 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003989 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003990 }
3991
3992 /**
3993 * Create an intent with a given action and for a given data url. Note
3994 * that the action <em>must</em> be in a namespace because Intents are
3995 * used globally in the system -- for example the system VIEW action is
3996 * android.intent.action.VIEW; an application's custom action would be
3997 * something like com.google.app.myapp.CUSTOM_ACTION.
3998 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003999 * <p><em>Note: scheme and host name matching in the Android framework is
4000 * case-sensitive, unlike the formal RFC. As a result,
4001 * you should always ensure that you write your Uri with these elements
4002 * using lower case letters, and normalize any Uris you receive from
4003 * outside of Android to ensure the scheme and host is lower case.</em></p>
4004 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004005 * @param action The Intent action, such as ACTION_VIEW.
4006 * @param uri The Intent data URI.
4007 */
4008 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004009 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004010 mData = uri;
4011 }
4012
4013 /**
4014 * Create an intent for a specific component. All other fields (action, data,
4015 * type, class) are null, though they can be modified later with explicit
4016 * calls. This provides a convenient way to create an intent that is
4017 * intended to execute a hard-coded class name, rather than relying on the
4018 * system to find an appropriate class for you; see {@link #setComponent}
4019 * for more information on the repercussions of this.
4020 *
4021 * @param packageContext A Context of the application package implementing
4022 * this class.
4023 * @param cls The component class that is to be used for the intent.
4024 *
4025 * @see #setClass
4026 * @see #setComponent
4027 * @see #Intent(String, android.net.Uri , Context, Class)
4028 */
4029 public Intent(Context packageContext, Class<?> cls) {
4030 mComponent = new ComponentName(packageContext, cls);
4031 }
4032
4033 /**
4034 * Create an intent for a specific component with a specified action and data.
Craig Mautner2dac0562014-05-06 09:06:44 -07004035 * This is equivalent to using {@link #Intent(String, android.net.Uri)} to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004036 * construct the Intent and then calling {@link #setClass} to set its
4037 * class.
4038 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004039 * <p><em>Note: scheme and host name matching in the Android framework is
4040 * case-sensitive, unlike the formal RFC. As a result,
4041 * you should always ensure that you write your Uri with these elements
4042 * using lower case letters, and normalize any Uris you receive from
4043 * outside of Android to ensure the scheme and host is lower case.</em></p>
4044 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004045 * @param action The Intent action, such as ACTION_VIEW.
4046 * @param uri The Intent data URI.
4047 * @param packageContext A Context of the application package implementing
4048 * this class.
4049 * @param cls The component class that is to be used for the intent.
4050 *
4051 * @see #Intent(String, android.net.Uri)
4052 * @see #Intent(Context, Class)
4053 * @see #setClass
4054 * @see #setComponent
4055 */
4056 public Intent(String action, Uri uri,
4057 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004058 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004059 mData = uri;
4060 mComponent = new ComponentName(packageContext, cls);
4061 }
4062
4063 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004064 * Create an intent to launch the main (root) activity of a task. This
4065 * is the Intent that is started when the application's is launched from
4066 * Home. For anything else that wants to launch an application in the
4067 * same way, it is important that they use an Intent structured the same
4068 * way, and can use this function to ensure this is the case.
4069 *
4070 * <p>The returned Intent has the given Activity component as its explicit
4071 * component, {@link #ACTION_MAIN} as its action, and includes the
4072 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4073 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4074 * to do that through {@link #addFlags(int)} on the returned Intent.
4075 *
4076 * @param mainActivity The main activity component that this Intent will
4077 * launch.
4078 * @return Returns a newly created Intent that can be used to launch the
4079 * activity as a main application entry.
4080 *
4081 * @see #setClass
4082 * @see #setComponent
4083 */
4084 public static Intent makeMainActivity(ComponentName mainActivity) {
4085 Intent intent = new Intent(ACTION_MAIN);
4086 intent.setComponent(mainActivity);
4087 intent.addCategory(CATEGORY_LAUNCHER);
4088 return intent;
4089 }
4090
4091 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004092 * Make an Intent for the main activity of an application, without
4093 * specifying a specific activity to run but giving a selector to find
4094 * the activity. This results in a final Intent that is structured
4095 * the same as when the application is launched from
4096 * Home. For anything else that wants to launch an application in the
4097 * same way, it is important that they use an Intent structured the same
4098 * way, and can use this function to ensure this is the case.
4099 *
4100 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
4101 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
4102 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
4103 * to do that through {@link #addFlags(int)} on the returned Intent.
4104 *
4105 * @param selectorAction The action name of the Intent's selector.
4106 * @param selectorCategory The name of a category to add to the Intent's
4107 * selector.
4108 * @return Returns a newly created Intent that can be used to launch the
4109 * activity as a main application entry.
4110 *
4111 * @see #setSelector(Intent)
4112 */
4113 public static Intent makeMainSelectorActivity(String selectorAction,
4114 String selectorCategory) {
4115 Intent intent = new Intent(ACTION_MAIN);
4116 intent.addCategory(CATEGORY_LAUNCHER);
4117 Intent selector = new Intent();
4118 selector.setAction(selectorAction);
4119 selector.addCategory(selectorCategory);
4120 intent.setSelector(selector);
4121 return intent;
4122 }
4123
4124 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08004125 * Make an Intent that can be used to re-launch an application's task
4126 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
4127 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
4128 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
4129 *
4130 * @param mainActivity The activity component that is the root of the
4131 * task; this is the activity that has been published in the application's
4132 * manifest as the main launcher icon.
4133 *
4134 * @return Returns a newly created Intent that can be used to relaunch the
4135 * activity's task in its root state.
4136 */
4137 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
4138 Intent intent = makeMainActivity(mainActivity);
4139 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
4140 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
4141 return intent;
4142 }
4143
4144 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004145 * Call {@link #parseUri} with 0 flags.
4146 * @deprecated Use {@link #parseUri} instead.
4147 */
4148 @Deprecated
4149 public static Intent getIntent(String uri) throws URISyntaxException {
4150 return parseUri(uri, 0);
4151 }
Tom Taylord4a47292009-12-21 13:59:18 -08004152
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004153 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004155 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07004156 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004157 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004158 *
4159 * <p>The URI given here must not be relative -- that is, it must include
4160 * the scheme and full path.
4161 *
4162 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004163 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004164 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004165 *
4166 * @return Intent The newly created Intent object.
4167 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004168 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
4169 * it bad (as parsed by the Uri class) or the Intent data within the
4170 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08004171 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004172 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004173 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004174 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004175 int i = 0;
4176 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004177 // Validate intent scheme for if requested.
4178 if ((flags&URI_INTENT_SCHEME) != 0) {
4179 if (!uri.startsWith("intent:")) {
4180 Intent intent = new Intent(ACTION_VIEW);
4181 try {
4182 intent.setData(Uri.parse(uri));
4183 } catch (IllegalArgumentException e) {
4184 throw new URISyntaxException(uri, e.getMessage());
4185 }
4186 return intent;
4187 }
4188 }
Tom Taylord4a47292009-12-21 13:59:18 -08004189
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004190 // simple case
4191 i = uri.lastIndexOf("#");
4192 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
4193
4194 // old format Intent URI
4195 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07004196
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004197 // new format
4198 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004199 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004200
4201 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004202 String data = i >= 0 ? uri.substring(0, i) : null;
4203 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004204 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07004205
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004206 // loop over contents of Intent, all name=value;
4207 while (!uri.startsWith("end", i)) {
4208 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004209 if (eq < 0) eq = i-1;
4210 int semi = uri.indexOf(';', i);
4211 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004212
4213 // action
4214 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004215 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004216 }
4217
4218 // categories
4219 else if (uri.startsWith("category=", i)) {
4220 intent.addCategory(value);
4221 }
4222
4223 // type
4224 else if (uri.startsWith("type=", i)) {
4225 intent.mType = value;
4226 }
4227
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004228 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004229 else if (uri.startsWith("launchFlags=", i)) {
4230 intent.mFlags = Integer.decode(value).intValue();
4231 }
4232
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004233 // package
4234 else if (uri.startsWith("package=", i)) {
4235 intent.mPackage = value;
4236 }
4237
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004238 // component
4239 else if (uri.startsWith("component=", i)) {
4240 intent.mComponent = ComponentName.unflattenFromString(value);
4241 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004242
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004243 // scheme
4244 else if (uri.startsWith("scheme=", i)) {
4245 scheme = value;
4246 }
4247
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004248 // source bounds
4249 else if (uri.startsWith("sourceBounds=", i)) {
4250 intent.mSourceBounds = Rect.unflattenFromString(value);
4251 }
4252
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004253 // selector
4254 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
4255 intent = new Intent();
4256 }
4257
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004258 // extra
4259 else {
4260 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004261 // create Bundle if it doesn't already exist
4262 if (intent.mExtras == null) intent.mExtras = new Bundle();
4263 Bundle b = intent.mExtras;
4264 // add EXTRA
4265 if (uri.startsWith("S.", i)) b.putString(key, value);
4266 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
4267 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
4268 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
4269 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
4270 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
4271 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
4272 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
4273 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
4274 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
4275 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004276
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004277 // move to the next item
4278 i = semi + 1;
4279 }
4280
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004281 if (intent != baseIntent) {
4282 // The Intent had a selector; fix it up.
4283 baseIntent.setSelector(intent);
4284 intent = baseIntent;
4285 }
4286
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004287 if (data != null) {
4288 if (data.startsWith("intent:")) {
4289 data = data.substring(7);
4290 if (scheme != null) {
4291 data = scheme + ':' + data;
4292 }
4293 }
Tom Taylord4a47292009-12-21 13:59:18 -08004294
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004295 if (data.length() > 0) {
4296 try {
4297 intent.mData = Uri.parse(data);
4298 } catch (IllegalArgumentException e) {
4299 throw new URISyntaxException(uri, e.getMessage());
4300 }
4301 }
4302 }
Tom Taylord4a47292009-12-21 13:59:18 -08004303
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004304 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004305
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004306 } catch (IndexOutOfBoundsException e) {
4307 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4308 }
4309 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004310
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004311 public static Intent getIntentOld(String uri) throws URISyntaxException {
4312 Intent intent;
4313
4314 int i = uri.lastIndexOf('#');
4315 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004316 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004317 final int intentFragmentStart = i;
4318 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004319
4320 i++;
4321
4322 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004323 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004324 i += 7;
4325 int j = uri.indexOf(')', i);
4326 action = uri.substring(i, j);
4327 i = j + 1;
4328 }
4329
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004330 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004331
4332 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004333 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004334 i += 11;
4335 int j = uri.indexOf(')', i);
4336 while (i < j) {
4337 int sep = uri.indexOf('!', i);
4338 if (sep < 0) sep = j;
4339 if (i < sep) {
4340 intent.addCategory(uri.substring(i, sep));
4341 }
4342 i = sep + 1;
4343 }
4344 i = j + 1;
4345 }
4346
4347 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004348 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004349 i += 5;
4350 int j = uri.indexOf(')', i);
4351 intent.mType = uri.substring(i, j);
4352 i = j + 1;
4353 }
4354
4355 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004356 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004357 i += 12;
4358 int j = uri.indexOf(')', i);
4359 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4360 i = j + 1;
4361 }
4362
4363 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004364 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004365 i += 10;
4366 int j = uri.indexOf(')', i);
4367 int sep = uri.indexOf('!', i);
4368 if (sep >= 0 && sep < j) {
4369 String pkg = uri.substring(i, sep);
4370 String cls = uri.substring(sep + 1, j);
4371 intent.mComponent = new ComponentName(pkg, cls);
4372 }
4373 i = j + 1;
4374 }
4375
4376 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004377 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004378 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004379
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004380 final int closeParen = uri.indexOf(')', i);
4381 if (closeParen == -1) throw new URISyntaxException(uri,
4382 "EXTRA missing trailing ')'", i);
4383
4384 while (i < closeParen) {
4385 // fetch the key value
4386 int j = uri.indexOf('=', i);
4387 if (j <= i + 1 || i >= closeParen) {
4388 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4389 }
4390 char type = uri.charAt(i);
4391 i++;
4392 String key = uri.substring(i, j);
4393 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004394
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004395 // get type-value
4396 j = uri.indexOf('!', i);
4397 if (j == -1 || j >= closeParen) j = closeParen;
4398 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4399 String value = uri.substring(i, j);
4400 i = j;
4401
4402 // create Bundle if it doesn't already exist
4403 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004404
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004405 // add item to bundle
4406 try {
4407 switch (type) {
4408 case 'S':
4409 intent.mExtras.putString(key, Uri.decode(value));
4410 break;
4411 case 'B':
4412 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4413 break;
4414 case 'b':
4415 intent.mExtras.putByte(key, Byte.parseByte(value));
4416 break;
4417 case 'c':
4418 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4419 break;
4420 case 'd':
4421 intent.mExtras.putDouble(key, Double.parseDouble(value));
4422 break;
4423 case 'f':
4424 intent.mExtras.putFloat(key, Float.parseFloat(value));
4425 break;
4426 case 'i':
4427 intent.mExtras.putInt(key, Integer.parseInt(value));
4428 break;
4429 case 'l':
4430 intent.mExtras.putLong(key, Long.parseLong(value));
4431 break;
4432 case 's':
4433 intent.mExtras.putShort(key, Short.parseShort(value));
4434 break;
4435 default:
4436 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4437 }
4438 } catch (NumberFormatException e) {
4439 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4440 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004441
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004442 char ch = uri.charAt(i);
4443 if (ch == ')') break;
4444 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4445 i++;
4446 }
4447 }
4448
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004449 if (isIntentFragment) {
4450 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4451 } else {
4452 intent.mData = Uri.parse(uri);
4453 }
Tom Taylord4a47292009-12-21 13:59:18 -08004454
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004455 if (intent.mAction == null) {
4456 // By default, if no action is specified, then use VIEW.
4457 intent.mAction = ACTION_VIEW;
4458 }
4459
4460 } else {
4461 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4462 }
4463
4464 return intent;
4465 }
4466
4467 /**
4468 * Retrieve the general action to be performed, such as
4469 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4470 * the information in the intent should be interpreted -- most importantly,
4471 * what to do with the data returned by {@link #getData}.
4472 *
4473 * @return The action of this intent or null if none is specified.
4474 *
4475 * @see #setAction
4476 */
4477 public String getAction() {
4478 return mAction;
4479 }
4480
4481 /**
4482 * Retrieve data this intent is operating on. This URI specifies the name
4483 * of the data; often it uses the content: scheme, specifying data in a
4484 * content provider. Other schemes may be handled by specific activities,
4485 * such as http: by the web browser.
4486 *
4487 * @return The URI of the data this intent is targeting or null.
4488 *
4489 * @see #getScheme
4490 * @see #setData
4491 */
4492 public Uri getData() {
4493 return mData;
4494 }
4495
4496 /**
4497 * The same as {@link #getData()}, but returns the URI as an encoded
4498 * String.
4499 */
4500 public String getDataString() {
4501 return mData != null ? mData.toString() : null;
4502 }
4503
4504 /**
4505 * Return the scheme portion of the intent's data. If the data is null or
4506 * does not include a scheme, null is returned. Otherwise, the scheme
4507 * prefix without the final ':' is returned, i.e. "http".
4508 *
4509 * <p>This is the same as calling getData().getScheme() (and checking for
4510 * null data).
4511 *
4512 * @return The scheme of this intent.
4513 *
4514 * @see #getData
4515 */
4516 public String getScheme() {
4517 return mData != null ? mData.getScheme() : null;
4518 }
4519
4520 /**
4521 * Retrieve any explicit MIME type included in the intent. This is usually
4522 * null, as the type is determined by the intent data.
4523 *
4524 * @return If a type was manually set, it is returned; else null is
4525 * returned.
4526 *
4527 * @see #resolveType(ContentResolver)
4528 * @see #setType
4529 */
4530 public String getType() {
4531 return mType;
4532 }
4533
4534 /**
4535 * Return the MIME data type of this intent. If the type field is
4536 * explicitly set, that is simply returned. Otherwise, if the data is set,
4537 * the type of that data is returned. If neither fields are set, a null is
4538 * returned.
4539 *
4540 * @return The MIME type of this intent.
4541 *
4542 * @see #getType
4543 * @see #resolveType(ContentResolver)
4544 */
4545 public String resolveType(Context context) {
4546 return resolveType(context.getContentResolver());
4547 }
4548
4549 /**
4550 * Return the MIME data type of this intent. If the type field is
4551 * explicitly set, that is simply returned. Otherwise, if the data is set,
4552 * the type of that data is returned. If neither fields are set, a null is
4553 * returned.
4554 *
4555 * @param resolver A ContentResolver that can be used to determine the MIME
4556 * type of the intent's data.
4557 *
4558 * @return The MIME type of this intent.
4559 *
4560 * @see #getType
4561 * @see #resolveType(Context)
4562 */
4563 public String resolveType(ContentResolver resolver) {
4564 if (mType != null) {
4565 return mType;
4566 }
4567 if (mData != null) {
4568 if ("content".equals(mData.getScheme())) {
4569 return resolver.getType(mData);
4570 }
4571 }
4572 return null;
4573 }
4574
4575 /**
4576 * Return the MIME data type of this intent, only if it will be needed for
4577 * intent resolution. This is not generally useful for application code;
4578 * it is used by the frameworks for communicating with back-end system
4579 * services.
4580 *
4581 * @param resolver A ContentResolver that can be used to determine the MIME
4582 * type of the intent's data.
4583 *
4584 * @return The MIME type of this intent, or null if it is unknown or not
4585 * needed.
4586 */
4587 public String resolveTypeIfNeeded(ContentResolver resolver) {
4588 if (mComponent != null) {
4589 return mType;
4590 }
4591 return resolveType(resolver);
4592 }
4593
4594 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004595 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004596 *
4597 * @param category The category to check.
4598 *
4599 * @return boolean True if the intent contains the category, else false.
4600 *
4601 * @see #getCategories
4602 * @see #addCategory
4603 */
4604 public boolean hasCategory(String category) {
4605 return mCategories != null && mCategories.contains(category);
4606 }
4607
4608 /**
4609 * Return the set of all categories in the intent. If there are no categories,
4610 * returns NULL.
4611 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004612 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004613 *
4614 * @see #hasCategory
4615 * @see #addCategory
4616 */
4617 public Set<String> getCategories() {
4618 return mCategories;
4619 }
4620
4621 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004622 * Return the specific selector associated with this Intent. If there is
4623 * none, returns null. See {@link #setSelector} for more information.
4624 *
4625 * @see #setSelector
4626 */
4627 public Intent getSelector() {
4628 return mSelector;
4629 }
4630
4631 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004632 * Return the {@link ClipData} associated with this Intent. If there is
4633 * none, returns null. See {@link #setClipData} for more information.
4634 *
John Spurlock125d1332013-11-25 11:58:37 -05004635 * @see #setClipData
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004636 */
4637 public ClipData getClipData() {
4638 return mClipData;
4639 }
4640
4641 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004642 * Sets the ClassLoader that will be used when unmarshalling
4643 * any Parcelable values from the extras of this Intent.
4644 *
4645 * @param loader a ClassLoader, or null to use the default loader
4646 * at the time of unmarshalling.
4647 */
4648 public void setExtrasClassLoader(ClassLoader loader) {
4649 if (mExtras != null) {
4650 mExtras.setClassLoader(loader);
4651 }
4652 }
4653
4654 /**
4655 * Returns true if an extra value is associated with the given name.
4656 * @param name the extra's name
4657 * @return true if the given extra is present.
4658 */
4659 public boolean hasExtra(String name) {
4660 return mExtras != null && mExtras.containsKey(name);
4661 }
4662
4663 /**
4664 * Returns true if the Intent's extras contain a parcelled file descriptor.
4665 * @return true if the Intent contains a parcelled file descriptor.
4666 */
4667 public boolean hasFileDescriptors() {
4668 return mExtras != null && mExtras.hasFileDescriptors();
4669 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004670
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004671 /** @hide */
4672 public void setAllowFds(boolean allowFds) {
4673 if (mExtras != null) {
4674 mExtras.setAllowFds(allowFds);
4675 }
4676 }
4677
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004678 /**
4679 * Retrieve extended data from the intent.
4680 *
4681 * @param name The name of the desired item.
4682 *
4683 * @return the value of an item that previously added with putExtra()
4684 * or null if none was found.
4685 *
4686 * @deprecated
4687 * @hide
4688 */
4689 @Deprecated
4690 public Object getExtra(String name) {
4691 return getExtra(name, null);
4692 }
4693
4694 /**
4695 * Retrieve extended data from the intent.
4696 *
4697 * @param name The name of the desired item.
4698 * @param defaultValue the value to be returned if no value of the desired
4699 * type is stored with the given name.
4700 *
4701 * @return the value of an item that previously added with putExtra()
4702 * or the default value if none was found.
4703 *
4704 * @see #putExtra(String, boolean)
4705 */
4706 public boolean getBooleanExtra(String name, boolean defaultValue) {
4707 return mExtras == null ? defaultValue :
4708 mExtras.getBoolean(name, defaultValue);
4709 }
4710
4711 /**
4712 * Retrieve extended data from the intent.
4713 *
4714 * @param name The name of the desired item.
4715 * @param defaultValue the value to be returned if no value of the desired
4716 * type is stored with the given name.
4717 *
4718 * @return the value of an item that previously added with putExtra()
4719 * or the default value if none was found.
4720 *
4721 * @see #putExtra(String, byte)
4722 */
4723 public byte getByteExtra(String name, byte defaultValue) {
4724 return mExtras == null ? defaultValue :
4725 mExtras.getByte(name, defaultValue);
4726 }
4727
4728 /**
4729 * Retrieve extended data from the intent.
4730 *
4731 * @param name The name of the desired item.
4732 * @param defaultValue the value to be returned if no value of the desired
4733 * type is stored with the given name.
4734 *
4735 * @return the value of an item that previously added with putExtra()
4736 * or the default value if none was found.
4737 *
4738 * @see #putExtra(String, short)
4739 */
4740 public short getShortExtra(String name, short defaultValue) {
4741 return mExtras == null ? defaultValue :
4742 mExtras.getShort(name, defaultValue);
4743 }
4744
4745 /**
4746 * Retrieve extended data from the intent.
4747 *
4748 * @param name The name of the desired item.
4749 * @param defaultValue the value to be returned if no value of the desired
4750 * type is stored with the given name.
4751 *
4752 * @return the value of an item that previously added with putExtra()
4753 * or the default value if none was found.
4754 *
4755 * @see #putExtra(String, char)
4756 */
4757 public char getCharExtra(String name, char defaultValue) {
4758 return mExtras == null ? defaultValue :
4759 mExtras.getChar(name, defaultValue);
4760 }
4761
4762 /**
4763 * Retrieve extended data from the intent.
4764 *
4765 * @param name The name of the desired item.
4766 * @param defaultValue the value to be returned if no value of the desired
4767 * type is stored with the given name.
4768 *
4769 * @return the value of an item that previously added with putExtra()
4770 * or the default value if none was found.
4771 *
4772 * @see #putExtra(String, int)
4773 */
4774 public int getIntExtra(String name, int defaultValue) {
4775 return mExtras == null ? defaultValue :
4776 mExtras.getInt(name, defaultValue);
4777 }
4778
4779 /**
4780 * Retrieve extended data from the intent.
4781 *
4782 * @param name The name of the desired item.
4783 * @param defaultValue the value to be returned if no value of the desired
4784 * type is stored with the given name.
4785 *
4786 * @return the value of an item that previously added with putExtra()
4787 * or the default value if none was found.
4788 *
4789 * @see #putExtra(String, long)
4790 */
4791 public long getLongExtra(String name, long defaultValue) {
4792 return mExtras == null ? defaultValue :
4793 mExtras.getLong(name, defaultValue);
4794 }
4795
4796 /**
4797 * Retrieve extended data from the intent.
4798 *
4799 * @param name The name of the desired item.
4800 * @param defaultValue the value to be returned if no value of the desired
4801 * type is stored with the given name.
4802 *
4803 * @return the value of an item that previously added with putExtra(),
4804 * or the default value if no such item is present
4805 *
4806 * @see #putExtra(String, float)
4807 */
4808 public float getFloatExtra(String name, float defaultValue) {
4809 return mExtras == null ? defaultValue :
4810 mExtras.getFloat(name, defaultValue);
4811 }
4812
4813 /**
4814 * Retrieve extended data from the intent.
4815 *
4816 * @param name The name of the desired item.
4817 * @param defaultValue the value to be returned if no value of the desired
4818 * type is stored with the given name.
4819 *
4820 * @return the value of an item that previously added with putExtra()
4821 * or the default value if none was found.
4822 *
4823 * @see #putExtra(String, double)
4824 */
4825 public double getDoubleExtra(String name, double defaultValue) {
4826 return mExtras == null ? defaultValue :
4827 mExtras.getDouble(name, defaultValue);
4828 }
4829
4830 /**
4831 * Retrieve extended data from the intent.
4832 *
4833 * @param name The name of the desired item.
4834 *
4835 * @return the value of an item that previously added with putExtra()
4836 * or null if no String value was found.
4837 *
4838 * @see #putExtra(String, String)
4839 */
4840 public String getStringExtra(String name) {
4841 return mExtras == null ? null : mExtras.getString(name);
4842 }
4843
4844 /**
4845 * Retrieve extended data from the intent.
4846 *
4847 * @param name The name of the desired item.
4848 *
4849 * @return the value of an item that previously added with putExtra()
4850 * or null if no CharSequence value was found.
4851 *
4852 * @see #putExtra(String, CharSequence)
4853 */
4854 public CharSequence getCharSequenceExtra(String name) {
4855 return mExtras == null ? null : mExtras.getCharSequence(name);
4856 }
4857
4858 /**
4859 * Retrieve extended data from the intent.
4860 *
4861 * @param name The name of the desired item.
4862 *
4863 * @return the value of an item that previously added with putExtra()
4864 * or null if no Parcelable value was found.
4865 *
4866 * @see #putExtra(String, Parcelable)
4867 */
4868 public <T extends Parcelable> T getParcelableExtra(String name) {
4869 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4870 }
4871
4872 /**
4873 * Retrieve extended data from the intent.
4874 *
4875 * @param name The name of the desired item.
4876 *
4877 * @return the value of an item that previously added with putExtra()
4878 * or null if no Parcelable[] value was found.
4879 *
4880 * @see #putExtra(String, Parcelable[])
4881 */
4882 public Parcelable[] getParcelableArrayExtra(String name) {
4883 return mExtras == null ? null : mExtras.getParcelableArray(name);
4884 }
4885
4886 /**
4887 * Retrieve extended data from the intent.
4888 *
4889 * @param name The name of the desired item.
4890 *
4891 * @return the value of an item that previously added with putExtra()
4892 * or null if no ArrayList<Parcelable> value was found.
4893 *
4894 * @see #putParcelableArrayListExtra(String, ArrayList)
4895 */
4896 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4897 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4898 }
4899
4900 /**
4901 * Retrieve extended data from the intent.
4902 *
4903 * @param name The name of the desired item.
4904 *
4905 * @return the value of an item that previously added with putExtra()
4906 * or null if no Serializable value was found.
4907 *
4908 * @see #putExtra(String, Serializable)
4909 */
4910 public Serializable getSerializableExtra(String name) {
4911 return mExtras == null ? null : mExtras.getSerializable(name);
4912 }
4913
4914 /**
4915 * Retrieve extended data from the intent.
4916 *
4917 * @param name The name of the desired item.
4918 *
4919 * @return the value of an item that previously added with putExtra()
4920 * or null if no ArrayList<Integer> value was found.
4921 *
4922 * @see #putIntegerArrayListExtra(String, ArrayList)
4923 */
4924 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4925 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4926 }
4927
4928 /**
4929 * Retrieve extended data from the intent.
4930 *
4931 * @param name The name of the desired item.
4932 *
4933 * @return the value of an item that previously added with putExtra()
4934 * or null if no ArrayList<String> value was found.
4935 *
4936 * @see #putStringArrayListExtra(String, ArrayList)
4937 */
4938 public ArrayList<String> getStringArrayListExtra(String name) {
4939 return mExtras == null ? null : mExtras.getStringArrayList(name);
4940 }
4941
4942 /**
4943 * Retrieve extended data from the intent.
4944 *
4945 * @param name The name of the desired item.
4946 *
4947 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004948 * or null if no ArrayList<CharSequence> value was found.
4949 *
4950 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4951 */
4952 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4953 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4954 }
4955
4956 /**
4957 * Retrieve extended data from the intent.
4958 *
4959 * @param name The name of the desired item.
4960 *
4961 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004962 * or null if no boolean array value was found.
4963 *
4964 * @see #putExtra(String, boolean[])
4965 */
4966 public boolean[] getBooleanArrayExtra(String name) {
4967 return mExtras == null ? null : mExtras.getBooleanArray(name);
4968 }
4969
4970 /**
4971 * Retrieve extended data from the intent.
4972 *
4973 * @param name The name of the desired item.
4974 *
4975 * @return the value of an item that previously added with putExtra()
4976 * or null if no byte array value was found.
4977 *
4978 * @see #putExtra(String, byte[])
4979 */
4980 public byte[] getByteArrayExtra(String name) {
4981 return mExtras == null ? null : mExtras.getByteArray(name);
4982 }
4983
4984 /**
4985 * Retrieve extended data from the intent.
4986 *
4987 * @param name The name of the desired item.
4988 *
4989 * @return the value of an item that previously added with putExtra()
4990 * or null if no short array value was found.
4991 *
4992 * @see #putExtra(String, short[])
4993 */
4994 public short[] getShortArrayExtra(String name) {
4995 return mExtras == null ? null : mExtras.getShortArray(name);
4996 }
4997
4998 /**
4999 * Retrieve extended data from the intent.
5000 *
5001 * @param name The name of the desired item.
5002 *
5003 * @return the value of an item that previously added with putExtra()
5004 * or null if no char array value was found.
5005 *
5006 * @see #putExtra(String, char[])
5007 */
5008 public char[] getCharArrayExtra(String name) {
5009 return mExtras == null ? null : mExtras.getCharArray(name);
5010 }
5011
5012 /**
5013 * Retrieve extended data from the intent.
5014 *
5015 * @param name The name of the desired item.
5016 *
5017 * @return the value of an item that previously added with putExtra()
5018 * or null if no int array value was found.
5019 *
5020 * @see #putExtra(String, int[])
5021 */
5022 public int[] getIntArrayExtra(String name) {
5023 return mExtras == null ? null : mExtras.getIntArray(name);
5024 }
5025
5026 /**
5027 * Retrieve extended data from the intent.
5028 *
5029 * @param name The name of the desired item.
5030 *
5031 * @return the value of an item that previously added with putExtra()
5032 * or null if no long array value was found.
5033 *
5034 * @see #putExtra(String, long[])
5035 */
5036 public long[] getLongArrayExtra(String name) {
5037 return mExtras == null ? null : mExtras.getLongArray(name);
5038 }
5039
5040 /**
5041 * Retrieve extended data from the intent.
5042 *
5043 * @param name The name of the desired item.
5044 *
5045 * @return the value of an item that previously added with putExtra()
5046 * or null if no float array value was found.
5047 *
5048 * @see #putExtra(String, float[])
5049 */
5050 public float[] getFloatArrayExtra(String name) {
5051 return mExtras == null ? null : mExtras.getFloatArray(name);
5052 }
5053
5054 /**
5055 * Retrieve extended data from the intent.
5056 *
5057 * @param name The name of the desired item.
5058 *
5059 * @return the value of an item that previously added with putExtra()
5060 * or null if no double array value was found.
5061 *
5062 * @see #putExtra(String, double[])
5063 */
5064 public double[] getDoubleArrayExtra(String name) {
5065 return mExtras == null ? null : mExtras.getDoubleArray(name);
5066 }
5067
5068 /**
5069 * Retrieve extended data from the intent.
5070 *
5071 * @param name The name of the desired item.
5072 *
5073 * @return the value of an item that previously added with putExtra()
5074 * or null if no String array value was found.
5075 *
5076 * @see #putExtra(String, String[])
5077 */
5078 public String[] getStringArrayExtra(String name) {
5079 return mExtras == null ? null : mExtras.getStringArray(name);
5080 }
5081
5082 /**
5083 * Retrieve extended data from the intent.
5084 *
5085 * @param name The name of the desired item.
5086 *
5087 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005088 * or null if no CharSequence array value was found.
5089 *
5090 * @see #putExtra(String, CharSequence[])
5091 */
5092 public CharSequence[] getCharSequenceArrayExtra(String name) {
5093 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
5094 }
5095
5096 /**
5097 * Retrieve extended data from the intent.
5098 *
5099 * @param name The name of the desired item.
5100 *
5101 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005102 * or null if no Bundle value was found.
5103 *
5104 * @see #putExtra(String, Bundle)
5105 */
5106 public Bundle getBundleExtra(String name) {
5107 return mExtras == null ? null : mExtras.getBundle(name);
5108 }
5109
5110 /**
5111 * Retrieve extended data from the intent.
5112 *
5113 * @param name The name of the desired item.
5114 *
5115 * @return the value of an item that previously added with putExtra()
5116 * or null if no IBinder value was found.
5117 *
5118 * @see #putExtra(String, IBinder)
5119 *
5120 * @deprecated
5121 * @hide
5122 */
5123 @Deprecated
5124 public IBinder getIBinderExtra(String name) {
5125 return mExtras == null ? null : mExtras.getIBinder(name);
5126 }
5127
5128 /**
5129 * Retrieve extended data from the intent.
5130 *
5131 * @param name The name of the desired item.
5132 * @param defaultValue The default value to return in case no item is
5133 * associated with the key 'name'
5134 *
5135 * @return the value of an item that previously added with putExtra()
5136 * or defaultValue if none was found.
5137 *
5138 * @see #putExtra
5139 *
5140 * @deprecated
5141 * @hide
5142 */
5143 @Deprecated
5144 public Object getExtra(String name, Object defaultValue) {
5145 Object result = defaultValue;
5146 if (mExtras != null) {
5147 Object result2 = mExtras.get(name);
5148 if (result2 != null) {
5149 result = result2;
5150 }
5151 }
5152
5153 return result;
5154 }
5155
5156 /**
5157 * Retrieves a map of extended data from the intent.
5158 *
5159 * @return the map of all extras previously added with putExtra(),
5160 * or null if none have been added.
5161 */
5162 public Bundle getExtras() {
5163 return (mExtras != null)
5164 ? new Bundle(mExtras)
5165 : null;
5166 }
5167
5168 /**
5169 * Retrieve any special flags associated with this intent. You will
5170 * normally just set them with {@link #setFlags} and let the system
5171 * take the appropriate action with them.
5172 *
5173 * @return int The currently set flags.
5174 *
5175 * @see #setFlags
5176 */
5177 public int getFlags() {
5178 return mFlags;
5179 }
5180
Dianne Hackborne7f97212011-02-24 14:40:20 -08005181 /** @hide */
5182 public boolean isExcludingStopped() {
5183 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
5184 == FLAG_EXCLUDE_STOPPED_PACKAGES;
5185 }
5186
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005187 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005188 * Retrieve the application package name this Intent is limited to. When
5189 * resolving an Intent, if non-null this limits the resolution to only
5190 * components in the given application package.
5191 *
5192 * @return The name of the application package for the Intent.
5193 *
5194 * @see #resolveActivity
5195 * @see #setPackage
5196 */
5197 public String getPackage() {
5198 return mPackage;
5199 }
5200
5201 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005202 * Retrieve the concrete component associated with the intent. When receiving
5203 * an intent, this is the component that was found to best handle it (that is,
5204 * yourself) and will always be non-null; in all other cases it will be
5205 * null unless explicitly set.
5206 *
5207 * @return The name of the application component to handle the intent.
5208 *
5209 * @see #resolveActivity
5210 * @see #setComponent
5211 */
5212 public ComponentName getComponent() {
5213 return mComponent;
5214 }
5215
5216 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005217 * Get the bounds of the sender of this intent, in screen coordinates. This can be
5218 * used as a hint to the receiver for animations and the like. Null means that there
5219 * is no source bounds.
5220 */
5221 public Rect getSourceBounds() {
5222 return mSourceBounds;
5223 }
5224
5225 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005226 * Return the Activity component that should be used to handle this intent.
5227 * The appropriate component is determined based on the information in the
5228 * intent, evaluated as follows:
5229 *
5230 * <p>If {@link #getComponent} returns an explicit class, that is returned
5231 * without any further consideration.
5232 *
5233 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
5234 * category to be considered.
5235 *
5236 * <p>If {@link #getAction} is non-NULL, the activity must handle this
5237 * action.
5238 *
5239 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
5240 * this type.
5241 *
5242 * <p>If {@link #addCategory} has added any categories, the activity must
5243 * handle ALL of the categories specified.
5244 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005245 * <p>If {@link #getPackage} is non-NULL, only activity components in
5246 * that application package will be considered.
5247 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005248 * <p>If there are no activities that satisfy all of these conditions, a
5249 * null string is returned.
5250 *
5251 * <p>If multiple activities are found to satisfy the intent, the one with
5252 * the highest priority will be used. If there are multiple activities
5253 * with the same priority, the system will either pick the best activity
5254 * based on user preference, or resolve to a system class that will allow
5255 * the user to pick an activity and forward from there.
5256 *
5257 * <p>This method is implemented simply by calling
5258 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
5259 * true.</p>
5260 * <p> This API is called for you as part of starting an activity from an
5261 * intent. You do not normally need to call it yourself.</p>
5262 *
5263 * @param pm The package manager with which to resolve the Intent.
5264 *
5265 * @return Name of the component implementing an activity that can
5266 * display the intent.
5267 *
5268 * @see #setComponent
5269 * @see #getComponent
5270 * @see #resolveActivityInfo
5271 */
5272 public ComponentName resolveActivity(PackageManager pm) {
5273 if (mComponent != null) {
5274 return mComponent;
5275 }
5276
5277 ResolveInfo info = pm.resolveActivity(
5278 this, PackageManager.MATCH_DEFAULT_ONLY);
5279 if (info != null) {
5280 return new ComponentName(
5281 info.activityInfo.applicationInfo.packageName,
5282 info.activityInfo.name);
5283 }
5284
5285 return null;
5286 }
5287
5288 /**
5289 * Resolve the Intent into an {@link ActivityInfo}
5290 * describing the activity that should execute the intent. Resolution
5291 * follows the same rules as described for {@link #resolveActivity}, but
5292 * you get back the completely information about the resolved activity
5293 * instead of just its class name.
5294 *
5295 * @param pm The package manager with which to resolve the Intent.
5296 * @param flags Addition information to retrieve as per
5297 * {@link PackageManager#getActivityInfo(ComponentName, int)
5298 * PackageManager.getActivityInfo()}.
5299 *
5300 * @return PackageManager.ActivityInfo
5301 *
5302 * @see #resolveActivity
5303 */
5304 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5305 ActivityInfo ai = null;
5306 if (mComponent != null) {
5307 try {
5308 ai = pm.getActivityInfo(mComponent, flags);
5309 } catch (PackageManager.NameNotFoundException e) {
5310 // ignore
5311 }
5312 } else {
5313 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005314 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005315 if (info != null) {
5316 ai = info.activityInfo;
5317 }
5318 }
5319
5320 return ai;
5321 }
5322
5323 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005324 * Special function for use by the system to resolve service
5325 * intents to system apps. Throws an exception if there are
5326 * multiple potential matches to the Intent. Returns null if
5327 * there are no matches.
5328 * @hide
5329 */
5330 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5331 if (mComponent != null) {
5332 return mComponent;
5333 }
5334
5335 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5336 if (results == null) {
5337 return null;
5338 }
5339 ComponentName comp = null;
5340 for (int i=0; i<results.size(); i++) {
5341 ResolveInfo ri = results.get(i);
5342 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5343 continue;
5344 }
5345 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5346 ri.serviceInfo.name);
5347 if (comp != null) {
5348 throw new IllegalStateException("Multiple system services handle " + this
5349 + ": " + comp + ", " + foundComp);
5350 }
5351 comp = foundComp;
5352 }
5353 return comp;
5354 }
5355
5356 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005357 * Set the general action to be performed.
5358 *
5359 * @param action An action name, such as ACTION_VIEW. Application-specific
5360 * actions should be prefixed with the vendor's package name.
5361 *
5362 * @return Returns the same Intent object, for chaining multiple calls
5363 * into a single statement.
5364 *
5365 * @see #getAction
5366 */
5367 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005368 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005369 return this;
5370 }
5371
5372 /**
5373 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005374 * clears any type that was previously set by {@link #setType} or
5375 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005376 *
Nick Pellyccae4122012-01-09 14:12:58 -08005377 * <p><em>Note: scheme matching in the Android framework is
5378 * case-sensitive, unlike the formal RFC. As a result,
5379 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005380 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005381 * {@link #setDataAndNormalize}
5382 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005383 *
Nick Pellyccae4122012-01-09 14:12:58 -08005384 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005385 *
5386 * @return Returns the same Intent object, for chaining multiple calls
5387 * into a single statement.
5388 *
5389 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005390 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005391 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005392 */
5393 public Intent setData(Uri data) {
5394 mData = data;
5395 mType = null;
5396 return this;
5397 }
5398
5399 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005400 * Normalize and set the data this intent is operating on.
5401 *
5402 * <p>This method automatically clears any type that was
5403 * previously set (for example, by {@link #setType}).
5404 *
5405 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005406 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005407 * so really this is just a convenience method for
5408 * <pre>
5409 * setData(data.normalize())
5410 * </pre>
5411 *
5412 * @param data The Uri of the data this intent is now targeting.
5413 *
5414 * @return Returns the same Intent object, for chaining multiple calls
5415 * into a single statement.
5416 *
5417 * @see #getData
5418 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005419 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005420 */
5421 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005422 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005423 }
5424
5425 /**
5426 * Set an explicit MIME data type.
5427 *
5428 * <p>This is used to create intents that only specify a type and not data,
5429 * for example to indicate the type of data to return.
5430 *
5431 * <p>This method automatically clears any data that was
5432 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005433 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005434 * <p><em>Note: MIME type matching in the Android framework is
5435 * case-sensitive, unlike formal RFC MIME types. As a result,
5436 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005437 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5438 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005439 *
5440 * @param type The MIME type of the data being handled by this intent.
5441 *
5442 * @return Returns the same Intent object, for chaining multiple calls
5443 * into a single statement.
5444 *
5445 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005446 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005447 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005448 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005449 */
5450 public Intent setType(String type) {
5451 mData = null;
5452 mType = type;
5453 return this;
5454 }
5455
5456 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005457 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005458 *
Nick Pellyccae4122012-01-09 14:12:58 -08005459 * <p>This is used to create intents that only specify a type and not data,
5460 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005461 *
Nick Pellyccae4122012-01-09 14:12:58 -08005462 * <p>This method automatically clears any data that was
5463 * previously set (for example by {@link #setData}).
5464 *
5465 * <p>The MIME type is normalized using
5466 * {@link #normalizeMimeType} before it is set,
5467 * so really this is just a convenience method for
5468 * <pre>
5469 * setType(Intent.normalizeMimeType(type))
5470 * </pre>
5471 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005472 * @param type The MIME type of the data being handled by this intent.
5473 *
5474 * @return Returns the same Intent object, for chaining multiple calls
5475 * into a single statement.
5476 *
Nick Pellyccae4122012-01-09 14:12:58 -08005477 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005478 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005479 * @see #normalizeMimeType
5480 */
5481 public Intent setTypeAndNormalize(String type) {
5482 return setType(normalizeMimeType(type));
5483 }
5484
5485 /**
5486 * (Usually optional) Set the data for the intent along with an explicit
5487 * MIME data type. This method should very rarely be used -- it allows you
5488 * to override the MIME type that would ordinarily be inferred from the
5489 * data with your own type given here.
5490 *
5491 * <p><em>Note: MIME type and Uri scheme matching in the
5492 * Android framework is case-sensitive, unlike the formal RFC definitions.
5493 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005494 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005495 * {@link #setDataAndTypeAndNormalize}
5496 * to ensure that they are converted to lower case.</em>
5497 *
5498 * @param data The Uri of the data this intent is now targeting.
5499 * @param type The MIME type of the data being handled by this intent.
5500 *
5501 * @return Returns the same Intent object, for chaining multiple calls
5502 * into a single statement.
5503 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005504 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005505 * @see #setData
5506 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005507 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005508 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005509 */
5510 public Intent setDataAndType(Uri data, String type) {
5511 mData = data;
5512 mType = type;
5513 return this;
5514 }
5515
5516 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005517 * (Usually optional) Normalize and set both the data Uri and an explicit
5518 * MIME data type. This method should very rarely be used -- it allows you
5519 * to override the MIME type that would ordinarily be inferred from the
5520 * data with your own type given here.
5521 *
5522 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005523 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005524 * before they are set, so really this is just a convenience method for
5525 * <pre>
5526 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5527 * </pre>
5528 *
5529 * @param data The Uri of the data this intent is now targeting.
5530 * @param type The MIME type of the data being handled by this intent.
5531 *
5532 * @return Returns the same Intent object, for chaining multiple calls
5533 * into a single statement.
5534 *
5535 * @see #setType
5536 * @see #setData
5537 * @see #setDataAndType
5538 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005539 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005540 */
5541 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005542 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005543 }
5544
5545 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005546 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005547 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005548 * activities that provide <em>all</em> of the requested categories will be
5549 * used.
5550 *
5551 * @param category The desired category. This can be either one of the
5552 * predefined Intent categories, or a custom category in your own
5553 * namespace.
5554 *
5555 * @return Returns the same Intent object, for chaining multiple calls
5556 * into a single statement.
5557 *
5558 * @see #hasCategory
5559 * @see #removeCategory
5560 */
5561 public Intent addCategory(String category) {
5562 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005563 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005564 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005565 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005566 return this;
5567 }
5568
5569 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005570 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005571 *
5572 * @param category The category to remove.
5573 *
5574 * @see #addCategory
5575 */
5576 public void removeCategory(String category) {
5577 if (mCategories != null) {
5578 mCategories.remove(category);
5579 if (mCategories.size() == 0) {
5580 mCategories = null;
5581 }
5582 }
5583 }
5584
5585 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005586 * Set a selector for this Intent. This is a modification to the kinds of
5587 * things the Intent will match. If the selector is set, it will be used
5588 * when trying to find entities that can handle the Intent, instead of the
5589 * main contents of the Intent. This allows you build an Intent containing
5590 * a generic protocol while targeting it more specifically.
5591 *
5592 * <p>An example of where this may be used is with things like
5593 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5594 * Intent that will launch the Browser application. However, the correct
5595 * main entry point of an application is actually {@link #ACTION_MAIN}
5596 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5597 * used to specify the actual Activity to launch. If you launch the browser
5598 * with something different, undesired behavior may happen if the user has
5599 * previously or later launches it the normal way, since they do not match.
5600 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5601 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5602 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5603 *
5604 * <p>Setting a selector does not impact the behavior of
5605 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5606 * desired behavior of a selector -- it does not impact the base meaning
5607 * of the Intent, just what kinds of things will be matched against it
5608 * when determining who can handle it.</p>
5609 *
5610 * <p>You can not use both a selector and {@link #setPackage(String)} on
5611 * the same base Intent.</p>
5612 *
5613 * @param selector The desired selector Intent; set to null to not use
5614 * a special selector.
5615 */
5616 public void setSelector(Intent selector) {
5617 if (selector == this) {
5618 throw new IllegalArgumentException(
5619 "Intent being set as a selector of itself");
5620 }
5621 if (selector != null && mPackage != null) {
5622 throw new IllegalArgumentException(
5623 "Can't set selector when package name is already set");
5624 }
5625 mSelector = selector;
5626 }
5627
5628 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005629 * Set a {@link ClipData} associated with this Intent. This replaces any
5630 * previously set ClipData.
5631 *
5632 * <p>The ClipData in an intent is not used for Intent matching or other
5633 * such operations. Semantically it is like extras, used to transmit
5634 * additional data with the Intent. The main feature of using this over
5635 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5636 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5637 * items included in the clip data. This is useful, in particular, if
5638 * you want to transmit an Intent containing multiple <code>content:</code>
5639 * URIs for which the recipient may not have global permission to access the
5640 * content provider.
5641 *
5642 * <p>If the ClipData contains items that are themselves Intents, any
5643 * grant flags in those Intents will be ignored. Only the top-level flags
5644 * of the main Intent are respected, and will be applied to all Uri or
5645 * Intent items in the clip (or sub-items of the clip).
5646 *
5647 * <p>The MIME type, label, and icon in the ClipData object are not
5648 * directly used by Intent. Applications should generally rely on the
5649 * MIME type of the Intent itself, not what it may find in the ClipData.
5650 * A common practice is to construct a ClipData for use with an Intent
John Spurlock33900182014-01-02 11:04:18 -05005651 * with a MIME type of "*&#47;*".
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005652 *
5653 * @param clip The new clip to set. May be null to clear the current clip.
5654 */
5655 public void setClipData(ClipData clip) {
5656 mClipData = clip;
5657 }
5658
5659 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005660 * Add extended data to the intent. The name must include a package
5661 * prefix, for example the app com.android.contacts would use names
5662 * like "com.android.contacts.ShowAll".
5663 *
5664 * @param name The name of the extra data, with package prefix.
5665 * @param value The boolean data value.
5666 *
5667 * @return Returns the same Intent object, for chaining multiple calls
5668 * into a single statement.
5669 *
5670 * @see #putExtras
5671 * @see #removeExtra
5672 * @see #getBooleanExtra(String, boolean)
5673 */
5674 public Intent putExtra(String name, boolean value) {
5675 if (mExtras == null) {
5676 mExtras = new Bundle();
5677 }
5678 mExtras.putBoolean(name, value);
5679 return this;
5680 }
5681
5682 /**
5683 * Add extended data to the intent. The name must include a package
5684 * prefix, for example the app com.android.contacts would use names
5685 * like "com.android.contacts.ShowAll".
5686 *
5687 * @param name The name of the extra data, with package prefix.
5688 * @param value The byte data value.
5689 *
5690 * @return Returns the same Intent object, for chaining multiple calls
5691 * into a single statement.
5692 *
5693 * @see #putExtras
5694 * @see #removeExtra
5695 * @see #getByteExtra(String, byte)
5696 */
5697 public Intent putExtra(String name, byte value) {
5698 if (mExtras == null) {
5699 mExtras = new Bundle();
5700 }
5701 mExtras.putByte(name, value);
5702 return this;
5703 }
5704
5705 /**
5706 * Add extended data to the intent. The name must include a package
5707 * prefix, for example the app com.android.contacts would use names
5708 * like "com.android.contacts.ShowAll".
5709 *
5710 * @param name The name of the extra data, with package prefix.
5711 * @param value The char data value.
5712 *
5713 * @return Returns the same Intent object, for chaining multiple calls
5714 * into a single statement.
5715 *
5716 * @see #putExtras
5717 * @see #removeExtra
5718 * @see #getCharExtra(String, char)
5719 */
5720 public Intent putExtra(String name, char value) {
5721 if (mExtras == null) {
5722 mExtras = new Bundle();
5723 }
5724 mExtras.putChar(name, value);
5725 return this;
5726 }
5727
5728 /**
5729 * Add extended data to the intent. The name must include a package
5730 * prefix, for example the app com.android.contacts would use names
5731 * like "com.android.contacts.ShowAll".
5732 *
5733 * @param name The name of the extra data, with package prefix.
5734 * @param value The short data value.
5735 *
5736 * @return Returns the same Intent object, for chaining multiple calls
5737 * into a single statement.
5738 *
5739 * @see #putExtras
5740 * @see #removeExtra
5741 * @see #getShortExtra(String, short)
5742 */
5743 public Intent putExtra(String name, short value) {
5744 if (mExtras == null) {
5745 mExtras = new Bundle();
5746 }
5747 mExtras.putShort(name, value);
5748 return this;
5749 }
5750
5751 /**
5752 * Add extended data to the intent. The name must include a package
5753 * prefix, for example the app com.android.contacts would use names
5754 * like "com.android.contacts.ShowAll".
5755 *
5756 * @param name The name of the extra data, with package prefix.
5757 * @param value The integer data value.
5758 *
5759 * @return Returns the same Intent object, for chaining multiple calls
5760 * into a single statement.
5761 *
5762 * @see #putExtras
5763 * @see #removeExtra
5764 * @see #getIntExtra(String, int)
5765 */
5766 public Intent putExtra(String name, int value) {
5767 if (mExtras == null) {
5768 mExtras = new Bundle();
5769 }
5770 mExtras.putInt(name, value);
5771 return this;
5772 }
5773
5774 /**
5775 * Add extended data to the intent. The name must include a package
5776 * prefix, for example the app com.android.contacts would use names
5777 * like "com.android.contacts.ShowAll".
5778 *
5779 * @param name The name of the extra data, with package prefix.
5780 * @param value The long data value.
5781 *
5782 * @return Returns the same Intent object, for chaining multiple calls
5783 * into a single statement.
5784 *
5785 * @see #putExtras
5786 * @see #removeExtra
5787 * @see #getLongExtra(String, long)
5788 */
5789 public Intent putExtra(String name, long value) {
5790 if (mExtras == null) {
5791 mExtras = new Bundle();
5792 }
5793 mExtras.putLong(name, value);
5794 return this;
5795 }
5796
5797 /**
5798 * Add extended data to the intent. The name must include a package
5799 * prefix, for example the app com.android.contacts would use names
5800 * like "com.android.contacts.ShowAll".
5801 *
5802 * @param name The name of the extra data, with package prefix.
5803 * @param value The float data value.
5804 *
5805 * @return Returns the same Intent object, for chaining multiple calls
5806 * into a single statement.
5807 *
5808 * @see #putExtras
5809 * @see #removeExtra
5810 * @see #getFloatExtra(String, float)
5811 */
5812 public Intent putExtra(String name, float value) {
5813 if (mExtras == null) {
5814 mExtras = new Bundle();
5815 }
5816 mExtras.putFloat(name, value);
5817 return this;
5818 }
5819
5820 /**
5821 * Add extended data to the intent. The name must include a package
5822 * prefix, for example the app com.android.contacts would use names
5823 * like "com.android.contacts.ShowAll".
5824 *
5825 * @param name The name of the extra data, with package prefix.
5826 * @param value The double data value.
5827 *
5828 * @return Returns the same Intent object, for chaining multiple calls
5829 * into a single statement.
5830 *
5831 * @see #putExtras
5832 * @see #removeExtra
5833 * @see #getDoubleExtra(String, double)
5834 */
5835 public Intent putExtra(String name, double value) {
5836 if (mExtras == null) {
5837 mExtras = new Bundle();
5838 }
5839 mExtras.putDouble(name, value);
5840 return this;
5841 }
5842
5843 /**
5844 * Add extended data to the intent. The name must include a package
5845 * prefix, for example the app com.android.contacts would use names
5846 * like "com.android.contacts.ShowAll".
5847 *
5848 * @param name The name of the extra data, with package prefix.
5849 * @param value The String data value.
5850 *
5851 * @return Returns the same Intent object, for chaining multiple calls
5852 * into a single statement.
5853 *
5854 * @see #putExtras
5855 * @see #removeExtra
5856 * @see #getStringExtra(String)
5857 */
5858 public Intent putExtra(String name, String value) {
5859 if (mExtras == null) {
5860 mExtras = new Bundle();
5861 }
5862 mExtras.putString(name, value);
5863 return this;
5864 }
5865
5866 /**
5867 * Add extended data to the intent. The name must include a package
5868 * prefix, for example the app com.android.contacts would use names
5869 * like "com.android.contacts.ShowAll".
5870 *
5871 * @param name The name of the extra data, with package prefix.
5872 * @param value The CharSequence data value.
5873 *
5874 * @return Returns the same Intent object, for chaining multiple calls
5875 * into a single statement.
5876 *
5877 * @see #putExtras
5878 * @see #removeExtra
5879 * @see #getCharSequenceExtra(String)
5880 */
5881 public Intent putExtra(String name, CharSequence value) {
5882 if (mExtras == null) {
5883 mExtras = new Bundle();
5884 }
5885 mExtras.putCharSequence(name, value);
5886 return this;
5887 }
5888
5889 /**
5890 * Add extended data to the intent. The name must include a package
5891 * prefix, for example the app com.android.contacts would use names
5892 * like "com.android.contacts.ShowAll".
5893 *
5894 * @param name The name of the extra data, with package prefix.
5895 * @param value The Parcelable data value.
5896 *
5897 * @return Returns the same Intent object, for chaining multiple calls
5898 * into a single statement.
5899 *
5900 * @see #putExtras
5901 * @see #removeExtra
5902 * @see #getParcelableExtra(String)
5903 */
5904 public Intent putExtra(String name, Parcelable value) {
5905 if (mExtras == null) {
5906 mExtras = new Bundle();
5907 }
5908 mExtras.putParcelable(name, value);
5909 return this;
5910 }
5911
5912 /**
5913 * Add extended data to the intent. The name must include a package
5914 * prefix, for example the app com.android.contacts would use names
5915 * like "com.android.contacts.ShowAll".
5916 *
5917 * @param name The name of the extra data, with package prefix.
5918 * @param value The Parcelable[] data value.
5919 *
5920 * @return Returns the same Intent object, for chaining multiple calls
5921 * into a single statement.
5922 *
5923 * @see #putExtras
5924 * @see #removeExtra
5925 * @see #getParcelableArrayExtra(String)
5926 */
5927 public Intent putExtra(String name, Parcelable[] value) {
5928 if (mExtras == null) {
5929 mExtras = new Bundle();
5930 }
5931 mExtras.putParcelableArray(name, value);
5932 return this;
5933 }
5934
5935 /**
5936 * Add extended data to the intent. The name must include a package
5937 * prefix, for example the app com.android.contacts would use names
5938 * like "com.android.contacts.ShowAll".
5939 *
5940 * @param name The name of the extra data, with package prefix.
5941 * @param value The ArrayList<Parcelable> data value.
5942 *
5943 * @return Returns the same Intent object, for chaining multiple calls
5944 * into a single statement.
5945 *
5946 * @see #putExtras
5947 * @see #removeExtra
5948 * @see #getParcelableArrayListExtra(String)
5949 */
5950 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5951 if (mExtras == null) {
5952 mExtras = new Bundle();
5953 }
5954 mExtras.putParcelableArrayList(name, value);
5955 return this;
5956 }
5957
5958 /**
5959 * Add extended data to the intent. The name must include a package
5960 * prefix, for example the app com.android.contacts would use names
5961 * like "com.android.contacts.ShowAll".
5962 *
5963 * @param name The name of the extra data, with package prefix.
5964 * @param value The ArrayList<Integer> data value.
5965 *
5966 * @return Returns the same Intent object, for chaining multiple calls
5967 * into a single statement.
5968 *
5969 * @see #putExtras
5970 * @see #removeExtra
5971 * @see #getIntegerArrayListExtra(String)
5972 */
5973 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5974 if (mExtras == null) {
5975 mExtras = new Bundle();
5976 }
5977 mExtras.putIntegerArrayList(name, value);
5978 return this;
5979 }
5980
5981 /**
5982 * Add extended data to the intent. The name must include a package
5983 * prefix, for example the app com.android.contacts would use names
5984 * like "com.android.contacts.ShowAll".
5985 *
5986 * @param name The name of the extra data, with package prefix.
5987 * @param value The ArrayList<String> data value.
5988 *
5989 * @return Returns the same Intent object, for chaining multiple calls
5990 * into a single statement.
5991 *
5992 * @see #putExtras
5993 * @see #removeExtra
5994 * @see #getStringArrayListExtra(String)
5995 */
5996 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5997 if (mExtras == null) {
5998 mExtras = new Bundle();
5999 }
6000 mExtras.putStringArrayList(name, value);
6001 return this;
6002 }
6003
6004 /**
6005 * Add extended data to the intent. The name must include a package
6006 * prefix, for example the app com.android.contacts would use names
6007 * like "com.android.contacts.ShowAll".
6008 *
6009 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006010 * @param value The ArrayList<CharSequence> data value.
6011 *
6012 * @return Returns the same Intent object, for chaining multiple calls
6013 * into a single statement.
6014 *
6015 * @see #putExtras
6016 * @see #removeExtra
6017 * @see #getCharSequenceArrayListExtra(String)
6018 */
6019 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
6020 if (mExtras == null) {
6021 mExtras = new Bundle();
6022 }
6023 mExtras.putCharSequenceArrayList(name, value);
6024 return this;
6025 }
6026
6027 /**
6028 * Add extended data to the intent. The name must include a package
6029 * prefix, for example the app com.android.contacts would use names
6030 * like "com.android.contacts.ShowAll".
6031 *
6032 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006033 * @param value The Serializable data value.
6034 *
6035 * @return Returns the same Intent object, for chaining multiple calls
6036 * into a single statement.
6037 *
6038 * @see #putExtras
6039 * @see #removeExtra
6040 * @see #getSerializableExtra(String)
6041 */
6042 public Intent putExtra(String name, Serializable value) {
6043 if (mExtras == null) {
6044 mExtras = new Bundle();
6045 }
6046 mExtras.putSerializable(name, value);
6047 return this;
6048 }
6049
6050 /**
6051 * Add extended data to the intent. The name must include a package
6052 * prefix, for example the app com.android.contacts would use names
6053 * like "com.android.contacts.ShowAll".
6054 *
6055 * @param name The name of the extra data, with package prefix.
6056 * @param value The boolean array data value.
6057 *
6058 * @return Returns the same Intent object, for chaining multiple calls
6059 * into a single statement.
6060 *
6061 * @see #putExtras
6062 * @see #removeExtra
6063 * @see #getBooleanArrayExtra(String)
6064 */
6065 public Intent putExtra(String name, boolean[] value) {
6066 if (mExtras == null) {
6067 mExtras = new Bundle();
6068 }
6069 mExtras.putBooleanArray(name, value);
6070 return this;
6071 }
6072
6073 /**
6074 * Add extended data to the intent. The name must include a package
6075 * prefix, for example the app com.android.contacts would use names
6076 * like "com.android.contacts.ShowAll".
6077 *
6078 * @param name The name of the extra data, with package prefix.
6079 * @param value The byte array data value.
6080 *
6081 * @return Returns the same Intent object, for chaining multiple calls
6082 * into a single statement.
6083 *
6084 * @see #putExtras
6085 * @see #removeExtra
6086 * @see #getByteArrayExtra(String)
6087 */
6088 public Intent putExtra(String name, byte[] value) {
6089 if (mExtras == null) {
6090 mExtras = new Bundle();
6091 }
6092 mExtras.putByteArray(name, value);
6093 return this;
6094 }
6095
6096 /**
6097 * Add extended data to the intent. The name must include a package
6098 * prefix, for example the app com.android.contacts would use names
6099 * like "com.android.contacts.ShowAll".
6100 *
6101 * @param name The name of the extra data, with package prefix.
6102 * @param value The short array data value.
6103 *
6104 * @return Returns the same Intent object, for chaining multiple calls
6105 * into a single statement.
6106 *
6107 * @see #putExtras
6108 * @see #removeExtra
6109 * @see #getShortArrayExtra(String)
6110 */
6111 public Intent putExtra(String name, short[] value) {
6112 if (mExtras == null) {
6113 mExtras = new Bundle();
6114 }
6115 mExtras.putShortArray(name, value);
6116 return this;
6117 }
6118
6119 /**
6120 * Add extended data to the intent. The name must include a package
6121 * prefix, for example the app com.android.contacts would use names
6122 * like "com.android.contacts.ShowAll".
6123 *
6124 * @param name The name of the extra data, with package prefix.
6125 * @param value The char array data value.
6126 *
6127 * @return Returns the same Intent object, for chaining multiple calls
6128 * into a single statement.
6129 *
6130 * @see #putExtras
6131 * @see #removeExtra
6132 * @see #getCharArrayExtra(String)
6133 */
6134 public Intent putExtra(String name, char[] value) {
6135 if (mExtras == null) {
6136 mExtras = new Bundle();
6137 }
6138 mExtras.putCharArray(name, value);
6139 return this;
6140 }
6141
6142 /**
6143 * Add extended data to the intent. The name must include a package
6144 * prefix, for example the app com.android.contacts would use names
6145 * like "com.android.contacts.ShowAll".
6146 *
6147 * @param name The name of the extra data, with package prefix.
6148 * @param value The int array data value.
6149 *
6150 * @return Returns the same Intent object, for chaining multiple calls
6151 * into a single statement.
6152 *
6153 * @see #putExtras
6154 * @see #removeExtra
6155 * @see #getIntArrayExtra(String)
6156 */
6157 public Intent putExtra(String name, int[] value) {
6158 if (mExtras == null) {
6159 mExtras = new Bundle();
6160 }
6161 mExtras.putIntArray(name, value);
6162 return this;
6163 }
6164
6165 /**
6166 * Add extended data to the intent. The name must include a package
6167 * prefix, for example the app com.android.contacts would use names
6168 * like "com.android.contacts.ShowAll".
6169 *
6170 * @param name The name of the extra data, with package prefix.
6171 * @param value The byte array data value.
6172 *
6173 * @return Returns the same Intent object, for chaining multiple calls
6174 * into a single statement.
6175 *
6176 * @see #putExtras
6177 * @see #removeExtra
6178 * @see #getLongArrayExtra(String)
6179 */
6180 public Intent putExtra(String name, long[] value) {
6181 if (mExtras == null) {
6182 mExtras = new Bundle();
6183 }
6184 mExtras.putLongArray(name, value);
6185 return this;
6186 }
6187
6188 /**
6189 * Add extended data to the intent. The name must include a package
6190 * prefix, for example the app com.android.contacts would use names
6191 * like "com.android.contacts.ShowAll".
6192 *
6193 * @param name The name of the extra data, with package prefix.
6194 * @param value The float array data value.
6195 *
6196 * @return Returns the same Intent object, for chaining multiple calls
6197 * into a single statement.
6198 *
6199 * @see #putExtras
6200 * @see #removeExtra
6201 * @see #getFloatArrayExtra(String)
6202 */
6203 public Intent putExtra(String name, float[] value) {
6204 if (mExtras == null) {
6205 mExtras = new Bundle();
6206 }
6207 mExtras.putFloatArray(name, value);
6208 return this;
6209 }
6210
6211 /**
6212 * Add extended data to the intent. The name must include a package
6213 * prefix, for example the app com.android.contacts would use names
6214 * like "com.android.contacts.ShowAll".
6215 *
6216 * @param name The name of the extra data, with package prefix.
6217 * @param value The double array data value.
6218 *
6219 * @return Returns the same Intent object, for chaining multiple calls
6220 * into a single statement.
6221 *
6222 * @see #putExtras
6223 * @see #removeExtra
6224 * @see #getDoubleArrayExtra(String)
6225 */
6226 public Intent putExtra(String name, double[] value) {
6227 if (mExtras == null) {
6228 mExtras = new Bundle();
6229 }
6230 mExtras.putDoubleArray(name, value);
6231 return this;
6232 }
6233
6234 /**
6235 * Add extended data to the intent. The name must include a package
6236 * prefix, for example the app com.android.contacts would use names
6237 * like "com.android.contacts.ShowAll".
6238 *
6239 * @param name The name of the extra data, with package prefix.
6240 * @param value The String array data value.
6241 *
6242 * @return Returns the same Intent object, for chaining multiple calls
6243 * into a single statement.
6244 *
6245 * @see #putExtras
6246 * @see #removeExtra
6247 * @see #getStringArrayExtra(String)
6248 */
6249 public Intent putExtra(String name, String[] value) {
6250 if (mExtras == null) {
6251 mExtras = new Bundle();
6252 }
6253 mExtras.putStringArray(name, value);
6254 return this;
6255 }
6256
6257 /**
6258 * Add extended data to the intent. The name must include a package
6259 * prefix, for example the app com.android.contacts would use names
6260 * like "com.android.contacts.ShowAll".
6261 *
6262 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00006263 * @param value The CharSequence array data value.
6264 *
6265 * @return Returns the same Intent object, for chaining multiple calls
6266 * into a single statement.
6267 *
6268 * @see #putExtras
6269 * @see #removeExtra
6270 * @see #getCharSequenceArrayExtra(String)
6271 */
6272 public Intent putExtra(String name, CharSequence[] value) {
6273 if (mExtras == null) {
6274 mExtras = new Bundle();
6275 }
6276 mExtras.putCharSequenceArray(name, value);
6277 return this;
6278 }
6279
6280 /**
6281 * Add extended data to the intent. The name must include a package
6282 * prefix, for example the app com.android.contacts would use names
6283 * like "com.android.contacts.ShowAll".
6284 *
6285 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006286 * @param value The Bundle data value.
6287 *
6288 * @return Returns the same Intent object, for chaining multiple calls
6289 * into a single statement.
6290 *
6291 * @see #putExtras
6292 * @see #removeExtra
6293 * @see #getBundleExtra(String)
6294 */
6295 public Intent putExtra(String name, Bundle value) {
6296 if (mExtras == null) {
6297 mExtras = new Bundle();
6298 }
6299 mExtras.putBundle(name, value);
6300 return this;
6301 }
6302
6303 /**
6304 * Add extended data to the intent. The name must include a package
6305 * prefix, for example the app com.android.contacts would use names
6306 * like "com.android.contacts.ShowAll".
6307 *
6308 * @param name The name of the extra data, with package prefix.
6309 * @param value The IBinder data value.
6310 *
6311 * @return Returns the same Intent object, for chaining multiple calls
6312 * into a single statement.
6313 *
6314 * @see #putExtras
6315 * @see #removeExtra
6316 * @see #getIBinderExtra(String)
6317 *
6318 * @deprecated
6319 * @hide
6320 */
6321 @Deprecated
6322 public Intent putExtra(String name, IBinder value) {
6323 if (mExtras == null) {
6324 mExtras = new Bundle();
6325 }
6326 mExtras.putIBinder(name, value);
6327 return this;
6328 }
6329
6330 /**
6331 * Copy all extras in 'src' in to this intent.
6332 *
6333 * @param src Contains the extras to copy.
6334 *
6335 * @see #putExtra
6336 */
6337 public Intent putExtras(Intent src) {
6338 if (src.mExtras != null) {
6339 if (mExtras == null) {
6340 mExtras = new Bundle(src.mExtras);
6341 } else {
6342 mExtras.putAll(src.mExtras);
6343 }
6344 }
6345 return this;
6346 }
6347
6348 /**
6349 * Add a set of extended data to the intent. The keys must include a package
6350 * prefix, for example the app com.android.contacts would use names
6351 * like "com.android.contacts.ShowAll".
6352 *
6353 * @param extras The Bundle of extras to add to this intent.
6354 *
6355 * @see #putExtra
6356 * @see #removeExtra
6357 */
6358 public Intent putExtras(Bundle extras) {
6359 if (mExtras == null) {
6360 mExtras = new Bundle();
6361 }
6362 mExtras.putAll(extras);
6363 return this;
6364 }
6365
6366 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006367 * Completely replace the extras in the Intent with the extras in the
6368 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006369 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006370 * @param src The exact extras contained in this Intent are copied
6371 * into the target intent, replacing any that were previously there.
6372 */
6373 public Intent replaceExtras(Intent src) {
6374 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6375 return this;
6376 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006377
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006378 /**
6379 * Completely replace the extras in the Intent with the given Bundle of
6380 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006381 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006382 * @param extras The new set of extras in the Intent, or null to erase
6383 * all extras.
6384 */
6385 public Intent replaceExtras(Bundle extras) {
6386 mExtras = extras != null ? new Bundle(extras) : null;
6387 return this;
6388 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006389
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006390 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006391 * Remove extended data from the intent.
6392 *
6393 * @see #putExtra
6394 */
6395 public void removeExtra(String name) {
6396 if (mExtras != null) {
6397 mExtras.remove(name);
6398 if (mExtras.size() == 0) {
6399 mExtras = null;
6400 }
6401 }
6402 }
6403
6404 /**
6405 * Set special flags controlling how this intent is handled. Most values
6406 * here depend on the type of component being executed by the Intent,
6407 * specifically the FLAG_ACTIVITY_* flags are all for use with
6408 * {@link Context#startActivity Context.startActivity()} and the
6409 * FLAG_RECEIVER_* flags are all for use with
6410 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6411 *
Scott Main7aee61f2011-02-08 11:25:01 -08006412 * <p>See the
6413 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6414 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006415 * the behavior of your application.
6416 *
6417 * @param flags The desired flags.
6418 *
6419 * @return Returns the same Intent object, for chaining multiple calls
6420 * into a single statement.
6421 *
6422 * @see #getFlags
6423 * @see #addFlags
6424 *
6425 * @see #FLAG_GRANT_READ_URI_PERMISSION
6426 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
Jeff Sharkey846318a2014-04-04 12:12:41 -07006427 * @see #FLAG_GRANT_PERSISTABLE_URI_PERMISSION
6428 * @see #FLAG_GRANT_PREFIX_URI_PERMISSION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006429 * @see #FLAG_DEBUG_LOG_RESOLUTION
6430 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006431 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006432 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006433 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006434 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006435 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6436 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006437 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006438 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
Craig Mautnerd00f4742014-03-12 14:17:26 -07006439 * @see #FLAG_ACTIVITY_NEW_DOCUMENT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006440 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006441 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006442 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006443 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006444 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6445 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006446 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006447 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006448 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006449 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6450 */
6451 public Intent setFlags(int flags) {
6452 mFlags = flags;
6453 return this;
6454 }
6455
6456 /**
6457 * Add additional flags to the intent (or with existing flags
6458 * value).
6459 *
6460 * @param flags The new flags to set.
6461 *
6462 * @return Returns the same Intent object, for chaining multiple calls
6463 * into a single statement.
6464 *
6465 * @see #setFlags
6466 */
6467 public Intent addFlags(int flags) {
6468 mFlags |= flags;
6469 return this;
6470 }
6471
6472 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006473 * (Usually optional) Set an explicit application package name that limits
6474 * the components this Intent will resolve to. If left to the default
6475 * value of null, all components in all applications will considered.
6476 * If non-null, the Intent can only match the components in the given
6477 * application package.
6478 *
6479 * @param packageName The name of the application package to handle the
6480 * intent, or null to allow any application package.
6481 *
6482 * @return Returns the same Intent object, for chaining multiple calls
6483 * into a single statement.
6484 *
6485 * @see #getPackage
6486 * @see #resolveActivity
6487 */
6488 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006489 if (packageName != null && mSelector != null) {
6490 throw new IllegalArgumentException(
6491 "Can't set package name when selector is already set");
6492 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006493 mPackage = packageName;
6494 return this;
6495 }
6496
6497 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006498 * (Usually optional) Explicitly set the component to handle the intent.
6499 * If left with the default value of null, the system will determine the
6500 * appropriate class to use based on the other fields (action, data,
6501 * type, categories) in the Intent. If this class is defined, the
6502 * specified class will always be used regardless of the other fields. You
6503 * should only set this value when you know you absolutely want a specific
6504 * class to be used; otherwise it is better to let the system find the
6505 * appropriate class so that you will respect the installed applications
6506 * and user preferences.
6507 *
6508 * @param component The name of the application component to handle the
6509 * intent, or null to let the system find one for you.
6510 *
6511 * @return Returns the same Intent object, for chaining multiple calls
6512 * into a single statement.
6513 *
6514 * @see #setClass
6515 * @see #setClassName(Context, String)
6516 * @see #setClassName(String, String)
6517 * @see #getComponent
6518 * @see #resolveActivity
6519 */
6520 public Intent setComponent(ComponentName component) {
6521 mComponent = component;
6522 return this;
6523 }
6524
6525 /**
6526 * Convenience for calling {@link #setComponent} with an
6527 * explicit class name.
6528 *
6529 * @param packageContext A Context of the application package implementing
6530 * this class.
6531 * @param className The name of a class inside of the application package
6532 * that will be used as the component for this Intent.
6533 *
6534 * @return Returns the same Intent object, for chaining multiple calls
6535 * into a single statement.
6536 *
6537 * @see #setComponent
6538 * @see #setClass
6539 */
6540 public Intent setClassName(Context packageContext, String className) {
6541 mComponent = new ComponentName(packageContext, className);
6542 return this;
6543 }
6544
6545 /**
6546 * Convenience for calling {@link #setComponent} with an
6547 * explicit application package name and class name.
6548 *
6549 * @param packageName The name of the package implementing the desired
6550 * component.
6551 * @param className The name of a class inside of the application package
6552 * that will be used as the component for this Intent.
6553 *
6554 * @return Returns the same Intent object, for chaining multiple calls
6555 * into a single statement.
6556 *
6557 * @see #setComponent
6558 * @see #setClass
6559 */
6560 public Intent setClassName(String packageName, String className) {
6561 mComponent = new ComponentName(packageName, className);
6562 return this;
6563 }
6564
6565 /**
6566 * Convenience for calling {@link #setComponent(ComponentName)} with the
6567 * name returned by a {@link Class} object.
6568 *
6569 * @param packageContext A Context of the application package implementing
6570 * this class.
6571 * @param cls The class name to set, equivalent to
6572 * <code>setClassName(context, cls.getName())</code>.
6573 *
6574 * @return Returns the same Intent object, for chaining multiple calls
6575 * into a single statement.
6576 *
6577 * @see #setComponent
6578 */
6579 public Intent setClass(Context packageContext, Class<?> cls) {
6580 mComponent = new ComponentName(packageContext, cls);
6581 return this;
6582 }
6583
6584 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006585 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6586 * used as a hint to the receiver for animations and the like. Null means that there
6587 * is no source bounds.
6588 */
6589 public void setSourceBounds(Rect r) {
6590 if (r != null) {
6591 mSourceBounds = new Rect(r);
6592 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006593 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006594 }
6595 }
6596
Tor Norbyed9273d62013-05-30 15:59:53 -07006597 /** @hide */
6598 @IntDef(flag = true,
6599 value = {
6600 FILL_IN_ACTION,
6601 FILL_IN_DATA,
6602 FILL_IN_CATEGORIES,
6603 FILL_IN_COMPONENT,
6604 FILL_IN_PACKAGE,
6605 FILL_IN_SOURCE_BOUNDS,
6606 FILL_IN_SELECTOR,
6607 FILL_IN_CLIP_DATA
6608 })
6609 @Retention(RetentionPolicy.SOURCE)
6610 public @interface FillInFlags {}
6611
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006612 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006613 * Use with {@link #fillIn} to allow the current action value to be
6614 * overwritten, even if it is already set.
6615 */
6616 public static final int FILL_IN_ACTION = 1<<0;
6617
6618 /**
6619 * Use with {@link #fillIn} to allow the current data or type value
6620 * overwritten, even if it is already set.
6621 */
6622 public static final int FILL_IN_DATA = 1<<1;
6623
6624 /**
6625 * Use with {@link #fillIn} to allow the current categories to be
6626 * overwritten, even if they are already set.
6627 */
6628 public static final int FILL_IN_CATEGORIES = 1<<2;
6629
6630 /**
6631 * Use with {@link #fillIn} to allow the current component value to be
6632 * overwritten, even if it is already set.
6633 */
6634 public static final int FILL_IN_COMPONENT = 1<<3;
6635
6636 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006637 * Use with {@link #fillIn} to allow the current package value to be
6638 * overwritten, even if it is already set.
6639 */
6640 public static final int FILL_IN_PACKAGE = 1<<4;
6641
6642 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006643 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006644 * overwritten, even if it is already set.
6645 */
6646 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6647
6648 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006649 * Use with {@link #fillIn} to allow the current selector to be
6650 * overwritten, even if it is already set.
6651 */
6652 public static final int FILL_IN_SELECTOR = 1<<6;
6653
6654 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006655 * Use with {@link #fillIn} to allow the current ClipData to be
6656 * overwritten, even if it is already set.
6657 */
6658 public static final int FILL_IN_CLIP_DATA = 1<<7;
6659
6660 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006661 * Copy the contents of <var>other</var> in to this object, but only
6662 * where fields are not defined by this object. For purposes of a field
6663 * being defined, the following pieces of data in the Intent are
6664 * considered to be separate fields:
6665 *
6666 * <ul>
6667 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006668 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006669 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6670 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006671 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006672 * <li> component, as set by {@link #setComponent(ComponentName)} or
6673 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006674 * <li> source bounds, as set by {@link #setSourceBounds}.
6675 * <li> selector, as set by {@link #setSelector(Intent)}.
6676 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006677 * <li> each top-level name in the associated extras.
6678 * </ul>
6679 *
6680 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006681 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006682 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6683 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6684 * the restriction where the corresponding field will not be replaced if
6685 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006686 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006687 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6688 * is explicitly specified. The selector will only be copied if
6689 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006690 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006691 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6692 * and Intent B with {action="gotit", data-type="some/thing",
6693 * categories="one","two"}.
6694 *
6695 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6696 * containing: {action="gotit", data-type="some/thing",
6697 * categories="bar"}.
6698 *
6699 * @param other Another Intent whose values are to be used to fill in
6700 * the current one.
6701 * @param flags Options to control which fields can be filled in.
6702 *
6703 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006704 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Tor Norbyed9273d62013-05-30 15:59:53 -07006705 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6706 * {@link #FILL_IN_SELECTOR} and {@link #FILL_IN_CLIP_DATA indicating which fields were
6707 * changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006708 */
Tor Norbyed9273d62013-05-30 15:59:53 -07006709 @FillInFlags
6710 public int fillIn(Intent other, @FillInFlags int flags) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006711 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006712 if (other.mAction != null
6713 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006714 mAction = other.mAction;
6715 changes |= FILL_IN_ACTION;
6716 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006717 if ((other.mData != null || other.mType != null)
6718 && ((mData == null && mType == null)
6719 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006720 mData = other.mData;
6721 mType = other.mType;
6722 changes |= FILL_IN_DATA;
6723 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006724 if (other.mCategories != null
6725 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006726 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006727 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006728 }
6729 changes |= FILL_IN_CATEGORIES;
6730 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006731 if (other.mPackage != null
6732 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006733 // Only do this if mSelector is not set.
6734 if (mSelector == null) {
6735 mPackage = other.mPackage;
6736 changes |= FILL_IN_PACKAGE;
6737 }
6738 }
6739 // Selector is special: it can only be set if explicitly allowed,
6740 // for the same reason as the component name.
6741 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6742 if (mPackage == null) {
6743 mSelector = new Intent(other.mSelector);
6744 mPackage = null;
6745 changes |= FILL_IN_SELECTOR;
6746 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006747 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006748 if (other.mClipData != null
6749 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6750 mClipData = other.mClipData;
6751 changes |= FILL_IN_CLIP_DATA;
6752 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006753 // Component is special: it can -only- be set if explicitly allowed,
6754 // since otherwise the sender could force the intent somewhere the
6755 // originator didn't intend.
6756 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006757 mComponent = other.mComponent;
6758 changes |= FILL_IN_COMPONENT;
6759 }
6760 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006761 if (other.mSourceBounds != null
6762 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6763 mSourceBounds = new Rect(other.mSourceBounds);
6764 changes |= FILL_IN_SOURCE_BOUNDS;
6765 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006766 if (mExtras == null) {
6767 if (other.mExtras != null) {
6768 mExtras = new Bundle(other.mExtras);
6769 }
6770 } else if (other.mExtras != null) {
6771 try {
6772 Bundle newb = new Bundle(other.mExtras);
6773 newb.putAll(mExtras);
6774 mExtras = newb;
6775 } catch (RuntimeException e) {
6776 // Modifying the extras can cause us to unparcel the contents
6777 // of the bundle, and if we do this in the system process that
6778 // may fail. We really should handle this (i.e., the Bundle
6779 // impl shouldn't be on top of a plain map), but for now just
6780 // ignore it and keep the original contents. :(
6781 Log.w("Intent", "Failure filling in extras", e);
6782 }
6783 }
6784 return changes;
6785 }
6786
6787 /**
6788 * Wrapper class holding an Intent and implementing comparisons on it for
6789 * the purpose of filtering. The class implements its
6790 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6791 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6792 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6793 * on the wrapped Intent.
6794 */
6795 public static final class FilterComparison {
6796 private final Intent mIntent;
6797 private final int mHashCode;
6798
6799 public FilterComparison(Intent intent) {
6800 mIntent = intent;
6801 mHashCode = intent.filterHashCode();
6802 }
6803
6804 /**
6805 * Return the Intent that this FilterComparison represents.
6806 * @return Returns the Intent held by the FilterComparison. Do
6807 * not modify!
6808 */
6809 public Intent getIntent() {
6810 return mIntent;
6811 }
6812
6813 @Override
6814 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006815 if (obj instanceof FilterComparison) {
6816 Intent other = ((FilterComparison)obj).mIntent;
6817 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006818 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006819 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006820 }
6821
6822 @Override
6823 public int hashCode() {
6824 return mHashCode;
6825 }
6826 }
6827
6828 /**
6829 * Determine if two intents are the same for the purposes of intent
6830 * resolution (filtering). That is, if their action, data, type,
6831 * class, and categories are the same. This does <em>not</em> compare
6832 * any extra data included in the intents.
6833 *
6834 * @param other The other Intent to compare against.
6835 *
6836 * @return Returns true if action, data, type, class, and categories
6837 * are the same.
6838 */
6839 public boolean filterEquals(Intent other) {
6840 if (other == null) {
6841 return false;
6842 }
6843 if (mAction != other.mAction) {
6844 if (mAction != null) {
6845 if (!mAction.equals(other.mAction)) {
6846 return false;
6847 }
6848 } else {
6849 if (!other.mAction.equals(mAction)) {
6850 return false;
6851 }
6852 }
6853 }
6854 if (mData != other.mData) {
6855 if (mData != null) {
6856 if (!mData.equals(other.mData)) {
6857 return false;
6858 }
6859 } else {
6860 if (!other.mData.equals(mData)) {
6861 return false;
6862 }
6863 }
6864 }
6865 if (mType != other.mType) {
6866 if (mType != null) {
6867 if (!mType.equals(other.mType)) {
6868 return false;
6869 }
6870 } else {
6871 if (!other.mType.equals(mType)) {
6872 return false;
6873 }
6874 }
6875 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006876 if (mPackage != other.mPackage) {
6877 if (mPackage != null) {
6878 if (!mPackage.equals(other.mPackage)) {
6879 return false;
6880 }
6881 } else {
6882 if (!other.mPackage.equals(mPackage)) {
6883 return false;
6884 }
6885 }
6886 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006887 if (mComponent != other.mComponent) {
6888 if (mComponent != null) {
6889 if (!mComponent.equals(other.mComponent)) {
6890 return false;
6891 }
6892 } else {
6893 if (!other.mComponent.equals(mComponent)) {
6894 return false;
6895 }
6896 }
6897 }
6898 if (mCategories != other.mCategories) {
6899 if (mCategories != null) {
6900 if (!mCategories.equals(other.mCategories)) {
6901 return false;
6902 }
6903 } else {
6904 if (!other.mCategories.equals(mCategories)) {
6905 return false;
6906 }
6907 }
6908 }
6909
6910 return true;
6911 }
6912
6913 /**
6914 * Generate hash code that matches semantics of filterEquals().
6915 *
6916 * @return Returns the hash value of the action, data, type, class, and
6917 * categories.
6918 *
6919 * @see #filterEquals
6920 */
6921 public int filterHashCode() {
6922 int code = 0;
6923 if (mAction != null) {
6924 code += mAction.hashCode();
6925 }
6926 if (mData != null) {
6927 code += mData.hashCode();
6928 }
6929 if (mType != null) {
6930 code += mType.hashCode();
6931 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006932 if (mPackage != null) {
6933 code += mPackage.hashCode();
6934 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006935 if (mComponent != null) {
6936 code += mComponent.hashCode();
6937 }
6938 if (mCategories != null) {
6939 code += mCategories.hashCode();
6940 }
6941 return code;
6942 }
6943
6944 @Override
6945 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006946 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006947
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006948 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006949 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006950 b.append(" }");
6951
6952 return b.toString();
6953 }
6954
6955 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006956 public String toInsecureString() {
6957 StringBuilder b = new StringBuilder(128);
6958
6959 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006960 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006961 b.append(" }");
6962
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006963 return b.toString();
6964 }
Romain Guy4969af72009-06-17 10:53:19 -07006965
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006966 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006967 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006968 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006969
6970 b.append("Intent { ");
6971 toShortString(b, false, true, true, true);
6972 b.append(" }");
6973
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006974 return b.toString();
6975 }
6976
6977 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006978 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6979 StringBuilder b = new StringBuilder(128);
6980 toShortString(b, secure, comp, extras, clip);
6981 return b.toString();
6982 }
6983
6984 /** @hide */
6985 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6986 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006987 boolean first = true;
6988 if (mAction != null) {
6989 b.append("act=").append(mAction);
6990 first = false;
6991 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006992 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006993 if (!first) {
6994 b.append(' ');
6995 }
6996 first = false;
6997 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006998 for (int i=0; i<mCategories.size(); i++) {
6999 if (i > 0) b.append(',');
7000 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007001 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007002 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007003 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007004 if (mData != null) {
7005 if (!first) {
7006 b.append(' ');
7007 }
7008 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07007009 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07007010 if (secure) {
7011 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07007012 } else {
7013 b.append(mData);
7014 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007015 }
7016 if (mType != null) {
7017 if (!first) {
7018 b.append(' ');
7019 }
7020 first = false;
7021 b.append("typ=").append(mType);
7022 }
7023 if (mFlags != 0) {
7024 if (!first) {
7025 b.append(' ');
7026 }
7027 first = false;
7028 b.append("flg=0x").append(Integer.toHexString(mFlags));
7029 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007030 if (mPackage != null) {
7031 if (!first) {
7032 b.append(' ');
7033 }
7034 first = false;
7035 b.append("pkg=").append(mPackage);
7036 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007037 if (comp && mComponent != null) {
7038 if (!first) {
7039 b.append(' ');
7040 }
7041 first = false;
7042 b.append("cmp=").append(mComponent.flattenToShortString());
7043 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007044 if (mSourceBounds != null) {
7045 if (!first) {
7046 b.append(' ');
7047 }
7048 first = false;
7049 b.append("bnds=").append(mSourceBounds.toShortString());
7050 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007051 if (mClipData != null) {
7052 if (!first) {
7053 b.append(' ');
7054 }
7055 first = false;
7056 if (clip) {
7057 b.append("clip={");
7058 mClipData.toShortString(b);
7059 b.append('}');
7060 } else {
7061 b.append("(has clip)");
7062 }
7063 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007064 if (extras && mExtras != null) {
7065 if (!first) {
7066 b.append(' ');
7067 }
7068 first = false;
7069 b.append("(has extras)");
7070 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007071 if (mSelector != null) {
7072 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007073 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007074 b.append("}");
7075 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007076 }
7077
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007078 /**
7079 * Call {@link #toUri} with 0 flags.
7080 * @deprecated Use {@link #toUri} instead.
7081 */
7082 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007083 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007084 return toUri(0);
7085 }
7086
7087 /**
7088 * Convert this Intent into a String holding a URI representation of it.
7089 * The returned URI string has been properly URI encoded, so it can be
7090 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
7091 * Intent's data as the base URI, with an additional fragment describing
7092 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08007093 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007094 * <p>You can convert the returned string back to an Intent with
7095 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08007096 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007097 * @param flags Additional operating flags. Either 0 or
7098 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08007099 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007100 * @return Returns a URI encoding URI string describing the entire contents
7101 * of the Intent.
7102 */
7103 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07007104 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007105 String scheme = null;
7106 if (mData != null) {
7107 String data = mData.toString();
7108 if ((flags&URI_INTENT_SCHEME) != 0) {
7109 final int N = data.length();
7110 for (int i=0; i<N; i++) {
7111 char c = data.charAt(i);
7112 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
7113 || c == '.' || c == '-') {
7114 continue;
7115 }
7116 if (c == ':' && i > 0) {
7117 // Valid scheme.
7118 scheme = data.substring(0, i);
7119 uri.append("intent:");
7120 data = data.substring(i+1);
7121 break;
7122 }
Tom Taylord4a47292009-12-21 13:59:18 -08007123
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007124 // No scheme.
7125 break;
7126 }
7127 }
7128 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08007129
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007130 } else if ((flags&URI_INTENT_SCHEME) != 0) {
7131 uri.append("intent:");
7132 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007133
7134 uri.append("#Intent;");
7135
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007136 toUriInner(uri, scheme, flags);
7137 if (mSelector != null) {
7138 uri.append("SEL;");
7139 // Note that for now we are not going to try to handle the
7140 // data part; not clear how to represent this as a URI, and
7141 // not much utility in it.
7142 mSelector.toUriInner(uri, null, flags);
7143 }
7144
7145 uri.append("end");
7146
7147 return uri.toString();
7148 }
7149
7150 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007151 if (scheme != null) {
7152 uri.append("scheme=").append(scheme).append(';');
7153 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007154 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007155 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007156 }
7157 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007158 for (int i=0; i<mCategories.size(); i++) {
7159 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007160 }
7161 }
7162 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007163 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007164 }
7165 if (mFlags != 0) {
7166 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
7167 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007168 if (mPackage != null) {
7169 uri.append("package=").append(Uri.encode(mPackage)).append(';');
7170 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007171 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007172 uri.append("component=").append(Uri.encode(
7173 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007174 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007175 if (mSourceBounds != null) {
7176 uri.append("sourceBounds=")
7177 .append(Uri.encode(mSourceBounds.flattenToString()))
7178 .append(';');
7179 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007180 if (mExtras != null) {
7181 for (String key : mExtras.keySet()) {
7182 final Object value = mExtras.get(key);
7183 char entryType =
7184 value instanceof String ? 'S' :
7185 value instanceof Boolean ? 'B' :
7186 value instanceof Byte ? 'b' :
7187 value instanceof Character ? 'c' :
7188 value instanceof Double ? 'd' :
7189 value instanceof Float ? 'f' :
7190 value instanceof Integer ? 'i' :
7191 value instanceof Long ? 'l' :
7192 value instanceof Short ? 's' :
7193 '\0';
7194
7195 if (entryType != '\0') {
7196 uri.append(entryType);
7197 uri.append('.');
7198 uri.append(Uri.encode(key));
7199 uri.append('=');
7200 uri.append(Uri.encode(value.toString()));
7201 uri.append(';');
7202 }
7203 }
7204 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007205 }
The Android Open Source Project10592532009-03-18 17:39:46 -07007206
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007207 public int describeContents() {
7208 return (mExtras != null) ? mExtras.describeContents() : 0;
7209 }
7210
7211 public void writeToParcel(Parcel out, int flags) {
7212 out.writeString(mAction);
7213 Uri.writeToParcel(out, mData);
7214 out.writeString(mType);
7215 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007216 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007217 ComponentName.writeToParcel(mComponent, out);
7218
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007219 if (mSourceBounds != null) {
7220 out.writeInt(1);
7221 mSourceBounds.writeToParcel(out, flags);
7222 } else {
7223 out.writeInt(0);
7224 }
7225
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007226 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007227 final int N = mCategories.size();
7228 out.writeInt(N);
7229 for (int i=0; i<N; i++) {
7230 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007231 }
7232 } else {
7233 out.writeInt(0);
7234 }
7235
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007236 if (mSelector != null) {
7237 out.writeInt(1);
7238 mSelector.writeToParcel(out, flags);
7239 } else {
7240 out.writeInt(0);
7241 }
7242
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007243 if (mClipData != null) {
7244 out.writeInt(1);
7245 mClipData.writeToParcel(out, flags);
7246 } else {
7247 out.writeInt(0);
7248 }
7249
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007250 out.writeBundle(mExtras);
7251 }
7252
7253 public static final Parcelable.Creator<Intent> CREATOR
7254 = new Parcelable.Creator<Intent>() {
7255 public Intent createFromParcel(Parcel in) {
7256 return new Intent(in);
7257 }
7258 public Intent[] newArray(int size) {
7259 return new Intent[size];
7260 }
7261 };
7262
Dianne Hackborneb034652009-09-07 00:49:58 -07007263 /** @hide */
7264 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007265 readFromParcel(in);
7266 }
7267
7268 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007269 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007270 mData = Uri.CREATOR.createFromParcel(in);
7271 mType = in.readString();
7272 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07007273 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007274 mComponent = ComponentName.readFromParcel(in);
7275
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08007276 if (in.readInt() != 0) {
7277 mSourceBounds = Rect.CREATOR.createFromParcel(in);
7278 }
7279
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007280 int N = in.readInt();
7281 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07007282 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007283 int i;
7284 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08007285 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007286 }
7287 } else {
7288 mCategories = null;
7289 }
7290
Dianne Hackbornf5b86712011-12-05 17:42:41 -08007291 if (in.readInt() != 0) {
7292 mSelector = new Intent(in);
7293 }
7294
Dianne Hackborn21c241e2012-03-08 13:57:23 -08007295 if (in.readInt() != 0) {
7296 mClipData = new ClipData(in);
7297 }
7298
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007299 mExtras = in.readBundle();
7300 }
7301
7302 /**
7303 * Parses the "intent" element (and its children) from XML and instantiates
7304 * an Intent object. The given XML parser should be located at the tag
7305 * where parsing should start (often named "intent"), from which the
7306 * basic action, data, type, and package and class name will be
7307 * retrieved. The function will then parse in to any child elements,
7308 * looking for <category android:name="xxx"> tags to add categories and
7309 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7310 * to the intent.
7311 *
7312 * @param resources The Resources to use when inflating resources.
7313 * @param parser The XML parser pointing at an "intent" tag.
7314 * @param attrs The AttributeSet interface for retrieving extended
7315 * attribute data at the current <var>parser</var> location.
7316 * @return An Intent object matching the XML data.
7317 * @throws XmlPullParserException If there was an XML parsing error.
7318 * @throws IOException If there was an I/O error.
7319 */
7320 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7321 throws XmlPullParserException, IOException {
7322 Intent intent = new Intent();
7323
7324 TypedArray sa = resources.obtainAttributes(attrs,
7325 com.android.internal.R.styleable.Intent);
7326
7327 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7328
7329 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7330 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7331 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7332
7333 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7334 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7335 if (packageName != null && className != null) {
7336 intent.setComponent(new ComponentName(packageName, className));
7337 }
7338
7339 sa.recycle();
7340
7341 int outerDepth = parser.getDepth();
7342 int type;
7343 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7344 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7345 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7346 continue;
7347 }
7348
7349 String nodeName = parser.getName();
Craig Mautner21d24a22014-04-23 11:45:37 -07007350 if (nodeName.equals(TAG_CATEGORIES)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007351 sa = resources.obtainAttributes(attrs,
7352 com.android.internal.R.styleable.IntentCategory);
7353 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7354 sa.recycle();
7355
7356 if (cat != null) {
7357 intent.addCategory(cat);
7358 }
7359 XmlUtils.skipCurrentTag(parser);
7360
Craig Mautner21d24a22014-04-23 11:45:37 -07007361 } else if (nodeName.equals(TAG_EXTRA)) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007362 if (intent.mExtras == null) {
7363 intent.mExtras = new Bundle();
7364 }
Craig Mautner21d24a22014-04-23 11:45:37 -07007365 resources.parseBundleExtra(TAG_EXTRA, attrs, intent.mExtras);
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007366 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007367
7368 } else {
7369 XmlUtils.skipCurrentTag(parser);
7370 }
7371 }
7372
7373 return intent;
7374 }
Nick Pellyccae4122012-01-09 14:12:58 -08007375
Craig Mautner21d24a22014-04-23 11:45:37 -07007376 /** @hide */
7377 public void saveToXml(XmlSerializer out) throws IOException {
7378 if (mAction != null) {
7379 out.attribute(null, ATTR_ACTION, mAction);
7380 }
7381 if (mData != null) {
7382 out.attribute(null, ATTR_DATA, mData.toString());
7383 }
7384 if (mType != null) {
7385 out.attribute(null, ATTR_TYPE, mType);
7386 }
7387 if (mComponent != null) {
7388 out.attribute(null, ATTR_COMPONENT, mComponent.flattenToShortString());
7389 }
7390 out.attribute(null, ATTR_FLAGS, Integer.toHexString(getFlags()));
7391
7392 if (mCategories != null) {
7393 out.startTag(null, TAG_CATEGORIES);
7394 for (int categoryNdx = mCategories.size() - 1; categoryNdx >= 0; --categoryNdx) {
7395 out.attribute(null, ATTR_CATEGORY, mCategories.valueAt(categoryNdx));
7396 }
7397 }
7398 }
7399
7400 /** @hide */
7401 public static Intent restoreFromXml(XmlPullParser in) throws IOException,
7402 XmlPullParserException {
7403 Intent intent = new Intent();
7404 final int outerDepth = in.getDepth();
7405
7406 int attrCount = in.getAttributeCount();
7407 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7408 final String attrName = in.getAttributeName(attrNdx);
7409 final String attrValue = in.getAttributeValue(attrNdx);
7410 if (ATTR_ACTION.equals(attrName)) {
7411 intent.setAction(attrValue);
7412 } else if (ATTR_DATA.equals(attrName)) {
7413 intent.setData(Uri.parse(attrValue));
7414 } else if (ATTR_TYPE.equals(attrName)) {
7415 intent.setType(attrValue);
7416 } else if (ATTR_COMPONENT.equals(attrName)) {
7417 intent.setComponent(ComponentName.unflattenFromString(attrValue));
7418 } else if (ATTR_FLAGS.equals(attrName)) {
7419 intent.setFlags(Integer.valueOf(attrValue, 16));
7420 } else {
7421 Log.e("Intent", "restoreFromXml: unknown attribute=" + attrName);
7422 }
7423 }
7424
7425 int event;
7426 String name;
7427 while (((event = in.next()) != XmlPullParser.END_DOCUMENT) &&
7428 (event != XmlPullParser.END_TAG || in.getDepth() < outerDepth)) {
7429 if (event == XmlPullParser.START_TAG) {
7430 name = in.getName();
7431 if (TAG_CATEGORIES.equals(name)) {
7432 attrCount = in.getAttributeCount();
7433 for (int attrNdx = attrCount - 1; attrNdx >= 0; --attrNdx) {
7434 intent.addCategory(in.getAttributeValue(attrNdx));
7435 }
7436 } else {
7437 Log.w("Intent", "restoreFromXml: unknown name=" + name);
7438 XmlUtils.skipCurrentTag(in);
7439 }
7440 }
7441 }
7442
7443 return intent;
7444 }
7445
Nick Pellyccae4122012-01-09 14:12:58 -08007446 /**
7447 * Normalize a MIME data type.
7448 *
7449 * <p>A normalized MIME type has white-space trimmed,
7450 * content-type parameters removed, and is lower-case.
7451 * This aligns the type with Android best practices for
7452 * intent filtering.
7453 *
7454 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7455 * "text/x-vCard" becomes "text/x-vcard".
7456 *
7457 * <p>All MIME types received from outside Android (such as user input,
7458 * or external sources like Bluetooth, NFC, or the Internet) should
7459 * be normalized before they are used to create an Intent.
7460 *
7461 * @param type MIME data type to normalize
7462 * @return normalized MIME data type, or null if the input was null
John Spurlock125d1332013-11-25 11:58:37 -05007463 * @see #setType
7464 * @see #setTypeAndNormalize
Nick Pellyccae4122012-01-09 14:12:58 -08007465 */
7466 public static String normalizeMimeType(String type) {
7467 if (type == null) {
7468 return null;
7469 }
7470
Elliott Hughescb64d432013-08-02 10:00:44 -07007471 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007472
7473 final int semicolonIndex = type.indexOf(';');
7474 if (semicolonIndex != -1) {
7475 type = type.substring(0, semicolonIndex);
7476 }
7477 return type;
7478 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007479
7480 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007481 * Prepare this {@link Intent} to leave an app process.
7482 *
7483 * @hide
7484 */
7485 public void prepareToLeaveProcess() {
7486 setAllowFds(false);
7487
7488 if (mSelector != null) {
7489 mSelector.prepareToLeaveProcess();
7490 }
7491 if (mClipData != null) {
7492 mClipData.prepareToLeaveProcess();
7493 }
7494
7495 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7496 // There are several ACTION_MEDIA_* broadcasts that send file://
7497 // Uris, so only check common actions.
7498 if (ACTION_VIEW.equals(mAction) ||
7499 ACTION_EDIT.equals(mAction) ||
7500 ACTION_ATTACH_DATA.equals(mAction)) {
7501 mData.checkFileUriExposed("Intent.getData()");
7502 }
7503 }
7504 }
7505
7506 /**
Nicolas Prevotd85fc722014-04-16 19:52:08 +01007507 * Prepare this {@link Intent} to be sent to another user
7508 *
7509 * @hide
7510 */
7511 public void prepareToLeaveUser(int userId) {
7512 Uri data = getData();
7513 if (data != null) {
7514 mData = maybeAddUserId(data, userId);
7515 }
7516 if (mSelector != null) {
7517 mSelector.prepareToLeaveUser(userId);
7518 }
7519 if (mClipData != null) {
7520 mClipData.prepareToLeaveUser(userId);
7521 }
7522 String action = getAction();
7523 if (ACTION_SEND.equals(action)) {
7524 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7525 if (stream != null) {
7526 putExtra(EXTRA_STREAM, maybeAddUserId(stream, userId));
7527 }
7528 }
7529 if (ACTION_SEND_MULTIPLE.equals(action)) {
7530 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7531 if (streams != null) {
7532 ArrayList<Uri> newStreams = new ArrayList<Uri>();
7533 for (int i = 0; i < streams.size(); i++) {
7534 newStreams.add(maybeAddUserId(streams.get(i), userId));
7535 }
7536 putParcelableArrayListExtra(EXTRA_STREAM, newStreams);
7537 }
7538 }
7539 }
7540
7541 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007542 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007543 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7544 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007545 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007546 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007547 * @hide
7548 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007549 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007550 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007551 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007552
7553 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007554 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007555
7556 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007557 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007558 try {
7559 // Inspect target intent to see if we need to migrate
7560 final Intent target = getParcelableExtra(EXTRA_INTENT);
7561 if (target != null && target.migrateExtraStreamToClipData()) {
7562 // Since we migrated in child, we need to promote ClipData
7563 // and flags to ourselves to grant.
7564 setClipData(target.getClipData());
Jeff Sharkey846318a2014-04-04 12:12:41 -07007565 addFlags(target.getFlags() & (FLAG_GRANT_READ_URI_PERMISSION
7566 | FLAG_GRANT_WRITE_URI_PERMISSION
7567 | FLAG_GRANT_PERSISTABLE_URI_PERMISSION
7568 | FLAG_GRANT_PREFIX_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007569 return true;
7570 } else {
7571 return false;
7572 }
7573 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007574 }
7575
7576 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007577 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007578 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7579 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7580 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7581 if (stream != null || text != null || htmlText != null) {
7582 final ClipData clipData = new ClipData(
7583 null, new String[] { getType() },
7584 new ClipData.Item(text, htmlText, null, stream));
7585 setClipData(clipData);
7586 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007587 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007588 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007589 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007590 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007591
7592 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007593 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007594 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7595 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7596 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7597 int num = -1;
7598 if (streams != null) {
7599 num = streams.size();
7600 }
7601 if (texts != null) {
7602 if (num >= 0 && num != texts.size()) {
7603 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007604 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007605 }
7606 num = texts.size();
7607 }
7608 if (htmlTexts != null) {
7609 if (num >= 0 && num != htmlTexts.size()) {
7610 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007611 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007612 }
7613 num = htmlTexts.size();
7614 }
7615 if (num > 0) {
7616 final ClipData clipData = new ClipData(
7617 null, new String[] { getType() },
7618 makeClipItem(streams, texts, htmlTexts, 0));
7619
7620 for (int i = 1; i < num; i++) {
7621 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7622 }
7623
7624 setClipData(clipData);
7625 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007626 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007627 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007628 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007629 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007630 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007631
7632 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007633 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007634
7635 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7636 ArrayList<String> htmlTexts, int which) {
7637 Uri uri = streams != null ? streams.get(which) : null;
7638 CharSequence text = texts != null ? texts.get(which) : null;
7639 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7640 return new ClipData.Item(text, htmlText, null, uri);
7641 }
Craig Mautnerd00f4742014-03-12 14:17:26 -07007642
7643 /** @hide */
7644 public boolean isDocument() {
7645 return (mFlags & FLAG_ACTIVITY_NEW_DOCUMENT) == FLAG_ACTIVITY_NEW_DOCUMENT;
7646 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007647}