blob: fc9572824f4107ff3bfcdafdac41fae7aad76900 [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.
Bjorn Bringert964e7d22013-03-12 19:35:57 +00001168 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001169 */
1170 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1171 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1172
1173 /**
Bjorn Bringert964e7d22013-03-12 19:35:57 +00001174 * An optional field on {@link #ACTION_ASSIST}
Bjorn Bringertbc086862013-03-01 12:59:24 +00001175 * containing the name of the current foreground application package at the time
1176 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001177 */
1178 public static final String EXTRA_ASSIST_PACKAGE
1179 = "android.intent.extra.ASSIST_PACKAGE";
1180
1181 /**
Bjorn Bringert964e7d22013-03-12 19:35:57 +00001182 * An optional field on {@link #ACTION_ASSIST}
Bjorn Bringertbc086862013-03-01 12:59:24 +00001183 * containing additional contextual information supplied by the current
1184 * foreground app at the time of the assist request. This is a {@link Bundle} of
1185 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001186 */
1187 public static final String EXTRA_ASSIST_CONTEXT
1188 = "android.intent.extra.ASSIST_CONTEXT";
1189
Jim Miller07994402012-05-02 14:22:27 -07001190 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001191 * Activity Action: List all available applications
1192 * <p>Input: Nothing.
1193 * <p>Output: nothing.
1194 */
1195 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1196 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1197 /**
1198 * Activity Action: Show settings for choosing wallpaper
1199 * <p>Input: Nothing.
1200 * <p>Output: Nothing.
1201 */
1202 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1203 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1204
1205 /**
1206 * Activity Action: Show activity for reporting a bug.
1207 * <p>Input: Nothing.
1208 * <p>Output: Nothing.
1209 */
1210 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1211 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1212
1213 /**
1214 * Activity Action: Main entry point for factory tests. Only used when
1215 * the device is booting in factory test node. The implementing package
1216 * must be installed in the system image.
1217 * <p>Input: nothing
1218 * <p>Output: nothing
1219 */
1220 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1221
1222 /**
1223 * Activity Action: The user pressed the "call" button to go to the dialer
1224 * or other appropriate UI for placing a call.
1225 * <p>Input: Nothing.
1226 * <p>Output: Nothing.
1227 */
1228 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1229 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1230
1231 /**
1232 * Activity Action: Start Voice Command.
1233 * <p>Input: Nothing.
1234 * <p>Output: Nothing.
1235 */
1236 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1237 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001238
1239 /**
1240 * Activity Action: Start action associated with long pressing on the
1241 * search key.
1242 * <p>Input: Nothing.
1243 * <p>Output: Nothing.
1244 */
1245 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1246 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001247
Jacek Surazski86b6c532009-05-13 14:38:28 +02001248 /**
1249 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1250 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001251 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001252 * <p>Input: No data is specified. The bug report is passed in using
1253 * an {@link #EXTRA_BUG_REPORT} field.
1254 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001255 *
1256 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001257 */
1258 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1259 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001260
1261 /**
1262 * Activity Action: Show power usage information to the user.
1263 * <p>Input: Nothing.
1264 * <p>Output: Nothing.
1265 */
1266 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1267 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001268
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001269 /**
1270 * Activity Action: Setup wizard to launch after a platform update. This
1271 * activity should have a string meta-data field associated with it,
1272 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1273 * the platform for setup. The activity will be launched only if
1274 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1275 * same value.
1276 * <p>Input: Nothing.
1277 * <p>Output: Nothing.
1278 * @hide
1279 */
1280 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1281 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001282
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001283 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001284 * Activity Action: Show settings for managing network data usage of a
1285 * specific application. Applications should define an activity that offers
1286 * options to control data usage.
1287 */
1288 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1289 public static final String ACTION_MANAGE_NETWORK_USAGE =
1290 "android.intent.action.MANAGE_NETWORK_USAGE";
1291
1292 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001293 * Activity Action: Launch application installer.
1294 * <p>
1295 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001296 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1297 * you can also use "package:<package-name>" to install an application for the
1298 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001299 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1300 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1301 * <p>
1302 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1303 * succeeded.
1304 *
1305 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1306 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1307 * @see #EXTRA_RETURN_RESULT
1308 */
1309 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1310 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1311
1312 /**
1313 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1314 * package. Specifies the installer package name; this package will receive the
1315 * {@link #ACTION_APP_ERROR} intent.
1316 */
1317 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1318 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1319
1320 /**
1321 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1322 * package. Specifies that the application being installed should not be
1323 * treated as coming from an unknown source, but as coming from the app
1324 * invoking the Intent. For this to work you must start the installer with
1325 * startActivityForResult().
1326 */
1327 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1328 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1329
1330 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001331 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1332 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001333 * data field originated from.
1334 */
rich cannings706e8ba2012-08-20 13:20:14 -07001335 public static final String EXTRA_ORIGINATING_URI
1336 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001337
1338 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001339 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1340 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1341 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001342 */
1343 public static final String EXTRA_REFERRER
1344 = "android.intent.extra.REFERRER";
1345
1346 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001347 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1348 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1349 * @hide
1350 */
1351 public static final String EXTRA_ORIGINATING_UID
1352 = "android.intent.extra.ORIGINATING_UID";
1353
1354 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001355 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1356 * package. Tells the installer UI to skip the confirmation with the user
1357 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001358 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1359 * will no longer show an interstitial message about updating existing
1360 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001361 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001362 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001363 public static final String EXTRA_ALLOW_REPLACE
1364 = "android.intent.extra.ALLOW_REPLACE";
1365
1366 /**
1367 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1368 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1369 * return to the application the result code of the install/uninstall. The returned result
1370 * code will be {@link android.app.Activity#RESULT_OK} on success or
1371 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1372 */
1373 public static final String EXTRA_RETURN_RESULT
1374 = "android.intent.extra.RETURN_RESULT";
1375
1376 /**
1377 * Package manager install result code. @hide because result codes are not
1378 * yet ready to be exposed.
1379 */
1380 public static final String EXTRA_INSTALL_RESULT
1381 = "android.intent.extra.INSTALL_RESULT";
1382
1383 /**
1384 * Activity Action: Launch application uninstaller.
1385 * <p>
1386 * Input: The data must be a package: URI whose scheme specific part is
1387 * the package name of the current installed package to be uninstalled.
1388 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1389 * <p>
1390 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1391 * succeeded.
1392 */
1393 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1394 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1395
1396 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001397 * Specify whether the package should be uninstalled for all users.
1398 * @hide because these should not be part of normal application flow.
1399 */
1400 public static final String EXTRA_UNINSTALL_ALL_USERS
1401 = "android.intent.extra.UNINSTALL_ALL_USERS";
1402
1403 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001404 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1405 * describing the last run version of the platform that was setup.
1406 * @hide
1407 */
1408 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1409
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001410 // ---------------------------------------------------------------------
1411 // ---------------------------------------------------------------------
1412 // Standard intent broadcast actions (see action variable).
1413
1414 /**
1415 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001416 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001417 * <p class="note">This is a protected intent that can only be sent
1418 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001419 */
1420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1421 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1422 /**
1423 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001424 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001425 * <p class="note">This is a protected intent that can only be sent
1426 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001427 */
1428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1429 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001430
1431 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001432 * Broadcast Action: Sent after the system stops dreaming.
1433 *
1434 * <p class="note">This is a protected intent that can only be sent by the system.
1435 * It is only sent to registered receivers.</p>
1436 */
1437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1438 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1439
1440 /**
1441 * Broadcast Action: Sent after the system starts dreaming.
1442 *
1443 * <p class="note">This is a protected intent that can only be sent by the system.
1444 * It is only sent to registered receivers.</p>
1445 */
1446 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1447 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1448
1449 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001450 * 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 -07001451 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001452 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001453 * <p class="note">This is a protected intent that can only be sent
1454 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001455 */
1456 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001457 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001459 /**
1460 * Broadcast Action: The current time has changed. Sent every
1461 * minute. You can <em>not</em> receive this through components declared
1462 * in manifests, only by exlicitly registering for it with
1463 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1464 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001465 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001466 * <p class="note">This is a protected intent that can only be sent
1467 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001468 */
1469 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1470 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1471 /**
1472 * Broadcast Action: The time was set.
1473 */
1474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1475 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1476 /**
1477 * Broadcast Action: The date has changed.
1478 */
1479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1480 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1481 /**
1482 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1483 * <ul>
1484 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1485 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001486 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001487 * <p class="note">This is a protected intent that can only be sent
1488 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001489 */
1490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1491 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1492 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001493 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1494 * DNS entries should be tossed.
1495 * @hide
1496 */
1497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1498 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1499 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001500 * Alarm Changed Action: This is broadcast when the AlarmClock
1501 * application's alarm is set or unset. It is used by the
1502 * AlarmClock application and the StatusBar service.
1503 * @hide
1504 */
1505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1506 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1507 /**
1508 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1509 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1510 * @hide
1511 */
1512 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1513 public static final String ACTION_SYNC_STATE_CHANGED
1514 = "android.intent.action.SYNC_STATE_CHANGED";
1515 /**
1516 * Broadcast Action: This is broadcast once, after the system has finished
1517 * booting. It can be used to perform application-specific initialization,
1518 * such as installing alarms. You must hold the
1519 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1520 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001521 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001522 * <p class="note">This is a protected intent that can only be sent
1523 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001524 */
1525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1526 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1527 /**
1528 * Broadcast Action: This is broadcast when a user action should request a
1529 * temporary system dialog to dismiss. Some examples of temporary system
1530 * dialogs are the notification window-shade and the recent tasks dialog.
1531 */
1532 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1533 /**
1534 * Broadcast Action: Trigger the download and eventual installation
1535 * of a package.
1536 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001537 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001538 * <p class="note">This is a protected intent that can only be sent
1539 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001540 *
1541 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001542 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001543 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001544 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1545 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1546 /**
1547 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001548 * device. The data contains the name of the package. Note that the
1549 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001550 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001551 * <ul>
1552 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1553 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1554 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1555 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001556 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001557 * <p class="note">This is a protected intent that can only be sent
1558 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1562 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001563 * Broadcast Action: A new version of an application package has been
1564 * installed, replacing an existing version that was previously installed.
1565 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001566 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001567 * <ul>
1568 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1569 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001570 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001571 * <p class="note">This is a protected intent that can only be sent
1572 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001573 */
1574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1575 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1576 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001577 * Broadcast Action: A new version of your application has been installed
1578 * over an existing one. This is only sent to the application that was
1579 * replaced. It does not contain any additional data; to receive it, just
1580 * use an intent filter for this action.
1581 *
1582 * <p class="note">This is a protected intent that can only be sent
1583 * by the system.
1584 */
1585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1586 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1587 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001588 * Broadcast Action: An existing application package has been removed from
1589 * the device. The data contains the name of the package. The package
1590 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001591 * <ul>
1592 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1593 * to the package.
1594 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1595 * application -- data and code -- is being removed.
1596 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1597 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1598 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001599 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001600 * <p class="note">This is a protected intent that can only be sent
1601 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001602 */
1603 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1604 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1605 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001606 * Broadcast Action: An existing application package has been completely
1607 * removed from the device. The data contains the name of the package.
1608 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1609 * {@link #EXTRA_DATA_REMOVED} is true and
1610 * {@link #EXTRA_REPLACING} is false of that broadcast.
1611 *
1612 * <ul>
1613 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1614 * to the package.
1615 * </ul>
1616 *
1617 * <p class="note">This is a protected intent that can only be sent
1618 * by the system.
1619 */
1620 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1621 public static final String ACTION_PACKAGE_FULLY_REMOVED
1622 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1623 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001624 * Broadcast Action: An existing application package has been changed (e.g.
1625 * a component has been enabled or disabled). The data contains the name of
1626 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001627 * <ul>
1628 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001629 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001630 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001631 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1632 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001633 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001634 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001635 * <p class="note">This is a protected intent that can only be sent
1636 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001637 */
1638 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1639 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1640 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001641 * @hide
1642 * Broadcast Action: Ask system services if there is any reason to
1643 * restart the given package. The data contains the name of the
1644 * package.
1645 * <ul>
1646 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1647 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1648 * </ul>
1649 *
1650 * <p class="note">This is a protected intent that can only be sent
1651 * by the system.
1652 */
1653 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1654 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1655 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001656 * Broadcast Action: The user has restarted a package, and all of its
1657 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001658 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001659 * be removed. Note that the restarted package does <em>not</em>
1660 * receive this broadcast.
1661 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001662 * <ul>
1663 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1664 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001665 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001666 * <p class="note">This is a protected intent that can only be sent
1667 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001668 */
1669 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1670 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1671 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001672 * Broadcast Action: The user has cleared the data of a package. This should
1673 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001674 * its persistent data is erased and this broadcast sent.
1675 * Note that the cleared package does <em>not</em>
1676 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001677 * <ul>
1678 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1679 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001680 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001681 * <p class="note">This is a protected intent that can only be sent
1682 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1685 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1686 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001687 * Broadcast Action: A user ID has been removed from the system. The user
1688 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001689 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001690 * <p class="note">This is a protected intent that can only be sent
1691 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001692 */
1693 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1694 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001695
1696 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001697 * Broadcast Action: Sent to the installer package of an application
1698 * when that application is first launched (that is the first time it
1699 * is moved out of the stopped state). The data contains the name of the package.
1700 *
1701 * <p class="note">This is a protected intent that can only be sent
1702 * by the system.
1703 */
1704 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1705 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1706
1707 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001708 * Broadcast Action: Sent to the system package verifier when a package
1709 * needs to be verified. The data contains the package URI.
1710 * <p class="note">
1711 * This is a protected intent that can only be sent by the system.
1712 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001713 */
1714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1715 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1716
1717 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001718 * Broadcast Action: Sent to the system package verifier when a package is
1719 * verified. The data contains the package URI.
1720 * <p class="note">
1721 * This is a protected intent that can only be sent by the system.
1722 */
1723 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1724 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1725
1726 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001727 * Broadcast Action: Resources for a set of packages (which were
1728 * previously unavailable) are currently
1729 * available since the media on which they exist is available.
1730 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1731 * list of packages whose availability changed.
1732 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1733 * list of uids of packages whose availability changed.
1734 * Note that the
1735 * packages in this list do <em>not</em> receive this broadcast.
1736 * The specified set of packages are now available on the system.
1737 * <p>Includes the following extras:
1738 * <ul>
1739 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1740 * whose resources(were previously unavailable) are currently available.
1741 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1742 * packages whose resources(were previously unavailable)
1743 * are currently available.
1744 * </ul>
1745 *
1746 * <p class="note">This is a protected intent that can only be sent
1747 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001748 */
1749 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001750 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1751 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001752
1753 /**
1754 * Broadcast Action: Resources for a set of packages are currently
1755 * unavailable since the media on which they exist is unavailable.
1756 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1757 * list of packages whose availability changed.
1758 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1759 * list of uids of packages whose availability changed.
1760 * The specified set of packages can no longer be
1761 * launched and are practically unavailable on the system.
1762 * <p>Inclues the following extras:
1763 * <ul>
1764 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1765 * whose resources are no longer available.
1766 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1767 * whose resources are no longer available.
1768 * </ul>
1769 *
1770 * <p class="note">This is a protected intent that can only be sent
1771 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001772 */
1773 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001774 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001775 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001776
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001777 /**
1778 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001779 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001780 * This should <em>only</em> be used to determine when the wallpaper
1781 * has changed to show the new wallpaper to the user. You should certainly
1782 * never, in response to this, change the wallpaper or other attributes of
1783 * it such as the suggested size. That would be crazy, right? You'd cause
1784 * all kinds of loops, especially if other apps are doing similar things,
1785 * right? Of course. So please don't do this.
1786 *
1787 * @deprecated Modern applications should use
1788 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1789 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1790 * shown behind their UI, rather than watching for this broadcast and
1791 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001792 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001793 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001794 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1795 /**
1796 * Broadcast Action: The current device {@link android.content.res.Configuration}
1797 * (orientation, locale, etc) has changed. When such a change happens, the
1798 * UIs (view hierarchy) will need to be rebuilt based on this new
1799 * information; for the most part, applications don't need to worry about
1800 * this, because the system will take care of stopping and restarting the
1801 * application to make sure it sees the new changes. Some system code that
1802 * can not be restarted will need to watch for this action and handle it
1803 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001804 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001805 * <p class="note">
1806 * You can <em>not</em> receive this through components declared
1807 * in manifests, only by explicitly registering for it with
1808 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1809 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001810 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001811 * <p class="note">This is a protected intent that can only be sent
1812 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001813 *
1814 * @see android.content.res.Configuration
1815 */
1816 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1817 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1818 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001819 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001820 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001821 * <p class="note">This is a protected intent that can only be sent
1822 * by the system.
1823 */
1824 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1825 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1826 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001827 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1828 * charging state, level, and other information about the battery.
1829 * See {@link android.os.BatteryManager} for documentation on the
1830 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001831 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001832 * <p class="note">
1833 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001834 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001835 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001836 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1837 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1838 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1839 * broadcasts that are sent and can be received through manifest
1840 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001841 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001842 * <p class="note">This is a protected intent that can only be sent
1843 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001844 */
1845 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1846 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1847 /**
1848 * Broadcast Action: Indicates low battery condition on the device.
1849 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001850 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001851 * <p class="note">This is a protected intent that can only be sent
1852 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001853 */
1854 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1855 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1856 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001857 * Broadcast Action: Indicates the battery is now okay after being low.
1858 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1859 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001860 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001861 * <p class="note">This is a protected intent that can only be sent
1862 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001863 */
1864 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1865 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1866 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001867 * Broadcast Action: External power has been connected to the device.
1868 * This is intended for applications that wish to register specifically to this notification.
1869 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1870 * stay active to receive this notification. This action can be used to implement actions
1871 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001872 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001873 * <p class="note">This is a protected intent that can only be sent
1874 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001875 */
1876 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001877 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001878 /**
1879 * Broadcast Action: External power has been removed from the device.
1880 * This is intended for applications that wish to register specifically to this notification.
1881 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1882 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001883 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001884 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001885 * <p class="note">This is a protected intent that can only be sent
1886 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001887 */
1888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001889 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001890 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001891 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001892 * Broadcast Action: Device is shutting down.
1893 * This is broadcast when the device is being shut down (completely turned
1894 * off, not sleeping). Once the broadcast is complete, the final shutdown
1895 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001896 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001897 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001898 * <p class="note">This is a protected intent that can only be sent
1899 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001902 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001903 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001904 * Activity Action: Start this activity to request system shutdown.
1905 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1906 * to request confirmation from the user before shutting down.
1907 *
1908 * <p class="note">This is a protected intent that can only be sent
1909 * by the system.
1910 *
1911 * {@hide}
1912 */
1913 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1914 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001915 * Broadcast Action: A sticky broadcast that indicates low memory
1916 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001917 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001918 * <p class="note">This is a protected intent that can only be sent
1919 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001920 */
1921 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1922 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1923 /**
1924 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001925 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001926 * <p class="note">This is a protected intent that can only be sent
1927 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1930 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1931 /**
Jake Hambybb371632010-08-23 18:16:48 -07001932 * Broadcast Action: A sticky broadcast that indicates a memory full
1933 * condition on the device. This is intended for activities that want
1934 * to be able to fill the data partition completely, leaving only
1935 * enough free space to prevent system-wide SQLite failures.
1936 *
1937 * <p class="note">This is a protected intent that can only be sent
1938 * by the system.
1939 *
1940 * {@hide}
1941 */
1942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1943 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1944 /**
1945 * Broadcast Action: Indicates memory full condition on the device
1946 * no longer exists.
1947 *
1948 * <p class="note">This is a protected intent that can only be sent
1949 * by the system.
1950 *
1951 * {@hide}
1952 */
1953 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1954 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1955 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001956 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1957 * and package management should be started.
1958 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1959 * notification.
1960 */
1961 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1962 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1963 /**
1964 * Broadcast Action: The device has entered USB Mass Storage mode.
1965 * This is used mainly for the USB Settings panel.
1966 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1967 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001968 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001969 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001970 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001971 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1972
1973 /**
1974 * Broadcast Action: The device has exited USB Mass Storage mode.
1975 * This is used mainly for the USB Settings panel.
1976 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1977 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001978 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001980 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1982
1983 /**
1984 * Broadcast Action: External media has been removed.
1985 * The path to the mount point for the removed media is contained in the Intent.mData field.
1986 */
1987 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1988 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1989
1990 /**
1991 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001992 * 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 -07001993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1996
1997 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001998 * Broadcast Action: External media is present, and being disk-checked
1999 * 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 -08002000 */
2001 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2002 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2003
2004 /**
2005 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2006 * 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 -08002007 */
2008 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2009 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2010
2011 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002013 * 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 -07002014 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2015 * media was mounted read only.
2016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2019
2020 /**
2021 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002022 * 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 -07002023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2026
2027 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002028 * Broadcast Action: External media is no longer being shared via USB mass storage.
2029 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2030 *
2031 * @hide
2032 */
2033 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2034
2035 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002036 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2037 * The path to the mount point for the removed media is contained in the Intent.mData field.
2038 */
2039 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2040 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2041
2042 /**
2043 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002044 * 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 -07002045 */
2046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2047 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2048
2049 /**
2050 * Broadcast Action: User has expressed the desire to remove the external storage media.
2051 * Applications should close all files they have open within the mount point when they receive this intent.
2052 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2056
2057 /**
2058 * Broadcast Action: The media scanner has started scanning a directory.
2059 * The path to the directory being scanned is contained in the Intent.mData field.
2060 */
2061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2063
2064 /**
2065 * Broadcast Action: The media scanner has finished scanning a directory.
2066 * The path to the scanned directory is contained in the Intent.mData field.
2067 */
2068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2070
2071 /**
2072 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2073 * The path to the file is contained in the Intent.mData field.
2074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2077
2078 /**
2079 * Broadcast Action: The "Media Button" was pressed. Includes a single
2080 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2081 * caused the broadcast.
2082 */
2083 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2084 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2085
2086 /**
2087 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2088 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2089 * caused the broadcast.
2090 */
2091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2092 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2093
2094 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2095 // location; they are not general-purpose actions.
2096
2097 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002098 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2102 "android.intent.action.GTALK_CONNECTED";
2103
2104 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002105 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002106 */
2107 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2108 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2109 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002110
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002111 /**
2112 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_INPUT_METHOD_CHANGED =
2116 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002117
2118 /**
2119 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2120 * more radios have been turned off or on. The intent will have the following extra value:</p>
2121 * <ul>
2122 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2123 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2124 * turned off</li>
2125 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002126 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002127 * <p class="note">This is a protected intent that can only be sent
2128 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002129 */
2130 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2131 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2132
2133 /**
2134 * Broadcast Action: Some content providers have parts of their namespace
2135 * where they publish new events or items that the user may be especially
2136 * interested in. For these things, they may broadcast this action when the
2137 * set of interesting items change.
2138 *
2139 * For example, GmailProvider sends this notification when the set of unread
2140 * mail in the inbox changes.
2141 *
2142 * <p>The data of the intent identifies which part of which provider
2143 * changed. When queried through the content resolver, the data URI will
2144 * return the data set in question.
2145 *
2146 * <p>The intent will have the following extra values:
2147 * <ul>
2148 * <li><em>count</em> - The number of items in the data set. This is the
2149 * same as the number of items in the cursor returned by querying the
2150 * data URI. </li>
2151 * </ul>
2152 *
2153 * This intent will be sent at boot (if the count is non-zero) and when the
2154 * data set changes. It is possible for the data set to change without the
2155 * count changing (for example, if a new unread message arrives in the same
2156 * sync operation in which a message is archived). The phone should still
2157 * ring/vibrate/etc as normal in this case.
2158 */
2159 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2160 public static final String ACTION_PROVIDER_CHANGED =
2161 "android.intent.action.PROVIDER_CHANGED";
2162
2163 /**
2164 * Broadcast Action: Wired Headset plugged in or unplugged.
2165 *
2166 * <p>The intent will have the following extra values:
2167 * <ul>
2168 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2169 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002170 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002171 * </ul>
2172 * </ul>
2173 */
2174 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2175 public static final String ACTION_HEADSET_PLUG =
2176 "android.intent.action.HEADSET_PLUG";
2177
2178 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002179 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2180 *
2181 * <p>The intent will have the following extra values:
2182 * <ul>
2183 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2184 * <li><em>name</em> - Headset type, human readable string </li>
2185 * </ul>
2186 * </ul>
2187 * @hide
2188 */
2189 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002190 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2191 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002192
2193 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002194 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002195 *
2196 * <p>The intent will have the following extra values:
2197 * <ul>
2198 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2199 * <li><em>name</em> - Headset type, human readable string </li>
2200 * </ul>
2201 * </ul>
2202 * @hide
2203 */
2204 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002205 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2206 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002207
2208 /**
2209 * Broadcast Action: A HMDI cable was plugged or unplugged
2210 *
2211 * <p>The intent will have the following extra values:
2212 * <ul>
2213 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2214 * <li><em>name</em> - HDMI cable, human readable string </li>
2215 * </ul>
2216 * </ul>
2217 * @hide
2218 */
2219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2220 public static final String ACTION_HDMI_AUDIO_PLUG =
2221 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002222
2223 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002224 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2225 *
2226 * <p>The intent will have the following extra values:
2227 * <ul>
2228 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2229 * <li><em>card</em> - ALSA card number (integer) </li>
2230 * <li><em>device</em> - ALSA device number (integer) </li>
2231 * </ul>
2232 * </ul>
2233 * @hide
2234 */
2235 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2236 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2237 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2238
2239 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002240 * Broadcast Action: A USB audio device was plugged in or unplugged.
2241 *
2242 * <p>The intent will have the following extra values:
2243 * <ul>
2244 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2245 * <li><em>card</em> - ALSA card number (integer) </li>
2246 * <li><em>device</em> - ALSA device number (integer) </li>
2247 * </ul>
2248 * </ul>
2249 * @hide
2250 */
2251 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2252 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2253 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2254
2255 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002256 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2257 * <ul>
2258 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2259 * </ul>
2260 *
2261 * <p class="note">This is a protected intent that can only be sent
2262 * by the system.
2263 *
2264 * @hide
2265 */
2266 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2267 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2268 = "android.intent.action.ADVANCED_SETTINGS";
2269
2270 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 * Broadcast Action: An outgoing call is about to be placed.
2272 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002273 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002274 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002275 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002276 * the phone number originally intended to be dialed.</li>
2277 * </ul>
2278 * <p>Once the broadcast is finished, the resultData is used as the actual
2279 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002280 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002281 * outgoing call in turn: for example, a parental control application
2282 * might verify that the user is authorized to place the call at that
2283 * time, then a number-rewriting application might add an area code if
2284 * one was not specified.</p>
2285 * <p>For consistency, any receiver whose purpose is to prohibit phone
2286 * calls should have a priority of 0, to ensure it will see the final
2287 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002288 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002289 * should have a positive priority.
2290 * Negative priorities are reserved for the system for this broadcast;
2291 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002292 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2293 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002294 * <p>Emergency calls cannot be intercepted using this mechanism, and
2295 * other calls cannot be modified to call emergency numbers using this
2296 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002297 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2298 * call to use their own service instead. Those apps should first prevent
2299 * the call from being placed by setting resultData to <code>null</code>
2300 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002301 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2303 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002304 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002305 * <p class="note">This is a protected intent that can only be sent
2306 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002307 */
2308 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2309 public static final String ACTION_NEW_OUTGOING_CALL =
2310 "android.intent.action.NEW_OUTGOING_CALL";
2311
2312 /**
2313 * Broadcast Action: Have the device reboot. This is only for use by
2314 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002315 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002316 * <p class="note">This is a protected intent that can only be sent
2317 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002318 */
2319 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2320 public static final String ACTION_REBOOT =
2321 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002322
Wei Huang97ecc9c2009-05-11 17:44:20 -07002323 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002324 * Broadcast Action: A sticky broadcast for changes in the physical
2325 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002326 *
2327 * <p>The intent will have the following extra values:
2328 * <ul>
2329 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002330 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002331 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002332 * <p>This is intended for monitoring the current physical dock state.
2333 * See {@link android.app.UiModeManager} for the normal API dealing with
2334 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002335 */
2336 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2337 public static final String ACTION_DOCK_EVENT =
2338 "android.intent.action.DOCK_EVENT";
2339
2340 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002341 * Broadcast Action: A broadcast when idle maintenance can be started.
2342 * This means that the user is not interacting with the device and is
2343 * not expected to do so soon. Typical use of the idle maintenance is
2344 * to perform somehow expensive tasks that can be postponed at a moment
2345 * when they will not degrade user experience.
2346 * <p>
2347 * <p class="note">In order to keep the device responsive in case of an
2348 * unexpected user interaction, implementations of a maintenance task
2349 * should be interruptible. In such a scenario a broadcast with action
2350 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2351 * should not do the maintenance work in
2352 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2353 * maintenance service by {@link Context#startService(Intent)}. Also
2354 * you should hold a wake lock while your maintenance service is running
2355 * to prevent the device going to sleep.
2356 * </p>
2357 * <p>
2358 * <p class="note">This is a protected intent that can only be sent by
2359 * the system.
2360 * </p>
2361 *
2362 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002363 *
2364 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002365 */
2366 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2367 public static final String ACTION_IDLE_MAINTENANCE_START =
2368 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2369
2370 /**
2371 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2372 * This means that the user was not interacting with the device as a result
2373 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2374 * was sent and now the user started interacting with the device. Typical
2375 * use of the idle maintenance is to perform somehow expensive tasks that
2376 * can be postponed at a moment when they will not degrade user experience.
2377 * <p>
2378 * <p class="note">In order to keep the device responsive in case of an
2379 * unexpected user interaction, implementations of a maintenance task
2380 * should be interruptible. Hence, on receiving a broadcast with this
2381 * action, the maintenance task should be interrupted as soon as possible.
2382 * In other words, you should not do the maintenance work in
2383 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2384 * maintenance service that was started on receiving of
2385 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2386 * lock you acquired when your maintenance service started.
2387 * </p>
2388 * <p class="note">This is a protected intent that can only be sent
2389 * by the system.
2390 *
2391 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002392 *
2393 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002394 */
2395 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2396 public static final String ACTION_IDLE_MAINTENANCE_END =
2397 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2398
2399 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002400 * Broadcast Action: a remote intent is to be broadcasted.
2401 *
2402 * A remote intent is used for remote RPC between devices. The remote intent
2403 * is serialized and sent from one device to another device. The receiving
2404 * device parses the remote intent and broadcasts it. Note that anyone can
2405 * broadcast a remote intent. However, if the intent receiver of the remote intent
2406 * does not trust intent broadcasts from arbitrary intent senders, it should require
2407 * the sender to hold certain permissions so only trusted sender's broadcast will be
2408 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002409 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002410 */
2411 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002412 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002413
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002414 /**
2415 * Broadcast Action: hook for permforming cleanup after a system update.
2416 *
2417 * The broadcast is sent when the system is booting, before the
2418 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2419 * image. A receiver for this should do its work and then disable itself
2420 * so that it does not get run again at the next boot.
2421 * @hide
2422 */
2423 public static final String ACTION_PRE_BOOT_COMPLETED =
2424 "android.intent.action.PRE_BOOT_COMPLETED";
2425
Amith Yamasani13593602012-03-22 16:16:17 -07002426 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002427 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002428 * on restricted users. The broadcast intent contains an extra
2429 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2430 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2431 * String[] depending on the restriction type.<p/>
2432 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002433 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2434 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2435 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002436 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2437 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002438 * @see RestrictionEntry
2439 */
2440 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2441 "android.intent.action.GET_RESTRICTION_ENTRIES";
2442
2443 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002444 * Sent the first time a user is starting, to allow system apps to
2445 * perform one time initialization. (This will not be seen by third
2446 * party applications because a newly initialized user does not have any
2447 * third party applications installed for it.) This is sent early in
2448 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002449 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2450 * broadcast, since it is part of a visible user interaction; be as quick
2451 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002452 */
2453 public static final String ACTION_USER_INITIALIZE =
2454 "android.intent.action.USER_INITIALIZE";
2455
2456 /**
2457 * Sent when a user switch is happening, causing the process's user to be
2458 * brought to the foreground. This is only sent to receivers registered
2459 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2460 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002461 * foreground. This is sent as a foreground
2462 * broadcast, since it is part of a visible user interaction; be as quick
2463 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002464 */
2465 public static final String ACTION_USER_FOREGROUND =
2466 "android.intent.action.USER_FOREGROUND";
2467
2468 /**
2469 * Sent when a user switch is happening, causing the process's user to be
2470 * sent to the background. This is only sent to receivers registered
2471 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2472 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002473 * background. This is sent as a foreground
2474 * broadcast, since it is part of a visible user interaction; be as quick
2475 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002476 */
2477 public static final String ACTION_USER_BACKGROUND =
2478 "android.intent.action.USER_BACKGROUND";
2479
2480 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002481 * Broadcast sent to the system when a user is added. Carries an extra
2482 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2483 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002484 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002485 * @hide
2486 */
2487 public static final String ACTION_USER_ADDED =
2488 "android.intent.action.USER_ADDED";
2489
2490 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002491 * Broadcast sent by the system when a user is started. Carries an extra
2492 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002493 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002494 * that has been started. This is sent as a foreground
2495 * broadcast, since it is part of a visible user interaction; be as quick
2496 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002497 * @hide
2498 */
2499 public static final String ACTION_USER_STARTED =
2500 "android.intent.action.USER_STARTED";
2501
2502 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002503 * Broadcast sent when a user is in the process of starting. Carries an extra
2504 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2505 * sent to registered receivers, not manifest receivers. It is sent to all
2506 * users (including the one that is being started). You must hold
2507 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2508 * this broadcast. This is sent as a background broadcast, since
2509 * its result is not part of the primary UX flow; to safely keep track of
2510 * started/stopped state of a user you can use this in conjunction with
2511 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2512 * other user state broadcasts since those are foreground broadcasts so can
2513 * execute in a different order.
2514 * @hide
2515 */
2516 public static final String ACTION_USER_STARTING =
2517 "android.intent.action.USER_STARTING";
2518
2519 /**
2520 * Broadcast sent when a user is going to be stopped. Carries an extra
2521 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2522 * sent to registered receivers, not manifest receivers. It is sent to all
2523 * users (including the one that is being stopped). You must hold
2524 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2525 * this broadcast. The user will not stop until all receivers have
2526 * handled the broadcast. This is sent as a background broadcast, since
2527 * its result is not part of the primary UX flow; to safely keep track of
2528 * started/stopped state of a user you can use this in conjunction with
2529 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2530 * other user state broadcasts since those are foreground broadcasts so can
2531 * execute in a different order.
2532 * @hide
2533 */
2534 public static final String ACTION_USER_STOPPING =
2535 "android.intent.action.USER_STOPPING";
2536
2537 /**
2538 * Broadcast sent to the system when a user is stopped. Carries an extra
2539 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2540 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2541 * specific package. This is only sent to registered receivers, not manifest
2542 * receivers. It is sent to all running users <em>except</em> the one that
2543 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002544 * @hide
2545 */
2546 public static final String ACTION_USER_STOPPED =
2547 "android.intent.action.USER_STOPPED";
2548
2549 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002550 * 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 -07002551 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002552 * one that has been removed. The user will not be completely removed until all receivers have
2553 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002554 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002555 * @hide
2556 */
2557 public static final String ACTION_USER_REMOVED =
2558 "android.intent.action.USER_REMOVED";
2559
2560 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002561 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002562 * the userHandle of the user to become the current one. This is only sent to
2563 * registered receivers, not manifest receivers. It is sent to all running users.
2564 * You must hold
2565 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002566 * @hide
2567 */
2568 public static final String ACTION_USER_SWITCHED =
2569 "android.intent.action.USER_SWITCHED";
2570
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002571 /**
2572 * Broadcast sent to the system when a user's information changes. Carries an extra
2573 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002574 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002575 * @hide
2576 */
2577 public static final String ACTION_USER_INFO_CHANGED =
2578 "android.intent.action.USER_INFO_CHANGED";
2579
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002580 /**
2581 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2582 */
2583 public static final String ACTION_QUICK_CLOCK =
2584 "android.intent.action.QUICK_CLOCK";
2585
Michael Wright0087a142013-02-05 16:29:39 -08002586 /**
2587 * Broadcast Action: This is broadcast when a user action should request the
2588 * brightness setting dialog.
2589 * @hide
2590 */
2591 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2592 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2593
Justin Kohd378ad72013-04-01 12:18:26 -07002594 /**
2595 * Broadcast Action: A global button was pressed. Includes a single
2596 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2597 * caused the broadcast.
2598 * @hide
2599 */
2600 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2601
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002602 // ---------------------------------------------------------------------
2603 // ---------------------------------------------------------------------
2604 // Standard intent categories (see addCategory()).
2605
2606 /**
2607 * Set if the activity should be an option for the default action
2608 * (center press) to perform on a piece of data. Setting this will
2609 * hide from the user any activities without it set when performing an
2610 * action on some data. Note that this is normal -not- set in the
2611 * Intent when initiating an action -- it is for use in intent filters
2612 * specified in packages.
2613 */
2614 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2615 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2616 /**
2617 * Activities that can be safely invoked from a browser must support this
2618 * category. For example, if the user is viewing a web page or an e-mail
2619 * and clicks on a link in the text, the Intent generated execute that
2620 * link will require the BROWSABLE category, so that only activities
2621 * supporting this category will be considered as possible actions. By
2622 * supporting this category, you are promising that there is nothing
2623 * damaging (without user intervention) that can happen by invoking any
2624 * matching Intent.
2625 */
2626 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2627 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2628 /**
2629 * Set if the activity should be considered as an alternative action to
2630 * the data the user is currently viewing. See also
2631 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2632 * applies to the selection in a list of items.
2633 *
2634 * <p>Supporting this category means that you would like your activity to be
2635 * displayed in the set of alternative things the user can do, usually as
2636 * part of the current activity's options menu. You will usually want to
2637 * include a specific label in the &lt;intent-filter&gt; of this action
2638 * describing to the user what it does.
2639 *
2640 * <p>The action of IntentFilter with this category is important in that it
2641 * describes the specific action the target will perform. This generally
2642 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2643 * a specific name such as "com.android.camera.action.CROP. Only one
2644 * alternative of any particular action will be shown to the user, so using
2645 * a specific action like this makes sure that your alternative will be
2646 * displayed while also allowing other applications to provide their own
2647 * overrides of that particular action.
2648 */
2649 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2650 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2651 /**
2652 * Set if the activity should be considered as an alternative selection
2653 * action to the data the user has currently selected. This is like
2654 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2655 * of items from which the user can select, giving them alternatives to the
2656 * default action that will be performed on it.
2657 */
2658 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2659 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2660 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002661 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002662 */
2663 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2664 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2665 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002666 * Should be displayed in the top-level launcher.
2667 */
2668 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2669 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2670 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002671 * Provides information about the package it is in; typically used if
2672 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2673 * a front-door to the user without having to be shown in the all apps list.
2674 */
2675 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2676 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2677 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002678 * This is the home activity, that is the first activity that is displayed
2679 * when the device boots.
2680 */
2681 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2682 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2683 /**
2684 * This activity is a preference panel.
2685 */
2686 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2687 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2688 /**
2689 * This activity is a development preference panel.
2690 */
2691 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2692 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2693 /**
2694 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002695 */
2696 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2697 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2698 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002699 * This activity allows the user to browse and download new applications.
2700 */
2701 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2702 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2703 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002704 * This activity may be exercised by the monkey or other automated test tools.
2705 */
2706 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2707 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2708 /**
2709 * To be used as a test (not part of the normal user experience).
2710 */
2711 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2712 /**
2713 * To be used as a unit test (run through the Test Harness).
2714 */
2715 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2716 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002717 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002718 * experience).
2719 */
2720 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2721 /**
2722 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002723 * ContentResolver.openInputStream. Openable URIs must support the columns in
2724 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002725 * when queried, though it is allowable for those columns to be blank.
2726 */
2727 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2728 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2729
2730 /**
2731 * To be used as code under test for framework instrumentation tests.
2732 */
2733 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2734 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002735 /**
2736 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002737 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2738 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002739 */
2740 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2741 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2742 /**
2743 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002744 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2745 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002746 */
2747 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2748 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002749 /**
2750 * An activity to run when device is inserted into a analog (low end) dock.
2751 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2752 * information, see {@link android.app.UiModeManager}.
2753 */
2754 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2755 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2756
2757 /**
2758 * An activity to run when device is inserted into a digital (high end) dock.
2759 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2760 * information, see {@link android.app.UiModeManager}.
2761 */
2762 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2763 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002764
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002765 /**
2766 * Used to indicate that the activity can be used in a car environment.
2767 */
2768 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2769 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2770
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002771 // ---------------------------------------------------------------------
2772 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002773 // Application launch intent categories (see addCategory()).
2774
2775 /**
2776 * Used with {@link #ACTION_MAIN} to launch the browser application.
2777 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002778 * <p>NOTE: This should not be used as the primary key of an Intent,
2779 * since it will not result in the app launching with the correct
2780 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002781 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002782 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002783 */
2784 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2785 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2786
2787 /**
2788 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2789 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002790 * <p>NOTE: This should not be used as the primary key of an Intent,
2791 * since it will not result in the app launching with the correct
2792 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002793 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002794 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002795 */
2796 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2797 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2798
2799 /**
2800 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2801 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002802 * <p>NOTE: This should not be used as the primary key of an Intent,
2803 * since it will not result in the app launching with the correct
2804 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002805 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002806 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002807 */
2808 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2809 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2810
2811 /**
2812 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2813 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002814 * <p>NOTE: This should not be used as the primary key of an Intent,
2815 * since it will not result in the app launching with the correct
2816 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002817 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002818 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002819 */
2820 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2821 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2822
2823 /**
2824 * Used with {@link #ACTION_MAIN} to launch the email application.
2825 * The activity should be able to send and receive email.
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_EMAIL = "android.intent.category.APP_EMAIL";
2834
2835 /**
2836 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2837 * The activity should be able to view and manipulate image and video files
2838 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002839 * <p>NOTE: This should not be used as the primary key of an Intent,
2840 * since it will not result in the app launching with the correct
2841 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002842 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002843 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002844 */
2845 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2846 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2847
2848 /**
2849 * Used with {@link #ACTION_MAIN} to launch the maps application.
2850 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002851 * <p>NOTE: This should not be used as the primary key of an Intent,
2852 * since it will not result in the app launching with the correct
2853 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002854 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002855 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002856 */
2857 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2858 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2859
2860 /**
2861 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2862 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002863 * <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_MESSAGING = "android.intent.category.APP_MESSAGING";
2871
2872 /**
2873 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002874 * The activity should be able to play, browse, or manipulate music files
2875 * stored on the device.
2876 * <p>NOTE: This should not be used as the primary key of an Intent,
2877 * since it will not result in the app launching with the correct
2878 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002879 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002880 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002881 */
2882 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2883 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2884
2885 // ---------------------------------------------------------------------
2886 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002887 // Standard extra data keys.
2888
2889 /**
2890 * The initial data to place in a newly created record. Use with
2891 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2892 * fields as would be given to the underlying ContentProvider.insert()
2893 * call.
2894 */
2895 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2896
2897 /**
2898 * A constant CharSequence that is associated with the Intent, used with
2899 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2900 * this may be a styled CharSequence, so you must use
2901 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2902 * retrieve it.
2903 */
2904 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2905
2906 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002907 * A constant String that is associated with the Intent, used with
2908 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2909 * as HTML formatted text. Note that you <em>must</em> also supply
2910 * {@link #EXTRA_TEXT}.
2911 */
2912 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2913
2914 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002915 * A content: URI holding a stream of data associated with the Intent,
2916 * used with {@link #ACTION_SEND} to supply the data being sent.
2917 */
2918 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2919
2920 /**
2921 * A String[] holding e-mail addresses that should be delivered to.
2922 */
2923 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2924
2925 /**
2926 * A String[] holding e-mail addresses that should be carbon copied.
2927 */
2928 public static final String EXTRA_CC = "android.intent.extra.CC";
2929
2930 /**
2931 * A String[] holding e-mail addresses that should be blind carbon copied.
2932 */
2933 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2934
2935 /**
2936 * A constant string holding the desired subject line of a message.
2937 */
2938 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2939
2940 /**
2941 * An Intent describing the choices you would like shown with
2942 * {@link #ACTION_PICK_ACTIVITY}.
2943 */
2944 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2945
2946 /**
2947 * A CharSequence dialog title to provide to the user when used with a
2948 * {@link #ACTION_CHOOSER}.
2949 */
2950 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2951
2952 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002953 * A Parcelable[] of {@link Intent} or
2954 * {@link android.content.pm.LabeledIntent} objects as set with
2955 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2956 * a the front of the list of choices, when shown to the user with a
2957 * {@link #ACTION_CHOOSER}.
2958 */
2959 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2960
2961 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002962 * A {@link android.view.KeyEvent} object containing the event that
2963 * triggered the creation of the Intent it is in.
2964 */
2965 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2966
2967 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002968 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2969 * before shutting down.
2970 *
2971 * {@hide}
2972 */
2973 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2974
2975 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002976 * 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 -07002977 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2978 * of restarting the application.
2979 */
2980 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2981
2982 /**
2983 * A String holding the phone number originally entered in
2984 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2985 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2986 */
2987 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002988
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002989 /**
2990 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2991 * intents to supply the uid the package had been assigned. Also an optional
2992 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2993 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2994 * purpose.
2995 */
2996 public static final String EXTRA_UID = "android.intent.extra.UID";
2997
2998 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002999 * @hide String array of package names.
3000 */
3001 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3002
3003 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003004 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3005 * intents to indicate whether this represents a full uninstall (removing
3006 * both the code and its data) or a partial uninstall (leaving its data,
3007 * implying that this is an update).
3008 */
3009 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003010
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003011 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003012 * @hide
3013 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3014 * intents to indicate that at this point the package has been removed for
3015 * all users on the device.
3016 */
3017 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3018 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3019
3020 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003021 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3022 * intents to indicate that this is a replacement of the package, so this
3023 * broadcast will immediately be followed by an add broadcast for a
3024 * different version of the same package.
3025 */
3026 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003027
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003028 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003029 * Used as an int extra field in {@link android.app.AlarmManager} intents
3030 * to tell the application being invoked how many pending alarms are being
3031 * delievered with the intent. For one-shot alarms this will always be 1.
3032 * For recurring alarms, this might be greater than 1 if the device was
3033 * asleep or powered off at the time an earlier alarm would have been
3034 * delivered.
3035 */
3036 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003037
Jacek Surazski86b6c532009-05-13 14:38:28 +02003038 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003039 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3040 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003041 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3042 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003043 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3044 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3045 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003046 */
3047 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3048
3049 /**
3050 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3051 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003052 */
3053 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3054
3055 /**
3056 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3057 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003058 */
3059 public static final int EXTRA_DOCK_STATE_DESK = 1;
3060
3061 /**
3062 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3063 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003064 */
3065 public static final int EXTRA_DOCK_STATE_CAR = 2;
3066
3067 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003068 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3069 * to represent that the phone is in a analog (low end) dock.
3070 */
3071 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3072
3073 /**
3074 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3075 * to represent that the phone is in a digital (high end) dock.
3076 */
3077 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3078
3079 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003080 * Boolean that can be supplied as meta-data with a dock activity, to
3081 * indicate that the dock should take over the home key when it is active.
3082 */
3083 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003084
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003085 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003086 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3087 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003088 */
3089 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3090
3091 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003092 * Used in the extra field in the remote intent. It's astring token passed with the
3093 * remote intent.
3094 */
3095 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3096 "android.intent.extra.remote_intent_token";
3097
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003098 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003099 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003100 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003101 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003102 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003103 "android.intent.extra.changed_component_name";
3104
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003105 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003106 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003107 * and contains a string array of all of the components that have changed. If
3108 * the state of the overall package has changed, then it will contain an entry
3109 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003110 */
3111 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3112 "android.intent.extra.changed_component_name_list";
3113
3114 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003115 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003116 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3117 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003118 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003119 */
3120 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3121 "android.intent.extra.changed_package_list";
3122
3123 /**
3124 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003125 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3126 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003127 * and contains an integer array of uids of all of the components
3128 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003129 */
3130 public static final String EXTRA_CHANGED_UID_LIST =
3131 "android.intent.extra.changed_uid_list";
3132
3133 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003134 * @hide
3135 * Magic extra system code can use when binding, to give a label for
3136 * who it is that has bound to a service. This is an integer giving
3137 * a framework string resource that can be displayed to the user.
3138 */
3139 public static final String EXTRA_CLIENT_LABEL =
3140 "android.intent.extra.client_label";
3141
3142 /**
3143 * @hide
3144 * Magic extra system code can use when binding, to give a PendingIntent object
3145 * that can be launched for the user to disable the system's use of this
3146 * service.
3147 */
3148 public static final String EXTRA_CLIENT_INTENT =
3149 "android.intent.extra.client_intent";
3150
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003151 /**
3152 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3153 * data that is on the local device. This is a boolean extra; the default
3154 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3155 * the user to select media that is already on the device, not requiring it
3156 * be downloaded from a remote service when opened. Another way to look
3157 * at it is that such content should generally have a "_data" column to the
3158 * path of the content on local external storage.
3159 */
3160 public static final String EXTRA_LOCAL_ONLY =
3161 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003162
Amith Yamasani13593602012-03-22 16:16:17 -07003163 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003164 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3165 * user to select and return multiple items. This is a boolean extra; the default
3166 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3167 * present the user with a UI where they can pick multiple items that are all
3168 * returned to the caller. When this happens, they should be returned as
3169 * the {@link #getClipData()} part of the result Intent.
3170 */
3171 public static final String EXTRA_ALLOW_MULTIPLE =
3172 "android.intent.extra.ALLOW_MULTIPLE";
3173
3174 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003175 * The userHandle carried with broadcast intents related to addition, removal and switching of
3176 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003177 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3178 * @hide
3179 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003180 public static final String EXTRA_USER_HANDLE =
3181 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003182
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003183 /**
3184 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003185 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3186 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003187 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003188 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3189
3190 /**
3191 * Extra sent in the intent to the BroadcastReceiver that handles
3192 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3193 * the restrictions as key/value pairs.
3194 */
3195 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3196 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003197
Amith Yamasani86118ba2013-03-28 14:33:16 -07003198 /**
3199 * Extra used in the response from a BroadcastReceiver that handles
3200 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3201 */
3202 public static final String EXTRA_RESTRICTIONS_INTENT =
3203 "android.intent.extra.restrictions_intent";
3204
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003205 // ---------------------------------------------------------------------
3206 // ---------------------------------------------------------------------
3207 // Intent flags (see mFlags variable).
3208
3209 /**
3210 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003211 * perform read operations on the Uri in the Intent's data and any URIs
3212 * specified in its ClipData. When applying to an Intent's ClipData,
3213 * all URIs as well as recursive traversals through data or other ClipData
3214 * in Intent items will be granted; only the grant flags of the top-level
3215 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003216 */
3217 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3218 /**
3219 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003220 * perform write operations on the Uri in the Intent's data and any URIs
3221 * specified in its ClipData. When applying to an Intent's ClipData,
3222 * all URIs as well as recursive traversals through data or other ClipData
3223 * in Intent items will be granted; only the grant flags of the top-level
3224 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003225 */
3226 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3227 /**
3228 * Can be set by the caller to indicate that this Intent is coming from
3229 * a background operation, not from direct user interaction.
3230 */
3231 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3232 /**
3233 * A flag you can enable for debugging: when set, log messages will be
3234 * printed during the resolution of this intent to show you what has
3235 * been found to create the final resolved list.
3236 */
3237 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003238 /**
3239 * If set, this intent will not match any components in packages that
3240 * are currently stopped. If this is not set, then the default behavior
3241 * is to include such applications in the result.
3242 */
3243 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3244 /**
3245 * If set, this intent will always match any components in packages that
3246 * are currently stopped. This is the default behavior when
3247 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3248 * flags are set, this one wins (it allows overriding of exclude for
3249 * places where the framework may automatically set the exclude flag).
3250 */
3251 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003252
3253 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003254 * If set, the new activity is not kept in the history stack. As soon as
3255 * the user navigates away from it, the activity is finished. This may also
3256 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3257 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003258 */
3259 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3260 /**
3261 * If set, the activity will not be launched if it is already running
3262 * at the top of the history stack.
3263 */
3264 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3265 /**
3266 * If set, this activity will become the start of a new task on this
3267 * history stack. A task (from the activity that started it to the
3268 * next task activity) defines an atomic group of activities that the
3269 * user can move to. Tasks can be moved to the foreground and background;
3270 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003271 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003272 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3273 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003274 *
3275 * <p>This flag is generally used by activities that want
3276 * to present a "launcher" style behavior: they give the user a list of
3277 * separate things that can be done, which otherwise run completely
3278 * independently of the activity launching them.
3279 *
3280 * <p>When using this flag, if a task is already running for the activity
3281 * you are now starting, then a new activity will not be started; instead,
3282 * the current task will simply be brought to the front of the screen with
3283 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3284 * to disable this behavior.
3285 *
3286 * <p>This flag can not be used when the caller is requesting a result from
3287 * the activity being launched.
3288 */
3289 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3290 /**
3291 * <strong>Do not use this flag unless you are implementing your own
3292 * top-level application launcher.</strong> Used in conjunction with
3293 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3294 * behavior of bringing an existing task to the foreground. When set,
3295 * a new task is <em>always</em> started to host the Activity for the
3296 * Intent, regardless of whether there is already an existing task running
3297 * the same thing.
3298 *
3299 * <p><strong>Because the default system does not include graphical task management,
3300 * you should not use this flag unless you provide some way for a user to
3301 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003302 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003303 * <p>This flag is ignored if
3304 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3305 *
Scott Main7aee61f2011-02-08 11:25:01 -08003306 * <p>See
3307 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3308 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003309 */
3310 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3311 /**
3312 * If set, and the activity being launched is already running in the
3313 * current task, then instead of launching a new instance of that activity,
3314 * all of the other activities on top of it will be closed and this Intent
3315 * will be delivered to the (now on top) old activity as a new Intent.
3316 *
3317 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3318 * If D calls startActivity() with an Intent that resolves to the component
3319 * of activity B, then C and D will be finished and B receive the given
3320 * Intent, resulting in the stack now being: A, B.
3321 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003322 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003323 * either receive the new intent you are starting here in its
3324 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003325 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003326 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3327 * the same intent, then it will be finished and re-created; for all other
3328 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3329 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003330 *
3331 * <p>This launch mode can also be used to good effect in conjunction with
3332 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3333 * of a task, it will bring any currently running instance of that task
3334 * to the foreground, and then clear it to its root state. This is
3335 * especially useful, for example, when launching an activity from the
3336 * notification manager.
3337 *
Scott Main7aee61f2011-02-08 11:25:01 -08003338 * <p>See
3339 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3340 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003341 */
3342 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3343 /**
3344 * If set and this intent is being used to launch a new activity from an
3345 * existing one, then the reply target of the existing activity will be
3346 * transfered to the new activity. This way the new activity can call
3347 * {@link android.app.Activity#setResult} and have that result sent back to
3348 * the reply target of the original activity.
3349 */
3350 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3351 /**
3352 * If set and this intent is being used to launch a new activity from an
3353 * existing one, the current activity will not be counted as the top
3354 * activity for deciding whether the new intent should be delivered to
3355 * the top instead of starting a new one. The previous activity will
3356 * be used as the top, with the assumption being that the current activity
3357 * will finish itself immediately.
3358 */
3359 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3360 /**
3361 * If set, the new activity is not kept in the list of recently launched
3362 * activities.
3363 */
3364 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3365 /**
3366 * This flag is not normally set by application code, but set for you by
3367 * the system as described in the
3368 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3369 * launchMode} documentation for the singleTask mode.
3370 */
3371 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3372 /**
3373 * If set, and this activity is either being started in a new task or
3374 * bringing to the top an existing task, then it will be launched as
3375 * the front door of the task. This will result in the application of
3376 * any affinities needed to have that task in the proper state (either
3377 * moving activities to or from it), or simply resetting that task to
3378 * its initial state if needed.
3379 */
3380 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3381 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003382 * This flag is not normally set by application code, but set for you by
3383 * the system if this activity is being launched from history
3384 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003385 */
3386 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003387 /**
3388 * If set, this marks a point in the task's activity stack that should
3389 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003390 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003391 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3392 * the user re-launching it from home), this activity and all on top of
3393 * it will be finished so that the user does not return to them, but
3394 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003395 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003396 * <p>This is useful for cases where you have a logical break in your
3397 * application. For example, an e-mail application may have a command
3398 * to view an attachment, which launches an image view activity to
3399 * display it. This activity should be part of the e-mail application's
3400 * task, since it is a part of the task the user is involved in. However,
3401 * if the user leaves that task, and later selects the e-mail app from
3402 * home, we may like them to return to the conversation they were
3403 * viewing, not the picture attachment, since that is confusing. By
3404 * setting this flag when launching the image viewer, that viewer and
3405 * any activities it starts will be removed the next time the user returns
3406 * to mail.
3407 */
3408 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003409 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003410 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003411 * callback from occurring on the current frontmost activity before it is
3412 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003413 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003414 * <p>Typically, an activity can rely on that callback to indicate that an
3415 * explicit user action has caused their activity to be moved out of the
3416 * foreground. The callback marks an appropriate point in the activity's
3417 * lifecycle for it to dismiss any notifications that it intends to display
3418 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003419 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003420 * <p>If an activity is ever started via any non-user-driven events such as
3421 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3422 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003423 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003424 */
3425 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003426 /**
3427 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3428 * this flag will cause the launched activity to be brought to the front of its
3429 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003430 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003431 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3432 * If D calls startActivity() with an Intent that resolves to the component
3433 * of activity B, then B will be brought to the front of the history stack,
3434 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003435 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003436 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003437 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003438 */
3439 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003440 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003441 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3442 * this flag will prevent the system from applying an activity transition
3443 * animation to go to the next activity state. This doesn't mean an
3444 * animation will never run -- if another activity change happens that doesn't
3445 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003446 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003447 * when you are going to do a series of activity operations but the
3448 * animation seen by the user shouldn't be driven by the first activity
3449 * change but rather a later one.
3450 */
3451 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3452 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003453 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3454 * this flag will cause any existing task that would be associated with the
3455 * activity to be cleared before the activity is started. That is, the activity
3456 * becomes the new root of an otherwise empty task, and any old activities
3457 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3458 */
3459 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3460 /**
3461 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3462 * this flag will cause a newly launching task to be placed on top of the current
3463 * home activity task (if there is one). That is, pressing back from the task
3464 * will always return the user to home even if that was not the last activity they
3465 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3466 */
3467 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3468 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003469 * If set, when sending a broadcast only registered receivers will be
3470 * called -- no BroadcastReceiver components will be launched.
3471 */
3472 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003473 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003474 * If set, when sending a broadcast the new broadcast will replace
3475 * any existing pending broadcast that matches it. Matching is defined
3476 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3477 * true for the intents of the two broadcasts. When a match is found,
3478 * the new broadcast (and receivers associated with it) will replace the
3479 * existing one in the pending broadcast list, remaining at the same
3480 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003481 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003482 * <p>This flag is most typically used with sticky broadcasts, which
3483 * only care about delivering the most recent values of the broadcast
3484 * to their receivers.
3485 */
3486 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3487 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003488 * If set, when sending a broadcast the recipient is allowed to run at
3489 * foreground priority, with a shorter timeout interval. During normal
3490 * broadcasts the receivers are not automatically hoisted out of the
3491 * background priority class.
3492 */
3493 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3494 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003495 * If set, when sending a broadcast <i>before boot has completed</i> only
3496 * registered receivers will be called -- no BroadcastReceiver components
3497 * will be launched. Sticky intent state will be recorded properly even
3498 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3499 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003500 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003501 * <p>This flag is only for use by system sevices as a convenience to
3502 * avoid having to implement a more complex mechanism around detection
3503 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003504 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003505 * @hide
3506 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003507 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003508 /**
3509 * Set when this broadcast is for a boot upgrade, a special mode that
3510 * allows the broadcast to be sent before the system is ready and launches
3511 * the app process with no providers running in it.
3512 * @hide
3513 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003514 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003515
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003516 /**
3517 * @hide Flags that can't be changed with PendingIntent.
3518 */
3519 public static final int IMMUTABLE_FLAGS =
3520 FLAG_GRANT_READ_URI_PERMISSION
3521 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003522
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003523 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003524 // ---------------------------------------------------------------------
3525 // toUri() and parseUri() options.
3526
3527 /**
3528 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3529 * always has the "intent:" scheme. This syntax can be used when you want
3530 * to later disambiguate between URIs that are intended to describe an
3531 * Intent vs. all others that should be treated as raw URIs. When used
3532 * with {@link #parseUri}, any other scheme will result in a generic
3533 * VIEW action for that raw URI.
3534 */
3535 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003536
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003537 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003538
3539 private String mAction;
3540 private Uri mData;
3541 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003542 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003543 private ComponentName mComponent;
3544 private int mFlags;
3545 private HashSet<String> mCategories;
3546 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003547 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003548 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003549 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003550
3551 // ---------------------------------------------------------------------
3552
3553 /**
3554 * Create an empty intent.
3555 */
3556 public Intent() {
3557 }
3558
3559 /**
3560 * Copy constructor.
3561 */
3562 public Intent(Intent o) {
3563 this.mAction = o.mAction;
3564 this.mData = o.mData;
3565 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003566 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003567 this.mComponent = o.mComponent;
3568 this.mFlags = o.mFlags;
3569 if (o.mCategories != null) {
3570 this.mCategories = new HashSet<String>(o.mCategories);
3571 }
3572 if (o.mExtras != null) {
3573 this.mExtras = new Bundle(o.mExtras);
3574 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003575 if (o.mSourceBounds != null) {
3576 this.mSourceBounds = new Rect(o.mSourceBounds);
3577 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003578 if (o.mSelector != null) {
3579 this.mSelector = new Intent(o.mSelector);
3580 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003581 if (o.mClipData != null) {
3582 this.mClipData = new ClipData(o.mClipData);
3583 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003584 }
3585
3586 @Override
3587 public Object clone() {
3588 return new Intent(this);
3589 }
3590
3591 private Intent(Intent o, boolean all) {
3592 this.mAction = o.mAction;
3593 this.mData = o.mData;
3594 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003595 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003596 this.mComponent = o.mComponent;
3597 if (o.mCategories != null) {
3598 this.mCategories = new HashSet<String>(o.mCategories);
3599 }
3600 }
3601
3602 /**
3603 * Make a clone of only the parts of the Intent that are relevant for
3604 * filter matching: the action, data, type, component, and categories.
3605 */
3606 public Intent cloneFilter() {
3607 return new Intent(this, false);
3608 }
3609
3610 /**
3611 * Create an intent with a given action. All other fields (data, type,
3612 * class) are null. Note that the action <em>must</em> be in a
3613 * namespace because Intents are used globally in the system -- for
3614 * example the system VIEW action is android.intent.action.VIEW; an
3615 * application's custom action would be something like
3616 * com.google.app.myapp.CUSTOM_ACTION.
3617 *
3618 * @param action The Intent action, such as ACTION_VIEW.
3619 */
3620 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003621 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003622 }
3623
3624 /**
3625 * Create an intent with a given action and for a given data url. Note
3626 * that the action <em>must</em> be in a namespace because Intents are
3627 * used globally in the system -- for example the system VIEW action is
3628 * android.intent.action.VIEW; an application's custom action would be
3629 * something like com.google.app.myapp.CUSTOM_ACTION.
3630 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003631 * <p><em>Note: scheme and host name matching in the Android framework is
3632 * case-sensitive, unlike the formal RFC. As a result,
3633 * you should always ensure that you write your Uri with these elements
3634 * using lower case letters, and normalize any Uris you receive from
3635 * outside of Android to ensure the scheme and host is lower case.</em></p>
3636 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003637 * @param action The Intent action, such as ACTION_VIEW.
3638 * @param uri The Intent data URI.
3639 */
3640 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003641 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003642 mData = uri;
3643 }
3644
3645 /**
3646 * Create an intent for a specific component. All other fields (action, data,
3647 * type, class) are null, though they can be modified later with explicit
3648 * calls. This provides a convenient way to create an intent that is
3649 * intended to execute a hard-coded class name, rather than relying on the
3650 * system to find an appropriate class for you; see {@link #setComponent}
3651 * for more information on the repercussions of this.
3652 *
3653 * @param packageContext A Context of the application package implementing
3654 * this class.
3655 * @param cls The component class that is to be used for the intent.
3656 *
3657 * @see #setClass
3658 * @see #setComponent
3659 * @see #Intent(String, android.net.Uri , Context, Class)
3660 */
3661 public Intent(Context packageContext, Class<?> cls) {
3662 mComponent = new ComponentName(packageContext, cls);
3663 }
3664
3665 /**
3666 * Create an intent for a specific component with a specified action and data.
3667 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3668 * construct the Intent and then calling {@link #setClass} to set its
3669 * class.
3670 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003671 * <p><em>Note: scheme and host name matching in the Android framework is
3672 * case-sensitive, unlike the formal RFC. As a result,
3673 * you should always ensure that you write your Uri with these elements
3674 * using lower case letters, and normalize any Uris you receive from
3675 * outside of Android to ensure the scheme and host is lower case.</em></p>
3676 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677 * @param action The Intent action, such as ACTION_VIEW.
3678 * @param uri The Intent data URI.
3679 * @param packageContext A Context of the application package implementing
3680 * this class.
3681 * @param cls The component class that is to be used for the intent.
3682 *
3683 * @see #Intent(String, android.net.Uri)
3684 * @see #Intent(Context, Class)
3685 * @see #setClass
3686 * @see #setComponent
3687 */
3688 public Intent(String action, Uri uri,
3689 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003690 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003691 mData = uri;
3692 mComponent = new ComponentName(packageContext, cls);
3693 }
3694
3695 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003696 * Create an intent to launch the main (root) activity of a task. This
3697 * is the Intent that is started when the application's is launched from
3698 * Home. For anything else that wants to launch an application in the
3699 * same way, it is important that they use an Intent structured the same
3700 * way, and can use this function to ensure this is the case.
3701 *
3702 * <p>The returned Intent has the given Activity component as its explicit
3703 * component, {@link #ACTION_MAIN} as its action, and includes the
3704 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3705 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3706 * to do that through {@link #addFlags(int)} on the returned Intent.
3707 *
3708 * @param mainActivity The main activity component that this Intent will
3709 * launch.
3710 * @return Returns a newly created Intent that can be used to launch the
3711 * activity as a main application entry.
3712 *
3713 * @see #setClass
3714 * @see #setComponent
3715 */
3716 public static Intent makeMainActivity(ComponentName mainActivity) {
3717 Intent intent = new Intent(ACTION_MAIN);
3718 intent.setComponent(mainActivity);
3719 intent.addCategory(CATEGORY_LAUNCHER);
3720 return intent;
3721 }
3722
3723 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003724 * Make an Intent for the main activity of an application, without
3725 * specifying a specific activity to run but giving a selector to find
3726 * the activity. This results in a final Intent that is structured
3727 * the same as when the application is launched from
3728 * Home. For anything else that wants to launch an application in the
3729 * same way, it is important that they use an Intent structured the same
3730 * way, and can use this function to ensure this is the case.
3731 *
3732 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3733 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3734 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3735 * to do that through {@link #addFlags(int)} on the returned Intent.
3736 *
3737 * @param selectorAction The action name of the Intent's selector.
3738 * @param selectorCategory The name of a category to add to the Intent's
3739 * selector.
3740 * @return Returns a newly created Intent that can be used to launch the
3741 * activity as a main application entry.
3742 *
3743 * @see #setSelector(Intent)
3744 */
3745 public static Intent makeMainSelectorActivity(String selectorAction,
3746 String selectorCategory) {
3747 Intent intent = new Intent(ACTION_MAIN);
3748 intent.addCategory(CATEGORY_LAUNCHER);
3749 Intent selector = new Intent();
3750 selector.setAction(selectorAction);
3751 selector.addCategory(selectorCategory);
3752 intent.setSelector(selector);
3753 return intent;
3754 }
3755
3756 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003757 * Make an Intent that can be used to re-launch an application's task
3758 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3759 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3760 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3761 *
3762 * @param mainActivity The activity component that is the root of the
3763 * task; this is the activity that has been published in the application's
3764 * manifest as the main launcher icon.
3765 *
3766 * @return Returns a newly created Intent that can be used to relaunch the
3767 * activity's task in its root state.
3768 */
3769 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3770 Intent intent = makeMainActivity(mainActivity);
3771 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3772 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3773 return intent;
3774 }
3775
3776 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003777 * Call {@link #parseUri} with 0 flags.
3778 * @deprecated Use {@link #parseUri} instead.
3779 */
3780 @Deprecated
3781 public static Intent getIntent(String uri) throws URISyntaxException {
3782 return parseUri(uri, 0);
3783 }
Tom Taylord4a47292009-12-21 13:59:18 -08003784
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003785 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003786 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003787 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003788 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003789 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003790 *
3791 * <p>The URI given here must not be relative -- that is, it must include
3792 * the scheme and full path.
3793 *
3794 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003795 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003796 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003797 *
3798 * @return Intent The newly created Intent object.
3799 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003800 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3801 * it bad (as parsed by the Uri class) or the Intent data within the
3802 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003803 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003804 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003805 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003806 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003807 int i = 0;
3808 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003809 // Validate intent scheme for if requested.
3810 if ((flags&URI_INTENT_SCHEME) != 0) {
3811 if (!uri.startsWith("intent:")) {
3812 Intent intent = new Intent(ACTION_VIEW);
3813 try {
3814 intent.setData(Uri.parse(uri));
3815 } catch (IllegalArgumentException e) {
3816 throw new URISyntaxException(uri, e.getMessage());
3817 }
3818 return intent;
3819 }
3820 }
Tom Taylord4a47292009-12-21 13:59:18 -08003821
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003822 // simple case
3823 i = uri.lastIndexOf("#");
3824 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3825
3826 // old format Intent URI
3827 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003828
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003829 // new format
3830 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003831 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003832
3833 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003834 String data = i >= 0 ? uri.substring(0, i) : null;
3835 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003836 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003837
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003838 // loop over contents of Intent, all name=value;
3839 while (!uri.startsWith("end", i)) {
3840 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003841 if (eq < 0) eq = i-1;
3842 int semi = uri.indexOf(';', i);
3843 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003844
3845 // action
3846 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003847 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003848 }
3849
3850 // categories
3851 else if (uri.startsWith("category=", i)) {
3852 intent.addCategory(value);
3853 }
3854
3855 // type
3856 else if (uri.startsWith("type=", i)) {
3857 intent.mType = value;
3858 }
3859
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003860 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003861 else if (uri.startsWith("launchFlags=", i)) {
3862 intent.mFlags = Integer.decode(value).intValue();
3863 }
3864
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003865 // package
3866 else if (uri.startsWith("package=", i)) {
3867 intent.mPackage = value;
3868 }
3869
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003870 // component
3871 else if (uri.startsWith("component=", i)) {
3872 intent.mComponent = ComponentName.unflattenFromString(value);
3873 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003874
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003875 // scheme
3876 else if (uri.startsWith("scheme=", i)) {
3877 scheme = value;
3878 }
3879
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003880 // source bounds
3881 else if (uri.startsWith("sourceBounds=", i)) {
3882 intent.mSourceBounds = Rect.unflattenFromString(value);
3883 }
3884
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003885 // selector
3886 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3887 intent = new Intent();
3888 }
3889
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003890 // extra
3891 else {
3892 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003893 // create Bundle if it doesn't already exist
3894 if (intent.mExtras == null) intent.mExtras = new Bundle();
3895 Bundle b = intent.mExtras;
3896 // add EXTRA
3897 if (uri.startsWith("S.", i)) b.putString(key, value);
3898 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3899 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3900 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3901 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3902 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3903 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3904 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3905 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3906 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3907 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003908
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003909 // move to the next item
3910 i = semi + 1;
3911 }
3912
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003913 if (intent != baseIntent) {
3914 // The Intent had a selector; fix it up.
3915 baseIntent.setSelector(intent);
3916 intent = baseIntent;
3917 }
3918
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003919 if (data != null) {
3920 if (data.startsWith("intent:")) {
3921 data = data.substring(7);
3922 if (scheme != null) {
3923 data = scheme + ':' + data;
3924 }
3925 }
Tom Taylord4a47292009-12-21 13:59:18 -08003926
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003927 if (data.length() > 0) {
3928 try {
3929 intent.mData = Uri.parse(data);
3930 } catch (IllegalArgumentException e) {
3931 throw new URISyntaxException(uri, e.getMessage());
3932 }
3933 }
3934 }
Tom Taylord4a47292009-12-21 13:59:18 -08003935
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003936 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003937
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003938 } catch (IndexOutOfBoundsException e) {
3939 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3940 }
3941 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003942
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003943 public static Intent getIntentOld(String uri) throws URISyntaxException {
3944 Intent intent;
3945
3946 int i = uri.lastIndexOf('#');
3947 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003948 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003949 final int intentFragmentStart = i;
3950 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003951
3952 i++;
3953
3954 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003955 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003956 i += 7;
3957 int j = uri.indexOf(')', i);
3958 action = uri.substring(i, j);
3959 i = j + 1;
3960 }
3961
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003962 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003963
3964 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003965 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003966 i += 11;
3967 int j = uri.indexOf(')', i);
3968 while (i < j) {
3969 int sep = uri.indexOf('!', i);
3970 if (sep < 0) sep = j;
3971 if (i < sep) {
3972 intent.addCategory(uri.substring(i, sep));
3973 }
3974 i = sep + 1;
3975 }
3976 i = j + 1;
3977 }
3978
3979 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003980 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003981 i += 5;
3982 int j = uri.indexOf(')', i);
3983 intent.mType = uri.substring(i, j);
3984 i = j + 1;
3985 }
3986
3987 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003988 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003989 i += 12;
3990 int j = uri.indexOf(')', i);
3991 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3992 i = j + 1;
3993 }
3994
3995 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003996 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003997 i += 10;
3998 int j = uri.indexOf(')', i);
3999 int sep = uri.indexOf('!', i);
4000 if (sep >= 0 && sep < j) {
4001 String pkg = uri.substring(i, sep);
4002 String cls = uri.substring(sep + 1, j);
4003 intent.mComponent = new ComponentName(pkg, cls);
4004 }
4005 i = j + 1;
4006 }
4007
4008 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004009 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004010 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004011
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004012 final int closeParen = uri.indexOf(')', i);
4013 if (closeParen == -1) throw new URISyntaxException(uri,
4014 "EXTRA missing trailing ')'", i);
4015
4016 while (i < closeParen) {
4017 // fetch the key value
4018 int j = uri.indexOf('=', i);
4019 if (j <= i + 1 || i >= closeParen) {
4020 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4021 }
4022 char type = uri.charAt(i);
4023 i++;
4024 String key = uri.substring(i, j);
4025 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004026
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004027 // get type-value
4028 j = uri.indexOf('!', i);
4029 if (j == -1 || j >= closeParen) j = closeParen;
4030 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4031 String value = uri.substring(i, j);
4032 i = j;
4033
4034 // create Bundle if it doesn't already exist
4035 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004036
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004037 // add item to bundle
4038 try {
4039 switch (type) {
4040 case 'S':
4041 intent.mExtras.putString(key, Uri.decode(value));
4042 break;
4043 case 'B':
4044 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4045 break;
4046 case 'b':
4047 intent.mExtras.putByte(key, Byte.parseByte(value));
4048 break;
4049 case 'c':
4050 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4051 break;
4052 case 'd':
4053 intent.mExtras.putDouble(key, Double.parseDouble(value));
4054 break;
4055 case 'f':
4056 intent.mExtras.putFloat(key, Float.parseFloat(value));
4057 break;
4058 case 'i':
4059 intent.mExtras.putInt(key, Integer.parseInt(value));
4060 break;
4061 case 'l':
4062 intent.mExtras.putLong(key, Long.parseLong(value));
4063 break;
4064 case 's':
4065 intent.mExtras.putShort(key, Short.parseShort(value));
4066 break;
4067 default:
4068 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4069 }
4070 } catch (NumberFormatException e) {
4071 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4072 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004073
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004074 char ch = uri.charAt(i);
4075 if (ch == ')') break;
4076 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4077 i++;
4078 }
4079 }
4080
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004081 if (isIntentFragment) {
4082 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4083 } else {
4084 intent.mData = Uri.parse(uri);
4085 }
Tom Taylord4a47292009-12-21 13:59:18 -08004086
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004087 if (intent.mAction == null) {
4088 // By default, if no action is specified, then use VIEW.
4089 intent.mAction = ACTION_VIEW;
4090 }
4091
4092 } else {
4093 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4094 }
4095
4096 return intent;
4097 }
4098
4099 /**
4100 * Retrieve the general action to be performed, such as
4101 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4102 * the information in the intent should be interpreted -- most importantly,
4103 * what to do with the data returned by {@link #getData}.
4104 *
4105 * @return The action of this intent or null if none is specified.
4106 *
4107 * @see #setAction
4108 */
4109 public String getAction() {
4110 return mAction;
4111 }
4112
4113 /**
4114 * Retrieve data this intent is operating on. This URI specifies the name
4115 * of the data; often it uses the content: scheme, specifying data in a
4116 * content provider. Other schemes may be handled by specific activities,
4117 * such as http: by the web browser.
4118 *
4119 * @return The URI of the data this intent is targeting or null.
4120 *
4121 * @see #getScheme
4122 * @see #setData
4123 */
4124 public Uri getData() {
4125 return mData;
4126 }
4127
4128 /**
4129 * The same as {@link #getData()}, but returns the URI as an encoded
4130 * String.
4131 */
4132 public String getDataString() {
4133 return mData != null ? mData.toString() : null;
4134 }
4135
4136 /**
4137 * Return the scheme portion of the intent's data. If the data is null or
4138 * does not include a scheme, null is returned. Otherwise, the scheme
4139 * prefix without the final ':' is returned, i.e. "http".
4140 *
4141 * <p>This is the same as calling getData().getScheme() (and checking for
4142 * null data).
4143 *
4144 * @return The scheme of this intent.
4145 *
4146 * @see #getData
4147 */
4148 public String getScheme() {
4149 return mData != null ? mData.getScheme() : null;
4150 }
4151
4152 /**
4153 * Retrieve any explicit MIME type included in the intent. This is usually
4154 * null, as the type is determined by the intent data.
4155 *
4156 * @return If a type was manually set, it is returned; else null is
4157 * returned.
4158 *
4159 * @see #resolveType(ContentResolver)
4160 * @see #setType
4161 */
4162 public String getType() {
4163 return mType;
4164 }
4165
4166 /**
4167 * Return the MIME data type of this intent. If the type field is
4168 * explicitly set, that is simply returned. Otherwise, if the data is set,
4169 * the type of that data is returned. If neither fields are set, a null is
4170 * returned.
4171 *
4172 * @return The MIME type of this intent.
4173 *
4174 * @see #getType
4175 * @see #resolveType(ContentResolver)
4176 */
4177 public String resolveType(Context context) {
4178 return resolveType(context.getContentResolver());
4179 }
4180
4181 /**
4182 * Return the MIME data type of this intent. If the type field is
4183 * explicitly set, that is simply returned. Otherwise, if the data is set,
4184 * the type of that data is returned. If neither fields are set, a null is
4185 * returned.
4186 *
4187 * @param resolver A ContentResolver that can be used to determine the MIME
4188 * type of the intent's data.
4189 *
4190 * @return The MIME type of this intent.
4191 *
4192 * @see #getType
4193 * @see #resolveType(Context)
4194 */
4195 public String resolveType(ContentResolver resolver) {
4196 if (mType != null) {
4197 return mType;
4198 }
4199 if (mData != null) {
4200 if ("content".equals(mData.getScheme())) {
4201 return resolver.getType(mData);
4202 }
4203 }
4204 return null;
4205 }
4206
4207 /**
4208 * Return the MIME data type of this intent, only if it will be needed for
4209 * intent resolution. This is not generally useful for application code;
4210 * it is used by the frameworks for communicating with back-end system
4211 * services.
4212 *
4213 * @param resolver A ContentResolver that can be used to determine the MIME
4214 * type of the intent's data.
4215 *
4216 * @return The MIME type of this intent, or null if it is unknown or not
4217 * needed.
4218 */
4219 public String resolveTypeIfNeeded(ContentResolver resolver) {
4220 if (mComponent != null) {
4221 return mType;
4222 }
4223 return resolveType(resolver);
4224 }
4225
4226 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004227 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004228 *
4229 * @param category The category to check.
4230 *
4231 * @return boolean True if the intent contains the category, else false.
4232 *
4233 * @see #getCategories
4234 * @see #addCategory
4235 */
4236 public boolean hasCategory(String category) {
4237 return mCategories != null && mCategories.contains(category);
4238 }
4239
4240 /**
4241 * Return the set of all categories in the intent. If there are no categories,
4242 * returns NULL.
4243 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004244 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004245 *
4246 * @see #hasCategory
4247 * @see #addCategory
4248 */
4249 public Set<String> getCategories() {
4250 return mCategories;
4251 }
4252
4253 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004254 * Return the specific selector associated with this Intent. If there is
4255 * none, returns null. See {@link #setSelector} for more information.
4256 *
4257 * @see #setSelector
4258 */
4259 public Intent getSelector() {
4260 return mSelector;
4261 }
4262
4263 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004264 * Return the {@link ClipData} associated with this Intent. If there is
4265 * none, returns null. See {@link #setClipData} for more information.
4266 *
4267 * @see #setClipData;
4268 */
4269 public ClipData getClipData() {
4270 return mClipData;
4271 }
4272
4273 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004274 * Sets the ClassLoader that will be used when unmarshalling
4275 * any Parcelable values from the extras of this Intent.
4276 *
4277 * @param loader a ClassLoader, or null to use the default loader
4278 * at the time of unmarshalling.
4279 */
4280 public void setExtrasClassLoader(ClassLoader loader) {
4281 if (mExtras != null) {
4282 mExtras.setClassLoader(loader);
4283 }
4284 }
4285
4286 /**
4287 * Returns true if an extra value is associated with the given name.
4288 * @param name the extra's name
4289 * @return true if the given extra is present.
4290 */
4291 public boolean hasExtra(String name) {
4292 return mExtras != null && mExtras.containsKey(name);
4293 }
4294
4295 /**
4296 * Returns true if the Intent's extras contain a parcelled file descriptor.
4297 * @return true if the Intent contains a parcelled file descriptor.
4298 */
4299 public boolean hasFileDescriptors() {
4300 return mExtras != null && mExtras.hasFileDescriptors();
4301 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004302
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004303 /** @hide */
4304 public void setAllowFds(boolean allowFds) {
4305 if (mExtras != null) {
4306 mExtras.setAllowFds(allowFds);
4307 }
4308 }
4309
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004310 /**
4311 * Retrieve extended data from the intent.
4312 *
4313 * @param name The name of the desired item.
4314 *
4315 * @return the value of an item that previously added with putExtra()
4316 * or null if none was found.
4317 *
4318 * @deprecated
4319 * @hide
4320 */
4321 @Deprecated
4322 public Object getExtra(String name) {
4323 return getExtra(name, null);
4324 }
4325
4326 /**
4327 * Retrieve extended data from the intent.
4328 *
4329 * @param name The name of the desired item.
4330 * @param defaultValue the value to be returned if no value of the desired
4331 * type is stored with the given name.
4332 *
4333 * @return the value of an item that previously added with putExtra()
4334 * or the default value if none was found.
4335 *
4336 * @see #putExtra(String, boolean)
4337 */
4338 public boolean getBooleanExtra(String name, boolean defaultValue) {
4339 return mExtras == null ? defaultValue :
4340 mExtras.getBoolean(name, defaultValue);
4341 }
4342
4343 /**
4344 * Retrieve extended data from the intent.
4345 *
4346 * @param name The name of the desired item.
4347 * @param defaultValue the value to be returned if no value of the desired
4348 * type is stored with the given name.
4349 *
4350 * @return the value of an item that previously added with putExtra()
4351 * or the default value if none was found.
4352 *
4353 * @see #putExtra(String, byte)
4354 */
4355 public byte getByteExtra(String name, byte defaultValue) {
4356 return mExtras == null ? defaultValue :
4357 mExtras.getByte(name, defaultValue);
4358 }
4359
4360 /**
4361 * Retrieve extended data from the intent.
4362 *
4363 * @param name The name of the desired item.
4364 * @param defaultValue the value to be returned if no value of the desired
4365 * type is stored with the given name.
4366 *
4367 * @return the value of an item that previously added with putExtra()
4368 * or the default value if none was found.
4369 *
4370 * @see #putExtra(String, short)
4371 */
4372 public short getShortExtra(String name, short defaultValue) {
4373 return mExtras == null ? defaultValue :
4374 mExtras.getShort(name, defaultValue);
4375 }
4376
4377 /**
4378 * Retrieve extended data from the intent.
4379 *
4380 * @param name The name of the desired item.
4381 * @param defaultValue the value to be returned if no value of the desired
4382 * type is stored with the given name.
4383 *
4384 * @return the value of an item that previously added with putExtra()
4385 * or the default value if none was found.
4386 *
4387 * @see #putExtra(String, char)
4388 */
4389 public char getCharExtra(String name, char defaultValue) {
4390 return mExtras == null ? defaultValue :
4391 mExtras.getChar(name, defaultValue);
4392 }
4393
4394 /**
4395 * Retrieve extended data from the intent.
4396 *
4397 * @param name The name of the desired item.
4398 * @param defaultValue the value to be returned if no value of the desired
4399 * type is stored with the given name.
4400 *
4401 * @return the value of an item that previously added with putExtra()
4402 * or the default value if none was found.
4403 *
4404 * @see #putExtra(String, int)
4405 */
4406 public int getIntExtra(String name, int defaultValue) {
4407 return mExtras == null ? defaultValue :
4408 mExtras.getInt(name, defaultValue);
4409 }
4410
4411 /**
4412 * Retrieve extended data from the intent.
4413 *
4414 * @param name The name of the desired item.
4415 * @param defaultValue the value to be returned if no value of the desired
4416 * type is stored with the given name.
4417 *
4418 * @return the value of an item that previously added with putExtra()
4419 * or the default value if none was found.
4420 *
4421 * @see #putExtra(String, long)
4422 */
4423 public long getLongExtra(String name, long defaultValue) {
4424 return mExtras == null ? defaultValue :
4425 mExtras.getLong(name, defaultValue);
4426 }
4427
4428 /**
4429 * Retrieve extended data from the intent.
4430 *
4431 * @param name The name of the desired item.
4432 * @param defaultValue the value to be returned if no value of the desired
4433 * type is stored with the given name.
4434 *
4435 * @return the value of an item that previously added with putExtra(),
4436 * or the default value if no such item is present
4437 *
4438 * @see #putExtra(String, float)
4439 */
4440 public float getFloatExtra(String name, float defaultValue) {
4441 return mExtras == null ? defaultValue :
4442 mExtras.getFloat(name, defaultValue);
4443 }
4444
4445 /**
4446 * Retrieve extended data from the intent.
4447 *
4448 * @param name The name of the desired item.
4449 * @param defaultValue the value to be returned if no value of the desired
4450 * type is stored with the given name.
4451 *
4452 * @return the value of an item that previously added with putExtra()
4453 * or the default value if none was found.
4454 *
4455 * @see #putExtra(String, double)
4456 */
4457 public double getDoubleExtra(String name, double defaultValue) {
4458 return mExtras == null ? defaultValue :
4459 mExtras.getDouble(name, defaultValue);
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 String value was found.
4469 *
4470 * @see #putExtra(String, String)
4471 */
4472 public String getStringExtra(String name) {
4473 return mExtras == null ? null : mExtras.getString(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 CharSequence value was found.
4483 *
4484 * @see #putExtra(String, CharSequence)
4485 */
4486 public CharSequence getCharSequenceExtra(String name) {
4487 return mExtras == null ? null : mExtras.getCharSequence(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 <T extends Parcelable> T getParcelableExtra(String name) {
4501 return mExtras == null ? null : mExtras.<T>getParcelable(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 Parcelable[] value was found.
4511 *
4512 * @see #putExtra(String, Parcelable[])
4513 */
4514 public Parcelable[] getParcelableArrayExtra(String name) {
4515 return mExtras == null ? null : mExtras.getParcelableArray(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 ArrayList<Parcelable> value was found.
4525 *
4526 * @see #putParcelableArrayListExtra(String, ArrayList)
4527 */
4528 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4529 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(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 Serializable value was found.
4539 *
4540 * @see #putExtra(String, Serializable)
4541 */
4542 public Serializable getSerializableExtra(String name) {
4543 return mExtras == null ? null : mExtras.getSerializable(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<Integer> value was found.
4553 *
4554 * @see #putIntegerArrayListExtra(String, ArrayList)
4555 */
4556 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4557 return mExtras == null ? null : mExtras.getIntegerArrayList(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()
4566 * or null if no ArrayList<String> value was found.
4567 *
4568 * @see #putStringArrayListExtra(String, ArrayList)
4569 */
4570 public ArrayList<String> getStringArrayListExtra(String name) {
4571 return mExtras == null ? null : mExtras.getStringArrayList(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()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004580 * or null if no ArrayList<CharSequence> value was found.
4581 *
4582 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4583 */
4584 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4585 return mExtras == null ? null : mExtras.getCharSequenceArrayList(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()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004594 * or null if no boolean array value was found.
4595 *
4596 * @see #putExtra(String, boolean[])
4597 */
4598 public boolean[] getBooleanArrayExtra(String name) {
4599 return mExtras == null ? null : mExtras.getBooleanArray(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 byte array value was found.
4609 *
4610 * @see #putExtra(String, byte[])
4611 */
4612 public byte[] getByteArrayExtra(String name) {
4613 return mExtras == null ? null : mExtras.getByteArray(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 short array value was found.
4623 *
4624 * @see #putExtra(String, short[])
4625 */
4626 public short[] getShortArrayExtra(String name) {
4627 return mExtras == null ? null : mExtras.getShortArray(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 char array value was found.
4637 *
4638 * @see #putExtra(String, char[])
4639 */
4640 public char[] getCharArrayExtra(String name) {
4641 return mExtras == null ? null : mExtras.getCharArray(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 int array value was found.
4651 *
4652 * @see #putExtra(String, int[])
4653 */
4654 public int[] getIntArrayExtra(String name) {
4655 return mExtras == null ? null : mExtras.getIntArray(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 long array value was found.
4665 *
4666 * @see #putExtra(String, long[])
4667 */
4668 public long[] getLongArrayExtra(String name) {
4669 return mExtras == null ? null : mExtras.getLongArray(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 float array value was found.
4679 *
4680 * @see #putExtra(String, float[])
4681 */
4682 public float[] getFloatArrayExtra(String name) {
4683 return mExtras == null ? null : mExtras.getFloatArray(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 double array value was found.
4693 *
4694 * @see #putExtra(String, double[])
4695 */
4696 public double[] getDoubleArrayExtra(String name) {
4697 return mExtras == null ? null : mExtras.getDoubleArray(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()
4706 * or null if no String array value was found.
4707 *
4708 * @see #putExtra(String, String[])
4709 */
4710 public String[] getStringArrayExtra(String name) {
4711 return mExtras == null ? null : mExtras.getStringArray(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()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004720 * or null if no CharSequence array value was found.
4721 *
4722 * @see #putExtra(String, CharSequence[])
4723 */
4724 public CharSequence[] getCharSequenceArrayExtra(String name) {
4725 return mExtras == null ? null : mExtras.getCharSequenceArray(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()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004734 * or null if no Bundle value was found.
4735 *
4736 * @see #putExtra(String, Bundle)
4737 */
4738 public Bundle getBundleExtra(String name) {
4739 return mExtras == null ? null : mExtras.getBundle(name);
4740 }
4741
4742 /**
4743 * Retrieve extended data from the intent.
4744 *
4745 * @param name The name of the desired item.
4746 *
4747 * @return the value of an item that previously added with putExtra()
4748 * or null if no IBinder value was found.
4749 *
4750 * @see #putExtra(String, IBinder)
4751 *
4752 * @deprecated
4753 * @hide
4754 */
4755 @Deprecated
4756 public IBinder getIBinderExtra(String name) {
4757 return mExtras == null ? null : mExtras.getIBinder(name);
4758 }
4759
4760 /**
4761 * Retrieve extended data from the intent.
4762 *
4763 * @param name The name of the desired item.
4764 * @param defaultValue The default value to return in case no item is
4765 * associated with the key 'name'
4766 *
4767 * @return the value of an item that previously added with putExtra()
4768 * or defaultValue if none was found.
4769 *
4770 * @see #putExtra
4771 *
4772 * @deprecated
4773 * @hide
4774 */
4775 @Deprecated
4776 public Object getExtra(String name, Object defaultValue) {
4777 Object result = defaultValue;
4778 if (mExtras != null) {
4779 Object result2 = mExtras.get(name);
4780 if (result2 != null) {
4781 result = result2;
4782 }
4783 }
4784
4785 return result;
4786 }
4787
4788 /**
4789 * Retrieves a map of extended data from the intent.
4790 *
4791 * @return the map of all extras previously added with putExtra(),
4792 * or null if none have been added.
4793 */
4794 public Bundle getExtras() {
4795 return (mExtras != null)
4796 ? new Bundle(mExtras)
4797 : null;
4798 }
4799
4800 /**
4801 * Retrieve any special flags associated with this intent. You will
4802 * normally just set them with {@link #setFlags} and let the system
4803 * take the appropriate action with them.
4804 *
4805 * @return int The currently set flags.
4806 *
4807 * @see #setFlags
4808 */
4809 public int getFlags() {
4810 return mFlags;
4811 }
4812
Dianne Hackborne7f97212011-02-24 14:40:20 -08004813 /** @hide */
4814 public boolean isExcludingStopped() {
4815 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4816 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4817 }
4818
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004819 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004820 * Retrieve the application package name this Intent is limited to. When
4821 * resolving an Intent, if non-null this limits the resolution to only
4822 * components in the given application package.
4823 *
4824 * @return The name of the application package for the Intent.
4825 *
4826 * @see #resolveActivity
4827 * @see #setPackage
4828 */
4829 public String getPackage() {
4830 return mPackage;
4831 }
4832
4833 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004834 * Retrieve the concrete component associated with the intent. When receiving
4835 * an intent, this is the component that was found to best handle it (that is,
4836 * yourself) and will always be non-null; in all other cases it will be
4837 * null unless explicitly set.
4838 *
4839 * @return The name of the application component to handle the intent.
4840 *
4841 * @see #resolveActivity
4842 * @see #setComponent
4843 */
4844 public ComponentName getComponent() {
4845 return mComponent;
4846 }
4847
4848 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004849 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4850 * used as a hint to the receiver for animations and the like. Null means that there
4851 * is no source bounds.
4852 */
4853 public Rect getSourceBounds() {
4854 return mSourceBounds;
4855 }
4856
4857 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004858 * Return the Activity component that should be used to handle this intent.
4859 * The appropriate component is determined based on the information in the
4860 * intent, evaluated as follows:
4861 *
4862 * <p>If {@link #getComponent} returns an explicit class, that is returned
4863 * without any further consideration.
4864 *
4865 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4866 * category to be considered.
4867 *
4868 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4869 * action.
4870 *
4871 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4872 * this type.
4873 *
4874 * <p>If {@link #addCategory} has added any categories, the activity must
4875 * handle ALL of the categories specified.
4876 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004877 * <p>If {@link #getPackage} is non-NULL, only activity components in
4878 * that application package will be considered.
4879 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004880 * <p>If there are no activities that satisfy all of these conditions, a
4881 * null string is returned.
4882 *
4883 * <p>If multiple activities are found to satisfy the intent, the one with
4884 * the highest priority will be used. If there are multiple activities
4885 * with the same priority, the system will either pick the best activity
4886 * based on user preference, or resolve to a system class that will allow
4887 * the user to pick an activity and forward from there.
4888 *
4889 * <p>This method is implemented simply by calling
4890 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4891 * true.</p>
4892 * <p> This API is called for you as part of starting an activity from an
4893 * intent. You do not normally need to call it yourself.</p>
4894 *
4895 * @param pm The package manager with which to resolve the Intent.
4896 *
4897 * @return Name of the component implementing an activity that can
4898 * display the intent.
4899 *
4900 * @see #setComponent
4901 * @see #getComponent
4902 * @see #resolveActivityInfo
4903 */
4904 public ComponentName resolveActivity(PackageManager pm) {
4905 if (mComponent != null) {
4906 return mComponent;
4907 }
4908
4909 ResolveInfo info = pm.resolveActivity(
4910 this, PackageManager.MATCH_DEFAULT_ONLY);
4911 if (info != null) {
4912 return new ComponentName(
4913 info.activityInfo.applicationInfo.packageName,
4914 info.activityInfo.name);
4915 }
4916
4917 return null;
4918 }
4919
4920 /**
4921 * Resolve the Intent into an {@link ActivityInfo}
4922 * describing the activity that should execute the intent. Resolution
4923 * follows the same rules as described for {@link #resolveActivity}, but
4924 * you get back the completely information about the resolved activity
4925 * instead of just its class name.
4926 *
4927 * @param pm The package manager with which to resolve the Intent.
4928 * @param flags Addition information to retrieve as per
4929 * {@link PackageManager#getActivityInfo(ComponentName, int)
4930 * PackageManager.getActivityInfo()}.
4931 *
4932 * @return PackageManager.ActivityInfo
4933 *
4934 * @see #resolveActivity
4935 */
4936 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4937 ActivityInfo ai = null;
4938 if (mComponent != null) {
4939 try {
4940 ai = pm.getActivityInfo(mComponent, flags);
4941 } catch (PackageManager.NameNotFoundException e) {
4942 // ignore
4943 }
4944 } else {
4945 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004946 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004947 if (info != null) {
4948 ai = info.activityInfo;
4949 }
4950 }
4951
4952 return ai;
4953 }
4954
4955 /**
4956 * Set the general action to be performed.
4957 *
4958 * @param action An action name, such as ACTION_VIEW. Application-specific
4959 * actions should be prefixed with the vendor's package name.
4960 *
4961 * @return Returns the same Intent object, for chaining multiple calls
4962 * into a single statement.
4963 *
4964 * @see #getAction
4965 */
4966 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004967 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004968 return this;
4969 }
4970
4971 /**
4972 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004973 * clears any type that was previously set by {@link #setType} or
4974 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004975 *
Nick Pellyccae4122012-01-09 14:12:58 -08004976 * <p><em>Note: scheme matching in the Android framework is
4977 * case-sensitive, unlike the formal RFC. As a result,
4978 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004979 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004980 * {@link #setDataAndNormalize}
4981 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004982 *
Nick Pellyccae4122012-01-09 14:12:58 -08004983 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004984 *
4985 * @return Returns the same Intent object, for chaining multiple calls
4986 * into a single statement.
4987 *
4988 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004989 * @see #setDataAndNormalize
4990 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004991 */
4992 public Intent setData(Uri data) {
4993 mData = data;
4994 mType = null;
4995 return this;
4996 }
4997
4998 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004999 * Normalize and set the data this intent is operating on.
5000 *
5001 * <p>This method automatically clears any type that was
5002 * previously set (for example, by {@link #setType}).
5003 *
5004 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005005 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005006 * so really this is just a convenience method for
5007 * <pre>
5008 * setData(data.normalize())
5009 * </pre>
5010 *
5011 * @param data The Uri of the data this intent is now targeting.
5012 *
5013 * @return Returns the same Intent object, for chaining multiple calls
5014 * into a single statement.
5015 *
5016 * @see #getData
5017 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005018 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005019 */
5020 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005021 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005022 }
5023
5024 /**
5025 * Set an explicit MIME data type.
5026 *
5027 * <p>This is used to create intents that only specify a type and not data,
5028 * for example to indicate the type of data to return.
5029 *
5030 * <p>This method automatically clears any data that was
5031 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005032 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005033 * <p><em>Note: MIME type matching in the Android framework is
5034 * case-sensitive, unlike formal RFC MIME types. As a result,
5035 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005036 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5037 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005038 *
5039 * @param type The MIME type of the data being handled by this intent.
5040 *
5041 * @return Returns the same Intent object, for chaining multiple calls
5042 * into a single statement.
5043 *
5044 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005045 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005046 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005047 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005048 */
5049 public Intent setType(String type) {
5050 mData = null;
5051 mType = type;
5052 return this;
5053 }
5054
5055 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005056 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005057 *
Nick Pellyccae4122012-01-09 14:12:58 -08005058 * <p>This is used to create intents that only specify a type and not data,
5059 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005060 *
Nick Pellyccae4122012-01-09 14:12:58 -08005061 * <p>This method automatically clears any data that was
5062 * previously set (for example by {@link #setData}).
5063 *
5064 * <p>The MIME type is normalized using
5065 * {@link #normalizeMimeType} before it is set,
5066 * so really this is just a convenience method for
5067 * <pre>
5068 * setType(Intent.normalizeMimeType(type))
5069 * </pre>
5070 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005071 * @param type The MIME type of the data being handled by this intent.
5072 *
5073 * @return Returns the same Intent object, for chaining multiple calls
5074 * into a single statement.
5075 *
Nick Pellyccae4122012-01-09 14:12:58 -08005076 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005077 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005078 * @see #normalizeMimeType
5079 */
5080 public Intent setTypeAndNormalize(String type) {
5081 return setType(normalizeMimeType(type));
5082 }
5083
5084 /**
5085 * (Usually optional) Set the data for the intent along with an explicit
5086 * MIME data type. This method should very rarely be used -- it allows you
5087 * to override the MIME type that would ordinarily be inferred from the
5088 * data with your own type given here.
5089 *
5090 * <p><em>Note: MIME type and Uri scheme matching in the
5091 * Android framework is case-sensitive, unlike the formal RFC definitions.
5092 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005093 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005094 * {@link #setDataAndTypeAndNormalize}
5095 * to ensure that they are converted to lower case.</em>
5096 *
5097 * @param data The Uri of the data this intent is now targeting.
5098 * @param type The MIME type of the data being handled by this intent.
5099 *
5100 * @return Returns the same Intent object, for chaining multiple calls
5101 * into a single statement.
5102 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005103 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005104 * @see #setData
5105 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005106 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005107 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005108 */
5109 public Intent setDataAndType(Uri data, String type) {
5110 mData = data;
5111 mType = type;
5112 return this;
5113 }
5114
5115 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005116 * (Usually optional) Normalize and set both the data Uri and an explicit
5117 * MIME data type. This method should very rarely be used -- it allows you
5118 * to override the MIME type that would ordinarily be inferred from the
5119 * data with your own type given here.
5120 *
5121 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005122 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005123 * before they are set, so really this is just a convenience method for
5124 * <pre>
5125 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5126 * </pre>
5127 *
5128 * @param data The Uri of the data this intent is now targeting.
5129 * @param type The MIME type of the data being handled by this intent.
5130 *
5131 * @return Returns the same Intent object, for chaining multiple calls
5132 * into a single statement.
5133 *
5134 * @see #setType
5135 * @see #setData
5136 * @see #setDataAndType
5137 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005138 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005139 */
5140 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005141 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005142 }
5143
5144 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005145 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005146 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005147 * activities that provide <em>all</em> of the requested categories will be
5148 * used.
5149 *
5150 * @param category The desired category. This can be either one of the
5151 * predefined Intent categories, or a custom category in your own
5152 * namespace.
5153 *
5154 * @return Returns the same Intent object, for chaining multiple calls
5155 * into a single statement.
5156 *
5157 * @see #hasCategory
5158 * @see #removeCategory
5159 */
5160 public Intent addCategory(String category) {
5161 if (mCategories == null) {
5162 mCategories = new HashSet<String>();
5163 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005164 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005165 return this;
5166 }
5167
5168 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005169 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005170 *
5171 * @param category The category to remove.
5172 *
5173 * @see #addCategory
5174 */
5175 public void removeCategory(String category) {
5176 if (mCategories != null) {
5177 mCategories.remove(category);
5178 if (mCategories.size() == 0) {
5179 mCategories = null;
5180 }
5181 }
5182 }
5183
5184 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005185 * Set a selector for this Intent. This is a modification to the kinds of
5186 * things the Intent will match. If the selector is set, it will be used
5187 * when trying to find entities that can handle the Intent, instead of the
5188 * main contents of the Intent. This allows you build an Intent containing
5189 * a generic protocol while targeting it more specifically.
5190 *
5191 * <p>An example of where this may be used is with things like
5192 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5193 * Intent that will launch the Browser application. However, the correct
5194 * main entry point of an application is actually {@link #ACTION_MAIN}
5195 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5196 * used to specify the actual Activity to launch. If you launch the browser
5197 * with something different, undesired behavior may happen if the user has
5198 * previously or later launches it the normal way, since they do not match.
5199 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5200 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5201 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5202 *
5203 * <p>Setting a selector does not impact the behavior of
5204 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5205 * desired behavior of a selector -- it does not impact the base meaning
5206 * of the Intent, just what kinds of things will be matched against it
5207 * when determining who can handle it.</p>
5208 *
5209 * <p>You can not use both a selector and {@link #setPackage(String)} on
5210 * the same base Intent.</p>
5211 *
5212 * @param selector The desired selector Intent; set to null to not use
5213 * a special selector.
5214 */
5215 public void setSelector(Intent selector) {
5216 if (selector == this) {
5217 throw new IllegalArgumentException(
5218 "Intent being set as a selector of itself");
5219 }
5220 if (selector != null && mPackage != null) {
5221 throw new IllegalArgumentException(
5222 "Can't set selector when package name is already set");
5223 }
5224 mSelector = selector;
5225 }
5226
5227 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005228 * Set a {@link ClipData} associated with this Intent. This replaces any
5229 * previously set ClipData.
5230 *
5231 * <p>The ClipData in an intent is not used for Intent matching or other
5232 * such operations. Semantically it is like extras, used to transmit
5233 * additional data with the Intent. The main feature of using this over
5234 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5235 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5236 * items included in the clip data. This is useful, in particular, if
5237 * you want to transmit an Intent containing multiple <code>content:</code>
5238 * URIs for which the recipient may not have global permission to access the
5239 * content provider.
5240 *
5241 * <p>If the ClipData contains items that are themselves Intents, any
5242 * grant flags in those Intents will be ignored. Only the top-level flags
5243 * of the main Intent are respected, and will be applied to all Uri or
5244 * Intent items in the clip (or sub-items of the clip).
5245 *
5246 * <p>The MIME type, label, and icon in the ClipData object are not
5247 * directly used by Intent. Applications should generally rely on the
5248 * MIME type of the Intent itself, not what it may find in the ClipData.
5249 * A common practice is to construct a ClipData for use with an Intent
5250 * with a MIME type of "*\/*".
5251 *
5252 * @param clip The new clip to set. May be null to clear the current clip.
5253 */
5254 public void setClipData(ClipData clip) {
5255 mClipData = clip;
5256 }
5257
5258 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005259 * Add extended data to the intent. The name must include a package
5260 * prefix, for example the app com.android.contacts would use names
5261 * like "com.android.contacts.ShowAll".
5262 *
5263 * @param name The name of the extra data, with package prefix.
5264 * @param value The boolean data value.
5265 *
5266 * @return Returns the same Intent object, for chaining multiple calls
5267 * into a single statement.
5268 *
5269 * @see #putExtras
5270 * @see #removeExtra
5271 * @see #getBooleanExtra(String, boolean)
5272 */
5273 public Intent putExtra(String name, boolean value) {
5274 if (mExtras == null) {
5275 mExtras = new Bundle();
5276 }
5277 mExtras.putBoolean(name, value);
5278 return this;
5279 }
5280
5281 /**
5282 * Add extended data to the intent. The name must include a package
5283 * prefix, for example the app com.android.contacts would use names
5284 * like "com.android.contacts.ShowAll".
5285 *
5286 * @param name The name of the extra data, with package prefix.
5287 * @param value The byte data value.
5288 *
5289 * @return Returns the same Intent object, for chaining multiple calls
5290 * into a single statement.
5291 *
5292 * @see #putExtras
5293 * @see #removeExtra
5294 * @see #getByteExtra(String, byte)
5295 */
5296 public Intent putExtra(String name, byte value) {
5297 if (mExtras == null) {
5298 mExtras = new Bundle();
5299 }
5300 mExtras.putByte(name, value);
5301 return this;
5302 }
5303
5304 /**
5305 * Add extended data to the intent. The name must include a package
5306 * prefix, for example the app com.android.contacts would use names
5307 * like "com.android.contacts.ShowAll".
5308 *
5309 * @param name The name of the extra data, with package prefix.
5310 * @param value The char data value.
5311 *
5312 * @return Returns the same Intent object, for chaining multiple calls
5313 * into a single statement.
5314 *
5315 * @see #putExtras
5316 * @see #removeExtra
5317 * @see #getCharExtra(String, char)
5318 */
5319 public Intent putExtra(String name, char value) {
5320 if (mExtras == null) {
5321 mExtras = new Bundle();
5322 }
5323 mExtras.putChar(name, value);
5324 return this;
5325 }
5326
5327 /**
5328 * Add extended data to the intent. The name must include a package
5329 * prefix, for example the app com.android.contacts would use names
5330 * like "com.android.contacts.ShowAll".
5331 *
5332 * @param name The name of the extra data, with package prefix.
5333 * @param value The short data value.
5334 *
5335 * @return Returns the same Intent object, for chaining multiple calls
5336 * into a single statement.
5337 *
5338 * @see #putExtras
5339 * @see #removeExtra
5340 * @see #getShortExtra(String, short)
5341 */
5342 public Intent putExtra(String name, short value) {
5343 if (mExtras == null) {
5344 mExtras = new Bundle();
5345 }
5346 mExtras.putShort(name, value);
5347 return this;
5348 }
5349
5350 /**
5351 * Add extended data to the intent. The name must include a package
5352 * prefix, for example the app com.android.contacts would use names
5353 * like "com.android.contacts.ShowAll".
5354 *
5355 * @param name The name of the extra data, with package prefix.
5356 * @param value The integer data value.
5357 *
5358 * @return Returns the same Intent object, for chaining multiple calls
5359 * into a single statement.
5360 *
5361 * @see #putExtras
5362 * @see #removeExtra
5363 * @see #getIntExtra(String, int)
5364 */
5365 public Intent putExtra(String name, int value) {
5366 if (mExtras == null) {
5367 mExtras = new Bundle();
5368 }
5369 mExtras.putInt(name, value);
5370 return this;
5371 }
5372
5373 /**
5374 * Add extended data to the intent. The name must include a package
5375 * prefix, for example the app com.android.contacts would use names
5376 * like "com.android.contacts.ShowAll".
5377 *
5378 * @param name The name of the extra data, with package prefix.
5379 * @param value The long data value.
5380 *
5381 * @return Returns the same Intent object, for chaining multiple calls
5382 * into a single statement.
5383 *
5384 * @see #putExtras
5385 * @see #removeExtra
5386 * @see #getLongExtra(String, long)
5387 */
5388 public Intent putExtra(String name, long value) {
5389 if (mExtras == null) {
5390 mExtras = new Bundle();
5391 }
5392 mExtras.putLong(name, value);
5393 return this;
5394 }
5395
5396 /**
5397 * Add extended data to the intent. The name must include a package
5398 * prefix, for example the app com.android.contacts would use names
5399 * like "com.android.contacts.ShowAll".
5400 *
5401 * @param name The name of the extra data, with package prefix.
5402 * @param value The float data value.
5403 *
5404 * @return Returns the same Intent object, for chaining multiple calls
5405 * into a single statement.
5406 *
5407 * @see #putExtras
5408 * @see #removeExtra
5409 * @see #getFloatExtra(String, float)
5410 */
5411 public Intent putExtra(String name, float value) {
5412 if (mExtras == null) {
5413 mExtras = new Bundle();
5414 }
5415 mExtras.putFloat(name, value);
5416 return this;
5417 }
5418
5419 /**
5420 * Add extended data to the intent. The name must include a package
5421 * prefix, for example the app com.android.contacts would use names
5422 * like "com.android.contacts.ShowAll".
5423 *
5424 * @param name The name of the extra data, with package prefix.
5425 * @param value The double data value.
5426 *
5427 * @return Returns the same Intent object, for chaining multiple calls
5428 * into a single statement.
5429 *
5430 * @see #putExtras
5431 * @see #removeExtra
5432 * @see #getDoubleExtra(String, double)
5433 */
5434 public Intent putExtra(String name, double value) {
5435 if (mExtras == null) {
5436 mExtras = new Bundle();
5437 }
5438 mExtras.putDouble(name, value);
5439 return this;
5440 }
5441
5442 /**
5443 * Add extended data to the intent. The name must include a package
5444 * prefix, for example the app com.android.contacts would use names
5445 * like "com.android.contacts.ShowAll".
5446 *
5447 * @param name The name of the extra data, with package prefix.
5448 * @param value The String data value.
5449 *
5450 * @return Returns the same Intent object, for chaining multiple calls
5451 * into a single statement.
5452 *
5453 * @see #putExtras
5454 * @see #removeExtra
5455 * @see #getStringExtra(String)
5456 */
5457 public Intent putExtra(String name, String value) {
5458 if (mExtras == null) {
5459 mExtras = new Bundle();
5460 }
5461 mExtras.putString(name, value);
5462 return this;
5463 }
5464
5465 /**
5466 * Add extended data to the intent. The name must include a package
5467 * prefix, for example the app com.android.contacts would use names
5468 * like "com.android.contacts.ShowAll".
5469 *
5470 * @param name The name of the extra data, with package prefix.
5471 * @param value The CharSequence data value.
5472 *
5473 * @return Returns the same Intent object, for chaining multiple calls
5474 * into a single statement.
5475 *
5476 * @see #putExtras
5477 * @see #removeExtra
5478 * @see #getCharSequenceExtra(String)
5479 */
5480 public Intent putExtra(String name, CharSequence value) {
5481 if (mExtras == null) {
5482 mExtras = new Bundle();
5483 }
5484 mExtras.putCharSequence(name, value);
5485 return this;
5486 }
5487
5488 /**
5489 * Add extended data to the intent. The name must include a package
5490 * prefix, for example the app com.android.contacts would use names
5491 * like "com.android.contacts.ShowAll".
5492 *
5493 * @param name The name of the extra data, with package prefix.
5494 * @param value The Parcelable data value.
5495 *
5496 * @return Returns the same Intent object, for chaining multiple calls
5497 * into a single statement.
5498 *
5499 * @see #putExtras
5500 * @see #removeExtra
5501 * @see #getParcelableExtra(String)
5502 */
5503 public Intent putExtra(String name, Parcelable value) {
5504 if (mExtras == null) {
5505 mExtras = new Bundle();
5506 }
5507 mExtras.putParcelable(name, value);
5508 return this;
5509 }
5510
5511 /**
5512 * Add extended data to the intent. The name must include a package
5513 * prefix, for example the app com.android.contacts would use names
5514 * like "com.android.contacts.ShowAll".
5515 *
5516 * @param name The name of the extra data, with package prefix.
5517 * @param value The Parcelable[] data value.
5518 *
5519 * @return Returns the same Intent object, for chaining multiple calls
5520 * into a single statement.
5521 *
5522 * @see #putExtras
5523 * @see #removeExtra
5524 * @see #getParcelableArrayExtra(String)
5525 */
5526 public Intent putExtra(String name, Parcelable[] value) {
5527 if (mExtras == null) {
5528 mExtras = new Bundle();
5529 }
5530 mExtras.putParcelableArray(name, value);
5531 return this;
5532 }
5533
5534 /**
5535 * Add extended data to the intent. The name must include a package
5536 * prefix, for example the app com.android.contacts would use names
5537 * like "com.android.contacts.ShowAll".
5538 *
5539 * @param name The name of the extra data, with package prefix.
5540 * @param value The ArrayList<Parcelable> data value.
5541 *
5542 * @return Returns the same Intent object, for chaining multiple calls
5543 * into a single statement.
5544 *
5545 * @see #putExtras
5546 * @see #removeExtra
5547 * @see #getParcelableArrayListExtra(String)
5548 */
5549 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5550 if (mExtras == null) {
5551 mExtras = new Bundle();
5552 }
5553 mExtras.putParcelableArrayList(name, value);
5554 return this;
5555 }
5556
5557 /**
5558 * Add extended data to the intent. The name must include a package
5559 * prefix, for example the app com.android.contacts would use names
5560 * like "com.android.contacts.ShowAll".
5561 *
5562 * @param name The name of the extra data, with package prefix.
5563 * @param value The ArrayList<Integer> data value.
5564 *
5565 * @return Returns the same Intent object, for chaining multiple calls
5566 * into a single statement.
5567 *
5568 * @see #putExtras
5569 * @see #removeExtra
5570 * @see #getIntegerArrayListExtra(String)
5571 */
5572 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5573 if (mExtras == null) {
5574 mExtras = new Bundle();
5575 }
5576 mExtras.putIntegerArrayList(name, value);
5577 return this;
5578 }
5579
5580 /**
5581 * Add extended data to the intent. The name must include a package
5582 * prefix, for example the app com.android.contacts would use names
5583 * like "com.android.contacts.ShowAll".
5584 *
5585 * @param name The name of the extra data, with package prefix.
5586 * @param value The ArrayList<String> data value.
5587 *
5588 * @return Returns the same Intent object, for chaining multiple calls
5589 * into a single statement.
5590 *
5591 * @see #putExtras
5592 * @see #removeExtra
5593 * @see #getStringArrayListExtra(String)
5594 */
5595 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5596 if (mExtras == null) {
5597 mExtras = new Bundle();
5598 }
5599 mExtras.putStringArrayList(name, value);
5600 return this;
5601 }
5602
5603 /**
5604 * Add extended data to the intent. The name must include a package
5605 * prefix, for example the app com.android.contacts would use names
5606 * like "com.android.contacts.ShowAll".
5607 *
5608 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005609 * @param value The ArrayList<CharSequence> data value.
5610 *
5611 * @return Returns the same Intent object, for chaining multiple calls
5612 * into a single statement.
5613 *
5614 * @see #putExtras
5615 * @see #removeExtra
5616 * @see #getCharSequenceArrayListExtra(String)
5617 */
5618 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5619 if (mExtras == null) {
5620 mExtras = new Bundle();
5621 }
5622 mExtras.putCharSequenceArrayList(name, value);
5623 return this;
5624 }
5625
5626 /**
5627 * Add extended data to the intent. The name must include a package
5628 * prefix, for example the app com.android.contacts would use names
5629 * like "com.android.contacts.ShowAll".
5630 *
5631 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005632 * @param value The Serializable data value.
5633 *
5634 * @return Returns the same Intent object, for chaining multiple calls
5635 * into a single statement.
5636 *
5637 * @see #putExtras
5638 * @see #removeExtra
5639 * @see #getSerializableExtra(String)
5640 */
5641 public Intent putExtra(String name, Serializable value) {
5642 if (mExtras == null) {
5643 mExtras = new Bundle();
5644 }
5645 mExtras.putSerializable(name, value);
5646 return this;
5647 }
5648
5649 /**
5650 * Add extended data to the intent. The name must include a package
5651 * prefix, for example the app com.android.contacts would use names
5652 * like "com.android.contacts.ShowAll".
5653 *
5654 * @param name The name of the extra data, with package prefix.
5655 * @param value The boolean array data value.
5656 *
5657 * @return Returns the same Intent object, for chaining multiple calls
5658 * into a single statement.
5659 *
5660 * @see #putExtras
5661 * @see #removeExtra
5662 * @see #getBooleanArrayExtra(String)
5663 */
5664 public Intent putExtra(String name, boolean[] value) {
5665 if (mExtras == null) {
5666 mExtras = new Bundle();
5667 }
5668 mExtras.putBooleanArray(name, value);
5669 return this;
5670 }
5671
5672 /**
5673 * Add extended data to the intent. The name must include a package
5674 * prefix, for example the app com.android.contacts would use names
5675 * like "com.android.contacts.ShowAll".
5676 *
5677 * @param name The name of the extra data, with package prefix.
5678 * @param value The byte array data value.
5679 *
5680 * @return Returns the same Intent object, for chaining multiple calls
5681 * into a single statement.
5682 *
5683 * @see #putExtras
5684 * @see #removeExtra
5685 * @see #getByteArrayExtra(String)
5686 */
5687 public Intent putExtra(String name, byte[] value) {
5688 if (mExtras == null) {
5689 mExtras = new Bundle();
5690 }
5691 mExtras.putByteArray(name, value);
5692 return this;
5693 }
5694
5695 /**
5696 * Add extended data to the intent. The name must include a package
5697 * prefix, for example the app com.android.contacts would use names
5698 * like "com.android.contacts.ShowAll".
5699 *
5700 * @param name The name of the extra data, with package prefix.
5701 * @param value The short array data value.
5702 *
5703 * @return Returns the same Intent object, for chaining multiple calls
5704 * into a single statement.
5705 *
5706 * @see #putExtras
5707 * @see #removeExtra
5708 * @see #getShortArrayExtra(String)
5709 */
5710 public Intent putExtra(String name, short[] value) {
5711 if (mExtras == null) {
5712 mExtras = new Bundle();
5713 }
5714 mExtras.putShortArray(name, value);
5715 return this;
5716 }
5717
5718 /**
5719 * Add extended data to the intent. The name must include a package
5720 * prefix, for example the app com.android.contacts would use names
5721 * like "com.android.contacts.ShowAll".
5722 *
5723 * @param name The name of the extra data, with package prefix.
5724 * @param value The char array data value.
5725 *
5726 * @return Returns the same Intent object, for chaining multiple calls
5727 * into a single statement.
5728 *
5729 * @see #putExtras
5730 * @see #removeExtra
5731 * @see #getCharArrayExtra(String)
5732 */
5733 public Intent putExtra(String name, char[] value) {
5734 if (mExtras == null) {
5735 mExtras = new Bundle();
5736 }
5737 mExtras.putCharArray(name, value);
5738 return this;
5739 }
5740
5741 /**
5742 * Add extended data to the intent. The name must include a package
5743 * prefix, for example the app com.android.contacts would use names
5744 * like "com.android.contacts.ShowAll".
5745 *
5746 * @param name The name of the extra data, with package prefix.
5747 * @param value The int array data value.
5748 *
5749 * @return Returns the same Intent object, for chaining multiple calls
5750 * into a single statement.
5751 *
5752 * @see #putExtras
5753 * @see #removeExtra
5754 * @see #getIntArrayExtra(String)
5755 */
5756 public Intent putExtra(String name, int[] value) {
5757 if (mExtras == null) {
5758 mExtras = new Bundle();
5759 }
5760 mExtras.putIntArray(name, value);
5761 return this;
5762 }
5763
5764 /**
5765 * Add extended data to the intent. The name must include a package
5766 * prefix, for example the app com.android.contacts would use names
5767 * like "com.android.contacts.ShowAll".
5768 *
5769 * @param name The name of the extra data, with package prefix.
5770 * @param value The byte array data value.
5771 *
5772 * @return Returns the same Intent object, for chaining multiple calls
5773 * into a single statement.
5774 *
5775 * @see #putExtras
5776 * @see #removeExtra
5777 * @see #getLongArrayExtra(String)
5778 */
5779 public Intent putExtra(String name, long[] value) {
5780 if (mExtras == null) {
5781 mExtras = new Bundle();
5782 }
5783 mExtras.putLongArray(name, value);
5784 return this;
5785 }
5786
5787 /**
5788 * Add extended data to the intent. The name must include a package
5789 * prefix, for example the app com.android.contacts would use names
5790 * like "com.android.contacts.ShowAll".
5791 *
5792 * @param name The name of the extra data, with package prefix.
5793 * @param value The float array data value.
5794 *
5795 * @return Returns the same Intent object, for chaining multiple calls
5796 * into a single statement.
5797 *
5798 * @see #putExtras
5799 * @see #removeExtra
5800 * @see #getFloatArrayExtra(String)
5801 */
5802 public Intent putExtra(String name, float[] value) {
5803 if (mExtras == null) {
5804 mExtras = new Bundle();
5805 }
5806 mExtras.putFloatArray(name, value);
5807 return this;
5808 }
5809
5810 /**
5811 * Add extended data to the intent. The name must include a package
5812 * prefix, for example the app com.android.contacts would use names
5813 * like "com.android.contacts.ShowAll".
5814 *
5815 * @param name The name of the extra data, with package prefix.
5816 * @param value The double array data value.
5817 *
5818 * @return Returns the same Intent object, for chaining multiple calls
5819 * into a single statement.
5820 *
5821 * @see #putExtras
5822 * @see #removeExtra
5823 * @see #getDoubleArrayExtra(String)
5824 */
5825 public Intent putExtra(String name, double[] value) {
5826 if (mExtras == null) {
5827 mExtras = new Bundle();
5828 }
5829 mExtras.putDoubleArray(name, value);
5830 return this;
5831 }
5832
5833 /**
5834 * Add extended data to the intent. The name must include a package
5835 * prefix, for example the app com.android.contacts would use names
5836 * like "com.android.contacts.ShowAll".
5837 *
5838 * @param name The name of the extra data, with package prefix.
5839 * @param value The String array data value.
5840 *
5841 * @return Returns the same Intent object, for chaining multiple calls
5842 * into a single statement.
5843 *
5844 * @see #putExtras
5845 * @see #removeExtra
5846 * @see #getStringArrayExtra(String)
5847 */
5848 public Intent putExtra(String name, String[] value) {
5849 if (mExtras == null) {
5850 mExtras = new Bundle();
5851 }
5852 mExtras.putStringArray(name, value);
5853 return this;
5854 }
5855
5856 /**
5857 * Add extended data to the intent. The name must include a package
5858 * prefix, for example the app com.android.contacts would use names
5859 * like "com.android.contacts.ShowAll".
5860 *
5861 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005862 * @param value The CharSequence array data value.
5863 *
5864 * @return Returns the same Intent object, for chaining multiple calls
5865 * into a single statement.
5866 *
5867 * @see #putExtras
5868 * @see #removeExtra
5869 * @see #getCharSequenceArrayExtra(String)
5870 */
5871 public Intent putExtra(String name, CharSequence[] value) {
5872 if (mExtras == null) {
5873 mExtras = new Bundle();
5874 }
5875 mExtras.putCharSequenceArray(name, value);
5876 return this;
5877 }
5878
5879 /**
5880 * Add extended data to the intent. The name must include a package
5881 * prefix, for example the app com.android.contacts would use names
5882 * like "com.android.contacts.ShowAll".
5883 *
5884 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005885 * @param value The Bundle data value.
5886 *
5887 * @return Returns the same Intent object, for chaining multiple calls
5888 * into a single statement.
5889 *
5890 * @see #putExtras
5891 * @see #removeExtra
5892 * @see #getBundleExtra(String)
5893 */
5894 public Intent putExtra(String name, Bundle value) {
5895 if (mExtras == null) {
5896 mExtras = new Bundle();
5897 }
5898 mExtras.putBundle(name, value);
5899 return this;
5900 }
5901
5902 /**
5903 * Add extended data to the intent. The name must include a package
5904 * prefix, for example the app com.android.contacts would use names
5905 * like "com.android.contacts.ShowAll".
5906 *
5907 * @param name The name of the extra data, with package prefix.
5908 * @param value The IBinder data value.
5909 *
5910 * @return Returns the same Intent object, for chaining multiple calls
5911 * into a single statement.
5912 *
5913 * @see #putExtras
5914 * @see #removeExtra
5915 * @see #getIBinderExtra(String)
5916 *
5917 * @deprecated
5918 * @hide
5919 */
5920 @Deprecated
5921 public Intent putExtra(String name, IBinder value) {
5922 if (mExtras == null) {
5923 mExtras = new Bundle();
5924 }
5925 mExtras.putIBinder(name, value);
5926 return this;
5927 }
5928
5929 /**
5930 * Copy all extras in 'src' in to this intent.
5931 *
5932 * @param src Contains the extras to copy.
5933 *
5934 * @see #putExtra
5935 */
5936 public Intent putExtras(Intent src) {
5937 if (src.mExtras != null) {
5938 if (mExtras == null) {
5939 mExtras = new Bundle(src.mExtras);
5940 } else {
5941 mExtras.putAll(src.mExtras);
5942 }
5943 }
5944 return this;
5945 }
5946
5947 /**
5948 * Add a set of extended data to the intent. The keys must include a package
5949 * prefix, for example the app com.android.contacts would use names
5950 * like "com.android.contacts.ShowAll".
5951 *
5952 * @param extras The Bundle of extras to add to this intent.
5953 *
5954 * @see #putExtra
5955 * @see #removeExtra
5956 */
5957 public Intent putExtras(Bundle extras) {
5958 if (mExtras == null) {
5959 mExtras = new Bundle();
5960 }
5961 mExtras.putAll(extras);
5962 return this;
5963 }
5964
5965 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005966 * Completely replace the extras in the Intent with the extras in the
5967 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005968 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005969 * @param src The exact extras contained in this Intent are copied
5970 * into the target intent, replacing any that were previously there.
5971 */
5972 public Intent replaceExtras(Intent src) {
5973 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5974 return this;
5975 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005976
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005977 /**
5978 * Completely replace the extras in the Intent with the given Bundle of
5979 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005980 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005981 * @param extras The new set of extras in the Intent, or null to erase
5982 * all extras.
5983 */
5984 public Intent replaceExtras(Bundle extras) {
5985 mExtras = extras != null ? new Bundle(extras) : null;
5986 return this;
5987 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005988
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005989 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005990 * Remove extended data from the intent.
5991 *
5992 * @see #putExtra
5993 */
5994 public void removeExtra(String name) {
5995 if (mExtras != null) {
5996 mExtras.remove(name);
5997 if (mExtras.size() == 0) {
5998 mExtras = null;
5999 }
6000 }
6001 }
6002
6003 /**
6004 * Set special flags controlling how this intent is handled. Most values
6005 * here depend on the type of component being executed by the Intent,
6006 * specifically the FLAG_ACTIVITY_* flags are all for use with
6007 * {@link Context#startActivity Context.startActivity()} and the
6008 * FLAG_RECEIVER_* flags are all for use with
6009 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6010 *
Scott Main7aee61f2011-02-08 11:25:01 -08006011 * <p>See the
6012 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6013 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006014 * the behavior of your application.
6015 *
6016 * @param flags The desired flags.
6017 *
6018 * @return Returns the same Intent object, for chaining multiple calls
6019 * into a single statement.
6020 *
6021 * @see #getFlags
6022 * @see #addFlags
6023 *
6024 * @see #FLAG_GRANT_READ_URI_PERMISSION
6025 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6026 * @see #FLAG_DEBUG_LOG_RESOLUTION
6027 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006028 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006029 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006030 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006031 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006032 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6033 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006034 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006035 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6036 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006037 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006038 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006039 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006040 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6041 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006042 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006043 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006044 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006045 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6046 */
6047 public Intent setFlags(int flags) {
6048 mFlags = flags;
6049 return this;
6050 }
6051
6052 /**
6053 * Add additional flags to the intent (or with existing flags
6054 * value).
6055 *
6056 * @param flags The new flags to set.
6057 *
6058 * @return Returns the same Intent object, for chaining multiple calls
6059 * into a single statement.
6060 *
6061 * @see #setFlags
6062 */
6063 public Intent addFlags(int flags) {
6064 mFlags |= flags;
6065 return this;
6066 }
6067
6068 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006069 * (Usually optional) Set an explicit application package name that limits
6070 * the components this Intent will resolve to. If left to the default
6071 * value of null, all components in all applications will considered.
6072 * If non-null, the Intent can only match the components in the given
6073 * application package.
6074 *
6075 * @param packageName The name of the application package to handle the
6076 * intent, or null to allow any application package.
6077 *
6078 * @return Returns the same Intent object, for chaining multiple calls
6079 * into a single statement.
6080 *
6081 * @see #getPackage
6082 * @see #resolveActivity
6083 */
6084 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006085 if (packageName != null && mSelector != null) {
6086 throw new IllegalArgumentException(
6087 "Can't set package name when selector is already set");
6088 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006089 mPackage = packageName;
6090 return this;
6091 }
6092
6093 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006094 * (Usually optional) Explicitly set the component to handle the intent.
6095 * If left with the default value of null, the system will determine the
6096 * appropriate class to use based on the other fields (action, data,
6097 * type, categories) in the Intent. If this class is defined, the
6098 * specified class will always be used regardless of the other fields. You
6099 * should only set this value when you know you absolutely want a specific
6100 * class to be used; otherwise it is better to let the system find the
6101 * appropriate class so that you will respect the installed applications
6102 * and user preferences.
6103 *
6104 * @param component The name of the application component to handle the
6105 * intent, or null to let the system find one for you.
6106 *
6107 * @return Returns the same Intent object, for chaining multiple calls
6108 * into a single statement.
6109 *
6110 * @see #setClass
6111 * @see #setClassName(Context, String)
6112 * @see #setClassName(String, String)
6113 * @see #getComponent
6114 * @see #resolveActivity
6115 */
6116 public Intent setComponent(ComponentName component) {
6117 mComponent = component;
6118 return this;
6119 }
6120
6121 /**
6122 * Convenience for calling {@link #setComponent} with an
6123 * explicit class name.
6124 *
6125 * @param packageContext A Context of the application package implementing
6126 * this class.
6127 * @param className The name of a class inside of the application package
6128 * that will be used as the component for this Intent.
6129 *
6130 * @return Returns the same Intent object, for chaining multiple calls
6131 * into a single statement.
6132 *
6133 * @see #setComponent
6134 * @see #setClass
6135 */
6136 public Intent setClassName(Context packageContext, String className) {
6137 mComponent = new ComponentName(packageContext, className);
6138 return this;
6139 }
6140
6141 /**
6142 * Convenience for calling {@link #setComponent} with an
6143 * explicit application package name and class name.
6144 *
6145 * @param packageName The name of the package implementing the desired
6146 * component.
6147 * @param className The name of a class inside of the application package
6148 * that will be used as the component for this Intent.
6149 *
6150 * @return Returns the same Intent object, for chaining multiple calls
6151 * into a single statement.
6152 *
6153 * @see #setComponent
6154 * @see #setClass
6155 */
6156 public Intent setClassName(String packageName, String className) {
6157 mComponent = new ComponentName(packageName, className);
6158 return this;
6159 }
6160
6161 /**
6162 * Convenience for calling {@link #setComponent(ComponentName)} with the
6163 * name returned by a {@link Class} object.
6164 *
6165 * @param packageContext A Context of the application package implementing
6166 * this class.
6167 * @param cls The class name to set, equivalent to
6168 * <code>setClassName(context, cls.getName())</code>.
6169 *
6170 * @return Returns the same Intent object, for chaining multiple calls
6171 * into a single statement.
6172 *
6173 * @see #setComponent
6174 */
6175 public Intent setClass(Context packageContext, Class<?> cls) {
6176 mComponent = new ComponentName(packageContext, cls);
6177 return this;
6178 }
6179
6180 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006181 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6182 * used as a hint to the receiver for animations and the like. Null means that there
6183 * is no source bounds.
6184 */
6185 public void setSourceBounds(Rect r) {
6186 if (r != null) {
6187 mSourceBounds = new Rect(r);
6188 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006189 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006190 }
6191 }
6192
6193 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006194 * Use with {@link #fillIn} to allow the current action value to be
6195 * overwritten, even if it is already set.
6196 */
6197 public static final int FILL_IN_ACTION = 1<<0;
6198
6199 /**
6200 * Use with {@link #fillIn} to allow the current data or type value
6201 * overwritten, even if it is already set.
6202 */
6203 public static final int FILL_IN_DATA = 1<<1;
6204
6205 /**
6206 * Use with {@link #fillIn} to allow the current categories to be
6207 * overwritten, even if they are already set.
6208 */
6209 public static final int FILL_IN_CATEGORIES = 1<<2;
6210
6211 /**
6212 * Use with {@link #fillIn} to allow the current component value to be
6213 * overwritten, even if it is already set.
6214 */
6215 public static final int FILL_IN_COMPONENT = 1<<3;
6216
6217 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006218 * Use with {@link #fillIn} to allow the current package value to be
6219 * overwritten, even if it is already set.
6220 */
6221 public static final int FILL_IN_PACKAGE = 1<<4;
6222
6223 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006224 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006225 * overwritten, even if it is already set.
6226 */
6227 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6228
6229 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006230 * Use with {@link #fillIn} to allow the current selector to be
6231 * overwritten, even if it is already set.
6232 */
6233 public static final int FILL_IN_SELECTOR = 1<<6;
6234
6235 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006236 * Use with {@link #fillIn} to allow the current ClipData to be
6237 * overwritten, even if it is already set.
6238 */
6239 public static final int FILL_IN_CLIP_DATA = 1<<7;
6240
6241 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006242 * Copy the contents of <var>other</var> in to this object, but only
6243 * where fields are not defined by this object. For purposes of a field
6244 * being defined, the following pieces of data in the Intent are
6245 * considered to be separate fields:
6246 *
6247 * <ul>
6248 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006249 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006250 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6251 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006252 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006253 * <li> component, as set by {@link #setComponent(ComponentName)} or
6254 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006255 * <li> source bounds, as set by {@link #setSourceBounds}.
6256 * <li> selector, as set by {@link #setSelector(Intent)}.
6257 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006258 * <li> each top-level name in the associated extras.
6259 * </ul>
6260 *
6261 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006262 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006263 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6264 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6265 * the restriction where the corresponding field will not be replaced if
6266 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006267 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006268 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6269 * is explicitly specified. The selector will only be copied if
6270 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006271 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006272 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6273 * and Intent B with {action="gotit", data-type="some/thing",
6274 * categories="one","two"}.
6275 *
6276 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6277 * containing: {action="gotit", data-type="some/thing",
6278 * categories="bar"}.
6279 *
6280 * @param other Another Intent whose values are to be used to fill in
6281 * the current one.
6282 * @param flags Options to control which fields can be filled in.
6283 *
6284 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006285 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006286 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6287 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006288 */
6289 public int fillIn(Intent other, int flags) {
6290 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006291 if (other.mAction != null
6292 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006293 mAction = other.mAction;
6294 changes |= FILL_IN_ACTION;
6295 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006296 if ((other.mData != null || other.mType != null)
6297 && ((mData == null && mType == null)
6298 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006299 mData = other.mData;
6300 mType = other.mType;
6301 changes |= FILL_IN_DATA;
6302 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006303 if (other.mCategories != null
6304 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006305 if (other.mCategories != null) {
6306 mCategories = new HashSet<String>(other.mCategories);
6307 }
6308 changes |= FILL_IN_CATEGORIES;
6309 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006310 if (other.mPackage != null
6311 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006312 // Only do this if mSelector is not set.
6313 if (mSelector == null) {
6314 mPackage = other.mPackage;
6315 changes |= FILL_IN_PACKAGE;
6316 }
6317 }
6318 // Selector is special: it can only be set if explicitly allowed,
6319 // for the same reason as the component name.
6320 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6321 if (mPackage == null) {
6322 mSelector = new Intent(other.mSelector);
6323 mPackage = null;
6324 changes |= FILL_IN_SELECTOR;
6325 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006326 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006327 if (other.mClipData != null
6328 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6329 mClipData = other.mClipData;
6330 changes |= FILL_IN_CLIP_DATA;
6331 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006332 // Component is special: it can -only- be set if explicitly allowed,
6333 // since otherwise the sender could force the intent somewhere the
6334 // originator didn't intend.
6335 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006336 mComponent = other.mComponent;
6337 changes |= FILL_IN_COMPONENT;
6338 }
6339 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006340 if (other.mSourceBounds != null
6341 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6342 mSourceBounds = new Rect(other.mSourceBounds);
6343 changes |= FILL_IN_SOURCE_BOUNDS;
6344 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006345 if (mExtras == null) {
6346 if (other.mExtras != null) {
6347 mExtras = new Bundle(other.mExtras);
6348 }
6349 } else if (other.mExtras != null) {
6350 try {
6351 Bundle newb = new Bundle(other.mExtras);
6352 newb.putAll(mExtras);
6353 mExtras = newb;
6354 } catch (RuntimeException e) {
6355 // Modifying the extras can cause us to unparcel the contents
6356 // of the bundle, and if we do this in the system process that
6357 // may fail. We really should handle this (i.e., the Bundle
6358 // impl shouldn't be on top of a plain map), but for now just
6359 // ignore it and keep the original contents. :(
6360 Log.w("Intent", "Failure filling in extras", e);
6361 }
6362 }
6363 return changes;
6364 }
6365
6366 /**
6367 * Wrapper class holding an Intent and implementing comparisons on it for
6368 * the purpose of filtering. The class implements its
6369 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6370 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6371 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6372 * on the wrapped Intent.
6373 */
6374 public static final class FilterComparison {
6375 private final Intent mIntent;
6376 private final int mHashCode;
6377
6378 public FilterComparison(Intent intent) {
6379 mIntent = intent;
6380 mHashCode = intent.filterHashCode();
6381 }
6382
6383 /**
6384 * Return the Intent that this FilterComparison represents.
6385 * @return Returns the Intent held by the FilterComparison. Do
6386 * not modify!
6387 */
6388 public Intent getIntent() {
6389 return mIntent;
6390 }
6391
6392 @Override
6393 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006394 if (obj instanceof FilterComparison) {
6395 Intent other = ((FilterComparison)obj).mIntent;
6396 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006397 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006398 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006399 }
6400
6401 @Override
6402 public int hashCode() {
6403 return mHashCode;
6404 }
6405 }
6406
6407 /**
6408 * Determine if two intents are the same for the purposes of intent
6409 * resolution (filtering). That is, if their action, data, type,
6410 * class, and categories are the same. This does <em>not</em> compare
6411 * any extra data included in the intents.
6412 *
6413 * @param other The other Intent to compare against.
6414 *
6415 * @return Returns true if action, data, type, class, and categories
6416 * are the same.
6417 */
6418 public boolean filterEquals(Intent other) {
6419 if (other == null) {
6420 return false;
6421 }
6422 if (mAction != other.mAction) {
6423 if (mAction != null) {
6424 if (!mAction.equals(other.mAction)) {
6425 return false;
6426 }
6427 } else {
6428 if (!other.mAction.equals(mAction)) {
6429 return false;
6430 }
6431 }
6432 }
6433 if (mData != other.mData) {
6434 if (mData != null) {
6435 if (!mData.equals(other.mData)) {
6436 return false;
6437 }
6438 } else {
6439 if (!other.mData.equals(mData)) {
6440 return false;
6441 }
6442 }
6443 }
6444 if (mType != other.mType) {
6445 if (mType != null) {
6446 if (!mType.equals(other.mType)) {
6447 return false;
6448 }
6449 } else {
6450 if (!other.mType.equals(mType)) {
6451 return false;
6452 }
6453 }
6454 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006455 if (mPackage != other.mPackage) {
6456 if (mPackage != null) {
6457 if (!mPackage.equals(other.mPackage)) {
6458 return false;
6459 }
6460 } else {
6461 if (!other.mPackage.equals(mPackage)) {
6462 return false;
6463 }
6464 }
6465 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006466 if (mComponent != other.mComponent) {
6467 if (mComponent != null) {
6468 if (!mComponent.equals(other.mComponent)) {
6469 return false;
6470 }
6471 } else {
6472 if (!other.mComponent.equals(mComponent)) {
6473 return false;
6474 }
6475 }
6476 }
6477 if (mCategories != other.mCategories) {
6478 if (mCategories != null) {
6479 if (!mCategories.equals(other.mCategories)) {
6480 return false;
6481 }
6482 } else {
6483 if (!other.mCategories.equals(mCategories)) {
6484 return false;
6485 }
6486 }
6487 }
6488
6489 return true;
6490 }
6491
6492 /**
6493 * Generate hash code that matches semantics of filterEquals().
6494 *
6495 * @return Returns the hash value of the action, data, type, class, and
6496 * categories.
6497 *
6498 * @see #filterEquals
6499 */
6500 public int filterHashCode() {
6501 int code = 0;
6502 if (mAction != null) {
6503 code += mAction.hashCode();
6504 }
6505 if (mData != null) {
6506 code += mData.hashCode();
6507 }
6508 if (mType != null) {
6509 code += mType.hashCode();
6510 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006511 if (mPackage != null) {
6512 code += mPackage.hashCode();
6513 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006514 if (mComponent != null) {
6515 code += mComponent.hashCode();
6516 }
6517 if (mCategories != null) {
6518 code += mCategories.hashCode();
6519 }
6520 return code;
6521 }
6522
6523 @Override
6524 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006525 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006526
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006527 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006528 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006529 b.append(" }");
6530
6531 return b.toString();
6532 }
6533
6534 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006535 public String toInsecureString() {
6536 StringBuilder b = new StringBuilder(128);
6537
6538 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006539 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006540 b.append(" }");
6541
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006542 return b.toString();
6543 }
Romain Guy4969af72009-06-17 10:53:19 -07006544
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006545 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006546 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006547 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006548
6549 b.append("Intent { ");
6550 toShortString(b, false, true, true, true);
6551 b.append(" }");
6552
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006553 return b.toString();
6554 }
6555
6556 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006557 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6558 StringBuilder b = new StringBuilder(128);
6559 toShortString(b, secure, comp, extras, clip);
6560 return b.toString();
6561 }
6562
6563 /** @hide */
6564 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6565 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006566 boolean first = true;
6567 if (mAction != null) {
6568 b.append("act=").append(mAction);
6569 first = false;
6570 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006571 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006572 if (!first) {
6573 b.append(' ');
6574 }
6575 first = false;
6576 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006577 Iterator<String> i = mCategories.iterator();
6578 boolean didone = false;
6579 while (i.hasNext()) {
6580 if (didone) b.append(",");
6581 didone = true;
6582 b.append(i.next());
6583 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006584 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006585 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006586 if (mData != null) {
6587 if (!first) {
6588 b.append(' ');
6589 }
6590 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006591 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006592 if (secure) {
6593 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006594 } else {
6595 b.append(mData);
6596 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006597 }
6598 if (mType != null) {
6599 if (!first) {
6600 b.append(' ');
6601 }
6602 first = false;
6603 b.append("typ=").append(mType);
6604 }
6605 if (mFlags != 0) {
6606 if (!first) {
6607 b.append(' ');
6608 }
6609 first = false;
6610 b.append("flg=0x").append(Integer.toHexString(mFlags));
6611 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006612 if (mPackage != null) {
6613 if (!first) {
6614 b.append(' ');
6615 }
6616 first = false;
6617 b.append("pkg=").append(mPackage);
6618 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006619 if (comp && mComponent != null) {
6620 if (!first) {
6621 b.append(' ');
6622 }
6623 first = false;
6624 b.append("cmp=").append(mComponent.flattenToShortString());
6625 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006626 if (mSourceBounds != null) {
6627 if (!first) {
6628 b.append(' ');
6629 }
6630 first = false;
6631 b.append("bnds=").append(mSourceBounds.toShortString());
6632 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006633 if (mClipData != null) {
6634 if (!first) {
6635 b.append(' ');
6636 }
6637 first = false;
6638 if (clip) {
6639 b.append("clip={");
6640 mClipData.toShortString(b);
6641 b.append('}');
6642 } else {
6643 b.append("(has clip)");
6644 }
6645 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006646 if (extras && mExtras != null) {
6647 if (!first) {
6648 b.append(' ');
6649 }
6650 first = false;
6651 b.append("(has extras)");
6652 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006653 if (mSelector != null) {
6654 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006655 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006656 b.append("}");
6657 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006658 }
6659
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006660 /**
6661 * Call {@link #toUri} with 0 flags.
6662 * @deprecated Use {@link #toUri} instead.
6663 */
6664 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006665 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006666 return toUri(0);
6667 }
6668
6669 /**
6670 * Convert this Intent into a String holding a URI representation of it.
6671 * The returned URI string has been properly URI encoded, so it can be
6672 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6673 * Intent's data as the base URI, with an additional fragment describing
6674 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006675 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006676 * <p>You can convert the returned string back to an Intent with
6677 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006678 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006679 * @param flags Additional operating flags. Either 0 or
6680 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006681 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006682 * @return Returns a URI encoding URI string describing the entire contents
6683 * of the Intent.
6684 */
6685 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006686 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006687 String scheme = null;
6688 if (mData != null) {
6689 String data = mData.toString();
6690 if ((flags&URI_INTENT_SCHEME) != 0) {
6691 final int N = data.length();
6692 for (int i=0; i<N; i++) {
6693 char c = data.charAt(i);
6694 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6695 || c == '.' || c == '-') {
6696 continue;
6697 }
6698 if (c == ':' && i > 0) {
6699 // Valid scheme.
6700 scheme = data.substring(0, i);
6701 uri.append("intent:");
6702 data = data.substring(i+1);
6703 break;
6704 }
Tom Taylord4a47292009-12-21 13:59:18 -08006705
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006706 // No scheme.
6707 break;
6708 }
6709 }
6710 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006711
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006712 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6713 uri.append("intent:");
6714 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006715
6716 uri.append("#Intent;");
6717
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006718 toUriInner(uri, scheme, flags);
6719 if (mSelector != null) {
6720 uri.append("SEL;");
6721 // Note that for now we are not going to try to handle the
6722 // data part; not clear how to represent this as a URI, and
6723 // not much utility in it.
6724 mSelector.toUriInner(uri, null, flags);
6725 }
6726
6727 uri.append("end");
6728
6729 return uri.toString();
6730 }
6731
6732 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006733 if (scheme != null) {
6734 uri.append("scheme=").append(scheme).append(';');
6735 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006736 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006737 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006738 }
6739 if (mCategories != null) {
6740 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006741 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006742 }
6743 }
6744 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006745 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006746 }
6747 if (mFlags != 0) {
6748 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6749 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006750 if (mPackage != null) {
6751 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6752 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006753 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006754 uri.append("component=").append(Uri.encode(
6755 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006756 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006757 if (mSourceBounds != null) {
6758 uri.append("sourceBounds=")
6759 .append(Uri.encode(mSourceBounds.flattenToString()))
6760 .append(';');
6761 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006762 if (mExtras != null) {
6763 for (String key : mExtras.keySet()) {
6764 final Object value = mExtras.get(key);
6765 char entryType =
6766 value instanceof String ? 'S' :
6767 value instanceof Boolean ? 'B' :
6768 value instanceof Byte ? 'b' :
6769 value instanceof Character ? 'c' :
6770 value instanceof Double ? 'd' :
6771 value instanceof Float ? 'f' :
6772 value instanceof Integer ? 'i' :
6773 value instanceof Long ? 'l' :
6774 value instanceof Short ? 's' :
6775 '\0';
6776
6777 if (entryType != '\0') {
6778 uri.append(entryType);
6779 uri.append('.');
6780 uri.append(Uri.encode(key));
6781 uri.append('=');
6782 uri.append(Uri.encode(value.toString()));
6783 uri.append(';');
6784 }
6785 }
6786 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006787 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006788
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006789 public int describeContents() {
6790 return (mExtras != null) ? mExtras.describeContents() : 0;
6791 }
6792
6793 public void writeToParcel(Parcel out, int flags) {
6794 out.writeString(mAction);
6795 Uri.writeToParcel(out, mData);
6796 out.writeString(mType);
6797 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006798 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006799 ComponentName.writeToParcel(mComponent, out);
6800
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006801 if (mSourceBounds != null) {
6802 out.writeInt(1);
6803 mSourceBounds.writeToParcel(out, flags);
6804 } else {
6805 out.writeInt(0);
6806 }
6807
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006808 if (mCategories != null) {
6809 out.writeInt(mCategories.size());
6810 for (String category : mCategories) {
6811 out.writeString(category);
6812 }
6813 } else {
6814 out.writeInt(0);
6815 }
6816
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006817 if (mSelector != null) {
6818 out.writeInt(1);
6819 mSelector.writeToParcel(out, flags);
6820 } else {
6821 out.writeInt(0);
6822 }
6823
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006824 if (mClipData != null) {
6825 out.writeInt(1);
6826 mClipData.writeToParcel(out, flags);
6827 } else {
6828 out.writeInt(0);
6829 }
6830
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006831 out.writeBundle(mExtras);
6832 }
6833
6834 public static final Parcelable.Creator<Intent> CREATOR
6835 = new Parcelable.Creator<Intent>() {
6836 public Intent createFromParcel(Parcel in) {
6837 return new Intent(in);
6838 }
6839 public Intent[] newArray(int size) {
6840 return new Intent[size];
6841 }
6842 };
6843
Dianne Hackborneb034652009-09-07 00:49:58 -07006844 /** @hide */
6845 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006846 readFromParcel(in);
6847 }
6848
6849 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006850 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006851 mData = Uri.CREATOR.createFromParcel(in);
6852 mType = in.readString();
6853 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006854 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006855 mComponent = ComponentName.readFromParcel(in);
6856
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006857 if (in.readInt() != 0) {
6858 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6859 }
6860
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006861 int N = in.readInt();
6862 if (N > 0) {
6863 mCategories = new HashSet<String>();
6864 int i;
6865 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006866 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006867 }
6868 } else {
6869 mCategories = null;
6870 }
6871
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006872 if (in.readInt() != 0) {
6873 mSelector = new Intent(in);
6874 }
6875
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006876 if (in.readInt() != 0) {
6877 mClipData = new ClipData(in);
6878 }
6879
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006880 mExtras = in.readBundle();
6881 }
6882
6883 /**
6884 * Parses the "intent" element (and its children) from XML and instantiates
6885 * an Intent object. The given XML parser should be located at the tag
6886 * where parsing should start (often named "intent"), from which the
6887 * basic action, data, type, and package and class name will be
6888 * retrieved. The function will then parse in to any child elements,
6889 * looking for <category android:name="xxx"> tags to add categories and
6890 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6891 * to the intent.
6892 *
6893 * @param resources The Resources to use when inflating resources.
6894 * @param parser The XML parser pointing at an "intent" tag.
6895 * @param attrs The AttributeSet interface for retrieving extended
6896 * attribute data at the current <var>parser</var> location.
6897 * @return An Intent object matching the XML data.
6898 * @throws XmlPullParserException If there was an XML parsing error.
6899 * @throws IOException If there was an I/O error.
6900 */
6901 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6902 throws XmlPullParserException, IOException {
6903 Intent intent = new Intent();
6904
6905 TypedArray sa = resources.obtainAttributes(attrs,
6906 com.android.internal.R.styleable.Intent);
6907
6908 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6909
6910 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6911 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6912 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6913
6914 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6915 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6916 if (packageName != null && className != null) {
6917 intent.setComponent(new ComponentName(packageName, className));
6918 }
6919
6920 sa.recycle();
6921
6922 int outerDepth = parser.getDepth();
6923 int type;
6924 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6925 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6926 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6927 continue;
6928 }
6929
6930 String nodeName = parser.getName();
6931 if (nodeName.equals("category")) {
6932 sa = resources.obtainAttributes(attrs,
6933 com.android.internal.R.styleable.IntentCategory);
6934 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6935 sa.recycle();
6936
6937 if (cat != null) {
6938 intent.addCategory(cat);
6939 }
6940 XmlUtils.skipCurrentTag(parser);
6941
6942 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006943 if (intent.mExtras == null) {
6944 intent.mExtras = new Bundle();
6945 }
6946 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6947 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006948
6949 } else {
6950 XmlUtils.skipCurrentTag(parser);
6951 }
6952 }
6953
6954 return intent;
6955 }
Nick Pellyccae4122012-01-09 14:12:58 -08006956
6957 /**
6958 * Normalize a MIME data type.
6959 *
6960 * <p>A normalized MIME type has white-space trimmed,
6961 * content-type parameters removed, and is lower-case.
6962 * This aligns the type with Android best practices for
6963 * intent filtering.
6964 *
6965 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6966 * "text/x-vCard" becomes "text/x-vcard".
6967 *
6968 * <p>All MIME types received from outside Android (such as user input,
6969 * or external sources like Bluetooth, NFC, or the Internet) should
6970 * be normalized before they are used to create an Intent.
6971 *
6972 * @param type MIME data type to normalize
6973 * @return normalized MIME data type, or null if the input was null
6974 * @see {@link #setType}
6975 * @see {@link #setTypeAndNormalize}
6976 */
6977 public static String normalizeMimeType(String type) {
6978 if (type == null) {
6979 return null;
6980 }
6981
6982 type = type.trim().toLowerCase(Locale.US);
6983
6984 final int semicolonIndex = type.indexOf(';');
6985 if (semicolonIndex != -1) {
6986 type = type.substring(0, semicolonIndex);
6987 }
6988 return type;
6989 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006990
6991 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07006992 * Prepare this {@link Intent} to leave an app process.
6993 *
6994 * @hide
6995 */
6996 public void prepareToLeaveProcess() {
6997 setAllowFds(false);
6998
6999 if (mSelector != null) {
7000 mSelector.prepareToLeaveProcess();
7001 }
7002 if (mClipData != null) {
7003 mClipData.prepareToLeaveProcess();
7004 }
7005
7006 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7007 // There are several ACTION_MEDIA_* broadcasts that send file://
7008 // Uris, so only check common actions.
7009 if (ACTION_VIEW.equals(mAction) ||
7010 ACTION_EDIT.equals(mAction) ||
7011 ACTION_ATTACH_DATA.equals(mAction)) {
7012 mData.checkFileUriExposed("Intent.getData()");
7013 }
7014 }
7015 }
7016
7017 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007018 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007019 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7020 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007021 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007022 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007023 * @hide
7024 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007025 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007026 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007027 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007028
7029 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007030 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007031
7032 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007033 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007034 try {
7035 // Inspect target intent to see if we need to migrate
7036 final Intent target = getParcelableExtra(EXTRA_INTENT);
7037 if (target != null && target.migrateExtraStreamToClipData()) {
7038 // Since we migrated in child, we need to promote ClipData
7039 // and flags to ourselves to grant.
7040 setClipData(target.getClipData());
7041 addFlags(target.getFlags()
7042 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
7043 return true;
7044 } else {
7045 return false;
7046 }
7047 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007048 }
7049
7050 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007051 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007052 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7053 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7054 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7055 if (stream != null || text != null || htmlText != null) {
7056 final ClipData clipData = new ClipData(
7057 null, new String[] { getType() },
7058 new ClipData.Item(text, htmlText, null, stream));
7059 setClipData(clipData);
7060 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007061 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007062 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007063 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007064 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007065
7066 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007067 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007068 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7069 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7070 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7071 int num = -1;
7072 if (streams != null) {
7073 num = streams.size();
7074 }
7075 if (texts != null) {
7076 if (num >= 0 && num != texts.size()) {
7077 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007078 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007079 }
7080 num = texts.size();
7081 }
7082 if (htmlTexts != null) {
7083 if (num >= 0 && num != htmlTexts.size()) {
7084 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007085 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007086 }
7087 num = htmlTexts.size();
7088 }
7089 if (num > 0) {
7090 final ClipData clipData = new ClipData(
7091 null, new String[] { getType() },
7092 makeClipItem(streams, texts, htmlTexts, 0));
7093
7094 for (int i = 1; i < num; i++) {
7095 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7096 }
7097
7098 setClipData(clipData);
7099 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007100 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007101 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007102 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007103 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007104 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007105
7106 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007107 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007108
7109 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7110 ArrayList<String> htmlTexts, int which) {
7111 Uri uri = streams != null ? streams.get(which) : null;
7112 CharSequence text = texts != null ? texts.get(which) : null;
7113 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7114 return new ClipData.Item(text, htmlText, null, uri);
7115 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007116}