blob: 36c69ef9cc2efbed83569c6f0094c1a0d255769b [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
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070035import android.os.StrictMode;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070036import android.util.AttributeSet;
37import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080038
39import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070040
41import java.io.IOException;
42import java.io.Serializable;
43import java.net.URISyntaxException;
44import java.util.ArrayList;
45import java.util.HashSet;
46import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080047import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import java.util.Set;
49
50/**
51 * An intent is an abstract description of an operation to be performed. It
52 * can be used with {@link Context#startActivity(Intent) startActivity} to
53 * launch an {@link android.app.Activity},
54 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
55 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
56 * and {@link android.content.Context#startService} or
57 * {@link android.content.Context#bindService} to communicate with a
58 * background {@link android.app.Service}.
59 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070060 * <p>An Intent provides a facility for performing late runtime binding between the code in
61 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070062 * can be thought of as the glue between activities. It is basically a passive data structure
63 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070064 *
65 * <div class="special reference">
66 * <h3>Developer Guides</h3>
67 * <p>For information about how to create and resolve intents, read the
68 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
69 * developer guide.</p>
70 * </div>
71 *
72 * <a name="IntentStructure"></a>
73 * <h3>Intent Structure</h3>
74 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070075 *
76 * <ul>
77 * <li> <p><b>action</b> -- The general action to be performed, such as
78 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
79 * etc.</p>
80 * </li>
81 * <li> <p><b>data</b> -- The data to operate on, such as a person record
82 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
83 * </li>
84 * </ul>
85 *
86 *
87 * <p>Some examples of action/data pairs are:</p>
88 *
89 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070090 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070091 * information about the person whose identifier is "1".</p>
92 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070093 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070094 * the phone dialer with the person filled in.</p>
95 * </li>
96 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
97 * the phone dialer with the given number filled in. Note how the
98 * VIEW action does what what is considered the most reasonable thing for
99 * a particular URI.</p>
100 * </li>
101 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
102 * the phone dialer with the given number filled in.</p>
103 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700104 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700105 * information about the person whose identifier is "1".</p>
106 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700107 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700108 * a list of people, which the user can browse through. This example is a
109 * typical top-level entry into the Contacts application, showing you the
110 * list of people. Selecting a particular person to view would result in a
111 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
112 * being used to start an activity to display that person.</p>
113 * </li>
114 * </ul>
115 *
116 * <p>In addition to these primary attributes, there are a number of secondary
117 * attributes that you can also include with an intent:</p>
118 *
119 * <ul>
120 * <li> <p><b>category</b> -- Gives additional information about the action
121 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
122 * appear in the Launcher as a top-level application, while
123 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
124 * of alternative actions the user can perform on a piece of data.</p>
125 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
126 * intent data. Normally the type is inferred from the data itself.
127 * By setting this attribute, you disable that evaluation and force
128 * an explicit type.</p>
129 * <li> <p><b>component</b> -- Specifies an explicit name of a component
130 * class to use for the intent. Normally this is determined by looking
131 * at the other information in the intent (the action, data/type, and
132 * categories) and matching that with a component that can handle it.
133 * If this attribute is set then none of the evaluation is performed,
134 * and this component is used exactly as is. By specifying this attribute,
135 * all of the other Intent attributes become optional.</p>
136 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
137 * This can be used to provide extended information to the component.
138 * For example, if we have a action to send an e-mail message, we could
139 * also include extra pieces of data here to supply a subject, body,
140 * etc.</p>
141 * </ul>
142 *
143 * <p>Here are some examples of other operations you can specify as intents
144 * using these additional parameters:</p>
145 *
146 * <ul>
147 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
148 * Launch the home screen.</p>
149 * </li>
150 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
151 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
152 * vnd.android.cursor.item/phone}</i></b>
153 * -- Display the list of people's phone numbers, allowing the user to
154 * browse through them and pick one and return it to the parent activity.</p>
155 * </li>
156 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
157 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
158 * -- Display all pickers for data that can be opened with
159 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
160 * allowing the user to pick one of them and then some data inside of it
161 * and returning the resulting URI to the caller. This can be used,
162 * for example, in an e-mail application to allow the user to pick some
163 * data to include as an attachment.</p>
164 * </li>
165 * </ul>
166 *
167 * <p>There are a variety of standard Intent action and category constants
168 * defined in the Intent class, but applications can also define their own.
169 * These strings use java style scoping, to ensure they are unique -- for
170 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700171 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700172 *
173 * <p>Put together, the set of actions, data types, categories, and extra data
174 * defines a language for the system allowing for the expression of phrases
175 * such as "call john smith's cell". As applications are added to the system,
176 * they can extend this language by adding new actions, types, and categories, or
177 * they can modify the behavior of existing phrases by supplying their own
178 * activities that handle them.</p>
179 *
180 * <a name="IntentResolution"></a>
181 * <h3>Intent Resolution</h3>
182 *
183 * <p>There are two primary forms of intents you will use.
184 *
185 * <ul>
186 * <li> <p><b>Explicit Intents</b> have specified a component (via
187 * {@link #setComponent} or {@link #setClass}), which provides the exact
188 * class to be run. Often these will not include any other information,
189 * simply being a way for an application to launch various internal
190 * activities it has as the user interacts with the application.
191 *
192 * <li> <p><b>Implicit Intents</b> have not specified a component;
193 * instead, they must include enough information for the system to
194 * determine which of the available components is best to run for that
195 * intent.
196 * </ul>
197 *
198 * <p>When using implicit intents, given such an arbitrary intent we need to
199 * know what to do with it. This is handled by the process of <em>Intent
200 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
201 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
202 * more activities/receivers) that can handle it.</p>
203 *
204 * <p>The intent resolution mechanism basically revolves around matching an
205 * Intent against all of the &lt;intent-filter&gt; descriptions in the
206 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
207 * objects explicitly registered with {@link Context#registerReceiver}.) More
208 * details on this can be found in the documentation on the {@link
209 * IntentFilter} class.</p>
210 *
211 * <p>There are three pieces of information in the Intent that are used for
212 * resolution: the action, type, and category. Using this information, a query
213 * is done on the {@link PackageManager} for a component that can handle the
214 * intent. The appropriate component is determined based on the intent
215 * information supplied in the <code>AndroidManifest.xml</code> file as
216 * follows:</p>
217 *
218 * <ul>
219 * <li> <p>The <b>action</b>, if given, must be listed by the component as
220 * one it handles.</p>
221 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
222 * already supplied in the Intent. Like the action, if a type is
223 * included in the intent (either explicitly or implicitly in its
224 * data), then this must be listed by the component as one it handles.</p>
225 * <li> For data that is not a <code>content:</code> URI and where no explicit
226 * type is included in the Intent, instead the <b>scheme</b> of the
227 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
228 * considered. Again like the action, if we are matching a scheme it
229 * must be listed by the component as one it can handle.
230 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
231 * by the activity as categories it handles. That is, if you include
232 * the categories {@link #CATEGORY_LAUNCHER} and
233 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
234 * with an intent that lists <em>both</em> of those categories.
235 * Activities will very often need to support the
236 * {@link #CATEGORY_DEFAULT} so that they can be found by
237 * {@link Context#startActivity Context.startActivity()}.</p>
238 * </ul>
239 *
240 * <p>For example, consider the Note Pad sample application that
241 * allows user to browse through a list of notes data and view details about
242 * individual items. Text in italics indicate places were you would replace a
243 * name with one specific to your own package.</p>
244 *
245 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
246 * package="<i>com.android.notepad</i>"&gt;
247 * &lt;application android:icon="@drawable/app_notes"
248 * android:label="@string/app_name"&gt;
249 *
250 * &lt;provider class=".NotePadProvider"
251 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
252 *
253 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
254 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700255 * &lt;action android:name="android.intent.action.MAIN" /&gt;
256 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700257 * &lt;/intent-filter&gt;
258 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700259 * &lt;action android:name="android.intent.action.VIEW" /&gt;
260 * &lt;action android:name="android.intent.action.EDIT" /&gt;
261 * &lt;action android:name="android.intent.action.PICK" /&gt;
262 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
263 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700264 * &lt;/intent-filter&gt;
265 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700266 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
267 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
268 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700269 * &lt;/intent-filter&gt;
270 * &lt;/activity&gt;
271 *
272 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
273 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700274 * &lt;action android:name="android.intent.action.VIEW" /&gt;
275 * &lt;action android:name="android.intent.action.EDIT" /&gt;
276 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
277 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700278 * &lt;/intent-filter&gt;
279 *
280 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="android.intent.action.INSERT" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 *
286 * &lt;/activity&gt;
287 *
288 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
289 * android:theme="@android:style/Theme.Dialog"&gt;
290 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700291 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
292 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
293 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
294 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
295 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700296 * &lt;/intent-filter&gt;
297 * &lt;/activity&gt;
298 *
299 * &lt;/application&gt;
300 * &lt;/manifest&gt;</pre>
301 *
302 * <p>The first activity,
303 * <code>com.android.notepad.NotesList</code>, serves as our main
304 * entry into the app. It can do three things as described by its three intent
305 * templates:
306 * <ol>
307 * <li><pre>
308 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700309 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
310 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700311 * &lt;/intent-filter&gt;</pre>
312 * <p>This provides a top-level entry into the NotePad application: the standard
313 * MAIN action is a main entry point (not requiring any other information in
314 * the Intent), and the LAUNCHER category says that this entry point should be
315 * listed in the application launcher.</p>
316 * <li><pre>
317 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700318 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
319 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
320 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
321 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
322 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700323 * &lt;/intent-filter&gt;</pre>
324 * <p>This declares the things that the activity can do on a directory of
325 * notes. The type being supported is given with the &lt;type&gt; tag, where
326 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
327 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
328 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
329 * The activity allows the user to view or edit the directory of data (via
330 * the VIEW and EDIT actions), or to pick a particular note and return it
331 * to the caller (via the PICK action). Note also the DEFAULT category
332 * supplied here: this is <em>required</em> for the
333 * {@link Context#startActivity Context.startActivity} method to resolve your
334 * activity when its component name is not explicitly specified.</p>
335 * <li><pre>
336 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700337 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
338 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
339 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700340 * &lt;/intent-filter&gt;</pre>
341 * <p>This filter describes the ability return to the caller a note selected by
342 * the user without needing to know where it came from. The data type
343 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
344 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
345 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
346 * The GET_CONTENT action is similar to the PICK action, where the activity
347 * will return to its caller a piece of data selected by the user. Here,
348 * however, the caller specifies the type of data they desire instead of
349 * the type of data the user will be picking from.</p>
350 * </ol>
351 *
352 * <p>Given these capabilities, the following intents will resolve to the
353 * NotesList activity:</p>
354 *
355 * <ul>
356 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
357 * activities that can be used as top-level entry points into an
358 * application.</p>
359 * <li> <p><b>{ action=android.app.action.MAIN,
360 * category=android.app.category.LAUNCHER }</b> is the actual intent
361 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700362 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700363 * data=content://com.google.provider.NotePad/notes }</b>
364 * displays a list of all the notes under
365 * "content://com.google.provider.NotePad/notes", which
366 * the user can browse through and see the details on.</p>
367 * <li> <p><b>{ action=android.app.action.PICK
368 * data=content://com.google.provider.NotePad/notes }</b>
369 * provides a list of the notes under
370 * "content://com.google.provider.NotePad/notes", from which
371 * the user can pick a note whose data URL is returned back to the caller.</p>
372 * <li> <p><b>{ action=android.app.action.GET_CONTENT
373 * type=vnd.android.cursor.item/vnd.google.note }</b>
374 * is similar to the pick action, but allows the caller to specify the
375 * kind of data they want back so that the system can find the appropriate
376 * activity to pick something of that data type.</p>
377 * </ul>
378 *
379 * <p>The second activity,
380 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
381 * note entry and allows them to edit it. It can do two things as described
382 * by its two intent templates:
383 * <ol>
384 * <li><pre>
385 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700386 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
387 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
388 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
389 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700390 * &lt;/intent-filter&gt;</pre>
391 * <p>The first, primary, purpose of this activity is to let the user interact
392 * with a single note, as decribed by the MIME type
393 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
394 * either VIEW a note or allow the user to EDIT it. Again we support the
395 * DEFAULT category to allow the activity to be launched without explicitly
396 * specifying its component.</p>
397 * <li><pre>
398 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700399 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
400 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
401 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700402 * &lt;/intent-filter&gt;</pre>
403 * <p>The secondary use of this activity is to insert a new note entry into
404 * an existing directory of notes. This is used when the user creates a new
405 * note: the INSERT action is executed on the directory of notes, causing
406 * this activity to run and have the user create the new note data which
407 * it then adds to the content provider.</p>
408 * </ol>
409 *
410 * <p>Given these capabilities, the following intents will resolve to the
411 * NoteEditor activity:</p>
412 *
413 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700414 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700415 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
416 * shows the user the content of note <var>{ID}</var>.</p>
417 * <li> <p><b>{ action=android.app.action.EDIT
418 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
419 * allows the user to edit the content of note <var>{ID}</var>.</p>
420 * <li> <p><b>{ action=android.app.action.INSERT
421 * data=content://com.google.provider.NotePad/notes }</b>
422 * creates a new, empty note in the notes list at
423 * "content://com.google.provider.NotePad/notes"
424 * and allows the user to edit it. If they keep their changes, the URI
425 * of the newly created note is returned to the caller.</p>
426 * </ul>
427 *
428 * <p>The last activity,
429 * <code>com.android.notepad.TitleEditor</code>, allows the user to
430 * edit the title of a note. This could be implemented as a class that the
431 * application directly invokes (by explicitly setting its component in
432 * the Intent), but here we show a way you can publish alternative
433 * operations on existing data:</p>
434 *
435 * <pre>
436 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700437 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
440 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
441 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700442 * &lt;/intent-filter&gt;</pre>
443 *
444 * <p>In the single intent template here, we
445 * have created our own private action called
446 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
447 * edit the title of a note. It must be invoked on a specific note
448 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
449 * view and edit actions, but here displays and edits the title contained
450 * in the note data.
451 *
452 * <p>In addition to supporting the default category as usual, our title editor
453 * also supports two other standard categories: ALTERNATIVE and
454 * SELECTED_ALTERNATIVE. Implementing
455 * these categories allows others to find the special action it provides
456 * without directly knowing about it, through the
457 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
458 * more often to build dynamic menu items with
459 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
460 * template here was also supply an explicit name for the template
461 * (via <code>android:label="@string/resolve_title"</code>) to better control
462 * what the user sees when presented with this activity as an alternative
463 * action to the data they are viewing.
464 *
465 * <p>Given these capabilities, the following intent will resolve to the
466 * TitleEditor activity:</p>
467 *
468 * <ul>
469 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
470 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
471 * displays and allows the user to edit the title associated
472 * with note <var>{ID}</var>.</p>
473 * </ul>
474 *
475 * <h3>Standard Activity Actions</h3>
476 *
477 * <p>These are the current standard actions that Intent defines for launching
478 * activities (usually through {@link Context#startActivity}. The most
479 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
480 * {@link #ACTION_EDIT}.
481 *
482 * <ul>
483 * <li> {@link #ACTION_MAIN}
484 * <li> {@link #ACTION_VIEW}
485 * <li> {@link #ACTION_ATTACH_DATA}
486 * <li> {@link #ACTION_EDIT}
487 * <li> {@link #ACTION_PICK}
488 * <li> {@link #ACTION_CHOOSER}
489 * <li> {@link #ACTION_GET_CONTENT}
490 * <li> {@link #ACTION_DIAL}
491 * <li> {@link #ACTION_CALL}
492 * <li> {@link #ACTION_SEND}
493 * <li> {@link #ACTION_SENDTO}
494 * <li> {@link #ACTION_ANSWER}
495 * <li> {@link #ACTION_INSERT}
496 * <li> {@link #ACTION_DELETE}
497 * <li> {@link #ACTION_RUN}
498 * <li> {@link #ACTION_SYNC}
499 * <li> {@link #ACTION_PICK_ACTIVITY}
500 * <li> {@link #ACTION_SEARCH}
501 * <li> {@link #ACTION_WEB_SEARCH}
502 * <li> {@link #ACTION_FACTORY_TEST}
503 * </ul>
504 *
505 * <h3>Standard Broadcast Actions</h3>
506 *
507 * <p>These are the current standard actions that Intent defines for receiving
508 * broadcasts (usually through {@link Context#registerReceiver} or a
509 * &lt;receiver&gt; tag in a manifest).
510 *
511 * <ul>
512 * <li> {@link #ACTION_TIME_TICK}
513 * <li> {@link #ACTION_TIME_CHANGED}
514 * <li> {@link #ACTION_TIMEZONE_CHANGED}
515 * <li> {@link #ACTION_BOOT_COMPLETED}
516 * <li> {@link #ACTION_PACKAGE_ADDED}
517 * <li> {@link #ACTION_PACKAGE_CHANGED}
518 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800519 * <li> {@link #ACTION_PACKAGE_RESTARTED}
520 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700521 * <li> {@link #ACTION_UID_REMOVED}
522 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700523 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700524 * <li> {@link #ACTION_POWER_DISCONNECTED}
525 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700526 * </ul>
527 *
528 * <h3>Standard Categories</h3>
529 *
530 * <p>These are the current standard categories that can be used to further
531 * clarify an Intent via {@link #addCategory}.
532 *
533 * <ul>
534 * <li> {@link #CATEGORY_DEFAULT}
535 * <li> {@link #CATEGORY_BROWSABLE}
536 * <li> {@link #CATEGORY_TAB}
537 * <li> {@link #CATEGORY_ALTERNATIVE}
538 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
539 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800540 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700541 * <li> {@link #CATEGORY_HOME}
542 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400544 * <li> {@link #CATEGORY_CAR_DOCK}
545 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500546 * <li> {@link #CATEGORY_LE_DESK_DOCK}
547 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200548 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700549 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700550 * </ul>
551 *
552 * <h3>Standard Extra Data</h3>
553 *
554 * <p>These are the current standard fields that can be used as extra data via
555 * {@link #putExtra}.
556 *
557 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800558 * <li> {@link #EXTRA_ALARM_COUNT}
559 * <li> {@link #EXTRA_BCC}
560 * <li> {@link #EXTRA_CC}
561 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
562 * <li> {@link #EXTRA_DATA_REMOVED}
563 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500564 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
565 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800566 * <li> {@link #EXTRA_DOCK_STATE_CAR}
567 * <li> {@link #EXTRA_DOCK_STATE_DESK}
568 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
569 * <li> {@link #EXTRA_DONT_KILL_APP}
570 * <li> {@link #EXTRA_EMAIL}
571 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800573 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700574 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700576 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800577 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
578 * <li> {@link #EXTRA_REPLACING}
579 * <li> {@link #EXTRA_SHORTCUT_ICON}
580 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
581 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700582 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_SHORTCUT_NAME}
584 * <li> {@link #EXTRA_SUBJECT}
585 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800587 * <li> {@link #EXTRA_TITLE}
588 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700589 * </ul>
590 *
591 * <h3>Flags</h3>
592 *
593 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800594 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
595 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700596 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800597public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700598 // ---------------------------------------------------------------------
599 // ---------------------------------------------------------------------
600 // Standard intent activity actions (see action variable).
601
602 /**
603 * Activity Action: Start as a main entry point, does not expect to
604 * receive data.
605 * <p>Input: nothing
606 * <p>Output: nothing
607 */
608 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
609 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800610
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 /**
612 * Activity Action: Display the data to the user. This is the most common
613 * action performed on data -- it is the generic action you can use on
614 * a piece of data to get the most reasonable thing to occur. For example,
615 * when used on a contacts entry it will view the entry; when used on a
616 * mailto: URI it will bring up a compose window filled with the information
617 * supplied by the URI; when used with a tel: URI it will invoke the
618 * dialer.
619 * <p>Input: {@link #getData} is URI from which to retrieve data.
620 * <p>Output: nothing.
621 */
622 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
623 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700625 /**
626 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
627 * performed on a piece of data.
628 */
629 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800630
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700631 /**
632 * Used to indicate that some piece of data should be attached to some other
633 * place. For example, image data could be attached to a contact. It is up
634 * to the recipient to decide where the data should be attached; the intent
635 * does not specify the ultimate destination.
636 * <p>Input: {@link #getData} is URI of data to be attached.
637 * <p>Output: nothing.
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Provide explicit editable access to the given data.
644 * <p>Input: {@link #getData} is URI of data to be edited.
645 * <p>Output: nothing.
646 */
647 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
648 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700650 /**
651 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
652 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
653 * The extras can contain type specific data to pass through to the editing/creating
654 * activity.
655 * <p>Output: The URI of the item that was picked. This must be a content:
656 * URI so that any receiver can access it.
657 */
658 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
659 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
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: Pick an item from the data, returning what was selected.
663 * <p>Input: {@link #getData} is URI containing a directory of data
664 * (vnd.android.cursor.dir/*) from which to pick an item.
665 * <p>Output: The URI of the item that was picked.
666 */
667 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
668 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800669
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 /**
671 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800672 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700673 * <p>Output: An Intent representing the shortcut. The intent must contain three
674 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
675 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676 * (value: ShortcutIconResource).</p>
677 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700678 * @see #EXTRA_SHORTCUT_INTENT
679 * @see #EXTRA_SHORTCUT_NAME
680 * @see #EXTRA_SHORTCUT_ICON
681 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
682 * @see android.content.Intent.ShortcutIconResource
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
686
687 /**
688 * The name of the extra used to define the Intent of a shortcut.
689 *
690 * @see #ACTION_CREATE_SHORTCUT
691 */
692 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
693 /**
694 * The name of the extra used to define the name of a shortcut.
695 *
696 * @see #ACTION_CREATE_SHORTCUT
697 */
698 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
699 /**
700 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
701 *
702 * @see #ACTION_CREATE_SHORTCUT
703 */
704 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
705 /**
706 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
707 *
708 * @see #ACTION_CREATE_SHORTCUT
709 * @see android.content.Intent.ShortcutIconResource
710 */
711 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
712 "android.intent.extra.shortcut.ICON_RESOURCE";
713
714 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800715 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700716 *
717 * @see Intent#ACTION_CREATE_SHORTCUT
718 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800719 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
720 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700721 */
722 public static class ShortcutIconResource implements Parcelable {
723 /**
724 * The package name of the application containing the icon.
725 */
726 public String packageName;
727
728 /**
729 * The resource name of the icon, including package, name and type.
730 */
731 public String resourceName;
732
733 /**
734 * Creates a new ShortcutIconResource for the specified context and resource
735 * identifier.
736 *
737 * @param context The context of the application.
738 * @param resourceId The resource idenfitier for the icon.
739 * @return A new ShortcutIconResource with the specified's context package name
740 * and icon resource idenfitier.
741 */
742 public static ShortcutIconResource fromContext(Context context, int resourceId) {
743 ShortcutIconResource icon = new ShortcutIconResource();
744 icon.packageName = context.getPackageName();
745 icon.resourceName = context.getResources().getResourceName(resourceId);
746 return icon;
747 }
748
749 /**
750 * Used to read a ShortcutIconResource from a Parcel.
751 */
752 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
753 new Parcelable.Creator<ShortcutIconResource>() {
754
755 public ShortcutIconResource createFromParcel(Parcel source) {
756 ShortcutIconResource icon = new ShortcutIconResource();
757 icon.packageName = source.readString();
758 icon.resourceName = source.readString();
759 return icon;
760 }
761
762 public ShortcutIconResource[] newArray(int size) {
763 return new ShortcutIconResource[size];
764 }
765 };
766
767 /**
768 * No special parcel contents.
769 */
770 public int describeContents() {
771 return 0;
772 }
773
774 public void writeToParcel(Parcel dest, int flags) {
775 dest.writeString(packageName);
776 dest.writeString(resourceName);
777 }
778
779 @Override
780 public String toString() {
781 return resourceName;
782 }
783 }
784
785 /**
786 * Activity Action: Display an activity chooser, allowing the user to pick
787 * what they want to before proceeding. This can be used as an alternative
788 * to the standard activity picker that is displayed by the system when
789 * you try to start an activity with multiple possible matches, with these
790 * differences in behavior:
791 * <ul>
792 * <li>You can specify the title that will appear in the activity chooser.
793 * <li>The user does not have the option to make one of the matching
794 * activities a preferred activity, and all possible activities will
795 * always be shown even if one of them is currently marked as the
796 * preferred activity.
797 * </ul>
798 * <p>
799 * This action should be used when the user will naturally expect to
800 * select an activity in order to proceed. An example if when not to use
801 * it is when the user clicks on a "mailto:" link. They would naturally
802 * expect to go directly to their mail app, so startActivity() should be
803 * called directly: it will
804 * either launch the current preferred app, or put up a dialog allowing the
805 * user to pick an app to use and optionally marking that as preferred.
806 * <p>
807 * In contrast, if the user is selecting a menu item to send a picture
808 * they are viewing to someone else, there are many different things they
809 * may want to do at this point: send it through e-mail, upload it to a
810 * web service, etc. In this case the CHOOSER action should be used, to
811 * always present to the user a list of the things they can do, with a
812 * nice title given by the caller such as "Send this photo with:".
813 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700814 * If you need to grant URI permissions through a chooser, you must specify
815 * the permissions to be granted on the ACTION_CHOOSER Intent
816 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
817 * {@link #setClipData} to specify the URIs to be granted as well as
818 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
819 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
820 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700821 * As a convenience, an Intent of this form can be created with the
822 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700824 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700825 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
826 * and can optionally have a {@link #EXTRA_TITLE} field containing the
827 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700828 * <p>
829 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700830 */
831 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
832 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
833
834 /**
835 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
836 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700837 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
838 * target intent, also optionally supplying a title. If the target
839 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
840 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
841 * set in the returned chooser intent, with its ClipData set appropriately:
842 * either a direct reflection of {@link #getClipData()} if that is non-null,
843 * or a new ClipData build from {@link #getData()}.
844 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700845 * @param target The Intent that the user will be selecting an activity
846 * to perform.
847 * @param title Optional title that will be displayed in the chooser.
848 * @return Return a new Intent object that you can hand to
849 * {@link Context#startActivity(Intent) Context.startActivity()} and
850 * related methods.
851 */
852 public static Intent createChooser(Intent target, CharSequence title) {
853 Intent intent = new Intent(ACTION_CHOOSER);
854 intent.putExtra(EXTRA_INTENT, target);
855 if (title != null) {
856 intent.putExtra(EXTRA_TITLE, title);
857 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700858
859 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700860 int permFlags = target.getFlags()
861 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
862 if (permFlags != 0) {
863 ClipData targetClipData = target.getClipData();
864 if (targetClipData == null && target.getData() != null) {
865 ClipData.Item item = new ClipData.Item(target.getData());
866 String[] mimeTypes;
867 if (target.getType() != null) {
868 mimeTypes = new String[] { target.getType() };
869 } else {
870 mimeTypes = new String[] { };
871 }
872 targetClipData = new ClipData(null, mimeTypes, item);
873 }
874 if (targetClipData != null) {
875 intent.setClipData(targetClipData);
876 intent.addFlags(permFlags);
877 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700878 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700879
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700880 return intent;
881 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700882
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 /**
884 * Activity Action: Allow the user to select a particular kind of data and
885 * return it. This is different than {@link #ACTION_PICK} in that here we
886 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800887 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700888 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900889 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700890 * etc.
891 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900892 * 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 -0700893 * of data, such as a person contact, you set the MIME type to the kind of
894 * data you want and launch it with {@link Context#startActivity(Intent)}.
895 * The system will then launch the best application to select that kind
896 * of data for you.
897 * <p>
898 * You may also be interested in any of a set of types of content the user
899 * can pick. For example, an e-mail application that wants to allow the
900 * user to add an attachment to an e-mail message can use this action to
901 * bring up a list of all of the types of content the user can attach.
902 * <p>
903 * In this case, you should wrap the GET_CONTENT intent with a chooser
904 * (through {@link #createChooser}), which will give the proper interface
905 * for the user to pick how to send your data and allow you to specify
906 * a prompt indicating what they are doing. You will usually specify a
907 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
908 * broad range of content types the user can select from.
909 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900910 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700911 * only pick from data that can be represented as a stream. This is
912 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
913 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800914 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900915 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800916 * is locally available on the device. For example, if this extra is set
917 * to true then an image picker should not show any pictures that are available
918 * from a remote server but not already on the local device (thus requiring
919 * they be downloaded when opened).
920 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800921 * If the caller can handle multiple returned items (the user performing
922 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
923 * to indicate this.
924 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700925 * Input: {@link #getType} is the desired MIME type to retrieve. Note
926 * that no URI is supplied in the intent, as there are no constraints on
927 * where the returned data originally comes from. You may also include the
928 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800929 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800930 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
931 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700932 * <p>
933 * Output: The URI of the item that was picked. This must be a content:
934 * URI so that any receiver can access it.
935 */
936 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
937 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
938 /**
939 * Activity Action: Dial a number as specified by the data. This shows a
940 * UI with the number being dialed, allowing the user to explicitly
941 * initiate the call.
942 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
943 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
944 * number.
945 * <p>Output: nothing.
946 */
947 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
948 public static final String ACTION_DIAL = "android.intent.action.DIAL";
949 /**
950 * Activity Action: Perform a call to someone specified by the data.
951 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
952 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
953 * number.
954 * <p>Output: nothing.
955 *
956 * <p>Note: there will be restrictions on which applications can initiate a
957 * call; most applications should use the {@link #ACTION_DIAL}.
958 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
959 * numbers. Applications can <strong>dial</strong> emergency numbers using
960 * {@link #ACTION_DIAL}, however.
961 */
962 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
963 public static final String ACTION_CALL = "android.intent.action.CALL";
964 /**
965 * Activity Action: Perform a call to an emergency number specified by the
966 * data.
967 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
968 * tel: URI of an explicit phone number.
969 * <p>Output: nothing.
970 * @hide
971 */
972 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
973 /**
974 * Activity action: Perform a call to any number (emergency or not)
975 * specified by the data.
976 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
977 * tel: URI of an explicit phone number.
978 * <p>Output: nothing.
979 * @hide
980 */
981 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
982 /**
983 * Activity Action: Send a message to someone specified by the data.
984 * <p>Input: {@link #getData} is URI describing the target.
985 * <p>Output: nothing.
986 */
987 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
988 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
989 /**
990 * Activity Action: Deliver some data to someone else. Who the data is
991 * being delivered to is not specified; it is up to the receiver of this
992 * action to ask the user where the data should be sent.
993 * <p>
994 * When launching a SEND intent, you should usually wrap it in a chooser
995 * (through {@link #createChooser}), which will give the proper interface
996 * for the user to pick how to send your data and allow you to specify
997 * a prompt indicating what they are doing.
998 * <p>
999 * Input: {@link #getType} is the MIME type of the data being sent.
1000 * get*Extra can have either a {@link #EXTRA_TEXT}
1001 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1002 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1003 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1004 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001005 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1006 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1007 * your text with HTML formatting.
1008 * <p>
1009 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1010 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1011 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1012 * content: URIs and other advanced features of {@link ClipData}. If
1013 * using this approach, you still must supply the same data through the
1014 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1015 * for compatibility with old applications. If you don't set a ClipData,
1016 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 * <p>
1018 * Optional standard extras, which may be interpreted by some recipients as
1019 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1020 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1021 * <p>
1022 * Output: nothing.
1023 */
1024 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1025 public static final String ACTION_SEND = "android.intent.action.SEND";
1026 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001027 * Activity Action: Deliver multiple data to someone else.
1028 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001029 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * <p>
1031 * Input: {@link #getType} is the MIME type of the data being sent.
1032 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001033 * #EXTRA_STREAM} field, containing the data to be sent. If using
1034 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1035 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001036 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001037 * Multiple types are supported, and receivers should handle mixed types
1038 * whenever possible. The right way for the receiver to check them is to
1039 * use the content resolver on each URI. The intent sender should try to
1040 * put the most concrete mime type in the intent type, but it can fall
1041 * back to {@literal <type>/*} or {@literal *}/* as needed.
1042 * <p>
1043 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1044 * be image/jpg, but if you are sending image/jpg and image/png, then the
1045 * intent's type should be image/*.
1046 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001047 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1048 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1049 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1050 * content: URIs and other advanced features of {@link ClipData}. If
1051 * using this approach, you still must supply the same data through the
1052 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1053 * for compatibility with old applications. If you don't set a ClipData,
1054 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1055 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001056 * Optional standard extras, which may be interpreted by some recipients as
1057 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1058 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1059 * <p>
1060 * Output: nothing.
1061 */
1062 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1063 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1064 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001065 * Activity Action: Handle an incoming phone call.
1066 * <p>Input: nothing.
1067 * <p>Output: nothing.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1071 /**
1072 * Activity Action: Insert an empty item into the given container.
1073 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1074 * in which to place the data.
1075 * <p>Output: URI of the new data that was created.
1076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1079 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001080 * Activity Action: Create a new item in the given container, initializing it
1081 * from the current contents of the clipboard.
1082 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1083 * in which to place the data.
1084 * <p>Output: URI of the new data that was created.
1085 */
1086 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1087 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1088 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001089 * Activity Action: Delete the given data from its container.
1090 * <p>Input: {@link #getData} is URI of data to be deleted.
1091 * <p>Output: nothing.
1092 */
1093 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1094 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1095 /**
1096 * Activity Action: Run the data, whatever that means.
1097 * <p>Input: ? (Note: this is currently specific to the test harness.)
1098 * <p>Output: nothing.
1099 */
1100 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1101 public static final String ACTION_RUN = "android.intent.action.RUN";
1102 /**
1103 * Activity Action: Perform a data synchronization.
1104 * <p>Input: ?
1105 * <p>Output: ?
1106 */
1107 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1108 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1109 /**
1110 * Activity Action: Pick an activity given an intent, returning the class
1111 * selected.
1112 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1113 * used with {@link PackageManager#queryIntentActivities} to determine the
1114 * set of activities from which to pick.
1115 * <p>Output: Class name of the activity that was selected.
1116 */
1117 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1118 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1119 /**
1120 * Activity Action: Perform a search.
1121 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1122 * is the text to search for. If empty, simply
1123 * enter your search results Activity with the search UI activated.
1124 * <p>Output: nothing.
1125 */
1126 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1127 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1128 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001129 * Activity Action: Start the platform-defined tutorial
1130 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1131 * is the text to search for. If empty, simply
1132 * enter your search results Activity with the search UI activated.
1133 * <p>Output: nothing.
1134 */
1135 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1136 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1137 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001138 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001139 * <p>
1140 * Input: {@link android.app.SearchManager#QUERY
1141 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1142 * a url starts with http or https, the site will be opened. If it is plain
1143 * text, Google search will be applied.
1144 * <p>
1145 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001149
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001150 /**
Jim Miller07994402012-05-02 14:22:27 -07001151 * Activity Action: Perform assist action.
1152 * <p>
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001153 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1154 * additional optional contextual information about where the user was when they requested
1155 * the assist.
Jim Miller07994402012-05-02 14:22:27 -07001156 * Output: nothing.
1157 */
1158 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1159 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001160
1161 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001162 * Activity Action: Perform voice assist action.
1163 * <p>
1164 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1165 * additional optional contextual information about where the user was when they requested
1166 * the voice assist.
1167 * Output: nothing.
1168 */
1169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1170 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1171
1172 /**
1173 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1174 * containing the name of the current foreground application package at the time
1175 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001176 */
1177 public static final String EXTRA_ASSIST_PACKAGE
1178 = "android.intent.extra.ASSIST_PACKAGE";
1179
1180 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001181 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1182 * containing additional contextual information supplied by the current
1183 * foreground app at the time of the assist request. This is a {@link Bundle} of
1184 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001185 */
1186 public static final String EXTRA_ASSIST_CONTEXT
1187 = "android.intent.extra.ASSIST_CONTEXT";
1188
Jim Miller07994402012-05-02 14:22:27 -07001189 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001190 * Activity Action: List all available applications
1191 * <p>Input: Nothing.
1192 * <p>Output: nothing.
1193 */
1194 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1195 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1196 /**
1197 * Activity Action: Show settings for choosing wallpaper
1198 * <p>Input: Nothing.
1199 * <p>Output: Nothing.
1200 */
1201 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1202 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1203
1204 /**
1205 * Activity Action: Show activity for reporting a bug.
1206 * <p>Input: Nothing.
1207 * <p>Output: Nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1211
1212 /**
1213 * Activity Action: Main entry point for factory tests. Only used when
1214 * the device is booting in factory test node. The implementing package
1215 * must be installed in the system image.
1216 * <p>Input: nothing
1217 * <p>Output: nothing
1218 */
1219 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1220
1221 /**
1222 * Activity Action: The user pressed the "call" button to go to the dialer
1223 * or other appropriate UI for placing a call.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1229
1230 /**
1231 * Activity Action: Start Voice Command.
1232 * <p>Input: Nothing.
1233 * <p>Output: Nothing.
1234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001237
1238 /**
1239 * Activity Action: Start action associated with long pressing on the
1240 * search key.
1241 * <p>Input: Nothing.
1242 * <p>Output: Nothing.
1243 */
1244 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1245 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001246
Jacek Surazski86b6c532009-05-13 14:38:28 +02001247 /**
1248 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1249 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001250 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001251 * <p>Input: No data is specified. The bug report is passed in using
1252 * an {@link #EXTRA_BUG_REPORT} field.
1253 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 *
1255 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001256 */
1257 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1258 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001259
1260 /**
1261 * Activity Action: Show power usage information to the user.
1262 * <p>Input: Nothing.
1263 * <p>Output: Nothing.
1264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001267
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001268 /**
1269 * Activity Action: Setup wizard to launch after a platform update. This
1270 * activity should have a string meta-data field associated with it,
1271 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1272 * the platform for setup. The activity will be launched only if
1273 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1274 * same value.
1275 * <p>Input: Nothing.
1276 * <p>Output: Nothing.
1277 * @hide
1278 */
1279 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1280 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001281
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001282 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001283 * Activity Action: Show settings for managing network data usage of a
1284 * specific application. Applications should define an activity that offers
1285 * options to control data usage.
1286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_MANAGE_NETWORK_USAGE =
1289 "android.intent.action.MANAGE_NETWORK_USAGE";
1290
1291 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001292 * Activity Action: Launch application installer.
1293 * <p>
1294 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001295 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1296 * you can also use "package:<package-name>" to install an application for the
1297 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001298 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1299 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1300 * <p>
1301 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1302 * succeeded.
1303 *
1304 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1305 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1306 * @see #EXTRA_RETURN_RESULT
1307 */
1308 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1309 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1310
1311 /**
1312 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1313 * package. Specifies the installer package name; this package will receive the
1314 * {@link #ACTION_APP_ERROR} intent.
1315 */
1316 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1317 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1318
1319 /**
1320 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1321 * package. Specifies that the application being installed should not be
1322 * treated as coming from an unknown source, but as coming from the app
1323 * invoking the Intent. For this to work you must start the installer with
1324 * startActivityForResult().
1325 */
1326 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1327 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1328
1329 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001330 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1331 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001332 * data field originated from.
1333 */
rich cannings706e8ba2012-08-20 13:20:14 -07001334 public static final String EXTRA_ORIGINATING_URI
1335 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001336
1337 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001338 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1339 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1340 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001341 */
1342 public static final String EXTRA_REFERRER
1343 = "android.intent.extra.REFERRER";
1344
1345 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001346 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1347 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1348 * @hide
1349 */
1350 public static final String EXTRA_ORIGINATING_UID
1351 = "android.intent.extra.ORIGINATING_UID";
1352
1353 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001354 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1355 * package. Tells the installer UI to skip the confirmation with the user
1356 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001357 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1358 * will no longer show an interstitial message about updating existing
1359 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001360 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001361 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001362 public static final String EXTRA_ALLOW_REPLACE
1363 = "android.intent.extra.ALLOW_REPLACE";
1364
1365 /**
1366 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1367 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1368 * return to the application the result code of the install/uninstall. The returned result
1369 * code will be {@link android.app.Activity#RESULT_OK} on success or
1370 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1371 */
1372 public static final String EXTRA_RETURN_RESULT
1373 = "android.intent.extra.RETURN_RESULT";
1374
1375 /**
1376 * Package manager install result code. @hide because result codes are not
1377 * yet ready to be exposed.
1378 */
1379 public static final String EXTRA_INSTALL_RESULT
1380 = "android.intent.extra.INSTALL_RESULT";
1381
1382 /**
1383 * Activity Action: Launch application uninstaller.
1384 * <p>
1385 * Input: The data must be a package: URI whose scheme specific part is
1386 * the package name of the current installed package to be uninstalled.
1387 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1388 * <p>
1389 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1390 * succeeded.
1391 */
1392 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1393 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1394
1395 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001396 * Specify whether the package should be uninstalled for all users.
1397 * @hide because these should not be part of normal application flow.
1398 */
1399 public static final String EXTRA_UNINSTALL_ALL_USERS
1400 = "android.intent.extra.UNINSTALL_ALL_USERS";
1401
1402 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001403 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1404 * describing the last run version of the platform that was setup.
1405 * @hide
1406 */
1407 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1408
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001409 // ---------------------------------------------------------------------
1410 // ---------------------------------------------------------------------
1411 // Standard intent broadcast actions (see action variable).
1412
1413 /**
1414 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001415 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001416 * <p class="note">This is a protected intent that can only be sent
1417 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001418 */
1419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1420 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1421 /**
1422 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001423 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001424 * <p class="note">This is a protected intent that can only be sent
1425 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001426 */
1427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1428 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001429
1430 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001431 * Broadcast Action: Sent after the system stops dreaming.
1432 *
1433 * <p class="note">This is a protected intent that can only be sent by the system.
1434 * It is only sent to registered receivers.</p>
1435 */
1436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1437 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1438
1439 /**
1440 * Broadcast Action: Sent after the system starts dreaming.
1441 *
1442 * <p class="note">This is a protected intent that can only be sent by the system.
1443 * It is only sent to registered receivers.</p>
1444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1446 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1447
1448 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001449 * 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 -07001450 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001451 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001452 * <p class="note">This is a protected intent that can only be sent
1453 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001454 */
1455 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001456 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001457
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001458 /**
1459 * Broadcast Action: The current time has changed. Sent every
1460 * minute. You can <em>not</em> receive this through components declared
1461 * in manifests, only by exlicitly registering for it with
1462 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1463 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001464 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001465 * <p class="note">This is a protected intent that can only be sent
1466 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001467 */
1468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1469 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1470 /**
1471 * Broadcast Action: The time was set.
1472 */
1473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1474 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1475 /**
1476 * Broadcast Action: The date has changed.
1477 */
1478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1479 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1480 /**
1481 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1482 * <ul>
1483 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1484 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001485 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001486 * <p class="note">This is a protected intent that can only be sent
1487 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001488 */
1489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1490 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1491 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001492 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1493 * DNS entries should be tossed.
1494 * @hide
1495 */
1496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1497 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1498 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001499 * Alarm Changed Action: This is broadcast when the AlarmClock
1500 * application's alarm is set or unset. It is used by the
1501 * AlarmClock application and the StatusBar service.
1502 * @hide
1503 */
1504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1505 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1506 /**
1507 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1508 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1509 * @hide
1510 */
1511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1512 public static final String ACTION_SYNC_STATE_CHANGED
1513 = "android.intent.action.SYNC_STATE_CHANGED";
1514 /**
1515 * Broadcast Action: This is broadcast once, after the system has finished
1516 * booting. It can be used to perform application-specific initialization,
1517 * such as installing alarms. You must hold the
1518 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1519 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001520 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001521 * <p class="note">This is a protected intent that can only be sent
1522 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001523 */
1524 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1525 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1526 /**
1527 * Broadcast Action: This is broadcast when a user action should request a
1528 * temporary system dialog to dismiss. Some examples of temporary system
1529 * dialogs are the notification window-shade and the recent tasks dialog.
1530 */
1531 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1532 /**
1533 * Broadcast Action: Trigger the download and eventual installation
1534 * of a package.
1535 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001536 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001537 * <p class="note">This is a protected intent that can only be sent
1538 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001539 *
1540 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001541 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001542 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001543 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1544 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1545 /**
1546 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001547 * device. The data contains the name of the package. Note that the
1548 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001549 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001550 * <ul>
1551 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1552 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1553 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1554 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001555 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001556 * <p class="note">This is a protected intent that can only be sent
1557 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001558 */
1559 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1560 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1561 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001562 * Broadcast Action: A new version of an application package has been
1563 * installed, replacing an existing version that was previously installed.
1564 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001565 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001566 * <ul>
1567 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1568 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001569 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001570 * <p class="note">This is a protected intent that can only be sent
1571 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001572 */
1573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1574 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1575 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001576 * Broadcast Action: A new version of your application has been installed
1577 * over an existing one. This is only sent to the application that was
1578 * replaced. It does not contain any additional data; to receive it, just
1579 * use an intent filter for this action.
1580 *
1581 * <p class="note">This is a protected intent that can only be sent
1582 * by the system.
1583 */
1584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1585 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1586 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001587 * Broadcast Action: An existing application package has been removed from
1588 * the device. The data contains the name of the package. The package
1589 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001590 * <ul>
1591 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1592 * to the package.
1593 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1594 * application -- data and code -- is being removed.
1595 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1596 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1597 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001598 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001599 * <p class="note">This is a protected intent that can only be sent
1600 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001601 */
1602 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1603 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1604 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001605 * Broadcast Action: An existing application package has been completely
1606 * removed from the device. The data contains the name of the package.
1607 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1608 * {@link #EXTRA_DATA_REMOVED} is true and
1609 * {@link #EXTRA_REPLACING} is false of that broadcast.
1610 *
1611 * <ul>
1612 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1613 * to the package.
1614 * </ul>
1615 *
1616 * <p class="note">This is a protected intent that can only be sent
1617 * by the system.
1618 */
1619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1620 public static final String ACTION_PACKAGE_FULLY_REMOVED
1621 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1622 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001623 * Broadcast Action: An existing application package has been changed (e.g.
1624 * a component has been enabled or disabled). The data contains the name of
1625 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001626 * <ul>
1627 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001628 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001629 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001630 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1631 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001632 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001633 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001634 * <p class="note">This is a protected intent that can only be sent
1635 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1639 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001640 * @hide
1641 * Broadcast Action: Ask system services if there is any reason to
1642 * restart the given package. The data contains the name of the
1643 * package.
1644 * <ul>
1645 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1646 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1647 * </ul>
1648 *
1649 * <p class="note">This is a protected intent that can only be sent
1650 * by the system.
1651 */
1652 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1653 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1654 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001655 * Broadcast Action: The user has restarted a package, and all of its
1656 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001657 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001658 * be removed. Note that the restarted package does <em>not</em>
1659 * receive this broadcast.
1660 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001661 * <ul>
1662 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1663 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001664 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001665 * <p class="note">This is a protected intent that can only be sent
1666 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001667 */
1668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1669 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1670 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001671 * Broadcast Action: The user has cleared the data of a package. This should
1672 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001673 * its persistent data is erased and this broadcast sent.
1674 * Note that the cleared package does <em>not</em>
1675 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001676 * <ul>
1677 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1678 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001679 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001680 * <p class="note">This is a protected intent that can only be sent
1681 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 */
1683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1684 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001686 * Broadcast Action: A user ID has been removed from the system. The user
1687 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001688 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001689 * <p class="note">This is a protected intent that can only be sent
1690 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001691 */
1692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1693 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001694
1695 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001696 * Broadcast Action: Sent to the installer package of an application
1697 * when that application is first launched (that is the first time it
1698 * is moved out of the stopped state). The data contains the name of the package.
1699 *
1700 * <p class="note">This is a protected intent that can only be sent
1701 * by the system.
1702 */
1703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1704 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1705
1706 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001707 * Broadcast Action: Sent to the system package verifier when a package
1708 * needs to be verified. The data contains the package URI.
1709 * <p class="note">
1710 * This is a protected intent that can only be sent by the system.
1711 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001712 */
1713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1714 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1715
1716 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001717 * Broadcast Action: Sent to the system package verifier when a package is
1718 * verified. The data contains the package URI.
1719 * <p class="note">
1720 * This is a protected intent that can only be sent by the system.
1721 */
1722 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1723 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1724
1725 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001726 * Broadcast Action: Resources for a set of packages (which were
1727 * previously unavailable) are currently
1728 * available since the media on which they exist is available.
1729 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1730 * list of packages whose availability changed.
1731 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1732 * list of uids of packages whose availability changed.
1733 * Note that the
1734 * packages in this list do <em>not</em> receive this broadcast.
1735 * The specified set of packages are now available on the system.
1736 * <p>Includes the following extras:
1737 * <ul>
1738 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1739 * whose resources(were previously unavailable) are currently available.
1740 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1741 * packages whose resources(were previously unavailable)
1742 * are currently available.
1743 * </ul>
1744 *
1745 * <p class="note">This is a protected intent that can only be sent
1746 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001749 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1750 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001751
1752 /**
1753 * Broadcast Action: Resources for a set of packages are currently
1754 * unavailable since the media on which they exist is unavailable.
1755 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1756 * list of packages whose availability changed.
1757 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1758 * list of uids of packages whose availability changed.
1759 * The specified set of packages can no longer be
1760 * launched and are practically unavailable on the system.
1761 * <p>Inclues the following extras:
1762 * <ul>
1763 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1764 * whose resources are no longer available.
1765 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1766 * whose resources are no longer available.
1767 * </ul>
1768 *
1769 * <p class="note">This is a protected intent that can only be sent
1770 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001773 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001774 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001775
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001776 /**
1777 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001778 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001779 * This should <em>only</em> be used to determine when the wallpaper
1780 * has changed to show the new wallpaper to the user. You should certainly
1781 * never, in response to this, change the wallpaper or other attributes of
1782 * it such as the suggested size. That would be crazy, right? You'd cause
1783 * all kinds of loops, especially if other apps are doing similar things,
1784 * right? Of course. So please don't do this.
1785 *
1786 * @deprecated Modern applications should use
1787 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1788 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1789 * shown behind their UI, rather than watching for this broadcast and
1790 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001791 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001792 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1794 /**
1795 * Broadcast Action: The current device {@link android.content.res.Configuration}
1796 * (orientation, locale, etc) has changed. When such a change happens, the
1797 * UIs (view hierarchy) will need to be rebuilt based on this new
1798 * information; for the most part, applications don't need to worry about
1799 * this, because the system will take care of stopping and restarting the
1800 * application to make sure it sees the new changes. Some system code that
1801 * can not be restarted will need to watch for this action and handle it
1802 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001803 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001804 * <p class="note">
1805 * You can <em>not</em> receive this through components declared
1806 * in manifests, only by explicitly registering for it with
1807 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1808 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001809 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001810 * <p class="note">This is a protected intent that can only be sent
1811 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001812 *
1813 * @see android.content.res.Configuration
1814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1817 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001818 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001819 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001820 * <p class="note">This is a protected intent that can only be sent
1821 * by the system.
1822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1824 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1825 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001826 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1827 * charging state, level, and other information about the battery.
1828 * See {@link android.os.BatteryManager} for documentation on the
1829 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001830 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001831 * <p class="note">
1832 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001833 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001834 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001835 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1836 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1837 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1838 * broadcasts that are sent and can be received through manifest
1839 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001840 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001841 * <p class="note">This is a protected intent that can only be sent
1842 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001843 */
1844 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1845 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1846 /**
1847 * Broadcast Action: Indicates low battery condition on the device.
1848 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001849 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001850 * <p class="note">This is a protected intent that can only be sent
1851 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001852 */
1853 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1854 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1855 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001856 * Broadcast Action: Indicates the battery is now okay after being low.
1857 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1858 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001859 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001860 * <p class="note">This is a protected intent that can only be sent
1861 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001862 */
1863 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1864 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1865 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001866 * Broadcast Action: External power has been connected to the device.
1867 * This is intended for applications that wish to register specifically to this notification.
1868 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1869 * stay active to receive this notification. This action can be used to implement actions
1870 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001871 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001872 * <p class="note">This is a protected intent that can only be sent
1873 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001876 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001877 /**
1878 * Broadcast Action: External power has been removed from the device.
1879 * This is intended for applications that wish to register specifically to this notification.
1880 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1881 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001882 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001883 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001884 * <p class="note">This is a protected intent that can only be sent
1885 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001886 */
1887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001888 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001889 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001890 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001891 * Broadcast Action: Device is shutting down.
1892 * This is broadcast when the device is being shut down (completely turned
1893 * off, not sleeping). Once the broadcast is complete, the final shutdown
1894 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001895 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001896 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001897 * <p class="note">This is a protected intent that can only be sent
1898 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001899 */
1900 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001901 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001902 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001903 * Activity Action: Start this activity to request system shutdown.
1904 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1905 * to request confirmation from the user before shutting down.
1906 *
1907 * <p class="note">This is a protected intent that can only be sent
1908 * by the system.
1909 *
1910 * {@hide}
1911 */
1912 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1913 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001914 * Broadcast Action: A sticky broadcast that indicates low memory
1915 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001916 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001917 * <p class="note">This is a protected intent that can only be sent
1918 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1922 /**
1923 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001924 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001925 * <p class="note">This is a protected intent that can only be sent
1926 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001927 */
1928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1929 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1930 /**
Jake Hambybb371632010-08-23 18:16:48 -07001931 * Broadcast Action: A sticky broadcast that indicates a memory full
1932 * condition on the device. This is intended for activities that want
1933 * to be able to fill the data partition completely, leaving only
1934 * enough free space to prevent system-wide SQLite failures.
1935 *
1936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
1938 *
1939 * {@hide}
1940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1943 /**
1944 * Broadcast Action: Indicates memory full condition on the device
1945 * no longer exists.
1946 *
1947 * <p class="note">This is a protected intent that can only be sent
1948 * by the system.
1949 *
1950 * {@hide}
1951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1954 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001955 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1956 * and package management should be started.
1957 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1958 * notification.
1959 */
1960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1961 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1962 /**
1963 * Broadcast Action: The device has entered USB Mass Storage mode.
1964 * This is used mainly for the USB Settings panel.
1965 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1966 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001967 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001968 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001969 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001970 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1971
1972 /**
1973 * Broadcast Action: The device has exited USB Mass Storage mode.
1974 * This is used mainly for the USB Settings panel.
1975 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1976 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001977 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001978 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001979 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1981
1982 /**
1983 * Broadcast Action: External media has been removed.
1984 * The path to the mount point for the removed media is contained in the Intent.mData field.
1985 */
1986 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1987 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1988
1989 /**
1990 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001991 * 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 -07001992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1995
1996 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001997 * Broadcast Action: External media is present, and being disk-checked
1998 * 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 -08001999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2002
2003 /**
2004 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2005 * 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 -08002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2009
2010 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002011 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002012 * 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 -07002013 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2014 * media was mounted read only.
2015 */
2016 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2017 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2018
2019 /**
2020 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002021 * 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 -07002022 */
2023 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2024 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2025
2026 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002027 * Broadcast Action: External media is no longer being shared via USB mass storage.
2028 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2029 *
2030 * @hide
2031 */
2032 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2033
2034 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2036 * The path to the mount point for the removed media is contained in the Intent.mData field.
2037 */
2038 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2039 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2040
2041 /**
2042 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002043 * 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 -07002044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2047
2048 /**
2049 * Broadcast Action: User has expressed the desire to remove the external storage media.
2050 * Applications should close all files they have open within the mount point when they receive this intent.
2051 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2055
2056 /**
2057 * Broadcast Action: The media scanner has started scanning a directory.
2058 * The path to the directory being scanned is contained in the Intent.mData field.
2059 */
2060 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2061 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2062
2063 /**
2064 * Broadcast Action: The media scanner has finished scanning a directory.
2065 * The path to the scanned directory is contained in the Intent.mData field.
2066 */
2067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2068 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2069
2070 /**
2071 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2072 * The path to the file is contained in the Intent.mData field.
2073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2076
2077 /**
2078 * Broadcast Action: The "Media Button" was pressed. Includes a single
2079 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2080 * caused the broadcast.
2081 */
2082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2083 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2084
2085 /**
2086 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2087 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2088 * caused the broadcast.
2089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2092
2093 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2094 // location; they are not general-purpose actions.
2095
2096 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002097 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2101 "android.intent.action.GTALK_CONNECTED";
2102
2103 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002104 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2108 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002109
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002110 /**
2111 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002112 */
2113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_INPUT_METHOD_CHANGED =
2115 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116
2117 /**
2118 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2119 * more radios have been turned off or on. The intent will have the following extra value:</p>
2120 * <ul>
2121 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2122 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2123 * turned off</li>
2124 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002125 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002126 * <p class="note">This is a protected intent that can only be sent
2127 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2131
2132 /**
2133 * Broadcast Action: Some content providers have parts of their namespace
2134 * where they publish new events or items that the user may be especially
2135 * interested in. For these things, they may broadcast this action when the
2136 * set of interesting items change.
2137 *
2138 * For example, GmailProvider sends this notification when the set of unread
2139 * mail in the inbox changes.
2140 *
2141 * <p>The data of the intent identifies which part of which provider
2142 * changed. When queried through the content resolver, the data URI will
2143 * return the data set in question.
2144 *
2145 * <p>The intent will have the following extra values:
2146 * <ul>
2147 * <li><em>count</em> - The number of items in the data set. This is the
2148 * same as the number of items in the cursor returned by querying the
2149 * data URI. </li>
2150 * </ul>
2151 *
2152 * This intent will be sent at boot (if the count is non-zero) and when the
2153 * data set changes. It is possible for the data set to change without the
2154 * count changing (for example, if a new unread message arrives in the same
2155 * sync operation in which a message is archived). The phone should still
2156 * ring/vibrate/etc as normal in this case.
2157 */
2158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2159 public static final String ACTION_PROVIDER_CHANGED =
2160 "android.intent.action.PROVIDER_CHANGED";
2161
2162 /**
2163 * Broadcast Action: Wired Headset plugged in or unplugged.
2164 *
2165 * <p>The intent will have the following extra values:
2166 * <ul>
2167 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2168 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002169 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002170 * </ul>
2171 * </ul>
2172 */
2173 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2174 public static final String ACTION_HEADSET_PLUG =
2175 "android.intent.action.HEADSET_PLUG";
2176
2177 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002178 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2179 *
2180 * <p>The intent will have the following extra values:
2181 * <ul>
2182 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2183 * <li><em>name</em> - Headset type, human readable string </li>
2184 * </ul>
2185 * </ul>
2186 * @hide
2187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002189 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2190 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002191
2192 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002193 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002194 *
2195 * <p>The intent will have the following extra values:
2196 * <ul>
2197 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2198 * <li><em>name</em> - Headset type, human readable string </li>
2199 * </ul>
2200 * </ul>
2201 * @hide
2202 */
2203 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002204 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2205 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002206
2207 /**
2208 * Broadcast Action: A HMDI cable was plugged or unplugged
2209 *
2210 * <p>The intent will have the following extra values:
2211 * <ul>
2212 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2213 * <li><em>name</em> - HDMI cable, human readable string </li>
2214 * </ul>
2215 * </ul>
2216 * @hide
2217 */
2218 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2219 public static final String ACTION_HDMI_AUDIO_PLUG =
2220 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002221
2222 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002223 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2224 *
2225 * <p>The intent will have the following extra values:
2226 * <ul>
2227 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2228 * <li><em>card</em> - ALSA card number (integer) </li>
2229 * <li><em>device</em> - ALSA device number (integer) </li>
2230 * </ul>
2231 * </ul>
2232 * @hide
2233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2236 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2237
2238 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002239 * Broadcast Action: A USB audio device was plugged in or unplugged.
2240 *
2241 * <p>The intent will have the following extra values:
2242 * <ul>
2243 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2244 * <li><em>card</em> - ALSA card number (integer) </li>
2245 * <li><em>device</em> - ALSA device number (integer) </li>
2246 * </ul>
2247 * </ul>
2248 * @hide
2249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2251 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2252 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2253
2254 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002255 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2256 * <ul>
2257 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2258 * </ul>
2259 *
2260 * <p class="note">This is a protected intent that can only be sent
2261 * by the system.
2262 *
2263 * @hide
2264 */
2265 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2267 = "android.intent.action.ADVANCED_SETTINGS";
2268
2269 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002270 * Broadcast Action: An outgoing call is about to be placed.
2271 *
2272 * <p>The Intent will have the following extra value:
2273 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002274 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 * the phone number originally intended to be dialed.</li>
2276 * </ul>
2277 * <p>Once the broadcast is finished, the resultData is used as the actual
2278 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002279 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002280 * outgoing call in turn: for example, a parental control application
2281 * might verify that the user is authorized to place the call at that
2282 * time, then a number-rewriting application might add an area code if
2283 * one was not specified.</p>
2284 * <p>For consistency, any receiver whose purpose is to prohibit phone
2285 * calls should have a priority of 0, to ensure it will see the final
2286 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002287 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288 * should have a positive priority.
2289 * Negative priorities are reserved for the system for this broadcast;
2290 * using them may cause problems.</p>
2291 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2292 * abort the broadcast.</p>
2293 * <p>Emergency calls cannot be intercepted using this mechanism, and
2294 * other calls cannot be modified to call emergency numbers using this
2295 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002296 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002297 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2298 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002299 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002300 * <p class="note">This is a protected intent that can only be sent
2301 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 */
2303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2304 public static final String ACTION_NEW_OUTGOING_CALL =
2305 "android.intent.action.NEW_OUTGOING_CALL";
2306
2307 /**
2308 * Broadcast Action: Have the device reboot. This is only for use by
2309 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002310 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002311 * <p class="note">This is a protected intent that can only be sent
2312 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002313 */
2314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2315 public static final String ACTION_REBOOT =
2316 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002317
Wei Huang97ecc9c2009-05-11 17:44:20 -07002318 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002319 * Broadcast Action: A sticky broadcast for changes in the physical
2320 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002321 *
2322 * <p>The intent will have the following extra values:
2323 * <ul>
2324 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002325 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002326 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002327 * <p>This is intended for monitoring the current physical dock state.
2328 * See {@link android.app.UiModeManager} for the normal API dealing with
2329 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002330 */
2331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2332 public static final String ACTION_DOCK_EVENT =
2333 "android.intent.action.DOCK_EVENT";
2334
2335 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002336 * Broadcast Action: A broadcast when idle maintenance can be started.
2337 * This means that the user is not interacting with the device and is
2338 * not expected to do so soon. Typical use of the idle maintenance is
2339 * to perform somehow expensive tasks that can be postponed at a moment
2340 * when they will not degrade user experience.
2341 * <p>
2342 * <p class="note">In order to keep the device responsive in case of an
2343 * unexpected user interaction, implementations of a maintenance task
2344 * should be interruptible. In such a scenario a broadcast with action
2345 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2346 * should not do the maintenance work in
2347 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2348 * maintenance service by {@link Context#startService(Intent)}. Also
2349 * you should hold a wake lock while your maintenance service is running
2350 * to prevent the device going to sleep.
2351 * </p>
2352 * <p>
2353 * <p class="note">This is a protected intent that can only be sent by
2354 * the system.
2355 * </p>
2356 *
2357 * @see #ACTION_IDLE_MAINTENANCE_END
2358 */
2359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2360 public static final String ACTION_IDLE_MAINTENANCE_START =
2361 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2362
2363 /**
2364 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2365 * This means that the user was not interacting with the device as a result
2366 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2367 * was sent and now the user started interacting with the device. Typical
2368 * use of the idle maintenance is to perform somehow expensive tasks that
2369 * can be postponed at a moment when they will not degrade user experience.
2370 * <p>
2371 * <p class="note">In order to keep the device responsive in case of an
2372 * unexpected user interaction, implementations of a maintenance task
2373 * should be interruptible. Hence, on receiving a broadcast with this
2374 * action, the maintenance task should be interrupted as soon as possible.
2375 * In other words, you should not do the maintenance work in
2376 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2377 * maintenance service that was started on receiving of
2378 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2379 * lock you acquired when your maintenance service started.
2380 * </p>
2381 * <p class="note">This is a protected intent that can only be sent
2382 * by the system.
2383 *
2384 * @see #ACTION_IDLE_MAINTENANCE_START
2385 */
2386 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2387 public static final String ACTION_IDLE_MAINTENANCE_END =
2388 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2389
2390 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002391 * Broadcast Action: a remote intent is to be broadcasted.
2392 *
2393 * A remote intent is used for remote RPC between devices. The remote intent
2394 * is serialized and sent from one device to another device. The receiving
2395 * device parses the remote intent and broadcasts it. Note that anyone can
2396 * broadcast a remote intent. However, if the intent receiver of the remote intent
2397 * does not trust intent broadcasts from arbitrary intent senders, it should require
2398 * the sender to hold certain permissions so only trusted sender's broadcast will be
2399 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002400 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002401 */
2402 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002403 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002404
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002405 /**
2406 * Broadcast Action: hook for permforming cleanup after a system update.
2407 *
2408 * The broadcast is sent when the system is booting, before the
2409 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2410 * image. A receiver for this should do its work and then disable itself
2411 * so that it does not get run again at the next boot.
2412 * @hide
2413 */
2414 public static final String ACTION_PRE_BOOT_COMPLETED =
2415 "android.intent.action.PRE_BOOT_COMPLETED";
2416
Amith Yamasani13593602012-03-22 16:16:17 -07002417 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002418 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani86118ba2013-03-28 14:33:16 -07002419 * on restricted users. The response should contain an extra {@link #EXTRA_RESTRICTIONS},
2420 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2421 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2422 * The activity specified by that intent will be launched for a result which must contain
2423 * the extra {@link #EXTRA_RESTRICTIONS}. The returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002424 * @see RestrictionEntry
2425 */
2426 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2427 "android.intent.action.GET_RESTRICTION_ENTRIES";
2428
2429 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002430 * Sent the first time a user is starting, to allow system apps to
2431 * perform one time initialization. (This will not be seen by third
2432 * party applications because a newly initialized user does not have any
2433 * third party applications installed for it.) This is sent early in
2434 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002435 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2436 * broadcast, since it is part of a visible user interaction; be as quick
2437 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002438 */
2439 public static final String ACTION_USER_INITIALIZE =
2440 "android.intent.action.USER_INITIALIZE";
2441
2442 /**
2443 * Sent when a user switch is happening, causing the process's user to be
2444 * brought to the foreground. This is only sent to receivers registered
2445 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2446 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002447 * foreground. This is sent as a foreground
2448 * broadcast, since it is part of a visible user interaction; be as quick
2449 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002450 */
2451 public static final String ACTION_USER_FOREGROUND =
2452 "android.intent.action.USER_FOREGROUND";
2453
2454 /**
2455 * Sent when a user switch is happening, causing the process's user to be
2456 * sent to the background. This is only sent to receivers registered
2457 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2458 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002459 * background. This is sent as a foreground
2460 * broadcast, since it is part of a visible user interaction; be as quick
2461 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002462 */
2463 public static final String ACTION_USER_BACKGROUND =
2464 "android.intent.action.USER_BACKGROUND";
2465
2466 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002467 * Broadcast sent to the system when a user is added. Carries an extra
2468 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2469 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002470 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002471 * @hide
2472 */
2473 public static final String ACTION_USER_ADDED =
2474 "android.intent.action.USER_ADDED";
2475
2476 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002477 * Broadcast sent by the system when a user is started. Carries an extra
2478 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002479 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002480 * that has been started. This is sent as a foreground
2481 * broadcast, since it is part of a visible user interaction; be as quick
2482 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002483 * @hide
2484 */
2485 public static final String ACTION_USER_STARTED =
2486 "android.intent.action.USER_STARTED";
2487
2488 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002489 * Broadcast sent when a user is in the process of starting. Carries an extra
2490 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2491 * sent to registered receivers, not manifest receivers. It is sent to all
2492 * users (including the one that is being started). You must hold
2493 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2494 * this broadcast. This is sent as a background broadcast, since
2495 * its result is not part of the primary UX flow; to safely keep track of
2496 * started/stopped state of a user you can use this in conjunction with
2497 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2498 * other user state broadcasts since those are foreground broadcasts so can
2499 * execute in a different order.
2500 * @hide
2501 */
2502 public static final String ACTION_USER_STARTING =
2503 "android.intent.action.USER_STARTING";
2504
2505 /**
2506 * Broadcast sent when a user is going to be stopped. Carries an extra
2507 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2508 * sent to registered receivers, not manifest receivers. It is sent to all
2509 * users (including the one that is being stopped). You must hold
2510 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2511 * this broadcast. The user will not stop until all receivers have
2512 * handled the broadcast. This is sent as a background broadcast, since
2513 * its result is not part of the primary UX flow; to safely keep track of
2514 * started/stopped state of a user you can use this in conjunction with
2515 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2516 * other user state broadcasts since those are foreground broadcasts so can
2517 * execute in a different order.
2518 * @hide
2519 */
2520 public static final String ACTION_USER_STOPPING =
2521 "android.intent.action.USER_STOPPING";
2522
2523 /**
2524 * Broadcast sent to the system when a user is stopped. Carries an extra
2525 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2526 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2527 * specific package. This is only sent to registered receivers, not manifest
2528 * receivers. It is sent to all running users <em>except</em> the one that
2529 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002530 * @hide
2531 */
2532 public static final String ACTION_USER_STOPPED =
2533 "android.intent.action.USER_STOPPED";
2534
2535 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002536 * 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 -07002537 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002538 * one that has been removed. The user will not be completely removed until all receivers have
2539 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002540 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002541 * @hide
2542 */
2543 public static final String ACTION_USER_REMOVED =
2544 "android.intent.action.USER_REMOVED";
2545
2546 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002547 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002548 * the userHandle of the user to become the current one. This is only sent to
2549 * registered receivers, not manifest receivers. It is sent to all running users.
2550 * You must hold
2551 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002552 * @hide
2553 */
2554 public static final String ACTION_USER_SWITCHED =
2555 "android.intent.action.USER_SWITCHED";
2556
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002557 /**
2558 * Broadcast sent to the system when a user's information changes. Carries an extra
2559 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2560 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2561 * whose information has changed.
2562 * @hide
2563 */
2564 public static final String ACTION_USER_INFO_CHANGED =
2565 "android.intent.action.USER_INFO_CHANGED";
2566
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002567 /**
2568 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2569 */
2570 public static final String ACTION_QUICK_CLOCK =
2571 "android.intent.action.QUICK_CLOCK";
2572
Michael Wright0087a142013-02-05 16:29:39 -08002573 /**
2574 * Broadcast Action: This is broadcast when a user action should request the
2575 * brightness setting dialog.
2576 * @hide
2577 */
2578 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2579 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2580
Justin Kohd378ad72013-04-01 12:18:26 -07002581 /**
2582 * Broadcast Action: A global button was pressed. Includes a single
2583 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2584 * caused the broadcast.
2585 * @hide
2586 */
2587 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2588
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002589 // ---------------------------------------------------------------------
2590 // ---------------------------------------------------------------------
2591 // Standard intent categories (see addCategory()).
2592
2593 /**
2594 * Set if the activity should be an option for the default action
2595 * (center press) to perform on a piece of data. Setting this will
2596 * hide from the user any activities without it set when performing an
2597 * action on some data. Note that this is normal -not- set in the
2598 * Intent when initiating an action -- it is for use in intent filters
2599 * specified in packages.
2600 */
2601 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2602 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2603 /**
2604 * Activities that can be safely invoked from a browser must support this
2605 * category. For example, if the user is viewing a web page or an e-mail
2606 * and clicks on a link in the text, the Intent generated execute that
2607 * link will require the BROWSABLE category, so that only activities
2608 * supporting this category will be considered as possible actions. By
2609 * supporting this category, you are promising that there is nothing
2610 * damaging (without user intervention) that can happen by invoking any
2611 * matching Intent.
2612 */
2613 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2614 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2615 /**
2616 * Set if the activity should be considered as an alternative action to
2617 * the data the user is currently viewing. See also
2618 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2619 * applies to the selection in a list of items.
2620 *
2621 * <p>Supporting this category means that you would like your activity to be
2622 * displayed in the set of alternative things the user can do, usually as
2623 * part of the current activity's options menu. You will usually want to
2624 * include a specific label in the &lt;intent-filter&gt; of this action
2625 * describing to the user what it does.
2626 *
2627 * <p>The action of IntentFilter with this category is important in that it
2628 * describes the specific action the target will perform. This generally
2629 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2630 * a specific name such as "com.android.camera.action.CROP. Only one
2631 * alternative of any particular action will be shown to the user, so using
2632 * a specific action like this makes sure that your alternative will be
2633 * displayed while also allowing other applications to provide their own
2634 * overrides of that particular action.
2635 */
2636 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2637 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2638 /**
2639 * Set if the activity should be considered as an alternative selection
2640 * action to the data the user has currently selected. This is like
2641 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2642 * of items from which the user can select, giving them alternatives to the
2643 * default action that will be performed on it.
2644 */
2645 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2646 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2647 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002648 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002649 */
2650 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2651 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2652 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002653 * Should be displayed in the top-level launcher.
2654 */
2655 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2656 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2657 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002658 * Provides information about the package it is in; typically used if
2659 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2660 * a front-door to the user without having to be shown in the all apps list.
2661 */
2662 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2663 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2664 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002665 * This is the home activity, that is the first activity that is displayed
2666 * when the device boots.
2667 */
2668 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2669 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2670 /**
2671 * This activity is a preference panel.
2672 */
2673 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2674 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2675 /**
2676 * This activity is a development preference panel.
2677 */
2678 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2679 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2680 /**
2681 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002682 */
2683 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2684 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2685 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002686 * This activity allows the user to browse and download new applications.
2687 */
2688 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2689 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2690 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002691 * This activity may be exercised by the monkey or other automated test tools.
2692 */
2693 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2694 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2695 /**
2696 * To be used as a test (not part of the normal user experience).
2697 */
2698 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2699 /**
2700 * To be used as a unit test (run through the Test Harness).
2701 */
2702 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2703 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002704 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002705 * experience).
2706 */
2707 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2708 /**
2709 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002710 * ContentResolver.openInputStream. Openable URIs must support the columns in
2711 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002712 * when queried, though it is allowable for those columns to be blank.
2713 */
2714 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2715 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2716
2717 /**
2718 * To be used as code under test for framework instrumentation tests.
2719 */
2720 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2721 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002722 /**
2723 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002724 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2725 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002726 */
2727 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2728 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2729 /**
2730 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002731 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2732 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002733 */
2734 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2735 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002736 /**
2737 * An activity to run when device is inserted into a analog (low end) dock.
2738 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2739 * information, see {@link android.app.UiModeManager}.
2740 */
2741 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2742 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2743
2744 /**
2745 * An activity to run when device is inserted into a digital (high end) dock.
2746 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2747 * information, see {@link android.app.UiModeManager}.
2748 */
2749 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2750 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002751
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002752 /**
2753 * Used to indicate that the activity can be used in a car environment.
2754 */
2755 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2756 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2757
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002758 // ---------------------------------------------------------------------
2759 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002760 // Application launch intent categories (see addCategory()).
2761
2762 /**
2763 * Used with {@link #ACTION_MAIN} to launch the browser application.
2764 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002765 * <p>NOTE: This should not be used as the primary key of an Intent,
2766 * since it will not result in the app launching with the correct
2767 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002768 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002769 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002770 */
2771 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2772 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2773
2774 /**
2775 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2776 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002777 * <p>NOTE: This should not be used as the primary key of an Intent,
2778 * since it will not result in the app launching with the correct
2779 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002780 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002781 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002782 */
2783 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2784 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2785
2786 /**
2787 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2788 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002789 * <p>NOTE: This should not be used as the primary key of an Intent,
2790 * since it will not result in the app launching with the correct
2791 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002792 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002793 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002794 */
2795 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2796 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2797
2798 /**
2799 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2800 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002801 * <p>NOTE: This should not be used as the primary key of an Intent,
2802 * since it will not result in the app launching with the correct
2803 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002804 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002805 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002806 */
2807 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2808 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2809
2810 /**
2811 * Used with {@link #ACTION_MAIN} to launch the email application.
2812 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002813 * <p>NOTE: This should not be used as the primary key of an Intent,
2814 * since it will not result in the app launching with the correct
2815 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002816 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002817 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002818 */
2819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2820 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2821
2822 /**
2823 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2824 * The activity should be able to view and manipulate image and video files
2825 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002826 * <p>NOTE: This should not be used as the primary key of an Intent,
2827 * since it will not result in the app launching with the correct
2828 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002829 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002830 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002831 */
2832 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2833 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2834
2835 /**
2836 * Used with {@link #ACTION_MAIN} to launch the maps application.
2837 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002838 * <p>NOTE: This should not be used as the primary key of an Intent,
2839 * since it will not result in the app launching with the correct
2840 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002841 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002842 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002843 */
2844 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2845 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2846
2847 /**
2848 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2849 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002850 * <p>NOTE: This should not be used as the primary key of an Intent,
2851 * since it will not result in the app launching with the correct
2852 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002853 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002854 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002855 */
2856 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2857 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2858
2859 /**
2860 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002861 * The activity should be able to play, browse, or manipulate music files
2862 * stored on the device.
2863 * <p>NOTE: This should not be used as the primary key of an Intent,
2864 * since it will not result in the app launching with the correct
2865 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002866 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002867 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002868 */
2869 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2870 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2871
2872 // ---------------------------------------------------------------------
2873 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002874 // Standard extra data keys.
2875
2876 /**
2877 * The initial data to place in a newly created record. Use with
2878 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2879 * fields as would be given to the underlying ContentProvider.insert()
2880 * call.
2881 */
2882 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2883
2884 /**
2885 * A constant CharSequence that is associated with the Intent, used with
2886 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2887 * this may be a styled CharSequence, so you must use
2888 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2889 * retrieve it.
2890 */
2891 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2892
2893 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002894 * A constant String that is associated with the Intent, used with
2895 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2896 * as HTML formatted text. Note that you <em>must</em> also supply
2897 * {@link #EXTRA_TEXT}.
2898 */
2899 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2900
2901 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002902 * A content: URI holding a stream of data associated with the Intent,
2903 * used with {@link #ACTION_SEND} to supply the data being sent.
2904 */
2905 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2906
2907 /**
2908 * A String[] holding e-mail addresses that should be delivered to.
2909 */
2910 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2911
2912 /**
2913 * A String[] holding e-mail addresses that should be carbon copied.
2914 */
2915 public static final String EXTRA_CC = "android.intent.extra.CC";
2916
2917 /**
2918 * A String[] holding e-mail addresses that should be blind carbon copied.
2919 */
2920 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2921
2922 /**
2923 * A constant string holding the desired subject line of a message.
2924 */
2925 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2926
2927 /**
2928 * An Intent describing the choices you would like shown with
2929 * {@link #ACTION_PICK_ACTIVITY}.
2930 */
2931 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2932
2933 /**
2934 * A CharSequence dialog title to provide to the user when used with a
2935 * {@link #ACTION_CHOOSER}.
2936 */
2937 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2938
2939 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002940 * A Parcelable[] of {@link Intent} or
2941 * {@link android.content.pm.LabeledIntent} objects as set with
2942 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2943 * a the front of the list of choices, when shown to the user with a
2944 * {@link #ACTION_CHOOSER}.
2945 */
2946 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2947
2948 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002949 * A {@link android.view.KeyEvent} object containing the event that
2950 * triggered the creation of the Intent it is in.
2951 */
2952 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2953
2954 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002955 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2956 * before shutting down.
2957 *
2958 * {@hide}
2959 */
2960 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2961
2962 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002963 * 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 -07002964 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2965 * of restarting the application.
2966 */
2967 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2968
2969 /**
2970 * A String holding the phone number originally entered in
2971 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2972 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2973 */
2974 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002976 /**
2977 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2978 * intents to supply the uid the package had been assigned. Also an optional
2979 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2980 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2981 * purpose.
2982 */
2983 public static final String EXTRA_UID = "android.intent.extra.UID";
2984
2985 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002986 * @hide String array of package names.
2987 */
2988 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2989
2990 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002991 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2992 * intents to indicate whether this represents a full uninstall (removing
2993 * both the code and its data) or a partial uninstall (leaving its data,
2994 * implying that this is an update).
2995 */
2996 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002997
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002998 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002999 * @hide
3000 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3001 * intents to indicate that at this point the package has been removed for
3002 * all users on the device.
3003 */
3004 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3005 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3006
3007 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003008 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3009 * intents to indicate that this is a replacement of the package, so this
3010 * broadcast will immediately be followed by an add broadcast for a
3011 * different version of the same package.
3012 */
3013 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003014
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003016 * Used as an int extra field in {@link android.app.AlarmManager} intents
3017 * to tell the application being invoked how many pending alarms are being
3018 * delievered with the intent. For one-shot alarms this will always be 1.
3019 * For recurring alarms, this might be greater than 1 if the device was
3020 * asleep or powered off at the time an earlier alarm would have been
3021 * delivered.
3022 */
3023 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003024
Jacek Surazski86b6c532009-05-13 14:38:28 +02003025 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003026 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3027 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003028 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3029 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003030 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3031 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3032 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003033 */
3034 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3035
3036 /**
3037 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3038 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003039 */
3040 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3041
3042 /**
3043 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3044 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003045 */
3046 public static final int EXTRA_DOCK_STATE_DESK = 1;
3047
3048 /**
3049 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3050 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003051 */
3052 public static final int EXTRA_DOCK_STATE_CAR = 2;
3053
3054 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003055 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3056 * to represent that the phone is in a analog (low end) dock.
3057 */
3058 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3059
3060 /**
3061 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3062 * to represent that the phone is in a digital (high end) dock.
3063 */
3064 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3065
3066 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003067 * Boolean that can be supplied as meta-data with a dock activity, to
3068 * indicate that the dock should take over the home key when it is active.
3069 */
3070 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003071
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003072 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003073 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3074 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003075 */
3076 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3077
3078 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003079 * Used in the extra field in the remote intent. It's astring token passed with the
3080 * remote intent.
3081 */
3082 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3083 "android.intent.extra.remote_intent_token";
3084
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003085 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003086 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003087 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003088 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003089 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003090 "android.intent.extra.changed_component_name";
3091
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003092 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003093 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003094 * and contains a string array of all of the components that have changed. If
3095 * the state of the overall package has changed, then it will contain an entry
3096 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003097 */
3098 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3099 "android.intent.extra.changed_component_name_list";
3100
3101 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003102 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003103 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3104 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003105 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003106 */
3107 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3108 "android.intent.extra.changed_package_list";
3109
3110 /**
3111 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003112 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3113 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003114 * and contains an integer array of uids of all of the components
3115 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003116 */
3117 public static final String EXTRA_CHANGED_UID_LIST =
3118 "android.intent.extra.changed_uid_list";
3119
3120 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003121 * @hide
3122 * Magic extra system code can use when binding, to give a label for
3123 * who it is that has bound to a service. This is an integer giving
3124 * a framework string resource that can be displayed to the user.
3125 */
3126 public static final String EXTRA_CLIENT_LABEL =
3127 "android.intent.extra.client_label";
3128
3129 /**
3130 * @hide
3131 * Magic extra system code can use when binding, to give a PendingIntent object
3132 * that can be launched for the user to disable the system's use of this
3133 * service.
3134 */
3135 public static final String EXTRA_CLIENT_INTENT =
3136 "android.intent.extra.client_intent";
3137
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003138 /**
3139 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3140 * data that is on the local device. This is a boolean extra; the default
3141 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3142 * the user to select media that is already on the device, not requiring it
3143 * be downloaded from a remote service when opened. Another way to look
3144 * at it is that such content should generally have a "_data" column to the
3145 * path of the content on local external storage.
3146 */
3147 public static final String EXTRA_LOCAL_ONLY =
3148 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003149
Amith Yamasani13593602012-03-22 16:16:17 -07003150 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003151 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3152 * user to select and return multiple items. This is a boolean extra; the default
3153 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3154 * present the user with a UI where they can pick multiple items that are all
3155 * returned to the caller. When this happens, they should be returned as
3156 * the {@link #getClipData()} part of the result Intent.
3157 */
3158 public static final String EXTRA_ALLOW_MULTIPLE =
3159 "android.intent.extra.ALLOW_MULTIPLE";
3160
3161 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003162 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003163 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3164 * @hide
3165 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003166 public static final String EXTRA_USER_HANDLE =
3167 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003168
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003169 /**
3170 * Extra used in the response from a BroadcastReceiver that handles
3171 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3172 */
3173 public static final String EXTRA_RESTRICTIONS = "android.intent.extra.restrictions";
3174
Amith Yamasani86118ba2013-03-28 14:33:16 -07003175 /**
3176 * Extra used in the response from a BroadcastReceiver that handles
3177 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3178 */
3179 public static final String EXTRA_RESTRICTIONS_INTENT =
3180 "android.intent.extra.restrictions_intent";
3181
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003182 // ---------------------------------------------------------------------
3183 // ---------------------------------------------------------------------
3184 // Intent flags (see mFlags variable).
3185
3186 /**
3187 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003188 * perform read operations on the Uri in the Intent's data and any URIs
3189 * specified in its ClipData. When applying to an Intent's ClipData,
3190 * all URIs as well as recursive traversals through data or other ClipData
3191 * in Intent items will be granted; only the grant flags of the top-level
3192 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003193 */
3194 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3195 /**
3196 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003197 * perform write operations on the Uri in the Intent's data and any URIs
3198 * specified in its ClipData. When applying to an Intent's ClipData,
3199 * all URIs as well as recursive traversals through data or other ClipData
3200 * in Intent items will be granted; only the grant flags of the top-level
3201 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003202 */
3203 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3204 /**
3205 * Can be set by the caller to indicate that this Intent is coming from
3206 * a background operation, not from direct user interaction.
3207 */
3208 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3209 /**
3210 * A flag you can enable for debugging: when set, log messages will be
3211 * printed during the resolution of this intent to show you what has
3212 * been found to create the final resolved list.
3213 */
3214 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003215 /**
3216 * If set, this intent will not match any components in packages that
3217 * are currently stopped. If this is not set, then the default behavior
3218 * is to include such applications in the result.
3219 */
3220 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3221 /**
3222 * If set, this intent will always match any components in packages that
3223 * are currently stopped. This is the default behavior when
3224 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3225 * flags are set, this one wins (it allows overriding of exclude for
3226 * places where the framework may automatically set the exclude flag).
3227 */
3228 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003229
3230 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003231 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3232 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the grant will be remembered
3233 * until explicitly revoked with
3234 * {@link Context#revokeUriPermission(Uri, int)}. These grants persist
3235 * across device reboots.
3236 */
3237 public static final int FLAG_PERSIST_GRANT_URI_PERMISSION = 0x00000040;
3238
3239 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003240 * If set, the new activity is not kept in the history stack. As soon as
3241 * the user navigates away from it, the activity is finished. This may also
3242 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3243 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003244 */
3245 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3246 /**
3247 * If set, the activity will not be launched if it is already running
3248 * at the top of the history stack.
3249 */
3250 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3251 /**
3252 * If set, this activity will become the start of a new task on this
3253 * history stack. A task (from the activity that started it to the
3254 * next task activity) defines an atomic group of activities that the
3255 * user can move to. Tasks can be moved to the foreground and background;
3256 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003257 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003258 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3259 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003260 *
3261 * <p>This flag is generally used by activities that want
3262 * to present a "launcher" style behavior: they give the user a list of
3263 * separate things that can be done, which otherwise run completely
3264 * independently of the activity launching them.
3265 *
3266 * <p>When using this flag, if a task is already running for the activity
3267 * you are now starting, then a new activity will not be started; instead,
3268 * the current task will simply be brought to the front of the screen with
3269 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3270 * to disable this behavior.
3271 *
3272 * <p>This flag can not be used when the caller is requesting a result from
3273 * the activity being launched.
3274 */
3275 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3276 /**
3277 * <strong>Do not use this flag unless you are implementing your own
3278 * top-level application launcher.</strong> Used in conjunction with
3279 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3280 * behavior of bringing an existing task to the foreground. When set,
3281 * a new task is <em>always</em> started to host the Activity for the
3282 * Intent, regardless of whether there is already an existing task running
3283 * the same thing.
3284 *
3285 * <p><strong>Because the default system does not include graphical task management,
3286 * you should not use this flag unless you provide some way for a user to
3287 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003288 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003289 * <p>This flag is ignored if
3290 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3291 *
Scott Main7aee61f2011-02-08 11:25:01 -08003292 * <p>See
3293 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3294 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003295 */
3296 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3297 /**
3298 * If set, and the activity being launched is already running in the
3299 * current task, then instead of launching a new instance of that activity,
3300 * all of the other activities on top of it will be closed and this Intent
3301 * will be delivered to the (now on top) old activity as a new Intent.
3302 *
3303 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3304 * If D calls startActivity() with an Intent that resolves to the component
3305 * of activity B, then C and D will be finished and B receive the given
3306 * Intent, resulting in the stack now being: A, B.
3307 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003308 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003309 * either receive the new intent you are starting here in its
3310 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003311 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003312 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3313 * the same intent, then it will be finished and re-created; for all other
3314 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3315 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003316 *
3317 * <p>This launch mode can also be used to good effect in conjunction with
3318 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3319 * of a task, it will bring any currently running instance of that task
3320 * to the foreground, and then clear it to its root state. This is
3321 * especially useful, for example, when launching an activity from the
3322 * notification manager.
3323 *
Scott Main7aee61f2011-02-08 11:25:01 -08003324 * <p>See
3325 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3326 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003327 */
3328 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3329 /**
3330 * If set and this intent is being used to launch a new activity from an
3331 * existing one, then the reply target of the existing activity will be
3332 * transfered to the new activity. This way the new activity can call
3333 * {@link android.app.Activity#setResult} and have that result sent back to
3334 * the reply target of the original activity.
3335 */
3336 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3337 /**
3338 * If set and this intent is being used to launch a new activity from an
3339 * existing one, the current activity will not be counted as the top
3340 * activity for deciding whether the new intent should be delivered to
3341 * the top instead of starting a new one. The previous activity will
3342 * be used as the top, with the assumption being that the current activity
3343 * will finish itself immediately.
3344 */
3345 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3346 /**
3347 * If set, the new activity is not kept in the list of recently launched
3348 * activities.
3349 */
3350 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3351 /**
3352 * This flag is not normally set by application code, but set for you by
3353 * the system as described in the
3354 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3355 * launchMode} documentation for the singleTask mode.
3356 */
3357 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3358 /**
3359 * If set, and this activity is either being started in a new task or
3360 * bringing to the top an existing task, then it will be launched as
3361 * the front door of the task. This will result in the application of
3362 * any affinities needed to have that task in the proper state (either
3363 * moving activities to or from it), or simply resetting that task to
3364 * its initial state if needed.
3365 */
3366 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3367 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003368 * This flag is not normally set by application code, but set for you by
3369 * the system if this activity is being launched from history
3370 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003371 */
3372 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003373 /**
3374 * If set, this marks a point in the task's activity stack that should
3375 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003376 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003377 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3378 * the user re-launching it from home), this activity and all on top of
3379 * it will be finished so that the user does not return to them, but
3380 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003381 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003382 * <p>This is useful for cases where you have a logical break in your
3383 * application. For example, an e-mail application may have a command
3384 * to view an attachment, which launches an image view activity to
3385 * display it. This activity should be part of the e-mail application's
3386 * task, since it is a part of the task the user is involved in. However,
3387 * if the user leaves that task, and later selects the e-mail app from
3388 * home, we may like them to return to the conversation they were
3389 * viewing, not the picture attachment, since that is confusing. By
3390 * setting this flag when launching the image viewer, that viewer and
3391 * any activities it starts will be removed the next time the user returns
3392 * to mail.
3393 */
3394 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003395 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003396 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003397 * callback from occurring on the current frontmost activity before it is
3398 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003399 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003400 * <p>Typically, an activity can rely on that callback to indicate that an
3401 * explicit user action has caused their activity to be moved out of the
3402 * foreground. The callback marks an appropriate point in the activity's
3403 * lifecycle for it to dismiss any notifications that it intends to display
3404 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003405 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003406 * <p>If an activity is ever started via any non-user-driven events such as
3407 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3408 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003409 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003410 */
3411 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003412 /**
3413 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3414 * this flag will cause the launched activity to be brought to the front of its
3415 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003416 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003417 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3418 * If D calls startActivity() with an Intent that resolves to the component
3419 * of activity B, then B will be brought to the front of the history stack,
3420 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003421 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003422 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003423 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003424 */
3425 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003426 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003427 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3428 * this flag will prevent the system from applying an activity transition
3429 * animation to go to the next activity state. This doesn't mean an
3430 * animation will never run -- if another activity change happens that doesn't
3431 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003432 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003433 * when you are going to do a series of activity operations but the
3434 * animation seen by the user shouldn't be driven by the first activity
3435 * change but rather a later one.
3436 */
3437 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3438 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003439 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3440 * this flag will cause any existing task that would be associated with the
3441 * activity to be cleared before the activity is started. That is, the activity
3442 * becomes the new root of an otherwise empty task, and any old activities
3443 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3444 */
3445 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3446 /**
3447 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3448 * this flag will cause a newly launching task to be placed on top of the current
3449 * home activity task (if there is one). That is, pressing back from the task
3450 * will always return the user to home even if that was not the last activity they
3451 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3452 */
3453 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3454 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003455 * If set, when sending a broadcast only registered receivers will be
3456 * called -- no BroadcastReceiver components will be launched.
3457 */
3458 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003459 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003460 * If set, when sending a broadcast the new broadcast will replace
3461 * any existing pending broadcast that matches it. Matching is defined
3462 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3463 * true for the intents of the two broadcasts. When a match is found,
3464 * the new broadcast (and receivers associated with it) will replace the
3465 * existing one in the pending broadcast list, remaining at the same
3466 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003467 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003468 * <p>This flag is most typically used with sticky broadcasts, which
3469 * only care about delivering the most recent values of the broadcast
3470 * to their receivers.
3471 */
3472 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3473 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003474 * If set, when sending a broadcast the recipient is allowed to run at
3475 * foreground priority, with a shorter timeout interval. During normal
3476 * broadcasts the receivers are not automatically hoisted out of the
3477 * background priority class.
3478 */
3479 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3480 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003481 * If set, when sending a broadcast <i>before boot has completed</i> only
3482 * registered receivers will be called -- no BroadcastReceiver components
3483 * will be launched. Sticky intent state will be recorded properly even
3484 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3485 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003486 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003487 * <p>This flag is only for use by system sevices as a convenience to
3488 * avoid having to implement a more complex mechanism around detection
3489 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003490 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003491 * @hide
3492 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003493 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003494 /**
3495 * Set when this broadcast is for a boot upgrade, a special mode that
3496 * allows the broadcast to be sent before the system is ready and launches
3497 * the app process with no providers running in it.
3498 * @hide
3499 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003500 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003501
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003502 /**
3503 * @hide Flags that can't be changed with PendingIntent.
3504 */
3505 public static final int IMMUTABLE_FLAGS =
3506 FLAG_GRANT_READ_URI_PERMISSION
3507 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003508
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003510 // ---------------------------------------------------------------------
3511 // toUri() and parseUri() options.
3512
3513 /**
3514 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3515 * always has the "intent:" scheme. This syntax can be used when you want
3516 * to later disambiguate between URIs that are intended to describe an
3517 * Intent vs. all others that should be treated as raw URIs. When used
3518 * with {@link #parseUri}, any other scheme will result in a generic
3519 * VIEW action for that raw URI.
3520 */
3521 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003522
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003523 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003524
3525 private String mAction;
3526 private Uri mData;
3527 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003528 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003529 private ComponentName mComponent;
3530 private int mFlags;
3531 private HashSet<String> mCategories;
3532 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003533 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003534 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003535 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003536
3537 // ---------------------------------------------------------------------
3538
3539 /**
3540 * Create an empty intent.
3541 */
3542 public Intent() {
3543 }
3544
3545 /**
3546 * Copy constructor.
3547 */
3548 public Intent(Intent o) {
3549 this.mAction = o.mAction;
3550 this.mData = o.mData;
3551 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003552 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003553 this.mComponent = o.mComponent;
3554 this.mFlags = o.mFlags;
3555 if (o.mCategories != null) {
3556 this.mCategories = new HashSet<String>(o.mCategories);
3557 }
3558 if (o.mExtras != null) {
3559 this.mExtras = new Bundle(o.mExtras);
3560 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003561 if (o.mSourceBounds != null) {
3562 this.mSourceBounds = new Rect(o.mSourceBounds);
3563 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003564 if (o.mSelector != null) {
3565 this.mSelector = new Intent(o.mSelector);
3566 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003567 if (o.mClipData != null) {
3568 this.mClipData = new ClipData(o.mClipData);
3569 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003570 }
3571
3572 @Override
3573 public Object clone() {
3574 return new Intent(this);
3575 }
3576
3577 private Intent(Intent o, boolean all) {
3578 this.mAction = o.mAction;
3579 this.mData = o.mData;
3580 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003581 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003582 this.mComponent = o.mComponent;
3583 if (o.mCategories != null) {
3584 this.mCategories = new HashSet<String>(o.mCategories);
3585 }
3586 }
3587
3588 /**
3589 * Make a clone of only the parts of the Intent that are relevant for
3590 * filter matching: the action, data, type, component, and categories.
3591 */
3592 public Intent cloneFilter() {
3593 return new Intent(this, false);
3594 }
3595
3596 /**
3597 * Create an intent with a given action. All other fields (data, type,
3598 * class) are null. Note that the action <em>must</em> be in a
3599 * namespace because Intents are used globally in the system -- for
3600 * example the system VIEW action is android.intent.action.VIEW; an
3601 * application's custom action would be something like
3602 * com.google.app.myapp.CUSTOM_ACTION.
3603 *
3604 * @param action The Intent action, such as ACTION_VIEW.
3605 */
3606 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003607 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003608 }
3609
3610 /**
3611 * Create an intent with a given action and for a given data url. Note
3612 * that the action <em>must</em> be in a namespace because Intents are
3613 * used globally in the system -- for example the system VIEW action is
3614 * android.intent.action.VIEW; an application's custom action would be
3615 * something like com.google.app.myapp.CUSTOM_ACTION.
3616 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003617 * <p><em>Note: scheme and host name matching in the Android framework is
3618 * case-sensitive, unlike the formal RFC. As a result,
3619 * you should always ensure that you write your Uri with these elements
3620 * using lower case letters, and normalize any Uris you receive from
3621 * outside of Android to ensure the scheme and host is lower case.</em></p>
3622 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003623 * @param action The Intent action, such as ACTION_VIEW.
3624 * @param uri The Intent data URI.
3625 */
3626 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003627 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003628 mData = uri;
3629 }
3630
3631 /**
3632 * Create an intent for a specific component. All other fields (action, data,
3633 * type, class) are null, though they can be modified later with explicit
3634 * calls. This provides a convenient way to create an intent that is
3635 * intended to execute a hard-coded class name, rather than relying on the
3636 * system to find an appropriate class for you; see {@link #setComponent}
3637 * for more information on the repercussions of this.
3638 *
3639 * @param packageContext A Context of the application package implementing
3640 * this class.
3641 * @param cls The component class that is to be used for the intent.
3642 *
3643 * @see #setClass
3644 * @see #setComponent
3645 * @see #Intent(String, android.net.Uri , Context, Class)
3646 */
3647 public Intent(Context packageContext, Class<?> cls) {
3648 mComponent = new ComponentName(packageContext, cls);
3649 }
3650
3651 /**
3652 * Create an intent for a specific component with a specified action and data.
3653 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3654 * construct the Intent and then calling {@link #setClass} to set its
3655 * class.
3656 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003657 * <p><em>Note: scheme and host name matching in the Android framework is
3658 * case-sensitive, unlike the formal RFC. As a result,
3659 * you should always ensure that you write your Uri with these elements
3660 * using lower case letters, and normalize any Uris you receive from
3661 * outside of Android to ensure the scheme and host is lower case.</em></p>
3662 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663 * @param action The Intent action, such as ACTION_VIEW.
3664 * @param uri The Intent data URI.
3665 * @param packageContext A Context of the application package implementing
3666 * this class.
3667 * @param cls The component class that is to be used for the intent.
3668 *
3669 * @see #Intent(String, android.net.Uri)
3670 * @see #Intent(Context, Class)
3671 * @see #setClass
3672 * @see #setComponent
3673 */
3674 public Intent(String action, Uri uri,
3675 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003676 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677 mData = uri;
3678 mComponent = new ComponentName(packageContext, cls);
3679 }
3680
3681 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003682 * Create an intent to launch the main (root) activity of a task. This
3683 * is the Intent that is started when the application's is launched from
3684 * Home. For anything else that wants to launch an application in the
3685 * same way, it is important that they use an Intent structured the same
3686 * way, and can use this function to ensure this is the case.
3687 *
3688 * <p>The returned Intent has the given Activity component as its explicit
3689 * component, {@link #ACTION_MAIN} as its action, and includes the
3690 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3691 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3692 * to do that through {@link #addFlags(int)} on the returned Intent.
3693 *
3694 * @param mainActivity The main activity component that this Intent will
3695 * launch.
3696 * @return Returns a newly created Intent that can be used to launch the
3697 * activity as a main application entry.
3698 *
3699 * @see #setClass
3700 * @see #setComponent
3701 */
3702 public static Intent makeMainActivity(ComponentName mainActivity) {
3703 Intent intent = new Intent(ACTION_MAIN);
3704 intent.setComponent(mainActivity);
3705 intent.addCategory(CATEGORY_LAUNCHER);
3706 return intent;
3707 }
3708
3709 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003710 * Make an Intent for the main activity of an application, without
3711 * specifying a specific activity to run but giving a selector to find
3712 * the activity. This results in a final Intent that is structured
3713 * the same as when the application is launched from
3714 * Home. For anything else that wants to launch an application in the
3715 * same way, it is important that they use an Intent structured the same
3716 * way, and can use this function to ensure this is the case.
3717 *
3718 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3719 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3720 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3721 * to do that through {@link #addFlags(int)} on the returned Intent.
3722 *
3723 * @param selectorAction The action name of the Intent's selector.
3724 * @param selectorCategory The name of a category to add to the Intent's
3725 * selector.
3726 * @return Returns a newly created Intent that can be used to launch the
3727 * activity as a main application entry.
3728 *
3729 * @see #setSelector(Intent)
3730 */
3731 public static Intent makeMainSelectorActivity(String selectorAction,
3732 String selectorCategory) {
3733 Intent intent = new Intent(ACTION_MAIN);
3734 intent.addCategory(CATEGORY_LAUNCHER);
3735 Intent selector = new Intent();
3736 selector.setAction(selectorAction);
3737 selector.addCategory(selectorCategory);
3738 intent.setSelector(selector);
3739 return intent;
3740 }
3741
3742 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003743 * Make an Intent that can be used to re-launch an application's task
3744 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3745 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3746 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3747 *
3748 * @param mainActivity The activity component that is the root of the
3749 * task; this is the activity that has been published in the application's
3750 * manifest as the main launcher icon.
3751 *
3752 * @return Returns a newly created Intent that can be used to relaunch the
3753 * activity's task in its root state.
3754 */
3755 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3756 Intent intent = makeMainActivity(mainActivity);
3757 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3758 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3759 return intent;
3760 }
3761
3762 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003763 * Call {@link #parseUri} with 0 flags.
3764 * @deprecated Use {@link #parseUri} instead.
3765 */
3766 @Deprecated
3767 public static Intent getIntent(String uri) throws URISyntaxException {
3768 return parseUri(uri, 0);
3769 }
Tom Taylord4a47292009-12-21 13:59:18 -08003770
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003771 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003772 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003773 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003774 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003775 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003776 *
3777 * <p>The URI given here must not be relative -- that is, it must include
3778 * the scheme and full path.
3779 *
3780 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003781 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003782 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003783 *
3784 * @return Intent The newly created Intent object.
3785 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003786 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3787 * it bad (as parsed by the Uri class) or the Intent data within the
3788 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003789 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003790 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003791 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003792 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003793 int i = 0;
3794 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003795 // Validate intent scheme for if requested.
3796 if ((flags&URI_INTENT_SCHEME) != 0) {
3797 if (!uri.startsWith("intent:")) {
3798 Intent intent = new Intent(ACTION_VIEW);
3799 try {
3800 intent.setData(Uri.parse(uri));
3801 } catch (IllegalArgumentException e) {
3802 throw new URISyntaxException(uri, e.getMessage());
3803 }
3804 return intent;
3805 }
3806 }
Tom Taylord4a47292009-12-21 13:59:18 -08003807
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003808 // simple case
3809 i = uri.lastIndexOf("#");
3810 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3811
3812 // old format Intent URI
3813 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003814
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003815 // new format
3816 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003817 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003818
3819 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003820 String data = i >= 0 ? uri.substring(0, i) : null;
3821 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003822 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003823
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003824 // loop over contents of Intent, all name=value;
3825 while (!uri.startsWith("end", i)) {
3826 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003827 if (eq < 0) eq = i-1;
3828 int semi = uri.indexOf(';', i);
3829 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003830
3831 // action
3832 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003833 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003834 }
3835
3836 // categories
3837 else if (uri.startsWith("category=", i)) {
3838 intent.addCategory(value);
3839 }
3840
3841 // type
3842 else if (uri.startsWith("type=", i)) {
3843 intent.mType = value;
3844 }
3845
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003846 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003847 else if (uri.startsWith("launchFlags=", i)) {
3848 intent.mFlags = Integer.decode(value).intValue();
3849 }
3850
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003851 // package
3852 else if (uri.startsWith("package=", i)) {
3853 intent.mPackage = value;
3854 }
3855
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003856 // component
3857 else if (uri.startsWith("component=", i)) {
3858 intent.mComponent = ComponentName.unflattenFromString(value);
3859 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003860
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003861 // scheme
3862 else if (uri.startsWith("scheme=", i)) {
3863 scheme = value;
3864 }
3865
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003866 // source bounds
3867 else if (uri.startsWith("sourceBounds=", i)) {
3868 intent.mSourceBounds = Rect.unflattenFromString(value);
3869 }
3870
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003871 // selector
3872 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3873 intent = new Intent();
3874 }
3875
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003876 // extra
3877 else {
3878 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003879 // create Bundle if it doesn't already exist
3880 if (intent.mExtras == null) intent.mExtras = new Bundle();
3881 Bundle b = intent.mExtras;
3882 // add EXTRA
3883 if (uri.startsWith("S.", i)) b.putString(key, value);
3884 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3885 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3886 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3887 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3888 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3889 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3890 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3891 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3892 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3893 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003894
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003895 // move to the next item
3896 i = semi + 1;
3897 }
3898
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003899 if (intent != baseIntent) {
3900 // The Intent had a selector; fix it up.
3901 baseIntent.setSelector(intent);
3902 intent = baseIntent;
3903 }
3904
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003905 if (data != null) {
3906 if (data.startsWith("intent:")) {
3907 data = data.substring(7);
3908 if (scheme != null) {
3909 data = scheme + ':' + data;
3910 }
3911 }
Tom Taylord4a47292009-12-21 13:59:18 -08003912
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003913 if (data.length() > 0) {
3914 try {
3915 intent.mData = Uri.parse(data);
3916 } catch (IllegalArgumentException e) {
3917 throw new URISyntaxException(uri, e.getMessage());
3918 }
3919 }
3920 }
Tom Taylord4a47292009-12-21 13:59:18 -08003921
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003922 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003923
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003924 } catch (IndexOutOfBoundsException e) {
3925 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3926 }
3927 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003928
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003929 public static Intent getIntentOld(String uri) throws URISyntaxException {
3930 Intent intent;
3931
3932 int i = uri.lastIndexOf('#');
3933 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003934 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003935 final int intentFragmentStart = i;
3936 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003937
3938 i++;
3939
3940 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003941 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003942 i += 7;
3943 int j = uri.indexOf(')', i);
3944 action = uri.substring(i, j);
3945 i = j + 1;
3946 }
3947
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003948 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003949
3950 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003951 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003952 i += 11;
3953 int j = uri.indexOf(')', i);
3954 while (i < j) {
3955 int sep = uri.indexOf('!', i);
3956 if (sep < 0) sep = j;
3957 if (i < sep) {
3958 intent.addCategory(uri.substring(i, sep));
3959 }
3960 i = sep + 1;
3961 }
3962 i = j + 1;
3963 }
3964
3965 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003966 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003967 i += 5;
3968 int j = uri.indexOf(')', i);
3969 intent.mType = uri.substring(i, j);
3970 i = j + 1;
3971 }
3972
3973 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003974 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003975 i += 12;
3976 int j = uri.indexOf(')', i);
3977 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3978 i = j + 1;
3979 }
3980
3981 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003982 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003983 i += 10;
3984 int j = uri.indexOf(')', i);
3985 int sep = uri.indexOf('!', i);
3986 if (sep >= 0 && sep < j) {
3987 String pkg = uri.substring(i, sep);
3988 String cls = uri.substring(sep + 1, j);
3989 intent.mComponent = new ComponentName(pkg, cls);
3990 }
3991 i = j + 1;
3992 }
3993
3994 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003995 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003996 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003997
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003998 final int closeParen = uri.indexOf(')', i);
3999 if (closeParen == -1) throw new URISyntaxException(uri,
4000 "EXTRA missing trailing ')'", i);
4001
4002 while (i < closeParen) {
4003 // fetch the key value
4004 int j = uri.indexOf('=', i);
4005 if (j <= i + 1 || i >= closeParen) {
4006 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4007 }
4008 char type = uri.charAt(i);
4009 i++;
4010 String key = uri.substring(i, j);
4011 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004012
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004013 // get type-value
4014 j = uri.indexOf('!', i);
4015 if (j == -1 || j >= closeParen) j = closeParen;
4016 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4017 String value = uri.substring(i, j);
4018 i = j;
4019
4020 // create Bundle if it doesn't already exist
4021 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004022
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004023 // add item to bundle
4024 try {
4025 switch (type) {
4026 case 'S':
4027 intent.mExtras.putString(key, Uri.decode(value));
4028 break;
4029 case 'B':
4030 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4031 break;
4032 case 'b':
4033 intent.mExtras.putByte(key, Byte.parseByte(value));
4034 break;
4035 case 'c':
4036 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4037 break;
4038 case 'd':
4039 intent.mExtras.putDouble(key, Double.parseDouble(value));
4040 break;
4041 case 'f':
4042 intent.mExtras.putFloat(key, Float.parseFloat(value));
4043 break;
4044 case 'i':
4045 intent.mExtras.putInt(key, Integer.parseInt(value));
4046 break;
4047 case 'l':
4048 intent.mExtras.putLong(key, Long.parseLong(value));
4049 break;
4050 case 's':
4051 intent.mExtras.putShort(key, Short.parseShort(value));
4052 break;
4053 default:
4054 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4055 }
4056 } catch (NumberFormatException e) {
4057 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4058 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004059
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004060 char ch = uri.charAt(i);
4061 if (ch == ')') break;
4062 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4063 i++;
4064 }
4065 }
4066
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004067 if (isIntentFragment) {
4068 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4069 } else {
4070 intent.mData = Uri.parse(uri);
4071 }
Tom Taylord4a47292009-12-21 13:59:18 -08004072
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004073 if (intent.mAction == null) {
4074 // By default, if no action is specified, then use VIEW.
4075 intent.mAction = ACTION_VIEW;
4076 }
4077
4078 } else {
4079 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4080 }
4081
4082 return intent;
4083 }
4084
4085 /**
4086 * Retrieve the general action to be performed, such as
4087 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4088 * the information in the intent should be interpreted -- most importantly,
4089 * what to do with the data returned by {@link #getData}.
4090 *
4091 * @return The action of this intent or null if none is specified.
4092 *
4093 * @see #setAction
4094 */
4095 public String getAction() {
4096 return mAction;
4097 }
4098
4099 /**
4100 * Retrieve data this intent is operating on. This URI specifies the name
4101 * of the data; often it uses the content: scheme, specifying data in a
4102 * content provider. Other schemes may be handled by specific activities,
4103 * such as http: by the web browser.
4104 *
4105 * @return The URI of the data this intent is targeting or null.
4106 *
4107 * @see #getScheme
4108 * @see #setData
4109 */
4110 public Uri getData() {
4111 return mData;
4112 }
4113
4114 /**
4115 * The same as {@link #getData()}, but returns the URI as an encoded
4116 * String.
4117 */
4118 public String getDataString() {
4119 return mData != null ? mData.toString() : null;
4120 }
4121
4122 /**
4123 * Return the scheme portion of the intent's data. If the data is null or
4124 * does not include a scheme, null is returned. Otherwise, the scheme
4125 * prefix without the final ':' is returned, i.e. "http".
4126 *
4127 * <p>This is the same as calling getData().getScheme() (and checking for
4128 * null data).
4129 *
4130 * @return The scheme of this intent.
4131 *
4132 * @see #getData
4133 */
4134 public String getScheme() {
4135 return mData != null ? mData.getScheme() : null;
4136 }
4137
4138 /**
4139 * Retrieve any explicit MIME type included in the intent. This is usually
4140 * null, as the type is determined by the intent data.
4141 *
4142 * @return If a type was manually set, it is returned; else null is
4143 * returned.
4144 *
4145 * @see #resolveType(ContentResolver)
4146 * @see #setType
4147 */
4148 public String getType() {
4149 return mType;
4150 }
4151
4152 /**
4153 * Return the MIME data type of this intent. If the type field is
4154 * explicitly set, that is simply returned. Otherwise, if the data is set,
4155 * the type of that data is returned. If neither fields are set, a null is
4156 * returned.
4157 *
4158 * @return The MIME type of this intent.
4159 *
4160 * @see #getType
4161 * @see #resolveType(ContentResolver)
4162 */
4163 public String resolveType(Context context) {
4164 return resolveType(context.getContentResolver());
4165 }
4166
4167 /**
4168 * Return the MIME data type of this intent. If the type field is
4169 * explicitly set, that is simply returned. Otherwise, if the data is set,
4170 * the type of that data is returned. If neither fields are set, a null is
4171 * returned.
4172 *
4173 * @param resolver A ContentResolver that can be used to determine the MIME
4174 * type of the intent's data.
4175 *
4176 * @return The MIME type of this intent.
4177 *
4178 * @see #getType
4179 * @see #resolveType(Context)
4180 */
4181 public String resolveType(ContentResolver resolver) {
4182 if (mType != null) {
4183 return mType;
4184 }
4185 if (mData != null) {
4186 if ("content".equals(mData.getScheme())) {
4187 return resolver.getType(mData);
4188 }
4189 }
4190 return null;
4191 }
4192
4193 /**
4194 * Return the MIME data type of this intent, only if it will be needed for
4195 * intent resolution. This is not generally useful for application code;
4196 * it is used by the frameworks for communicating with back-end system
4197 * services.
4198 *
4199 * @param resolver A ContentResolver that can be used to determine the MIME
4200 * type of the intent's data.
4201 *
4202 * @return The MIME type of this intent, or null if it is unknown or not
4203 * needed.
4204 */
4205 public String resolveTypeIfNeeded(ContentResolver resolver) {
4206 if (mComponent != null) {
4207 return mType;
4208 }
4209 return resolveType(resolver);
4210 }
4211
4212 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004213 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004214 *
4215 * @param category The category to check.
4216 *
4217 * @return boolean True if the intent contains the category, else false.
4218 *
4219 * @see #getCategories
4220 * @see #addCategory
4221 */
4222 public boolean hasCategory(String category) {
4223 return mCategories != null && mCategories.contains(category);
4224 }
4225
4226 /**
4227 * Return the set of all categories in the intent. If there are no categories,
4228 * returns NULL.
4229 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004230 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004231 *
4232 * @see #hasCategory
4233 * @see #addCategory
4234 */
4235 public Set<String> getCategories() {
4236 return mCategories;
4237 }
4238
4239 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004240 * Return the specific selector associated with this Intent. If there is
4241 * none, returns null. See {@link #setSelector} for more information.
4242 *
4243 * @see #setSelector
4244 */
4245 public Intent getSelector() {
4246 return mSelector;
4247 }
4248
4249 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004250 * Return the {@link ClipData} associated with this Intent. If there is
4251 * none, returns null. See {@link #setClipData} for more information.
4252 *
4253 * @see #setClipData;
4254 */
4255 public ClipData getClipData() {
4256 return mClipData;
4257 }
4258
4259 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004260 * Sets the ClassLoader that will be used when unmarshalling
4261 * any Parcelable values from the extras of this Intent.
4262 *
4263 * @param loader a ClassLoader, or null to use the default loader
4264 * at the time of unmarshalling.
4265 */
4266 public void setExtrasClassLoader(ClassLoader loader) {
4267 if (mExtras != null) {
4268 mExtras.setClassLoader(loader);
4269 }
4270 }
4271
4272 /**
4273 * Returns true if an extra value is associated with the given name.
4274 * @param name the extra's name
4275 * @return true if the given extra is present.
4276 */
4277 public boolean hasExtra(String name) {
4278 return mExtras != null && mExtras.containsKey(name);
4279 }
4280
4281 /**
4282 * Returns true if the Intent's extras contain a parcelled file descriptor.
4283 * @return true if the Intent contains a parcelled file descriptor.
4284 */
4285 public boolean hasFileDescriptors() {
4286 return mExtras != null && mExtras.hasFileDescriptors();
4287 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004288
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004289 /** @hide */
4290 public void setAllowFds(boolean allowFds) {
4291 if (mExtras != null) {
4292 mExtras.setAllowFds(allowFds);
4293 }
4294 }
4295
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004296 /**
4297 * Retrieve extended data from the intent.
4298 *
4299 * @param name The name of the desired item.
4300 *
4301 * @return the value of an item that previously added with putExtra()
4302 * or null if none was found.
4303 *
4304 * @deprecated
4305 * @hide
4306 */
4307 @Deprecated
4308 public Object getExtra(String name) {
4309 return getExtra(name, null);
4310 }
4311
4312 /**
4313 * Retrieve extended data from the intent.
4314 *
4315 * @param name The name of the desired item.
4316 * @param defaultValue the value to be returned if no value of the desired
4317 * type is stored with the given name.
4318 *
4319 * @return the value of an item that previously added with putExtra()
4320 * or the default value if none was found.
4321 *
4322 * @see #putExtra(String, boolean)
4323 */
4324 public boolean getBooleanExtra(String name, boolean defaultValue) {
4325 return mExtras == null ? defaultValue :
4326 mExtras.getBoolean(name, defaultValue);
4327 }
4328
4329 /**
4330 * Retrieve extended data from the intent.
4331 *
4332 * @param name The name of the desired item.
4333 * @param defaultValue the value to be returned if no value of the desired
4334 * type is stored with the given name.
4335 *
4336 * @return the value of an item that previously added with putExtra()
4337 * or the default value if none was found.
4338 *
4339 * @see #putExtra(String, byte)
4340 */
4341 public byte getByteExtra(String name, byte defaultValue) {
4342 return mExtras == null ? defaultValue :
4343 mExtras.getByte(name, defaultValue);
4344 }
4345
4346 /**
4347 * Retrieve extended data from the intent.
4348 *
4349 * @param name The name of the desired item.
4350 * @param defaultValue the value to be returned if no value of the desired
4351 * type is stored with the given name.
4352 *
4353 * @return the value of an item that previously added with putExtra()
4354 * or the default value if none was found.
4355 *
4356 * @see #putExtra(String, short)
4357 */
4358 public short getShortExtra(String name, short defaultValue) {
4359 return mExtras == null ? defaultValue :
4360 mExtras.getShort(name, defaultValue);
4361 }
4362
4363 /**
4364 * Retrieve extended data from the intent.
4365 *
4366 * @param name The name of the desired item.
4367 * @param defaultValue the value to be returned if no value of the desired
4368 * type is stored with the given name.
4369 *
4370 * @return the value of an item that previously added with putExtra()
4371 * or the default value if none was found.
4372 *
4373 * @see #putExtra(String, char)
4374 */
4375 public char getCharExtra(String name, char defaultValue) {
4376 return mExtras == null ? defaultValue :
4377 mExtras.getChar(name, defaultValue);
4378 }
4379
4380 /**
4381 * Retrieve extended data from the intent.
4382 *
4383 * @param name The name of the desired item.
4384 * @param defaultValue the value to be returned if no value of the desired
4385 * type is stored with the given name.
4386 *
4387 * @return the value of an item that previously added with putExtra()
4388 * or the default value if none was found.
4389 *
4390 * @see #putExtra(String, int)
4391 */
4392 public int getIntExtra(String name, int defaultValue) {
4393 return mExtras == null ? defaultValue :
4394 mExtras.getInt(name, defaultValue);
4395 }
4396
4397 /**
4398 * Retrieve extended data from the intent.
4399 *
4400 * @param name The name of the desired item.
4401 * @param defaultValue the value to be returned if no value of the desired
4402 * type is stored with the given name.
4403 *
4404 * @return the value of an item that previously added with putExtra()
4405 * or the default value if none was found.
4406 *
4407 * @see #putExtra(String, long)
4408 */
4409 public long getLongExtra(String name, long defaultValue) {
4410 return mExtras == null ? defaultValue :
4411 mExtras.getLong(name, defaultValue);
4412 }
4413
4414 /**
4415 * Retrieve extended data from the intent.
4416 *
4417 * @param name The name of the desired item.
4418 * @param defaultValue the value to be returned if no value of the desired
4419 * type is stored with the given name.
4420 *
4421 * @return the value of an item that previously added with putExtra(),
4422 * or the default value if no such item is present
4423 *
4424 * @see #putExtra(String, float)
4425 */
4426 public float getFloatExtra(String name, float defaultValue) {
4427 return mExtras == null ? defaultValue :
4428 mExtras.getFloat(name, defaultValue);
4429 }
4430
4431 /**
4432 * Retrieve extended data from the intent.
4433 *
4434 * @param name The name of the desired item.
4435 * @param defaultValue the value to be returned if no value of the desired
4436 * type is stored with the given name.
4437 *
4438 * @return the value of an item that previously added with putExtra()
4439 * or the default value if none was found.
4440 *
4441 * @see #putExtra(String, double)
4442 */
4443 public double getDoubleExtra(String name, double defaultValue) {
4444 return mExtras == null ? defaultValue :
4445 mExtras.getDouble(name, defaultValue);
4446 }
4447
4448 /**
4449 * Retrieve extended data from the intent.
4450 *
4451 * @param name The name of the desired item.
4452 *
4453 * @return the value of an item that previously added with putExtra()
4454 * or null if no String value was found.
4455 *
4456 * @see #putExtra(String, String)
4457 */
4458 public String getStringExtra(String name) {
4459 return mExtras == null ? null : mExtras.getString(name);
4460 }
4461
4462 /**
4463 * Retrieve extended data from the intent.
4464 *
4465 * @param name The name of the desired item.
4466 *
4467 * @return the value of an item that previously added with putExtra()
4468 * or null if no CharSequence value was found.
4469 *
4470 * @see #putExtra(String, CharSequence)
4471 */
4472 public CharSequence getCharSequenceExtra(String name) {
4473 return mExtras == null ? null : mExtras.getCharSequence(name);
4474 }
4475
4476 /**
4477 * Retrieve extended data from the intent.
4478 *
4479 * @param name The name of the desired item.
4480 *
4481 * @return the value of an item that previously added with putExtra()
4482 * or null if no Parcelable value was found.
4483 *
4484 * @see #putExtra(String, Parcelable)
4485 */
4486 public <T extends Parcelable> T getParcelableExtra(String name) {
4487 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4488 }
4489
4490 /**
4491 * Retrieve extended data from the intent.
4492 *
4493 * @param name The name of the desired item.
4494 *
4495 * @return the value of an item that previously added with putExtra()
4496 * or null if no Parcelable[] value was found.
4497 *
4498 * @see #putExtra(String, Parcelable[])
4499 */
4500 public Parcelable[] getParcelableArrayExtra(String name) {
4501 return mExtras == null ? null : mExtras.getParcelableArray(name);
4502 }
4503
4504 /**
4505 * Retrieve extended data from the intent.
4506 *
4507 * @param name The name of the desired item.
4508 *
4509 * @return the value of an item that previously added with putExtra()
4510 * or null if no ArrayList<Parcelable> value was found.
4511 *
4512 * @see #putParcelableArrayListExtra(String, ArrayList)
4513 */
4514 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4515 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4516 }
4517
4518 /**
4519 * Retrieve extended data from the intent.
4520 *
4521 * @param name The name of the desired item.
4522 *
4523 * @return the value of an item that previously added with putExtra()
4524 * or null if no Serializable value was found.
4525 *
4526 * @see #putExtra(String, Serializable)
4527 */
4528 public Serializable getSerializableExtra(String name) {
4529 return mExtras == null ? null : mExtras.getSerializable(name);
4530 }
4531
4532 /**
4533 * Retrieve extended data from the intent.
4534 *
4535 * @param name The name of the desired item.
4536 *
4537 * @return the value of an item that previously added with putExtra()
4538 * or null if no ArrayList<Integer> value was found.
4539 *
4540 * @see #putIntegerArrayListExtra(String, ArrayList)
4541 */
4542 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4543 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4544 }
4545
4546 /**
4547 * Retrieve extended data from the intent.
4548 *
4549 * @param name The name of the desired item.
4550 *
4551 * @return the value of an item that previously added with putExtra()
4552 * or null if no ArrayList<String> value was found.
4553 *
4554 * @see #putStringArrayListExtra(String, ArrayList)
4555 */
4556 public ArrayList<String> getStringArrayListExtra(String name) {
4557 return mExtras == null ? null : mExtras.getStringArrayList(name);
4558 }
4559
4560 /**
4561 * Retrieve extended data from the intent.
4562 *
4563 * @param name The name of the desired item.
4564 *
4565 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004566 * or null if no ArrayList<CharSequence> value was found.
4567 *
4568 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4569 */
4570 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4571 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4572 }
4573
4574 /**
4575 * Retrieve extended data from the intent.
4576 *
4577 * @param name The name of the desired item.
4578 *
4579 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004580 * or null if no boolean array value was found.
4581 *
4582 * @see #putExtra(String, boolean[])
4583 */
4584 public boolean[] getBooleanArrayExtra(String name) {
4585 return mExtras == null ? null : mExtras.getBooleanArray(name);
4586 }
4587
4588 /**
4589 * Retrieve extended data from the intent.
4590 *
4591 * @param name The name of the desired item.
4592 *
4593 * @return the value of an item that previously added with putExtra()
4594 * or null if no byte array value was found.
4595 *
4596 * @see #putExtra(String, byte[])
4597 */
4598 public byte[] getByteArrayExtra(String name) {
4599 return mExtras == null ? null : mExtras.getByteArray(name);
4600 }
4601
4602 /**
4603 * Retrieve extended data from the intent.
4604 *
4605 * @param name The name of the desired item.
4606 *
4607 * @return the value of an item that previously added with putExtra()
4608 * or null if no short array value was found.
4609 *
4610 * @see #putExtra(String, short[])
4611 */
4612 public short[] getShortArrayExtra(String name) {
4613 return mExtras == null ? null : mExtras.getShortArray(name);
4614 }
4615
4616 /**
4617 * Retrieve extended data from the intent.
4618 *
4619 * @param name The name of the desired item.
4620 *
4621 * @return the value of an item that previously added with putExtra()
4622 * or null if no char array value was found.
4623 *
4624 * @see #putExtra(String, char[])
4625 */
4626 public char[] getCharArrayExtra(String name) {
4627 return mExtras == null ? null : mExtras.getCharArray(name);
4628 }
4629
4630 /**
4631 * Retrieve extended data from the intent.
4632 *
4633 * @param name The name of the desired item.
4634 *
4635 * @return the value of an item that previously added with putExtra()
4636 * or null if no int array value was found.
4637 *
4638 * @see #putExtra(String, int[])
4639 */
4640 public int[] getIntArrayExtra(String name) {
4641 return mExtras == null ? null : mExtras.getIntArray(name);
4642 }
4643
4644 /**
4645 * Retrieve extended data from the intent.
4646 *
4647 * @param name The name of the desired item.
4648 *
4649 * @return the value of an item that previously added with putExtra()
4650 * or null if no long array value was found.
4651 *
4652 * @see #putExtra(String, long[])
4653 */
4654 public long[] getLongArrayExtra(String name) {
4655 return mExtras == null ? null : mExtras.getLongArray(name);
4656 }
4657
4658 /**
4659 * Retrieve extended data from the intent.
4660 *
4661 * @param name The name of the desired item.
4662 *
4663 * @return the value of an item that previously added with putExtra()
4664 * or null if no float array value was found.
4665 *
4666 * @see #putExtra(String, float[])
4667 */
4668 public float[] getFloatArrayExtra(String name) {
4669 return mExtras == null ? null : mExtras.getFloatArray(name);
4670 }
4671
4672 /**
4673 * Retrieve extended data from the intent.
4674 *
4675 * @param name The name of the desired item.
4676 *
4677 * @return the value of an item that previously added with putExtra()
4678 * or null if no double array value was found.
4679 *
4680 * @see #putExtra(String, double[])
4681 */
4682 public double[] getDoubleArrayExtra(String name) {
4683 return mExtras == null ? null : mExtras.getDoubleArray(name);
4684 }
4685
4686 /**
4687 * Retrieve extended data from the intent.
4688 *
4689 * @param name The name of the desired item.
4690 *
4691 * @return the value of an item that previously added with putExtra()
4692 * or null if no String array value was found.
4693 *
4694 * @see #putExtra(String, String[])
4695 */
4696 public String[] getStringArrayExtra(String name) {
4697 return mExtras == null ? null : mExtras.getStringArray(name);
4698 }
4699
4700 /**
4701 * Retrieve extended data from the intent.
4702 *
4703 * @param name The name of the desired item.
4704 *
4705 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004706 * or null if no CharSequence array value was found.
4707 *
4708 * @see #putExtra(String, CharSequence[])
4709 */
4710 public CharSequence[] getCharSequenceArrayExtra(String name) {
4711 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4712 }
4713
4714 /**
4715 * Retrieve extended data from the intent.
4716 *
4717 * @param name The name of the desired item.
4718 *
4719 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004720 * or null if no Bundle value was found.
4721 *
4722 * @see #putExtra(String, Bundle)
4723 */
4724 public Bundle getBundleExtra(String name) {
4725 return mExtras == null ? null : mExtras.getBundle(name);
4726 }
4727
4728 /**
4729 * Retrieve extended data from the intent.
4730 *
4731 * @param name The name of the desired item.
4732 *
4733 * @return the value of an item that previously added with putExtra()
4734 * or null if no IBinder value was found.
4735 *
4736 * @see #putExtra(String, IBinder)
4737 *
4738 * @deprecated
4739 * @hide
4740 */
4741 @Deprecated
4742 public IBinder getIBinderExtra(String name) {
4743 return mExtras == null ? null : mExtras.getIBinder(name);
4744 }
4745
4746 /**
4747 * Retrieve extended data from the intent.
4748 *
4749 * @param name The name of the desired item.
4750 * @param defaultValue The default value to return in case no item is
4751 * associated with the key 'name'
4752 *
4753 * @return the value of an item that previously added with putExtra()
4754 * or defaultValue if none was found.
4755 *
4756 * @see #putExtra
4757 *
4758 * @deprecated
4759 * @hide
4760 */
4761 @Deprecated
4762 public Object getExtra(String name, Object defaultValue) {
4763 Object result = defaultValue;
4764 if (mExtras != null) {
4765 Object result2 = mExtras.get(name);
4766 if (result2 != null) {
4767 result = result2;
4768 }
4769 }
4770
4771 return result;
4772 }
4773
4774 /**
4775 * Retrieves a map of extended data from the intent.
4776 *
4777 * @return the map of all extras previously added with putExtra(),
4778 * or null if none have been added.
4779 */
4780 public Bundle getExtras() {
4781 return (mExtras != null)
4782 ? new Bundle(mExtras)
4783 : null;
4784 }
4785
4786 /**
4787 * Retrieve any special flags associated with this intent. You will
4788 * normally just set them with {@link #setFlags} and let the system
4789 * take the appropriate action with them.
4790 *
4791 * @return int The currently set flags.
4792 *
4793 * @see #setFlags
4794 */
4795 public int getFlags() {
4796 return mFlags;
4797 }
4798
Dianne Hackborne7f97212011-02-24 14:40:20 -08004799 /** @hide */
4800 public boolean isExcludingStopped() {
4801 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4802 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4803 }
4804
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004805 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004806 * Retrieve the application package name this Intent is limited to. When
4807 * resolving an Intent, if non-null this limits the resolution to only
4808 * components in the given application package.
4809 *
4810 * @return The name of the application package for the Intent.
4811 *
4812 * @see #resolveActivity
4813 * @see #setPackage
4814 */
4815 public String getPackage() {
4816 return mPackage;
4817 }
4818
4819 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004820 * Retrieve the concrete component associated with the intent. When receiving
4821 * an intent, this is the component that was found to best handle it (that is,
4822 * yourself) and will always be non-null; in all other cases it will be
4823 * null unless explicitly set.
4824 *
4825 * @return The name of the application component to handle the intent.
4826 *
4827 * @see #resolveActivity
4828 * @see #setComponent
4829 */
4830 public ComponentName getComponent() {
4831 return mComponent;
4832 }
4833
4834 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004835 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4836 * used as a hint to the receiver for animations and the like. Null means that there
4837 * is no source bounds.
4838 */
4839 public Rect getSourceBounds() {
4840 return mSourceBounds;
4841 }
4842
4843 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004844 * Return the Activity component that should be used to handle this intent.
4845 * The appropriate component is determined based on the information in the
4846 * intent, evaluated as follows:
4847 *
4848 * <p>If {@link #getComponent} returns an explicit class, that is returned
4849 * without any further consideration.
4850 *
4851 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4852 * category to be considered.
4853 *
4854 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4855 * action.
4856 *
4857 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4858 * this type.
4859 *
4860 * <p>If {@link #addCategory} has added any categories, the activity must
4861 * handle ALL of the categories specified.
4862 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004863 * <p>If {@link #getPackage} is non-NULL, only activity components in
4864 * that application package will be considered.
4865 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004866 * <p>If there are no activities that satisfy all of these conditions, a
4867 * null string is returned.
4868 *
4869 * <p>If multiple activities are found to satisfy the intent, the one with
4870 * the highest priority will be used. If there are multiple activities
4871 * with the same priority, the system will either pick the best activity
4872 * based on user preference, or resolve to a system class that will allow
4873 * the user to pick an activity and forward from there.
4874 *
4875 * <p>This method is implemented simply by calling
4876 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4877 * true.</p>
4878 * <p> This API is called for you as part of starting an activity from an
4879 * intent. You do not normally need to call it yourself.</p>
4880 *
4881 * @param pm The package manager with which to resolve the Intent.
4882 *
4883 * @return Name of the component implementing an activity that can
4884 * display the intent.
4885 *
4886 * @see #setComponent
4887 * @see #getComponent
4888 * @see #resolveActivityInfo
4889 */
4890 public ComponentName resolveActivity(PackageManager pm) {
4891 if (mComponent != null) {
4892 return mComponent;
4893 }
4894
4895 ResolveInfo info = pm.resolveActivity(
4896 this, PackageManager.MATCH_DEFAULT_ONLY);
4897 if (info != null) {
4898 return new ComponentName(
4899 info.activityInfo.applicationInfo.packageName,
4900 info.activityInfo.name);
4901 }
4902
4903 return null;
4904 }
4905
4906 /**
4907 * Resolve the Intent into an {@link ActivityInfo}
4908 * describing the activity that should execute the intent. Resolution
4909 * follows the same rules as described for {@link #resolveActivity}, but
4910 * you get back the completely information about the resolved activity
4911 * instead of just its class name.
4912 *
4913 * @param pm The package manager with which to resolve the Intent.
4914 * @param flags Addition information to retrieve as per
4915 * {@link PackageManager#getActivityInfo(ComponentName, int)
4916 * PackageManager.getActivityInfo()}.
4917 *
4918 * @return PackageManager.ActivityInfo
4919 *
4920 * @see #resolveActivity
4921 */
4922 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4923 ActivityInfo ai = null;
4924 if (mComponent != null) {
4925 try {
4926 ai = pm.getActivityInfo(mComponent, flags);
4927 } catch (PackageManager.NameNotFoundException e) {
4928 // ignore
4929 }
4930 } else {
4931 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004932 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004933 if (info != null) {
4934 ai = info.activityInfo;
4935 }
4936 }
4937
4938 return ai;
4939 }
4940
4941 /**
4942 * Set the general action to be performed.
4943 *
4944 * @param action An action name, such as ACTION_VIEW. Application-specific
4945 * actions should be prefixed with the vendor's package name.
4946 *
4947 * @return Returns the same Intent object, for chaining multiple calls
4948 * into a single statement.
4949 *
4950 * @see #getAction
4951 */
4952 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004953 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004954 return this;
4955 }
4956
4957 /**
4958 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004959 * clears any type that was previously set by {@link #setType} or
4960 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004961 *
Nick Pellyccae4122012-01-09 14:12:58 -08004962 * <p><em>Note: scheme matching in the Android framework is
4963 * case-sensitive, unlike the formal RFC. As a result,
4964 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004965 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004966 * {@link #setDataAndNormalize}
4967 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004968 *
Nick Pellyccae4122012-01-09 14:12:58 -08004969 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004970 *
4971 * @return Returns the same Intent object, for chaining multiple calls
4972 * into a single statement.
4973 *
4974 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004975 * @see #setDataAndNormalize
4976 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004977 */
4978 public Intent setData(Uri data) {
4979 mData = data;
4980 mType = null;
4981 return this;
4982 }
4983
4984 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004985 * Normalize and set the data this intent is operating on.
4986 *
4987 * <p>This method automatically clears any type that was
4988 * previously set (for example, by {@link #setType}).
4989 *
4990 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004991 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004992 * so really this is just a convenience method for
4993 * <pre>
4994 * setData(data.normalize())
4995 * </pre>
4996 *
4997 * @param data The Uri of the data this intent is now targeting.
4998 *
4999 * @return Returns the same Intent object, for chaining multiple calls
5000 * into a single statement.
5001 *
5002 * @see #getData
5003 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005004 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005005 */
5006 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005007 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005008 }
5009
5010 /**
5011 * Set an explicit MIME data type.
5012 *
5013 * <p>This is used to create intents that only specify a type and not data,
5014 * for example to indicate the type of data to return.
5015 *
5016 * <p>This method automatically clears any data that was
5017 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005018 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005019 * <p><em>Note: MIME type matching in the Android framework is
5020 * case-sensitive, unlike formal RFC MIME types. As a result,
5021 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005022 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5023 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005024 *
5025 * @param type The MIME type of the data being handled by this intent.
5026 *
5027 * @return Returns the same Intent object, for chaining multiple calls
5028 * into a single statement.
5029 *
5030 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005031 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005032 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005033 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005034 */
5035 public Intent setType(String type) {
5036 mData = null;
5037 mType = type;
5038 return this;
5039 }
5040
5041 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005042 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005043 *
Nick Pellyccae4122012-01-09 14:12:58 -08005044 * <p>This is used to create intents that only specify a type and not data,
5045 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005046 *
Nick Pellyccae4122012-01-09 14:12:58 -08005047 * <p>This method automatically clears any data that was
5048 * previously set (for example by {@link #setData}).
5049 *
5050 * <p>The MIME type is normalized using
5051 * {@link #normalizeMimeType} before it is set,
5052 * so really this is just a convenience method for
5053 * <pre>
5054 * setType(Intent.normalizeMimeType(type))
5055 * </pre>
5056 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005057 * @param type The MIME type of the data being handled by this intent.
5058 *
5059 * @return Returns the same Intent object, for chaining multiple calls
5060 * into a single statement.
5061 *
Nick Pellyccae4122012-01-09 14:12:58 -08005062 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005063 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005064 * @see #normalizeMimeType
5065 */
5066 public Intent setTypeAndNormalize(String type) {
5067 return setType(normalizeMimeType(type));
5068 }
5069
5070 /**
5071 * (Usually optional) Set the data for the intent along with an explicit
5072 * MIME data type. This method should very rarely be used -- it allows you
5073 * to override the MIME type that would ordinarily be inferred from the
5074 * data with your own type given here.
5075 *
5076 * <p><em>Note: MIME type and Uri scheme matching in the
5077 * Android framework is case-sensitive, unlike the formal RFC definitions.
5078 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005079 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005080 * {@link #setDataAndTypeAndNormalize}
5081 * to ensure that they are converted to lower case.</em>
5082 *
5083 * @param data The Uri of the data this intent is now targeting.
5084 * @param type The MIME type of the data being handled by this intent.
5085 *
5086 * @return Returns the same Intent object, for chaining multiple calls
5087 * into a single statement.
5088 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005089 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005090 * @see #setData
5091 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005092 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005093 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005094 */
5095 public Intent setDataAndType(Uri data, String type) {
5096 mData = data;
5097 mType = type;
5098 return this;
5099 }
5100
5101 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005102 * (Usually optional) Normalize and set both the data Uri and an explicit
5103 * MIME data type. This method should very rarely be used -- it allows you
5104 * to override the MIME type that would ordinarily be inferred from the
5105 * data with your own type given here.
5106 *
5107 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005108 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005109 * before they are set, so really this is just a convenience method for
5110 * <pre>
5111 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5112 * </pre>
5113 *
5114 * @param data The Uri of the data this intent is now targeting.
5115 * @param type The MIME type of the data being handled by this intent.
5116 *
5117 * @return Returns the same Intent object, for chaining multiple calls
5118 * into a single statement.
5119 *
5120 * @see #setType
5121 * @see #setData
5122 * @see #setDataAndType
5123 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005124 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005125 */
5126 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005127 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005128 }
5129
5130 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005131 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005132 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005133 * activities that provide <em>all</em> of the requested categories will be
5134 * used.
5135 *
5136 * @param category The desired category. This can be either one of the
5137 * predefined Intent categories, or a custom category in your own
5138 * namespace.
5139 *
5140 * @return Returns the same Intent object, for chaining multiple calls
5141 * into a single statement.
5142 *
5143 * @see #hasCategory
5144 * @see #removeCategory
5145 */
5146 public Intent addCategory(String category) {
5147 if (mCategories == null) {
5148 mCategories = new HashSet<String>();
5149 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005150 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005151 return this;
5152 }
5153
5154 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005155 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005156 *
5157 * @param category The category to remove.
5158 *
5159 * @see #addCategory
5160 */
5161 public void removeCategory(String category) {
5162 if (mCategories != null) {
5163 mCategories.remove(category);
5164 if (mCategories.size() == 0) {
5165 mCategories = null;
5166 }
5167 }
5168 }
5169
5170 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005171 * Set a selector for this Intent. This is a modification to the kinds of
5172 * things the Intent will match. If the selector is set, it will be used
5173 * when trying to find entities that can handle the Intent, instead of the
5174 * main contents of the Intent. This allows you build an Intent containing
5175 * a generic protocol while targeting it more specifically.
5176 *
5177 * <p>An example of where this may be used is with things like
5178 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5179 * Intent that will launch the Browser application. However, the correct
5180 * main entry point of an application is actually {@link #ACTION_MAIN}
5181 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5182 * used to specify the actual Activity to launch. If you launch the browser
5183 * with something different, undesired behavior may happen if the user has
5184 * previously or later launches it the normal way, since they do not match.
5185 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5186 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5187 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5188 *
5189 * <p>Setting a selector does not impact the behavior of
5190 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5191 * desired behavior of a selector -- it does not impact the base meaning
5192 * of the Intent, just what kinds of things will be matched against it
5193 * when determining who can handle it.</p>
5194 *
5195 * <p>You can not use both a selector and {@link #setPackage(String)} on
5196 * the same base Intent.</p>
5197 *
5198 * @param selector The desired selector Intent; set to null to not use
5199 * a special selector.
5200 */
5201 public void setSelector(Intent selector) {
5202 if (selector == this) {
5203 throw new IllegalArgumentException(
5204 "Intent being set as a selector of itself");
5205 }
5206 if (selector != null && mPackage != null) {
5207 throw new IllegalArgumentException(
5208 "Can't set selector when package name is already set");
5209 }
5210 mSelector = selector;
5211 }
5212
5213 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005214 * Set a {@link ClipData} associated with this Intent. This replaces any
5215 * previously set ClipData.
5216 *
5217 * <p>The ClipData in an intent is not used for Intent matching or other
5218 * such operations. Semantically it is like extras, used to transmit
5219 * additional data with the Intent. The main feature of using this over
5220 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5221 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5222 * items included in the clip data. This is useful, in particular, if
5223 * you want to transmit an Intent containing multiple <code>content:</code>
5224 * URIs for which the recipient may not have global permission to access the
5225 * content provider.
5226 *
5227 * <p>If the ClipData contains items that are themselves Intents, any
5228 * grant flags in those Intents will be ignored. Only the top-level flags
5229 * of the main Intent are respected, and will be applied to all Uri or
5230 * Intent items in the clip (or sub-items of the clip).
5231 *
5232 * <p>The MIME type, label, and icon in the ClipData object are not
5233 * directly used by Intent. Applications should generally rely on the
5234 * MIME type of the Intent itself, not what it may find in the ClipData.
5235 * A common practice is to construct a ClipData for use with an Intent
5236 * with a MIME type of "*\/*".
5237 *
5238 * @param clip The new clip to set. May be null to clear the current clip.
5239 */
5240 public void setClipData(ClipData clip) {
5241 mClipData = clip;
5242 }
5243
5244 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005245 * Add extended data to the intent. The name must include a package
5246 * prefix, for example the app com.android.contacts would use names
5247 * like "com.android.contacts.ShowAll".
5248 *
5249 * @param name The name of the extra data, with package prefix.
5250 * @param value The boolean data value.
5251 *
5252 * @return Returns the same Intent object, for chaining multiple calls
5253 * into a single statement.
5254 *
5255 * @see #putExtras
5256 * @see #removeExtra
5257 * @see #getBooleanExtra(String, boolean)
5258 */
5259 public Intent putExtra(String name, boolean value) {
5260 if (mExtras == null) {
5261 mExtras = new Bundle();
5262 }
5263 mExtras.putBoolean(name, value);
5264 return this;
5265 }
5266
5267 /**
5268 * Add extended data to the intent. The name must include a package
5269 * prefix, for example the app com.android.contacts would use names
5270 * like "com.android.contacts.ShowAll".
5271 *
5272 * @param name The name of the extra data, with package prefix.
5273 * @param value The byte data value.
5274 *
5275 * @return Returns the same Intent object, for chaining multiple calls
5276 * into a single statement.
5277 *
5278 * @see #putExtras
5279 * @see #removeExtra
5280 * @see #getByteExtra(String, byte)
5281 */
5282 public Intent putExtra(String name, byte value) {
5283 if (mExtras == null) {
5284 mExtras = new Bundle();
5285 }
5286 mExtras.putByte(name, value);
5287 return this;
5288 }
5289
5290 /**
5291 * Add extended data to the intent. The name must include a package
5292 * prefix, for example the app com.android.contacts would use names
5293 * like "com.android.contacts.ShowAll".
5294 *
5295 * @param name The name of the extra data, with package prefix.
5296 * @param value The char data value.
5297 *
5298 * @return Returns the same Intent object, for chaining multiple calls
5299 * into a single statement.
5300 *
5301 * @see #putExtras
5302 * @see #removeExtra
5303 * @see #getCharExtra(String, char)
5304 */
5305 public Intent putExtra(String name, char value) {
5306 if (mExtras == null) {
5307 mExtras = new Bundle();
5308 }
5309 mExtras.putChar(name, value);
5310 return this;
5311 }
5312
5313 /**
5314 * Add extended data to the intent. The name must include a package
5315 * prefix, for example the app com.android.contacts would use names
5316 * like "com.android.contacts.ShowAll".
5317 *
5318 * @param name The name of the extra data, with package prefix.
5319 * @param value The short data value.
5320 *
5321 * @return Returns the same Intent object, for chaining multiple calls
5322 * into a single statement.
5323 *
5324 * @see #putExtras
5325 * @see #removeExtra
5326 * @see #getShortExtra(String, short)
5327 */
5328 public Intent putExtra(String name, short value) {
5329 if (mExtras == null) {
5330 mExtras = new Bundle();
5331 }
5332 mExtras.putShort(name, value);
5333 return this;
5334 }
5335
5336 /**
5337 * Add extended data to the intent. The name must include a package
5338 * prefix, for example the app com.android.contacts would use names
5339 * like "com.android.contacts.ShowAll".
5340 *
5341 * @param name The name of the extra data, with package prefix.
5342 * @param value The integer data value.
5343 *
5344 * @return Returns the same Intent object, for chaining multiple calls
5345 * into a single statement.
5346 *
5347 * @see #putExtras
5348 * @see #removeExtra
5349 * @see #getIntExtra(String, int)
5350 */
5351 public Intent putExtra(String name, int value) {
5352 if (mExtras == null) {
5353 mExtras = new Bundle();
5354 }
5355 mExtras.putInt(name, value);
5356 return this;
5357 }
5358
5359 /**
5360 * Add extended data to the intent. The name must include a package
5361 * prefix, for example the app com.android.contacts would use names
5362 * like "com.android.contacts.ShowAll".
5363 *
5364 * @param name The name of the extra data, with package prefix.
5365 * @param value The long data value.
5366 *
5367 * @return Returns the same Intent object, for chaining multiple calls
5368 * into a single statement.
5369 *
5370 * @see #putExtras
5371 * @see #removeExtra
5372 * @see #getLongExtra(String, long)
5373 */
5374 public Intent putExtra(String name, long value) {
5375 if (mExtras == null) {
5376 mExtras = new Bundle();
5377 }
5378 mExtras.putLong(name, value);
5379 return this;
5380 }
5381
5382 /**
5383 * Add extended data to the intent. The name must include a package
5384 * prefix, for example the app com.android.contacts would use names
5385 * like "com.android.contacts.ShowAll".
5386 *
5387 * @param name The name of the extra data, with package prefix.
5388 * @param value The float data value.
5389 *
5390 * @return Returns the same Intent object, for chaining multiple calls
5391 * into a single statement.
5392 *
5393 * @see #putExtras
5394 * @see #removeExtra
5395 * @see #getFloatExtra(String, float)
5396 */
5397 public Intent putExtra(String name, float value) {
5398 if (mExtras == null) {
5399 mExtras = new Bundle();
5400 }
5401 mExtras.putFloat(name, value);
5402 return this;
5403 }
5404
5405 /**
5406 * Add extended data to the intent. The name must include a package
5407 * prefix, for example the app com.android.contacts would use names
5408 * like "com.android.contacts.ShowAll".
5409 *
5410 * @param name The name of the extra data, with package prefix.
5411 * @param value The double data value.
5412 *
5413 * @return Returns the same Intent object, for chaining multiple calls
5414 * into a single statement.
5415 *
5416 * @see #putExtras
5417 * @see #removeExtra
5418 * @see #getDoubleExtra(String, double)
5419 */
5420 public Intent putExtra(String name, double value) {
5421 if (mExtras == null) {
5422 mExtras = new Bundle();
5423 }
5424 mExtras.putDouble(name, value);
5425 return this;
5426 }
5427
5428 /**
5429 * Add extended data to the intent. The name must include a package
5430 * prefix, for example the app com.android.contacts would use names
5431 * like "com.android.contacts.ShowAll".
5432 *
5433 * @param name The name of the extra data, with package prefix.
5434 * @param value The String data value.
5435 *
5436 * @return Returns the same Intent object, for chaining multiple calls
5437 * into a single statement.
5438 *
5439 * @see #putExtras
5440 * @see #removeExtra
5441 * @see #getStringExtra(String)
5442 */
5443 public Intent putExtra(String name, String value) {
5444 if (mExtras == null) {
5445 mExtras = new Bundle();
5446 }
5447 mExtras.putString(name, value);
5448 return this;
5449 }
5450
5451 /**
5452 * Add extended data to the intent. The name must include a package
5453 * prefix, for example the app com.android.contacts would use names
5454 * like "com.android.contacts.ShowAll".
5455 *
5456 * @param name The name of the extra data, with package prefix.
5457 * @param value The CharSequence data value.
5458 *
5459 * @return Returns the same Intent object, for chaining multiple calls
5460 * into a single statement.
5461 *
5462 * @see #putExtras
5463 * @see #removeExtra
5464 * @see #getCharSequenceExtra(String)
5465 */
5466 public Intent putExtra(String name, CharSequence value) {
5467 if (mExtras == null) {
5468 mExtras = new Bundle();
5469 }
5470 mExtras.putCharSequence(name, value);
5471 return this;
5472 }
5473
5474 /**
5475 * Add extended data to the intent. The name must include a package
5476 * prefix, for example the app com.android.contacts would use names
5477 * like "com.android.contacts.ShowAll".
5478 *
5479 * @param name The name of the extra data, with package prefix.
5480 * @param value The Parcelable data value.
5481 *
5482 * @return Returns the same Intent object, for chaining multiple calls
5483 * into a single statement.
5484 *
5485 * @see #putExtras
5486 * @see #removeExtra
5487 * @see #getParcelableExtra(String)
5488 */
5489 public Intent putExtra(String name, Parcelable value) {
5490 if (mExtras == null) {
5491 mExtras = new Bundle();
5492 }
5493 mExtras.putParcelable(name, value);
5494 return this;
5495 }
5496
5497 /**
5498 * Add extended data to the intent. The name must include a package
5499 * prefix, for example the app com.android.contacts would use names
5500 * like "com.android.contacts.ShowAll".
5501 *
5502 * @param name The name of the extra data, with package prefix.
5503 * @param value The Parcelable[] data value.
5504 *
5505 * @return Returns the same Intent object, for chaining multiple calls
5506 * into a single statement.
5507 *
5508 * @see #putExtras
5509 * @see #removeExtra
5510 * @see #getParcelableArrayExtra(String)
5511 */
5512 public Intent putExtra(String name, Parcelable[] value) {
5513 if (mExtras == null) {
5514 mExtras = new Bundle();
5515 }
5516 mExtras.putParcelableArray(name, value);
5517 return this;
5518 }
5519
5520 /**
5521 * Add extended data to the intent. The name must include a package
5522 * prefix, for example the app com.android.contacts would use names
5523 * like "com.android.contacts.ShowAll".
5524 *
5525 * @param name The name of the extra data, with package prefix.
5526 * @param value The ArrayList<Parcelable> data value.
5527 *
5528 * @return Returns the same Intent object, for chaining multiple calls
5529 * into a single statement.
5530 *
5531 * @see #putExtras
5532 * @see #removeExtra
5533 * @see #getParcelableArrayListExtra(String)
5534 */
5535 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5536 if (mExtras == null) {
5537 mExtras = new Bundle();
5538 }
5539 mExtras.putParcelableArrayList(name, value);
5540 return this;
5541 }
5542
5543 /**
5544 * Add extended data to the intent. The name must include a package
5545 * prefix, for example the app com.android.contacts would use names
5546 * like "com.android.contacts.ShowAll".
5547 *
5548 * @param name The name of the extra data, with package prefix.
5549 * @param value The ArrayList<Integer> data value.
5550 *
5551 * @return Returns the same Intent object, for chaining multiple calls
5552 * into a single statement.
5553 *
5554 * @see #putExtras
5555 * @see #removeExtra
5556 * @see #getIntegerArrayListExtra(String)
5557 */
5558 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5559 if (mExtras == null) {
5560 mExtras = new Bundle();
5561 }
5562 mExtras.putIntegerArrayList(name, value);
5563 return this;
5564 }
5565
5566 /**
5567 * Add extended data to the intent. The name must include a package
5568 * prefix, for example the app com.android.contacts would use names
5569 * like "com.android.contacts.ShowAll".
5570 *
5571 * @param name The name of the extra data, with package prefix.
5572 * @param value The ArrayList<String> data value.
5573 *
5574 * @return Returns the same Intent object, for chaining multiple calls
5575 * into a single statement.
5576 *
5577 * @see #putExtras
5578 * @see #removeExtra
5579 * @see #getStringArrayListExtra(String)
5580 */
5581 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5582 if (mExtras == null) {
5583 mExtras = new Bundle();
5584 }
5585 mExtras.putStringArrayList(name, value);
5586 return this;
5587 }
5588
5589 /**
5590 * Add extended data to the intent. The name must include a package
5591 * prefix, for example the app com.android.contacts would use names
5592 * like "com.android.contacts.ShowAll".
5593 *
5594 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005595 * @param value The ArrayList<CharSequence> data value.
5596 *
5597 * @return Returns the same Intent object, for chaining multiple calls
5598 * into a single statement.
5599 *
5600 * @see #putExtras
5601 * @see #removeExtra
5602 * @see #getCharSequenceArrayListExtra(String)
5603 */
5604 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5605 if (mExtras == null) {
5606 mExtras = new Bundle();
5607 }
5608 mExtras.putCharSequenceArrayList(name, value);
5609 return this;
5610 }
5611
5612 /**
5613 * Add extended data to the intent. The name must include a package
5614 * prefix, for example the app com.android.contacts would use names
5615 * like "com.android.contacts.ShowAll".
5616 *
5617 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005618 * @param value The Serializable data value.
5619 *
5620 * @return Returns the same Intent object, for chaining multiple calls
5621 * into a single statement.
5622 *
5623 * @see #putExtras
5624 * @see #removeExtra
5625 * @see #getSerializableExtra(String)
5626 */
5627 public Intent putExtra(String name, Serializable value) {
5628 if (mExtras == null) {
5629 mExtras = new Bundle();
5630 }
5631 mExtras.putSerializable(name, value);
5632 return this;
5633 }
5634
5635 /**
5636 * Add extended data to the intent. The name must include a package
5637 * prefix, for example the app com.android.contacts would use names
5638 * like "com.android.contacts.ShowAll".
5639 *
5640 * @param name The name of the extra data, with package prefix.
5641 * @param value The boolean array data value.
5642 *
5643 * @return Returns the same Intent object, for chaining multiple calls
5644 * into a single statement.
5645 *
5646 * @see #putExtras
5647 * @see #removeExtra
5648 * @see #getBooleanArrayExtra(String)
5649 */
5650 public Intent putExtra(String name, boolean[] value) {
5651 if (mExtras == null) {
5652 mExtras = new Bundle();
5653 }
5654 mExtras.putBooleanArray(name, value);
5655 return this;
5656 }
5657
5658 /**
5659 * Add extended data to the intent. The name must include a package
5660 * prefix, for example the app com.android.contacts would use names
5661 * like "com.android.contacts.ShowAll".
5662 *
5663 * @param name The name of the extra data, with package prefix.
5664 * @param value The byte array data value.
5665 *
5666 * @return Returns the same Intent object, for chaining multiple calls
5667 * into a single statement.
5668 *
5669 * @see #putExtras
5670 * @see #removeExtra
5671 * @see #getByteArrayExtra(String)
5672 */
5673 public Intent putExtra(String name, byte[] value) {
5674 if (mExtras == null) {
5675 mExtras = new Bundle();
5676 }
5677 mExtras.putByteArray(name, value);
5678 return this;
5679 }
5680
5681 /**
5682 * Add extended data to the intent. The name must include a package
5683 * prefix, for example the app com.android.contacts would use names
5684 * like "com.android.contacts.ShowAll".
5685 *
5686 * @param name The name of the extra data, with package prefix.
5687 * @param value The short array data value.
5688 *
5689 * @return Returns the same Intent object, for chaining multiple calls
5690 * into a single statement.
5691 *
5692 * @see #putExtras
5693 * @see #removeExtra
5694 * @see #getShortArrayExtra(String)
5695 */
5696 public Intent putExtra(String name, short[] value) {
5697 if (mExtras == null) {
5698 mExtras = new Bundle();
5699 }
5700 mExtras.putShortArray(name, value);
5701 return this;
5702 }
5703
5704 /**
5705 * Add extended data to the intent. The name must include a package
5706 * prefix, for example the app com.android.contacts would use names
5707 * like "com.android.contacts.ShowAll".
5708 *
5709 * @param name The name of the extra data, with package prefix.
5710 * @param value The char array data value.
5711 *
5712 * @return Returns the same Intent object, for chaining multiple calls
5713 * into a single statement.
5714 *
5715 * @see #putExtras
5716 * @see #removeExtra
5717 * @see #getCharArrayExtra(String)
5718 */
5719 public Intent putExtra(String name, char[] value) {
5720 if (mExtras == null) {
5721 mExtras = new Bundle();
5722 }
5723 mExtras.putCharArray(name, value);
5724 return this;
5725 }
5726
5727 /**
5728 * Add extended data to the intent. The name must include a package
5729 * prefix, for example the app com.android.contacts would use names
5730 * like "com.android.contacts.ShowAll".
5731 *
5732 * @param name The name of the extra data, with package prefix.
5733 * @param value The int array data value.
5734 *
5735 * @return Returns the same Intent object, for chaining multiple calls
5736 * into a single statement.
5737 *
5738 * @see #putExtras
5739 * @see #removeExtra
5740 * @see #getIntArrayExtra(String)
5741 */
5742 public Intent putExtra(String name, int[] value) {
5743 if (mExtras == null) {
5744 mExtras = new Bundle();
5745 }
5746 mExtras.putIntArray(name, value);
5747 return this;
5748 }
5749
5750 /**
5751 * Add extended data to the intent. The name must include a package
5752 * prefix, for example the app com.android.contacts would use names
5753 * like "com.android.contacts.ShowAll".
5754 *
5755 * @param name The name of the extra data, with package prefix.
5756 * @param value The byte array data value.
5757 *
5758 * @return Returns the same Intent object, for chaining multiple calls
5759 * into a single statement.
5760 *
5761 * @see #putExtras
5762 * @see #removeExtra
5763 * @see #getLongArrayExtra(String)
5764 */
5765 public Intent putExtra(String name, long[] value) {
5766 if (mExtras == null) {
5767 mExtras = new Bundle();
5768 }
5769 mExtras.putLongArray(name, value);
5770 return this;
5771 }
5772
5773 /**
5774 * Add extended data to the intent. The name must include a package
5775 * prefix, for example the app com.android.contacts would use names
5776 * like "com.android.contacts.ShowAll".
5777 *
5778 * @param name The name of the extra data, with package prefix.
5779 * @param value The float array data value.
5780 *
5781 * @return Returns the same Intent object, for chaining multiple calls
5782 * into a single statement.
5783 *
5784 * @see #putExtras
5785 * @see #removeExtra
5786 * @see #getFloatArrayExtra(String)
5787 */
5788 public Intent putExtra(String name, float[] value) {
5789 if (mExtras == null) {
5790 mExtras = new Bundle();
5791 }
5792 mExtras.putFloatArray(name, value);
5793 return this;
5794 }
5795
5796 /**
5797 * Add extended data to the intent. The name must include a package
5798 * prefix, for example the app com.android.contacts would use names
5799 * like "com.android.contacts.ShowAll".
5800 *
5801 * @param name The name of the extra data, with package prefix.
5802 * @param value The double array data value.
5803 *
5804 * @return Returns the same Intent object, for chaining multiple calls
5805 * into a single statement.
5806 *
5807 * @see #putExtras
5808 * @see #removeExtra
5809 * @see #getDoubleArrayExtra(String)
5810 */
5811 public Intent putExtra(String name, double[] value) {
5812 if (mExtras == null) {
5813 mExtras = new Bundle();
5814 }
5815 mExtras.putDoubleArray(name, value);
5816 return this;
5817 }
5818
5819 /**
5820 * Add extended data to the intent. The name must include a package
5821 * prefix, for example the app com.android.contacts would use names
5822 * like "com.android.contacts.ShowAll".
5823 *
5824 * @param name The name of the extra data, with package prefix.
5825 * @param value The String array data value.
5826 *
5827 * @return Returns the same Intent object, for chaining multiple calls
5828 * into a single statement.
5829 *
5830 * @see #putExtras
5831 * @see #removeExtra
5832 * @see #getStringArrayExtra(String)
5833 */
5834 public Intent putExtra(String name, String[] value) {
5835 if (mExtras == null) {
5836 mExtras = new Bundle();
5837 }
5838 mExtras.putStringArray(name, value);
5839 return this;
5840 }
5841
5842 /**
5843 * Add extended data to the intent. The name must include a package
5844 * prefix, for example the app com.android.contacts would use names
5845 * like "com.android.contacts.ShowAll".
5846 *
5847 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005848 * @param value The CharSequence array data value.
5849 *
5850 * @return Returns the same Intent object, for chaining multiple calls
5851 * into a single statement.
5852 *
5853 * @see #putExtras
5854 * @see #removeExtra
5855 * @see #getCharSequenceArrayExtra(String)
5856 */
5857 public Intent putExtra(String name, CharSequence[] value) {
5858 if (mExtras == null) {
5859 mExtras = new Bundle();
5860 }
5861 mExtras.putCharSequenceArray(name, value);
5862 return this;
5863 }
5864
5865 /**
5866 * Add extended data to the intent. The name must include a package
5867 * prefix, for example the app com.android.contacts would use names
5868 * like "com.android.contacts.ShowAll".
5869 *
5870 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005871 * @param value The Bundle data value.
5872 *
5873 * @return Returns the same Intent object, for chaining multiple calls
5874 * into a single statement.
5875 *
5876 * @see #putExtras
5877 * @see #removeExtra
5878 * @see #getBundleExtra(String)
5879 */
5880 public Intent putExtra(String name, Bundle value) {
5881 if (mExtras == null) {
5882 mExtras = new Bundle();
5883 }
5884 mExtras.putBundle(name, value);
5885 return this;
5886 }
5887
5888 /**
5889 * Add extended data to the intent. The name must include a package
5890 * prefix, for example the app com.android.contacts would use names
5891 * like "com.android.contacts.ShowAll".
5892 *
5893 * @param name The name of the extra data, with package prefix.
5894 * @param value The IBinder data value.
5895 *
5896 * @return Returns the same Intent object, for chaining multiple calls
5897 * into a single statement.
5898 *
5899 * @see #putExtras
5900 * @see #removeExtra
5901 * @see #getIBinderExtra(String)
5902 *
5903 * @deprecated
5904 * @hide
5905 */
5906 @Deprecated
5907 public Intent putExtra(String name, IBinder value) {
5908 if (mExtras == null) {
5909 mExtras = new Bundle();
5910 }
5911 mExtras.putIBinder(name, value);
5912 return this;
5913 }
5914
5915 /**
5916 * Copy all extras in 'src' in to this intent.
5917 *
5918 * @param src Contains the extras to copy.
5919 *
5920 * @see #putExtra
5921 */
5922 public Intent putExtras(Intent src) {
5923 if (src.mExtras != null) {
5924 if (mExtras == null) {
5925 mExtras = new Bundle(src.mExtras);
5926 } else {
5927 mExtras.putAll(src.mExtras);
5928 }
5929 }
5930 return this;
5931 }
5932
5933 /**
5934 * Add a set of extended data to the intent. The keys must include a package
5935 * prefix, for example the app com.android.contacts would use names
5936 * like "com.android.contacts.ShowAll".
5937 *
5938 * @param extras The Bundle of extras to add to this intent.
5939 *
5940 * @see #putExtra
5941 * @see #removeExtra
5942 */
5943 public Intent putExtras(Bundle extras) {
5944 if (mExtras == null) {
5945 mExtras = new Bundle();
5946 }
5947 mExtras.putAll(extras);
5948 return this;
5949 }
5950
5951 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005952 * Completely replace the extras in the Intent with the extras in the
5953 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005954 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005955 * @param src The exact extras contained in this Intent are copied
5956 * into the target intent, replacing any that were previously there.
5957 */
5958 public Intent replaceExtras(Intent src) {
5959 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5960 return this;
5961 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005962
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005963 /**
5964 * Completely replace the extras in the Intent with the given Bundle of
5965 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005966 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005967 * @param extras The new set of extras in the Intent, or null to erase
5968 * all extras.
5969 */
5970 public Intent replaceExtras(Bundle extras) {
5971 mExtras = extras != null ? new Bundle(extras) : null;
5972 return this;
5973 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005974
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005975 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005976 * Remove extended data from the intent.
5977 *
5978 * @see #putExtra
5979 */
5980 public void removeExtra(String name) {
5981 if (mExtras != null) {
5982 mExtras.remove(name);
5983 if (mExtras.size() == 0) {
5984 mExtras = null;
5985 }
5986 }
5987 }
5988
5989 /**
5990 * Set special flags controlling how this intent is handled. Most values
5991 * here depend on the type of component being executed by the Intent,
5992 * specifically the FLAG_ACTIVITY_* flags are all for use with
5993 * {@link Context#startActivity Context.startActivity()} and the
5994 * FLAG_RECEIVER_* flags are all for use with
5995 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5996 *
Scott Main7aee61f2011-02-08 11:25:01 -08005997 * <p>See the
5998 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5999 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006000 * the behavior of your application.
6001 *
6002 * @param flags The desired flags.
6003 *
6004 * @return Returns the same Intent object, for chaining multiple calls
6005 * into a single statement.
6006 *
6007 * @see #getFlags
6008 * @see #addFlags
6009 *
6010 * @see #FLAG_GRANT_READ_URI_PERMISSION
6011 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6012 * @see #FLAG_DEBUG_LOG_RESOLUTION
6013 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006014 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006015 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006016 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006017 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006018 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6019 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006020 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006021 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6022 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006023 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006024 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006025 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006026 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6027 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006028 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006029 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006030 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006031 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6032 */
6033 public Intent setFlags(int flags) {
6034 mFlags = flags;
6035 return this;
6036 }
6037
6038 /**
6039 * Add additional flags to the intent (or with existing flags
6040 * value).
6041 *
6042 * @param flags The new flags to set.
6043 *
6044 * @return Returns the same Intent object, for chaining multiple calls
6045 * into a single statement.
6046 *
6047 * @see #setFlags
6048 */
6049 public Intent addFlags(int flags) {
6050 mFlags |= flags;
6051 return this;
6052 }
6053
6054 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006055 * (Usually optional) Set an explicit application package name that limits
6056 * the components this Intent will resolve to. If left to the default
6057 * value of null, all components in all applications will considered.
6058 * If non-null, the Intent can only match the components in the given
6059 * application package.
6060 *
6061 * @param packageName The name of the application package to handle the
6062 * intent, or null to allow any application package.
6063 *
6064 * @return Returns the same Intent object, for chaining multiple calls
6065 * into a single statement.
6066 *
6067 * @see #getPackage
6068 * @see #resolveActivity
6069 */
6070 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006071 if (packageName != null && mSelector != null) {
6072 throw new IllegalArgumentException(
6073 "Can't set package name when selector is already set");
6074 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006075 mPackage = packageName;
6076 return this;
6077 }
6078
6079 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006080 * (Usually optional) Explicitly set the component to handle the intent.
6081 * If left with the default value of null, the system will determine the
6082 * appropriate class to use based on the other fields (action, data,
6083 * type, categories) in the Intent. If this class is defined, the
6084 * specified class will always be used regardless of the other fields. You
6085 * should only set this value when you know you absolutely want a specific
6086 * class to be used; otherwise it is better to let the system find the
6087 * appropriate class so that you will respect the installed applications
6088 * and user preferences.
6089 *
6090 * @param component The name of the application component to handle the
6091 * intent, or null to let the system find one for you.
6092 *
6093 * @return Returns the same Intent object, for chaining multiple calls
6094 * into a single statement.
6095 *
6096 * @see #setClass
6097 * @see #setClassName(Context, String)
6098 * @see #setClassName(String, String)
6099 * @see #getComponent
6100 * @see #resolveActivity
6101 */
6102 public Intent setComponent(ComponentName component) {
6103 mComponent = component;
6104 return this;
6105 }
6106
6107 /**
6108 * Convenience for calling {@link #setComponent} with an
6109 * explicit class name.
6110 *
6111 * @param packageContext A Context of the application package implementing
6112 * this class.
6113 * @param className The name of a class inside of the application package
6114 * that will be used as the component for this Intent.
6115 *
6116 * @return Returns the same Intent object, for chaining multiple calls
6117 * into a single statement.
6118 *
6119 * @see #setComponent
6120 * @see #setClass
6121 */
6122 public Intent setClassName(Context packageContext, String className) {
6123 mComponent = new ComponentName(packageContext, className);
6124 return this;
6125 }
6126
6127 /**
6128 * Convenience for calling {@link #setComponent} with an
6129 * explicit application package name and class name.
6130 *
6131 * @param packageName The name of the package implementing the desired
6132 * component.
6133 * @param className The name of a class inside of the application package
6134 * that will be used as the component for this Intent.
6135 *
6136 * @return Returns the same Intent object, for chaining multiple calls
6137 * into a single statement.
6138 *
6139 * @see #setComponent
6140 * @see #setClass
6141 */
6142 public Intent setClassName(String packageName, String className) {
6143 mComponent = new ComponentName(packageName, className);
6144 return this;
6145 }
6146
6147 /**
6148 * Convenience for calling {@link #setComponent(ComponentName)} with the
6149 * name returned by a {@link Class} object.
6150 *
6151 * @param packageContext A Context of the application package implementing
6152 * this class.
6153 * @param cls The class name to set, equivalent to
6154 * <code>setClassName(context, cls.getName())</code>.
6155 *
6156 * @return Returns the same Intent object, for chaining multiple calls
6157 * into a single statement.
6158 *
6159 * @see #setComponent
6160 */
6161 public Intent setClass(Context packageContext, Class<?> cls) {
6162 mComponent = new ComponentName(packageContext, cls);
6163 return this;
6164 }
6165
6166 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006167 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6168 * used as a hint to the receiver for animations and the like. Null means that there
6169 * is no source bounds.
6170 */
6171 public void setSourceBounds(Rect r) {
6172 if (r != null) {
6173 mSourceBounds = new Rect(r);
6174 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006175 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006176 }
6177 }
6178
6179 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006180 * Use with {@link #fillIn} to allow the current action value to be
6181 * overwritten, even if it is already set.
6182 */
6183 public static final int FILL_IN_ACTION = 1<<0;
6184
6185 /**
6186 * Use with {@link #fillIn} to allow the current data or type value
6187 * overwritten, even if it is already set.
6188 */
6189 public static final int FILL_IN_DATA = 1<<1;
6190
6191 /**
6192 * Use with {@link #fillIn} to allow the current categories to be
6193 * overwritten, even if they are already set.
6194 */
6195 public static final int FILL_IN_CATEGORIES = 1<<2;
6196
6197 /**
6198 * Use with {@link #fillIn} to allow the current component value to be
6199 * overwritten, even if it is already set.
6200 */
6201 public static final int FILL_IN_COMPONENT = 1<<3;
6202
6203 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006204 * Use with {@link #fillIn} to allow the current package value to be
6205 * overwritten, even if it is already set.
6206 */
6207 public static final int FILL_IN_PACKAGE = 1<<4;
6208
6209 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006210 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006211 * overwritten, even if it is already set.
6212 */
6213 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6214
6215 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006216 * Use with {@link #fillIn} to allow the current selector to be
6217 * overwritten, even if it is already set.
6218 */
6219 public static final int FILL_IN_SELECTOR = 1<<6;
6220
6221 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006222 * Use with {@link #fillIn} to allow the current ClipData to be
6223 * overwritten, even if it is already set.
6224 */
6225 public static final int FILL_IN_CLIP_DATA = 1<<7;
6226
6227 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006228 * Copy the contents of <var>other</var> in to this object, but only
6229 * where fields are not defined by this object. For purposes of a field
6230 * being defined, the following pieces of data in the Intent are
6231 * considered to be separate fields:
6232 *
6233 * <ul>
6234 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006235 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006236 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6237 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006238 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006239 * <li> component, as set by {@link #setComponent(ComponentName)} or
6240 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006241 * <li> source bounds, as set by {@link #setSourceBounds}.
6242 * <li> selector, as set by {@link #setSelector(Intent)}.
6243 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006244 * <li> each top-level name in the associated extras.
6245 * </ul>
6246 *
6247 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006248 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006249 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6250 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6251 * the restriction where the corresponding field will not be replaced if
6252 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006253 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006254 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6255 * is explicitly specified. The selector will only be copied if
6256 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006257 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006258 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6259 * and Intent B with {action="gotit", data-type="some/thing",
6260 * categories="one","two"}.
6261 *
6262 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6263 * containing: {action="gotit", data-type="some/thing",
6264 * categories="bar"}.
6265 *
6266 * @param other Another Intent whose values are to be used to fill in
6267 * the current one.
6268 * @param flags Options to control which fields can be filled in.
6269 *
6270 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006271 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006272 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6273 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006274 */
6275 public int fillIn(Intent other, int flags) {
6276 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006277 if (other.mAction != null
6278 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006279 mAction = other.mAction;
6280 changes |= FILL_IN_ACTION;
6281 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006282 if ((other.mData != null || other.mType != null)
6283 && ((mData == null && mType == null)
6284 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006285 mData = other.mData;
6286 mType = other.mType;
6287 changes |= FILL_IN_DATA;
6288 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006289 if (other.mCategories != null
6290 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006291 if (other.mCategories != null) {
6292 mCategories = new HashSet<String>(other.mCategories);
6293 }
6294 changes |= FILL_IN_CATEGORIES;
6295 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006296 if (other.mPackage != null
6297 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006298 // Only do this if mSelector is not set.
6299 if (mSelector == null) {
6300 mPackage = other.mPackage;
6301 changes |= FILL_IN_PACKAGE;
6302 }
6303 }
6304 // Selector is special: it can only be set if explicitly allowed,
6305 // for the same reason as the component name.
6306 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6307 if (mPackage == null) {
6308 mSelector = new Intent(other.mSelector);
6309 mPackage = null;
6310 changes |= FILL_IN_SELECTOR;
6311 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006312 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006313 if (other.mClipData != null
6314 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6315 mClipData = other.mClipData;
6316 changes |= FILL_IN_CLIP_DATA;
6317 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006318 // Component is special: it can -only- be set if explicitly allowed,
6319 // since otherwise the sender could force the intent somewhere the
6320 // originator didn't intend.
6321 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006322 mComponent = other.mComponent;
6323 changes |= FILL_IN_COMPONENT;
6324 }
6325 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006326 if (other.mSourceBounds != null
6327 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6328 mSourceBounds = new Rect(other.mSourceBounds);
6329 changes |= FILL_IN_SOURCE_BOUNDS;
6330 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006331 if (mExtras == null) {
6332 if (other.mExtras != null) {
6333 mExtras = new Bundle(other.mExtras);
6334 }
6335 } else if (other.mExtras != null) {
6336 try {
6337 Bundle newb = new Bundle(other.mExtras);
6338 newb.putAll(mExtras);
6339 mExtras = newb;
6340 } catch (RuntimeException e) {
6341 // Modifying the extras can cause us to unparcel the contents
6342 // of the bundle, and if we do this in the system process that
6343 // may fail. We really should handle this (i.e., the Bundle
6344 // impl shouldn't be on top of a plain map), but for now just
6345 // ignore it and keep the original contents. :(
6346 Log.w("Intent", "Failure filling in extras", e);
6347 }
6348 }
6349 return changes;
6350 }
6351
6352 /**
6353 * Wrapper class holding an Intent and implementing comparisons on it for
6354 * the purpose of filtering. The class implements its
6355 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6356 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6357 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6358 * on the wrapped Intent.
6359 */
6360 public static final class FilterComparison {
6361 private final Intent mIntent;
6362 private final int mHashCode;
6363
6364 public FilterComparison(Intent intent) {
6365 mIntent = intent;
6366 mHashCode = intent.filterHashCode();
6367 }
6368
6369 /**
6370 * Return the Intent that this FilterComparison represents.
6371 * @return Returns the Intent held by the FilterComparison. Do
6372 * not modify!
6373 */
6374 public Intent getIntent() {
6375 return mIntent;
6376 }
6377
6378 @Override
6379 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006380 if (obj instanceof FilterComparison) {
6381 Intent other = ((FilterComparison)obj).mIntent;
6382 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006383 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006384 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006385 }
6386
6387 @Override
6388 public int hashCode() {
6389 return mHashCode;
6390 }
6391 }
6392
6393 /**
6394 * Determine if two intents are the same for the purposes of intent
6395 * resolution (filtering). That is, if their action, data, type,
6396 * class, and categories are the same. This does <em>not</em> compare
6397 * any extra data included in the intents.
6398 *
6399 * @param other The other Intent to compare against.
6400 *
6401 * @return Returns true if action, data, type, class, and categories
6402 * are the same.
6403 */
6404 public boolean filterEquals(Intent other) {
6405 if (other == null) {
6406 return false;
6407 }
6408 if (mAction != other.mAction) {
6409 if (mAction != null) {
6410 if (!mAction.equals(other.mAction)) {
6411 return false;
6412 }
6413 } else {
6414 if (!other.mAction.equals(mAction)) {
6415 return false;
6416 }
6417 }
6418 }
6419 if (mData != other.mData) {
6420 if (mData != null) {
6421 if (!mData.equals(other.mData)) {
6422 return false;
6423 }
6424 } else {
6425 if (!other.mData.equals(mData)) {
6426 return false;
6427 }
6428 }
6429 }
6430 if (mType != other.mType) {
6431 if (mType != null) {
6432 if (!mType.equals(other.mType)) {
6433 return false;
6434 }
6435 } else {
6436 if (!other.mType.equals(mType)) {
6437 return false;
6438 }
6439 }
6440 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006441 if (mPackage != other.mPackage) {
6442 if (mPackage != null) {
6443 if (!mPackage.equals(other.mPackage)) {
6444 return false;
6445 }
6446 } else {
6447 if (!other.mPackage.equals(mPackage)) {
6448 return false;
6449 }
6450 }
6451 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006452 if (mComponent != other.mComponent) {
6453 if (mComponent != null) {
6454 if (!mComponent.equals(other.mComponent)) {
6455 return false;
6456 }
6457 } else {
6458 if (!other.mComponent.equals(mComponent)) {
6459 return false;
6460 }
6461 }
6462 }
6463 if (mCategories != other.mCategories) {
6464 if (mCategories != null) {
6465 if (!mCategories.equals(other.mCategories)) {
6466 return false;
6467 }
6468 } else {
6469 if (!other.mCategories.equals(mCategories)) {
6470 return false;
6471 }
6472 }
6473 }
6474
6475 return true;
6476 }
6477
6478 /**
6479 * Generate hash code that matches semantics of filterEquals().
6480 *
6481 * @return Returns the hash value of the action, data, type, class, and
6482 * categories.
6483 *
6484 * @see #filterEquals
6485 */
6486 public int filterHashCode() {
6487 int code = 0;
6488 if (mAction != null) {
6489 code += mAction.hashCode();
6490 }
6491 if (mData != null) {
6492 code += mData.hashCode();
6493 }
6494 if (mType != null) {
6495 code += mType.hashCode();
6496 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006497 if (mPackage != null) {
6498 code += mPackage.hashCode();
6499 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006500 if (mComponent != null) {
6501 code += mComponent.hashCode();
6502 }
6503 if (mCategories != null) {
6504 code += mCategories.hashCode();
6505 }
6506 return code;
6507 }
6508
6509 @Override
6510 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006511 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006512
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006513 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006514 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006515 b.append(" }");
6516
6517 return b.toString();
6518 }
6519
6520 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006521 public String toInsecureString() {
6522 StringBuilder b = new StringBuilder(128);
6523
6524 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006525 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006526 b.append(" }");
6527
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006528 return b.toString();
6529 }
Romain Guy4969af72009-06-17 10:53:19 -07006530
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006531 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006532 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006533 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006534
6535 b.append("Intent { ");
6536 toShortString(b, false, true, true, true);
6537 b.append(" }");
6538
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006539 return b.toString();
6540 }
6541
6542 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006543 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6544 StringBuilder b = new StringBuilder(128);
6545 toShortString(b, secure, comp, extras, clip);
6546 return b.toString();
6547 }
6548
6549 /** @hide */
6550 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6551 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006552 boolean first = true;
6553 if (mAction != null) {
6554 b.append("act=").append(mAction);
6555 first = false;
6556 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006557 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006558 if (!first) {
6559 b.append(' ');
6560 }
6561 first = false;
6562 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006563 Iterator<String> i = mCategories.iterator();
6564 boolean didone = false;
6565 while (i.hasNext()) {
6566 if (didone) b.append(",");
6567 didone = true;
6568 b.append(i.next());
6569 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006570 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006571 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006572 if (mData != null) {
6573 if (!first) {
6574 b.append(' ');
6575 }
6576 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006577 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006578 if (secure) {
6579 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006580 } else {
6581 b.append(mData);
6582 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006583 }
6584 if (mType != null) {
6585 if (!first) {
6586 b.append(' ');
6587 }
6588 first = false;
6589 b.append("typ=").append(mType);
6590 }
6591 if (mFlags != 0) {
6592 if (!first) {
6593 b.append(' ');
6594 }
6595 first = false;
6596 b.append("flg=0x").append(Integer.toHexString(mFlags));
6597 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006598 if (mPackage != null) {
6599 if (!first) {
6600 b.append(' ');
6601 }
6602 first = false;
6603 b.append("pkg=").append(mPackage);
6604 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006605 if (comp && mComponent != null) {
6606 if (!first) {
6607 b.append(' ');
6608 }
6609 first = false;
6610 b.append("cmp=").append(mComponent.flattenToShortString());
6611 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006612 if (mSourceBounds != null) {
6613 if (!first) {
6614 b.append(' ');
6615 }
6616 first = false;
6617 b.append("bnds=").append(mSourceBounds.toShortString());
6618 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006619 if (mClipData != null) {
6620 if (!first) {
6621 b.append(' ');
6622 }
6623 first = false;
6624 if (clip) {
6625 b.append("clip={");
6626 mClipData.toShortString(b);
6627 b.append('}');
6628 } else {
6629 b.append("(has clip)");
6630 }
6631 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006632 if (extras && mExtras != null) {
6633 if (!first) {
6634 b.append(' ');
6635 }
6636 first = false;
6637 b.append("(has extras)");
6638 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006639 if (mSelector != null) {
6640 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006641 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006642 b.append("}");
6643 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006644 }
6645
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006646 /**
6647 * Call {@link #toUri} with 0 flags.
6648 * @deprecated Use {@link #toUri} instead.
6649 */
6650 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006651 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006652 return toUri(0);
6653 }
6654
6655 /**
6656 * Convert this Intent into a String holding a URI representation of it.
6657 * The returned URI string has been properly URI encoded, so it can be
6658 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6659 * Intent's data as the base URI, with an additional fragment describing
6660 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006661 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006662 * <p>You can convert the returned string back to an Intent with
6663 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006664 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006665 * @param flags Additional operating flags. Either 0 or
6666 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006667 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006668 * @return Returns a URI encoding URI string describing the entire contents
6669 * of the Intent.
6670 */
6671 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006672 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006673 String scheme = null;
6674 if (mData != null) {
6675 String data = mData.toString();
6676 if ((flags&URI_INTENT_SCHEME) != 0) {
6677 final int N = data.length();
6678 for (int i=0; i<N; i++) {
6679 char c = data.charAt(i);
6680 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6681 || c == '.' || c == '-') {
6682 continue;
6683 }
6684 if (c == ':' && i > 0) {
6685 // Valid scheme.
6686 scheme = data.substring(0, i);
6687 uri.append("intent:");
6688 data = data.substring(i+1);
6689 break;
6690 }
Tom Taylord4a47292009-12-21 13:59:18 -08006691
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006692 // No scheme.
6693 break;
6694 }
6695 }
6696 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006697
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006698 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6699 uri.append("intent:");
6700 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006701
6702 uri.append("#Intent;");
6703
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006704 toUriInner(uri, scheme, flags);
6705 if (mSelector != null) {
6706 uri.append("SEL;");
6707 // Note that for now we are not going to try to handle the
6708 // data part; not clear how to represent this as a URI, and
6709 // not much utility in it.
6710 mSelector.toUriInner(uri, null, flags);
6711 }
6712
6713 uri.append("end");
6714
6715 return uri.toString();
6716 }
6717
6718 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006719 if (scheme != null) {
6720 uri.append("scheme=").append(scheme).append(';');
6721 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006722 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006723 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006724 }
6725 if (mCategories != null) {
6726 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006727 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006728 }
6729 }
6730 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006731 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006732 }
6733 if (mFlags != 0) {
6734 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6735 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006736 if (mPackage != null) {
6737 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6738 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006739 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006740 uri.append("component=").append(Uri.encode(
6741 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006742 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006743 if (mSourceBounds != null) {
6744 uri.append("sourceBounds=")
6745 .append(Uri.encode(mSourceBounds.flattenToString()))
6746 .append(';');
6747 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006748 if (mExtras != null) {
6749 for (String key : mExtras.keySet()) {
6750 final Object value = mExtras.get(key);
6751 char entryType =
6752 value instanceof String ? 'S' :
6753 value instanceof Boolean ? 'B' :
6754 value instanceof Byte ? 'b' :
6755 value instanceof Character ? 'c' :
6756 value instanceof Double ? 'd' :
6757 value instanceof Float ? 'f' :
6758 value instanceof Integer ? 'i' :
6759 value instanceof Long ? 'l' :
6760 value instanceof Short ? 's' :
6761 '\0';
6762
6763 if (entryType != '\0') {
6764 uri.append(entryType);
6765 uri.append('.');
6766 uri.append(Uri.encode(key));
6767 uri.append('=');
6768 uri.append(Uri.encode(value.toString()));
6769 uri.append(';');
6770 }
6771 }
6772 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006773 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006774
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006775 public int describeContents() {
6776 return (mExtras != null) ? mExtras.describeContents() : 0;
6777 }
6778
6779 public void writeToParcel(Parcel out, int flags) {
6780 out.writeString(mAction);
6781 Uri.writeToParcel(out, mData);
6782 out.writeString(mType);
6783 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006784 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006785 ComponentName.writeToParcel(mComponent, out);
6786
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006787 if (mSourceBounds != null) {
6788 out.writeInt(1);
6789 mSourceBounds.writeToParcel(out, flags);
6790 } else {
6791 out.writeInt(0);
6792 }
6793
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006794 if (mCategories != null) {
6795 out.writeInt(mCategories.size());
6796 for (String category : mCategories) {
6797 out.writeString(category);
6798 }
6799 } else {
6800 out.writeInt(0);
6801 }
6802
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006803 if (mSelector != null) {
6804 out.writeInt(1);
6805 mSelector.writeToParcel(out, flags);
6806 } else {
6807 out.writeInt(0);
6808 }
6809
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006810 if (mClipData != null) {
6811 out.writeInt(1);
6812 mClipData.writeToParcel(out, flags);
6813 } else {
6814 out.writeInt(0);
6815 }
6816
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006817 out.writeBundle(mExtras);
6818 }
6819
6820 public static final Parcelable.Creator<Intent> CREATOR
6821 = new Parcelable.Creator<Intent>() {
6822 public Intent createFromParcel(Parcel in) {
6823 return new Intent(in);
6824 }
6825 public Intent[] newArray(int size) {
6826 return new Intent[size];
6827 }
6828 };
6829
Dianne Hackborneb034652009-09-07 00:49:58 -07006830 /** @hide */
6831 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006832 readFromParcel(in);
6833 }
6834
6835 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006836 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006837 mData = Uri.CREATOR.createFromParcel(in);
6838 mType = in.readString();
6839 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006840 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006841 mComponent = ComponentName.readFromParcel(in);
6842
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006843 if (in.readInt() != 0) {
6844 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6845 }
6846
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006847 int N = in.readInt();
6848 if (N > 0) {
6849 mCategories = new HashSet<String>();
6850 int i;
6851 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006852 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006853 }
6854 } else {
6855 mCategories = null;
6856 }
6857
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006858 if (in.readInt() != 0) {
6859 mSelector = new Intent(in);
6860 }
6861
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006862 if (in.readInt() != 0) {
6863 mClipData = new ClipData(in);
6864 }
6865
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006866 mExtras = in.readBundle();
6867 }
6868
6869 /**
6870 * Parses the "intent" element (and its children) from XML and instantiates
6871 * an Intent object. The given XML parser should be located at the tag
6872 * where parsing should start (often named "intent"), from which the
6873 * basic action, data, type, and package and class name will be
6874 * retrieved. The function will then parse in to any child elements,
6875 * looking for <category android:name="xxx"> tags to add categories and
6876 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6877 * to the intent.
6878 *
6879 * @param resources The Resources to use when inflating resources.
6880 * @param parser The XML parser pointing at an "intent" tag.
6881 * @param attrs The AttributeSet interface for retrieving extended
6882 * attribute data at the current <var>parser</var> location.
6883 * @return An Intent object matching the XML data.
6884 * @throws XmlPullParserException If there was an XML parsing error.
6885 * @throws IOException If there was an I/O error.
6886 */
6887 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6888 throws XmlPullParserException, IOException {
6889 Intent intent = new Intent();
6890
6891 TypedArray sa = resources.obtainAttributes(attrs,
6892 com.android.internal.R.styleable.Intent);
6893
6894 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6895
6896 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6897 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6898 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6899
6900 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6901 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6902 if (packageName != null && className != null) {
6903 intent.setComponent(new ComponentName(packageName, className));
6904 }
6905
6906 sa.recycle();
6907
6908 int outerDepth = parser.getDepth();
6909 int type;
6910 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6911 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6912 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6913 continue;
6914 }
6915
6916 String nodeName = parser.getName();
6917 if (nodeName.equals("category")) {
6918 sa = resources.obtainAttributes(attrs,
6919 com.android.internal.R.styleable.IntentCategory);
6920 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6921 sa.recycle();
6922
6923 if (cat != null) {
6924 intent.addCategory(cat);
6925 }
6926 XmlUtils.skipCurrentTag(parser);
6927
6928 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006929 if (intent.mExtras == null) {
6930 intent.mExtras = new Bundle();
6931 }
6932 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6933 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006934
6935 } else {
6936 XmlUtils.skipCurrentTag(parser);
6937 }
6938 }
6939
6940 return intent;
6941 }
Nick Pellyccae4122012-01-09 14:12:58 -08006942
6943 /**
6944 * Normalize a MIME data type.
6945 *
6946 * <p>A normalized MIME type has white-space trimmed,
6947 * content-type parameters removed, and is lower-case.
6948 * This aligns the type with Android best practices for
6949 * intent filtering.
6950 *
6951 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6952 * "text/x-vCard" becomes "text/x-vcard".
6953 *
6954 * <p>All MIME types received from outside Android (such as user input,
6955 * or external sources like Bluetooth, NFC, or the Internet) should
6956 * be normalized before they are used to create an Intent.
6957 *
6958 * @param type MIME data type to normalize
6959 * @return normalized MIME data type, or null if the input was null
6960 * @see {@link #setType}
6961 * @see {@link #setTypeAndNormalize}
6962 */
6963 public static String normalizeMimeType(String type) {
6964 if (type == null) {
6965 return null;
6966 }
6967
6968 type = type.trim().toLowerCase(Locale.US);
6969
6970 final int semicolonIndex = type.indexOf(';');
6971 if (semicolonIndex != -1) {
6972 type = type.substring(0, semicolonIndex);
6973 }
6974 return type;
6975 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006976
6977 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07006978 * Prepare this {@link Intent} to leave an app process.
6979 *
6980 * @hide
6981 */
6982 public void prepareToLeaveProcess() {
6983 setAllowFds(false);
6984
6985 if (mSelector != null) {
6986 mSelector.prepareToLeaveProcess();
6987 }
6988 if (mClipData != null) {
6989 mClipData.prepareToLeaveProcess();
6990 }
6991
6992 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
6993 // There are several ACTION_MEDIA_* broadcasts that send file://
6994 // Uris, so only check common actions.
6995 if (ACTION_VIEW.equals(mAction) ||
6996 ACTION_EDIT.equals(mAction) ||
6997 ACTION_ATTACH_DATA.equals(mAction)) {
6998 mData.checkFileUriExposed("Intent.getData()");
6999 }
7000 }
7001 }
7002
7003 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007004 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007005 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7006 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007007 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007008 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007009 * @hide
7010 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007011 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007012 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007013 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007014
7015 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007016 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007017
7018 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007019 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007020 try {
7021 // Inspect target intent to see if we need to migrate
7022 final Intent target = getParcelableExtra(EXTRA_INTENT);
7023 if (target != null && target.migrateExtraStreamToClipData()) {
7024 // Since we migrated in child, we need to promote ClipData
7025 // and flags to ourselves to grant.
7026 setClipData(target.getClipData());
7027 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007028 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
7029 | FLAG_PERSIST_GRANT_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007030 return true;
7031 } else {
7032 return false;
7033 }
7034 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007035 }
7036
7037 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007038 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007039 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7040 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7041 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7042 if (stream != null || text != null || htmlText != null) {
7043 final ClipData clipData = new ClipData(
7044 null, new String[] { getType() },
7045 new ClipData.Item(text, htmlText, null, stream));
7046 setClipData(clipData);
7047 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007048 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007049 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007050 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007051 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007052
7053 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007054 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007055 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7056 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7057 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7058 int num = -1;
7059 if (streams != null) {
7060 num = streams.size();
7061 }
7062 if (texts != null) {
7063 if (num >= 0 && num != texts.size()) {
7064 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007065 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007066 }
7067 num = texts.size();
7068 }
7069 if (htmlTexts != null) {
7070 if (num >= 0 && num != htmlTexts.size()) {
7071 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007072 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007073 }
7074 num = htmlTexts.size();
7075 }
7076 if (num > 0) {
7077 final ClipData clipData = new ClipData(
7078 null, new String[] { getType() },
7079 makeClipItem(streams, texts, htmlTexts, 0));
7080
7081 for (int i = 1; i < num; i++) {
7082 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7083 }
7084
7085 setClipData(clipData);
7086 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007087 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007088 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007089 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007090 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007091 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007092
7093 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007094 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007095
7096 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7097 ArrayList<String> htmlTexts, int which) {
7098 Uri uri = streams != null ? streams.get(which) : null;
7099 CharSequence text = texts != null ? texts.get(which) : null;
7100 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7101 return new ClipData.Item(text, htmlText, null, uri);
7102 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007103}