blob: da09a18e9b32b2fc26f718b916c08479a3848066 [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;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
573 * <li> {@link #EXTRA_PHONE_NUMBER}
574 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
575 * <li> {@link #EXTRA_REPLACING}
576 * <li> {@link #EXTRA_SHORTCUT_ICON}
577 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
578 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700579 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800580 * <li> {@link #EXTRA_SHORTCUT_NAME}
581 * <li> {@link #EXTRA_SUBJECT}
582 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700583 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800584 * <li> {@link #EXTRA_TITLE}
585 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 * </ul>
587 *
588 * <h3>Flags</h3>
589 *
590 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800591 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
592 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700593 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800594public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 // ---------------------------------------------------------------------
596 // ---------------------------------------------------------------------
597 // Standard intent activity actions (see action variable).
598
599 /**
600 * Activity Action: Start as a main entry point, does not expect to
601 * receive data.
602 * <p>Input: nothing
603 * <p>Output: nothing
604 */
605 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
606 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800607
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700608 /**
609 * Activity Action: Display the data to the user. This is the most common
610 * action performed on data -- it is the generic action you can use on
611 * a piece of data to get the most reasonable thing to occur. For example,
612 * when used on a contacts entry it will view the entry; when used on a
613 * mailto: URI it will bring up a compose window filled with the information
614 * supplied by the URI; when used with a tel: URI it will invoke the
615 * dialer.
616 * <p>Input: {@link #getData} is URI from which to retrieve data.
617 * <p>Output: nothing.
618 */
619 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
620 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800621
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700622 /**
623 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
624 * performed on a piece of data.
625 */
626 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800627
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700628 /**
629 * Used to indicate that some piece of data should be attached to some other
630 * place. For example, image data could be attached to a contact. It is up
631 * to the recipient to decide where the data should be attached; the intent
632 * does not specify the ultimate destination.
633 * <p>Input: {@link #getData} is URI of data to be attached.
634 * <p>Output: nothing.
635 */
636 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
637 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700639 /**
640 * Activity Action: Provide explicit editable access to the given data.
641 * <p>Input: {@link #getData} is URI of data to be edited.
642 * <p>Output: nothing.
643 */
644 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
645 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700647 /**
648 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
649 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
650 * The extras can contain type specific data to pass through to the editing/creating
651 * activity.
652 * <p>Output: The URI of the item that was picked. This must be a content:
653 * URI so that any receiver can access it.
654 */
655 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
656 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Activity Action: Pick an item from the data, returning what was selected.
660 * <p>Input: {@link #getData} is URI containing a directory of data
661 * (vnd.android.cursor.dir/*) from which to pick an item.
662 * <p>Output: The URI of the item that was picked.
663 */
664 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
665 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700667 /**
668 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800669 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 * <p>Output: An Intent representing the shortcut. The intent must contain three
671 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
672 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800673 * (value: ShortcutIconResource).</p>
674 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700675 * @see #EXTRA_SHORTCUT_INTENT
676 * @see #EXTRA_SHORTCUT_NAME
677 * @see #EXTRA_SHORTCUT_ICON
678 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
679 * @see android.content.Intent.ShortcutIconResource
680 */
681 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
682 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
683
684 /**
685 * The name of the extra used to define the Intent of a shortcut.
686 *
687 * @see #ACTION_CREATE_SHORTCUT
688 */
689 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
690 /**
691 * The name of the extra used to define the name of a shortcut.
692 *
693 * @see #ACTION_CREATE_SHORTCUT
694 */
695 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
696 /**
697 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
698 *
699 * @see #ACTION_CREATE_SHORTCUT
700 */
701 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
702 /**
703 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
704 *
705 * @see #ACTION_CREATE_SHORTCUT
706 * @see android.content.Intent.ShortcutIconResource
707 */
708 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
709 "android.intent.extra.shortcut.ICON_RESOURCE";
710
711 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800712 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700713 *
714 * @see Intent#ACTION_CREATE_SHORTCUT
715 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800716 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
717 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 */
719 public static class ShortcutIconResource implements Parcelable {
720 /**
721 * The package name of the application containing the icon.
722 */
723 public String packageName;
724
725 /**
726 * The resource name of the icon, including package, name and type.
727 */
728 public String resourceName;
729
730 /**
731 * Creates a new ShortcutIconResource for the specified context and resource
732 * identifier.
733 *
734 * @param context The context of the application.
735 * @param resourceId The resource idenfitier for the icon.
736 * @return A new ShortcutIconResource with the specified's context package name
737 * and icon resource idenfitier.
738 */
739 public static ShortcutIconResource fromContext(Context context, int resourceId) {
740 ShortcutIconResource icon = new ShortcutIconResource();
741 icon.packageName = context.getPackageName();
742 icon.resourceName = context.getResources().getResourceName(resourceId);
743 return icon;
744 }
745
746 /**
747 * Used to read a ShortcutIconResource from a Parcel.
748 */
749 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
750 new Parcelable.Creator<ShortcutIconResource>() {
751
752 public ShortcutIconResource createFromParcel(Parcel source) {
753 ShortcutIconResource icon = new ShortcutIconResource();
754 icon.packageName = source.readString();
755 icon.resourceName = source.readString();
756 return icon;
757 }
758
759 public ShortcutIconResource[] newArray(int size) {
760 return new ShortcutIconResource[size];
761 }
762 };
763
764 /**
765 * No special parcel contents.
766 */
767 public int describeContents() {
768 return 0;
769 }
770
771 public void writeToParcel(Parcel dest, int flags) {
772 dest.writeString(packageName);
773 dest.writeString(resourceName);
774 }
775
776 @Override
777 public String toString() {
778 return resourceName;
779 }
780 }
781
782 /**
783 * Activity Action: Display an activity chooser, allowing the user to pick
784 * what they want to before proceeding. This can be used as an alternative
785 * to the standard activity picker that is displayed by the system when
786 * you try to start an activity with multiple possible matches, with these
787 * differences in behavior:
788 * <ul>
789 * <li>You can specify the title that will appear in the activity chooser.
790 * <li>The user does not have the option to make one of the matching
791 * activities a preferred activity, and all possible activities will
792 * always be shown even if one of them is currently marked as the
793 * preferred activity.
794 * </ul>
795 * <p>
796 * This action should be used when the user will naturally expect to
797 * select an activity in order to proceed. An example if when not to use
798 * it is when the user clicks on a "mailto:" link. They would naturally
799 * expect to go directly to their mail app, so startActivity() should be
800 * called directly: it will
801 * either launch the current preferred app, or put up a dialog allowing the
802 * user to pick an app to use and optionally marking that as preferred.
803 * <p>
804 * In contrast, if the user is selecting a menu item to send a picture
805 * they are viewing to someone else, there are many different things they
806 * may want to do at this point: send it through e-mail, upload it to a
807 * web service, etc. In this case the CHOOSER action should be used, to
808 * always present to the user a list of the things they can do, with a
809 * nice title given by the caller such as "Send this photo with:".
810 * <p>
811 * As a convenience, an Intent of this form can be created with the
812 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700813 * <p>
814 * If the target {@link #EXTRA_INTENT} contains {@link ClipData}, you should
815 * also copy it to this intent along with relevant flags, such as
816 * {@link #FLAG_GRANT_READ_URI_PERMISSION}.
817 * <p>
818 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700819 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
820 * and can optionally have a {@link #EXTRA_TITLE} field containing the
821 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700822 * <p>
823 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 */
825 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
826 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
827
828 /**
829 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
830 *
831 * @param target The Intent that the user will be selecting an activity
832 * to perform.
833 * @param title Optional title that will be displayed in the chooser.
834 * @return Return a new Intent object that you can hand to
835 * {@link Context#startActivity(Intent) Context.startActivity()} and
836 * related methods.
837 */
838 public static Intent createChooser(Intent target, CharSequence title) {
839 Intent intent = new Intent(ACTION_CHOOSER);
840 intent.putExtra(EXTRA_INTENT, target);
841 if (title != null) {
842 intent.putExtra(EXTRA_TITLE, title);
843 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700844
845 // Migrate any clip data and flags from target.
846 final ClipData targetClipData = target.getClipData();
847 if (targetClipData != null) {
848 intent.setClipData(targetClipData);
849 intent.addFlags(target.getFlags()
850 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
851 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700852 return intent;
853 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700854
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700855 /**
856 * Activity Action: Allow the user to select a particular kind of data and
857 * return it. This is different than {@link #ACTION_PICK} in that here we
858 * just say what kind of data is desired, not a URI of existing data from
859 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
860 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900861 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700862 * etc.
863 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900864 * 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 -0700865 * of data, such as a person contact, you set the MIME type to the kind of
866 * data you want and launch it with {@link Context#startActivity(Intent)}.
867 * The system will then launch the best application to select that kind
868 * of data for you.
869 * <p>
870 * You may also be interested in any of a set of types of content the user
871 * can pick. For example, an e-mail application that wants to allow the
872 * user to add an attachment to an e-mail message can use this action to
873 * bring up a list of all of the types of content the user can attach.
874 * <p>
875 * In this case, you should wrap the GET_CONTENT intent with a chooser
876 * (through {@link #createChooser}), which will give the proper interface
877 * for the user to pick how to send your data and allow you to specify
878 * a prompt indicating what they are doing. You will usually specify a
879 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
880 * broad range of content types the user can select from.
881 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900882 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 * only pick from data that can be represented as a stream. This is
884 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
885 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800886 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900887 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800888 * is locally available on the device. For example, if this extra is set
889 * to true then an image picker should not show any pictures that are available
890 * from a remote server but not already on the local device (thus requiring
891 * they be downloaded when opened).
892 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700893 * Input: {@link #getType} is the desired MIME type to retrieve. Note
894 * that no URI is supplied in the intent, as there are no constraints on
895 * where the returned data originally comes from. You may also include the
896 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800897 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
898 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700899 * <p>
900 * Output: The URI of the item that was picked. This must be a content:
901 * URI so that any receiver can access it.
902 */
903 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
904 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
905 /**
906 * Activity Action: Dial a number as specified by the data. This shows a
907 * UI with the number being dialed, allowing the user to explicitly
908 * initiate the call.
909 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
910 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
911 * number.
912 * <p>Output: nothing.
913 */
914 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
915 public static final String ACTION_DIAL = "android.intent.action.DIAL";
916 /**
917 * Activity Action: Perform a call to someone specified by the data.
918 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
919 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
920 * number.
921 * <p>Output: nothing.
922 *
923 * <p>Note: there will be restrictions on which applications can initiate a
924 * call; most applications should use the {@link #ACTION_DIAL}.
925 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
926 * numbers. Applications can <strong>dial</strong> emergency numbers using
927 * {@link #ACTION_DIAL}, however.
928 */
929 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
930 public static final String ACTION_CALL = "android.intent.action.CALL";
931 /**
932 * Activity Action: Perform a call to an emergency number specified by the
933 * data.
934 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
935 * tel: URI of an explicit phone number.
936 * <p>Output: nothing.
937 * @hide
938 */
939 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
940 /**
941 * Activity action: Perform a call to any number (emergency or not)
942 * specified by the data.
943 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
944 * tel: URI of an explicit phone number.
945 * <p>Output: nothing.
946 * @hide
947 */
948 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
949 /**
950 * Activity Action: Send a message to someone specified by the data.
951 * <p>Input: {@link #getData} is URI describing the target.
952 * <p>Output: nothing.
953 */
954 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
955 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
956 /**
957 * Activity Action: Deliver some data to someone else. Who the data is
958 * being delivered to is not specified; it is up to the receiver of this
959 * action to ask the user where the data should be sent.
960 * <p>
961 * When launching a SEND intent, you should usually wrap it in a chooser
962 * (through {@link #createChooser}), which will give the proper interface
963 * for the user to pick how to send your data and allow you to specify
964 * a prompt indicating what they are doing.
965 * <p>
966 * Input: {@link #getType} is the MIME type of the data being sent.
967 * get*Extra can have either a {@link #EXTRA_TEXT}
968 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
969 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
970 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
971 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700972 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
973 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
974 * your text with HTML formatting.
975 * <p>
976 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
977 * being sent can be supplied through {@link #setClipData(ClipData)}. This
978 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
979 * content: URIs and other advanced features of {@link ClipData}. If
980 * using this approach, you still must supply the same data through the
981 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
982 * for compatibility with old applications. If you don't set a ClipData,
983 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700984 * <p>
985 * Optional standard extras, which may be interpreted by some recipients as
986 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
987 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
988 * <p>
989 * Output: nothing.
990 */
991 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
992 public static final String ACTION_SEND = "android.intent.action.SEND";
993 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800994 * Activity Action: Deliver multiple data to someone else.
995 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700996 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800997 * <p>
998 * Input: {@link #getType} is the MIME type of the data being sent.
999 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001000 * #EXTRA_STREAM} field, containing the data to be sent. If using
1001 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1002 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001003 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001004 * Multiple types are supported, and receivers should handle mixed types
1005 * whenever possible. The right way for the receiver to check them is to
1006 * use the content resolver on each URI. The intent sender should try to
1007 * put the most concrete mime type in the intent type, but it can fall
1008 * back to {@literal <type>/*} or {@literal *}/* as needed.
1009 * <p>
1010 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1011 * be image/jpg, but if you are sending image/jpg and image/png, then the
1012 * intent's type should be image/*.
1013 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001014 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1015 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1016 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1017 * content: URIs and other advanced features of {@link ClipData}. If
1018 * using this approach, you still must supply the same data through the
1019 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1020 * for compatibility with old applications. If you don't set a ClipData,
1021 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1022 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001023 * Optional standard extras, which may be interpreted by some recipients as
1024 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1025 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1026 * <p>
1027 * Output: nothing.
1028 */
1029 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1030 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1031 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001032 * Activity Action: Handle an incoming phone call.
1033 * <p>Input: nothing.
1034 * <p>Output: nothing.
1035 */
1036 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1037 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1038 /**
1039 * Activity Action: Insert an empty item into the given container.
1040 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1041 * in which to place the data.
1042 * <p>Output: URI of the new data that was created.
1043 */
1044 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1045 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1046 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001047 * Activity Action: Create a new item in the given container, initializing it
1048 * from the current contents of the clipboard.
1049 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1050 * in which to place the data.
1051 * <p>Output: URI of the new data that was created.
1052 */
1053 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1054 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1055 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001056 * Activity Action: Delete the given data from its container.
1057 * <p>Input: {@link #getData} is URI of data to be deleted.
1058 * <p>Output: nothing.
1059 */
1060 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1061 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1062 /**
1063 * Activity Action: Run the data, whatever that means.
1064 * <p>Input: ? (Note: this is currently specific to the test harness.)
1065 * <p>Output: nothing.
1066 */
1067 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1068 public static final String ACTION_RUN = "android.intent.action.RUN";
1069 /**
1070 * Activity Action: Perform a data synchronization.
1071 * <p>Input: ?
1072 * <p>Output: ?
1073 */
1074 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1075 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1076 /**
1077 * Activity Action: Pick an activity given an intent, returning the class
1078 * selected.
1079 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1080 * used with {@link PackageManager#queryIntentActivities} to determine the
1081 * set of activities from which to pick.
1082 * <p>Output: Class name of the activity that was selected.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1086 /**
1087 * Activity Action: Perform a search.
1088 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1089 * is the text to search for. If empty, simply
1090 * enter your search results Activity with the search UI activated.
1091 * <p>Output: nothing.
1092 */
1093 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1094 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1095 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001096 * Activity Action: Start the platform-defined tutorial
1097 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1098 * is the text to search for. If empty, simply
1099 * enter your search results Activity with the search UI activated.
1100 * <p>Output: nothing.
1101 */
1102 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1103 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1104 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001105 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001106 * <p>
1107 * Input: {@link android.app.SearchManager#QUERY
1108 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1109 * a url starts with http or https, the site will be opened. If it is plain
1110 * text, Google search will be applied.
1111 * <p>
1112 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001113 */
1114 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1115 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1116 /**
Jim Miller07994402012-05-02 14:22:27 -07001117 * Activity Action: Perform assist action.
1118 * <p>
1119 * Input: nothing
1120 * Output: nothing.
1121 */
1122 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1123 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
1124 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001125 * Activity Action: List all available applications
1126 * <p>Input: Nothing.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1131 /**
1132 * Activity Action: Show settings for choosing wallpaper
1133 * <p>Input: Nothing.
1134 * <p>Output: Nothing.
1135 */
1136 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1137 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1138
1139 /**
1140 * Activity Action: Show activity for reporting a bug.
1141 * <p>Input: Nothing.
1142 * <p>Output: Nothing.
1143 */
1144 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1145 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1146
1147 /**
1148 * Activity Action: Main entry point for factory tests. Only used when
1149 * the device is booting in factory test node. The implementing package
1150 * must be installed in the system image.
1151 * <p>Input: nothing
1152 * <p>Output: nothing
1153 */
1154 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1155
1156 /**
1157 * Activity Action: The user pressed the "call" button to go to the dialer
1158 * or other appropriate UI for placing a call.
1159 * <p>Input: Nothing.
1160 * <p>Output: Nothing.
1161 */
1162 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1163 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1164
1165 /**
1166 * Activity Action: Start Voice Command.
1167 * <p>Input: Nothing.
1168 * <p>Output: Nothing.
1169 */
1170 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1171 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001172
1173 /**
1174 * Activity Action: Start action associated with long pressing on the
1175 * search key.
1176 * <p>Input: Nothing.
1177 * <p>Output: Nothing.
1178 */
1179 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1180 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001181
Jacek Surazski86b6c532009-05-13 14:38:28 +02001182 /**
1183 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1184 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001185 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001186 * <p>Input: No data is specified. The bug report is passed in using
1187 * an {@link #EXTRA_BUG_REPORT} field.
1188 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001189 *
1190 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001191 */
1192 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1193 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001194
1195 /**
1196 * Activity Action: Show power usage information to the user.
1197 * <p>Input: Nothing.
1198 * <p>Output: Nothing.
1199 */
1200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1201 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001202
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001203 /**
1204 * Activity Action: Setup wizard to launch after a platform update. This
1205 * activity should have a string meta-data field associated with it,
1206 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1207 * the platform for setup. The activity will be launched only if
1208 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1209 * same value.
1210 * <p>Input: Nothing.
1211 * <p>Output: Nothing.
1212 * @hide
1213 */
1214 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1215 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001216
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001217 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001218 * Activity Action: Show settings for managing network data usage of a
1219 * specific application. Applications should define an activity that offers
1220 * options to control data usage.
1221 */
1222 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1223 public static final String ACTION_MANAGE_NETWORK_USAGE =
1224 "android.intent.action.MANAGE_NETWORK_USAGE";
1225
1226 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001227 * Activity Action: Launch application installer.
1228 * <p>
1229 * Input: The data must be a content: or file: URI at which the application
1230 * can be retrieved. You can optionally supply
1231 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1232 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1233 * <p>
1234 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1235 * succeeded.
1236 *
1237 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1238 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1239 * @see #EXTRA_RETURN_RESULT
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1243
1244 /**
1245 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1246 * package. Specifies the installer package name; this package will receive the
1247 * {@link #ACTION_APP_ERROR} intent.
1248 */
1249 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1250 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1251
1252 /**
1253 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1254 * package. Specifies that the application being installed should not be
1255 * treated as coming from an unknown source, but as coming from the app
1256 * invoking the Intent. For this to work you must start the installer with
1257 * startActivityForResult().
1258 */
1259 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1260 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1261
1262 /**
1263 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1264 * package. Tells the installer UI to skip the confirmation with the user
1265 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001266 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1267 * will no longer show an interstitial message about updating existing
1268 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001269 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001270 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001271 public static final String EXTRA_ALLOW_REPLACE
1272 = "android.intent.extra.ALLOW_REPLACE";
1273
1274 /**
1275 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1276 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1277 * return to the application the result code of the install/uninstall. The returned result
1278 * code will be {@link android.app.Activity#RESULT_OK} on success or
1279 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1280 */
1281 public static final String EXTRA_RETURN_RESULT
1282 = "android.intent.extra.RETURN_RESULT";
1283
1284 /**
1285 * Package manager install result code. @hide because result codes are not
1286 * yet ready to be exposed.
1287 */
1288 public static final String EXTRA_INSTALL_RESULT
1289 = "android.intent.extra.INSTALL_RESULT";
1290
1291 /**
1292 * Activity Action: Launch application uninstaller.
1293 * <p>
1294 * Input: The data must be a package: URI whose scheme specific part is
1295 * the package name of the current installed package to be uninstalled.
1296 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1297 * <p>
1298 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1299 * succeeded.
1300 */
1301 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1302 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1303
1304 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001305 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1306 * describing the last run version of the platform that was setup.
1307 * @hide
1308 */
1309 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1310
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001311 // ---------------------------------------------------------------------
1312 // ---------------------------------------------------------------------
1313 // Standard intent broadcast actions (see action variable).
1314
1315 /**
1316 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001317 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001318 * <p class="note">This is a protected intent that can only be sent
1319 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001320 */
1321 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1322 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1323 /**
1324 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001325 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001326 * <p class="note">This is a protected intent that can only be sent
1327 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001328 */
1329 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1330 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001331
1332 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001333 * 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 -07001334 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001335 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001336 * <p class="note">This is a protected intent that can only be sent
1337 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001338 */
1339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001340 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001341
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001342 /**
1343 * Broadcast Action: The current time has changed. Sent every
1344 * minute. You can <em>not</em> receive this through components declared
1345 * in manifests, only by exlicitly registering for it with
1346 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1347 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001348 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001349 * <p class="note">This is a protected intent that can only be sent
1350 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001351 */
1352 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1353 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1354 /**
1355 * Broadcast Action: The time was set.
1356 */
1357 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1358 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1359 /**
1360 * Broadcast Action: The date has changed.
1361 */
1362 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1363 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1364 /**
1365 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1366 * <ul>
1367 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1368 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001369 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001370 * <p class="note">This is a protected intent that can only be sent
1371 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001372 */
1373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1374 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1375 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001376 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1377 * DNS entries should be tossed.
1378 * @hide
1379 */
1380 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1381 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1382 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001383 * Alarm Changed Action: This is broadcast when the AlarmClock
1384 * application's alarm is set or unset. It is used by the
1385 * AlarmClock application and the StatusBar service.
1386 * @hide
1387 */
1388 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1389 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1390 /**
1391 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1392 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1393 * @hide
1394 */
1395 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1396 public static final String ACTION_SYNC_STATE_CHANGED
1397 = "android.intent.action.SYNC_STATE_CHANGED";
1398 /**
1399 * Broadcast Action: This is broadcast once, after the system has finished
1400 * booting. It can be used to perform application-specific initialization,
1401 * such as installing alarms. You must hold the
1402 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1403 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001404 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001405 * <p class="note">This is a protected intent that can only be sent
1406 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001407 */
1408 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1409 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1410 /**
1411 * Broadcast Action: This is broadcast when a user action should request a
1412 * temporary system dialog to dismiss. Some examples of temporary system
1413 * dialogs are the notification window-shade and the recent tasks dialog.
1414 */
1415 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1416 /**
1417 * Broadcast Action: Trigger the download and eventual installation
1418 * of a package.
1419 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001420 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001421 * <p class="note">This is a protected intent that can only be sent
1422 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001423 *
1424 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001425 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001426 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1428 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1429 /**
1430 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001431 * device. The data contains the name of the package. Note that the
1432 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001433 * <p>My include the following extras:
1434 * <ul>
1435 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1436 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1437 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1438 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001439 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001440 * <p class="note">This is a protected intent that can only be sent
1441 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001442 */
1443 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1444 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1445 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001446 * Broadcast Action: A new version of an application package has been
1447 * installed, replacing an existing version that was previously installed.
1448 * The data contains the name of the package.
1449 * <p>My include the following extras:
1450 * <ul>
1451 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1452 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001453 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001454 * <p class="note">This is a protected intent that can only be sent
1455 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001456 */
1457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1458 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1459 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001460 * Broadcast Action: A new version of your application has been installed
1461 * over an existing one. This is only sent to the application that was
1462 * replaced. It does not contain any additional data; to receive it, just
1463 * use an intent filter for this action.
1464 *
1465 * <p class="note">This is a protected intent that can only be sent
1466 * by the system.
1467 */
1468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1469 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1470 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001471 * Broadcast Action: An existing application package has been removed from
1472 * the device. The data contains the name of the package. The package
1473 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001474 * <ul>
1475 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1476 * to the package.
1477 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1478 * application -- data and code -- is being removed.
1479 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1480 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1481 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001482 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001483 * <p class="note">This is a protected intent that can only be sent
1484 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001485 */
1486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1487 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1488 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001489 * Broadcast Action: An existing application package has been completely
1490 * removed from the device. The data contains the name of the package.
1491 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1492 * {@link #EXTRA_DATA_REMOVED} is true and
1493 * {@link #EXTRA_REPLACING} is false of that broadcast.
1494 *
1495 * <ul>
1496 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1497 * to the package.
1498 * </ul>
1499 *
1500 * <p class="note">This is a protected intent that can only be sent
1501 * by the system.
1502 */
1503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504 public static final String ACTION_PACKAGE_FULLY_REMOVED
1505 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1506 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001507 * Broadcast Action: An existing application package has been changed (e.g.
1508 * a component has been enabled or disabled). The data contains the name of
1509 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001510 * <ul>
1511 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001512 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1513 * of the changed components.
1514 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1515 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001516 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001517 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001518 * <p class="note">This is a protected intent that can only be sent
1519 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001520 */
1521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1522 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1523 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001524 * @hide
1525 * Broadcast Action: Ask system services if there is any reason to
1526 * restart the given package. The data contains the name of the
1527 * package.
1528 * <ul>
1529 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1530 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1531 * </ul>
1532 *
1533 * <p class="note">This is a protected intent that can only be sent
1534 * by the system.
1535 */
1536 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1537 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1538 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001539 * Broadcast Action: The user has restarted a package, and all of its
1540 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001541 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001542 * be removed. Note that the restarted package does <em>not</em>
1543 * receive this broadcast.
1544 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001545 * <ul>
1546 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1547 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001548 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001549 * <p class="note">This is a protected intent that can only be sent
1550 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001551 */
1552 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1553 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1554 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001555 * Broadcast Action: The user has cleared the data of a package. This should
1556 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001557 * its persistent data is erased and this broadcast sent.
1558 * Note that the cleared package does <em>not</em>
1559 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001560 * <ul>
1561 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1562 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001563 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001564 * <p class="note">This is a protected intent that can only be sent
1565 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001566 */
1567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1568 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1569 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001570 * Broadcast Action: A user ID has been removed from the system. The user
1571 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001572 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001573 * <p class="note">This is a protected intent that can only be sent
1574 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001575 */
1576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1577 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001578
1579 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001580 * Broadcast Action: Sent to the installer package of an application
1581 * when that application is first launched (that is the first time it
1582 * is moved out of the stopped state). The data contains the name of the package.
1583 *
1584 * <p class="note">This is a protected intent that can only be sent
1585 * by the system.
1586 */
1587 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1588 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1589
1590 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001591 * Broadcast Action: Sent to the system package verifier when a package
1592 * needs to be verified. The data contains the package URI.
1593 * <p class="note">
1594 * This is a protected intent that can only be sent by the system.
1595 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001596 */
1597 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1598 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1599
1600 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001601 * Broadcast Action: Resources for a set of packages (which were
1602 * previously unavailable) are currently
1603 * available since the media on which they exist is available.
1604 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1605 * list of packages whose availability changed.
1606 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1607 * list of uids of packages whose availability changed.
1608 * Note that the
1609 * packages in this list do <em>not</em> receive this broadcast.
1610 * The specified set of packages are now available on the system.
1611 * <p>Includes the following extras:
1612 * <ul>
1613 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1614 * whose resources(were previously unavailable) are currently available.
1615 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1616 * packages whose resources(were previously unavailable)
1617 * are currently available.
1618 * </ul>
1619 *
1620 * <p class="note">This is a protected intent that can only be sent
1621 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001622 */
1623 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001624 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1625 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001626
1627 /**
1628 * Broadcast Action: Resources for a set of packages are currently
1629 * unavailable since the media on which they exist is unavailable.
1630 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1631 * list of packages whose availability changed.
1632 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1633 * list of uids of packages whose availability changed.
1634 * The specified set of packages can no longer be
1635 * launched and are practically unavailable on the system.
1636 * <p>Inclues the following extras:
1637 * <ul>
1638 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1639 * whose resources are no longer available.
1640 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1641 * whose resources are no longer available.
1642 * </ul>
1643 *
1644 * <p class="note">This is a protected intent that can only be sent
1645 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001646 */
1647 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001648 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001649 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001650
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001651 /**
1652 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001653 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001654 * This should <em>only</em> be used to determine when the wallpaper
1655 * has changed to show the new wallpaper to the user. You should certainly
1656 * never, in response to this, change the wallpaper or other attributes of
1657 * it such as the suggested size. That would be crazy, right? You'd cause
1658 * all kinds of loops, especially if other apps are doing similar things,
1659 * right? Of course. So please don't do this.
1660 *
1661 * @deprecated Modern applications should use
1662 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1663 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1664 * shown behind their UI, rather than watching for this broadcast and
1665 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001666 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001667 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001668 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1669 /**
1670 * Broadcast Action: The current device {@link android.content.res.Configuration}
1671 * (orientation, locale, etc) has changed. When such a change happens, the
1672 * UIs (view hierarchy) will need to be rebuilt based on this new
1673 * information; for the most part, applications don't need to worry about
1674 * this, because the system will take care of stopping and restarting the
1675 * application to make sure it sees the new changes. Some system code that
1676 * can not be restarted will need to watch for this action and handle it
1677 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001678 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001679 * <p class="note">
1680 * You can <em>not</em> receive this through components declared
1681 * in manifests, only by explicitly registering for it with
1682 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1683 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001684 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001685 * <p class="note">This is a protected intent that can only be sent
1686 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001687 *
1688 * @see android.content.res.Configuration
1689 */
1690 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1691 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1692 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001693 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001694 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001695 * <p class="note">This is a protected intent that can only be sent
1696 * by the system.
1697 */
1698 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1699 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1700 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001701 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1702 * charging state, level, and other information about the battery.
1703 * See {@link android.os.BatteryManager} for documentation on the
1704 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001705 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001706 * <p class="note">
1707 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001708 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001709 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001710 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1711 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1712 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1713 * broadcasts that are sent and can be received through manifest
1714 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001715 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001716 * <p class="note">This is a protected intent that can only be sent
1717 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001718 */
1719 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1720 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1721 /**
1722 * Broadcast Action: Indicates low battery condition on the device.
1723 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001724 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001725 * <p class="note">This is a protected intent that can only be sent
1726 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001727 */
1728 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1729 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1730 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001731 * Broadcast Action: Indicates the battery is now okay after being low.
1732 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1733 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001734 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001735 * <p class="note">This is a protected intent that can only be sent
1736 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001737 */
1738 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1739 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1740 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001741 * Broadcast Action: External power has been connected to the device.
1742 * This is intended for applications that wish to register specifically to this notification.
1743 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1744 * stay active to receive this notification. This action can be used to implement actions
1745 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001746 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001747 * <p class="note">This is a protected intent that can only be sent
1748 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001749 */
1750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001751 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001752 /**
1753 * Broadcast Action: External power has been removed from the device.
1754 * This is intended for applications that wish to register specifically to this notification.
1755 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1756 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001757 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001758 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001759 * <p class="note">This is a protected intent that can only be sent
1760 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001761 */
1762 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001763 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001764 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001765 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001766 * Broadcast Action: Device is shutting down.
1767 * This is broadcast when the device is being shut down (completely turned
1768 * off, not sleeping). Once the broadcast is complete, the final shutdown
1769 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001770 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001771 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001772 * <p class="note">This is a protected intent that can only be sent
1773 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001774 */
1775 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001776 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001777 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001778 * Activity Action: Start this activity to request system shutdown.
1779 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1780 * to request confirmation from the user before shutting down.
1781 *
1782 * <p class="note">This is a protected intent that can only be sent
1783 * by the system.
1784 *
1785 * {@hide}
1786 */
1787 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1788 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001789 * Broadcast Action: A sticky broadcast that indicates low memory
1790 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001791 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001792 * <p class="note">This is a protected intent that can only be sent
1793 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001794 */
1795 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1796 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1797 /**
1798 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001799 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001800 * <p class="note">This is a protected intent that can only be sent
1801 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001802 */
1803 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1804 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1805 /**
Jake Hambybb371632010-08-23 18:16:48 -07001806 * Broadcast Action: A sticky broadcast that indicates a memory full
1807 * condition on the device. This is intended for activities that want
1808 * to be able to fill the data partition completely, leaving only
1809 * enough free space to prevent system-wide SQLite failures.
1810 *
1811 * <p class="note">This is a protected intent that can only be sent
1812 * by the system.
1813 *
1814 * {@hide}
1815 */
1816 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1817 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1818 /**
1819 * Broadcast Action: Indicates memory full condition on the device
1820 * no longer exists.
1821 *
1822 * <p class="note">This is a protected intent that can only be sent
1823 * by the system.
1824 *
1825 * {@hide}
1826 */
1827 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1828 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1829 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001830 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1831 * and package management should be started.
1832 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1833 * notification.
1834 */
1835 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1836 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1837 /**
1838 * Broadcast Action: The device has entered USB Mass Storage mode.
1839 * This is used mainly for the USB Settings panel.
1840 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1841 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001842 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001843 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001844 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1846
1847 /**
1848 * Broadcast Action: The device has exited USB Mass Storage mode.
1849 * This is used mainly for the USB Settings panel.
1850 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1851 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001852 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001853 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001854 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1856
1857 /**
1858 * Broadcast Action: External media has been removed.
1859 * The path to the mount point for the removed media is contained in the Intent.mData field.
1860 */
1861 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1862 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1863
1864 /**
1865 * Broadcast Action: External media is present, but not mounted at its mount point.
1866 * The path to the mount point for the removed media is contained in the Intent.mData field.
1867 */
1868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1869 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1870
1871 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001872 * Broadcast Action: External media is present, and being disk-checked
1873 * 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 -08001874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1876 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1877
1878 /**
1879 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1880 * 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 -08001881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1884
1885 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001886 * Broadcast Action: External media is present and mounted at its mount point.
1887 * The path to the mount point for the removed media is contained in the Intent.mData field.
1888 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1889 * media was mounted read only.
1890 */
1891 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1892 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1893
1894 /**
1895 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001896 * 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 -07001897 */
1898 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1899 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1900
1901 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001902 * Broadcast Action: External media is no longer being shared via USB mass storage.
1903 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1904 *
1905 * @hide
1906 */
1907 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1908
1909 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001910 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1911 * The path to the mount point for the removed media is contained in the Intent.mData field.
1912 */
1913 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1914 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1915
1916 /**
1917 * Broadcast Action: External media is present but cannot be mounted.
1918 * The path to the mount point for the removed media is contained in the Intent.mData field.
1919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1922
1923 /**
1924 * Broadcast Action: User has expressed the desire to remove the external storage media.
1925 * Applications should close all files they have open within the mount point when they receive this intent.
1926 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1927 */
1928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1929 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1930
1931 /**
1932 * Broadcast Action: The media scanner has started scanning a directory.
1933 * The path to the directory being scanned is contained in the Intent.mData field.
1934 */
1935 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1936 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1937
1938 /**
1939 * Broadcast Action: The media scanner has finished scanning a directory.
1940 * The path to the scanned directory is contained in the Intent.mData field.
1941 */
1942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1943 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1944
1945 /**
1946 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1947 * The path to the file is contained in the Intent.mData field.
1948 */
1949 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1950 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1951
1952 /**
1953 * Broadcast Action: The "Media Button" was pressed. Includes a single
1954 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1955 * caused the broadcast.
1956 */
1957 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1958 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1959
1960 /**
1961 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1962 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1963 * caused the broadcast.
1964 */
1965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1966 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1967
1968 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1969 // location; they are not general-purpose actions.
1970
1971 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001972 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 */
1974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1975 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1976 "android.intent.action.GTALK_CONNECTED";
1977
1978 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09001979 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1983 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001984
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001985 /**
1986 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001987 */
1988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1989 public static final String ACTION_INPUT_METHOD_CHANGED =
1990 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001991
1992 /**
1993 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1994 * more radios have been turned off or on. The intent will have the following extra value:</p>
1995 * <ul>
1996 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1997 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1998 * turned off</li>
1999 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002000 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002001 * <p class="note">This is a protected intent that can only be sent
2002 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002003 */
2004 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2005 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2006
2007 /**
2008 * Broadcast Action: Some content providers have parts of their namespace
2009 * where they publish new events or items that the user may be especially
2010 * interested in. For these things, they may broadcast this action when the
2011 * set of interesting items change.
2012 *
2013 * For example, GmailProvider sends this notification when the set of unread
2014 * mail in the inbox changes.
2015 *
2016 * <p>The data of the intent identifies which part of which provider
2017 * changed. When queried through the content resolver, the data URI will
2018 * return the data set in question.
2019 *
2020 * <p>The intent will have the following extra values:
2021 * <ul>
2022 * <li><em>count</em> - The number of items in the data set. This is the
2023 * same as the number of items in the cursor returned by querying the
2024 * data URI. </li>
2025 * </ul>
2026 *
2027 * This intent will be sent at boot (if the count is non-zero) and when the
2028 * data set changes. It is possible for the data set to change without the
2029 * count changing (for example, if a new unread message arrives in the same
2030 * sync operation in which a message is archived). The phone should still
2031 * ring/vibrate/etc as normal in this case.
2032 */
2033 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2034 public static final String ACTION_PROVIDER_CHANGED =
2035 "android.intent.action.PROVIDER_CHANGED";
2036
2037 /**
2038 * Broadcast Action: Wired Headset plugged in or unplugged.
2039 *
2040 * <p>The intent will have the following extra values:
2041 * <ul>
2042 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2043 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002044 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002045 * </ul>
2046 * </ul>
2047 */
2048 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2049 public static final String ACTION_HEADSET_PLUG =
2050 "android.intent.action.HEADSET_PLUG";
2051
2052 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002053 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2054 *
2055 * <p>The intent will have the following extra values:
2056 * <ul>
2057 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2058 * <li><em>name</em> - Headset type, human readable string </li>
2059 * </ul>
2060 * </ul>
2061 * @hide
2062 */
2063 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002064 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2065 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002066
2067 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002068 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002069 *
2070 * <p>The intent will have the following extra values:
2071 * <ul>
2072 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2073 * <li><em>name</em> - Headset type, human readable string </li>
2074 * </ul>
2075 * </ul>
2076 * @hide
2077 */
2078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002079 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2080 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002081
2082 /**
2083 * Broadcast Action: A HMDI cable was plugged or unplugged
2084 *
2085 * <p>The intent will have the following extra values:
2086 * <ul>
2087 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2088 * <li><em>name</em> - HDMI cable, human readable string </li>
2089 * </ul>
2090 * </ul>
2091 * @hide
2092 */
2093 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2094 public static final String ACTION_HDMI_AUDIO_PLUG =
2095 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002096
2097 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002098 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2099 *
2100 * <p>The intent will have the following extra values:
2101 * <ul>
2102 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2103 * <li><em>card</em> - ALSA card number (integer) </li>
2104 * <li><em>device</em> - ALSA device number (integer) </li>
2105 * </ul>
2106 * </ul>
2107 * @hide
2108 */
2109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2110 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2111 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2112
2113 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002114 * Broadcast Action: A USB audio device was plugged in or unplugged.
2115 *
2116 * <p>The intent will have the following extra values:
2117 * <ul>
2118 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2119 * <li><em>card</em> - ALSA card number (integer) </li>
2120 * <li><em>device</em> - ALSA device number (integer) </li>
2121 * </ul>
2122 * </ul>
2123 * @hide
2124 */
2125 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2126 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2127 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2128
2129 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002130 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2131 * <ul>
2132 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2133 * </ul>
2134 *
2135 * <p class="note">This is a protected intent that can only be sent
2136 * by the system.
2137 *
2138 * @hide
2139 */
2140 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2141 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2142 = "android.intent.action.ADVANCED_SETTINGS";
2143
2144 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002145 * Broadcast Action: An outgoing call is about to be placed.
2146 *
2147 * <p>The Intent will have the following extra value:
2148 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002149 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002150 * the phone number originally intended to be dialed.</li>
2151 * </ul>
2152 * <p>Once the broadcast is finished, the resultData is used as the actual
2153 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002154 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002155 * outgoing call in turn: for example, a parental control application
2156 * might verify that the user is authorized to place the call at that
2157 * time, then a number-rewriting application might add an area code if
2158 * one was not specified.</p>
2159 * <p>For consistency, any receiver whose purpose is to prohibit phone
2160 * calls should have a priority of 0, to ensure it will see the final
2161 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002162 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002163 * should have a positive priority.
2164 * Negative priorities are reserved for the system for this broadcast;
2165 * using them may cause problems.</p>
2166 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2167 * abort the broadcast.</p>
2168 * <p>Emergency calls cannot be intercepted using this mechanism, and
2169 * other calls cannot be modified to call emergency numbers using this
2170 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002171 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002172 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2173 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002174 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002175 * <p class="note">This is a protected intent that can only be sent
2176 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002177 */
2178 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2179 public static final String ACTION_NEW_OUTGOING_CALL =
2180 "android.intent.action.NEW_OUTGOING_CALL";
2181
2182 /**
2183 * Broadcast Action: Have the device reboot. This is only for use by
2184 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002185 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002186 * <p class="note">This is a protected intent that can only be sent
2187 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002188 */
2189 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2190 public static final String ACTION_REBOOT =
2191 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002192
Wei Huang97ecc9c2009-05-11 17:44:20 -07002193 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002194 * Broadcast Action: A sticky broadcast for changes in the physical
2195 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002196 *
2197 * <p>The intent will have the following extra values:
2198 * <ul>
2199 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002200 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002201 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002202 * <p>This is intended for monitoring the current physical dock state.
2203 * See {@link android.app.UiModeManager} for the normal API dealing with
2204 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002205 */
2206 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2207 public static final String ACTION_DOCK_EVENT =
2208 "android.intent.action.DOCK_EVENT";
2209
2210 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002211 * Broadcast Action: a remote intent is to be broadcasted.
2212 *
2213 * A remote intent is used for remote RPC between devices. The remote intent
2214 * is serialized and sent from one device to another device. The receiving
2215 * device parses the remote intent and broadcasts it. Note that anyone can
2216 * broadcast a remote intent. However, if the intent receiver of the remote intent
2217 * does not trust intent broadcasts from arbitrary intent senders, it should require
2218 * the sender to hold certain permissions so only trusted sender's broadcast will be
2219 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002220 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002221 */
2222 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002223 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002224
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002225 /**
2226 * Broadcast Action: hook for permforming cleanup after a system update.
2227 *
2228 * The broadcast is sent when the system is booting, before the
2229 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2230 * image. A receiver for this should do its work and then disable itself
2231 * so that it does not get run again at the next boot.
2232 * @hide
2233 */
2234 public static final String ACTION_PRE_BOOT_COMPLETED =
2235 "android.intent.action.PRE_BOOT_COMPLETED";
2236
Amith Yamasani13593602012-03-22 16:16:17 -07002237 /**
2238 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USERID that has the
2239 * userid of the new user.
2240 * @hide
2241 */
2242 public static final String ACTION_USER_ADDED =
2243 "android.intent.action.USER_ADDED";
2244
2245 /**
2246 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USERID that has
2247 * the userid of the user.
2248 * @hide
2249 */
2250 public static final String ACTION_USER_REMOVED =
2251 "android.intent.action.USER_REMOVED";
2252
2253 /**
2254 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USERID that has
2255 * the userid of the user to become the current one.
2256 * @hide
2257 */
2258 public static final String ACTION_USER_SWITCHED =
2259 "android.intent.action.USER_SWITCHED";
2260
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002261 // ---------------------------------------------------------------------
2262 // ---------------------------------------------------------------------
2263 // Standard intent categories (see addCategory()).
2264
2265 /**
2266 * Set if the activity should be an option for the default action
2267 * (center press) to perform on a piece of data. Setting this will
2268 * hide from the user any activities without it set when performing an
2269 * action on some data. Note that this is normal -not- set in the
2270 * Intent when initiating an action -- it is for use in intent filters
2271 * specified in packages.
2272 */
2273 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2274 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2275 /**
2276 * Activities that can be safely invoked from a browser must support this
2277 * category. For example, if the user is viewing a web page or an e-mail
2278 * and clicks on a link in the text, the Intent generated execute that
2279 * link will require the BROWSABLE category, so that only activities
2280 * supporting this category will be considered as possible actions. By
2281 * supporting this category, you are promising that there is nothing
2282 * damaging (without user intervention) that can happen by invoking any
2283 * matching Intent.
2284 */
2285 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2286 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2287 /**
2288 * Set if the activity should be considered as an alternative action to
2289 * the data the user is currently viewing. See also
2290 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2291 * applies to the selection in a list of items.
2292 *
2293 * <p>Supporting this category means that you would like your activity to be
2294 * displayed in the set of alternative things the user can do, usually as
2295 * part of the current activity's options menu. You will usually want to
2296 * include a specific label in the &lt;intent-filter&gt; of this action
2297 * describing to the user what it does.
2298 *
2299 * <p>The action of IntentFilter with this category is important in that it
2300 * describes the specific action the target will perform. This generally
2301 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2302 * a specific name such as "com.android.camera.action.CROP. Only one
2303 * alternative of any particular action will be shown to the user, so using
2304 * a specific action like this makes sure that your alternative will be
2305 * displayed while also allowing other applications to provide their own
2306 * overrides of that particular action.
2307 */
2308 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2309 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2310 /**
2311 * Set if the activity should be considered as an alternative selection
2312 * action to the data the user has currently selected. This is like
2313 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2314 * of items from which the user can select, giving them alternatives to the
2315 * default action that will be performed on it.
2316 */
2317 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2318 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2319 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002320 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002321 */
2322 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2323 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2324 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002325 * Should be displayed in the top-level launcher.
2326 */
2327 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2328 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2329 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002330 * Provides information about the package it is in; typically used if
2331 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2332 * a front-door to the user without having to be shown in the all apps list.
2333 */
2334 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2335 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2336 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002337 * This is the home activity, that is the first activity that is displayed
2338 * when the device boots.
2339 */
2340 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2341 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2342 /**
2343 * This activity is a preference panel.
2344 */
2345 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2346 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2347 /**
2348 * This activity is a development preference panel.
2349 */
2350 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2351 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2352 /**
2353 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002354 */
2355 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2356 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2357 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002358 * This activity allows the user to browse and download new applications.
2359 */
2360 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2361 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2362 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002363 * This activity may be exercised by the monkey or other automated test tools.
2364 */
2365 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2366 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2367 /**
2368 * To be used as a test (not part of the normal user experience).
2369 */
2370 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2371 /**
2372 * To be used as a unit test (run through the Test Harness).
2373 */
2374 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2375 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002376 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002377 * experience).
2378 */
2379 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2380 /**
2381 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2382 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2383 * when queried, though it is allowable for those columns to be blank.
2384 */
2385 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2386 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2387
2388 /**
2389 * To be used as code under test for framework instrumentation tests.
2390 */
2391 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2392 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002393 /**
2394 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002395 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2396 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002397 */
2398 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2399 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2400 /**
2401 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002402 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2403 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002404 */
2405 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2406 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002407 /**
2408 * An activity to run when device is inserted into a analog (low end) dock.
2409 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2410 * information, see {@link android.app.UiModeManager}.
2411 */
2412 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2413 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2414
2415 /**
2416 * An activity to run when device is inserted into a digital (high end) dock.
2417 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2418 * information, see {@link android.app.UiModeManager}.
2419 */
2420 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2421 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002422
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002423 /**
2424 * Used to indicate that the activity can be used in a car environment.
2425 */
2426 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2427 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2428
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002429 // ---------------------------------------------------------------------
2430 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002431 // Application launch intent categories (see addCategory()).
2432
2433 /**
2434 * Used with {@link #ACTION_MAIN} to launch the browser application.
2435 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002436 * <p>NOTE: This should not be used as the primary key of an Intent,
2437 * since it will not result in the app launching with the correct
2438 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002439 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002440 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002441 */
2442 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2443 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2444
2445 /**
2446 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2447 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002448 * <p>NOTE: This should not be used as the primary key of an Intent,
2449 * since it will not result in the app launching with the correct
2450 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002451 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002452 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002453 */
2454 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2455 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2456
2457 /**
2458 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2459 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002460 * <p>NOTE: This should not be used as the primary key of an Intent,
2461 * since it will not result in the app launching with the correct
2462 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002463 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002464 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002465 */
2466 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2467 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2468
2469 /**
2470 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2471 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002472 * <p>NOTE: This should not be used as the primary key of an Intent,
2473 * since it will not result in the app launching with the correct
2474 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002475 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002476 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002477 */
2478 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2479 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2480
2481 /**
2482 * Used with {@link #ACTION_MAIN} to launch the email application.
2483 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002484 * <p>NOTE: This should not be used as the primary key of an Intent,
2485 * since it will not result in the app launching with the correct
2486 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002487 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002488 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002489 */
2490 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2491 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2492
2493 /**
2494 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2495 * The activity should be able to view and manipulate image and video files
2496 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002497 * <p>NOTE: This should not be used as the primary key of an Intent,
2498 * since it will not result in the app launching with the correct
2499 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002500 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002501 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002502 */
2503 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2504 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2505
2506 /**
2507 * Used with {@link #ACTION_MAIN} to launch the maps application.
2508 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002509 * <p>NOTE: This should not be used as the primary key of an Intent,
2510 * since it will not result in the app launching with the correct
2511 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002512 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002513 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002514 */
2515 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2516 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2517
2518 /**
2519 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2520 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002521 * <p>NOTE: This should not be used as the primary key of an Intent,
2522 * since it will not result in the app launching with the correct
2523 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002524 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002525 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002526 */
2527 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2528 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2529
2530 /**
2531 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002532 * The activity should be able to play, browse, or manipulate music files
2533 * stored on the device.
2534 * <p>NOTE: This should not be used as the primary key of an Intent,
2535 * since it will not result in the app launching with the correct
2536 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002537 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002538 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002539 */
2540 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2541 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2542
2543 // ---------------------------------------------------------------------
2544 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002545 // Standard extra data keys.
2546
2547 /**
2548 * The initial data to place in a newly created record. Use with
2549 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2550 * fields as would be given to the underlying ContentProvider.insert()
2551 * call.
2552 */
2553 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2554
2555 /**
2556 * A constant CharSequence that is associated with the Intent, used with
2557 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2558 * this may be a styled CharSequence, so you must use
2559 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2560 * retrieve it.
2561 */
2562 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2563
2564 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002565 * A constant String that is associated with the Intent, used with
2566 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2567 * as HTML formatted text. Note that you <em>must</em> also supply
2568 * {@link #EXTRA_TEXT}.
2569 */
2570 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2571
2572 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002573 * A content: URI holding a stream of data associated with the Intent,
2574 * used with {@link #ACTION_SEND} to supply the data being sent.
2575 */
2576 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2577
2578 /**
2579 * A String[] holding e-mail addresses that should be delivered to.
2580 */
2581 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2582
2583 /**
2584 * A String[] holding e-mail addresses that should be carbon copied.
2585 */
2586 public static final String EXTRA_CC = "android.intent.extra.CC";
2587
2588 /**
2589 * A String[] holding e-mail addresses that should be blind carbon copied.
2590 */
2591 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2592
2593 /**
2594 * A constant string holding the desired subject line of a message.
2595 */
2596 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2597
2598 /**
2599 * An Intent describing the choices you would like shown with
2600 * {@link #ACTION_PICK_ACTIVITY}.
2601 */
2602 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2603
2604 /**
2605 * A CharSequence dialog title to provide to the user when used with a
2606 * {@link #ACTION_CHOOSER}.
2607 */
2608 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2609
2610 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002611 * A Parcelable[] of {@link Intent} or
2612 * {@link android.content.pm.LabeledIntent} objects as set with
2613 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2614 * a the front of the list of choices, when shown to the user with a
2615 * {@link #ACTION_CHOOSER}.
2616 */
2617 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2618
2619 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002620 * A {@link android.view.KeyEvent} object containing the event that
2621 * triggered the creation of the Intent it is in.
2622 */
2623 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2624
2625 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002626 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2627 * before shutting down.
2628 *
2629 * {@hide}
2630 */
2631 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2632
2633 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002634 * 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 -07002635 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2636 * of restarting the application.
2637 */
2638 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2639
2640 /**
2641 * A String holding the phone number originally entered in
2642 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2643 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2644 */
2645 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002647 /**
2648 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2649 * intents to supply the uid the package had been assigned. Also an optional
2650 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2651 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2652 * purpose.
2653 */
2654 public static final String EXTRA_UID = "android.intent.extra.UID";
2655
2656 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002657 * @hide String array of package names.
2658 */
2659 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2660
2661 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002662 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2663 * intents to indicate whether this represents a full uninstall (removing
2664 * both the code and its data) or a partial uninstall (leaving its data,
2665 * implying that this is an update).
2666 */
2667 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002668
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002669 /**
2670 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2671 * intents to indicate that this is a replacement of the package, so this
2672 * broadcast will immediately be followed by an add broadcast for a
2673 * different version of the same package.
2674 */
2675 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002676
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002677 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002678 * Used as an int extra field in {@link android.app.AlarmManager} intents
2679 * to tell the application being invoked how many pending alarms are being
2680 * delievered with the intent. For one-shot alarms this will always be 1.
2681 * For recurring alarms, this might be greater than 1 if the device was
2682 * asleep or powered off at the time an earlier alarm would have been
2683 * delivered.
2684 */
2685 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002686
Jacek Surazski86b6c532009-05-13 14:38:28 +02002687 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002688 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2689 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002690 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2691 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002692 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2693 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2694 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002695 */
2696 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2697
2698 /**
2699 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2700 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002701 */
2702 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2703
2704 /**
2705 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2706 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002707 */
2708 public static final int EXTRA_DOCK_STATE_DESK = 1;
2709
2710 /**
2711 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2712 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002713 */
2714 public static final int EXTRA_DOCK_STATE_CAR = 2;
2715
2716 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002717 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2718 * to represent that the phone is in a analog (low end) dock.
2719 */
2720 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2721
2722 /**
2723 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2724 * to represent that the phone is in a digital (high end) dock.
2725 */
2726 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2727
2728 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002729 * Boolean that can be supplied as meta-data with a dock activity, to
2730 * indicate that the dock should take over the home key when it is active.
2731 */
2732 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002733
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002734 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002735 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2736 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002737 */
2738 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2739
2740 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002741 * Used in the extra field in the remote intent. It's astring token passed with the
2742 * remote intent.
2743 */
2744 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2745 "android.intent.extra.remote_intent_token";
2746
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002747 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002748 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002749 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002750 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002751 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002752 "android.intent.extra.changed_component_name";
2753
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002754 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002755 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002756 * and contains a string array of all of the components that have changed.
2757 */
2758 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2759 "android.intent.extra.changed_component_name_list";
2760
2761 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002762 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002763 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2764 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002765 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002766 */
2767 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2768 "android.intent.extra.changed_package_list";
2769
2770 /**
2771 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002772 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2773 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002774 * and contains an integer array of uids of all of the components
2775 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002776 */
2777 public static final String EXTRA_CHANGED_UID_LIST =
2778 "android.intent.extra.changed_uid_list";
2779
2780 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002781 * @hide
2782 * Magic extra system code can use when binding, to give a label for
2783 * who it is that has bound to a service. This is an integer giving
2784 * a framework string resource that can be displayed to the user.
2785 */
2786 public static final String EXTRA_CLIENT_LABEL =
2787 "android.intent.extra.client_label";
2788
2789 /**
2790 * @hide
2791 * Magic extra system code can use when binding, to give a PendingIntent object
2792 * that can be launched for the user to disable the system's use of this
2793 * service.
2794 */
2795 public static final String EXTRA_CLIENT_INTENT =
2796 "android.intent.extra.client_intent";
2797
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002798 /**
2799 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2800 * data that is on the local device. This is a boolean extra; the default
2801 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2802 * the user to select media that is already on the device, not requiring it
2803 * be downloaded from a remote service when opened. Another way to look
2804 * at it is that such content should generally have a "_data" column to the
2805 * path of the content on local external storage.
2806 */
2807 public static final String EXTRA_LOCAL_ONLY =
2808 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002809
Amith Yamasani13593602012-03-22 16:16:17 -07002810 /**
2811 * The userid carried with broadcast intents related to addition, removal and switching of users
2812 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2813 * @hide
2814 */
2815 public static final String EXTRA_USERID =
2816 "android.intent.extra.user_id";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002817 // ---------------------------------------------------------------------
2818 // ---------------------------------------------------------------------
2819 // Intent flags (see mFlags variable).
2820
2821 /**
2822 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002823 * perform read operations on the Uri in the Intent's data and any URIs
2824 * specified in its ClipData. When applying to an Intent's ClipData,
2825 * all URIs as well as recursive traversals through data or other ClipData
2826 * in Intent items will be granted; only the grant flags of the top-level
2827 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002828 */
2829 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2830 /**
2831 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002832 * perform write operations on the Uri in the Intent's data and any URIs
2833 * specified in its ClipData. When applying to an Intent's ClipData,
2834 * all URIs as well as recursive traversals through data or other ClipData
2835 * in Intent items will be granted; only the grant flags of the top-level
2836 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002837 */
2838 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2839 /**
2840 * Can be set by the caller to indicate that this Intent is coming from
2841 * a background operation, not from direct user interaction.
2842 */
2843 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2844 /**
2845 * A flag you can enable for debugging: when set, log messages will be
2846 * printed during the resolution of this intent to show you what has
2847 * been found to create the final resolved list.
2848 */
2849 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002850 /**
2851 * If set, this intent will not match any components in packages that
2852 * are currently stopped. If this is not set, then the default behavior
2853 * is to include such applications in the result.
2854 */
2855 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2856 /**
2857 * If set, this intent will always match any components in packages that
2858 * are currently stopped. This is the default behavior when
2859 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2860 * flags are set, this one wins (it allows overriding of exclude for
2861 * places where the framework may automatically set the exclude flag).
2862 */
2863 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002864
2865 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002866 * If set, the new activity is not kept in the history stack. As soon as
2867 * the user navigates away from it, the activity is finished. This may also
2868 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2869 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870 */
2871 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2872 /**
2873 * If set, the activity will not be launched if it is already running
2874 * at the top of the history stack.
2875 */
2876 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2877 /**
2878 * If set, this activity will become the start of a new task on this
2879 * history stack. A task (from the activity that started it to the
2880 * next task activity) defines an atomic group of activities that the
2881 * user can move to. Tasks can be moved to the foreground and background;
2882 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002883 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002884 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2885 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002886 *
2887 * <p>This flag is generally used by activities that want
2888 * to present a "launcher" style behavior: they give the user a list of
2889 * separate things that can be done, which otherwise run completely
2890 * independently of the activity launching them.
2891 *
2892 * <p>When using this flag, if a task is already running for the activity
2893 * you are now starting, then a new activity will not be started; instead,
2894 * the current task will simply be brought to the front of the screen with
2895 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2896 * to disable this behavior.
2897 *
2898 * <p>This flag can not be used when the caller is requesting a result from
2899 * the activity being launched.
2900 */
2901 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2902 /**
2903 * <strong>Do not use this flag unless you are implementing your own
2904 * top-level application launcher.</strong> Used in conjunction with
2905 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2906 * behavior of bringing an existing task to the foreground. When set,
2907 * a new task is <em>always</em> started to host the Activity for the
2908 * Intent, regardless of whether there is already an existing task running
2909 * the same thing.
2910 *
2911 * <p><strong>Because the default system does not include graphical task management,
2912 * you should not use this flag unless you provide some way for a user to
2913 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002914 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002915 * <p>This flag is ignored if
2916 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2917 *
Scott Main7aee61f2011-02-08 11:25:01 -08002918 * <p>See
2919 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2920 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002921 */
2922 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2923 /**
2924 * If set, and the activity being launched is already running in the
2925 * current task, then instead of launching a new instance of that activity,
2926 * all of the other activities on top of it will be closed and this Intent
2927 * will be delivered to the (now on top) old activity as a new Intent.
2928 *
2929 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2930 * If D calls startActivity() with an Intent that resolves to the component
2931 * of activity B, then C and D will be finished and B receive the given
2932 * Intent, resulting in the stack now being: A, B.
2933 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002934 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002935 * either receive the new intent you are starting here in its
2936 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002937 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002938 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2939 * the same intent, then it will be finished and re-created; for all other
2940 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2941 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002942 *
2943 * <p>This launch mode can also be used to good effect in conjunction with
2944 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2945 * of a task, it will bring any currently running instance of that task
2946 * to the foreground, and then clear it to its root state. This is
2947 * especially useful, for example, when launching an activity from the
2948 * notification manager.
2949 *
Scott Main7aee61f2011-02-08 11:25:01 -08002950 * <p>See
2951 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2952 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002953 */
2954 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2955 /**
2956 * If set and this intent is being used to launch a new activity from an
2957 * existing one, then the reply target of the existing activity will be
2958 * transfered to the new activity. This way the new activity can call
2959 * {@link android.app.Activity#setResult} and have that result sent back to
2960 * the reply target of the original activity.
2961 */
2962 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2963 /**
2964 * If set and this intent is being used to launch a new activity from an
2965 * existing one, the current activity will not be counted as the top
2966 * activity for deciding whether the new intent should be delivered to
2967 * the top instead of starting a new one. The previous activity will
2968 * be used as the top, with the assumption being that the current activity
2969 * will finish itself immediately.
2970 */
2971 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2972 /**
2973 * If set, the new activity is not kept in the list of recently launched
2974 * activities.
2975 */
2976 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2977 /**
2978 * This flag is not normally set by application code, but set for you by
2979 * the system as described in the
2980 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2981 * launchMode} documentation for the singleTask mode.
2982 */
2983 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2984 /**
2985 * If set, and this activity is either being started in a new task or
2986 * bringing to the top an existing task, then it will be launched as
2987 * the front door of the task. This will result in the application of
2988 * any affinities needed to have that task in the proper state (either
2989 * moving activities to or from it), or simply resetting that task to
2990 * its initial state if needed.
2991 */
2992 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2993 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002994 * This flag is not normally set by application code, but set for you by
2995 * the system if this activity is being launched from history
2996 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002997 */
2998 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002999 /**
3000 * If set, this marks a point in the task's activity stack that should
3001 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003002 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003003 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3004 * the user re-launching it from home), this activity and all on top of
3005 * it will be finished so that the user does not return to them, but
3006 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003007 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003008 * <p>This is useful for cases where you have a logical break in your
3009 * application. For example, an e-mail application may have a command
3010 * to view an attachment, which launches an image view activity to
3011 * display it. This activity should be part of the e-mail application's
3012 * task, since it is a part of the task the user is involved in. However,
3013 * if the user leaves that task, and later selects the e-mail app from
3014 * home, we may like them to return to the conversation they were
3015 * viewing, not the picture attachment, since that is confusing. By
3016 * setting this flag when launching the image viewer, that viewer and
3017 * any activities it starts will be removed the next time the user returns
3018 * to mail.
3019 */
3020 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003021 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003022 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003023 * callback from occurring on the current frontmost activity before it is
3024 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003025 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003026 * <p>Typically, an activity can rely on that callback to indicate that an
3027 * explicit user action has caused their activity to be moved out of the
3028 * foreground. The callback marks an appropriate point in the activity's
3029 * lifecycle for it to dismiss any notifications that it intends to display
3030 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003031 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003032 * <p>If an activity is ever started via any non-user-driven events such as
3033 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3034 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003035 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003036 */
3037 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003038 /**
3039 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3040 * this flag will cause the launched activity to be brought to the front of its
3041 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003042 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003043 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3044 * If D calls startActivity() with an Intent that resolves to the component
3045 * of activity B, then B will be brought to the front of the history stack,
3046 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003047 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003048 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003049 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003050 */
3051 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003052 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003053 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3054 * this flag will prevent the system from applying an activity transition
3055 * animation to go to the next activity state. This doesn't mean an
3056 * animation will never run -- if another activity change happens that doesn't
3057 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003058 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003059 * when you are going to do a series of activity operations but the
3060 * animation seen by the user shouldn't be driven by the first activity
3061 * change but rather a later one.
3062 */
3063 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3064 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003065 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3066 * this flag will cause any existing task that would be associated with the
3067 * activity to be cleared before the activity is started. That is, the activity
3068 * becomes the new root of an otherwise empty task, and any old activities
3069 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3070 */
3071 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3072 /**
3073 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3074 * this flag will cause a newly launching task to be placed on top of the current
3075 * home activity task (if there is one). That is, pressing back from the task
3076 * will always return the user to home even if that was not the last activity they
3077 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3078 */
3079 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3080 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003081 * If set, when sending a broadcast only registered receivers will be
3082 * called -- no BroadcastReceiver components will be launched.
3083 */
3084 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003085 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003086 * If set, when sending a broadcast the new broadcast will replace
3087 * any existing pending broadcast that matches it. Matching is defined
3088 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3089 * true for the intents of the two broadcasts. When a match is found,
3090 * the new broadcast (and receivers associated with it) will replace the
3091 * existing one in the pending broadcast list, remaining at the same
3092 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003093 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003094 * <p>This flag is most typically used with sticky broadcasts, which
3095 * only care about delivering the most recent values of the broadcast
3096 * to their receivers.
3097 */
3098 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3099 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003100 * If set, when sending a broadcast the recipient is allowed to run at
3101 * foreground priority, with a shorter timeout interval. During normal
3102 * broadcasts the receivers are not automatically hoisted out of the
3103 * background priority class.
3104 */
3105 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3106 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003107 * If set, when sending a broadcast <i>before boot has completed</i> only
3108 * registered receivers will be called -- no BroadcastReceiver components
3109 * will be launched. Sticky intent state will be recorded properly even
3110 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3111 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003112 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003113 * <p>This flag is only for use by system sevices as a convenience to
3114 * avoid having to implement a more complex mechanism around detection
3115 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003116 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003117 * @hide
3118 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003119 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003120 /**
3121 * Set when this broadcast is for a boot upgrade, a special mode that
3122 * allows the broadcast to be sent before the system is ready and launches
3123 * the app process with no providers running in it.
3124 * @hide
3125 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003126 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003127
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003128 /**
3129 * @hide Flags that can't be changed with PendingIntent.
3130 */
3131 public static final int IMMUTABLE_FLAGS =
3132 FLAG_GRANT_READ_URI_PERMISSION
3133 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003134
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003135 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003136 // ---------------------------------------------------------------------
3137 // toUri() and parseUri() options.
3138
3139 /**
3140 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3141 * always has the "intent:" scheme. This syntax can be used when you want
3142 * to later disambiguate between URIs that are intended to describe an
3143 * Intent vs. all others that should be treated as raw URIs. When used
3144 * with {@link #parseUri}, any other scheme will result in a generic
3145 * VIEW action for that raw URI.
3146 */
3147 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003148
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003149 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003150
3151 private String mAction;
3152 private Uri mData;
3153 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003154 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003155 private ComponentName mComponent;
3156 private int mFlags;
3157 private HashSet<String> mCategories;
3158 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003159 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003160 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003161 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003162
3163 // ---------------------------------------------------------------------
3164
3165 /**
3166 * Create an empty intent.
3167 */
3168 public Intent() {
3169 }
3170
3171 /**
3172 * Copy constructor.
3173 */
3174 public Intent(Intent o) {
3175 this.mAction = o.mAction;
3176 this.mData = o.mData;
3177 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003178 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003179 this.mComponent = o.mComponent;
3180 this.mFlags = o.mFlags;
3181 if (o.mCategories != null) {
3182 this.mCategories = new HashSet<String>(o.mCategories);
3183 }
3184 if (o.mExtras != null) {
3185 this.mExtras = new Bundle(o.mExtras);
3186 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003187 if (o.mSourceBounds != null) {
3188 this.mSourceBounds = new Rect(o.mSourceBounds);
3189 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003190 if (o.mSelector != null) {
3191 this.mSelector = new Intent(o.mSelector);
3192 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003193 if (o.mClipData != null) {
3194 this.mClipData = new ClipData(o.mClipData);
3195 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003196 }
3197
3198 @Override
3199 public Object clone() {
3200 return new Intent(this);
3201 }
3202
3203 private Intent(Intent o, boolean all) {
3204 this.mAction = o.mAction;
3205 this.mData = o.mData;
3206 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003207 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003208 this.mComponent = o.mComponent;
3209 if (o.mCategories != null) {
3210 this.mCategories = new HashSet<String>(o.mCategories);
3211 }
3212 }
3213
3214 /**
3215 * Make a clone of only the parts of the Intent that are relevant for
3216 * filter matching: the action, data, type, component, and categories.
3217 */
3218 public Intent cloneFilter() {
3219 return new Intent(this, false);
3220 }
3221
3222 /**
3223 * Create an intent with a given action. All other fields (data, type,
3224 * class) are null. Note that the action <em>must</em> be in a
3225 * namespace because Intents are used globally in the system -- for
3226 * example the system VIEW action is android.intent.action.VIEW; an
3227 * application's custom action would be something like
3228 * com.google.app.myapp.CUSTOM_ACTION.
3229 *
3230 * @param action The Intent action, such as ACTION_VIEW.
3231 */
3232 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003233 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003234 }
3235
3236 /**
3237 * Create an intent with a given action and for a given data url. Note
3238 * that the action <em>must</em> be in a namespace because Intents are
3239 * used globally in the system -- for example the system VIEW action is
3240 * android.intent.action.VIEW; an application's custom action would be
3241 * something like com.google.app.myapp.CUSTOM_ACTION.
3242 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003243 * <p><em>Note: scheme and host name matching in the Android framework is
3244 * case-sensitive, unlike the formal RFC. As a result,
3245 * you should always ensure that you write your Uri with these elements
3246 * using lower case letters, and normalize any Uris you receive from
3247 * outside of Android to ensure the scheme and host is lower case.</em></p>
3248 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003249 * @param action The Intent action, such as ACTION_VIEW.
3250 * @param uri The Intent data URI.
3251 */
3252 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003253 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003254 mData = uri;
3255 }
3256
3257 /**
3258 * Create an intent for a specific component. All other fields (action, data,
3259 * type, class) are null, though they can be modified later with explicit
3260 * calls. This provides a convenient way to create an intent that is
3261 * intended to execute a hard-coded class name, rather than relying on the
3262 * system to find an appropriate class for you; see {@link #setComponent}
3263 * for more information on the repercussions of this.
3264 *
3265 * @param packageContext A Context of the application package implementing
3266 * this class.
3267 * @param cls The component class that is to be used for the intent.
3268 *
3269 * @see #setClass
3270 * @see #setComponent
3271 * @see #Intent(String, android.net.Uri , Context, Class)
3272 */
3273 public Intent(Context packageContext, Class<?> cls) {
3274 mComponent = new ComponentName(packageContext, cls);
3275 }
3276
3277 /**
3278 * Create an intent for a specific component with a specified action and data.
3279 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3280 * construct the Intent and then calling {@link #setClass} to set its
3281 * class.
3282 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003283 * <p><em>Note: scheme and host name matching in the Android framework is
3284 * case-sensitive, unlike the formal RFC. As a result,
3285 * you should always ensure that you write your Uri with these elements
3286 * using lower case letters, and normalize any Uris you receive from
3287 * outside of Android to ensure the scheme and host is lower case.</em></p>
3288 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003289 * @param action The Intent action, such as ACTION_VIEW.
3290 * @param uri The Intent data URI.
3291 * @param packageContext A Context of the application package implementing
3292 * this class.
3293 * @param cls The component class that is to be used for the intent.
3294 *
3295 * @see #Intent(String, android.net.Uri)
3296 * @see #Intent(Context, Class)
3297 * @see #setClass
3298 * @see #setComponent
3299 */
3300 public Intent(String action, Uri uri,
3301 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003302 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003303 mData = uri;
3304 mComponent = new ComponentName(packageContext, cls);
3305 }
3306
3307 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003308 * Create an intent to launch the main (root) activity of a task. This
3309 * is the Intent that is started when the application's is launched from
3310 * Home. For anything else that wants to launch an application in the
3311 * same way, it is important that they use an Intent structured the same
3312 * way, and can use this function to ensure this is the case.
3313 *
3314 * <p>The returned Intent has the given Activity component as its explicit
3315 * component, {@link #ACTION_MAIN} as its action, and includes the
3316 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3317 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3318 * to do that through {@link #addFlags(int)} on the returned Intent.
3319 *
3320 * @param mainActivity The main activity component that this Intent will
3321 * launch.
3322 * @return Returns a newly created Intent that can be used to launch the
3323 * activity as a main application entry.
3324 *
3325 * @see #setClass
3326 * @see #setComponent
3327 */
3328 public static Intent makeMainActivity(ComponentName mainActivity) {
3329 Intent intent = new Intent(ACTION_MAIN);
3330 intent.setComponent(mainActivity);
3331 intent.addCategory(CATEGORY_LAUNCHER);
3332 return intent;
3333 }
3334
3335 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003336 * Make an Intent for the main activity of an application, without
3337 * specifying a specific activity to run but giving a selector to find
3338 * the activity. This results in a final Intent that is structured
3339 * the same as when the application is launched from
3340 * Home. For anything else that wants to launch an application in the
3341 * same way, it is important that they use an Intent structured the same
3342 * way, and can use this function to ensure this is the case.
3343 *
3344 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3345 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3346 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3347 * to do that through {@link #addFlags(int)} on the returned Intent.
3348 *
3349 * @param selectorAction The action name of the Intent's selector.
3350 * @param selectorCategory The name of a category to add to the Intent's
3351 * selector.
3352 * @return Returns a newly created Intent that can be used to launch the
3353 * activity as a main application entry.
3354 *
3355 * @see #setSelector(Intent)
3356 */
3357 public static Intent makeMainSelectorActivity(String selectorAction,
3358 String selectorCategory) {
3359 Intent intent = new Intent(ACTION_MAIN);
3360 intent.addCategory(CATEGORY_LAUNCHER);
3361 Intent selector = new Intent();
3362 selector.setAction(selectorAction);
3363 selector.addCategory(selectorCategory);
3364 intent.setSelector(selector);
3365 return intent;
3366 }
3367
3368 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003369 * Make an Intent that can be used to re-launch an application's task
3370 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3371 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3372 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3373 *
3374 * @param mainActivity The activity component that is the root of the
3375 * task; this is the activity that has been published in the application's
3376 * manifest as the main launcher icon.
3377 *
3378 * @return Returns a newly created Intent that can be used to relaunch the
3379 * activity's task in its root state.
3380 */
3381 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3382 Intent intent = makeMainActivity(mainActivity);
3383 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3384 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3385 return intent;
3386 }
3387
3388 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003389 * Call {@link #parseUri} with 0 flags.
3390 * @deprecated Use {@link #parseUri} instead.
3391 */
3392 @Deprecated
3393 public static Intent getIntent(String uri) throws URISyntaxException {
3394 return parseUri(uri, 0);
3395 }
Tom Taylord4a47292009-12-21 13:59:18 -08003396
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003397 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003398 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003399 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003400 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003401 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003402 *
3403 * <p>The URI given here must not be relative -- that is, it must include
3404 * the scheme and full path.
3405 *
3406 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003407 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003408 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003409 *
3410 * @return Intent The newly created Intent object.
3411 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003412 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3413 * it bad (as parsed by the Uri class) or the Intent data within the
3414 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003415 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003416 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003417 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003418 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003419 int i = 0;
3420 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003421 // Validate intent scheme for if requested.
3422 if ((flags&URI_INTENT_SCHEME) != 0) {
3423 if (!uri.startsWith("intent:")) {
3424 Intent intent = new Intent(ACTION_VIEW);
3425 try {
3426 intent.setData(Uri.parse(uri));
3427 } catch (IllegalArgumentException e) {
3428 throw new URISyntaxException(uri, e.getMessage());
3429 }
3430 return intent;
3431 }
3432 }
Tom Taylord4a47292009-12-21 13:59:18 -08003433
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003434 // simple case
3435 i = uri.lastIndexOf("#");
3436 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3437
3438 // old format Intent URI
3439 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003440
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003441 // new format
3442 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003443 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003444
3445 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003446 String data = i >= 0 ? uri.substring(0, i) : null;
3447 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003448 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003449
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003450 // loop over contents of Intent, all name=value;
3451 while (!uri.startsWith("end", i)) {
3452 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003453 if (eq < 0) eq = i-1;
3454 int semi = uri.indexOf(';', i);
3455 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003456
3457 // action
3458 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003459 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003460 }
3461
3462 // categories
3463 else if (uri.startsWith("category=", i)) {
3464 intent.addCategory(value);
3465 }
3466
3467 // type
3468 else if (uri.startsWith("type=", i)) {
3469 intent.mType = value;
3470 }
3471
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003472 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003473 else if (uri.startsWith("launchFlags=", i)) {
3474 intent.mFlags = Integer.decode(value).intValue();
3475 }
3476
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003477 // package
3478 else if (uri.startsWith("package=", i)) {
3479 intent.mPackage = value;
3480 }
3481
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003482 // component
3483 else if (uri.startsWith("component=", i)) {
3484 intent.mComponent = ComponentName.unflattenFromString(value);
3485 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003486
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003487 // scheme
3488 else if (uri.startsWith("scheme=", i)) {
3489 scheme = value;
3490 }
3491
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003492 // source bounds
3493 else if (uri.startsWith("sourceBounds=", i)) {
3494 intent.mSourceBounds = Rect.unflattenFromString(value);
3495 }
3496
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003497 // selector
3498 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3499 intent = new Intent();
3500 }
3501
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003502 // extra
3503 else {
3504 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003505 // create Bundle if it doesn't already exist
3506 if (intent.mExtras == null) intent.mExtras = new Bundle();
3507 Bundle b = intent.mExtras;
3508 // add EXTRA
3509 if (uri.startsWith("S.", i)) b.putString(key, value);
3510 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3511 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3512 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3513 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3514 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3515 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3516 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3517 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3518 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3519 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003520
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003521 // move to the next item
3522 i = semi + 1;
3523 }
3524
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003525 if (intent != baseIntent) {
3526 // The Intent had a selector; fix it up.
3527 baseIntent.setSelector(intent);
3528 intent = baseIntent;
3529 }
3530
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003531 if (data != null) {
3532 if (data.startsWith("intent:")) {
3533 data = data.substring(7);
3534 if (scheme != null) {
3535 data = scheme + ':' + data;
3536 }
3537 }
Tom Taylord4a47292009-12-21 13:59:18 -08003538
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003539 if (data.length() > 0) {
3540 try {
3541 intent.mData = Uri.parse(data);
3542 } catch (IllegalArgumentException e) {
3543 throw new URISyntaxException(uri, e.getMessage());
3544 }
3545 }
3546 }
Tom Taylord4a47292009-12-21 13:59:18 -08003547
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003548 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003549
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003550 } catch (IndexOutOfBoundsException e) {
3551 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3552 }
3553 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003554
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003555 public static Intent getIntentOld(String uri) throws URISyntaxException {
3556 Intent intent;
3557
3558 int i = uri.lastIndexOf('#');
3559 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003560 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003561 final int intentFragmentStart = i;
3562 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003563
3564 i++;
3565
3566 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003567 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003568 i += 7;
3569 int j = uri.indexOf(')', i);
3570 action = uri.substring(i, j);
3571 i = j + 1;
3572 }
3573
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003574 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003575
3576 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003577 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003578 i += 11;
3579 int j = uri.indexOf(')', i);
3580 while (i < j) {
3581 int sep = uri.indexOf('!', i);
3582 if (sep < 0) sep = j;
3583 if (i < sep) {
3584 intent.addCategory(uri.substring(i, sep));
3585 }
3586 i = sep + 1;
3587 }
3588 i = j + 1;
3589 }
3590
3591 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003592 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003593 i += 5;
3594 int j = uri.indexOf(')', i);
3595 intent.mType = uri.substring(i, j);
3596 i = j + 1;
3597 }
3598
3599 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003600 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003601 i += 12;
3602 int j = uri.indexOf(')', i);
3603 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3604 i = j + 1;
3605 }
3606
3607 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003608 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003609 i += 10;
3610 int j = uri.indexOf(')', i);
3611 int sep = uri.indexOf('!', i);
3612 if (sep >= 0 && sep < j) {
3613 String pkg = uri.substring(i, sep);
3614 String cls = uri.substring(sep + 1, j);
3615 intent.mComponent = new ComponentName(pkg, cls);
3616 }
3617 i = j + 1;
3618 }
3619
3620 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003621 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003622 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003624 final int closeParen = uri.indexOf(')', i);
3625 if (closeParen == -1) throw new URISyntaxException(uri,
3626 "EXTRA missing trailing ')'", i);
3627
3628 while (i < closeParen) {
3629 // fetch the key value
3630 int j = uri.indexOf('=', i);
3631 if (j <= i + 1 || i >= closeParen) {
3632 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3633 }
3634 char type = uri.charAt(i);
3635 i++;
3636 String key = uri.substring(i, j);
3637 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003638
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003639 // get type-value
3640 j = uri.indexOf('!', i);
3641 if (j == -1 || j >= closeParen) j = closeParen;
3642 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3643 String value = uri.substring(i, j);
3644 i = j;
3645
3646 // create Bundle if it doesn't already exist
3647 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003649 // add item to bundle
3650 try {
3651 switch (type) {
3652 case 'S':
3653 intent.mExtras.putString(key, Uri.decode(value));
3654 break;
3655 case 'B':
3656 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3657 break;
3658 case 'b':
3659 intent.mExtras.putByte(key, Byte.parseByte(value));
3660 break;
3661 case 'c':
3662 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3663 break;
3664 case 'd':
3665 intent.mExtras.putDouble(key, Double.parseDouble(value));
3666 break;
3667 case 'f':
3668 intent.mExtras.putFloat(key, Float.parseFloat(value));
3669 break;
3670 case 'i':
3671 intent.mExtras.putInt(key, Integer.parseInt(value));
3672 break;
3673 case 'l':
3674 intent.mExtras.putLong(key, Long.parseLong(value));
3675 break;
3676 case 's':
3677 intent.mExtras.putShort(key, Short.parseShort(value));
3678 break;
3679 default:
3680 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3681 }
3682 } catch (NumberFormatException e) {
3683 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3684 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003685
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003686 char ch = uri.charAt(i);
3687 if (ch == ')') break;
3688 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3689 i++;
3690 }
3691 }
3692
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003693 if (isIntentFragment) {
3694 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3695 } else {
3696 intent.mData = Uri.parse(uri);
3697 }
Tom Taylord4a47292009-12-21 13:59:18 -08003698
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003699 if (intent.mAction == null) {
3700 // By default, if no action is specified, then use VIEW.
3701 intent.mAction = ACTION_VIEW;
3702 }
3703
3704 } else {
3705 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3706 }
3707
3708 return intent;
3709 }
3710
3711 /**
3712 * Retrieve the general action to be performed, such as
3713 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3714 * the information in the intent should be interpreted -- most importantly,
3715 * what to do with the data returned by {@link #getData}.
3716 *
3717 * @return The action of this intent or null if none is specified.
3718 *
3719 * @see #setAction
3720 */
3721 public String getAction() {
3722 return mAction;
3723 }
3724
3725 /**
3726 * Retrieve data this intent is operating on. This URI specifies the name
3727 * of the data; often it uses the content: scheme, specifying data in a
3728 * content provider. Other schemes may be handled by specific activities,
3729 * such as http: by the web browser.
3730 *
3731 * @return The URI of the data this intent is targeting or null.
3732 *
3733 * @see #getScheme
3734 * @see #setData
3735 */
3736 public Uri getData() {
3737 return mData;
3738 }
3739
3740 /**
3741 * The same as {@link #getData()}, but returns the URI as an encoded
3742 * String.
3743 */
3744 public String getDataString() {
3745 return mData != null ? mData.toString() : null;
3746 }
3747
3748 /**
3749 * Return the scheme portion of the intent's data. If the data is null or
3750 * does not include a scheme, null is returned. Otherwise, the scheme
3751 * prefix without the final ':' is returned, i.e. "http".
3752 *
3753 * <p>This is the same as calling getData().getScheme() (and checking for
3754 * null data).
3755 *
3756 * @return The scheme of this intent.
3757 *
3758 * @see #getData
3759 */
3760 public String getScheme() {
3761 return mData != null ? mData.getScheme() : null;
3762 }
3763
3764 /**
3765 * Retrieve any explicit MIME type included in the intent. This is usually
3766 * null, as the type is determined by the intent data.
3767 *
3768 * @return If a type was manually set, it is returned; else null is
3769 * returned.
3770 *
3771 * @see #resolveType(ContentResolver)
3772 * @see #setType
3773 */
3774 public String getType() {
3775 return mType;
3776 }
3777
3778 /**
3779 * Return the MIME data type of this intent. If the type field is
3780 * explicitly set, that is simply returned. Otherwise, if the data is set,
3781 * the type of that data is returned. If neither fields are set, a null is
3782 * returned.
3783 *
3784 * @return The MIME type of this intent.
3785 *
3786 * @see #getType
3787 * @see #resolveType(ContentResolver)
3788 */
3789 public String resolveType(Context context) {
3790 return resolveType(context.getContentResolver());
3791 }
3792
3793 /**
3794 * Return the MIME data type of this intent. If the type field is
3795 * explicitly set, that is simply returned. Otherwise, if the data is set,
3796 * the type of that data is returned. If neither fields are set, a null is
3797 * returned.
3798 *
3799 * @param resolver A ContentResolver that can be used to determine the MIME
3800 * type of the intent's data.
3801 *
3802 * @return The MIME type of this intent.
3803 *
3804 * @see #getType
3805 * @see #resolveType(Context)
3806 */
3807 public String resolveType(ContentResolver resolver) {
3808 if (mType != null) {
3809 return mType;
3810 }
3811 if (mData != null) {
3812 if ("content".equals(mData.getScheme())) {
3813 return resolver.getType(mData);
3814 }
3815 }
3816 return null;
3817 }
3818
3819 /**
3820 * Return the MIME data type of this intent, only if it will be needed for
3821 * intent resolution. This is not generally useful for application code;
3822 * it is used by the frameworks for communicating with back-end system
3823 * services.
3824 *
3825 * @param resolver A ContentResolver that can be used to determine the MIME
3826 * type of the intent's data.
3827 *
3828 * @return The MIME type of this intent, or null if it is unknown or not
3829 * needed.
3830 */
3831 public String resolveTypeIfNeeded(ContentResolver resolver) {
3832 if (mComponent != null) {
3833 return mType;
3834 }
3835 return resolveType(resolver);
3836 }
3837
3838 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003839 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003840 *
3841 * @param category The category to check.
3842 *
3843 * @return boolean True if the intent contains the category, else false.
3844 *
3845 * @see #getCategories
3846 * @see #addCategory
3847 */
3848 public boolean hasCategory(String category) {
3849 return mCategories != null && mCategories.contains(category);
3850 }
3851
3852 /**
3853 * Return the set of all categories in the intent. If there are no categories,
3854 * returns NULL.
3855 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003856 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003857 *
3858 * @see #hasCategory
3859 * @see #addCategory
3860 */
3861 public Set<String> getCategories() {
3862 return mCategories;
3863 }
3864
3865 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003866 * Return the specific selector associated with this Intent. If there is
3867 * none, returns null. See {@link #setSelector} for more information.
3868 *
3869 * @see #setSelector
3870 */
3871 public Intent getSelector() {
3872 return mSelector;
3873 }
3874
3875 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003876 * Return the {@link ClipData} associated with this Intent. If there is
3877 * none, returns null. See {@link #setClipData} for more information.
3878 *
3879 * @see #setClipData;
3880 */
3881 public ClipData getClipData() {
3882 return mClipData;
3883 }
3884
3885 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003886 * Sets the ClassLoader that will be used when unmarshalling
3887 * any Parcelable values from the extras of this Intent.
3888 *
3889 * @param loader a ClassLoader, or null to use the default loader
3890 * at the time of unmarshalling.
3891 */
3892 public void setExtrasClassLoader(ClassLoader loader) {
3893 if (mExtras != null) {
3894 mExtras.setClassLoader(loader);
3895 }
3896 }
3897
3898 /**
3899 * Returns true if an extra value is associated with the given name.
3900 * @param name the extra's name
3901 * @return true if the given extra is present.
3902 */
3903 public boolean hasExtra(String name) {
3904 return mExtras != null && mExtras.containsKey(name);
3905 }
3906
3907 /**
3908 * Returns true if the Intent's extras contain a parcelled file descriptor.
3909 * @return true if the Intent contains a parcelled file descriptor.
3910 */
3911 public boolean hasFileDescriptors() {
3912 return mExtras != null && mExtras.hasFileDescriptors();
3913 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003914
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003915 /** @hide */
3916 public void setAllowFds(boolean allowFds) {
3917 if (mExtras != null) {
3918 mExtras.setAllowFds(allowFds);
3919 }
3920 }
3921
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003922 /**
3923 * Retrieve extended data from the intent.
3924 *
3925 * @param name The name of the desired item.
3926 *
3927 * @return the value of an item that previously added with putExtra()
3928 * or null if none was found.
3929 *
3930 * @deprecated
3931 * @hide
3932 */
3933 @Deprecated
3934 public Object getExtra(String name) {
3935 return getExtra(name, null);
3936 }
3937
3938 /**
3939 * Retrieve extended data from the intent.
3940 *
3941 * @param name The name of the desired item.
3942 * @param defaultValue the value to be returned if no value of the desired
3943 * type is stored with the given name.
3944 *
3945 * @return the value of an item that previously added with putExtra()
3946 * or the default value if none was found.
3947 *
3948 * @see #putExtra(String, boolean)
3949 */
3950 public boolean getBooleanExtra(String name, boolean defaultValue) {
3951 return mExtras == null ? defaultValue :
3952 mExtras.getBoolean(name, defaultValue);
3953 }
3954
3955 /**
3956 * Retrieve extended data from the intent.
3957 *
3958 * @param name The name of the desired item.
3959 * @param defaultValue the value to be returned if no value of the desired
3960 * type is stored with the given name.
3961 *
3962 * @return the value of an item that previously added with putExtra()
3963 * or the default value if none was found.
3964 *
3965 * @see #putExtra(String, byte)
3966 */
3967 public byte getByteExtra(String name, byte defaultValue) {
3968 return mExtras == null ? defaultValue :
3969 mExtras.getByte(name, defaultValue);
3970 }
3971
3972 /**
3973 * Retrieve extended data from the intent.
3974 *
3975 * @param name The name of the desired item.
3976 * @param defaultValue the value to be returned if no value of the desired
3977 * type is stored with the given name.
3978 *
3979 * @return the value of an item that previously added with putExtra()
3980 * or the default value if none was found.
3981 *
3982 * @see #putExtra(String, short)
3983 */
3984 public short getShortExtra(String name, short defaultValue) {
3985 return mExtras == null ? defaultValue :
3986 mExtras.getShort(name, defaultValue);
3987 }
3988
3989 /**
3990 * Retrieve extended data from the intent.
3991 *
3992 * @param name The name of the desired item.
3993 * @param defaultValue the value to be returned if no value of the desired
3994 * type is stored with the given name.
3995 *
3996 * @return the value of an item that previously added with putExtra()
3997 * or the default value if none was found.
3998 *
3999 * @see #putExtra(String, char)
4000 */
4001 public char getCharExtra(String name, char defaultValue) {
4002 return mExtras == null ? defaultValue :
4003 mExtras.getChar(name, defaultValue);
4004 }
4005
4006 /**
4007 * Retrieve extended data from the intent.
4008 *
4009 * @param name The name of the desired item.
4010 * @param defaultValue the value to be returned if no value of the desired
4011 * type is stored with the given name.
4012 *
4013 * @return the value of an item that previously added with putExtra()
4014 * or the default value if none was found.
4015 *
4016 * @see #putExtra(String, int)
4017 */
4018 public int getIntExtra(String name, int defaultValue) {
4019 return mExtras == null ? defaultValue :
4020 mExtras.getInt(name, defaultValue);
4021 }
4022
4023 /**
4024 * Retrieve extended data from the intent.
4025 *
4026 * @param name The name of the desired item.
4027 * @param defaultValue the value to be returned if no value of the desired
4028 * type is stored with the given name.
4029 *
4030 * @return the value of an item that previously added with putExtra()
4031 * or the default value if none was found.
4032 *
4033 * @see #putExtra(String, long)
4034 */
4035 public long getLongExtra(String name, long defaultValue) {
4036 return mExtras == null ? defaultValue :
4037 mExtras.getLong(name, defaultValue);
4038 }
4039
4040 /**
4041 * Retrieve extended data from the intent.
4042 *
4043 * @param name The name of the desired item.
4044 * @param defaultValue the value to be returned if no value of the desired
4045 * type is stored with the given name.
4046 *
4047 * @return the value of an item that previously added with putExtra(),
4048 * or the default value if no such item is present
4049 *
4050 * @see #putExtra(String, float)
4051 */
4052 public float getFloatExtra(String name, float defaultValue) {
4053 return mExtras == null ? defaultValue :
4054 mExtras.getFloat(name, defaultValue);
4055 }
4056
4057 /**
4058 * Retrieve extended data from the intent.
4059 *
4060 * @param name The name of the desired item.
4061 * @param defaultValue the value to be returned if no value of the desired
4062 * type is stored with the given name.
4063 *
4064 * @return the value of an item that previously added with putExtra()
4065 * or the default value if none was found.
4066 *
4067 * @see #putExtra(String, double)
4068 */
4069 public double getDoubleExtra(String name, double defaultValue) {
4070 return mExtras == null ? defaultValue :
4071 mExtras.getDouble(name, defaultValue);
4072 }
4073
4074 /**
4075 * Retrieve extended data from the intent.
4076 *
4077 * @param name The name of the desired item.
4078 *
4079 * @return the value of an item that previously added with putExtra()
4080 * or null if no String value was found.
4081 *
4082 * @see #putExtra(String, String)
4083 */
4084 public String getStringExtra(String name) {
4085 return mExtras == null ? null : mExtras.getString(name);
4086 }
4087
4088 /**
4089 * Retrieve extended data from the intent.
4090 *
4091 * @param name The name of the desired item.
4092 *
4093 * @return the value of an item that previously added with putExtra()
4094 * or null if no CharSequence value was found.
4095 *
4096 * @see #putExtra(String, CharSequence)
4097 */
4098 public CharSequence getCharSequenceExtra(String name) {
4099 return mExtras == null ? null : mExtras.getCharSequence(name);
4100 }
4101
4102 /**
4103 * Retrieve extended data from the intent.
4104 *
4105 * @param name The name of the desired item.
4106 *
4107 * @return the value of an item that previously added with putExtra()
4108 * or null if no Parcelable value was found.
4109 *
4110 * @see #putExtra(String, Parcelable)
4111 */
4112 public <T extends Parcelable> T getParcelableExtra(String name) {
4113 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4114 }
4115
4116 /**
4117 * Retrieve extended data from the intent.
4118 *
4119 * @param name The name of the desired item.
4120 *
4121 * @return the value of an item that previously added with putExtra()
4122 * or null if no Parcelable[] value was found.
4123 *
4124 * @see #putExtra(String, Parcelable[])
4125 */
4126 public Parcelable[] getParcelableArrayExtra(String name) {
4127 return mExtras == null ? null : mExtras.getParcelableArray(name);
4128 }
4129
4130 /**
4131 * Retrieve extended data from the intent.
4132 *
4133 * @param name The name of the desired item.
4134 *
4135 * @return the value of an item that previously added with putExtra()
4136 * or null if no ArrayList<Parcelable> value was found.
4137 *
4138 * @see #putParcelableArrayListExtra(String, ArrayList)
4139 */
4140 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4141 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4142 }
4143
4144 /**
4145 * Retrieve extended data from the intent.
4146 *
4147 * @param name The name of the desired item.
4148 *
4149 * @return the value of an item that previously added with putExtra()
4150 * or null if no Serializable value was found.
4151 *
4152 * @see #putExtra(String, Serializable)
4153 */
4154 public Serializable getSerializableExtra(String name) {
4155 return mExtras == null ? null : mExtras.getSerializable(name);
4156 }
4157
4158 /**
4159 * Retrieve extended data from the intent.
4160 *
4161 * @param name The name of the desired item.
4162 *
4163 * @return the value of an item that previously added with putExtra()
4164 * or null if no ArrayList<Integer> value was found.
4165 *
4166 * @see #putIntegerArrayListExtra(String, ArrayList)
4167 */
4168 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4169 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4170 }
4171
4172 /**
4173 * Retrieve extended data from the intent.
4174 *
4175 * @param name The name of the desired item.
4176 *
4177 * @return the value of an item that previously added with putExtra()
4178 * or null if no ArrayList<String> value was found.
4179 *
4180 * @see #putStringArrayListExtra(String, ArrayList)
4181 */
4182 public ArrayList<String> getStringArrayListExtra(String name) {
4183 return mExtras == null ? null : mExtras.getStringArrayList(name);
4184 }
4185
4186 /**
4187 * Retrieve extended data from the intent.
4188 *
4189 * @param name The name of the desired item.
4190 *
4191 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004192 * or null if no ArrayList<CharSequence> value was found.
4193 *
4194 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4195 */
4196 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4197 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4198 }
4199
4200 /**
4201 * Retrieve extended data from the intent.
4202 *
4203 * @param name The name of the desired item.
4204 *
4205 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004206 * or null if no boolean array value was found.
4207 *
4208 * @see #putExtra(String, boolean[])
4209 */
4210 public boolean[] getBooleanArrayExtra(String name) {
4211 return mExtras == null ? null : mExtras.getBooleanArray(name);
4212 }
4213
4214 /**
4215 * Retrieve extended data from the intent.
4216 *
4217 * @param name The name of the desired item.
4218 *
4219 * @return the value of an item that previously added with putExtra()
4220 * or null if no byte array value was found.
4221 *
4222 * @see #putExtra(String, byte[])
4223 */
4224 public byte[] getByteArrayExtra(String name) {
4225 return mExtras == null ? null : mExtras.getByteArray(name);
4226 }
4227
4228 /**
4229 * Retrieve extended data from the intent.
4230 *
4231 * @param name The name of the desired item.
4232 *
4233 * @return the value of an item that previously added with putExtra()
4234 * or null if no short array value was found.
4235 *
4236 * @see #putExtra(String, short[])
4237 */
4238 public short[] getShortArrayExtra(String name) {
4239 return mExtras == null ? null : mExtras.getShortArray(name);
4240 }
4241
4242 /**
4243 * Retrieve extended data from the intent.
4244 *
4245 * @param name The name of the desired item.
4246 *
4247 * @return the value of an item that previously added with putExtra()
4248 * or null if no char array value was found.
4249 *
4250 * @see #putExtra(String, char[])
4251 */
4252 public char[] getCharArrayExtra(String name) {
4253 return mExtras == null ? null : mExtras.getCharArray(name);
4254 }
4255
4256 /**
4257 * Retrieve extended data from the intent.
4258 *
4259 * @param name The name of the desired item.
4260 *
4261 * @return the value of an item that previously added with putExtra()
4262 * or null if no int array value was found.
4263 *
4264 * @see #putExtra(String, int[])
4265 */
4266 public int[] getIntArrayExtra(String name) {
4267 return mExtras == null ? null : mExtras.getIntArray(name);
4268 }
4269
4270 /**
4271 * Retrieve extended data from the intent.
4272 *
4273 * @param name The name of the desired item.
4274 *
4275 * @return the value of an item that previously added with putExtra()
4276 * or null if no long array value was found.
4277 *
4278 * @see #putExtra(String, long[])
4279 */
4280 public long[] getLongArrayExtra(String name) {
4281 return mExtras == null ? null : mExtras.getLongArray(name);
4282 }
4283
4284 /**
4285 * Retrieve extended data from the intent.
4286 *
4287 * @param name The name of the desired item.
4288 *
4289 * @return the value of an item that previously added with putExtra()
4290 * or null if no float array value was found.
4291 *
4292 * @see #putExtra(String, float[])
4293 */
4294 public float[] getFloatArrayExtra(String name) {
4295 return mExtras == null ? null : mExtras.getFloatArray(name);
4296 }
4297
4298 /**
4299 * Retrieve extended data from the intent.
4300 *
4301 * @param name The name of the desired item.
4302 *
4303 * @return the value of an item that previously added with putExtra()
4304 * or null if no double array value was found.
4305 *
4306 * @see #putExtra(String, double[])
4307 */
4308 public double[] getDoubleArrayExtra(String name) {
4309 return mExtras == null ? null : mExtras.getDoubleArray(name);
4310 }
4311
4312 /**
4313 * Retrieve extended data from the intent.
4314 *
4315 * @param name The name of the desired item.
4316 *
4317 * @return the value of an item that previously added with putExtra()
4318 * or null if no String array value was found.
4319 *
4320 * @see #putExtra(String, String[])
4321 */
4322 public String[] getStringArrayExtra(String name) {
4323 return mExtras == null ? null : mExtras.getStringArray(name);
4324 }
4325
4326 /**
4327 * Retrieve extended data from the intent.
4328 *
4329 * @param name The name of the desired item.
4330 *
4331 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004332 * or null if no CharSequence array value was found.
4333 *
4334 * @see #putExtra(String, CharSequence[])
4335 */
4336 public CharSequence[] getCharSequenceArrayExtra(String name) {
4337 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4338 }
4339
4340 /**
4341 * Retrieve extended data from the intent.
4342 *
4343 * @param name The name of the desired item.
4344 *
4345 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004346 * or null if no Bundle value was found.
4347 *
4348 * @see #putExtra(String, Bundle)
4349 */
4350 public Bundle getBundleExtra(String name) {
4351 return mExtras == null ? null : mExtras.getBundle(name);
4352 }
4353
4354 /**
4355 * Retrieve extended data from the intent.
4356 *
4357 * @param name The name of the desired item.
4358 *
4359 * @return the value of an item that previously added with putExtra()
4360 * or null if no IBinder value was found.
4361 *
4362 * @see #putExtra(String, IBinder)
4363 *
4364 * @deprecated
4365 * @hide
4366 */
4367 @Deprecated
4368 public IBinder getIBinderExtra(String name) {
4369 return mExtras == null ? null : mExtras.getIBinder(name);
4370 }
4371
4372 /**
4373 * Retrieve extended data from the intent.
4374 *
4375 * @param name The name of the desired item.
4376 * @param defaultValue The default value to return in case no item is
4377 * associated with the key 'name'
4378 *
4379 * @return the value of an item that previously added with putExtra()
4380 * or defaultValue if none was found.
4381 *
4382 * @see #putExtra
4383 *
4384 * @deprecated
4385 * @hide
4386 */
4387 @Deprecated
4388 public Object getExtra(String name, Object defaultValue) {
4389 Object result = defaultValue;
4390 if (mExtras != null) {
4391 Object result2 = mExtras.get(name);
4392 if (result2 != null) {
4393 result = result2;
4394 }
4395 }
4396
4397 return result;
4398 }
4399
4400 /**
4401 * Retrieves a map of extended data from the intent.
4402 *
4403 * @return the map of all extras previously added with putExtra(),
4404 * or null if none have been added.
4405 */
4406 public Bundle getExtras() {
4407 return (mExtras != null)
4408 ? new Bundle(mExtras)
4409 : null;
4410 }
4411
4412 /**
4413 * Retrieve any special flags associated with this intent. You will
4414 * normally just set them with {@link #setFlags} and let the system
4415 * take the appropriate action with them.
4416 *
4417 * @return int The currently set flags.
4418 *
4419 * @see #setFlags
4420 */
4421 public int getFlags() {
4422 return mFlags;
4423 }
4424
Dianne Hackborne7f97212011-02-24 14:40:20 -08004425 /** @hide */
4426 public boolean isExcludingStopped() {
4427 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4428 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4429 }
4430
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004431 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004432 * Retrieve the application package name this Intent is limited to. When
4433 * resolving an Intent, if non-null this limits the resolution to only
4434 * components in the given application package.
4435 *
4436 * @return The name of the application package for the Intent.
4437 *
4438 * @see #resolveActivity
4439 * @see #setPackage
4440 */
4441 public String getPackage() {
4442 return mPackage;
4443 }
4444
4445 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004446 * Retrieve the concrete component associated with the intent. When receiving
4447 * an intent, this is the component that was found to best handle it (that is,
4448 * yourself) and will always be non-null; in all other cases it will be
4449 * null unless explicitly set.
4450 *
4451 * @return The name of the application component to handle the intent.
4452 *
4453 * @see #resolveActivity
4454 * @see #setComponent
4455 */
4456 public ComponentName getComponent() {
4457 return mComponent;
4458 }
4459
4460 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004461 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4462 * used as a hint to the receiver for animations and the like. Null means that there
4463 * is no source bounds.
4464 */
4465 public Rect getSourceBounds() {
4466 return mSourceBounds;
4467 }
4468
4469 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004470 * Return the Activity component that should be used to handle this intent.
4471 * The appropriate component is determined based on the information in the
4472 * intent, evaluated as follows:
4473 *
4474 * <p>If {@link #getComponent} returns an explicit class, that is returned
4475 * without any further consideration.
4476 *
4477 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4478 * category to be considered.
4479 *
4480 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4481 * action.
4482 *
4483 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4484 * this type.
4485 *
4486 * <p>If {@link #addCategory} has added any categories, the activity must
4487 * handle ALL of the categories specified.
4488 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004489 * <p>If {@link #getPackage} is non-NULL, only activity components in
4490 * that application package will be considered.
4491 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004492 * <p>If there are no activities that satisfy all of these conditions, a
4493 * null string is returned.
4494 *
4495 * <p>If multiple activities are found to satisfy the intent, the one with
4496 * the highest priority will be used. If there are multiple activities
4497 * with the same priority, the system will either pick the best activity
4498 * based on user preference, or resolve to a system class that will allow
4499 * the user to pick an activity and forward from there.
4500 *
4501 * <p>This method is implemented simply by calling
4502 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4503 * true.</p>
4504 * <p> This API is called for you as part of starting an activity from an
4505 * intent. You do not normally need to call it yourself.</p>
4506 *
4507 * @param pm The package manager with which to resolve the Intent.
4508 *
4509 * @return Name of the component implementing an activity that can
4510 * display the intent.
4511 *
4512 * @see #setComponent
4513 * @see #getComponent
4514 * @see #resolveActivityInfo
4515 */
4516 public ComponentName resolveActivity(PackageManager pm) {
4517 if (mComponent != null) {
4518 return mComponent;
4519 }
4520
4521 ResolveInfo info = pm.resolveActivity(
4522 this, PackageManager.MATCH_DEFAULT_ONLY);
4523 if (info != null) {
4524 return new ComponentName(
4525 info.activityInfo.applicationInfo.packageName,
4526 info.activityInfo.name);
4527 }
4528
4529 return null;
4530 }
4531
4532 /**
4533 * Resolve the Intent into an {@link ActivityInfo}
4534 * describing the activity that should execute the intent. Resolution
4535 * follows the same rules as described for {@link #resolveActivity}, but
4536 * you get back the completely information about the resolved activity
4537 * instead of just its class name.
4538 *
4539 * @param pm The package manager with which to resolve the Intent.
4540 * @param flags Addition information to retrieve as per
4541 * {@link PackageManager#getActivityInfo(ComponentName, int)
4542 * PackageManager.getActivityInfo()}.
4543 *
4544 * @return PackageManager.ActivityInfo
4545 *
4546 * @see #resolveActivity
4547 */
4548 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4549 ActivityInfo ai = null;
4550 if (mComponent != null) {
4551 try {
4552 ai = pm.getActivityInfo(mComponent, flags);
4553 } catch (PackageManager.NameNotFoundException e) {
4554 // ignore
4555 }
4556 } else {
4557 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004558 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004559 if (info != null) {
4560 ai = info.activityInfo;
4561 }
4562 }
4563
4564 return ai;
4565 }
4566
4567 /**
4568 * Set the general action to be performed.
4569 *
4570 * @param action An action name, such as ACTION_VIEW. Application-specific
4571 * actions should be prefixed with the vendor's package name.
4572 *
4573 * @return Returns the same Intent object, for chaining multiple calls
4574 * into a single statement.
4575 *
4576 * @see #getAction
4577 */
4578 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004579 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004580 return this;
4581 }
4582
4583 /**
4584 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004585 * clears any type that was previously set by {@link #setType} or
4586 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004587 *
Nick Pellyccae4122012-01-09 14:12:58 -08004588 * <p><em>Note: scheme matching in the Android framework is
4589 * case-sensitive, unlike the formal RFC. As a result,
4590 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004591 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004592 * {@link #setDataAndNormalize}
4593 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004594 *
Nick Pellyccae4122012-01-09 14:12:58 -08004595 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004596 *
4597 * @return Returns the same Intent object, for chaining multiple calls
4598 * into a single statement.
4599 *
4600 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004601 * @see #setDataAndNormalize
4602 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004603 */
4604 public Intent setData(Uri data) {
4605 mData = data;
4606 mType = null;
4607 return this;
4608 }
4609
4610 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004611 * Normalize and set the data this intent is operating on.
4612 *
4613 * <p>This method automatically clears any type that was
4614 * previously set (for example, by {@link #setType}).
4615 *
4616 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004617 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004618 * so really this is just a convenience method for
4619 * <pre>
4620 * setData(data.normalize())
4621 * </pre>
4622 *
4623 * @param data The Uri of the data this intent is now targeting.
4624 *
4625 * @return Returns the same Intent object, for chaining multiple calls
4626 * into a single statement.
4627 *
4628 * @see #getData
4629 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004630 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004631 */
4632 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004633 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004634 }
4635
4636 /**
4637 * Set an explicit MIME data type.
4638 *
4639 * <p>This is used to create intents that only specify a type and not data,
4640 * for example to indicate the type of data to return.
4641 *
4642 * <p>This method automatically clears any data that was
4643 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004644 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004645 * <p><em>Note: MIME type matching in the Android framework is
4646 * case-sensitive, unlike formal RFC MIME types. As a result,
4647 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004648 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4649 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004650 *
4651 * @param type The MIME type of the data being handled by this intent.
4652 *
4653 * @return Returns the same Intent object, for chaining multiple calls
4654 * into a single statement.
4655 *
4656 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004657 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004658 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004659 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004660 */
4661 public Intent setType(String type) {
4662 mData = null;
4663 mType = type;
4664 return this;
4665 }
4666
4667 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004668 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004669 *
Nick Pellyccae4122012-01-09 14:12:58 -08004670 * <p>This is used to create intents that only specify a type and not data,
4671 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004672 *
Nick Pellyccae4122012-01-09 14:12:58 -08004673 * <p>This method automatically clears any data that was
4674 * previously set (for example by {@link #setData}).
4675 *
4676 * <p>The MIME type is normalized using
4677 * {@link #normalizeMimeType} before it is set,
4678 * so really this is just a convenience method for
4679 * <pre>
4680 * setType(Intent.normalizeMimeType(type))
4681 * </pre>
4682 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004683 * @param type The MIME type of the data being handled by this intent.
4684 *
4685 * @return Returns the same Intent object, for chaining multiple calls
4686 * into a single statement.
4687 *
Nick Pellyccae4122012-01-09 14:12:58 -08004688 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004689 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004690 * @see #normalizeMimeType
4691 */
4692 public Intent setTypeAndNormalize(String type) {
4693 return setType(normalizeMimeType(type));
4694 }
4695
4696 /**
4697 * (Usually optional) Set the data for the intent along with an explicit
4698 * MIME data type. This method should very rarely be used -- it allows you
4699 * to override the MIME type that would ordinarily be inferred from the
4700 * data with your own type given here.
4701 *
4702 * <p><em>Note: MIME type and Uri scheme matching in the
4703 * Android framework is case-sensitive, unlike the formal RFC definitions.
4704 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004705 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004706 * {@link #setDataAndTypeAndNormalize}
4707 * to ensure that they are converted to lower case.</em>
4708 *
4709 * @param data The Uri of the data this intent is now targeting.
4710 * @param type The MIME type of the data being handled by this intent.
4711 *
4712 * @return Returns the same Intent object, for chaining multiple calls
4713 * into a single statement.
4714 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004715 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004716 * @see #setData
4717 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004718 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004719 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004720 */
4721 public Intent setDataAndType(Uri data, String type) {
4722 mData = data;
4723 mType = type;
4724 return this;
4725 }
4726
4727 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004728 * (Usually optional) Normalize and set both the data Uri and an explicit
4729 * MIME data type. This method should very rarely be used -- it allows you
4730 * to override the MIME type that would ordinarily be inferred from the
4731 * data with your own type given here.
4732 *
4733 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004734 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004735 * before they are set, so really this is just a convenience method for
4736 * <pre>
4737 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4738 * </pre>
4739 *
4740 * @param data The Uri of the data this intent is now targeting.
4741 * @param type The MIME type of the data being handled by this intent.
4742 *
4743 * @return Returns the same Intent object, for chaining multiple calls
4744 * into a single statement.
4745 *
4746 * @see #setType
4747 * @see #setData
4748 * @see #setDataAndType
4749 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004750 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004751 */
4752 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004753 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004754 }
4755
4756 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004757 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004758 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004759 * activities that provide <em>all</em> of the requested categories will be
4760 * used.
4761 *
4762 * @param category The desired category. This can be either one of the
4763 * predefined Intent categories, or a custom category in your own
4764 * namespace.
4765 *
4766 * @return Returns the same Intent object, for chaining multiple calls
4767 * into a single statement.
4768 *
4769 * @see #hasCategory
4770 * @see #removeCategory
4771 */
4772 public Intent addCategory(String category) {
4773 if (mCategories == null) {
4774 mCategories = new HashSet<String>();
4775 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004776 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004777 return this;
4778 }
4779
4780 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004781 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004782 *
4783 * @param category The category to remove.
4784 *
4785 * @see #addCategory
4786 */
4787 public void removeCategory(String category) {
4788 if (mCategories != null) {
4789 mCategories.remove(category);
4790 if (mCategories.size() == 0) {
4791 mCategories = null;
4792 }
4793 }
4794 }
4795
4796 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004797 * Set a selector for this Intent. This is a modification to the kinds of
4798 * things the Intent will match. If the selector is set, it will be used
4799 * when trying to find entities that can handle the Intent, instead of the
4800 * main contents of the Intent. This allows you build an Intent containing
4801 * a generic protocol while targeting it more specifically.
4802 *
4803 * <p>An example of where this may be used is with things like
4804 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4805 * Intent that will launch the Browser application. However, the correct
4806 * main entry point of an application is actually {@link #ACTION_MAIN}
4807 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4808 * used to specify the actual Activity to launch. If you launch the browser
4809 * with something different, undesired behavior may happen if the user has
4810 * previously or later launches it the normal way, since they do not match.
4811 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4812 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4813 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4814 *
4815 * <p>Setting a selector does not impact the behavior of
4816 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4817 * desired behavior of a selector -- it does not impact the base meaning
4818 * of the Intent, just what kinds of things will be matched against it
4819 * when determining who can handle it.</p>
4820 *
4821 * <p>You can not use both a selector and {@link #setPackage(String)} on
4822 * the same base Intent.</p>
4823 *
4824 * @param selector The desired selector Intent; set to null to not use
4825 * a special selector.
4826 */
4827 public void setSelector(Intent selector) {
4828 if (selector == this) {
4829 throw new IllegalArgumentException(
4830 "Intent being set as a selector of itself");
4831 }
4832 if (selector != null && mPackage != null) {
4833 throw new IllegalArgumentException(
4834 "Can't set selector when package name is already set");
4835 }
4836 mSelector = selector;
4837 }
4838
4839 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004840 * Set a {@link ClipData} associated with this Intent. This replaces any
4841 * previously set ClipData.
4842 *
4843 * <p>The ClipData in an intent is not used for Intent matching or other
4844 * such operations. Semantically it is like extras, used to transmit
4845 * additional data with the Intent. The main feature of using this over
4846 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4847 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4848 * items included in the clip data. This is useful, in particular, if
4849 * you want to transmit an Intent containing multiple <code>content:</code>
4850 * URIs for which the recipient may not have global permission to access the
4851 * content provider.
4852 *
4853 * <p>If the ClipData contains items that are themselves Intents, any
4854 * grant flags in those Intents will be ignored. Only the top-level flags
4855 * of the main Intent are respected, and will be applied to all Uri or
4856 * Intent items in the clip (or sub-items of the clip).
4857 *
4858 * <p>The MIME type, label, and icon in the ClipData object are not
4859 * directly used by Intent. Applications should generally rely on the
4860 * MIME type of the Intent itself, not what it may find in the ClipData.
4861 * A common practice is to construct a ClipData for use with an Intent
4862 * with a MIME type of "*\/*".
4863 *
4864 * @param clip The new clip to set. May be null to clear the current clip.
4865 */
4866 public void setClipData(ClipData clip) {
4867 mClipData = clip;
4868 }
4869
4870 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004871 * Add extended data to the intent. The name must include a package
4872 * prefix, for example the app com.android.contacts would use names
4873 * like "com.android.contacts.ShowAll".
4874 *
4875 * @param name The name of the extra data, with package prefix.
4876 * @param value The boolean data value.
4877 *
4878 * @return Returns the same Intent object, for chaining multiple calls
4879 * into a single statement.
4880 *
4881 * @see #putExtras
4882 * @see #removeExtra
4883 * @see #getBooleanExtra(String, boolean)
4884 */
4885 public Intent putExtra(String name, boolean value) {
4886 if (mExtras == null) {
4887 mExtras = new Bundle();
4888 }
4889 mExtras.putBoolean(name, value);
4890 return this;
4891 }
4892
4893 /**
4894 * Add extended data to the intent. The name must include a package
4895 * prefix, for example the app com.android.contacts would use names
4896 * like "com.android.contacts.ShowAll".
4897 *
4898 * @param name The name of the extra data, with package prefix.
4899 * @param value The byte data value.
4900 *
4901 * @return Returns the same Intent object, for chaining multiple calls
4902 * into a single statement.
4903 *
4904 * @see #putExtras
4905 * @see #removeExtra
4906 * @see #getByteExtra(String, byte)
4907 */
4908 public Intent putExtra(String name, byte value) {
4909 if (mExtras == null) {
4910 mExtras = new Bundle();
4911 }
4912 mExtras.putByte(name, value);
4913 return this;
4914 }
4915
4916 /**
4917 * Add extended data to the intent. The name must include a package
4918 * prefix, for example the app com.android.contacts would use names
4919 * like "com.android.contacts.ShowAll".
4920 *
4921 * @param name The name of the extra data, with package prefix.
4922 * @param value The char data value.
4923 *
4924 * @return Returns the same Intent object, for chaining multiple calls
4925 * into a single statement.
4926 *
4927 * @see #putExtras
4928 * @see #removeExtra
4929 * @see #getCharExtra(String, char)
4930 */
4931 public Intent putExtra(String name, char value) {
4932 if (mExtras == null) {
4933 mExtras = new Bundle();
4934 }
4935 mExtras.putChar(name, value);
4936 return this;
4937 }
4938
4939 /**
4940 * Add extended data to the intent. The name must include a package
4941 * prefix, for example the app com.android.contacts would use names
4942 * like "com.android.contacts.ShowAll".
4943 *
4944 * @param name The name of the extra data, with package prefix.
4945 * @param value The short data value.
4946 *
4947 * @return Returns the same Intent object, for chaining multiple calls
4948 * into a single statement.
4949 *
4950 * @see #putExtras
4951 * @see #removeExtra
4952 * @see #getShortExtra(String, short)
4953 */
4954 public Intent putExtra(String name, short value) {
4955 if (mExtras == null) {
4956 mExtras = new Bundle();
4957 }
4958 mExtras.putShort(name, value);
4959 return this;
4960 }
4961
4962 /**
4963 * Add extended data to the intent. The name must include a package
4964 * prefix, for example the app com.android.contacts would use names
4965 * like "com.android.contacts.ShowAll".
4966 *
4967 * @param name The name of the extra data, with package prefix.
4968 * @param value The integer data value.
4969 *
4970 * @return Returns the same Intent object, for chaining multiple calls
4971 * into a single statement.
4972 *
4973 * @see #putExtras
4974 * @see #removeExtra
4975 * @see #getIntExtra(String, int)
4976 */
4977 public Intent putExtra(String name, int value) {
4978 if (mExtras == null) {
4979 mExtras = new Bundle();
4980 }
4981 mExtras.putInt(name, value);
4982 return this;
4983 }
4984
4985 /**
4986 * Add extended data to the intent. The name must include a package
4987 * prefix, for example the app com.android.contacts would use names
4988 * like "com.android.contacts.ShowAll".
4989 *
4990 * @param name The name of the extra data, with package prefix.
4991 * @param value The long data value.
4992 *
4993 * @return Returns the same Intent object, for chaining multiple calls
4994 * into a single statement.
4995 *
4996 * @see #putExtras
4997 * @see #removeExtra
4998 * @see #getLongExtra(String, long)
4999 */
5000 public Intent putExtra(String name, long value) {
5001 if (mExtras == null) {
5002 mExtras = new Bundle();
5003 }
5004 mExtras.putLong(name, value);
5005 return this;
5006 }
5007
5008 /**
5009 * Add extended data to the intent. The name must include a package
5010 * prefix, for example the app com.android.contacts would use names
5011 * like "com.android.contacts.ShowAll".
5012 *
5013 * @param name The name of the extra data, with package prefix.
5014 * @param value The float data value.
5015 *
5016 * @return Returns the same Intent object, for chaining multiple calls
5017 * into a single statement.
5018 *
5019 * @see #putExtras
5020 * @see #removeExtra
5021 * @see #getFloatExtra(String, float)
5022 */
5023 public Intent putExtra(String name, float value) {
5024 if (mExtras == null) {
5025 mExtras = new Bundle();
5026 }
5027 mExtras.putFloat(name, value);
5028 return this;
5029 }
5030
5031 /**
5032 * Add extended data to the intent. The name must include a package
5033 * prefix, for example the app com.android.contacts would use names
5034 * like "com.android.contacts.ShowAll".
5035 *
5036 * @param name The name of the extra data, with package prefix.
5037 * @param value The double data value.
5038 *
5039 * @return Returns the same Intent object, for chaining multiple calls
5040 * into a single statement.
5041 *
5042 * @see #putExtras
5043 * @see #removeExtra
5044 * @see #getDoubleExtra(String, double)
5045 */
5046 public Intent putExtra(String name, double value) {
5047 if (mExtras == null) {
5048 mExtras = new Bundle();
5049 }
5050 mExtras.putDouble(name, value);
5051 return this;
5052 }
5053
5054 /**
5055 * Add extended data to the intent. The name must include a package
5056 * prefix, for example the app com.android.contacts would use names
5057 * like "com.android.contacts.ShowAll".
5058 *
5059 * @param name The name of the extra data, with package prefix.
5060 * @param value The String data value.
5061 *
5062 * @return Returns the same Intent object, for chaining multiple calls
5063 * into a single statement.
5064 *
5065 * @see #putExtras
5066 * @see #removeExtra
5067 * @see #getStringExtra(String)
5068 */
5069 public Intent putExtra(String name, String value) {
5070 if (mExtras == null) {
5071 mExtras = new Bundle();
5072 }
5073 mExtras.putString(name, value);
5074 return this;
5075 }
5076
5077 /**
5078 * Add extended data to the intent. The name must include a package
5079 * prefix, for example the app com.android.contacts would use names
5080 * like "com.android.contacts.ShowAll".
5081 *
5082 * @param name The name of the extra data, with package prefix.
5083 * @param value The CharSequence data value.
5084 *
5085 * @return Returns the same Intent object, for chaining multiple calls
5086 * into a single statement.
5087 *
5088 * @see #putExtras
5089 * @see #removeExtra
5090 * @see #getCharSequenceExtra(String)
5091 */
5092 public Intent putExtra(String name, CharSequence value) {
5093 if (mExtras == null) {
5094 mExtras = new Bundle();
5095 }
5096 mExtras.putCharSequence(name, value);
5097 return this;
5098 }
5099
5100 /**
5101 * Add extended data to the intent. The name must include a package
5102 * prefix, for example the app com.android.contacts would use names
5103 * like "com.android.contacts.ShowAll".
5104 *
5105 * @param name The name of the extra data, with package prefix.
5106 * @param value The Parcelable data value.
5107 *
5108 * @return Returns the same Intent object, for chaining multiple calls
5109 * into a single statement.
5110 *
5111 * @see #putExtras
5112 * @see #removeExtra
5113 * @see #getParcelableExtra(String)
5114 */
5115 public Intent putExtra(String name, Parcelable value) {
5116 if (mExtras == null) {
5117 mExtras = new Bundle();
5118 }
5119 mExtras.putParcelable(name, value);
5120 return this;
5121 }
5122
5123 /**
5124 * Add extended data to the intent. The name must include a package
5125 * prefix, for example the app com.android.contacts would use names
5126 * like "com.android.contacts.ShowAll".
5127 *
5128 * @param name The name of the extra data, with package prefix.
5129 * @param value The Parcelable[] data value.
5130 *
5131 * @return Returns the same Intent object, for chaining multiple calls
5132 * into a single statement.
5133 *
5134 * @see #putExtras
5135 * @see #removeExtra
5136 * @see #getParcelableArrayExtra(String)
5137 */
5138 public Intent putExtra(String name, Parcelable[] value) {
5139 if (mExtras == null) {
5140 mExtras = new Bundle();
5141 }
5142 mExtras.putParcelableArray(name, value);
5143 return this;
5144 }
5145
5146 /**
5147 * Add extended data to the intent. The name must include a package
5148 * prefix, for example the app com.android.contacts would use names
5149 * like "com.android.contacts.ShowAll".
5150 *
5151 * @param name The name of the extra data, with package prefix.
5152 * @param value The ArrayList<Parcelable> data value.
5153 *
5154 * @return Returns the same Intent object, for chaining multiple calls
5155 * into a single statement.
5156 *
5157 * @see #putExtras
5158 * @see #removeExtra
5159 * @see #getParcelableArrayListExtra(String)
5160 */
5161 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5162 if (mExtras == null) {
5163 mExtras = new Bundle();
5164 }
5165 mExtras.putParcelableArrayList(name, value);
5166 return this;
5167 }
5168
5169 /**
5170 * Add extended data to the intent. The name must include a package
5171 * prefix, for example the app com.android.contacts would use names
5172 * like "com.android.contacts.ShowAll".
5173 *
5174 * @param name The name of the extra data, with package prefix.
5175 * @param value The ArrayList<Integer> data value.
5176 *
5177 * @return Returns the same Intent object, for chaining multiple calls
5178 * into a single statement.
5179 *
5180 * @see #putExtras
5181 * @see #removeExtra
5182 * @see #getIntegerArrayListExtra(String)
5183 */
5184 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5185 if (mExtras == null) {
5186 mExtras = new Bundle();
5187 }
5188 mExtras.putIntegerArrayList(name, value);
5189 return this;
5190 }
5191
5192 /**
5193 * Add extended data to the intent. The name must include a package
5194 * prefix, for example the app com.android.contacts would use names
5195 * like "com.android.contacts.ShowAll".
5196 *
5197 * @param name The name of the extra data, with package prefix.
5198 * @param value The ArrayList<String> data value.
5199 *
5200 * @return Returns the same Intent object, for chaining multiple calls
5201 * into a single statement.
5202 *
5203 * @see #putExtras
5204 * @see #removeExtra
5205 * @see #getStringArrayListExtra(String)
5206 */
5207 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5208 if (mExtras == null) {
5209 mExtras = new Bundle();
5210 }
5211 mExtras.putStringArrayList(name, value);
5212 return this;
5213 }
5214
5215 /**
5216 * Add extended data to the intent. The name must include a package
5217 * prefix, for example the app com.android.contacts would use names
5218 * like "com.android.contacts.ShowAll".
5219 *
5220 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005221 * @param value The ArrayList<CharSequence> data value.
5222 *
5223 * @return Returns the same Intent object, for chaining multiple calls
5224 * into a single statement.
5225 *
5226 * @see #putExtras
5227 * @see #removeExtra
5228 * @see #getCharSequenceArrayListExtra(String)
5229 */
5230 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5231 if (mExtras == null) {
5232 mExtras = new Bundle();
5233 }
5234 mExtras.putCharSequenceArrayList(name, value);
5235 return this;
5236 }
5237
5238 /**
5239 * Add extended data to the intent. The name must include a package
5240 * prefix, for example the app com.android.contacts would use names
5241 * like "com.android.contacts.ShowAll".
5242 *
5243 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005244 * @param value The Serializable data value.
5245 *
5246 * @return Returns the same Intent object, for chaining multiple calls
5247 * into a single statement.
5248 *
5249 * @see #putExtras
5250 * @see #removeExtra
5251 * @see #getSerializableExtra(String)
5252 */
5253 public Intent putExtra(String name, Serializable value) {
5254 if (mExtras == null) {
5255 mExtras = new Bundle();
5256 }
5257 mExtras.putSerializable(name, value);
5258 return this;
5259 }
5260
5261 /**
5262 * Add extended data to the intent. The name must include a package
5263 * prefix, for example the app com.android.contacts would use names
5264 * like "com.android.contacts.ShowAll".
5265 *
5266 * @param name The name of the extra data, with package prefix.
5267 * @param value The boolean array data value.
5268 *
5269 * @return Returns the same Intent object, for chaining multiple calls
5270 * into a single statement.
5271 *
5272 * @see #putExtras
5273 * @see #removeExtra
5274 * @see #getBooleanArrayExtra(String)
5275 */
5276 public Intent putExtra(String name, boolean[] value) {
5277 if (mExtras == null) {
5278 mExtras = new Bundle();
5279 }
5280 mExtras.putBooleanArray(name, value);
5281 return this;
5282 }
5283
5284 /**
5285 * Add extended data to the intent. The name must include a package
5286 * prefix, for example the app com.android.contacts would use names
5287 * like "com.android.contacts.ShowAll".
5288 *
5289 * @param name The name of the extra data, with package prefix.
5290 * @param value The byte array data value.
5291 *
5292 * @return Returns the same Intent object, for chaining multiple calls
5293 * into a single statement.
5294 *
5295 * @see #putExtras
5296 * @see #removeExtra
5297 * @see #getByteArrayExtra(String)
5298 */
5299 public Intent putExtra(String name, byte[] value) {
5300 if (mExtras == null) {
5301 mExtras = new Bundle();
5302 }
5303 mExtras.putByteArray(name, value);
5304 return this;
5305 }
5306
5307 /**
5308 * Add extended data to the intent. The name must include a package
5309 * prefix, for example the app com.android.contacts would use names
5310 * like "com.android.contacts.ShowAll".
5311 *
5312 * @param name The name of the extra data, with package prefix.
5313 * @param value The short array data value.
5314 *
5315 * @return Returns the same Intent object, for chaining multiple calls
5316 * into a single statement.
5317 *
5318 * @see #putExtras
5319 * @see #removeExtra
5320 * @see #getShortArrayExtra(String)
5321 */
5322 public Intent putExtra(String name, short[] value) {
5323 if (mExtras == null) {
5324 mExtras = new Bundle();
5325 }
5326 mExtras.putShortArray(name, value);
5327 return this;
5328 }
5329
5330 /**
5331 * Add extended data to the intent. The name must include a package
5332 * prefix, for example the app com.android.contacts would use names
5333 * like "com.android.contacts.ShowAll".
5334 *
5335 * @param name The name of the extra data, with package prefix.
5336 * @param value The char array data value.
5337 *
5338 * @return Returns the same Intent object, for chaining multiple calls
5339 * into a single statement.
5340 *
5341 * @see #putExtras
5342 * @see #removeExtra
5343 * @see #getCharArrayExtra(String)
5344 */
5345 public Intent putExtra(String name, char[] value) {
5346 if (mExtras == null) {
5347 mExtras = new Bundle();
5348 }
5349 mExtras.putCharArray(name, value);
5350 return this;
5351 }
5352
5353 /**
5354 * Add extended data to the intent. The name must include a package
5355 * prefix, for example the app com.android.contacts would use names
5356 * like "com.android.contacts.ShowAll".
5357 *
5358 * @param name The name of the extra data, with package prefix.
5359 * @param value The int array data value.
5360 *
5361 * @return Returns the same Intent object, for chaining multiple calls
5362 * into a single statement.
5363 *
5364 * @see #putExtras
5365 * @see #removeExtra
5366 * @see #getIntArrayExtra(String)
5367 */
5368 public Intent putExtra(String name, int[] value) {
5369 if (mExtras == null) {
5370 mExtras = new Bundle();
5371 }
5372 mExtras.putIntArray(name, value);
5373 return this;
5374 }
5375
5376 /**
5377 * Add extended data to the intent. The name must include a package
5378 * prefix, for example the app com.android.contacts would use names
5379 * like "com.android.contacts.ShowAll".
5380 *
5381 * @param name The name of the extra data, with package prefix.
5382 * @param value The byte array data value.
5383 *
5384 * @return Returns the same Intent object, for chaining multiple calls
5385 * into a single statement.
5386 *
5387 * @see #putExtras
5388 * @see #removeExtra
5389 * @see #getLongArrayExtra(String)
5390 */
5391 public Intent putExtra(String name, long[] value) {
5392 if (mExtras == null) {
5393 mExtras = new Bundle();
5394 }
5395 mExtras.putLongArray(name, value);
5396 return this;
5397 }
5398
5399 /**
5400 * Add extended data to the intent. The name must include a package
5401 * prefix, for example the app com.android.contacts would use names
5402 * like "com.android.contacts.ShowAll".
5403 *
5404 * @param name The name of the extra data, with package prefix.
5405 * @param value The float array data value.
5406 *
5407 * @return Returns the same Intent object, for chaining multiple calls
5408 * into a single statement.
5409 *
5410 * @see #putExtras
5411 * @see #removeExtra
5412 * @see #getFloatArrayExtra(String)
5413 */
5414 public Intent putExtra(String name, float[] value) {
5415 if (mExtras == null) {
5416 mExtras = new Bundle();
5417 }
5418 mExtras.putFloatArray(name, value);
5419 return this;
5420 }
5421
5422 /**
5423 * Add extended data to the intent. The name must include a package
5424 * prefix, for example the app com.android.contacts would use names
5425 * like "com.android.contacts.ShowAll".
5426 *
5427 * @param name The name of the extra data, with package prefix.
5428 * @param value The double array data value.
5429 *
5430 * @return Returns the same Intent object, for chaining multiple calls
5431 * into a single statement.
5432 *
5433 * @see #putExtras
5434 * @see #removeExtra
5435 * @see #getDoubleArrayExtra(String)
5436 */
5437 public Intent putExtra(String name, double[] value) {
5438 if (mExtras == null) {
5439 mExtras = new Bundle();
5440 }
5441 mExtras.putDoubleArray(name, value);
5442 return this;
5443 }
5444
5445 /**
5446 * Add extended data to the intent. The name must include a package
5447 * prefix, for example the app com.android.contacts would use names
5448 * like "com.android.contacts.ShowAll".
5449 *
5450 * @param name The name of the extra data, with package prefix.
5451 * @param value The String array data value.
5452 *
5453 * @return Returns the same Intent object, for chaining multiple calls
5454 * into a single statement.
5455 *
5456 * @see #putExtras
5457 * @see #removeExtra
5458 * @see #getStringArrayExtra(String)
5459 */
5460 public Intent putExtra(String name, String[] value) {
5461 if (mExtras == null) {
5462 mExtras = new Bundle();
5463 }
5464 mExtras.putStringArray(name, value);
5465 return this;
5466 }
5467
5468 /**
5469 * Add extended data to the intent. The name must include a package
5470 * prefix, for example the app com.android.contacts would use names
5471 * like "com.android.contacts.ShowAll".
5472 *
5473 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005474 * @param value The CharSequence array data value.
5475 *
5476 * @return Returns the same Intent object, for chaining multiple calls
5477 * into a single statement.
5478 *
5479 * @see #putExtras
5480 * @see #removeExtra
5481 * @see #getCharSequenceArrayExtra(String)
5482 */
5483 public Intent putExtra(String name, CharSequence[] value) {
5484 if (mExtras == null) {
5485 mExtras = new Bundle();
5486 }
5487 mExtras.putCharSequenceArray(name, value);
5488 return this;
5489 }
5490
5491 /**
5492 * Add extended data to the intent. The name must include a package
5493 * prefix, for example the app com.android.contacts would use names
5494 * like "com.android.contacts.ShowAll".
5495 *
5496 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005497 * @param value The Bundle data value.
5498 *
5499 * @return Returns the same Intent object, for chaining multiple calls
5500 * into a single statement.
5501 *
5502 * @see #putExtras
5503 * @see #removeExtra
5504 * @see #getBundleExtra(String)
5505 */
5506 public Intent putExtra(String name, Bundle value) {
5507 if (mExtras == null) {
5508 mExtras = new Bundle();
5509 }
5510 mExtras.putBundle(name, value);
5511 return this;
5512 }
5513
5514 /**
5515 * Add extended data to the intent. The name must include a package
5516 * prefix, for example the app com.android.contacts would use names
5517 * like "com.android.contacts.ShowAll".
5518 *
5519 * @param name The name of the extra data, with package prefix.
5520 * @param value The IBinder data value.
5521 *
5522 * @return Returns the same Intent object, for chaining multiple calls
5523 * into a single statement.
5524 *
5525 * @see #putExtras
5526 * @see #removeExtra
5527 * @see #getIBinderExtra(String)
5528 *
5529 * @deprecated
5530 * @hide
5531 */
5532 @Deprecated
5533 public Intent putExtra(String name, IBinder value) {
5534 if (mExtras == null) {
5535 mExtras = new Bundle();
5536 }
5537 mExtras.putIBinder(name, value);
5538 return this;
5539 }
5540
5541 /**
5542 * Copy all extras in 'src' in to this intent.
5543 *
5544 * @param src Contains the extras to copy.
5545 *
5546 * @see #putExtra
5547 */
5548 public Intent putExtras(Intent src) {
5549 if (src.mExtras != null) {
5550 if (mExtras == null) {
5551 mExtras = new Bundle(src.mExtras);
5552 } else {
5553 mExtras.putAll(src.mExtras);
5554 }
5555 }
5556 return this;
5557 }
5558
5559 /**
5560 * Add a set of extended data to the intent. The keys must include a package
5561 * prefix, for example the app com.android.contacts would use names
5562 * like "com.android.contacts.ShowAll".
5563 *
5564 * @param extras The Bundle of extras to add to this intent.
5565 *
5566 * @see #putExtra
5567 * @see #removeExtra
5568 */
5569 public Intent putExtras(Bundle extras) {
5570 if (mExtras == null) {
5571 mExtras = new Bundle();
5572 }
5573 mExtras.putAll(extras);
5574 return this;
5575 }
5576
5577 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005578 * Completely replace the extras in the Intent with the extras in the
5579 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005580 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005581 * @param src The exact extras contained in this Intent are copied
5582 * into the target intent, replacing any that were previously there.
5583 */
5584 public Intent replaceExtras(Intent src) {
5585 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5586 return this;
5587 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005588
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005589 /**
5590 * Completely replace the extras in the Intent with the given Bundle of
5591 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005592 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005593 * @param extras The new set of extras in the Intent, or null to erase
5594 * all extras.
5595 */
5596 public Intent replaceExtras(Bundle extras) {
5597 mExtras = extras != null ? new Bundle(extras) : null;
5598 return this;
5599 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005600
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005601 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005602 * Remove extended data from the intent.
5603 *
5604 * @see #putExtra
5605 */
5606 public void removeExtra(String name) {
5607 if (mExtras != null) {
5608 mExtras.remove(name);
5609 if (mExtras.size() == 0) {
5610 mExtras = null;
5611 }
5612 }
5613 }
5614
5615 /**
5616 * Set special flags controlling how this intent is handled. Most values
5617 * here depend on the type of component being executed by the Intent,
5618 * specifically the FLAG_ACTIVITY_* flags are all for use with
5619 * {@link Context#startActivity Context.startActivity()} and the
5620 * FLAG_RECEIVER_* flags are all for use with
5621 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5622 *
Scott Main7aee61f2011-02-08 11:25:01 -08005623 * <p>See the
5624 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5625 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005626 * the behavior of your application.
5627 *
5628 * @param flags The desired flags.
5629 *
5630 * @return Returns the same Intent object, for chaining multiple calls
5631 * into a single statement.
5632 *
5633 * @see #getFlags
5634 * @see #addFlags
5635 *
5636 * @see #FLAG_GRANT_READ_URI_PERMISSION
5637 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5638 * @see #FLAG_DEBUG_LOG_RESOLUTION
5639 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005640 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005641 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005642 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005643 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005644 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5645 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005646 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005647 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5648 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005649 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005650 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005651 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005652 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5653 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005654 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005655 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005656 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005657 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5658 */
5659 public Intent setFlags(int flags) {
5660 mFlags = flags;
5661 return this;
5662 }
5663
5664 /**
5665 * Add additional flags to the intent (or with existing flags
5666 * value).
5667 *
5668 * @param flags The new flags to set.
5669 *
5670 * @return Returns the same Intent object, for chaining multiple calls
5671 * into a single statement.
5672 *
5673 * @see #setFlags
5674 */
5675 public Intent addFlags(int flags) {
5676 mFlags |= flags;
5677 return this;
5678 }
5679
5680 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005681 * (Usually optional) Set an explicit application package name that limits
5682 * the components this Intent will resolve to. If left to the default
5683 * value of null, all components in all applications will considered.
5684 * If non-null, the Intent can only match the components in the given
5685 * application package.
5686 *
5687 * @param packageName The name of the application package to handle the
5688 * intent, or null to allow any application package.
5689 *
5690 * @return Returns the same Intent object, for chaining multiple calls
5691 * into a single statement.
5692 *
5693 * @see #getPackage
5694 * @see #resolveActivity
5695 */
5696 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005697 if (packageName != null && mSelector != null) {
5698 throw new IllegalArgumentException(
5699 "Can't set package name when selector is already set");
5700 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005701 mPackage = packageName;
5702 return this;
5703 }
5704
5705 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005706 * (Usually optional) Explicitly set the component to handle the intent.
5707 * If left with the default value of null, the system will determine the
5708 * appropriate class to use based on the other fields (action, data,
5709 * type, categories) in the Intent. If this class is defined, the
5710 * specified class will always be used regardless of the other fields. You
5711 * should only set this value when you know you absolutely want a specific
5712 * class to be used; otherwise it is better to let the system find the
5713 * appropriate class so that you will respect the installed applications
5714 * and user preferences.
5715 *
5716 * @param component The name of the application component to handle the
5717 * intent, or null to let the system find one for you.
5718 *
5719 * @return Returns the same Intent object, for chaining multiple calls
5720 * into a single statement.
5721 *
5722 * @see #setClass
5723 * @see #setClassName(Context, String)
5724 * @see #setClassName(String, String)
5725 * @see #getComponent
5726 * @see #resolveActivity
5727 */
5728 public Intent setComponent(ComponentName component) {
5729 mComponent = component;
5730 return this;
5731 }
5732
5733 /**
5734 * Convenience for calling {@link #setComponent} with an
5735 * explicit class name.
5736 *
5737 * @param packageContext A Context of the application package implementing
5738 * this class.
5739 * @param className The name of a class inside of the application package
5740 * that will be used as the component for this Intent.
5741 *
5742 * @return Returns the same Intent object, for chaining multiple calls
5743 * into a single statement.
5744 *
5745 * @see #setComponent
5746 * @see #setClass
5747 */
5748 public Intent setClassName(Context packageContext, String className) {
5749 mComponent = new ComponentName(packageContext, className);
5750 return this;
5751 }
5752
5753 /**
5754 * Convenience for calling {@link #setComponent} with an
5755 * explicit application package name and class name.
5756 *
5757 * @param packageName The name of the package implementing the desired
5758 * component.
5759 * @param className The name of a class inside of the application package
5760 * that will be used as the component for this Intent.
5761 *
5762 * @return Returns the same Intent object, for chaining multiple calls
5763 * into a single statement.
5764 *
5765 * @see #setComponent
5766 * @see #setClass
5767 */
5768 public Intent setClassName(String packageName, String className) {
5769 mComponent = new ComponentName(packageName, className);
5770 return this;
5771 }
5772
5773 /**
5774 * Convenience for calling {@link #setComponent(ComponentName)} with the
5775 * name returned by a {@link Class} object.
5776 *
5777 * @param packageContext A Context of the application package implementing
5778 * this class.
5779 * @param cls The class name to set, equivalent to
5780 * <code>setClassName(context, cls.getName())</code>.
5781 *
5782 * @return Returns the same Intent object, for chaining multiple calls
5783 * into a single statement.
5784 *
5785 * @see #setComponent
5786 */
5787 public Intent setClass(Context packageContext, Class<?> cls) {
5788 mComponent = new ComponentName(packageContext, cls);
5789 return this;
5790 }
5791
5792 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005793 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5794 * used as a hint to the receiver for animations and the like. Null means that there
5795 * is no source bounds.
5796 */
5797 public void setSourceBounds(Rect r) {
5798 if (r != null) {
5799 mSourceBounds = new Rect(r);
5800 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005801 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005802 }
5803 }
5804
5805 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005806 * Use with {@link #fillIn} to allow the current action value to be
5807 * overwritten, even if it is already set.
5808 */
5809 public static final int FILL_IN_ACTION = 1<<0;
5810
5811 /**
5812 * Use with {@link #fillIn} to allow the current data or type value
5813 * overwritten, even if it is already set.
5814 */
5815 public static final int FILL_IN_DATA = 1<<1;
5816
5817 /**
5818 * Use with {@link #fillIn} to allow the current categories to be
5819 * overwritten, even if they are already set.
5820 */
5821 public static final int FILL_IN_CATEGORIES = 1<<2;
5822
5823 /**
5824 * Use with {@link #fillIn} to allow the current component value to be
5825 * overwritten, even if it is already set.
5826 */
5827 public static final int FILL_IN_COMPONENT = 1<<3;
5828
5829 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005830 * Use with {@link #fillIn} to allow the current package value to be
5831 * overwritten, even if it is already set.
5832 */
5833 public static final int FILL_IN_PACKAGE = 1<<4;
5834
5835 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005836 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005837 * overwritten, even if it is already set.
5838 */
5839 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5840
5841 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005842 * Use with {@link #fillIn} to allow the current selector to be
5843 * overwritten, even if it is already set.
5844 */
5845 public static final int FILL_IN_SELECTOR = 1<<6;
5846
5847 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005848 * Use with {@link #fillIn} to allow the current ClipData to be
5849 * overwritten, even if it is already set.
5850 */
5851 public static final int FILL_IN_CLIP_DATA = 1<<7;
5852
5853 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005854 * Copy the contents of <var>other</var> in to this object, but only
5855 * where fields are not defined by this object. For purposes of a field
5856 * being defined, the following pieces of data in the Intent are
5857 * considered to be separate fields:
5858 *
5859 * <ul>
5860 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005861 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005862 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5863 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005864 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005865 * <li> component, as set by {@link #setComponent(ComponentName)} or
5866 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005867 * <li> source bounds, as set by {@link #setSourceBounds}.
5868 * <li> selector, as set by {@link #setSelector(Intent)}.
5869 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005870 * <li> each top-level name in the associated extras.
5871 * </ul>
5872 *
5873 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005874 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005875 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5876 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5877 * the restriction where the corresponding field will not be replaced if
5878 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005879 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005880 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
5881 * is explicitly specified. The selector will only be copied if
5882 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005883 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005884 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5885 * and Intent B with {action="gotit", data-type="some/thing",
5886 * categories="one","two"}.
5887 *
5888 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5889 * containing: {action="gotit", data-type="some/thing",
5890 * categories="bar"}.
5891 *
5892 * @param other Another Intent whose values are to be used to fill in
5893 * the current one.
5894 * @param flags Options to control which fields can be filled in.
5895 *
5896 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005897 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005898 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5899 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005900 */
5901 public int fillIn(Intent other, int flags) {
5902 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005903 if (other.mAction != null
5904 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005905 mAction = other.mAction;
5906 changes |= FILL_IN_ACTION;
5907 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005908 if ((other.mData != null || other.mType != null)
5909 && ((mData == null && mType == null)
5910 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005911 mData = other.mData;
5912 mType = other.mType;
5913 changes |= FILL_IN_DATA;
5914 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005915 if (other.mCategories != null
5916 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005917 if (other.mCategories != null) {
5918 mCategories = new HashSet<String>(other.mCategories);
5919 }
5920 changes |= FILL_IN_CATEGORIES;
5921 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005922 if (other.mPackage != null
5923 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005924 // Only do this if mSelector is not set.
5925 if (mSelector == null) {
5926 mPackage = other.mPackage;
5927 changes |= FILL_IN_PACKAGE;
5928 }
5929 }
5930 // Selector is special: it can only be set if explicitly allowed,
5931 // for the same reason as the component name.
5932 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5933 if (mPackage == null) {
5934 mSelector = new Intent(other.mSelector);
5935 mPackage = null;
5936 changes |= FILL_IN_SELECTOR;
5937 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005938 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005939 if (other.mClipData != null
5940 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
5941 mClipData = other.mClipData;
5942 changes |= FILL_IN_CLIP_DATA;
5943 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005944 // Component is special: it can -only- be set if explicitly allowed,
5945 // since otherwise the sender could force the intent somewhere the
5946 // originator didn't intend.
5947 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005948 mComponent = other.mComponent;
5949 changes |= FILL_IN_COMPONENT;
5950 }
5951 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005952 if (other.mSourceBounds != null
5953 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5954 mSourceBounds = new Rect(other.mSourceBounds);
5955 changes |= FILL_IN_SOURCE_BOUNDS;
5956 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005957 if (mExtras == null) {
5958 if (other.mExtras != null) {
5959 mExtras = new Bundle(other.mExtras);
5960 }
5961 } else if (other.mExtras != null) {
5962 try {
5963 Bundle newb = new Bundle(other.mExtras);
5964 newb.putAll(mExtras);
5965 mExtras = newb;
5966 } catch (RuntimeException e) {
5967 // Modifying the extras can cause us to unparcel the contents
5968 // of the bundle, and if we do this in the system process that
5969 // may fail. We really should handle this (i.e., the Bundle
5970 // impl shouldn't be on top of a plain map), but for now just
5971 // ignore it and keep the original contents. :(
5972 Log.w("Intent", "Failure filling in extras", e);
5973 }
5974 }
5975 return changes;
5976 }
5977
5978 /**
5979 * Wrapper class holding an Intent and implementing comparisons on it for
5980 * the purpose of filtering. The class implements its
5981 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5982 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5983 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5984 * on the wrapped Intent.
5985 */
5986 public static final class FilterComparison {
5987 private final Intent mIntent;
5988 private final int mHashCode;
5989
5990 public FilterComparison(Intent intent) {
5991 mIntent = intent;
5992 mHashCode = intent.filterHashCode();
5993 }
5994
5995 /**
5996 * Return the Intent that this FilterComparison represents.
5997 * @return Returns the Intent held by the FilterComparison. Do
5998 * not modify!
5999 */
6000 public Intent getIntent() {
6001 return mIntent;
6002 }
6003
6004 @Override
6005 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006006 if (obj instanceof FilterComparison) {
6007 Intent other = ((FilterComparison)obj).mIntent;
6008 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006009 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006010 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006011 }
6012
6013 @Override
6014 public int hashCode() {
6015 return mHashCode;
6016 }
6017 }
6018
6019 /**
6020 * Determine if two intents are the same for the purposes of intent
6021 * resolution (filtering). That is, if their action, data, type,
6022 * class, and categories are the same. This does <em>not</em> compare
6023 * any extra data included in the intents.
6024 *
6025 * @param other The other Intent to compare against.
6026 *
6027 * @return Returns true if action, data, type, class, and categories
6028 * are the same.
6029 */
6030 public boolean filterEquals(Intent other) {
6031 if (other == null) {
6032 return false;
6033 }
6034 if (mAction != other.mAction) {
6035 if (mAction != null) {
6036 if (!mAction.equals(other.mAction)) {
6037 return false;
6038 }
6039 } else {
6040 if (!other.mAction.equals(mAction)) {
6041 return false;
6042 }
6043 }
6044 }
6045 if (mData != other.mData) {
6046 if (mData != null) {
6047 if (!mData.equals(other.mData)) {
6048 return false;
6049 }
6050 } else {
6051 if (!other.mData.equals(mData)) {
6052 return false;
6053 }
6054 }
6055 }
6056 if (mType != other.mType) {
6057 if (mType != null) {
6058 if (!mType.equals(other.mType)) {
6059 return false;
6060 }
6061 } else {
6062 if (!other.mType.equals(mType)) {
6063 return false;
6064 }
6065 }
6066 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006067 if (mPackage != other.mPackage) {
6068 if (mPackage != null) {
6069 if (!mPackage.equals(other.mPackage)) {
6070 return false;
6071 }
6072 } else {
6073 if (!other.mPackage.equals(mPackage)) {
6074 return false;
6075 }
6076 }
6077 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006078 if (mComponent != other.mComponent) {
6079 if (mComponent != null) {
6080 if (!mComponent.equals(other.mComponent)) {
6081 return false;
6082 }
6083 } else {
6084 if (!other.mComponent.equals(mComponent)) {
6085 return false;
6086 }
6087 }
6088 }
6089 if (mCategories != other.mCategories) {
6090 if (mCategories != null) {
6091 if (!mCategories.equals(other.mCategories)) {
6092 return false;
6093 }
6094 } else {
6095 if (!other.mCategories.equals(mCategories)) {
6096 return false;
6097 }
6098 }
6099 }
6100
6101 return true;
6102 }
6103
6104 /**
6105 * Generate hash code that matches semantics of filterEquals().
6106 *
6107 * @return Returns the hash value of the action, data, type, class, and
6108 * categories.
6109 *
6110 * @see #filterEquals
6111 */
6112 public int filterHashCode() {
6113 int code = 0;
6114 if (mAction != null) {
6115 code += mAction.hashCode();
6116 }
6117 if (mData != null) {
6118 code += mData.hashCode();
6119 }
6120 if (mType != null) {
6121 code += mType.hashCode();
6122 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006123 if (mPackage != null) {
6124 code += mPackage.hashCode();
6125 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006126 if (mComponent != null) {
6127 code += mComponent.hashCode();
6128 }
6129 if (mCategories != null) {
6130 code += mCategories.hashCode();
6131 }
6132 return code;
6133 }
6134
6135 @Override
6136 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006137 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006138
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006139 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006140 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006141 b.append(" }");
6142
6143 return b.toString();
6144 }
6145
6146 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006147 public String toInsecureString() {
6148 StringBuilder b = new StringBuilder(128);
6149
6150 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006151 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006152 b.append(" }");
6153
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006154 return b.toString();
6155 }
Romain Guy4969af72009-06-17 10:53:19 -07006156
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006157 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006158 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006159 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006160
6161 b.append("Intent { ");
6162 toShortString(b, false, true, true, true);
6163 b.append(" }");
6164
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006165 return b.toString();
6166 }
6167
6168 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006169 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6170 StringBuilder b = new StringBuilder(128);
6171 toShortString(b, secure, comp, extras, clip);
6172 return b.toString();
6173 }
6174
6175 /** @hide */
6176 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6177 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006178 boolean first = true;
6179 if (mAction != null) {
6180 b.append("act=").append(mAction);
6181 first = false;
6182 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006183 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006184 if (!first) {
6185 b.append(' ');
6186 }
6187 first = false;
6188 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006189 Iterator<String> i = mCategories.iterator();
6190 boolean didone = false;
6191 while (i.hasNext()) {
6192 if (didone) b.append(",");
6193 didone = true;
6194 b.append(i.next());
6195 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006196 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006197 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006198 if (mData != null) {
6199 if (!first) {
6200 b.append(' ');
6201 }
6202 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006203 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006204 if (secure) {
6205 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006206 } else {
6207 b.append(mData);
6208 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006209 }
6210 if (mType != null) {
6211 if (!first) {
6212 b.append(' ');
6213 }
6214 first = false;
6215 b.append("typ=").append(mType);
6216 }
6217 if (mFlags != 0) {
6218 if (!first) {
6219 b.append(' ');
6220 }
6221 first = false;
6222 b.append("flg=0x").append(Integer.toHexString(mFlags));
6223 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006224 if (mPackage != null) {
6225 if (!first) {
6226 b.append(' ');
6227 }
6228 first = false;
6229 b.append("pkg=").append(mPackage);
6230 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006231 if (comp && mComponent != null) {
6232 if (!first) {
6233 b.append(' ');
6234 }
6235 first = false;
6236 b.append("cmp=").append(mComponent.flattenToShortString());
6237 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006238 if (mSourceBounds != null) {
6239 if (!first) {
6240 b.append(' ');
6241 }
6242 first = false;
6243 b.append("bnds=").append(mSourceBounds.toShortString());
6244 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006245 if (mClipData != null) {
6246 if (!first) {
6247 b.append(' ');
6248 }
6249 first = false;
6250 if (clip) {
6251 b.append("clip={");
6252 mClipData.toShortString(b);
6253 b.append('}');
6254 } else {
6255 b.append("(has clip)");
6256 }
6257 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006258 if (extras && mExtras != null) {
6259 if (!first) {
6260 b.append(' ');
6261 }
6262 first = false;
6263 b.append("(has extras)");
6264 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006265 if (mSelector != null) {
6266 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006267 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006268 b.append("}");
6269 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006270 }
6271
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006272 /**
6273 * Call {@link #toUri} with 0 flags.
6274 * @deprecated Use {@link #toUri} instead.
6275 */
6276 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006277 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006278 return toUri(0);
6279 }
6280
6281 /**
6282 * Convert this Intent into a String holding a URI representation of it.
6283 * The returned URI string has been properly URI encoded, so it can be
6284 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6285 * Intent's data as the base URI, with an additional fragment describing
6286 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006287 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006288 * <p>You can convert the returned string back to an Intent with
6289 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006290 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006291 * @param flags Additional operating flags. Either 0 or
6292 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006293 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006294 * @return Returns a URI encoding URI string describing the entire contents
6295 * of the Intent.
6296 */
6297 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006298 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006299 String scheme = null;
6300 if (mData != null) {
6301 String data = mData.toString();
6302 if ((flags&URI_INTENT_SCHEME) != 0) {
6303 final int N = data.length();
6304 for (int i=0; i<N; i++) {
6305 char c = data.charAt(i);
6306 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6307 || c == '.' || c == '-') {
6308 continue;
6309 }
6310 if (c == ':' && i > 0) {
6311 // Valid scheme.
6312 scheme = data.substring(0, i);
6313 uri.append("intent:");
6314 data = data.substring(i+1);
6315 break;
6316 }
Tom Taylord4a47292009-12-21 13:59:18 -08006317
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006318 // No scheme.
6319 break;
6320 }
6321 }
6322 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006323
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006324 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6325 uri.append("intent:");
6326 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006327
6328 uri.append("#Intent;");
6329
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006330 toUriInner(uri, scheme, flags);
6331 if (mSelector != null) {
6332 uri.append("SEL;");
6333 // Note that for now we are not going to try to handle the
6334 // data part; not clear how to represent this as a URI, and
6335 // not much utility in it.
6336 mSelector.toUriInner(uri, null, flags);
6337 }
6338
6339 uri.append("end");
6340
6341 return uri.toString();
6342 }
6343
6344 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006345 if (scheme != null) {
6346 uri.append("scheme=").append(scheme).append(';');
6347 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006348 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006349 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006350 }
6351 if (mCategories != null) {
6352 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006353 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006354 }
6355 }
6356 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006357 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006358 }
6359 if (mFlags != 0) {
6360 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6361 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006362 if (mPackage != null) {
6363 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6364 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006365 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006366 uri.append("component=").append(Uri.encode(
6367 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006368 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006369 if (mSourceBounds != null) {
6370 uri.append("sourceBounds=")
6371 .append(Uri.encode(mSourceBounds.flattenToString()))
6372 .append(';');
6373 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006374 if (mExtras != null) {
6375 for (String key : mExtras.keySet()) {
6376 final Object value = mExtras.get(key);
6377 char entryType =
6378 value instanceof String ? 'S' :
6379 value instanceof Boolean ? 'B' :
6380 value instanceof Byte ? 'b' :
6381 value instanceof Character ? 'c' :
6382 value instanceof Double ? 'd' :
6383 value instanceof Float ? 'f' :
6384 value instanceof Integer ? 'i' :
6385 value instanceof Long ? 'l' :
6386 value instanceof Short ? 's' :
6387 '\0';
6388
6389 if (entryType != '\0') {
6390 uri.append(entryType);
6391 uri.append('.');
6392 uri.append(Uri.encode(key));
6393 uri.append('=');
6394 uri.append(Uri.encode(value.toString()));
6395 uri.append(';');
6396 }
6397 }
6398 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006399 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006400
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006401 public int describeContents() {
6402 return (mExtras != null) ? mExtras.describeContents() : 0;
6403 }
6404
6405 public void writeToParcel(Parcel out, int flags) {
6406 out.writeString(mAction);
6407 Uri.writeToParcel(out, mData);
6408 out.writeString(mType);
6409 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006410 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006411 ComponentName.writeToParcel(mComponent, out);
6412
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006413 if (mSourceBounds != null) {
6414 out.writeInt(1);
6415 mSourceBounds.writeToParcel(out, flags);
6416 } else {
6417 out.writeInt(0);
6418 }
6419
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006420 if (mCategories != null) {
6421 out.writeInt(mCategories.size());
6422 for (String category : mCategories) {
6423 out.writeString(category);
6424 }
6425 } else {
6426 out.writeInt(0);
6427 }
6428
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006429 if (mSelector != null) {
6430 out.writeInt(1);
6431 mSelector.writeToParcel(out, flags);
6432 } else {
6433 out.writeInt(0);
6434 }
6435
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006436 if (mClipData != null) {
6437 out.writeInt(1);
6438 mClipData.writeToParcel(out, flags);
6439 } else {
6440 out.writeInt(0);
6441 }
6442
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006443 out.writeBundle(mExtras);
6444 }
6445
6446 public static final Parcelable.Creator<Intent> CREATOR
6447 = new Parcelable.Creator<Intent>() {
6448 public Intent createFromParcel(Parcel in) {
6449 return new Intent(in);
6450 }
6451 public Intent[] newArray(int size) {
6452 return new Intent[size];
6453 }
6454 };
6455
Dianne Hackborneb034652009-09-07 00:49:58 -07006456 /** @hide */
6457 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006458 readFromParcel(in);
6459 }
6460
6461 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006462 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006463 mData = Uri.CREATOR.createFromParcel(in);
6464 mType = in.readString();
6465 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006466 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006467 mComponent = ComponentName.readFromParcel(in);
6468
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006469 if (in.readInt() != 0) {
6470 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6471 }
6472
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006473 int N = in.readInt();
6474 if (N > 0) {
6475 mCategories = new HashSet<String>();
6476 int i;
6477 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006478 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006479 }
6480 } else {
6481 mCategories = null;
6482 }
6483
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006484 if (in.readInt() != 0) {
6485 mSelector = new Intent(in);
6486 }
6487
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006488 if (in.readInt() != 0) {
6489 mClipData = new ClipData(in);
6490 }
6491
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006492 mExtras = in.readBundle();
6493 }
6494
6495 /**
6496 * Parses the "intent" element (and its children) from XML and instantiates
6497 * an Intent object. The given XML parser should be located at the tag
6498 * where parsing should start (often named "intent"), from which the
6499 * basic action, data, type, and package and class name will be
6500 * retrieved. The function will then parse in to any child elements,
6501 * looking for <category android:name="xxx"> tags to add categories and
6502 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6503 * to the intent.
6504 *
6505 * @param resources The Resources to use when inflating resources.
6506 * @param parser The XML parser pointing at an "intent" tag.
6507 * @param attrs The AttributeSet interface for retrieving extended
6508 * attribute data at the current <var>parser</var> location.
6509 * @return An Intent object matching the XML data.
6510 * @throws XmlPullParserException If there was an XML parsing error.
6511 * @throws IOException If there was an I/O error.
6512 */
6513 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6514 throws XmlPullParserException, IOException {
6515 Intent intent = new Intent();
6516
6517 TypedArray sa = resources.obtainAttributes(attrs,
6518 com.android.internal.R.styleable.Intent);
6519
6520 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6521
6522 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6523 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6524 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6525
6526 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6527 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6528 if (packageName != null && className != null) {
6529 intent.setComponent(new ComponentName(packageName, className));
6530 }
6531
6532 sa.recycle();
6533
6534 int outerDepth = parser.getDepth();
6535 int type;
6536 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6537 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6538 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6539 continue;
6540 }
6541
6542 String nodeName = parser.getName();
6543 if (nodeName.equals("category")) {
6544 sa = resources.obtainAttributes(attrs,
6545 com.android.internal.R.styleable.IntentCategory);
6546 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6547 sa.recycle();
6548
6549 if (cat != null) {
6550 intent.addCategory(cat);
6551 }
6552 XmlUtils.skipCurrentTag(parser);
6553
6554 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006555 if (intent.mExtras == null) {
6556 intent.mExtras = new Bundle();
6557 }
6558 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6559 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006560
6561 } else {
6562 XmlUtils.skipCurrentTag(parser);
6563 }
6564 }
6565
6566 return intent;
6567 }
Nick Pellyccae4122012-01-09 14:12:58 -08006568
6569 /**
6570 * Normalize a MIME data type.
6571 *
6572 * <p>A normalized MIME type has white-space trimmed,
6573 * content-type parameters removed, and is lower-case.
6574 * This aligns the type with Android best practices for
6575 * intent filtering.
6576 *
6577 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6578 * "text/x-vCard" becomes "text/x-vcard".
6579 *
6580 * <p>All MIME types received from outside Android (such as user input,
6581 * or external sources like Bluetooth, NFC, or the Internet) should
6582 * be normalized before they are used to create an Intent.
6583 *
6584 * @param type MIME data type to normalize
6585 * @return normalized MIME data type, or null if the input was null
6586 * @see {@link #setType}
6587 * @see {@link #setTypeAndNormalize}
6588 */
6589 public static String normalizeMimeType(String type) {
6590 if (type == null) {
6591 return null;
6592 }
6593
6594 type = type.trim().toLowerCase(Locale.US);
6595
6596 final int semicolonIndex = type.indexOf(';');
6597 if (semicolonIndex != -1) {
6598 type = type.substring(0, semicolonIndex);
6599 }
6600 return type;
6601 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006602
6603 /**
6604 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006605 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6606 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006607 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006608 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006609 * @hide
6610 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006611 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006612 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006613 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006614
6615 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006616 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006617
6618 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006619 if (ACTION_CHOOSER.equals(action)) {
6620 // Inspect target intent to see if we need to migrate
6621 final Intent target = getParcelableExtra(EXTRA_INTENT);
6622 if (target.migrateExtraStreamToClipData()) {
6623 // Since we migrated in child, we need to promote ClipData and
6624 // flags to ourselves to grant.
6625 setClipData(target.getClipData());
6626 addFlags(target.getFlags()
6627 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6628 return true;
6629 } else {
6630 return false;
6631 }
6632
6633 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006634 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006635 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6636 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6637 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6638 if (stream != null || text != null || htmlText != null) {
6639 final ClipData clipData = new ClipData(
6640 null, new String[] { getType() },
6641 new ClipData.Item(text, htmlText, null, stream));
6642 setClipData(clipData);
6643 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006644 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006645 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006646 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006647 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006648
6649 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006650 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006651 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6652 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6653 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6654 int num = -1;
6655 if (streams != null) {
6656 num = streams.size();
6657 }
6658 if (texts != null) {
6659 if (num >= 0 && num != texts.size()) {
6660 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006661 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006662 }
6663 num = texts.size();
6664 }
6665 if (htmlTexts != null) {
6666 if (num >= 0 && num != htmlTexts.size()) {
6667 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006668 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006669 }
6670 num = htmlTexts.size();
6671 }
6672 if (num > 0) {
6673 final ClipData clipData = new ClipData(
6674 null, new String[] { getType() },
6675 makeClipItem(streams, texts, htmlTexts, 0));
6676
6677 for (int i = 1; i < num; i++) {
6678 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6679 }
6680
6681 setClipData(clipData);
6682 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006683 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006684 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006685 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006686 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006687 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006688
6689 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006690 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006691
6692 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6693 ArrayList<String> htmlTexts, int which) {
6694 Uri uri = streams != null ? streams.get(which) : null;
6695 CharSequence text = texts != null ? texts.get(which) : null;
6696 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6697 return new ClipData.Item(text, htmlText, null, uri);
6698 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006699}