blob: ab62c446e57a64e2c61ba4f011fc31511b19c01a [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.
813 * <p>Input: No data should be specified. get*Extra must have
814 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
815 * and can optionally have a {@link #EXTRA_TITLE} field containing the
816 * title text to display in the chooser.
817 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
818 */
819 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
820 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
821
822 /**
823 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
824 *
825 * @param target The Intent that the user will be selecting an activity
826 * to perform.
827 * @param title Optional title that will be displayed in the chooser.
828 * @return Return a new Intent object that you can hand to
829 * {@link Context#startActivity(Intent) Context.startActivity()} and
830 * related methods.
831 */
832 public static Intent createChooser(Intent target, CharSequence title) {
833 Intent intent = new Intent(ACTION_CHOOSER);
834 intent.putExtra(EXTRA_INTENT, target);
835 if (title != null) {
836 intent.putExtra(EXTRA_TITLE, title);
837 }
838 return intent;
839 }
840 /**
841 * Activity Action: Allow the user to select a particular kind of data and
842 * return it. This is different than {@link #ACTION_PICK} in that here we
843 * just say what kind of data is desired, not a URI of existing data from
844 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
845 * create the data as it runs (for example taking a picture or recording a
846 * sound), let them browser over the web and download the desired data,
847 * etc.
848 * <p>
849 * There are two main ways to use this action: if you want an specific kind
850 * of data, such as a person contact, you set the MIME type to the kind of
851 * data you want and launch it with {@link Context#startActivity(Intent)}.
852 * The system will then launch the best application to select that kind
853 * of data for you.
854 * <p>
855 * You may also be interested in any of a set of types of content the user
856 * can pick. For example, an e-mail application that wants to allow the
857 * user to add an attachment to an e-mail message can use this action to
858 * bring up a list of all of the types of content the user can attach.
859 * <p>
860 * In this case, you should wrap the GET_CONTENT intent with a chooser
861 * (through {@link #createChooser}), which will give the proper interface
862 * for the user to pick how to send your data and allow you to specify
863 * a prompt indicating what they are doing. You will usually specify a
864 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
865 * broad range of content types the user can select from.
866 * <p>
867 * When using such a broad GET_CONTENT action, it is often desireable to
868 * only pick from data that can be represented as a stream. This is
869 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
870 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800871 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
872 * the launched content chooser only return results representing data that
873 * is locally available on the device. For example, if this extra is set
874 * to true then an image picker should not show any pictures that are available
875 * from a remote server but not already on the local device (thus requiring
876 * they be downloaded when opened).
877 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700878 * Input: {@link #getType} is the desired MIME type to retrieve. Note
879 * that no URI is supplied in the intent, as there are no constraints on
880 * where the returned data originally comes from. You may also include the
881 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800882 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
883 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700884 * <p>
885 * Output: The URI of the item that was picked. This must be a content:
886 * URI so that any receiver can access it.
887 */
888 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
889 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
890 /**
891 * Activity Action: Dial a number as specified by the data. This shows a
892 * UI with the number being dialed, allowing the user to explicitly
893 * initiate the call.
894 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
895 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
896 * number.
897 * <p>Output: nothing.
898 */
899 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
900 public static final String ACTION_DIAL = "android.intent.action.DIAL";
901 /**
902 * Activity Action: Perform a call to someone specified by the data.
903 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
904 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
905 * number.
906 * <p>Output: nothing.
907 *
908 * <p>Note: there will be restrictions on which applications can initiate a
909 * call; most applications should use the {@link #ACTION_DIAL}.
910 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
911 * numbers. Applications can <strong>dial</strong> emergency numbers using
912 * {@link #ACTION_DIAL}, however.
913 */
914 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
915 public static final String ACTION_CALL = "android.intent.action.CALL";
916 /**
917 * Activity Action: Perform a call to an emergency number specified by the
918 * data.
919 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
920 * tel: URI of an explicit phone number.
921 * <p>Output: nothing.
922 * @hide
923 */
924 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
925 /**
926 * Activity action: Perform a call to any number (emergency or not)
927 * specified by the data.
928 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
929 * tel: URI of an explicit phone number.
930 * <p>Output: nothing.
931 * @hide
932 */
933 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
934 /**
935 * Activity Action: Send a message to someone specified by the data.
936 * <p>Input: {@link #getData} is URI describing the target.
937 * <p>Output: nothing.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
941 /**
942 * Activity Action: Deliver some data to someone else. Who the data is
943 * being delivered to is not specified; it is up to the receiver of this
944 * action to ask the user where the data should be sent.
945 * <p>
946 * When launching a SEND intent, you should usually wrap it in a chooser
947 * (through {@link #createChooser}), which will give the proper interface
948 * for the user to pick how to send your data and allow you to specify
949 * a prompt indicating what they are doing.
950 * <p>
951 * Input: {@link #getType} is the MIME type of the data being sent.
952 * get*Extra can have either a {@link #EXTRA_TEXT}
953 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
954 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
955 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
956 * if the MIME type is unknown (this will only allow senders that can
957 * handle generic data streams).
958 * <p>
959 * Optional standard extras, which may be interpreted by some recipients as
960 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
961 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
962 * <p>
963 * Output: nothing.
964 */
965 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
966 public static final String ACTION_SEND = "android.intent.action.SEND";
967 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800968 * Activity Action: Deliver multiple data to someone else.
969 * <p>
970 * Like ACTION_SEND, except the data is multiple.
971 * <p>
972 * Input: {@link #getType} is the MIME type of the data being sent.
973 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
974 * #EXTRA_STREAM} field, containing the data to be sent.
975 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800976 * Multiple types are supported, and receivers should handle mixed types
977 * whenever possible. The right way for the receiver to check them is to
978 * use the content resolver on each URI. The intent sender should try to
979 * put the most concrete mime type in the intent type, but it can fall
980 * back to {@literal <type>/*} or {@literal *}/* as needed.
981 * <p>
982 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
983 * be image/jpg, but if you are sending image/jpg and image/png, then the
984 * intent's type should be image/*.
985 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800986 * Optional standard extras, which may be interpreted by some recipients as
987 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
988 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
989 * <p>
990 * Output: nothing.
991 */
992 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
993 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
994 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700995 * Activity Action: Handle an incoming phone call.
996 * <p>Input: nothing.
997 * <p>Output: nothing.
998 */
999 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1000 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1001 /**
1002 * Activity Action: Insert an empty item into the given container.
1003 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1004 * in which to place the data.
1005 * <p>Output: URI of the new data that was created.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1009 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001010 * Activity Action: Create a new item in the given container, initializing it
1011 * from the current contents of the clipboard.
1012 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1013 * in which to place the data.
1014 * <p>Output: URI of the new data that was created.
1015 */
1016 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1017 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1018 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001019 * Activity Action: Delete the given data from its container.
1020 * <p>Input: {@link #getData} is URI of data to be deleted.
1021 * <p>Output: nothing.
1022 */
1023 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1024 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1025 /**
1026 * Activity Action: Run the data, whatever that means.
1027 * <p>Input: ? (Note: this is currently specific to the test harness.)
1028 * <p>Output: nothing.
1029 */
1030 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1031 public static final String ACTION_RUN = "android.intent.action.RUN";
1032 /**
1033 * Activity Action: Perform a data synchronization.
1034 * <p>Input: ?
1035 * <p>Output: ?
1036 */
1037 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1038 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1039 /**
1040 * Activity Action: Pick an activity given an intent, returning the class
1041 * selected.
1042 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1043 * used with {@link PackageManager#queryIntentActivities} to determine the
1044 * set of activities from which to pick.
1045 * <p>Output: Class name of the activity that was selected.
1046 */
1047 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1048 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1049 /**
1050 * Activity Action: Perform a search.
1051 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1052 * is the text to search for. If empty, simply
1053 * enter your search results Activity with the search UI activated.
1054 * <p>Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1058 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001059 * Activity Action: Start the platform-defined tutorial
1060 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1061 * is the text to search for. If empty, simply
1062 * enter your search results Activity with the search UI activated.
1063 * <p>Output: nothing.
1064 */
1065 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1066 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1067 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001068 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001069 * <p>
1070 * Input: {@link android.app.SearchManager#QUERY
1071 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1072 * a url starts with http or https, the site will be opened. If it is plain
1073 * text, Google search will be applied.
1074 * <p>
1075 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1079 /**
1080 * Activity Action: List all available applications
1081 * <p>Input: Nothing.
1082 * <p>Output: nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1086 /**
1087 * Activity Action: Show settings for choosing wallpaper
1088 * <p>Input: Nothing.
1089 * <p>Output: Nothing.
1090 */
1091 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1092 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1093
1094 /**
1095 * Activity Action: Show activity for reporting a bug.
1096 * <p>Input: Nothing.
1097 * <p>Output: Nothing.
1098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1101
1102 /**
1103 * Activity Action: Main entry point for factory tests. Only used when
1104 * the device is booting in factory test node. The implementing package
1105 * must be installed in the system image.
1106 * <p>Input: nothing
1107 * <p>Output: nothing
1108 */
1109 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1110
1111 /**
1112 * Activity Action: The user pressed the "call" button to go to the dialer
1113 * or other appropriate UI for placing a call.
1114 * <p>Input: Nothing.
1115 * <p>Output: Nothing.
1116 */
1117 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1118 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1119
1120 /**
1121 * Activity Action: Start Voice Command.
1122 * <p>Input: Nothing.
1123 * <p>Output: Nothing.
1124 */
1125 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1126 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001127
1128 /**
1129 * Activity Action: Start action associated with long pressing on the
1130 * search key.
1131 * <p>Input: Nothing.
1132 * <p>Output: Nothing.
1133 */
1134 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1135 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001136
Jacek Surazski86b6c532009-05-13 14:38:28 +02001137 /**
1138 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1139 * This intent is delivered to the package which installed the application, usually
1140 * the Market.
1141 * <p>Input: No data is specified. The bug report is passed in using
1142 * an {@link #EXTRA_BUG_REPORT} field.
1143 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001144 *
1145 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001149
1150 /**
1151 * Activity Action: Show power usage information to the user.
1152 * <p>Input: Nothing.
1153 * <p>Output: Nothing.
1154 */
1155 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1156 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001157
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001158 /**
1159 * Activity Action: Setup wizard to launch after a platform update. This
1160 * activity should have a string meta-data field associated with it,
1161 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1162 * the platform for setup. The activity will be launched only if
1163 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1164 * same value.
1165 * <p>Input: Nothing.
1166 * <p>Output: Nothing.
1167 * @hide
1168 */
1169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1170 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001171
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001172 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001173 * Activity Action: Show settings for managing network data usage of a
1174 * specific application. Applications should define an activity that offers
1175 * options to control data usage.
1176 */
1177 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1178 public static final String ACTION_MANAGE_NETWORK_USAGE =
1179 "android.intent.action.MANAGE_NETWORK_USAGE";
1180
1181 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001182 * Activity Action: Launch application installer.
1183 * <p>
1184 * Input: The data must be a content: or file: URI at which the application
1185 * can be retrieved. You can optionally supply
1186 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1187 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1188 * <p>
1189 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1190 * succeeded.
1191 *
1192 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1193 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1194 * @see #EXTRA_RETURN_RESULT
1195 */
1196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1197 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1198
1199 /**
1200 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1201 * package. Specifies the installer package name; this package will receive the
1202 * {@link #ACTION_APP_ERROR} intent.
1203 */
1204 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1205 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1206
1207 /**
1208 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1209 * package. Specifies that the application being installed should not be
1210 * treated as coming from an unknown source, but as coming from the app
1211 * invoking the Intent. For this to work you must start the installer with
1212 * startActivityForResult().
1213 */
1214 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1215 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1216
1217 /**
1218 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1219 * package. Tells the installer UI to skip the confirmation with the user
1220 * if the .apk is replacing an existing one.
1221 */
1222 public static final String EXTRA_ALLOW_REPLACE
1223 = "android.intent.extra.ALLOW_REPLACE";
1224
1225 /**
1226 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1227 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1228 * return to the application the result code of the install/uninstall. The returned result
1229 * code will be {@link android.app.Activity#RESULT_OK} on success or
1230 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1231 */
1232 public static final String EXTRA_RETURN_RESULT
1233 = "android.intent.extra.RETURN_RESULT";
1234
1235 /**
1236 * Package manager install result code. @hide because result codes are not
1237 * yet ready to be exposed.
1238 */
1239 public static final String EXTRA_INSTALL_RESULT
1240 = "android.intent.extra.INSTALL_RESULT";
1241
1242 /**
1243 * Activity Action: Launch application uninstaller.
1244 * <p>
1245 * Input: The data must be a package: URI whose scheme specific part is
1246 * the package name of the current installed package to be uninstalled.
1247 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1248 * <p>
1249 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1250 * succeeded.
1251 */
1252 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1253 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1254
1255 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001256 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1257 * describing the last run version of the platform that was setup.
1258 * @hide
1259 */
1260 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1261
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001262 // ---------------------------------------------------------------------
1263 // ---------------------------------------------------------------------
1264 // Standard intent broadcast actions (see action variable).
1265
1266 /**
1267 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001268 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001269 * <p class="note">This is a protected intent that can only be sent
1270 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001271 */
1272 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1273 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1274 /**
1275 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001276 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001277 * <p class="note">This is a protected intent that can only be sent
1278 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001279 */
1280 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1281 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001282
1283 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001284 * 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 -07001285 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001286 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001287 * <p class="note">This is a protected intent that can only be sent
1288 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001289 */
1290 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001291 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001292
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001293 /**
1294 * Broadcast Action: The current time has changed. Sent every
1295 * minute. You can <em>not</em> receive this through components declared
1296 * in manifests, only by exlicitly registering for it with
1297 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1298 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001299 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001300 * <p class="note">This is a protected intent that can only be sent
1301 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001302 */
1303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1304 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1305 /**
1306 * Broadcast Action: The time was set.
1307 */
1308 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1309 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1310 /**
1311 * Broadcast Action: The date has changed.
1312 */
1313 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1314 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1315 /**
1316 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1317 * <ul>
1318 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1319 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001320 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001321 * <p class="note">This is a protected intent that can only be sent
1322 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001323 */
1324 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1325 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1326 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001327 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1328 * DNS entries should be tossed.
1329 * @hide
1330 */
1331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1332 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1333 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001334 * Alarm Changed Action: This is broadcast when the AlarmClock
1335 * application's alarm is set or unset. It is used by the
1336 * AlarmClock application and the StatusBar service.
1337 * @hide
1338 */
1339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1340 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1341 /**
1342 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1343 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1344 * @hide
1345 */
1346 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1347 public static final String ACTION_SYNC_STATE_CHANGED
1348 = "android.intent.action.SYNC_STATE_CHANGED";
1349 /**
1350 * Broadcast Action: This is broadcast once, after the system has finished
1351 * booting. It can be used to perform application-specific initialization,
1352 * such as installing alarms. You must hold the
1353 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1354 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001355 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001356 * <p class="note">This is a protected intent that can only be sent
1357 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001358 */
1359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1360 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1361 /**
1362 * Broadcast Action: This is broadcast when a user action should request a
1363 * temporary system dialog to dismiss. Some examples of temporary system
1364 * dialogs are the notification window-shade and the recent tasks dialog.
1365 */
1366 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1367 /**
1368 * Broadcast Action: Trigger the download and eventual installation
1369 * of a package.
1370 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001371 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001372 * <p class="note">This is a protected intent that can only be sent
1373 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001374 *
1375 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001376 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001377 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001378 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1379 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1380 /**
1381 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001382 * device. The data contains the name of the package. Note that the
1383 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001384 * <p>My include the following extras:
1385 * <ul>
1386 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1387 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1388 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1389 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001390 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001391 * <p class="note">This is a protected intent that can only be sent
1392 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001393 */
1394 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1395 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1396 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001397 * Broadcast Action: A new version of an application package has been
1398 * installed, replacing an existing version that was previously installed.
1399 * The data contains the name of the package.
1400 * <p>My include the following extras:
1401 * <ul>
1402 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1403 * </ul>
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 Projectc2ad2412009-03-19 23:08:54 -07001407 */
1408 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1409 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1410 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001411 * Broadcast Action: A new version of your application has been installed
1412 * over an existing one. This is only sent to the application that was
1413 * replaced. It does not contain any additional data; to receive it, just
1414 * use an intent filter for this action.
1415 *
1416 * <p class="note">This is a protected intent that can only be sent
1417 * by the system.
1418 */
1419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1420 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1421 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001422 * Broadcast Action: An existing application package has been removed from
1423 * the device. The data contains the name of the package. The package
1424 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001425 * <ul>
1426 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1427 * to the package.
1428 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1429 * application -- data and code -- is being removed.
1430 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1431 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1432 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001433 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001434 * <p class="note">This is a protected intent that can only be sent
1435 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001436 */
1437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1438 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1439 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001440 * Broadcast Action: An existing application package has been completely
1441 * removed from the device. The data contains the name of the package.
1442 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1443 * {@link #EXTRA_DATA_REMOVED} is true and
1444 * {@link #EXTRA_REPLACING} is false of that broadcast.
1445 *
1446 * <ul>
1447 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1448 * to the package.
1449 * </ul>
1450 *
1451 * <p class="note">This is a protected intent that can only be sent
1452 * by the system.
1453 */
1454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1455 public static final String ACTION_PACKAGE_FULLY_REMOVED
1456 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1457 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001458 * Broadcast Action: An existing application package has been changed (e.g.
1459 * a component has been enabled or disabled). The data contains the name of
1460 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001461 * <ul>
1462 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001463 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1464 * of the changed components.
1465 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1466 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001467 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001468 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001469 * <p class="note">This is a protected intent that can only be sent
1470 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001471 */
1472 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1473 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1474 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001475 * @hide
1476 * Broadcast Action: Ask system services if there is any reason to
1477 * restart the given package. The data contains the name of the
1478 * package.
1479 * <ul>
1480 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1481 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1482 * </ul>
1483 *
1484 * <p class="note">This is a protected intent that can only be sent
1485 * by the system.
1486 */
1487 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1488 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1489 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001490 * Broadcast Action: The user has restarted a package, and all of its
1491 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001492 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001493 * be removed. Note that the restarted package does <em>not</em>
1494 * receive this broadcast.
1495 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001496 * <ul>
1497 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1498 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001499 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001500 * <p class="note">This is a protected intent that can only be sent
1501 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001502 */
1503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1505 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001506 * Broadcast Action: The user has cleared the data of a package. This should
1507 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001508 * its persistent data is erased and this broadcast sent.
1509 * Note that the cleared package does <em>not</em>
1510 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001511 * <ul>
1512 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1513 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001514 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001515 * <p class="note">This is a protected intent that can only be sent
1516 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001517 */
1518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1519 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1520 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001521 * Broadcast Action: A user ID has been removed from the system. The user
1522 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001523 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001524 * <p class="note">This is a protected intent that can only be sent
1525 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001526 */
1527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1528 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001529
1530 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001531 * Broadcast Action: Sent to the installer package of an application
1532 * when that application is first launched (that is the first time it
1533 * is moved out of the stopped state). The data contains the name of the package.
1534 *
1535 * <p class="note">This is a protected intent that can only be sent
1536 * by the system.
1537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1540
1541 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001542 * Broadcast Action: Sent to the system package verifier when a package
1543 * needs to be verified. The data contains the package URI.
1544 * <p class="note">
1545 * This is a protected intent that can only be sent by the system.
1546 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001547 */
1548 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1549 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1550
1551 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001552 * Broadcast Action: Resources for a set of packages (which were
1553 * previously unavailable) are currently
1554 * available since the media on which they exist is available.
1555 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1556 * list of packages whose availability changed.
1557 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1558 * list of uids of packages whose availability changed.
1559 * Note that the
1560 * packages in this list do <em>not</em> receive this broadcast.
1561 * The specified set of packages are now available on the system.
1562 * <p>Includes the following extras:
1563 * <ul>
1564 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1565 * whose resources(were previously unavailable) are currently available.
1566 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1567 * packages whose resources(were previously unavailable)
1568 * are currently available.
1569 * </ul>
1570 *
1571 * <p class="note">This is a protected intent that can only be sent
1572 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001573 */
1574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001575 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1576 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001577
1578 /**
1579 * Broadcast Action: Resources for a set of packages are currently
1580 * unavailable since the media on which they exist is unavailable.
1581 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1582 * list of packages whose availability changed.
1583 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1584 * list of uids of packages whose availability changed.
1585 * The specified set of packages can no longer be
1586 * launched and are practically unavailable on the system.
1587 * <p>Inclues the following extras:
1588 * <ul>
1589 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1590 * whose resources are no longer available.
1591 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1592 * whose resources are no longer available.
1593 * </ul>
1594 *
1595 * <p class="note">This is a protected intent that can only be sent
1596 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001597 */
1598 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001599 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001600 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001601
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001602 /**
1603 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001604 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001605 */
1606 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1607 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1608 /**
1609 * Broadcast Action: The current device {@link android.content.res.Configuration}
1610 * (orientation, locale, etc) has changed. When such a change happens, the
1611 * UIs (view hierarchy) will need to be rebuilt based on this new
1612 * information; for the most part, applications don't need to worry about
1613 * this, because the system will take care of stopping and restarting the
1614 * application to make sure it sees the new changes. Some system code that
1615 * can not be restarted will need to watch for this action and handle it
1616 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001617 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001618 * <p class="note">
1619 * You can <em>not</em> receive this through components declared
1620 * in manifests, only by explicitly registering for it with
1621 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1622 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001623 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001624 * <p class="note">This is a protected intent that can only be sent
1625 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001626 *
1627 * @see android.content.res.Configuration
1628 */
1629 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1630 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1631 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001632 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001633 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001634 * <p class="note">This is a protected intent that can only be sent
1635 * by the system.
1636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1639 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001640 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1641 * charging state, level, and other information about the battery.
1642 * See {@link android.os.BatteryManager} for documentation on the
1643 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001644 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001645 * <p class="note">
1646 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001647 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001648 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001649 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1650 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1651 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1652 * broadcasts that are sent and can be received through manifest
1653 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001654 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001655 * <p class="note">This is a protected intent that can only be sent
1656 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1660 /**
1661 * Broadcast Action: Indicates low battery condition on the device.
1662 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001663 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001664 * <p class="note">This is a protected intent that can only be sent
1665 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001666 */
1667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1668 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1669 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001670 * Broadcast Action: Indicates the battery is now okay after being low.
1671 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1672 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001673 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001674 * <p class="note">This is a protected intent that can only be sent
1675 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001676 */
1677 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1678 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1679 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001680 * Broadcast Action: External power has been connected to the device.
1681 * This is intended for applications that wish to register specifically to this notification.
1682 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1683 * stay active to receive this notification. This action can be used to implement actions
1684 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001685 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001686 * <p class="note">This is a protected intent that can only be sent
1687 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001688 */
1689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001690 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001691 /**
1692 * Broadcast Action: External power has been removed from the device.
1693 * This is intended for applications that wish to register specifically to this notification.
1694 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1695 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001696 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001697 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001698 * <p class="note">This is a protected intent that can only be sent
1699 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001700 */
1701 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001702 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001703 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001704 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001705 * Broadcast Action: Device is shutting down.
1706 * This is broadcast when the device is being shut down (completely turned
1707 * off, not sleeping). Once the broadcast is complete, the final shutdown
1708 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001709 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001710 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001711 * <p class="note">This is a protected intent that can only be sent
1712 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001713 */
1714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001715 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001716 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001717 * Activity Action: Start this activity to request system shutdown.
1718 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1719 * to request confirmation from the user before shutting down.
1720 *
1721 * <p class="note">This is a protected intent that can only be sent
1722 * by the system.
1723 *
1724 * {@hide}
1725 */
1726 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1727 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001728 * Broadcast Action: A sticky broadcast that indicates low memory
1729 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001730 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001733 */
1734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1735 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1736 /**
1737 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001738 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001739 * <p class="note">This is a protected intent that can only be sent
1740 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001741 */
1742 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1743 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1744 /**
Jake Hambybb371632010-08-23 18:16:48 -07001745 * Broadcast Action: A sticky broadcast that indicates a memory full
1746 * condition on the device. This is intended for activities that want
1747 * to be able to fill the data partition completely, leaving only
1748 * enough free space to prevent system-wide SQLite failures.
1749 *
1750 * <p class="note">This is a protected intent that can only be sent
1751 * by the system.
1752 *
1753 * {@hide}
1754 */
1755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1756 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1757 /**
1758 * Broadcast Action: Indicates memory full condition on the device
1759 * no longer exists.
1760 *
1761 * <p class="note">This is a protected intent that can only be sent
1762 * by the system.
1763 *
1764 * {@hide}
1765 */
1766 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1767 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1768 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001769 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1770 * and package management should be started.
1771 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1772 * notification.
1773 */
1774 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1775 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1776 /**
1777 * Broadcast Action: The device has entered USB Mass Storage mode.
1778 * This is used mainly for the USB Settings panel.
1779 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1780 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001781 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001782 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001783 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001784 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1785
1786 /**
1787 * Broadcast Action: The device has exited USB Mass Storage mode.
1788 * This is used mainly for the USB Settings panel.
1789 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1790 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001791 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001792 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001793 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001794 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1795
1796 /**
1797 * Broadcast Action: External media has been removed.
1798 * The path to the mount point for the removed media is contained in the Intent.mData field.
1799 */
1800 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1801 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1802
1803 /**
1804 * Broadcast Action: External media is present, but not mounted at its mount point.
1805 * The path to the mount point for the removed media is contained in the Intent.mData field.
1806 */
1807 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1808 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1809
1810 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001811 * Broadcast Action: External media is present, and being disk-checked
1812 * 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 -08001813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1815 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1816
1817 /**
1818 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1819 * 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 -08001820 */
1821 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1822 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1823
1824 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001825 * Broadcast Action: External media is present and mounted at its mount point.
1826 * The path to the mount point for the removed media is contained in the Intent.mData field.
1827 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1828 * media was mounted read only.
1829 */
1830 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1831 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1832
1833 /**
1834 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001835 * 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 -07001836 */
1837 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1838 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1839
1840 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001841 * Broadcast Action: External media is no longer being shared via USB mass storage.
1842 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1843 *
1844 * @hide
1845 */
1846 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1847
1848 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1850 * The path to the mount point for the removed media is contained in the Intent.mData field.
1851 */
1852 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1853 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1854
1855 /**
1856 * Broadcast Action: External media is present but cannot be mounted.
1857 * The path to the mount point for the removed media is contained in the Intent.mData field.
1858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1861
1862 /**
1863 * Broadcast Action: User has expressed the desire to remove the external storage media.
1864 * Applications should close all files they have open within the mount point when they receive this intent.
1865 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1866 */
1867 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1868 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1869
1870 /**
1871 * Broadcast Action: The media scanner has started scanning a directory.
1872 * The path to the directory being scanned is contained in the Intent.mData field.
1873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1875 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1876
1877 /**
1878 * Broadcast Action: The media scanner has finished scanning a directory.
1879 * The path to the scanned directory is contained in the Intent.mData field.
1880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1882 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1883
1884 /**
1885 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1886 * The path to the file is contained in the Intent.mData field.
1887 */
1888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1889 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1890
1891 /**
1892 * Broadcast Action: The "Media Button" was pressed. Includes a single
1893 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1894 * caused the broadcast.
1895 */
1896 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1897 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1898
1899 /**
1900 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1901 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1902 * caused the broadcast.
1903 */
1904 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1905 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1906
1907 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1908 // location; they are not general-purpose actions.
1909
1910 /**
1911 * Broadcast Action: An GTalk connection has been established.
1912 */
1913 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1914 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1915 "android.intent.action.GTALK_CONNECTED";
1916
1917 /**
1918 * Broadcast Action: An GTalk connection has been disconnected.
1919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1922 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001923
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001924 /**
1925 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_INPUT_METHOD_CHANGED =
1929 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930
1931 /**
1932 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1933 * more radios have been turned off or on. The intent will have the following extra value:</p>
1934 * <ul>
1935 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1936 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1937 * turned off</li>
1938 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001939 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001940 * <p class="note">This is a protected intent that can only be sent
1941 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 */
1943 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1944 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1945
1946 /**
1947 * Broadcast Action: Some content providers have parts of their namespace
1948 * where they publish new events or items that the user may be especially
1949 * interested in. For these things, they may broadcast this action when the
1950 * set of interesting items change.
1951 *
1952 * For example, GmailProvider sends this notification when the set of unread
1953 * mail in the inbox changes.
1954 *
1955 * <p>The data of the intent identifies which part of which provider
1956 * changed. When queried through the content resolver, the data URI will
1957 * return the data set in question.
1958 *
1959 * <p>The intent will have the following extra values:
1960 * <ul>
1961 * <li><em>count</em> - The number of items in the data set. This is the
1962 * same as the number of items in the cursor returned by querying the
1963 * data URI. </li>
1964 * </ul>
1965 *
1966 * This intent will be sent at boot (if the count is non-zero) and when the
1967 * data set changes. It is possible for the data set to change without the
1968 * count changing (for example, if a new unread message arrives in the same
1969 * sync operation in which a message is archived). The phone should still
1970 * ring/vibrate/etc as normal in this case.
1971 */
1972 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1973 public static final String ACTION_PROVIDER_CHANGED =
1974 "android.intent.action.PROVIDER_CHANGED";
1975
1976 /**
1977 * Broadcast Action: Wired Headset plugged in or unplugged.
1978 *
1979 * <p>The intent will have the following extra values:
1980 * <ul>
1981 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1982 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001983 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001984 * </ul>
1985 * </ul>
1986 */
1987 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1988 public static final String ACTION_HEADSET_PLUG =
1989 "android.intent.action.HEADSET_PLUG";
1990
1991 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001992 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
1993 *
1994 * <p>The intent will have the following extra values:
1995 * <ul>
1996 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1997 * <li><em>name</em> - Headset type, human readable string </li>
1998 * </ul>
1999 * </ul>
2000 * @hide
2001 */
2002 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2003 public static final String ACTION_USB_ANLG_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08002004 "android.intent.action.USB_ANLG_HEADSET_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002005
2006 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002007 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002008 *
2009 * <p>The intent will have the following extra values:
2010 * <ul>
2011 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2012 * <li><em>name</em> - Headset type, human readable string </li>
2013 * </ul>
2014 * </ul>
2015 * @hide
2016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_USB_DGTL_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08002019 "android.intent.action.USB_DGTL_HEADSET_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002020
2021 /**
2022 * Broadcast Action: A HMDI cable was plugged or unplugged
2023 *
2024 * <p>The intent will have the following extra values:
2025 * <ul>
2026 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2027 * <li><em>name</em> - HDMI cable, human readable string </li>
2028 * </ul>
2029 * </ul>
2030 * @hide
2031 */
2032 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2033 public static final String ACTION_HDMI_AUDIO_PLUG =
2034 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002035
2036 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002037 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2038 * <ul>
2039 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2040 * </ul>
2041 *
2042 * <p class="note">This is a protected intent that can only be sent
2043 * by the system.
2044 *
2045 * @hide
2046 */
2047 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2049 = "android.intent.action.ADVANCED_SETTINGS";
2050
2051 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002052 * Broadcast Action: An outgoing call is about to be placed.
2053 *
2054 * <p>The Intent will have the following extra value:
2055 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002056 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002057 * the phone number originally intended to be dialed.</li>
2058 * </ul>
2059 * <p>Once the broadcast is finished, the resultData is used as the actual
2060 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002061 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002062 * outgoing call in turn: for example, a parental control application
2063 * might verify that the user is authorized to place the call at that
2064 * time, then a number-rewriting application might add an area code if
2065 * one was not specified.</p>
2066 * <p>For consistency, any receiver whose purpose is to prohibit phone
2067 * calls should have a priority of 0, to ensure it will see the final
2068 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002069 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002070 * should have a positive priority.
2071 * Negative priorities are reserved for the system for this broadcast;
2072 * using them may cause problems.</p>
2073 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2074 * abort the broadcast.</p>
2075 * <p>Emergency calls cannot be intercepted using this mechanism, and
2076 * other calls cannot be modified to call emergency numbers using this
2077 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002078 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002079 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2080 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002081 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002082 * <p class="note">This is a protected intent that can only be sent
2083 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_NEW_OUTGOING_CALL =
2087 "android.intent.action.NEW_OUTGOING_CALL";
2088
2089 /**
2090 * Broadcast Action: Have the device reboot. This is only for use by
2091 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002092 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002093 * <p class="note">This is a protected intent that can only be sent
2094 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002095 */
2096 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2097 public static final String ACTION_REBOOT =
2098 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002099
Wei Huang97ecc9c2009-05-11 17:44:20 -07002100 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002101 * Broadcast Action: A sticky broadcast for changes in the physical
2102 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002103 *
2104 * <p>The intent will have the following extra values:
2105 * <ul>
2106 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002107 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002108 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002109 * <p>This is intended for monitoring the current physical dock state.
2110 * See {@link android.app.UiModeManager} for the normal API dealing with
2111 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002112 */
2113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_DOCK_EVENT =
2115 "android.intent.action.DOCK_EVENT";
2116
2117 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002118 * Broadcast Action: a remote intent is to be broadcasted.
2119 *
2120 * A remote intent is used for remote RPC between devices. The remote intent
2121 * is serialized and sent from one device to another device. The receiving
2122 * device parses the remote intent and broadcasts it. Note that anyone can
2123 * broadcast a remote intent. However, if the intent receiver of the remote intent
2124 * does not trust intent broadcasts from arbitrary intent senders, it should require
2125 * the sender to hold certain permissions so only trusted sender's broadcast will be
2126 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002127 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002128 */
2129 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002130 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002131
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002132 /**
2133 * Broadcast Action: hook for permforming cleanup after a system update.
2134 *
2135 * The broadcast is sent when the system is booting, before the
2136 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2137 * image. A receiver for this should do its work and then disable itself
2138 * so that it does not get run again at the next boot.
2139 * @hide
2140 */
2141 public static final String ACTION_PRE_BOOT_COMPLETED =
2142 "android.intent.action.PRE_BOOT_COMPLETED";
2143
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002144 // ---------------------------------------------------------------------
2145 // ---------------------------------------------------------------------
2146 // Standard intent categories (see addCategory()).
2147
2148 /**
2149 * Set if the activity should be an option for the default action
2150 * (center press) to perform on a piece of data. Setting this will
2151 * hide from the user any activities without it set when performing an
2152 * action on some data. Note that this is normal -not- set in the
2153 * Intent when initiating an action -- it is for use in intent filters
2154 * specified in packages.
2155 */
2156 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2157 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2158 /**
2159 * Activities that can be safely invoked from a browser must support this
2160 * category. For example, if the user is viewing a web page or an e-mail
2161 * and clicks on a link in the text, the Intent generated execute that
2162 * link will require the BROWSABLE category, so that only activities
2163 * supporting this category will be considered as possible actions. By
2164 * supporting this category, you are promising that there is nothing
2165 * damaging (without user intervention) that can happen by invoking any
2166 * matching Intent.
2167 */
2168 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2169 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2170 /**
2171 * Set if the activity should be considered as an alternative action to
2172 * the data the user is currently viewing. See also
2173 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2174 * applies to the selection in a list of items.
2175 *
2176 * <p>Supporting this category means that you would like your activity to be
2177 * displayed in the set of alternative things the user can do, usually as
2178 * part of the current activity's options menu. You will usually want to
2179 * include a specific label in the &lt;intent-filter&gt; of this action
2180 * describing to the user what it does.
2181 *
2182 * <p>The action of IntentFilter with this category is important in that it
2183 * describes the specific action the target will perform. This generally
2184 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2185 * a specific name such as "com.android.camera.action.CROP. Only one
2186 * alternative of any particular action will be shown to the user, so using
2187 * a specific action like this makes sure that your alternative will be
2188 * displayed while also allowing other applications to provide their own
2189 * overrides of that particular action.
2190 */
2191 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2192 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2193 /**
2194 * Set if the activity should be considered as an alternative selection
2195 * action to the data the user has currently selected. This is like
2196 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2197 * of items from which the user can select, giving them alternatives to the
2198 * default action that will be performed on it.
2199 */
2200 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2201 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2202 /**
2203 * Intended to be used as a tab inside of an containing TabActivity.
2204 */
2205 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2206 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2207 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002208 * Should be displayed in the top-level launcher.
2209 */
2210 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2211 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2212 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002213 * Provides information about the package it is in; typically used if
2214 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2215 * a front-door to the user without having to be shown in the all apps list.
2216 */
2217 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2218 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2219 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002220 * This is the home activity, that is the first activity that is displayed
2221 * when the device boots.
2222 */
2223 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2224 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2225 /**
2226 * This activity is a preference panel.
2227 */
2228 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2229 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2230 /**
2231 * This activity is a development preference panel.
2232 */
2233 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2234 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2235 /**
2236 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002237 */
2238 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2239 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2240 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002241 * This activity allows the user to browse and download new applications.
2242 */
2243 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2244 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2245 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002246 * This activity may be exercised by the monkey or other automated test tools.
2247 */
2248 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2249 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2250 /**
2251 * To be used as a test (not part of the normal user experience).
2252 */
2253 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2254 /**
2255 * To be used as a unit test (run through the Test Harness).
2256 */
2257 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2258 /**
2259 * To be used as an sample code example (not part of the normal user
2260 * experience).
2261 */
2262 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2263 /**
2264 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2265 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2266 * when queried, though it is allowable for those columns to be blank.
2267 */
2268 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2269 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2270
2271 /**
2272 * To be used as code under test for framework instrumentation tests.
2273 */
2274 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2275 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002276 /**
2277 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002278 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2279 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002280 */
2281 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2282 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2283 /**
2284 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002285 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2286 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002287 */
2288 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2289 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002290 /**
2291 * An activity to run when device is inserted into a analog (low end) dock.
2292 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2293 * information, see {@link android.app.UiModeManager}.
2294 */
2295 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2296 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2297
2298 /**
2299 * An activity to run when device is inserted into a digital (high end) dock.
2300 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2301 * information, see {@link android.app.UiModeManager}.
2302 */
2303 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2304 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002305
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002306 /**
2307 * Used to indicate that the activity can be used in a car environment.
2308 */
2309 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2310 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2311
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002312 // ---------------------------------------------------------------------
2313 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002314 // Application launch intent categories (see addCategory()).
2315
2316 /**
2317 * Used with {@link #ACTION_MAIN} to launch the browser application.
2318 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002319 * <p>NOTE: This should not be used as the primary key of an Intent,
2320 * since it will not result in the app launching with the correct
2321 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002322 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002323 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002324 */
2325 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2326 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2327
2328 /**
2329 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2330 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002331 * <p>NOTE: This should not be used as the primary key of an Intent,
2332 * since it will not result in the app launching with the correct
2333 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002334 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002335 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002336 */
2337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2338 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2339
2340 /**
2341 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2342 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002343 * <p>NOTE: This should not be used as the primary key of an Intent,
2344 * since it will not result in the app launching with the correct
2345 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002346 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002347 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002348 */
2349 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2350 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2351
2352 /**
2353 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2354 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002355 * <p>NOTE: This should not be used as the primary key of an Intent,
2356 * since it will not result in the app launching with the correct
2357 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002358 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002359 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002360 */
2361 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2362 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2363
2364 /**
2365 * Used with {@link #ACTION_MAIN} to launch the email application.
2366 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002367 * <p>NOTE: This should not be used as the primary key of an Intent,
2368 * since it will not result in the app launching with the correct
2369 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002370 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002371 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002372 */
2373 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2374 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2375
2376 /**
2377 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2378 * The activity should be able to view and manipulate image and video files
2379 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002380 * <p>NOTE: This should not be used as the primary key of an Intent,
2381 * since it will not result in the app launching with the correct
2382 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002383 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002384 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002385 */
2386 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2387 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2388
2389 /**
2390 * Used with {@link #ACTION_MAIN} to launch the maps application.
2391 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002392 * <p>NOTE: This should not be used as the primary key of an Intent,
2393 * since it will not result in the app launching with the correct
2394 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002395 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002396 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002397 */
2398 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2399 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2400
2401 /**
2402 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2403 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002404 * <p>NOTE: This should not be used as the primary key of an Intent,
2405 * since it will not result in the app launching with the correct
2406 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002407 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002408 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002409 */
2410 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2411 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2412
2413 /**
2414 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002415 * The activity should be able to play, browse, or manipulate music files
2416 * stored on the device.
2417 * <p>NOTE: This should not be used as the primary key of an Intent,
2418 * since it will not result in the app launching with the correct
2419 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002420 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002421 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002422 */
2423 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2424 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2425
2426 // ---------------------------------------------------------------------
2427 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002428 // Standard extra data keys.
2429
2430 /**
2431 * The initial data to place in a newly created record. Use with
2432 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2433 * fields as would be given to the underlying ContentProvider.insert()
2434 * call.
2435 */
2436 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2437
2438 /**
2439 * A constant CharSequence that is associated with the Intent, used with
2440 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2441 * this may be a styled CharSequence, so you must use
2442 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2443 * retrieve it.
2444 */
2445 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2446
2447 /**
2448 * A content: URI holding a stream of data associated with the Intent,
2449 * used with {@link #ACTION_SEND} to supply the data being sent.
2450 */
2451 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2452
2453 /**
2454 * A String[] holding e-mail addresses that should be delivered to.
2455 */
2456 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2457
2458 /**
2459 * A String[] holding e-mail addresses that should be carbon copied.
2460 */
2461 public static final String EXTRA_CC = "android.intent.extra.CC";
2462
2463 /**
2464 * A String[] holding e-mail addresses that should be blind carbon copied.
2465 */
2466 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2467
2468 /**
2469 * A constant string holding the desired subject line of a message.
2470 */
2471 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2472
2473 /**
2474 * An Intent describing the choices you would like shown with
2475 * {@link #ACTION_PICK_ACTIVITY}.
2476 */
2477 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2478
2479 /**
2480 * A CharSequence dialog title to provide to the user when used with a
2481 * {@link #ACTION_CHOOSER}.
2482 */
2483 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2484
2485 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002486 * A Parcelable[] of {@link Intent} or
2487 * {@link android.content.pm.LabeledIntent} objects as set with
2488 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2489 * a the front of the list of choices, when shown to the user with a
2490 * {@link #ACTION_CHOOSER}.
2491 */
2492 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2493
2494 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002495 * A {@link android.view.KeyEvent} object containing the event that
2496 * triggered the creation of the Intent it is in.
2497 */
2498 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2499
2500 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002501 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2502 * before shutting down.
2503 *
2504 * {@hide}
2505 */
2506 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2507
2508 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002509 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2510 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2511 * of restarting the application.
2512 */
2513 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2514
2515 /**
2516 * A String holding the phone number originally entered in
2517 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2518 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2519 */
2520 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002521
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002522 /**
2523 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2524 * intents to supply the uid the package had been assigned. Also an optional
2525 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2526 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2527 * purpose.
2528 */
2529 public static final String EXTRA_UID = "android.intent.extra.UID";
2530
2531 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002532 * @hide String array of package names.
2533 */
2534 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2535
2536 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002537 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2538 * intents to indicate whether this represents a full uninstall (removing
2539 * both the code and its data) or a partial uninstall (leaving its data,
2540 * implying that this is an update).
2541 */
2542 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002543
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002544 /**
2545 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2546 * intents to indicate that this is a replacement of the package, so this
2547 * broadcast will immediately be followed by an add broadcast for a
2548 * different version of the same package.
2549 */
2550 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002551
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002552 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002553 * Used as an int extra field in {@link android.app.AlarmManager} intents
2554 * to tell the application being invoked how many pending alarms are being
2555 * delievered with the intent. For one-shot alarms this will always be 1.
2556 * For recurring alarms, this might be greater than 1 if the device was
2557 * asleep or powered off at the time an earlier alarm would have been
2558 * delivered.
2559 */
2560 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002561
Jacek Surazski86b6c532009-05-13 14:38:28 +02002562 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002563 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2564 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002565 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2566 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002567 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2568 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2569 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002570 */
2571 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2572
2573 /**
2574 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2575 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002576 */
2577 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2578
2579 /**
2580 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2581 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002582 */
2583 public static final int EXTRA_DOCK_STATE_DESK = 1;
2584
2585 /**
2586 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2587 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002588 */
2589 public static final int EXTRA_DOCK_STATE_CAR = 2;
2590
2591 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002592 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2593 * to represent that the phone is in a analog (low end) dock.
2594 */
2595 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2596
2597 /**
2598 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2599 * to represent that the phone is in a digital (high end) dock.
2600 */
2601 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2602
2603 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002604 * Boolean that can be supplied as meta-data with a dock activity, to
2605 * indicate that the dock should take over the home key when it is active.
2606 */
2607 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002608
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002609 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002610 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2611 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002612 */
2613 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2614
2615 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002616 * Used in the extra field in the remote intent. It's astring token passed with the
2617 * remote intent.
2618 */
2619 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2620 "android.intent.extra.remote_intent_token";
2621
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002622 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002623 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002624 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002625 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002626 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002627 "android.intent.extra.changed_component_name";
2628
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002629 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002630 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002631 * and contains a string array of all of the components that have changed.
2632 */
2633 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2634 "android.intent.extra.changed_component_name_list";
2635
2636 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002637 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002638 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2639 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002640 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002641 */
2642 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2643 "android.intent.extra.changed_package_list";
2644
2645 /**
2646 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002647 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2648 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002649 * and contains an integer array of uids of all of the components
2650 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002651 */
2652 public static final String EXTRA_CHANGED_UID_LIST =
2653 "android.intent.extra.changed_uid_list";
2654
2655 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002656 * @hide
2657 * Magic extra system code can use when binding, to give a label for
2658 * who it is that has bound to a service. This is an integer giving
2659 * a framework string resource that can be displayed to the user.
2660 */
2661 public static final String EXTRA_CLIENT_LABEL =
2662 "android.intent.extra.client_label";
2663
2664 /**
2665 * @hide
2666 * Magic extra system code can use when binding, to give a PendingIntent object
2667 * that can be launched for the user to disable the system's use of this
2668 * service.
2669 */
2670 public static final String EXTRA_CLIENT_INTENT =
2671 "android.intent.extra.client_intent";
2672
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002673 /**
2674 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2675 * data that is on the local device. This is a boolean extra; the default
2676 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2677 * the user to select media that is already on the device, not requiring it
2678 * be downloaded from a remote service when opened. Another way to look
2679 * at it is that such content should generally have a "_data" column to the
2680 * path of the content on local external storage.
2681 */
2682 public static final String EXTRA_LOCAL_ONLY =
2683 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002684
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002685 // ---------------------------------------------------------------------
2686 // ---------------------------------------------------------------------
2687 // Intent flags (see mFlags variable).
2688
2689 /**
2690 * If set, the recipient of this Intent will be granted permission to
2691 * perform read operations on the Uri in the Intent's data.
2692 */
2693 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2694 /**
2695 * If set, the recipient of this Intent will be granted permission to
2696 * perform write operations on the Uri in the Intent's data.
2697 */
2698 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2699 /**
2700 * Can be set by the caller to indicate that this Intent is coming from
2701 * a background operation, not from direct user interaction.
2702 */
2703 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2704 /**
2705 * A flag you can enable for debugging: when set, log messages will be
2706 * printed during the resolution of this intent to show you what has
2707 * been found to create the final resolved list.
2708 */
2709 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002710 /**
2711 * If set, this intent will not match any components in packages that
2712 * are currently stopped. If this is not set, then the default behavior
2713 * is to include such applications in the result.
2714 */
2715 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2716 /**
2717 * If set, this intent will always match any components in packages that
2718 * are currently stopped. This is the default behavior when
2719 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2720 * flags are set, this one wins (it allows overriding of exclude for
2721 * places where the framework may automatically set the exclude flag).
2722 */
2723 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002724
2725 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002726 * If set, the new activity is not kept in the history stack. As soon as
2727 * the user navigates away from it, the activity is finished. This may also
2728 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2729 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002730 */
2731 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2732 /**
2733 * If set, the activity will not be launched if it is already running
2734 * at the top of the history stack.
2735 */
2736 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2737 /**
2738 * If set, this activity will become the start of a new task on this
2739 * history stack. A task (from the activity that started it to the
2740 * next task activity) defines an atomic group of activities that the
2741 * user can move to. Tasks can be moved to the foreground and background;
2742 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002743 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002744 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2745 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002746 *
2747 * <p>This flag is generally used by activities that want
2748 * to present a "launcher" style behavior: they give the user a list of
2749 * separate things that can be done, which otherwise run completely
2750 * independently of the activity launching them.
2751 *
2752 * <p>When using this flag, if a task is already running for the activity
2753 * you are now starting, then a new activity will not be started; instead,
2754 * the current task will simply be brought to the front of the screen with
2755 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2756 * to disable this behavior.
2757 *
2758 * <p>This flag can not be used when the caller is requesting a result from
2759 * the activity being launched.
2760 */
2761 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2762 /**
2763 * <strong>Do not use this flag unless you are implementing your own
2764 * top-level application launcher.</strong> Used in conjunction with
2765 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2766 * behavior of bringing an existing task to the foreground. When set,
2767 * a new task is <em>always</em> started to host the Activity for the
2768 * Intent, regardless of whether there is already an existing task running
2769 * the same thing.
2770 *
2771 * <p><strong>Because the default system does not include graphical task management,
2772 * you should not use this flag unless you provide some way for a user to
2773 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002774 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002775 * <p>This flag is ignored if
2776 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2777 *
Scott Main7aee61f2011-02-08 11:25:01 -08002778 * <p>See
2779 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2780 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002781 */
2782 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2783 /**
2784 * If set, and the activity being launched is already running in the
2785 * current task, then instead of launching a new instance of that activity,
2786 * all of the other activities on top of it will be closed and this Intent
2787 * will be delivered to the (now on top) old activity as a new Intent.
2788 *
2789 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2790 * If D calls startActivity() with an Intent that resolves to the component
2791 * of activity B, then C and D will be finished and B receive the given
2792 * Intent, resulting in the stack now being: A, B.
2793 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002794 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002795 * either receive the new intent you are starting here in its
2796 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002797 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002798 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2799 * the same intent, then it will be finished and re-created; for all other
2800 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2801 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002802 *
2803 * <p>This launch mode can also be used to good effect in conjunction with
2804 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2805 * of a task, it will bring any currently running instance of that task
2806 * to the foreground, and then clear it to its root state. This is
2807 * especially useful, for example, when launching an activity from the
2808 * notification manager.
2809 *
Scott Main7aee61f2011-02-08 11:25:01 -08002810 * <p>See
2811 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2812 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002813 */
2814 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2815 /**
2816 * If set and this intent is being used to launch a new activity from an
2817 * existing one, then the reply target of the existing activity will be
2818 * transfered to the new activity. This way the new activity can call
2819 * {@link android.app.Activity#setResult} and have that result sent back to
2820 * the reply target of the original activity.
2821 */
2822 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2823 /**
2824 * If set and this intent is being used to launch a new activity from an
2825 * existing one, the current activity will not be counted as the top
2826 * activity for deciding whether the new intent should be delivered to
2827 * the top instead of starting a new one. The previous activity will
2828 * be used as the top, with the assumption being that the current activity
2829 * will finish itself immediately.
2830 */
2831 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2832 /**
2833 * If set, the new activity is not kept in the list of recently launched
2834 * activities.
2835 */
2836 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2837 /**
2838 * This flag is not normally set by application code, but set for you by
2839 * the system as described in the
2840 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2841 * launchMode} documentation for the singleTask mode.
2842 */
2843 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2844 /**
2845 * If set, and this activity is either being started in a new task or
2846 * bringing to the top an existing task, then it will be launched as
2847 * the front door of the task. This will result in the application of
2848 * any affinities needed to have that task in the proper state (either
2849 * moving activities to or from it), or simply resetting that task to
2850 * its initial state if needed.
2851 */
2852 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2853 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002854 * This flag is not normally set by application code, but set for you by
2855 * the system if this activity is being launched from history
2856 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002857 */
2858 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002859 /**
2860 * If set, this marks a point in the task's activity stack that should
2861 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002862 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002863 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2864 * the user re-launching it from home), this activity and all on top of
2865 * it will be finished so that the user does not return to them, but
2866 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002867 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002868 * <p>This is useful for cases where you have a logical break in your
2869 * application. For example, an e-mail application may have a command
2870 * to view an attachment, which launches an image view activity to
2871 * display it. This activity should be part of the e-mail application's
2872 * task, since it is a part of the task the user is involved in. However,
2873 * if the user leaves that task, and later selects the e-mail app from
2874 * home, we may like them to return to the conversation they were
2875 * viewing, not the picture attachment, since that is confusing. By
2876 * setting this flag when launching the image viewer, that viewer and
2877 * any activities it starts will be removed the next time the user returns
2878 * to mail.
2879 */
2880 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002881 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002882 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002883 * callback from occurring on the current frontmost activity before it is
2884 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002885 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002886 * <p>Typically, an activity can rely on that callback to indicate that an
2887 * explicit user action has caused their activity to be moved out of the
2888 * foreground. The callback marks an appropriate point in the activity's
2889 * lifecycle for it to dismiss any notifications that it intends to display
2890 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002891 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002892 * <p>If an activity is ever started via any non-user-driven events such as
2893 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2894 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002895 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002896 */
2897 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002898 /**
2899 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2900 * this flag will cause the launched activity to be brought to the front of its
2901 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002902 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002903 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2904 * If D calls startActivity() with an Intent that resolves to the component
2905 * of activity B, then B will be brought to the front of the history stack,
2906 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002907 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002908 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002909 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002910 */
2911 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002912 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002913 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2914 * this flag will prevent the system from applying an activity transition
2915 * animation to go to the next activity state. This doesn't mean an
2916 * animation will never run -- if another activity change happens that doesn't
2917 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002918 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002919 * when you are going to do a series of activity operations but the
2920 * animation seen by the user shouldn't be driven by the first activity
2921 * change but rather a later one.
2922 */
2923 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2924 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002925 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2926 * this flag will cause any existing task that would be associated with the
2927 * activity to be cleared before the activity is started. That is, the activity
2928 * becomes the new root of an otherwise empty task, and any old activities
2929 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2930 */
2931 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
2932 /**
2933 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2934 * this flag will cause a newly launching task to be placed on top of the current
2935 * home activity task (if there is one). That is, pressing back from the task
2936 * will always return the user to home even if that was not the last activity they
2937 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2938 */
2939 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
2940 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002941 * If set, when sending a broadcast only registered receivers will be
2942 * called -- no BroadcastReceiver components will be launched.
2943 */
2944 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002945 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002946 * If set, when sending a broadcast the new broadcast will replace
2947 * any existing pending broadcast that matches it. Matching is defined
2948 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
2949 * true for the intents of the two broadcasts. When a match is found,
2950 * the new broadcast (and receivers associated with it) will replace the
2951 * existing one in the pending broadcast list, remaining at the same
2952 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08002953 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002954 * <p>This flag is most typically used with sticky broadcasts, which
2955 * only care about delivering the most recent values of the broadcast
2956 * to their receivers.
2957 */
2958 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
2959 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08002960 * If set, when sending a broadcast the recipient is allowed to run at
2961 * foreground priority, with a shorter timeout interval. During normal
2962 * broadcasts the receivers are not automatically hoisted out of the
2963 * background priority class.
2964 */
2965 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
2966 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002967 * If set, when sending a broadcast <i>before boot has completed</i> only
2968 * registered receivers will be called -- no BroadcastReceiver components
2969 * will be launched. Sticky intent state will be recorded properly even
2970 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2971 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002972 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002973 * <p>This flag is only for use by system sevices as a convenience to
2974 * avoid having to implement a more complex mechanism around detection
2975 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002976 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002977 * @hide
2978 */
Christopher Tatef46723b2012-01-26 14:19:24 -08002979 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002980 /**
2981 * Set when this broadcast is for a boot upgrade, a special mode that
2982 * allows the broadcast to be sent before the system is ready and launches
2983 * the app process with no providers running in it.
2984 * @hide
2985 */
Christopher Tatef46723b2012-01-26 14:19:24 -08002986 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002987
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002988 /**
2989 * @hide Flags that can't be changed with PendingIntent.
2990 */
2991 public static final int IMMUTABLE_FLAGS =
2992 FLAG_GRANT_READ_URI_PERMISSION
2993 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08002994
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002995 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002996 // ---------------------------------------------------------------------
2997 // toUri() and parseUri() options.
2998
2999 /**
3000 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3001 * always has the "intent:" scheme. This syntax can be used when you want
3002 * to later disambiguate between URIs that are intended to describe an
3003 * Intent vs. all others that should be treated as raw URIs. When used
3004 * with {@link #parseUri}, any other scheme will result in a generic
3005 * VIEW action for that raw URI.
3006 */
3007 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003008
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003009 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003010
3011 private String mAction;
3012 private Uri mData;
3013 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003014 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003015 private ComponentName mComponent;
3016 private int mFlags;
3017 private HashSet<String> mCategories;
3018 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003019 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003020 private Intent mSelector;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003021
3022 // ---------------------------------------------------------------------
3023
3024 /**
3025 * Create an empty intent.
3026 */
3027 public Intent() {
3028 }
3029
3030 /**
3031 * Copy constructor.
3032 */
3033 public Intent(Intent o) {
3034 this.mAction = o.mAction;
3035 this.mData = o.mData;
3036 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003037 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003038 this.mComponent = o.mComponent;
3039 this.mFlags = o.mFlags;
3040 if (o.mCategories != null) {
3041 this.mCategories = new HashSet<String>(o.mCategories);
3042 }
3043 if (o.mExtras != null) {
3044 this.mExtras = new Bundle(o.mExtras);
3045 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003046 if (o.mSourceBounds != null) {
3047 this.mSourceBounds = new Rect(o.mSourceBounds);
3048 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003049 if (o.mSelector != null) {
3050 this.mSelector = new Intent(o.mSelector);
3051 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003052 }
3053
3054 @Override
3055 public Object clone() {
3056 return new Intent(this);
3057 }
3058
3059 private Intent(Intent o, boolean all) {
3060 this.mAction = o.mAction;
3061 this.mData = o.mData;
3062 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003063 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003064 this.mComponent = o.mComponent;
3065 if (o.mCategories != null) {
3066 this.mCategories = new HashSet<String>(o.mCategories);
3067 }
3068 }
3069
3070 /**
3071 * Make a clone of only the parts of the Intent that are relevant for
3072 * filter matching: the action, data, type, component, and categories.
3073 */
3074 public Intent cloneFilter() {
3075 return new Intent(this, false);
3076 }
3077
3078 /**
3079 * Create an intent with a given action. All other fields (data, type,
3080 * class) are null. Note that the action <em>must</em> be in a
3081 * namespace because Intents are used globally in the system -- for
3082 * example the system VIEW action is android.intent.action.VIEW; an
3083 * application's custom action would be something like
3084 * com.google.app.myapp.CUSTOM_ACTION.
3085 *
3086 * @param action The Intent action, such as ACTION_VIEW.
3087 */
3088 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003089 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003090 }
3091
3092 /**
3093 * Create an intent with a given action and for a given data url. Note
3094 * that the action <em>must</em> be in a namespace because Intents are
3095 * used globally in the system -- for example the system VIEW action is
3096 * android.intent.action.VIEW; an application's custom action would be
3097 * something like com.google.app.myapp.CUSTOM_ACTION.
3098 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003099 * <p><em>Note: scheme and host name matching in the Android framework is
3100 * case-sensitive, unlike the formal RFC. As a result,
3101 * you should always ensure that you write your Uri with these elements
3102 * using lower case letters, and normalize any Uris you receive from
3103 * outside of Android to ensure the scheme and host is lower case.</em></p>
3104 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003105 * @param action The Intent action, such as ACTION_VIEW.
3106 * @param uri The Intent data URI.
3107 */
3108 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003109 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003110 mData = uri;
3111 }
3112
3113 /**
3114 * Create an intent for a specific component. All other fields (action, data,
3115 * type, class) are null, though they can be modified later with explicit
3116 * calls. This provides a convenient way to create an intent that is
3117 * intended to execute a hard-coded class name, rather than relying on the
3118 * system to find an appropriate class for you; see {@link #setComponent}
3119 * for more information on the repercussions of this.
3120 *
3121 * @param packageContext A Context of the application package implementing
3122 * this class.
3123 * @param cls The component class that is to be used for the intent.
3124 *
3125 * @see #setClass
3126 * @see #setComponent
3127 * @see #Intent(String, android.net.Uri , Context, Class)
3128 */
3129 public Intent(Context packageContext, Class<?> cls) {
3130 mComponent = new ComponentName(packageContext, cls);
3131 }
3132
3133 /**
3134 * Create an intent for a specific component with a specified action and data.
3135 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3136 * construct the Intent and then calling {@link #setClass} to set its
3137 * class.
3138 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003139 * <p><em>Note: scheme and host name matching in the Android framework is
3140 * case-sensitive, unlike the formal RFC. As a result,
3141 * you should always ensure that you write your Uri with these elements
3142 * using lower case letters, and normalize any Uris you receive from
3143 * outside of Android to ensure the scheme and host is lower case.</em></p>
3144 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003145 * @param action The Intent action, such as ACTION_VIEW.
3146 * @param uri The Intent data URI.
3147 * @param packageContext A Context of the application package implementing
3148 * this class.
3149 * @param cls The component class that is to be used for the intent.
3150 *
3151 * @see #Intent(String, android.net.Uri)
3152 * @see #Intent(Context, Class)
3153 * @see #setClass
3154 * @see #setComponent
3155 */
3156 public Intent(String action, Uri uri,
3157 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003158 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003159 mData = uri;
3160 mComponent = new ComponentName(packageContext, cls);
3161 }
3162
3163 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003164 * Create an intent to launch the main (root) activity of a task. This
3165 * is the Intent that is started when the application's is launched from
3166 * Home. For anything else that wants to launch an application in the
3167 * same way, it is important that they use an Intent structured the same
3168 * way, and can use this function to ensure this is the case.
3169 *
3170 * <p>The returned Intent has the given Activity component as its explicit
3171 * component, {@link #ACTION_MAIN} as its action, and includes the
3172 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3173 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3174 * to do that through {@link #addFlags(int)} on the returned Intent.
3175 *
3176 * @param mainActivity The main activity component that this Intent will
3177 * launch.
3178 * @return Returns a newly created Intent that can be used to launch the
3179 * activity as a main application entry.
3180 *
3181 * @see #setClass
3182 * @see #setComponent
3183 */
3184 public static Intent makeMainActivity(ComponentName mainActivity) {
3185 Intent intent = new Intent(ACTION_MAIN);
3186 intent.setComponent(mainActivity);
3187 intent.addCategory(CATEGORY_LAUNCHER);
3188 return intent;
3189 }
3190
3191 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003192 * Make an Intent for the main activity of an application, without
3193 * specifying a specific activity to run but giving a selector to find
3194 * the activity. This results in a final Intent that is structured
3195 * the same as when the application is launched from
3196 * Home. For anything else that wants to launch an application in the
3197 * same way, it is important that they use an Intent structured the same
3198 * way, and can use this function to ensure this is the case.
3199 *
3200 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3201 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3202 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3203 * to do that through {@link #addFlags(int)} on the returned Intent.
3204 *
3205 * @param selectorAction The action name of the Intent's selector.
3206 * @param selectorCategory The name of a category to add to the Intent's
3207 * selector.
3208 * @return Returns a newly created Intent that can be used to launch the
3209 * activity as a main application entry.
3210 *
3211 * @see #setSelector(Intent)
3212 */
3213 public static Intent makeMainSelectorActivity(String selectorAction,
3214 String selectorCategory) {
3215 Intent intent = new Intent(ACTION_MAIN);
3216 intent.addCategory(CATEGORY_LAUNCHER);
3217 Intent selector = new Intent();
3218 selector.setAction(selectorAction);
3219 selector.addCategory(selectorCategory);
3220 intent.setSelector(selector);
3221 return intent;
3222 }
3223
3224 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003225 * Make an Intent that can be used to re-launch an application's task
3226 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3227 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3228 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3229 *
3230 * @param mainActivity The activity component that is the root of the
3231 * task; this is the activity that has been published in the application's
3232 * manifest as the main launcher icon.
3233 *
3234 * @return Returns a newly created Intent that can be used to relaunch the
3235 * activity's task in its root state.
3236 */
3237 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3238 Intent intent = makeMainActivity(mainActivity);
3239 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3240 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3241 return intent;
3242 }
3243
3244 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003245 * Call {@link #parseUri} with 0 flags.
3246 * @deprecated Use {@link #parseUri} instead.
3247 */
3248 @Deprecated
3249 public static Intent getIntent(String uri) throws URISyntaxException {
3250 return parseUri(uri, 0);
3251 }
Tom Taylord4a47292009-12-21 13:59:18 -08003252
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003253 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003254 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003255 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003256 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003257 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003258 *
3259 * <p>The URI given here must not be relative -- that is, it must include
3260 * the scheme and full path.
3261 *
3262 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003263 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003264 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003265 *
3266 * @return Intent The newly created Intent object.
3267 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003268 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3269 * it bad (as parsed by the Uri class) or the Intent data within the
3270 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003271 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003272 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003273 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003274 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003275 int i = 0;
3276 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003277 // Validate intent scheme for if requested.
3278 if ((flags&URI_INTENT_SCHEME) != 0) {
3279 if (!uri.startsWith("intent:")) {
3280 Intent intent = new Intent(ACTION_VIEW);
3281 try {
3282 intent.setData(Uri.parse(uri));
3283 } catch (IllegalArgumentException e) {
3284 throw new URISyntaxException(uri, e.getMessage());
3285 }
3286 return intent;
3287 }
3288 }
Tom Taylord4a47292009-12-21 13:59:18 -08003289
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003290 // simple case
3291 i = uri.lastIndexOf("#");
3292 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3293
3294 // old format Intent URI
3295 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003296
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003297 // new format
3298 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003299 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003300
3301 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003302 String data = i >= 0 ? uri.substring(0, i) : null;
3303 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003304 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003305
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003306 // loop over contents of Intent, all name=value;
3307 while (!uri.startsWith("end", i)) {
3308 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003309 if (eq < 0) eq = i-1;
3310 int semi = uri.indexOf(';', i);
3311 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003312
3313 // action
3314 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003315 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003316 }
3317
3318 // categories
3319 else if (uri.startsWith("category=", i)) {
3320 intent.addCategory(value);
3321 }
3322
3323 // type
3324 else if (uri.startsWith("type=", i)) {
3325 intent.mType = value;
3326 }
3327
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003328 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003329 else if (uri.startsWith("launchFlags=", i)) {
3330 intent.mFlags = Integer.decode(value).intValue();
3331 }
3332
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003333 // package
3334 else if (uri.startsWith("package=", i)) {
3335 intent.mPackage = value;
3336 }
3337
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003338 // component
3339 else if (uri.startsWith("component=", i)) {
3340 intent.mComponent = ComponentName.unflattenFromString(value);
3341 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003342
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003343 // scheme
3344 else if (uri.startsWith("scheme=", i)) {
3345 scheme = value;
3346 }
3347
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003348 // source bounds
3349 else if (uri.startsWith("sourceBounds=", i)) {
3350 intent.mSourceBounds = Rect.unflattenFromString(value);
3351 }
3352
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003353 // selector
3354 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3355 intent = new Intent();
3356 }
3357
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003358 // extra
3359 else {
3360 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003361 // create Bundle if it doesn't already exist
3362 if (intent.mExtras == null) intent.mExtras = new Bundle();
3363 Bundle b = intent.mExtras;
3364 // add EXTRA
3365 if (uri.startsWith("S.", i)) b.putString(key, value);
3366 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3367 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3368 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3369 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3370 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3371 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3372 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3373 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3374 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3375 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003376
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003377 // move to the next item
3378 i = semi + 1;
3379 }
3380
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003381 if (intent != baseIntent) {
3382 // The Intent had a selector; fix it up.
3383 baseIntent.setSelector(intent);
3384 intent = baseIntent;
3385 }
3386
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003387 if (data != null) {
3388 if (data.startsWith("intent:")) {
3389 data = data.substring(7);
3390 if (scheme != null) {
3391 data = scheme + ':' + data;
3392 }
3393 }
Tom Taylord4a47292009-12-21 13:59:18 -08003394
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003395 if (data.length() > 0) {
3396 try {
3397 intent.mData = Uri.parse(data);
3398 } catch (IllegalArgumentException e) {
3399 throw new URISyntaxException(uri, e.getMessage());
3400 }
3401 }
3402 }
Tom Taylord4a47292009-12-21 13:59:18 -08003403
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003404 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003405
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003406 } catch (IndexOutOfBoundsException e) {
3407 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3408 }
3409 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003410
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003411 public static Intent getIntentOld(String uri) throws URISyntaxException {
3412 Intent intent;
3413
3414 int i = uri.lastIndexOf('#');
3415 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003416 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003417 final int intentFragmentStart = i;
3418 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003419
3420 i++;
3421
3422 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003423 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003424 i += 7;
3425 int j = uri.indexOf(')', i);
3426 action = uri.substring(i, j);
3427 i = j + 1;
3428 }
3429
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003430 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003431
3432 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003433 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003434 i += 11;
3435 int j = uri.indexOf(')', i);
3436 while (i < j) {
3437 int sep = uri.indexOf('!', i);
3438 if (sep < 0) sep = j;
3439 if (i < sep) {
3440 intent.addCategory(uri.substring(i, sep));
3441 }
3442 i = sep + 1;
3443 }
3444 i = j + 1;
3445 }
3446
3447 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003448 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003449 i += 5;
3450 int j = uri.indexOf(')', i);
3451 intent.mType = uri.substring(i, j);
3452 i = j + 1;
3453 }
3454
3455 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003456 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003457 i += 12;
3458 int j = uri.indexOf(')', i);
3459 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3460 i = j + 1;
3461 }
3462
3463 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003464 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003465 i += 10;
3466 int j = uri.indexOf(')', i);
3467 int sep = uri.indexOf('!', i);
3468 if (sep >= 0 && sep < j) {
3469 String pkg = uri.substring(i, sep);
3470 String cls = uri.substring(sep + 1, j);
3471 intent.mComponent = new ComponentName(pkg, cls);
3472 }
3473 i = j + 1;
3474 }
3475
3476 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003477 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003478 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003479
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003480 final int closeParen = uri.indexOf(')', i);
3481 if (closeParen == -1) throw new URISyntaxException(uri,
3482 "EXTRA missing trailing ')'", i);
3483
3484 while (i < closeParen) {
3485 // fetch the key value
3486 int j = uri.indexOf('=', i);
3487 if (j <= i + 1 || i >= closeParen) {
3488 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3489 }
3490 char type = uri.charAt(i);
3491 i++;
3492 String key = uri.substring(i, j);
3493 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003494
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003495 // get type-value
3496 j = uri.indexOf('!', i);
3497 if (j == -1 || j >= closeParen) j = closeParen;
3498 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3499 String value = uri.substring(i, j);
3500 i = j;
3501
3502 // create Bundle if it doesn't already exist
3503 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003504
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003505 // add item to bundle
3506 try {
3507 switch (type) {
3508 case 'S':
3509 intent.mExtras.putString(key, Uri.decode(value));
3510 break;
3511 case 'B':
3512 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3513 break;
3514 case 'b':
3515 intent.mExtras.putByte(key, Byte.parseByte(value));
3516 break;
3517 case 'c':
3518 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3519 break;
3520 case 'd':
3521 intent.mExtras.putDouble(key, Double.parseDouble(value));
3522 break;
3523 case 'f':
3524 intent.mExtras.putFloat(key, Float.parseFloat(value));
3525 break;
3526 case 'i':
3527 intent.mExtras.putInt(key, Integer.parseInt(value));
3528 break;
3529 case 'l':
3530 intent.mExtras.putLong(key, Long.parseLong(value));
3531 break;
3532 case 's':
3533 intent.mExtras.putShort(key, Short.parseShort(value));
3534 break;
3535 default:
3536 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3537 }
3538 } catch (NumberFormatException e) {
3539 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3540 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003541
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003542 char ch = uri.charAt(i);
3543 if (ch == ')') break;
3544 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3545 i++;
3546 }
3547 }
3548
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003549 if (isIntentFragment) {
3550 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3551 } else {
3552 intent.mData = Uri.parse(uri);
3553 }
Tom Taylord4a47292009-12-21 13:59:18 -08003554
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003555 if (intent.mAction == null) {
3556 // By default, if no action is specified, then use VIEW.
3557 intent.mAction = ACTION_VIEW;
3558 }
3559
3560 } else {
3561 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3562 }
3563
3564 return intent;
3565 }
3566
3567 /**
3568 * Retrieve the general action to be performed, such as
3569 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3570 * the information in the intent should be interpreted -- most importantly,
3571 * what to do with the data returned by {@link #getData}.
3572 *
3573 * @return The action of this intent or null if none is specified.
3574 *
3575 * @see #setAction
3576 */
3577 public String getAction() {
3578 return mAction;
3579 }
3580
3581 /**
3582 * Retrieve data this intent is operating on. This URI specifies the name
3583 * of the data; often it uses the content: scheme, specifying data in a
3584 * content provider. Other schemes may be handled by specific activities,
3585 * such as http: by the web browser.
3586 *
3587 * @return The URI of the data this intent is targeting or null.
3588 *
3589 * @see #getScheme
3590 * @see #setData
3591 */
3592 public Uri getData() {
3593 return mData;
3594 }
3595
3596 /**
3597 * The same as {@link #getData()}, but returns the URI as an encoded
3598 * String.
3599 */
3600 public String getDataString() {
3601 return mData != null ? mData.toString() : null;
3602 }
3603
3604 /**
3605 * Return the scheme portion of the intent's data. If the data is null or
3606 * does not include a scheme, null is returned. Otherwise, the scheme
3607 * prefix without the final ':' is returned, i.e. "http".
3608 *
3609 * <p>This is the same as calling getData().getScheme() (and checking for
3610 * null data).
3611 *
3612 * @return The scheme of this intent.
3613 *
3614 * @see #getData
3615 */
3616 public String getScheme() {
3617 return mData != null ? mData.getScheme() : null;
3618 }
3619
3620 /**
3621 * Retrieve any explicit MIME type included in the intent. This is usually
3622 * null, as the type is determined by the intent data.
3623 *
3624 * @return If a type was manually set, it is returned; else null is
3625 * returned.
3626 *
3627 * @see #resolveType(ContentResolver)
3628 * @see #setType
3629 */
3630 public String getType() {
3631 return mType;
3632 }
3633
3634 /**
3635 * Return the MIME data type of this intent. If the type field is
3636 * explicitly set, that is simply returned. Otherwise, if the data is set,
3637 * the type of that data is returned. If neither fields are set, a null is
3638 * returned.
3639 *
3640 * @return The MIME type of this intent.
3641 *
3642 * @see #getType
3643 * @see #resolveType(ContentResolver)
3644 */
3645 public String resolveType(Context context) {
3646 return resolveType(context.getContentResolver());
3647 }
3648
3649 /**
3650 * Return the MIME data type of this intent. If the type field is
3651 * explicitly set, that is simply returned. Otherwise, if the data is set,
3652 * the type of that data is returned. If neither fields are set, a null is
3653 * returned.
3654 *
3655 * @param resolver A ContentResolver that can be used to determine the MIME
3656 * type of the intent's data.
3657 *
3658 * @return The MIME type of this intent.
3659 *
3660 * @see #getType
3661 * @see #resolveType(Context)
3662 */
3663 public String resolveType(ContentResolver resolver) {
3664 if (mType != null) {
3665 return mType;
3666 }
3667 if (mData != null) {
3668 if ("content".equals(mData.getScheme())) {
3669 return resolver.getType(mData);
3670 }
3671 }
3672 return null;
3673 }
3674
3675 /**
3676 * Return the MIME data type of this intent, only if it will be needed for
3677 * intent resolution. This is not generally useful for application code;
3678 * it is used by the frameworks for communicating with back-end system
3679 * services.
3680 *
3681 * @param resolver A ContentResolver that can be used to determine the MIME
3682 * type of the intent's data.
3683 *
3684 * @return The MIME type of this intent, or null if it is unknown or not
3685 * needed.
3686 */
3687 public String resolveTypeIfNeeded(ContentResolver resolver) {
3688 if (mComponent != null) {
3689 return mType;
3690 }
3691 return resolveType(resolver);
3692 }
3693
3694 /**
3695 * Check if an category exists in the intent.
3696 *
3697 * @param category The category to check.
3698 *
3699 * @return boolean True if the intent contains the category, else false.
3700 *
3701 * @see #getCategories
3702 * @see #addCategory
3703 */
3704 public boolean hasCategory(String category) {
3705 return mCategories != null && mCategories.contains(category);
3706 }
3707
3708 /**
3709 * Return the set of all categories in the intent. If there are no categories,
3710 * returns NULL.
3711 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003712 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003713 *
3714 * @see #hasCategory
3715 * @see #addCategory
3716 */
3717 public Set<String> getCategories() {
3718 return mCategories;
3719 }
3720
3721 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003722 * Return the specific selector associated with this Intent. If there is
3723 * none, returns null. See {@link #setSelector} for more information.
3724 *
3725 * @see #setSelector
3726 */
3727 public Intent getSelector() {
3728 return mSelector;
3729 }
3730
3731 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003732 * Sets the ClassLoader that will be used when unmarshalling
3733 * any Parcelable values from the extras of this Intent.
3734 *
3735 * @param loader a ClassLoader, or null to use the default loader
3736 * at the time of unmarshalling.
3737 */
3738 public void setExtrasClassLoader(ClassLoader loader) {
3739 if (mExtras != null) {
3740 mExtras.setClassLoader(loader);
3741 }
3742 }
3743
3744 /**
3745 * Returns true if an extra value is associated with the given name.
3746 * @param name the extra's name
3747 * @return true if the given extra is present.
3748 */
3749 public boolean hasExtra(String name) {
3750 return mExtras != null && mExtras.containsKey(name);
3751 }
3752
3753 /**
3754 * Returns true if the Intent's extras contain a parcelled file descriptor.
3755 * @return true if the Intent contains a parcelled file descriptor.
3756 */
3757 public boolean hasFileDescriptors() {
3758 return mExtras != null && mExtras.hasFileDescriptors();
3759 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003760
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003761 /** @hide */
3762 public void setAllowFds(boolean allowFds) {
3763 if (mExtras != null) {
3764 mExtras.setAllowFds(allowFds);
3765 }
3766 }
3767
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003768 /**
3769 * Retrieve extended data from the intent.
3770 *
3771 * @param name The name of the desired item.
3772 *
3773 * @return the value of an item that previously added with putExtra()
3774 * or null if none was found.
3775 *
3776 * @deprecated
3777 * @hide
3778 */
3779 @Deprecated
3780 public Object getExtra(String name) {
3781 return getExtra(name, null);
3782 }
3783
3784 /**
3785 * Retrieve extended data from the intent.
3786 *
3787 * @param name The name of the desired item.
3788 * @param defaultValue the value to be returned if no value of the desired
3789 * type is stored with the given name.
3790 *
3791 * @return the value of an item that previously added with putExtra()
3792 * or the default value if none was found.
3793 *
3794 * @see #putExtra(String, boolean)
3795 */
3796 public boolean getBooleanExtra(String name, boolean defaultValue) {
3797 return mExtras == null ? defaultValue :
3798 mExtras.getBoolean(name, defaultValue);
3799 }
3800
3801 /**
3802 * Retrieve extended data from the intent.
3803 *
3804 * @param name The name of the desired item.
3805 * @param defaultValue the value to be returned if no value of the desired
3806 * type is stored with the given name.
3807 *
3808 * @return the value of an item that previously added with putExtra()
3809 * or the default value if none was found.
3810 *
3811 * @see #putExtra(String, byte)
3812 */
3813 public byte getByteExtra(String name, byte defaultValue) {
3814 return mExtras == null ? defaultValue :
3815 mExtras.getByte(name, defaultValue);
3816 }
3817
3818 /**
3819 * Retrieve extended data from the intent.
3820 *
3821 * @param name The name of the desired item.
3822 * @param defaultValue the value to be returned if no value of the desired
3823 * type is stored with the given name.
3824 *
3825 * @return the value of an item that previously added with putExtra()
3826 * or the default value if none was found.
3827 *
3828 * @see #putExtra(String, short)
3829 */
3830 public short getShortExtra(String name, short defaultValue) {
3831 return mExtras == null ? defaultValue :
3832 mExtras.getShort(name, defaultValue);
3833 }
3834
3835 /**
3836 * Retrieve extended data from the intent.
3837 *
3838 * @param name The name of the desired item.
3839 * @param defaultValue the value to be returned if no value of the desired
3840 * type is stored with the given name.
3841 *
3842 * @return the value of an item that previously added with putExtra()
3843 * or the default value if none was found.
3844 *
3845 * @see #putExtra(String, char)
3846 */
3847 public char getCharExtra(String name, char defaultValue) {
3848 return mExtras == null ? defaultValue :
3849 mExtras.getChar(name, defaultValue);
3850 }
3851
3852 /**
3853 * Retrieve extended data from the intent.
3854 *
3855 * @param name The name of the desired item.
3856 * @param defaultValue the value to be returned if no value of the desired
3857 * type is stored with the given name.
3858 *
3859 * @return the value of an item that previously added with putExtra()
3860 * or the default value if none was found.
3861 *
3862 * @see #putExtra(String, int)
3863 */
3864 public int getIntExtra(String name, int defaultValue) {
3865 return mExtras == null ? defaultValue :
3866 mExtras.getInt(name, defaultValue);
3867 }
3868
3869 /**
3870 * Retrieve extended data from the intent.
3871 *
3872 * @param name The name of the desired item.
3873 * @param defaultValue the value to be returned if no value of the desired
3874 * type is stored with the given name.
3875 *
3876 * @return the value of an item that previously added with putExtra()
3877 * or the default value if none was found.
3878 *
3879 * @see #putExtra(String, long)
3880 */
3881 public long getLongExtra(String name, long defaultValue) {
3882 return mExtras == null ? defaultValue :
3883 mExtras.getLong(name, defaultValue);
3884 }
3885
3886 /**
3887 * Retrieve extended data from the intent.
3888 *
3889 * @param name The name of the desired item.
3890 * @param defaultValue the value to be returned if no value of the desired
3891 * type is stored with the given name.
3892 *
3893 * @return the value of an item that previously added with putExtra(),
3894 * or the default value if no such item is present
3895 *
3896 * @see #putExtra(String, float)
3897 */
3898 public float getFloatExtra(String name, float defaultValue) {
3899 return mExtras == null ? defaultValue :
3900 mExtras.getFloat(name, defaultValue);
3901 }
3902
3903 /**
3904 * Retrieve extended data from the intent.
3905 *
3906 * @param name The name of the desired item.
3907 * @param defaultValue the value to be returned if no value of the desired
3908 * type is stored with the given name.
3909 *
3910 * @return the value of an item that previously added with putExtra()
3911 * or the default value if none was found.
3912 *
3913 * @see #putExtra(String, double)
3914 */
3915 public double getDoubleExtra(String name, double defaultValue) {
3916 return mExtras == null ? defaultValue :
3917 mExtras.getDouble(name, defaultValue);
3918 }
3919
3920 /**
3921 * Retrieve extended data from the intent.
3922 *
3923 * @param name The name of the desired item.
3924 *
3925 * @return the value of an item that previously added with putExtra()
3926 * or null if no String value was found.
3927 *
3928 * @see #putExtra(String, String)
3929 */
3930 public String getStringExtra(String name) {
3931 return mExtras == null ? null : mExtras.getString(name);
3932 }
3933
3934 /**
3935 * Retrieve extended data from the intent.
3936 *
3937 * @param name The name of the desired item.
3938 *
3939 * @return the value of an item that previously added with putExtra()
3940 * or null if no CharSequence value was found.
3941 *
3942 * @see #putExtra(String, CharSequence)
3943 */
3944 public CharSequence getCharSequenceExtra(String name) {
3945 return mExtras == null ? null : mExtras.getCharSequence(name);
3946 }
3947
3948 /**
3949 * Retrieve extended data from the intent.
3950 *
3951 * @param name The name of the desired item.
3952 *
3953 * @return the value of an item that previously added with putExtra()
3954 * or null if no Parcelable value was found.
3955 *
3956 * @see #putExtra(String, Parcelable)
3957 */
3958 public <T extends Parcelable> T getParcelableExtra(String name) {
3959 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3960 }
3961
3962 /**
3963 * Retrieve extended data from the intent.
3964 *
3965 * @param name The name of the desired item.
3966 *
3967 * @return the value of an item that previously added with putExtra()
3968 * or null if no Parcelable[] value was found.
3969 *
3970 * @see #putExtra(String, Parcelable[])
3971 */
3972 public Parcelable[] getParcelableArrayExtra(String name) {
3973 return mExtras == null ? null : mExtras.getParcelableArray(name);
3974 }
3975
3976 /**
3977 * Retrieve extended data from the intent.
3978 *
3979 * @param name The name of the desired item.
3980 *
3981 * @return the value of an item that previously added with putExtra()
3982 * or null if no ArrayList<Parcelable> value was found.
3983 *
3984 * @see #putParcelableArrayListExtra(String, ArrayList)
3985 */
3986 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3987 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3988 }
3989
3990 /**
3991 * Retrieve extended data from the intent.
3992 *
3993 * @param name The name of the desired item.
3994 *
3995 * @return the value of an item that previously added with putExtra()
3996 * or null if no Serializable value was found.
3997 *
3998 * @see #putExtra(String, Serializable)
3999 */
4000 public Serializable getSerializableExtra(String name) {
4001 return mExtras == null ? null : mExtras.getSerializable(name);
4002 }
4003
4004 /**
4005 * Retrieve extended data from the intent.
4006 *
4007 * @param name The name of the desired item.
4008 *
4009 * @return the value of an item that previously added with putExtra()
4010 * or null if no ArrayList<Integer> value was found.
4011 *
4012 * @see #putIntegerArrayListExtra(String, ArrayList)
4013 */
4014 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4015 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4016 }
4017
4018 /**
4019 * Retrieve extended data from the intent.
4020 *
4021 * @param name The name of the desired item.
4022 *
4023 * @return the value of an item that previously added with putExtra()
4024 * or null if no ArrayList<String> value was found.
4025 *
4026 * @see #putStringArrayListExtra(String, ArrayList)
4027 */
4028 public ArrayList<String> getStringArrayListExtra(String name) {
4029 return mExtras == null ? null : mExtras.getStringArrayList(name);
4030 }
4031
4032 /**
4033 * Retrieve extended data from the intent.
4034 *
4035 * @param name The name of the desired item.
4036 *
4037 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004038 * or null if no ArrayList<CharSequence> value was found.
4039 *
4040 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4041 */
4042 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4043 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4044 }
4045
4046 /**
4047 * Retrieve extended data from the intent.
4048 *
4049 * @param name The name of the desired item.
4050 *
4051 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004052 * or null if no boolean array value was found.
4053 *
4054 * @see #putExtra(String, boolean[])
4055 */
4056 public boolean[] getBooleanArrayExtra(String name) {
4057 return mExtras == null ? null : mExtras.getBooleanArray(name);
4058 }
4059
4060 /**
4061 * Retrieve extended data from the intent.
4062 *
4063 * @param name The name of the desired item.
4064 *
4065 * @return the value of an item that previously added with putExtra()
4066 * or null if no byte array value was found.
4067 *
4068 * @see #putExtra(String, byte[])
4069 */
4070 public byte[] getByteArrayExtra(String name) {
4071 return mExtras == null ? null : mExtras.getByteArray(name);
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 short array value was found.
4081 *
4082 * @see #putExtra(String, short[])
4083 */
4084 public short[] getShortArrayExtra(String name) {
4085 return mExtras == null ? null : mExtras.getShortArray(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 char array value was found.
4095 *
4096 * @see #putExtra(String, char[])
4097 */
4098 public char[] getCharArrayExtra(String name) {
4099 return mExtras == null ? null : mExtras.getCharArray(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 int array value was found.
4109 *
4110 * @see #putExtra(String, int[])
4111 */
4112 public int[] getIntArrayExtra(String name) {
4113 return mExtras == null ? null : mExtras.getIntArray(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 long array value was found.
4123 *
4124 * @see #putExtra(String, long[])
4125 */
4126 public long[] getLongArrayExtra(String name) {
4127 return mExtras == null ? null : mExtras.getLongArray(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 float array value was found.
4137 *
4138 * @see #putExtra(String, float[])
4139 */
4140 public float[] getFloatArrayExtra(String name) {
4141 return mExtras == null ? null : mExtras.getFloatArray(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 double array value was found.
4151 *
4152 * @see #putExtra(String, double[])
4153 */
4154 public double[] getDoubleArrayExtra(String name) {
4155 return mExtras == null ? null : mExtras.getDoubleArray(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 String array value was found.
4165 *
4166 * @see #putExtra(String, String[])
4167 */
4168 public String[] getStringArrayExtra(String name) {
4169 return mExtras == null ? null : mExtras.getStringArray(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()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004178 * or null if no CharSequence array value was found.
4179 *
4180 * @see #putExtra(String, CharSequence[])
4181 */
4182 public CharSequence[] getCharSequenceArrayExtra(String name) {
4183 return mExtras == null ? null : mExtras.getCharSequenceArray(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()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004192 * or null if no Bundle value was found.
4193 *
4194 * @see #putExtra(String, Bundle)
4195 */
4196 public Bundle getBundleExtra(String name) {
4197 return mExtras == null ? null : mExtras.getBundle(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()
4206 * or null if no IBinder value was found.
4207 *
4208 * @see #putExtra(String, IBinder)
4209 *
4210 * @deprecated
4211 * @hide
4212 */
4213 @Deprecated
4214 public IBinder getIBinderExtra(String name) {
4215 return mExtras == null ? null : mExtras.getIBinder(name);
4216 }
4217
4218 /**
4219 * Retrieve extended data from the intent.
4220 *
4221 * @param name The name of the desired item.
4222 * @param defaultValue The default value to return in case no item is
4223 * associated with the key 'name'
4224 *
4225 * @return the value of an item that previously added with putExtra()
4226 * or defaultValue if none was found.
4227 *
4228 * @see #putExtra
4229 *
4230 * @deprecated
4231 * @hide
4232 */
4233 @Deprecated
4234 public Object getExtra(String name, Object defaultValue) {
4235 Object result = defaultValue;
4236 if (mExtras != null) {
4237 Object result2 = mExtras.get(name);
4238 if (result2 != null) {
4239 result = result2;
4240 }
4241 }
4242
4243 return result;
4244 }
4245
4246 /**
4247 * Retrieves a map of extended data from the intent.
4248 *
4249 * @return the map of all extras previously added with putExtra(),
4250 * or null if none have been added.
4251 */
4252 public Bundle getExtras() {
4253 return (mExtras != null)
4254 ? new Bundle(mExtras)
4255 : null;
4256 }
4257
4258 /**
4259 * Retrieve any special flags associated with this intent. You will
4260 * normally just set them with {@link #setFlags} and let the system
4261 * take the appropriate action with them.
4262 *
4263 * @return int The currently set flags.
4264 *
4265 * @see #setFlags
4266 */
4267 public int getFlags() {
4268 return mFlags;
4269 }
4270
Dianne Hackborne7f97212011-02-24 14:40:20 -08004271 /** @hide */
4272 public boolean isExcludingStopped() {
4273 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4274 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4275 }
4276
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004277 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004278 * Retrieve the application package name this Intent is limited to. When
4279 * resolving an Intent, if non-null this limits the resolution to only
4280 * components in the given application package.
4281 *
4282 * @return The name of the application package for the Intent.
4283 *
4284 * @see #resolveActivity
4285 * @see #setPackage
4286 */
4287 public String getPackage() {
4288 return mPackage;
4289 }
4290
4291 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004292 * Retrieve the concrete component associated with the intent. When receiving
4293 * an intent, this is the component that was found to best handle it (that is,
4294 * yourself) and will always be non-null; in all other cases it will be
4295 * null unless explicitly set.
4296 *
4297 * @return The name of the application component to handle the intent.
4298 *
4299 * @see #resolveActivity
4300 * @see #setComponent
4301 */
4302 public ComponentName getComponent() {
4303 return mComponent;
4304 }
4305
4306 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004307 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4308 * used as a hint to the receiver for animations and the like. Null means that there
4309 * is no source bounds.
4310 */
4311 public Rect getSourceBounds() {
4312 return mSourceBounds;
4313 }
4314
4315 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004316 * Return the Activity component that should be used to handle this intent.
4317 * The appropriate component is determined based on the information in the
4318 * intent, evaluated as follows:
4319 *
4320 * <p>If {@link #getComponent} returns an explicit class, that is returned
4321 * without any further consideration.
4322 *
4323 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4324 * category to be considered.
4325 *
4326 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4327 * action.
4328 *
4329 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4330 * this type.
4331 *
4332 * <p>If {@link #addCategory} has added any categories, the activity must
4333 * handle ALL of the categories specified.
4334 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004335 * <p>If {@link #getPackage} is non-NULL, only activity components in
4336 * that application package will be considered.
4337 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004338 * <p>If there are no activities that satisfy all of these conditions, a
4339 * null string is returned.
4340 *
4341 * <p>If multiple activities are found to satisfy the intent, the one with
4342 * the highest priority will be used. If there are multiple activities
4343 * with the same priority, the system will either pick the best activity
4344 * based on user preference, or resolve to a system class that will allow
4345 * the user to pick an activity and forward from there.
4346 *
4347 * <p>This method is implemented simply by calling
4348 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4349 * true.</p>
4350 * <p> This API is called for you as part of starting an activity from an
4351 * intent. You do not normally need to call it yourself.</p>
4352 *
4353 * @param pm The package manager with which to resolve the Intent.
4354 *
4355 * @return Name of the component implementing an activity that can
4356 * display the intent.
4357 *
4358 * @see #setComponent
4359 * @see #getComponent
4360 * @see #resolveActivityInfo
4361 */
4362 public ComponentName resolveActivity(PackageManager pm) {
4363 if (mComponent != null) {
4364 return mComponent;
4365 }
4366
4367 ResolveInfo info = pm.resolveActivity(
4368 this, PackageManager.MATCH_DEFAULT_ONLY);
4369 if (info != null) {
4370 return new ComponentName(
4371 info.activityInfo.applicationInfo.packageName,
4372 info.activityInfo.name);
4373 }
4374
4375 return null;
4376 }
4377
4378 /**
4379 * Resolve the Intent into an {@link ActivityInfo}
4380 * describing the activity that should execute the intent. Resolution
4381 * follows the same rules as described for {@link #resolveActivity}, but
4382 * you get back the completely information about the resolved activity
4383 * instead of just its class name.
4384 *
4385 * @param pm The package manager with which to resolve the Intent.
4386 * @param flags Addition information to retrieve as per
4387 * {@link PackageManager#getActivityInfo(ComponentName, int)
4388 * PackageManager.getActivityInfo()}.
4389 *
4390 * @return PackageManager.ActivityInfo
4391 *
4392 * @see #resolveActivity
4393 */
4394 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4395 ActivityInfo ai = null;
4396 if (mComponent != null) {
4397 try {
4398 ai = pm.getActivityInfo(mComponent, flags);
4399 } catch (PackageManager.NameNotFoundException e) {
4400 // ignore
4401 }
4402 } else {
4403 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004404 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004405 if (info != null) {
4406 ai = info.activityInfo;
4407 }
4408 }
4409
4410 return ai;
4411 }
4412
4413 /**
4414 * Set the general action to be performed.
4415 *
4416 * @param action An action name, such as ACTION_VIEW. Application-specific
4417 * actions should be prefixed with the vendor's package name.
4418 *
4419 * @return Returns the same Intent object, for chaining multiple calls
4420 * into a single statement.
4421 *
4422 * @see #getAction
4423 */
4424 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004425 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004426 return this;
4427 }
4428
4429 /**
4430 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004431 * clears any type that was previously set by {@link #setType} or
4432 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004433 *
Nick Pellyccae4122012-01-09 14:12:58 -08004434 * <p><em>Note: scheme matching in the Android framework is
4435 * case-sensitive, unlike the formal RFC. As a result,
4436 * you should always write your Uri with a lower case scheme,
4437 * or use {@link Uri#normalize} or
4438 * {@link #setDataAndNormalize}
4439 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004440 *
Nick Pellyccae4122012-01-09 14:12:58 -08004441 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004442 *
4443 * @return Returns the same Intent object, for chaining multiple calls
4444 * into a single statement.
4445 *
4446 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004447 * @see #setDataAndNormalize
4448 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004449 */
4450 public Intent setData(Uri data) {
4451 mData = data;
4452 mType = null;
4453 return this;
4454 }
4455
4456 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004457 * Normalize and set the data this intent is operating on.
4458 *
4459 * <p>This method automatically clears any type that was
4460 * previously set (for example, by {@link #setType}).
4461 *
4462 * <p>The data Uri is normalized using
4463 * {@link android.net.Uri#normalize} before it is set,
4464 * so really this is just a convenience method for
4465 * <pre>
4466 * setData(data.normalize())
4467 * </pre>
4468 *
4469 * @param data The Uri of the data this intent is now targeting.
4470 *
4471 * @return Returns the same Intent object, for chaining multiple calls
4472 * into a single statement.
4473 *
4474 * @see #getData
4475 * @see #setType
4476 * @see android.net.Uri#normalize
4477 */
4478 public Intent setDataAndNormalize(Uri data) {
4479 return setData(data.normalize());
4480 }
4481
4482 /**
4483 * Set an explicit MIME data type.
4484 *
4485 * <p>This is used to create intents that only specify a type and not data,
4486 * for example to indicate the type of data to return.
4487 *
4488 * <p>This method automatically clears any data that was
4489 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004490 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004491 * <p><em>Note: MIME type matching in the Android framework is
4492 * case-sensitive, unlike formal RFC MIME types. As a result,
4493 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004494 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4495 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004496 *
4497 * @param type The MIME type of the data being handled by this intent.
4498 *
4499 * @return Returns the same Intent object, for chaining multiple calls
4500 * into a single statement.
4501 *
4502 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004503 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004504 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004505 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004506 */
4507 public Intent setType(String type) {
4508 mData = null;
4509 mType = type;
4510 return this;
4511 }
4512
4513 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004514 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004515 *
Nick Pellyccae4122012-01-09 14:12:58 -08004516 * <p>This is used to create intents that only specify a type and not data,
4517 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004518 *
Nick Pellyccae4122012-01-09 14:12:58 -08004519 * <p>This method automatically clears any data that was
4520 * previously set (for example by {@link #setData}).
4521 *
4522 * <p>The MIME type is normalized using
4523 * {@link #normalizeMimeType} before it is set,
4524 * so really this is just a convenience method for
4525 * <pre>
4526 * setType(Intent.normalizeMimeType(type))
4527 * </pre>
4528 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004529 * @param type The MIME type of the data being handled by this intent.
4530 *
4531 * @return Returns the same Intent object, for chaining multiple calls
4532 * into a single statement.
4533 *
Nick Pellyccae4122012-01-09 14:12:58 -08004534 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004535 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004536 * @see #normalizeMimeType
4537 */
4538 public Intent setTypeAndNormalize(String type) {
4539 return setType(normalizeMimeType(type));
4540 }
4541
4542 /**
4543 * (Usually optional) Set the data for the intent along with an explicit
4544 * MIME data type. This method should very rarely be used -- it allows you
4545 * to override the MIME type that would ordinarily be inferred from the
4546 * data with your own type given here.
4547 *
4548 * <p><em>Note: MIME type and Uri scheme matching in the
4549 * Android framework is case-sensitive, unlike the formal RFC definitions.
4550 * As a result, you should always write these elements with lower case letters,
4551 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalize} or
4552 * {@link #setDataAndTypeAndNormalize}
4553 * to ensure that they are converted to lower case.</em>
4554 *
4555 * @param data The Uri of the data this intent is now targeting.
4556 * @param type The MIME type of the data being handled by this intent.
4557 *
4558 * @return Returns the same Intent object, for chaining multiple calls
4559 * into a single statement.
4560 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004561 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004562 * @see #setData
4563 * @see #normalizeMimeType
4564 * @see android.net.Uri#normalize
4565 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004566 */
4567 public Intent setDataAndType(Uri data, String type) {
4568 mData = data;
4569 mType = type;
4570 return this;
4571 }
4572
4573 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004574 * (Usually optional) Normalize and set both the data Uri and an explicit
4575 * MIME data type. This method should very rarely be used -- it allows you
4576 * to override the MIME type that would ordinarily be inferred from the
4577 * data with your own type given here.
4578 *
4579 * <p>The data Uri and the MIME type are normalize using
4580 * {@link android.net.Uri#normalize} and {@link #normalizeMimeType}
4581 * before they are set, so really this is just a convenience method for
4582 * <pre>
4583 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4584 * </pre>
4585 *
4586 * @param data The Uri of the data this intent is now targeting.
4587 * @param type The MIME type of the data being handled by this intent.
4588 *
4589 * @return Returns the same Intent object, for chaining multiple calls
4590 * into a single statement.
4591 *
4592 * @see #setType
4593 * @see #setData
4594 * @see #setDataAndType
4595 * @see #normalizeMimeType
4596 * @see android.net.Uri#normalize
4597 */
4598 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
4599 return setDataAndType(data.normalize(), normalizeMimeType(type));
4600 }
4601
4602 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004603 * Add a new category to the intent. Categories provide additional detail
4604 * about the action the intent is perform. When resolving an intent, only
4605 * activities that provide <em>all</em> of the requested categories will be
4606 * used.
4607 *
4608 * @param category The desired category. This can be either one of the
4609 * predefined Intent categories, or a custom category in your own
4610 * namespace.
4611 *
4612 * @return Returns the same Intent object, for chaining multiple calls
4613 * into a single statement.
4614 *
4615 * @see #hasCategory
4616 * @see #removeCategory
4617 */
4618 public Intent addCategory(String category) {
4619 if (mCategories == null) {
4620 mCategories = new HashSet<String>();
4621 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004622 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004623 return this;
4624 }
4625
4626 /**
4627 * Remove an category from an intent.
4628 *
4629 * @param category The category to remove.
4630 *
4631 * @see #addCategory
4632 */
4633 public void removeCategory(String category) {
4634 if (mCategories != null) {
4635 mCategories.remove(category);
4636 if (mCategories.size() == 0) {
4637 mCategories = null;
4638 }
4639 }
4640 }
4641
4642 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004643 * Set a selector for this Intent. This is a modification to the kinds of
4644 * things the Intent will match. If the selector is set, it will be used
4645 * when trying to find entities that can handle the Intent, instead of the
4646 * main contents of the Intent. This allows you build an Intent containing
4647 * a generic protocol while targeting it more specifically.
4648 *
4649 * <p>An example of where this may be used is with things like
4650 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4651 * Intent that will launch the Browser application. However, the correct
4652 * main entry point of an application is actually {@link #ACTION_MAIN}
4653 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4654 * used to specify the actual Activity to launch. If you launch the browser
4655 * with something different, undesired behavior may happen if the user has
4656 * previously or later launches it the normal way, since they do not match.
4657 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4658 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4659 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4660 *
4661 * <p>Setting a selector does not impact the behavior of
4662 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4663 * desired behavior of a selector -- it does not impact the base meaning
4664 * of the Intent, just what kinds of things will be matched against it
4665 * when determining who can handle it.</p>
4666 *
4667 * <p>You can not use both a selector and {@link #setPackage(String)} on
4668 * the same base Intent.</p>
4669 *
4670 * @param selector The desired selector Intent; set to null to not use
4671 * a special selector.
4672 */
4673 public void setSelector(Intent selector) {
4674 if (selector == this) {
4675 throw new IllegalArgumentException(
4676 "Intent being set as a selector of itself");
4677 }
4678 if (selector != null && mPackage != null) {
4679 throw new IllegalArgumentException(
4680 "Can't set selector when package name is already set");
4681 }
4682 mSelector = selector;
4683 }
4684
4685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004686 * Add extended data to the intent. The name must include a package
4687 * prefix, for example the app com.android.contacts would use names
4688 * like "com.android.contacts.ShowAll".
4689 *
4690 * @param name The name of the extra data, with package prefix.
4691 * @param value The boolean data value.
4692 *
4693 * @return Returns the same Intent object, for chaining multiple calls
4694 * into a single statement.
4695 *
4696 * @see #putExtras
4697 * @see #removeExtra
4698 * @see #getBooleanExtra(String, boolean)
4699 */
4700 public Intent putExtra(String name, boolean value) {
4701 if (mExtras == null) {
4702 mExtras = new Bundle();
4703 }
4704 mExtras.putBoolean(name, value);
4705 return this;
4706 }
4707
4708 /**
4709 * Add extended data to the intent. The name must include a package
4710 * prefix, for example the app com.android.contacts would use names
4711 * like "com.android.contacts.ShowAll".
4712 *
4713 * @param name The name of the extra data, with package prefix.
4714 * @param value The byte data value.
4715 *
4716 * @return Returns the same Intent object, for chaining multiple calls
4717 * into a single statement.
4718 *
4719 * @see #putExtras
4720 * @see #removeExtra
4721 * @see #getByteExtra(String, byte)
4722 */
4723 public Intent putExtra(String name, byte value) {
4724 if (mExtras == null) {
4725 mExtras = new Bundle();
4726 }
4727 mExtras.putByte(name, value);
4728 return this;
4729 }
4730
4731 /**
4732 * Add extended data to the intent. The name must include a package
4733 * prefix, for example the app com.android.contacts would use names
4734 * like "com.android.contacts.ShowAll".
4735 *
4736 * @param name The name of the extra data, with package prefix.
4737 * @param value The char data value.
4738 *
4739 * @return Returns the same Intent object, for chaining multiple calls
4740 * into a single statement.
4741 *
4742 * @see #putExtras
4743 * @see #removeExtra
4744 * @see #getCharExtra(String, char)
4745 */
4746 public Intent putExtra(String name, char value) {
4747 if (mExtras == null) {
4748 mExtras = new Bundle();
4749 }
4750 mExtras.putChar(name, value);
4751 return this;
4752 }
4753
4754 /**
4755 * Add extended data to the intent. The name must include a package
4756 * prefix, for example the app com.android.contacts would use names
4757 * like "com.android.contacts.ShowAll".
4758 *
4759 * @param name The name of the extra data, with package prefix.
4760 * @param value The short data value.
4761 *
4762 * @return Returns the same Intent object, for chaining multiple calls
4763 * into a single statement.
4764 *
4765 * @see #putExtras
4766 * @see #removeExtra
4767 * @see #getShortExtra(String, short)
4768 */
4769 public Intent putExtra(String name, short value) {
4770 if (mExtras == null) {
4771 mExtras = new Bundle();
4772 }
4773 mExtras.putShort(name, value);
4774 return this;
4775 }
4776
4777 /**
4778 * Add extended data to the intent. The name must include a package
4779 * prefix, for example the app com.android.contacts would use names
4780 * like "com.android.contacts.ShowAll".
4781 *
4782 * @param name The name of the extra data, with package prefix.
4783 * @param value The integer data value.
4784 *
4785 * @return Returns the same Intent object, for chaining multiple calls
4786 * into a single statement.
4787 *
4788 * @see #putExtras
4789 * @see #removeExtra
4790 * @see #getIntExtra(String, int)
4791 */
4792 public Intent putExtra(String name, int value) {
4793 if (mExtras == null) {
4794 mExtras = new Bundle();
4795 }
4796 mExtras.putInt(name, value);
4797 return this;
4798 }
4799
4800 /**
4801 * Add extended data to the intent. The name must include a package
4802 * prefix, for example the app com.android.contacts would use names
4803 * like "com.android.contacts.ShowAll".
4804 *
4805 * @param name The name of the extra data, with package prefix.
4806 * @param value The long data value.
4807 *
4808 * @return Returns the same Intent object, for chaining multiple calls
4809 * into a single statement.
4810 *
4811 * @see #putExtras
4812 * @see #removeExtra
4813 * @see #getLongExtra(String, long)
4814 */
4815 public Intent putExtra(String name, long value) {
4816 if (mExtras == null) {
4817 mExtras = new Bundle();
4818 }
4819 mExtras.putLong(name, value);
4820 return this;
4821 }
4822
4823 /**
4824 * Add extended data to the intent. The name must include a package
4825 * prefix, for example the app com.android.contacts would use names
4826 * like "com.android.contacts.ShowAll".
4827 *
4828 * @param name The name of the extra data, with package prefix.
4829 * @param value The float data value.
4830 *
4831 * @return Returns the same Intent object, for chaining multiple calls
4832 * into a single statement.
4833 *
4834 * @see #putExtras
4835 * @see #removeExtra
4836 * @see #getFloatExtra(String, float)
4837 */
4838 public Intent putExtra(String name, float value) {
4839 if (mExtras == null) {
4840 mExtras = new Bundle();
4841 }
4842 mExtras.putFloat(name, value);
4843 return this;
4844 }
4845
4846 /**
4847 * Add extended data to the intent. The name must include a package
4848 * prefix, for example the app com.android.contacts would use names
4849 * like "com.android.contacts.ShowAll".
4850 *
4851 * @param name The name of the extra data, with package prefix.
4852 * @param value The double data value.
4853 *
4854 * @return Returns the same Intent object, for chaining multiple calls
4855 * into a single statement.
4856 *
4857 * @see #putExtras
4858 * @see #removeExtra
4859 * @see #getDoubleExtra(String, double)
4860 */
4861 public Intent putExtra(String name, double value) {
4862 if (mExtras == null) {
4863 mExtras = new Bundle();
4864 }
4865 mExtras.putDouble(name, value);
4866 return this;
4867 }
4868
4869 /**
4870 * Add extended data to the intent. The name must include a package
4871 * prefix, for example the app com.android.contacts would use names
4872 * like "com.android.contacts.ShowAll".
4873 *
4874 * @param name The name of the extra data, with package prefix.
4875 * @param value The String data value.
4876 *
4877 * @return Returns the same Intent object, for chaining multiple calls
4878 * into a single statement.
4879 *
4880 * @see #putExtras
4881 * @see #removeExtra
4882 * @see #getStringExtra(String)
4883 */
4884 public Intent putExtra(String name, String value) {
4885 if (mExtras == null) {
4886 mExtras = new Bundle();
4887 }
4888 mExtras.putString(name, value);
4889 return this;
4890 }
4891
4892 /**
4893 * Add extended data to the intent. The name must include a package
4894 * prefix, for example the app com.android.contacts would use names
4895 * like "com.android.contacts.ShowAll".
4896 *
4897 * @param name The name of the extra data, with package prefix.
4898 * @param value The CharSequence data value.
4899 *
4900 * @return Returns the same Intent object, for chaining multiple calls
4901 * into a single statement.
4902 *
4903 * @see #putExtras
4904 * @see #removeExtra
4905 * @see #getCharSequenceExtra(String)
4906 */
4907 public Intent putExtra(String name, CharSequence value) {
4908 if (mExtras == null) {
4909 mExtras = new Bundle();
4910 }
4911 mExtras.putCharSequence(name, value);
4912 return this;
4913 }
4914
4915 /**
4916 * Add extended data to the intent. The name must include a package
4917 * prefix, for example the app com.android.contacts would use names
4918 * like "com.android.contacts.ShowAll".
4919 *
4920 * @param name The name of the extra data, with package prefix.
4921 * @param value The Parcelable data value.
4922 *
4923 * @return Returns the same Intent object, for chaining multiple calls
4924 * into a single statement.
4925 *
4926 * @see #putExtras
4927 * @see #removeExtra
4928 * @see #getParcelableExtra(String)
4929 */
4930 public Intent putExtra(String name, Parcelable value) {
4931 if (mExtras == null) {
4932 mExtras = new Bundle();
4933 }
4934 mExtras.putParcelable(name, value);
4935 return this;
4936 }
4937
4938 /**
4939 * Add extended data to the intent. The name must include a package
4940 * prefix, for example the app com.android.contacts would use names
4941 * like "com.android.contacts.ShowAll".
4942 *
4943 * @param name The name of the extra data, with package prefix.
4944 * @param value The Parcelable[] data value.
4945 *
4946 * @return Returns the same Intent object, for chaining multiple calls
4947 * into a single statement.
4948 *
4949 * @see #putExtras
4950 * @see #removeExtra
4951 * @see #getParcelableArrayExtra(String)
4952 */
4953 public Intent putExtra(String name, Parcelable[] value) {
4954 if (mExtras == null) {
4955 mExtras = new Bundle();
4956 }
4957 mExtras.putParcelableArray(name, value);
4958 return this;
4959 }
4960
4961 /**
4962 * Add extended data to the intent. The name must include a package
4963 * prefix, for example the app com.android.contacts would use names
4964 * like "com.android.contacts.ShowAll".
4965 *
4966 * @param name The name of the extra data, with package prefix.
4967 * @param value The ArrayList<Parcelable> data value.
4968 *
4969 * @return Returns the same Intent object, for chaining multiple calls
4970 * into a single statement.
4971 *
4972 * @see #putExtras
4973 * @see #removeExtra
4974 * @see #getParcelableArrayListExtra(String)
4975 */
4976 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4977 if (mExtras == null) {
4978 mExtras = new Bundle();
4979 }
4980 mExtras.putParcelableArrayList(name, value);
4981 return this;
4982 }
4983
4984 /**
4985 * Add extended data to the intent. The name must include a package
4986 * prefix, for example the app com.android.contacts would use names
4987 * like "com.android.contacts.ShowAll".
4988 *
4989 * @param name The name of the extra data, with package prefix.
4990 * @param value The ArrayList<Integer> data value.
4991 *
4992 * @return Returns the same Intent object, for chaining multiple calls
4993 * into a single statement.
4994 *
4995 * @see #putExtras
4996 * @see #removeExtra
4997 * @see #getIntegerArrayListExtra(String)
4998 */
4999 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5000 if (mExtras == null) {
5001 mExtras = new Bundle();
5002 }
5003 mExtras.putIntegerArrayList(name, value);
5004 return this;
5005 }
5006
5007 /**
5008 * Add extended data to the intent. The name must include a package
5009 * prefix, for example the app com.android.contacts would use names
5010 * like "com.android.contacts.ShowAll".
5011 *
5012 * @param name The name of the extra data, with package prefix.
5013 * @param value The ArrayList<String> data value.
5014 *
5015 * @return Returns the same Intent object, for chaining multiple calls
5016 * into a single statement.
5017 *
5018 * @see #putExtras
5019 * @see #removeExtra
5020 * @see #getStringArrayListExtra(String)
5021 */
5022 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5023 if (mExtras == null) {
5024 mExtras = new Bundle();
5025 }
5026 mExtras.putStringArrayList(name, value);
5027 return this;
5028 }
5029
5030 /**
5031 * Add extended data to the intent. The name must include a package
5032 * prefix, for example the app com.android.contacts would use names
5033 * like "com.android.contacts.ShowAll".
5034 *
5035 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005036 * @param value The ArrayList<CharSequence> data value.
5037 *
5038 * @return Returns the same Intent object, for chaining multiple calls
5039 * into a single statement.
5040 *
5041 * @see #putExtras
5042 * @see #removeExtra
5043 * @see #getCharSequenceArrayListExtra(String)
5044 */
5045 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5046 if (mExtras == null) {
5047 mExtras = new Bundle();
5048 }
5049 mExtras.putCharSequenceArrayList(name, value);
5050 return this;
5051 }
5052
5053 /**
5054 * Add extended data to the intent. The name must include a package
5055 * prefix, for example the app com.android.contacts would use names
5056 * like "com.android.contacts.ShowAll".
5057 *
5058 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005059 * @param value The Serializable data value.
5060 *
5061 * @return Returns the same Intent object, for chaining multiple calls
5062 * into a single statement.
5063 *
5064 * @see #putExtras
5065 * @see #removeExtra
5066 * @see #getSerializableExtra(String)
5067 */
5068 public Intent putExtra(String name, Serializable value) {
5069 if (mExtras == null) {
5070 mExtras = new Bundle();
5071 }
5072 mExtras.putSerializable(name, value);
5073 return this;
5074 }
5075
5076 /**
5077 * Add extended data to the intent. The name must include a package
5078 * prefix, for example the app com.android.contacts would use names
5079 * like "com.android.contacts.ShowAll".
5080 *
5081 * @param name The name of the extra data, with package prefix.
5082 * @param value The boolean array data value.
5083 *
5084 * @return Returns the same Intent object, for chaining multiple calls
5085 * into a single statement.
5086 *
5087 * @see #putExtras
5088 * @see #removeExtra
5089 * @see #getBooleanArrayExtra(String)
5090 */
5091 public Intent putExtra(String name, boolean[] value) {
5092 if (mExtras == null) {
5093 mExtras = new Bundle();
5094 }
5095 mExtras.putBooleanArray(name, value);
5096 return this;
5097 }
5098
5099 /**
5100 * Add extended data to the intent. The name must include a package
5101 * prefix, for example the app com.android.contacts would use names
5102 * like "com.android.contacts.ShowAll".
5103 *
5104 * @param name The name of the extra data, with package prefix.
5105 * @param value The byte array data value.
5106 *
5107 * @return Returns the same Intent object, for chaining multiple calls
5108 * into a single statement.
5109 *
5110 * @see #putExtras
5111 * @see #removeExtra
5112 * @see #getByteArrayExtra(String)
5113 */
5114 public Intent putExtra(String name, byte[] value) {
5115 if (mExtras == null) {
5116 mExtras = new Bundle();
5117 }
5118 mExtras.putByteArray(name, value);
5119 return this;
5120 }
5121
5122 /**
5123 * Add extended data to the intent. The name must include a package
5124 * prefix, for example the app com.android.contacts would use names
5125 * like "com.android.contacts.ShowAll".
5126 *
5127 * @param name The name of the extra data, with package prefix.
5128 * @param value The short array data value.
5129 *
5130 * @return Returns the same Intent object, for chaining multiple calls
5131 * into a single statement.
5132 *
5133 * @see #putExtras
5134 * @see #removeExtra
5135 * @see #getShortArrayExtra(String)
5136 */
5137 public Intent putExtra(String name, short[] value) {
5138 if (mExtras == null) {
5139 mExtras = new Bundle();
5140 }
5141 mExtras.putShortArray(name, value);
5142 return this;
5143 }
5144
5145 /**
5146 * Add extended data to the intent. The name must include a package
5147 * prefix, for example the app com.android.contacts would use names
5148 * like "com.android.contacts.ShowAll".
5149 *
5150 * @param name The name of the extra data, with package prefix.
5151 * @param value The char array data value.
5152 *
5153 * @return Returns the same Intent object, for chaining multiple calls
5154 * into a single statement.
5155 *
5156 * @see #putExtras
5157 * @see #removeExtra
5158 * @see #getCharArrayExtra(String)
5159 */
5160 public Intent putExtra(String name, char[] value) {
5161 if (mExtras == null) {
5162 mExtras = new Bundle();
5163 }
5164 mExtras.putCharArray(name, value);
5165 return this;
5166 }
5167
5168 /**
5169 * Add extended data to the intent. The name must include a package
5170 * prefix, for example the app com.android.contacts would use names
5171 * like "com.android.contacts.ShowAll".
5172 *
5173 * @param name The name of the extra data, with package prefix.
5174 * @param value The int array data value.
5175 *
5176 * @return Returns the same Intent object, for chaining multiple calls
5177 * into a single statement.
5178 *
5179 * @see #putExtras
5180 * @see #removeExtra
5181 * @see #getIntArrayExtra(String)
5182 */
5183 public Intent putExtra(String name, int[] value) {
5184 if (mExtras == null) {
5185 mExtras = new Bundle();
5186 }
5187 mExtras.putIntArray(name, value);
5188 return this;
5189 }
5190
5191 /**
5192 * Add extended data to the intent. The name must include a package
5193 * prefix, for example the app com.android.contacts would use names
5194 * like "com.android.contacts.ShowAll".
5195 *
5196 * @param name The name of the extra data, with package prefix.
5197 * @param value The byte array data value.
5198 *
5199 * @return Returns the same Intent object, for chaining multiple calls
5200 * into a single statement.
5201 *
5202 * @see #putExtras
5203 * @see #removeExtra
5204 * @see #getLongArrayExtra(String)
5205 */
5206 public Intent putExtra(String name, long[] value) {
5207 if (mExtras == null) {
5208 mExtras = new Bundle();
5209 }
5210 mExtras.putLongArray(name, value);
5211 return this;
5212 }
5213
5214 /**
5215 * Add extended data to the intent. The name must include a package
5216 * prefix, for example the app com.android.contacts would use names
5217 * like "com.android.contacts.ShowAll".
5218 *
5219 * @param name The name of the extra data, with package prefix.
5220 * @param value The float array data value.
5221 *
5222 * @return Returns the same Intent object, for chaining multiple calls
5223 * into a single statement.
5224 *
5225 * @see #putExtras
5226 * @see #removeExtra
5227 * @see #getFloatArrayExtra(String)
5228 */
5229 public Intent putExtra(String name, float[] value) {
5230 if (mExtras == null) {
5231 mExtras = new Bundle();
5232 }
5233 mExtras.putFloatArray(name, value);
5234 return this;
5235 }
5236
5237 /**
5238 * Add extended data to the intent. The name must include a package
5239 * prefix, for example the app com.android.contacts would use names
5240 * like "com.android.contacts.ShowAll".
5241 *
5242 * @param name The name of the extra data, with package prefix.
5243 * @param value The double array data value.
5244 *
5245 * @return Returns the same Intent object, for chaining multiple calls
5246 * into a single statement.
5247 *
5248 * @see #putExtras
5249 * @see #removeExtra
5250 * @see #getDoubleArrayExtra(String)
5251 */
5252 public Intent putExtra(String name, double[] value) {
5253 if (mExtras == null) {
5254 mExtras = new Bundle();
5255 }
5256 mExtras.putDoubleArray(name, value);
5257 return this;
5258 }
5259
5260 /**
5261 * Add extended data to the intent. The name must include a package
5262 * prefix, for example the app com.android.contacts would use names
5263 * like "com.android.contacts.ShowAll".
5264 *
5265 * @param name The name of the extra data, with package prefix.
5266 * @param value The String array data value.
5267 *
5268 * @return Returns the same Intent object, for chaining multiple calls
5269 * into a single statement.
5270 *
5271 * @see #putExtras
5272 * @see #removeExtra
5273 * @see #getStringArrayExtra(String)
5274 */
5275 public Intent putExtra(String name, String[] value) {
5276 if (mExtras == null) {
5277 mExtras = new Bundle();
5278 }
5279 mExtras.putStringArray(name, value);
5280 return this;
5281 }
5282
5283 /**
5284 * Add extended data to the intent. The name must include a package
5285 * prefix, for example the app com.android.contacts would use names
5286 * like "com.android.contacts.ShowAll".
5287 *
5288 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005289 * @param value The CharSequence array data value.
5290 *
5291 * @return Returns the same Intent object, for chaining multiple calls
5292 * into a single statement.
5293 *
5294 * @see #putExtras
5295 * @see #removeExtra
5296 * @see #getCharSequenceArrayExtra(String)
5297 */
5298 public Intent putExtra(String name, CharSequence[] value) {
5299 if (mExtras == null) {
5300 mExtras = new Bundle();
5301 }
5302 mExtras.putCharSequenceArray(name, value);
5303 return this;
5304 }
5305
5306 /**
5307 * Add extended data to the intent. The name must include a package
5308 * prefix, for example the app com.android.contacts would use names
5309 * like "com.android.contacts.ShowAll".
5310 *
5311 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005312 * @param value The Bundle data value.
5313 *
5314 * @return Returns the same Intent object, for chaining multiple calls
5315 * into a single statement.
5316 *
5317 * @see #putExtras
5318 * @see #removeExtra
5319 * @see #getBundleExtra(String)
5320 */
5321 public Intent putExtra(String name, Bundle value) {
5322 if (mExtras == null) {
5323 mExtras = new Bundle();
5324 }
5325 mExtras.putBundle(name, value);
5326 return this;
5327 }
5328
5329 /**
5330 * Add extended data to the intent. The name must include a package
5331 * prefix, for example the app com.android.contacts would use names
5332 * like "com.android.contacts.ShowAll".
5333 *
5334 * @param name The name of the extra data, with package prefix.
5335 * @param value The IBinder data value.
5336 *
5337 * @return Returns the same Intent object, for chaining multiple calls
5338 * into a single statement.
5339 *
5340 * @see #putExtras
5341 * @see #removeExtra
5342 * @see #getIBinderExtra(String)
5343 *
5344 * @deprecated
5345 * @hide
5346 */
5347 @Deprecated
5348 public Intent putExtra(String name, IBinder value) {
5349 if (mExtras == null) {
5350 mExtras = new Bundle();
5351 }
5352 mExtras.putIBinder(name, value);
5353 return this;
5354 }
5355
5356 /**
5357 * Copy all extras in 'src' in to this intent.
5358 *
5359 * @param src Contains the extras to copy.
5360 *
5361 * @see #putExtra
5362 */
5363 public Intent putExtras(Intent src) {
5364 if (src.mExtras != null) {
5365 if (mExtras == null) {
5366 mExtras = new Bundle(src.mExtras);
5367 } else {
5368 mExtras.putAll(src.mExtras);
5369 }
5370 }
5371 return this;
5372 }
5373
5374 /**
5375 * Add a set of extended data to the intent. The keys must include a package
5376 * prefix, for example the app com.android.contacts would use names
5377 * like "com.android.contacts.ShowAll".
5378 *
5379 * @param extras The Bundle of extras to add to this intent.
5380 *
5381 * @see #putExtra
5382 * @see #removeExtra
5383 */
5384 public Intent putExtras(Bundle extras) {
5385 if (mExtras == null) {
5386 mExtras = new Bundle();
5387 }
5388 mExtras.putAll(extras);
5389 return this;
5390 }
5391
5392 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005393 * Completely replace the extras in the Intent with the extras in the
5394 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005395 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005396 * @param src The exact extras contained in this Intent are copied
5397 * into the target intent, replacing any that were previously there.
5398 */
5399 public Intent replaceExtras(Intent src) {
5400 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5401 return this;
5402 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005403
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005404 /**
5405 * Completely replace the extras in the Intent with the given Bundle of
5406 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005407 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005408 * @param extras The new set of extras in the Intent, or null to erase
5409 * all extras.
5410 */
5411 public Intent replaceExtras(Bundle extras) {
5412 mExtras = extras != null ? new Bundle(extras) : null;
5413 return this;
5414 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005415
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005416 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005417 * Remove extended data from the intent.
5418 *
5419 * @see #putExtra
5420 */
5421 public void removeExtra(String name) {
5422 if (mExtras != null) {
5423 mExtras.remove(name);
5424 if (mExtras.size() == 0) {
5425 mExtras = null;
5426 }
5427 }
5428 }
5429
5430 /**
5431 * Set special flags controlling how this intent is handled. Most values
5432 * here depend on the type of component being executed by the Intent,
5433 * specifically the FLAG_ACTIVITY_* flags are all for use with
5434 * {@link Context#startActivity Context.startActivity()} and the
5435 * FLAG_RECEIVER_* flags are all for use with
5436 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5437 *
Scott Main7aee61f2011-02-08 11:25:01 -08005438 * <p>See the
5439 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5440 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005441 * the behavior of your application.
5442 *
5443 * @param flags The desired flags.
5444 *
5445 * @return Returns the same Intent object, for chaining multiple calls
5446 * into a single statement.
5447 *
5448 * @see #getFlags
5449 * @see #addFlags
5450 *
5451 * @see #FLAG_GRANT_READ_URI_PERMISSION
5452 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5453 * @see #FLAG_DEBUG_LOG_RESOLUTION
5454 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005455 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005456 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005457 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005458 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005459 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5460 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005461 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005462 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5463 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005464 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005465 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005466 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005467 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5468 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005469 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005470 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005471 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005472 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5473 */
5474 public Intent setFlags(int flags) {
5475 mFlags = flags;
5476 return this;
5477 }
5478
5479 /**
5480 * Add additional flags to the intent (or with existing flags
5481 * value).
5482 *
5483 * @param flags The new flags to set.
5484 *
5485 * @return Returns the same Intent object, for chaining multiple calls
5486 * into a single statement.
5487 *
5488 * @see #setFlags
5489 */
5490 public Intent addFlags(int flags) {
5491 mFlags |= flags;
5492 return this;
5493 }
5494
5495 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005496 * (Usually optional) Set an explicit application package name that limits
5497 * the components this Intent will resolve to. If left to the default
5498 * value of null, all components in all applications will considered.
5499 * If non-null, the Intent can only match the components in the given
5500 * application package.
5501 *
5502 * @param packageName The name of the application package to handle the
5503 * intent, or null to allow any application package.
5504 *
5505 * @return Returns the same Intent object, for chaining multiple calls
5506 * into a single statement.
5507 *
5508 * @see #getPackage
5509 * @see #resolveActivity
5510 */
5511 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005512 if (packageName != null && mSelector != null) {
5513 throw new IllegalArgumentException(
5514 "Can't set package name when selector is already set");
5515 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005516 mPackage = packageName;
5517 return this;
5518 }
5519
5520 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005521 * (Usually optional) Explicitly set the component to handle the intent.
5522 * If left with the default value of null, the system will determine the
5523 * appropriate class to use based on the other fields (action, data,
5524 * type, categories) in the Intent. If this class is defined, the
5525 * specified class will always be used regardless of the other fields. You
5526 * should only set this value when you know you absolutely want a specific
5527 * class to be used; otherwise it is better to let the system find the
5528 * appropriate class so that you will respect the installed applications
5529 * and user preferences.
5530 *
5531 * @param component The name of the application component to handle the
5532 * intent, or null to let the system find one for you.
5533 *
5534 * @return Returns the same Intent object, for chaining multiple calls
5535 * into a single statement.
5536 *
5537 * @see #setClass
5538 * @see #setClassName(Context, String)
5539 * @see #setClassName(String, String)
5540 * @see #getComponent
5541 * @see #resolveActivity
5542 */
5543 public Intent setComponent(ComponentName component) {
5544 mComponent = component;
5545 return this;
5546 }
5547
5548 /**
5549 * Convenience for calling {@link #setComponent} with an
5550 * explicit class name.
5551 *
5552 * @param packageContext A Context of the application package implementing
5553 * this class.
5554 * @param className The name of a class inside of the application package
5555 * that will be used as the component for this Intent.
5556 *
5557 * @return Returns the same Intent object, for chaining multiple calls
5558 * into a single statement.
5559 *
5560 * @see #setComponent
5561 * @see #setClass
5562 */
5563 public Intent setClassName(Context packageContext, String className) {
5564 mComponent = new ComponentName(packageContext, className);
5565 return this;
5566 }
5567
5568 /**
5569 * Convenience for calling {@link #setComponent} with an
5570 * explicit application package name and class name.
5571 *
5572 * @param packageName The name of the package implementing the desired
5573 * component.
5574 * @param className The name of a class inside of the application package
5575 * that will be used as the component for this Intent.
5576 *
5577 * @return Returns the same Intent object, for chaining multiple calls
5578 * into a single statement.
5579 *
5580 * @see #setComponent
5581 * @see #setClass
5582 */
5583 public Intent setClassName(String packageName, String className) {
5584 mComponent = new ComponentName(packageName, className);
5585 return this;
5586 }
5587
5588 /**
5589 * Convenience for calling {@link #setComponent(ComponentName)} with the
5590 * name returned by a {@link Class} object.
5591 *
5592 * @param packageContext A Context of the application package implementing
5593 * this class.
5594 * @param cls The class name to set, equivalent to
5595 * <code>setClassName(context, cls.getName())</code>.
5596 *
5597 * @return Returns the same Intent object, for chaining multiple calls
5598 * into a single statement.
5599 *
5600 * @see #setComponent
5601 */
5602 public Intent setClass(Context packageContext, Class<?> cls) {
5603 mComponent = new ComponentName(packageContext, cls);
5604 return this;
5605 }
5606
5607 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005608 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5609 * used as a hint to the receiver for animations and the like. Null means that there
5610 * is no source bounds.
5611 */
5612 public void setSourceBounds(Rect r) {
5613 if (r != null) {
5614 mSourceBounds = new Rect(r);
5615 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005616 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005617 }
5618 }
5619
5620 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005621 * Use with {@link #fillIn} to allow the current action value to be
5622 * overwritten, even if it is already set.
5623 */
5624 public static final int FILL_IN_ACTION = 1<<0;
5625
5626 /**
5627 * Use with {@link #fillIn} to allow the current data or type value
5628 * overwritten, even if it is already set.
5629 */
5630 public static final int FILL_IN_DATA = 1<<1;
5631
5632 /**
5633 * Use with {@link #fillIn} to allow the current categories to be
5634 * overwritten, even if they are already set.
5635 */
5636 public static final int FILL_IN_CATEGORIES = 1<<2;
5637
5638 /**
5639 * Use with {@link #fillIn} to allow the current component value to be
5640 * overwritten, even if it is already set.
5641 */
5642 public static final int FILL_IN_COMPONENT = 1<<3;
5643
5644 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005645 * Use with {@link #fillIn} to allow the current package value to be
5646 * overwritten, even if it is already set.
5647 */
5648 public static final int FILL_IN_PACKAGE = 1<<4;
5649
5650 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005651 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005652 * overwritten, even if it is already set.
5653 */
5654 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5655
5656 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005657 * Use with {@link #fillIn} to allow the current selector to be
5658 * overwritten, even if it is already set.
5659 */
5660 public static final int FILL_IN_SELECTOR = 1<<6;
5661
5662 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005663 * Copy the contents of <var>other</var> in to this object, but only
5664 * where fields are not defined by this object. For purposes of a field
5665 * being defined, the following pieces of data in the Intent are
5666 * considered to be separate fields:
5667 *
5668 * <ul>
5669 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005670 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005671 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5672 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005673 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005674 * <li> component, as set by {@link #setComponent(ComponentName)} or
5675 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005676 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005677 * <li> each top-level name in the associated extras.
5678 * </ul>
5679 *
5680 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005681 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005682 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5683 * {@link #FILL_IN_SELECTOR} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005684 * corresponding field will not be replaced if it is already set.
5685 *
Brett Chabot3e391752009-07-21 16:07:23 -07005686 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005687 * specified. The selector will only be copied if {@link #FILL_IN_SELECTOR} is
5688 * explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005689 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005690 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5691 * and Intent B with {action="gotit", data-type="some/thing",
5692 * categories="one","two"}.
5693 *
5694 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5695 * containing: {action="gotit", data-type="some/thing",
5696 * categories="bar"}.
5697 *
5698 * @param other Another Intent whose values are to be used to fill in
5699 * the current one.
5700 * @param flags Options to control which fields can be filled in.
5701 *
5702 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005703 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005704 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5705 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005706 */
5707 public int fillIn(Intent other, int flags) {
5708 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005709 if (other.mAction != null
5710 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005711 mAction = other.mAction;
5712 changes |= FILL_IN_ACTION;
5713 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005714 if ((other.mData != null || other.mType != null)
5715 && ((mData == null && mType == null)
5716 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005717 mData = other.mData;
5718 mType = other.mType;
5719 changes |= FILL_IN_DATA;
5720 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005721 if (other.mCategories != null
5722 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005723 if (other.mCategories != null) {
5724 mCategories = new HashSet<String>(other.mCategories);
5725 }
5726 changes |= FILL_IN_CATEGORIES;
5727 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005728 if (other.mPackage != null
5729 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005730 // Only do this if mSelector is not set.
5731 if (mSelector == null) {
5732 mPackage = other.mPackage;
5733 changes |= FILL_IN_PACKAGE;
5734 }
5735 }
5736 // Selector is special: it can only be set if explicitly allowed,
5737 // for the same reason as the component name.
5738 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5739 if (mPackage == null) {
5740 mSelector = new Intent(other.mSelector);
5741 mPackage = null;
5742 changes |= FILL_IN_SELECTOR;
5743 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005744 }
5745 // Component is special: it can -only- be set if explicitly allowed,
5746 // since otherwise the sender could force the intent somewhere the
5747 // originator didn't intend.
5748 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005749 mComponent = other.mComponent;
5750 changes |= FILL_IN_COMPONENT;
5751 }
5752 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005753 if (other.mSourceBounds != null
5754 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5755 mSourceBounds = new Rect(other.mSourceBounds);
5756 changes |= FILL_IN_SOURCE_BOUNDS;
5757 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005758 if (mExtras == null) {
5759 if (other.mExtras != null) {
5760 mExtras = new Bundle(other.mExtras);
5761 }
5762 } else if (other.mExtras != null) {
5763 try {
5764 Bundle newb = new Bundle(other.mExtras);
5765 newb.putAll(mExtras);
5766 mExtras = newb;
5767 } catch (RuntimeException e) {
5768 // Modifying the extras can cause us to unparcel the contents
5769 // of the bundle, and if we do this in the system process that
5770 // may fail. We really should handle this (i.e., the Bundle
5771 // impl shouldn't be on top of a plain map), but for now just
5772 // ignore it and keep the original contents. :(
5773 Log.w("Intent", "Failure filling in extras", e);
5774 }
5775 }
5776 return changes;
5777 }
5778
5779 /**
5780 * Wrapper class holding an Intent and implementing comparisons on it for
5781 * the purpose of filtering. The class implements its
5782 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5783 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5784 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5785 * on the wrapped Intent.
5786 */
5787 public static final class FilterComparison {
5788 private final Intent mIntent;
5789 private final int mHashCode;
5790
5791 public FilterComparison(Intent intent) {
5792 mIntent = intent;
5793 mHashCode = intent.filterHashCode();
5794 }
5795
5796 /**
5797 * Return the Intent that this FilterComparison represents.
5798 * @return Returns the Intent held by the FilterComparison. Do
5799 * not modify!
5800 */
5801 public Intent getIntent() {
5802 return mIntent;
5803 }
5804
5805 @Override
5806 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005807 if (obj instanceof FilterComparison) {
5808 Intent other = ((FilterComparison)obj).mIntent;
5809 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005810 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005811 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005812 }
5813
5814 @Override
5815 public int hashCode() {
5816 return mHashCode;
5817 }
5818 }
5819
5820 /**
5821 * Determine if two intents are the same for the purposes of intent
5822 * resolution (filtering). That is, if their action, data, type,
5823 * class, and categories are the same. This does <em>not</em> compare
5824 * any extra data included in the intents.
5825 *
5826 * @param other The other Intent to compare against.
5827 *
5828 * @return Returns true if action, data, type, class, and categories
5829 * are the same.
5830 */
5831 public boolean filterEquals(Intent other) {
5832 if (other == null) {
5833 return false;
5834 }
5835 if (mAction != other.mAction) {
5836 if (mAction != null) {
5837 if (!mAction.equals(other.mAction)) {
5838 return false;
5839 }
5840 } else {
5841 if (!other.mAction.equals(mAction)) {
5842 return false;
5843 }
5844 }
5845 }
5846 if (mData != other.mData) {
5847 if (mData != null) {
5848 if (!mData.equals(other.mData)) {
5849 return false;
5850 }
5851 } else {
5852 if (!other.mData.equals(mData)) {
5853 return false;
5854 }
5855 }
5856 }
5857 if (mType != other.mType) {
5858 if (mType != null) {
5859 if (!mType.equals(other.mType)) {
5860 return false;
5861 }
5862 } else {
5863 if (!other.mType.equals(mType)) {
5864 return false;
5865 }
5866 }
5867 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005868 if (mPackage != other.mPackage) {
5869 if (mPackage != null) {
5870 if (!mPackage.equals(other.mPackage)) {
5871 return false;
5872 }
5873 } else {
5874 if (!other.mPackage.equals(mPackage)) {
5875 return false;
5876 }
5877 }
5878 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005879 if (mComponent != other.mComponent) {
5880 if (mComponent != null) {
5881 if (!mComponent.equals(other.mComponent)) {
5882 return false;
5883 }
5884 } else {
5885 if (!other.mComponent.equals(mComponent)) {
5886 return false;
5887 }
5888 }
5889 }
5890 if (mCategories != other.mCategories) {
5891 if (mCategories != null) {
5892 if (!mCategories.equals(other.mCategories)) {
5893 return false;
5894 }
5895 } else {
5896 if (!other.mCategories.equals(mCategories)) {
5897 return false;
5898 }
5899 }
5900 }
5901
5902 return true;
5903 }
5904
5905 /**
5906 * Generate hash code that matches semantics of filterEquals().
5907 *
5908 * @return Returns the hash value of the action, data, type, class, and
5909 * categories.
5910 *
5911 * @see #filterEquals
5912 */
5913 public int filterHashCode() {
5914 int code = 0;
5915 if (mAction != null) {
5916 code += mAction.hashCode();
5917 }
5918 if (mData != null) {
5919 code += mData.hashCode();
5920 }
5921 if (mType != null) {
5922 code += mType.hashCode();
5923 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005924 if (mPackage != null) {
5925 code += mPackage.hashCode();
5926 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005927 if (mComponent != null) {
5928 code += mComponent.hashCode();
5929 }
5930 if (mCategories != null) {
5931 code += mCategories.hashCode();
5932 }
5933 return code;
5934 }
5935
5936 @Override
5937 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07005938 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005939
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005940 b.append("Intent { ");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07005941 toShortString(b, true, true, true);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005942 b.append(" }");
5943
5944 return b.toString();
5945 }
5946
5947 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07005948 public String toInsecureString() {
5949 StringBuilder b = new StringBuilder(128);
5950
5951 b.append("Intent { ");
5952 toShortString(b, false, true, true);
5953 b.append(" }");
5954
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005955 return b.toString();
5956 }
Romain Guy4969af72009-06-17 10:53:19 -07005957
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005958 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07005959 public String toShortString(boolean secure, boolean comp, boolean extras) {
5960 StringBuilder b = new StringBuilder(128);
5961 toShortString(b, secure, comp, extras);
5962 return b.toString();
5963 }
5964
5965 /** @hide */
5966 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005967 boolean first = true;
5968 if (mAction != null) {
5969 b.append("act=").append(mAction);
5970 first = false;
5971 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005972 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005973 if (!first) {
5974 b.append(' ');
5975 }
5976 first = false;
5977 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005978 Iterator<String> i = mCategories.iterator();
5979 boolean didone = false;
5980 while (i.hasNext()) {
5981 if (didone) b.append(",");
5982 didone = true;
5983 b.append(i.next());
5984 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005985 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005986 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005987 if (mData != null) {
5988 if (!first) {
5989 b.append(' ');
5990 }
5991 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07005992 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07005993 if (secure) {
5994 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07005995 } else {
5996 b.append(mData);
5997 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005998 }
5999 if (mType != null) {
6000 if (!first) {
6001 b.append(' ');
6002 }
6003 first = false;
6004 b.append("typ=").append(mType);
6005 }
6006 if (mFlags != 0) {
6007 if (!first) {
6008 b.append(' ');
6009 }
6010 first = false;
6011 b.append("flg=0x").append(Integer.toHexString(mFlags));
6012 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006013 if (mPackage != null) {
6014 if (!first) {
6015 b.append(' ');
6016 }
6017 first = false;
6018 b.append("pkg=").append(mPackage);
6019 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006020 if (comp && mComponent != null) {
6021 if (!first) {
6022 b.append(' ');
6023 }
6024 first = false;
6025 b.append("cmp=").append(mComponent.flattenToShortString());
6026 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006027 if (mSourceBounds != null) {
6028 if (!first) {
6029 b.append(' ');
6030 }
6031 first = false;
6032 b.append("bnds=").append(mSourceBounds.toShortString());
6033 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006034 if (extras && mExtras != null) {
6035 if (!first) {
6036 b.append(' ');
6037 }
6038 first = false;
6039 b.append("(has extras)");
6040 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006041 if (mSelector != null) {
6042 b.append(" sel={");
6043 mSelector.toShortString(b, secure, comp, extras);
6044 b.append("}");
6045 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006046 }
6047
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006048 /**
6049 * Call {@link #toUri} with 0 flags.
6050 * @deprecated Use {@link #toUri} instead.
6051 */
6052 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006053 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006054 return toUri(0);
6055 }
6056
6057 /**
6058 * Convert this Intent into a String holding a URI representation of it.
6059 * The returned URI string has been properly URI encoded, so it can be
6060 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6061 * Intent's data as the base URI, with an additional fragment describing
6062 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006063 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006064 * <p>You can convert the returned string back to an Intent with
6065 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006066 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006067 * @param flags Additional operating flags. Either 0 or
6068 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006069 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006070 * @return Returns a URI encoding URI string describing the entire contents
6071 * of the Intent.
6072 */
6073 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006074 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006075 String scheme = null;
6076 if (mData != null) {
6077 String data = mData.toString();
6078 if ((flags&URI_INTENT_SCHEME) != 0) {
6079 final int N = data.length();
6080 for (int i=0; i<N; i++) {
6081 char c = data.charAt(i);
6082 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6083 || c == '.' || c == '-') {
6084 continue;
6085 }
6086 if (c == ':' && i > 0) {
6087 // Valid scheme.
6088 scheme = data.substring(0, i);
6089 uri.append("intent:");
6090 data = data.substring(i+1);
6091 break;
6092 }
Tom Taylord4a47292009-12-21 13:59:18 -08006093
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006094 // No scheme.
6095 break;
6096 }
6097 }
6098 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006099
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006100 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6101 uri.append("intent:");
6102 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006103
6104 uri.append("#Intent;");
6105
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006106 toUriInner(uri, scheme, flags);
6107 if (mSelector != null) {
6108 uri.append("SEL;");
6109 // Note that for now we are not going to try to handle the
6110 // data part; not clear how to represent this as a URI, and
6111 // not much utility in it.
6112 mSelector.toUriInner(uri, null, flags);
6113 }
6114
6115 uri.append("end");
6116
6117 return uri.toString();
6118 }
6119
6120 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006121 if (scheme != null) {
6122 uri.append("scheme=").append(scheme).append(';');
6123 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006124 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006125 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006126 }
6127 if (mCategories != null) {
6128 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006129 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006130 }
6131 }
6132 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006133 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006134 }
6135 if (mFlags != 0) {
6136 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6137 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006138 if (mPackage != null) {
6139 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6140 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006141 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006142 uri.append("component=").append(Uri.encode(
6143 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006144 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006145 if (mSourceBounds != null) {
6146 uri.append("sourceBounds=")
6147 .append(Uri.encode(mSourceBounds.flattenToString()))
6148 .append(';');
6149 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006150 if (mExtras != null) {
6151 for (String key : mExtras.keySet()) {
6152 final Object value = mExtras.get(key);
6153 char entryType =
6154 value instanceof String ? 'S' :
6155 value instanceof Boolean ? 'B' :
6156 value instanceof Byte ? 'b' :
6157 value instanceof Character ? 'c' :
6158 value instanceof Double ? 'd' :
6159 value instanceof Float ? 'f' :
6160 value instanceof Integer ? 'i' :
6161 value instanceof Long ? 'l' :
6162 value instanceof Short ? 's' :
6163 '\0';
6164
6165 if (entryType != '\0') {
6166 uri.append(entryType);
6167 uri.append('.');
6168 uri.append(Uri.encode(key));
6169 uri.append('=');
6170 uri.append(Uri.encode(value.toString()));
6171 uri.append(';');
6172 }
6173 }
6174 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006175 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006176
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006177 public int describeContents() {
6178 return (mExtras != null) ? mExtras.describeContents() : 0;
6179 }
6180
6181 public void writeToParcel(Parcel out, int flags) {
6182 out.writeString(mAction);
6183 Uri.writeToParcel(out, mData);
6184 out.writeString(mType);
6185 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006186 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006187 ComponentName.writeToParcel(mComponent, out);
6188
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006189 if (mSourceBounds != null) {
6190 out.writeInt(1);
6191 mSourceBounds.writeToParcel(out, flags);
6192 } else {
6193 out.writeInt(0);
6194 }
6195
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006196 if (mCategories != null) {
6197 out.writeInt(mCategories.size());
6198 for (String category : mCategories) {
6199 out.writeString(category);
6200 }
6201 } else {
6202 out.writeInt(0);
6203 }
6204
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006205 if (mSelector != null) {
6206 out.writeInt(1);
6207 mSelector.writeToParcel(out, flags);
6208 } else {
6209 out.writeInt(0);
6210 }
6211
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006212 out.writeBundle(mExtras);
6213 }
6214
6215 public static final Parcelable.Creator<Intent> CREATOR
6216 = new Parcelable.Creator<Intent>() {
6217 public Intent createFromParcel(Parcel in) {
6218 return new Intent(in);
6219 }
6220 public Intent[] newArray(int size) {
6221 return new Intent[size];
6222 }
6223 };
6224
Dianne Hackborneb034652009-09-07 00:49:58 -07006225 /** @hide */
6226 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006227 readFromParcel(in);
6228 }
6229
6230 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006231 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006232 mData = Uri.CREATOR.createFromParcel(in);
6233 mType = in.readString();
6234 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006235 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006236 mComponent = ComponentName.readFromParcel(in);
6237
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006238 if (in.readInt() != 0) {
6239 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6240 }
6241
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006242 int N = in.readInt();
6243 if (N > 0) {
6244 mCategories = new HashSet<String>();
6245 int i;
6246 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006247 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006248 }
6249 } else {
6250 mCategories = null;
6251 }
6252
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006253 if (in.readInt() != 0) {
6254 mSelector = new Intent(in);
6255 }
6256
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006257 mExtras = in.readBundle();
6258 }
6259
6260 /**
6261 * Parses the "intent" element (and its children) from XML and instantiates
6262 * an Intent object. The given XML parser should be located at the tag
6263 * where parsing should start (often named "intent"), from which the
6264 * basic action, data, type, and package and class name will be
6265 * retrieved. The function will then parse in to any child elements,
6266 * looking for <category android:name="xxx"> tags to add categories and
6267 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6268 * to the intent.
6269 *
6270 * @param resources The Resources to use when inflating resources.
6271 * @param parser The XML parser pointing at an "intent" tag.
6272 * @param attrs The AttributeSet interface for retrieving extended
6273 * attribute data at the current <var>parser</var> location.
6274 * @return An Intent object matching the XML data.
6275 * @throws XmlPullParserException If there was an XML parsing error.
6276 * @throws IOException If there was an I/O error.
6277 */
6278 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6279 throws XmlPullParserException, IOException {
6280 Intent intent = new Intent();
6281
6282 TypedArray sa = resources.obtainAttributes(attrs,
6283 com.android.internal.R.styleable.Intent);
6284
6285 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6286
6287 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6288 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6289 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6290
6291 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6292 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6293 if (packageName != null && className != null) {
6294 intent.setComponent(new ComponentName(packageName, className));
6295 }
6296
6297 sa.recycle();
6298
6299 int outerDepth = parser.getDepth();
6300 int type;
6301 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6302 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6303 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6304 continue;
6305 }
6306
6307 String nodeName = parser.getName();
6308 if (nodeName.equals("category")) {
6309 sa = resources.obtainAttributes(attrs,
6310 com.android.internal.R.styleable.IntentCategory);
6311 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6312 sa.recycle();
6313
6314 if (cat != null) {
6315 intent.addCategory(cat);
6316 }
6317 XmlUtils.skipCurrentTag(parser);
6318
6319 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006320 if (intent.mExtras == null) {
6321 intent.mExtras = new Bundle();
6322 }
6323 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6324 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006325
6326 } else {
6327 XmlUtils.skipCurrentTag(parser);
6328 }
6329 }
6330
6331 return intent;
6332 }
Nick Pellyccae4122012-01-09 14:12:58 -08006333
6334 /**
6335 * Normalize a MIME data type.
6336 *
6337 * <p>A normalized MIME type has white-space trimmed,
6338 * content-type parameters removed, and is lower-case.
6339 * This aligns the type with Android best practices for
6340 * intent filtering.
6341 *
6342 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6343 * "text/x-vCard" becomes "text/x-vcard".
6344 *
6345 * <p>All MIME types received from outside Android (such as user input,
6346 * or external sources like Bluetooth, NFC, or the Internet) should
6347 * be normalized before they are used to create an Intent.
6348 *
6349 * @param type MIME data type to normalize
6350 * @return normalized MIME data type, or null if the input was null
6351 * @see {@link #setType}
6352 * @see {@link #setTypeAndNormalize}
6353 */
6354 public static String normalizeMimeType(String type) {
6355 if (type == null) {
6356 return null;
6357 }
6358
6359 type = type.trim().toLowerCase(Locale.US);
6360
6361 final int semicolonIndex = type.indexOf(';');
6362 if (semicolonIndex != -1) {
6363 type = type.substring(0, semicolonIndex);
6364 }
6365 return type;
6366 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006367}