blob: a96e89685f52caed00b0c3264583a9f493ed5a11 [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;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import com.android.internal.util.XmlUtils;
38
39import java.io.IOException;
40import java.io.Serializable;
41import java.net.URISyntaxException;
42import java.util.ArrayList;
43import java.util.HashSet;
44import java.util.Iterator;
45import java.util.Set;
46
47/**
48 * An intent is an abstract description of an operation to be performed. It
49 * can be used with {@link Context#startActivity(Intent) startActivity} to
50 * launch an {@link android.app.Activity},
51 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
52 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
53 * and {@link android.content.Context#startService} or
54 * {@link android.content.Context#bindService} to communicate with a
55 * background {@link android.app.Service}.
56 *
57 * <p>An Intent provides a facility for performing late runtime binding between
58 * the code in different applications. Its most significant use is in the
59 * launching of activities, where it can be thought of as the glue between
60 * activities. It is
61 * basically a passive data structure holding an abstract description of an
62 * action to be performed. The primary pieces of information in an intent
63 * are:</p>
64 *
65 * <ul>
66 * <li> <p><b>action</b> -- The general action to be performed, such as
67 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
68 * etc.</p>
69 * </li>
70 * <li> <p><b>data</b> -- The data to operate on, such as a person record
71 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
72 * </li>
73 * </ul>
74 *
75 *
76 * <p>Some examples of action/data pairs are:</p>
77 *
78 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070079 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070080 * information about the person whose identifier is "1".</p>
81 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070082 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070083 * the phone dialer with the person filled in.</p>
84 * </li>
85 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
86 * the phone dialer with the given number filled in. Note how the
87 * VIEW action does what what is considered the most reasonable thing for
88 * a particular URI.</p>
89 * </li>
90 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
91 * the phone dialer with the given number filled in.</p>
92 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070093 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070094 * information about the person whose identifier is "1".</p>
95 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070096 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070097 * a list of people, which the user can browse through. This example is a
98 * typical top-level entry into the Contacts application, showing you the
99 * list of people. Selecting a particular person to view would result in a
100 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
101 * being used to start an activity to display that person.</p>
102 * </li>
103 * </ul>
104 *
105 * <p>In addition to these primary attributes, there are a number of secondary
106 * attributes that you can also include with an intent:</p>
107 *
108 * <ul>
109 * <li> <p><b>category</b> -- Gives additional information about the action
110 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
111 * appear in the Launcher as a top-level application, while
112 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
113 * of alternative actions the user can perform on a piece of data.</p>
114 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
115 * intent data. Normally the type is inferred from the data itself.
116 * By setting this attribute, you disable that evaluation and force
117 * an explicit type.</p>
118 * <li> <p><b>component</b> -- Specifies an explicit name of a component
119 * class to use for the intent. Normally this is determined by looking
120 * at the other information in the intent (the action, data/type, and
121 * categories) and matching that with a component that can handle it.
122 * If this attribute is set then none of the evaluation is performed,
123 * and this component is used exactly as is. By specifying this attribute,
124 * all of the other Intent attributes become optional.</p>
125 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
126 * This can be used to provide extended information to the component.
127 * For example, if we have a action to send an e-mail message, we could
128 * also include extra pieces of data here to supply a subject, body,
129 * etc.</p>
130 * </ul>
131 *
132 * <p>Here are some examples of other operations you can specify as intents
133 * using these additional parameters:</p>
134 *
135 * <ul>
136 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
137 * Launch the home screen.</p>
138 * </li>
139 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
140 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
141 * vnd.android.cursor.item/phone}</i></b>
142 * -- Display the list of people's phone numbers, allowing the user to
143 * browse through them and pick one and return it to the parent activity.</p>
144 * </li>
145 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
146 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
147 * -- Display all pickers for data that can be opened with
148 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
149 * allowing the user to pick one of them and then some data inside of it
150 * and returning the resulting URI to the caller. This can be used,
151 * for example, in an e-mail application to allow the user to pick some
152 * data to include as an attachment.</p>
153 * </li>
154 * </ul>
155 *
156 * <p>There are a variety of standard Intent action and category constants
157 * defined in the Intent class, but applications can also define their own.
158 * These strings use java style scoping, to ensure they are unique -- for
159 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700160 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700161 *
162 * <p>Put together, the set of actions, data types, categories, and extra data
163 * defines a language for the system allowing for the expression of phrases
164 * such as "call john smith's cell". As applications are added to the system,
165 * they can extend this language by adding new actions, types, and categories, or
166 * they can modify the behavior of existing phrases by supplying their own
167 * activities that handle them.</p>
168 *
169 * <a name="IntentResolution"></a>
170 * <h3>Intent Resolution</h3>
171 *
172 * <p>There are two primary forms of intents you will use.
173 *
174 * <ul>
175 * <li> <p><b>Explicit Intents</b> have specified a component (via
176 * {@link #setComponent} or {@link #setClass}), which provides the exact
177 * class to be run. Often these will not include any other information,
178 * simply being a way for an application to launch various internal
179 * activities it has as the user interacts with the application.
180 *
181 * <li> <p><b>Implicit Intents</b> have not specified a component;
182 * instead, they must include enough information for the system to
183 * determine which of the available components is best to run for that
184 * intent.
185 * </ul>
186 *
187 * <p>When using implicit intents, given such an arbitrary intent we need to
188 * know what to do with it. This is handled by the process of <em>Intent
189 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
190 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
191 * more activities/receivers) that can handle it.</p>
192 *
193 * <p>The intent resolution mechanism basically revolves around matching an
194 * Intent against all of the &lt;intent-filter&gt; descriptions in the
195 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
196 * objects explicitly registered with {@link Context#registerReceiver}.) More
197 * details on this can be found in the documentation on the {@link
198 * IntentFilter} class.</p>
199 *
200 * <p>There are three pieces of information in the Intent that are used for
201 * resolution: the action, type, and category. Using this information, a query
202 * is done on the {@link PackageManager} for a component that can handle the
203 * intent. The appropriate component is determined based on the intent
204 * information supplied in the <code>AndroidManifest.xml</code> file as
205 * follows:</p>
206 *
207 * <ul>
208 * <li> <p>The <b>action</b>, if given, must be listed by the component as
209 * one it handles.</p>
210 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
211 * already supplied in the Intent. Like the action, if a type is
212 * included in the intent (either explicitly or implicitly in its
213 * data), then this must be listed by the component as one it handles.</p>
214 * <li> For data that is not a <code>content:</code> URI and where no explicit
215 * type is included in the Intent, instead the <b>scheme</b> of the
216 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
217 * considered. Again like the action, if we are matching a scheme it
218 * must be listed by the component as one it can handle.
219 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
220 * by the activity as categories it handles. That is, if you include
221 * the categories {@link #CATEGORY_LAUNCHER} and
222 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
223 * with an intent that lists <em>both</em> of those categories.
224 * Activities will very often need to support the
225 * {@link #CATEGORY_DEFAULT} so that they can be found by
226 * {@link Context#startActivity Context.startActivity()}.</p>
227 * </ul>
228 *
229 * <p>For example, consider the Note Pad sample application that
230 * allows user to browse through a list of notes data and view details about
231 * individual items. Text in italics indicate places were you would replace a
232 * name with one specific to your own package.</p>
233 *
234 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
235 * package="<i>com.android.notepad</i>"&gt;
236 * &lt;application android:icon="@drawable/app_notes"
237 * android:label="@string/app_name"&gt;
238 *
239 * &lt;provider class=".NotePadProvider"
240 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
241 *
242 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
243 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700244 * &lt;action android:name="android.intent.action.MAIN" /&gt;
245 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700246 * &lt;/intent-filter&gt;
247 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700248 * &lt;action android:name="android.intent.action.VIEW" /&gt;
249 * &lt;action android:name="android.intent.action.EDIT" /&gt;
250 * &lt;action android:name="android.intent.action.PICK" /&gt;
251 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
252 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700253 * &lt;/intent-filter&gt;
254 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700255 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
256 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
257 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700258 * &lt;/intent-filter&gt;
259 * &lt;/activity&gt;
260 *
261 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
262 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700263 * &lt;action android:name="android.intent.action.VIEW" /&gt;
264 * &lt;action android:name="android.intent.action.EDIT" /&gt;
265 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
266 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700267 * &lt;/intent-filter&gt;
268 *
269 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700270 * &lt;action android:name="android.intent.action.INSERT" /&gt;
271 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
272 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700273 * &lt;/intent-filter&gt;
274 *
275 * &lt;/activity&gt;
276 *
277 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
278 * android:theme="@android:style/Theme.Dialog"&gt;
279 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
283 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
284 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700285 * &lt;/intent-filter&gt;
286 * &lt;/activity&gt;
287 *
288 * &lt;/application&gt;
289 * &lt;/manifest&gt;</pre>
290 *
291 * <p>The first activity,
292 * <code>com.android.notepad.NotesList</code>, serves as our main
293 * entry into the app. It can do three things as described by its three intent
294 * templates:
295 * <ol>
296 * <li><pre>
297 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700298 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
299 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700300 * &lt;/intent-filter&gt;</pre>
301 * <p>This provides a top-level entry into the NotePad application: the standard
302 * MAIN action is a main entry point (not requiring any other information in
303 * the Intent), and the LAUNCHER category says that this entry point should be
304 * listed in the application launcher.</p>
305 * <li><pre>
306 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700307 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
308 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
309 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
310 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
311 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700312 * &lt;/intent-filter&gt;</pre>
313 * <p>This declares the things that the activity can do on a directory of
314 * notes. The type being supported is given with the &lt;type&gt; tag, where
315 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
316 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
317 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
318 * The activity allows the user to view or edit the directory of data (via
319 * the VIEW and EDIT actions), or to pick a particular note and return it
320 * to the caller (via the PICK action). Note also the DEFAULT category
321 * supplied here: this is <em>required</em> for the
322 * {@link Context#startActivity Context.startActivity} method to resolve your
323 * activity when its component name is not explicitly specified.</p>
324 * <li><pre>
325 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700326 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
327 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
328 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700329 * &lt;/intent-filter&gt;</pre>
330 * <p>This filter describes the ability return to the caller a note selected by
331 * the user without needing to know where it came from. The data type
332 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
333 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
334 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
335 * The GET_CONTENT action is similar to the PICK action, where the activity
336 * will return to its caller a piece of data selected by the user. Here,
337 * however, the caller specifies the type of data they desire instead of
338 * the type of data the user will be picking from.</p>
339 * </ol>
340 *
341 * <p>Given these capabilities, the following intents will resolve to the
342 * NotesList activity:</p>
343 *
344 * <ul>
345 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
346 * activities that can be used as top-level entry points into an
347 * application.</p>
348 * <li> <p><b>{ action=android.app.action.MAIN,
349 * category=android.app.category.LAUNCHER }</b> is the actual intent
350 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700351 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700352 * data=content://com.google.provider.NotePad/notes }</b>
353 * displays a list of all the notes under
354 * "content://com.google.provider.NotePad/notes", which
355 * the user can browse through and see the details on.</p>
356 * <li> <p><b>{ action=android.app.action.PICK
357 * data=content://com.google.provider.NotePad/notes }</b>
358 * provides a list of the notes under
359 * "content://com.google.provider.NotePad/notes", from which
360 * the user can pick a note whose data URL is returned back to the caller.</p>
361 * <li> <p><b>{ action=android.app.action.GET_CONTENT
362 * type=vnd.android.cursor.item/vnd.google.note }</b>
363 * is similar to the pick action, but allows the caller to specify the
364 * kind of data they want back so that the system can find the appropriate
365 * activity to pick something of that data type.</p>
366 * </ul>
367 *
368 * <p>The second activity,
369 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
370 * note entry and allows them to edit it. It can do two things as described
371 * by its two intent templates:
372 * <ol>
373 * <li><pre>
374 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700375 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
376 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
377 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
378 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700379 * &lt;/intent-filter&gt;</pre>
380 * <p>The first, primary, purpose of this activity is to let the user interact
381 * with a single note, as decribed by the MIME type
382 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
383 * either VIEW a note or allow the user to EDIT it. Again we support the
384 * DEFAULT category to allow the activity to be launched without explicitly
385 * specifying its component.</p>
386 * <li><pre>
387 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700388 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
389 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
390 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700391 * &lt;/intent-filter&gt;</pre>
392 * <p>The secondary use of this activity is to insert a new note entry into
393 * an existing directory of notes. This is used when the user creates a new
394 * note: the INSERT action is executed on the directory of notes, causing
395 * this activity to run and have the user create the new note data which
396 * it then adds to the content provider.</p>
397 * </ol>
398 *
399 * <p>Given these capabilities, the following intents will resolve to the
400 * NoteEditor activity:</p>
401 *
402 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700403 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700404 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
405 * shows the user the content of note <var>{ID}</var>.</p>
406 * <li> <p><b>{ action=android.app.action.EDIT
407 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
408 * allows the user to edit the content of note <var>{ID}</var>.</p>
409 * <li> <p><b>{ action=android.app.action.INSERT
410 * data=content://com.google.provider.NotePad/notes }</b>
411 * creates a new, empty note in the notes list at
412 * "content://com.google.provider.NotePad/notes"
413 * and allows the user to edit it. If they keep their changes, the URI
414 * of the newly created note is returned to the caller.</p>
415 * </ul>
416 *
417 * <p>The last activity,
418 * <code>com.android.notepad.TitleEditor</code>, allows the user to
419 * edit the title of a note. This could be implemented as a class that the
420 * application directly invokes (by explicitly setting its component in
421 * the Intent), but here we show a way you can publish alternative
422 * operations on existing data:</p>
423 *
424 * <pre>
425 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700426 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
427 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
429 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
430 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700431 * &lt;/intent-filter&gt;</pre>
432 *
433 * <p>In the single intent template here, we
434 * have created our own private action called
435 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
436 * edit the title of a note. It must be invoked on a specific note
437 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
438 * view and edit actions, but here displays and edits the title contained
439 * in the note data.
440 *
441 * <p>In addition to supporting the default category as usual, our title editor
442 * also supports two other standard categories: ALTERNATIVE and
443 * SELECTED_ALTERNATIVE. Implementing
444 * these categories allows others to find the special action it provides
445 * without directly knowing about it, through the
446 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
447 * more often to build dynamic menu items with
448 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
449 * template here was also supply an explicit name for the template
450 * (via <code>android:label="@string/resolve_title"</code>) to better control
451 * what the user sees when presented with this activity as an alternative
452 * action to the data they are viewing.
453 *
454 * <p>Given these capabilities, the following intent will resolve to the
455 * TitleEditor activity:</p>
456 *
457 * <ul>
458 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
459 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
460 * displays and allows the user to edit the title associated
461 * with note <var>{ID}</var>.</p>
462 * </ul>
463 *
464 * <h3>Standard Activity Actions</h3>
465 *
466 * <p>These are the current standard actions that Intent defines for launching
467 * activities (usually through {@link Context#startActivity}. The most
468 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
469 * {@link #ACTION_EDIT}.
470 *
471 * <ul>
472 * <li> {@link #ACTION_MAIN}
473 * <li> {@link #ACTION_VIEW}
474 * <li> {@link #ACTION_ATTACH_DATA}
475 * <li> {@link #ACTION_EDIT}
476 * <li> {@link #ACTION_PICK}
477 * <li> {@link #ACTION_CHOOSER}
478 * <li> {@link #ACTION_GET_CONTENT}
479 * <li> {@link #ACTION_DIAL}
480 * <li> {@link #ACTION_CALL}
481 * <li> {@link #ACTION_SEND}
482 * <li> {@link #ACTION_SENDTO}
483 * <li> {@link #ACTION_ANSWER}
484 * <li> {@link #ACTION_INSERT}
485 * <li> {@link #ACTION_DELETE}
486 * <li> {@link #ACTION_RUN}
487 * <li> {@link #ACTION_SYNC}
488 * <li> {@link #ACTION_PICK_ACTIVITY}
489 * <li> {@link #ACTION_SEARCH}
490 * <li> {@link #ACTION_WEB_SEARCH}
491 * <li> {@link #ACTION_FACTORY_TEST}
492 * </ul>
493 *
494 * <h3>Standard Broadcast Actions</h3>
495 *
496 * <p>These are the current standard actions that Intent defines for receiving
497 * broadcasts (usually through {@link Context#registerReceiver} or a
498 * &lt;receiver&gt; tag in a manifest).
499 *
500 * <ul>
501 * <li> {@link #ACTION_TIME_TICK}
502 * <li> {@link #ACTION_TIME_CHANGED}
503 * <li> {@link #ACTION_TIMEZONE_CHANGED}
504 * <li> {@link #ACTION_BOOT_COMPLETED}
505 * <li> {@link #ACTION_PACKAGE_ADDED}
506 * <li> {@link #ACTION_PACKAGE_CHANGED}
507 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800508 * <li> {@link #ACTION_PACKAGE_RESTARTED}
509 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700510 * <li> {@link #ACTION_UID_REMOVED}
511 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700512 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700513 * <li> {@link #ACTION_POWER_DISCONNECTED}
514 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700515 * </ul>
516 *
517 * <h3>Standard Categories</h3>
518 *
519 * <p>These are the current standard categories that can be used to further
520 * clarify an Intent via {@link #addCategory}.
521 *
522 * <ul>
523 * <li> {@link #CATEGORY_DEFAULT}
524 * <li> {@link #CATEGORY_BROWSABLE}
525 * <li> {@link #CATEGORY_TAB}
526 * <li> {@link #CATEGORY_ALTERNATIVE}
527 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
528 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800529 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700530 * <li> {@link #CATEGORY_HOME}
531 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700532 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400533 * <li> {@link #CATEGORY_CAR_DOCK}
534 * <li> {@link #CATEGORY_DESK_DOCK}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700535 * </ul>
536 *
537 * <h3>Standard Extra Data</h3>
538 *
539 * <p>These are the current standard fields that can be used as extra data via
540 * {@link #putExtra}.
541 *
542 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800543 * <li> {@link #EXTRA_ALARM_COUNT}
544 * <li> {@link #EXTRA_BCC}
545 * <li> {@link #EXTRA_CC}
546 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
547 * <li> {@link #EXTRA_DATA_REMOVED}
548 * <li> {@link #EXTRA_DOCK_STATE}
549 * <li> {@link #EXTRA_DOCK_STATE_CAR}
550 * <li> {@link #EXTRA_DOCK_STATE_DESK}
551 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
552 * <li> {@link #EXTRA_DONT_KILL_APP}
553 * <li> {@link #EXTRA_EMAIL}
554 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700555 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800556 * <li> {@link #EXTRA_KEY_EVENT}
557 * <li> {@link #EXTRA_PHONE_NUMBER}
558 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
559 * <li> {@link #EXTRA_REPLACING}
560 * <li> {@link #EXTRA_SHORTCUT_ICON}
561 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
562 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700563 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800564 * <li> {@link #EXTRA_SHORTCUT_NAME}
565 * <li> {@link #EXTRA_SUBJECT}
566 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700567 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800568 * <li> {@link #EXTRA_TITLE}
569 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700570 * </ul>
571 *
572 * <h3>Flags</h3>
573 *
574 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800575 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
576 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700577 */
578public class Intent implements Parcelable {
579 // ---------------------------------------------------------------------
580 // ---------------------------------------------------------------------
581 // Standard intent activity actions (see action variable).
582
583 /**
584 * Activity Action: Start as a main entry point, does not expect to
585 * receive data.
586 * <p>Input: nothing
587 * <p>Output: nothing
588 */
589 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
590 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800591
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700592 /**
593 * Activity Action: Display the data to the user. This is the most common
594 * action performed on data -- it is the generic action you can use on
595 * a piece of data to get the most reasonable thing to occur. For example,
596 * when used on a contacts entry it will view the entry; when used on a
597 * mailto: URI it will bring up a compose window filled with the information
598 * supplied by the URI; when used with a tel: URI it will invoke the
599 * dialer.
600 * <p>Input: {@link #getData} is URI from which to retrieve data.
601 * <p>Output: nothing.
602 */
603 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
604 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800605
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700606 /**
607 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
608 * performed on a piece of data.
609 */
610 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800611
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700612 /**
613 * Used to indicate that some piece of data should be attached to some other
614 * place. For example, image data could be attached to a contact. It is up
615 * to the recipient to decide where the data should be attached; the intent
616 * does not specify the ultimate destination.
617 * <p>Input: {@link #getData} is URI of data to be attached.
618 * <p>Output: nothing.
619 */
620 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
621 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800622
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700623 /**
624 * Activity Action: Provide explicit editable access to the given data.
625 * <p>Input: {@link #getData} is URI of data to be edited.
626 * <p>Output: nothing.
627 */
628 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
629 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800630
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700631 /**
632 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
633 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
634 * The extras can contain type specific data to pass through to the editing/creating
635 * activity.
636 * <p>Output: The URI of the item that was picked. This must be a content:
637 * URI so that any receiver can access it.
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Pick an item from the data, returning what was selected.
644 * <p>Input: {@link #getData} is URI containing a directory of data
645 * (vnd.android.cursor.dir/*) from which to pick an item.
646 * <p>Output: The URI of the item that was picked.
647 */
648 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
649 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800650
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700651 /**
652 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800653 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700654 * <p>Output: An Intent representing the shortcut. The intent must contain three
655 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
656 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657 * (value: ShortcutIconResource).</p>
658 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700659 * @see #EXTRA_SHORTCUT_INTENT
660 * @see #EXTRA_SHORTCUT_NAME
661 * @see #EXTRA_SHORTCUT_ICON
662 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
663 * @see android.content.Intent.ShortcutIconResource
664 */
665 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
666 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
667
668 /**
669 * The name of the extra used to define the Intent of a shortcut.
670 *
671 * @see #ACTION_CREATE_SHORTCUT
672 */
673 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
674 /**
675 * The name of the extra used to define the name of a shortcut.
676 *
677 * @see #ACTION_CREATE_SHORTCUT
678 */
679 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
680 /**
681 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
682 *
683 * @see #ACTION_CREATE_SHORTCUT
684 */
685 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
686 /**
687 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
688 *
689 * @see #ACTION_CREATE_SHORTCUT
690 * @see android.content.Intent.ShortcutIconResource
691 */
692 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
693 "android.intent.extra.shortcut.ICON_RESOURCE";
694
695 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800696 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700697 *
698 * @see Intent#ACTION_CREATE_SHORTCUT
699 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800700 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
701 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700702 */
703 public static class ShortcutIconResource implements Parcelable {
704 /**
705 * The package name of the application containing the icon.
706 */
707 public String packageName;
708
709 /**
710 * The resource name of the icon, including package, name and type.
711 */
712 public String resourceName;
713
714 /**
715 * Creates a new ShortcutIconResource for the specified context and resource
716 * identifier.
717 *
718 * @param context The context of the application.
719 * @param resourceId The resource idenfitier for the icon.
720 * @return A new ShortcutIconResource with the specified's context package name
721 * and icon resource idenfitier.
722 */
723 public static ShortcutIconResource fromContext(Context context, int resourceId) {
724 ShortcutIconResource icon = new ShortcutIconResource();
725 icon.packageName = context.getPackageName();
726 icon.resourceName = context.getResources().getResourceName(resourceId);
727 return icon;
728 }
729
730 /**
731 * Used to read a ShortcutIconResource from a Parcel.
732 */
733 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
734 new Parcelable.Creator<ShortcutIconResource>() {
735
736 public ShortcutIconResource createFromParcel(Parcel source) {
737 ShortcutIconResource icon = new ShortcutIconResource();
738 icon.packageName = source.readString();
739 icon.resourceName = source.readString();
740 return icon;
741 }
742
743 public ShortcutIconResource[] newArray(int size) {
744 return new ShortcutIconResource[size];
745 }
746 };
747
748 /**
749 * No special parcel contents.
750 */
751 public int describeContents() {
752 return 0;
753 }
754
755 public void writeToParcel(Parcel dest, int flags) {
756 dest.writeString(packageName);
757 dest.writeString(resourceName);
758 }
759
760 @Override
761 public String toString() {
762 return resourceName;
763 }
764 }
765
766 /**
767 * Activity Action: Display an activity chooser, allowing the user to pick
768 * what they want to before proceeding. This can be used as an alternative
769 * to the standard activity picker that is displayed by the system when
770 * you try to start an activity with multiple possible matches, with these
771 * differences in behavior:
772 * <ul>
773 * <li>You can specify the title that will appear in the activity chooser.
774 * <li>The user does not have the option to make one of the matching
775 * activities a preferred activity, and all possible activities will
776 * always be shown even if one of them is currently marked as the
777 * preferred activity.
778 * </ul>
779 * <p>
780 * This action should be used when the user will naturally expect to
781 * select an activity in order to proceed. An example if when not to use
782 * it is when the user clicks on a "mailto:" link. They would naturally
783 * expect to go directly to their mail app, so startActivity() should be
784 * called directly: it will
785 * either launch the current preferred app, or put up a dialog allowing the
786 * user to pick an app to use and optionally marking that as preferred.
787 * <p>
788 * In contrast, if the user is selecting a menu item to send a picture
789 * they are viewing to someone else, there are many different things they
790 * may want to do at this point: send it through e-mail, upload it to a
791 * web service, etc. In this case the CHOOSER action should be used, to
792 * always present to the user a list of the things they can do, with a
793 * nice title given by the caller such as "Send this photo with:".
794 * <p>
795 * As a convenience, an Intent of this form can be created with the
796 * {@link #createChooser} function.
797 * <p>Input: No data should be specified. get*Extra must have
798 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
799 * and can optionally have a {@link #EXTRA_TITLE} field containing the
800 * title text to display in the chooser.
801 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
802 */
803 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
804 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
805
806 /**
807 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
808 *
809 * @param target The Intent that the user will be selecting an activity
810 * to perform.
811 * @param title Optional title that will be displayed in the chooser.
812 * @return Return a new Intent object that you can hand to
813 * {@link Context#startActivity(Intent) Context.startActivity()} and
814 * related methods.
815 */
816 public static Intent createChooser(Intent target, CharSequence title) {
817 Intent intent = new Intent(ACTION_CHOOSER);
818 intent.putExtra(EXTRA_INTENT, target);
819 if (title != null) {
820 intent.putExtra(EXTRA_TITLE, title);
821 }
822 return intent;
823 }
824 /**
825 * Activity Action: Allow the user to select a particular kind of data and
826 * return it. This is different than {@link #ACTION_PICK} in that here we
827 * just say what kind of data is desired, not a URI of existing data from
828 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
829 * create the data as it runs (for example taking a picture or recording a
830 * sound), let them browser over the web and download the desired data,
831 * etc.
832 * <p>
833 * There are two main ways to use this action: if you want an specific kind
834 * of data, such as a person contact, you set the MIME type to the kind of
835 * data you want and launch it with {@link Context#startActivity(Intent)}.
836 * The system will then launch the best application to select that kind
837 * of data for you.
838 * <p>
839 * You may also be interested in any of a set of types of content the user
840 * can pick. For example, an e-mail application that wants to allow the
841 * user to add an attachment to an e-mail message can use this action to
842 * bring up a list of all of the types of content the user can attach.
843 * <p>
844 * In this case, you should wrap the GET_CONTENT intent with a chooser
845 * (through {@link #createChooser}), which will give the proper interface
846 * for the user to pick how to send your data and allow you to specify
847 * a prompt indicating what they are doing. You will usually specify a
848 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
849 * broad range of content types the user can select from.
850 * <p>
851 * When using such a broad GET_CONTENT action, it is often desireable to
852 * only pick from data that can be represented as a stream. This is
853 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
854 * <p>
855 * Input: {@link #getType} is the desired MIME type to retrieve. Note
856 * that no URI is supplied in the intent, as there are no constraints on
857 * where the returned data originally comes from. You may also include the
858 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
859 * opened as a stream.
860 * <p>
861 * Output: The URI of the item that was picked. This must be a content:
862 * URI so that any receiver can access it.
863 */
864 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
865 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
866 /**
867 * Activity Action: Dial a number as specified by the data. This shows a
868 * UI with the number being dialed, allowing the user to explicitly
869 * initiate the call.
870 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
871 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
872 * number.
873 * <p>Output: nothing.
874 */
875 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
876 public static final String ACTION_DIAL = "android.intent.action.DIAL";
877 /**
878 * Activity Action: Perform a call to someone specified by the data.
879 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
880 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
881 * number.
882 * <p>Output: nothing.
883 *
884 * <p>Note: there will be restrictions on which applications can initiate a
885 * call; most applications should use the {@link #ACTION_DIAL}.
886 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
887 * numbers. Applications can <strong>dial</strong> emergency numbers using
888 * {@link #ACTION_DIAL}, however.
889 */
890 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
891 public static final String ACTION_CALL = "android.intent.action.CALL";
892 /**
893 * Activity Action: Perform a call to an emergency number specified by the
894 * data.
895 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
896 * tel: URI of an explicit phone number.
897 * <p>Output: nothing.
898 * @hide
899 */
900 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
901 /**
902 * Activity action: Perform a call to any number (emergency or not)
903 * specified by the data.
904 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
905 * tel: URI of an explicit phone number.
906 * <p>Output: nothing.
907 * @hide
908 */
909 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
910 /**
911 * Activity Action: Send a message to someone specified by the data.
912 * <p>Input: {@link #getData} is URI describing the target.
913 * <p>Output: nothing.
914 */
915 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
916 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
917 /**
918 * Activity Action: Deliver some data to someone else. Who the data is
919 * being delivered to is not specified; it is up to the receiver of this
920 * action to ask the user where the data should be sent.
921 * <p>
922 * When launching a SEND intent, you should usually wrap it in a chooser
923 * (through {@link #createChooser}), which will give the proper interface
924 * for the user to pick how to send your data and allow you to specify
925 * a prompt indicating what they are doing.
926 * <p>
927 * Input: {@link #getType} is the MIME type of the data being sent.
928 * get*Extra can have either a {@link #EXTRA_TEXT}
929 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
930 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
931 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
932 * if the MIME type is unknown (this will only allow senders that can
933 * handle generic data streams).
934 * <p>
935 * Optional standard extras, which may be interpreted by some recipients as
936 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
937 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
938 * <p>
939 * Output: nothing.
940 */
941 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
942 public static final String ACTION_SEND = "android.intent.action.SEND";
943 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800944 * Activity Action: Deliver multiple data to someone else.
945 * <p>
946 * Like ACTION_SEND, except the data is multiple.
947 * <p>
948 * Input: {@link #getType} is the MIME type of the data being sent.
949 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
950 * #EXTRA_STREAM} field, containing the data to be sent.
951 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800952 * Multiple types are supported, and receivers should handle mixed types
953 * whenever possible. The right way for the receiver to check them is to
954 * use the content resolver on each URI. The intent sender should try to
955 * put the most concrete mime type in the intent type, but it can fall
956 * back to {@literal <type>/*} or {@literal *}/* as needed.
957 * <p>
958 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
959 * be image/jpg, but if you are sending image/jpg and image/png, then the
960 * intent's type should be image/*.
961 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800962 * Optional standard extras, which may be interpreted by some recipients as
963 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
964 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
965 * <p>
966 * Output: nothing.
967 */
968 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
969 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
970 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700971 * Activity Action: Handle an incoming phone call.
972 * <p>Input: nothing.
973 * <p>Output: nothing.
974 */
975 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
976 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
977 /**
978 * Activity Action: Insert an empty item into the given container.
979 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
980 * in which to place the data.
981 * <p>Output: URI of the new data that was created.
982 */
983 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
984 public static final String ACTION_INSERT = "android.intent.action.INSERT";
985 /**
986 * Activity Action: Delete the given data from its container.
987 * <p>Input: {@link #getData} is URI of data to be deleted.
988 * <p>Output: nothing.
989 */
990 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
991 public static final String ACTION_DELETE = "android.intent.action.DELETE";
992 /**
993 * Activity Action: Run the data, whatever that means.
994 * <p>Input: ? (Note: this is currently specific to the test harness.)
995 * <p>Output: nothing.
996 */
997 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
998 public static final String ACTION_RUN = "android.intent.action.RUN";
999 /**
1000 * Activity Action: Perform a data synchronization.
1001 * <p>Input: ?
1002 * <p>Output: ?
1003 */
1004 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1005 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1006 /**
1007 * Activity Action: Pick an activity given an intent, returning the class
1008 * selected.
1009 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1010 * used with {@link PackageManager#queryIntentActivities} to determine the
1011 * set of activities from which to pick.
1012 * <p>Output: Class name of the activity that was selected.
1013 */
1014 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1015 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1016 /**
1017 * Activity Action: Perform a search.
1018 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1019 * is the text to search for. If empty, simply
1020 * enter your search results Activity with the search UI activated.
1021 * <p>Output: nothing.
1022 */
1023 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1024 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1025 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001026 * Activity Action: Start the platform-defined tutorial
1027 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1028 * is the text to search for. If empty, simply
1029 * enter your search results Activity with the search UI activated.
1030 * <p>Output: nothing.
1031 */
1032 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1033 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1034 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001035 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001036 * <p>
1037 * Input: {@link android.app.SearchManager#QUERY
1038 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1039 * a url starts with http or https, the site will be opened. If it is plain
1040 * text, Google search will be applied.
1041 * <p>
1042 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001043 */
1044 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1045 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1046 /**
1047 * Activity Action: List all available applications
1048 * <p>Input: Nothing.
1049 * <p>Output: nothing.
1050 */
1051 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1052 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1053 /**
1054 * Activity Action: Show settings for choosing wallpaper
1055 * <p>Input: Nothing.
1056 * <p>Output: Nothing.
1057 */
1058 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1059 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1060
1061 /**
1062 * Activity Action: Show activity for reporting a bug.
1063 * <p>Input: Nothing.
1064 * <p>Output: Nothing.
1065 */
1066 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1067 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1068
1069 /**
1070 * Activity Action: Main entry point for factory tests. Only used when
1071 * the device is booting in factory test node. The implementing package
1072 * must be installed in the system image.
1073 * <p>Input: nothing
1074 * <p>Output: nothing
1075 */
1076 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1077
1078 /**
1079 * Activity Action: The user pressed the "call" button to go to the dialer
1080 * or other appropriate UI for placing a call.
1081 * <p>Input: Nothing.
1082 * <p>Output: Nothing.
1083 */
1084 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1085 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1086
1087 /**
1088 * Activity Action: Start Voice Command.
1089 * <p>Input: Nothing.
1090 * <p>Output: Nothing.
1091 */
1092 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1093 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001094
1095 /**
1096 * Activity Action: Start action associated with long pressing on the
1097 * search key.
1098 * <p>Input: Nothing.
1099 * <p>Output: Nothing.
1100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001103
Jacek Surazski86b6c532009-05-13 14:38:28 +02001104 /**
1105 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1106 * This intent is delivered to the package which installed the application, usually
1107 * the Market.
1108 * <p>Input: No data is specified. The bug report is passed in using
1109 * an {@link #EXTRA_BUG_REPORT} field.
1110 * <p>Output: Nothing.
1111 * @hide
1112 */
1113 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1114 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001115
1116 /**
1117 * Activity Action: Show power usage information to the user.
1118 * <p>Input: Nothing.
1119 * <p>Output: Nothing.
1120 */
1121 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1122 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
1123
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001124 /**
1125 * Activity Action: Setup wizard to launch after a platform update. This
1126 * activity should have a string meta-data field associated with it,
1127 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1128 * the platform for setup. The activity will be launched only if
1129 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1130 * same value.
1131 * <p>Input: Nothing.
1132 * <p>Output: Nothing.
1133 * @hide
1134 */
1135 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1136 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
1137
1138 /**
1139 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1140 * describing the last run version of the platform that was setup.
1141 * @hide
1142 */
1143 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1144
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001145 // ---------------------------------------------------------------------
1146 // ---------------------------------------------------------------------
1147 // Standard intent broadcast actions (see action variable).
1148
1149 /**
1150 * Broadcast Action: Sent after the screen turns off.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001151 *
1152 * <p class="note">This is a protected intent that can only be sent
1153 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001154 */
1155 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1156 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1157 /**
1158 * Broadcast Action: Sent after the screen turns on.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001159 *
1160 * <p class="note">This is a protected intent that can only be sent
1161 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001162 */
1163 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1164 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001165
1166 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001167 * 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 -07001168 * keyguard is gone).
Dianne Hackborn854060af2009-07-09 18:14:31 -07001169 *
1170 * <p class="note">This is a protected intent that can only be sent
1171 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001172 */
1173 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1174 public static final String ACTION_USER_PRESENT= "android.intent.action.USER_PRESENT";
1175
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001176 /**
1177 * Broadcast Action: The current time has changed. Sent every
1178 * minute. You can <em>not</em> receive this through components declared
1179 * in manifests, only by exlicitly registering for it with
1180 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1181 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001182 *
1183 * <p class="note">This is a protected intent that can only be sent
1184 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001185 */
1186 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1187 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1188 /**
1189 * Broadcast Action: The time was set.
1190 */
1191 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1192 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1193 /**
1194 * Broadcast Action: The date has changed.
1195 */
1196 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1197 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1198 /**
1199 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1200 * <ul>
1201 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1202 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001203 *
1204 * <p class="note">This is a protected intent that can only be sent
1205 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001206 */
1207 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1208 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1209 /**
1210 * Alarm Changed Action: This is broadcast when the AlarmClock
1211 * application's alarm is set or unset. It is used by the
1212 * AlarmClock application and the StatusBar service.
1213 * @hide
1214 */
1215 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1216 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1217 /**
1218 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1219 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1220 * @hide
1221 */
1222 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1223 public static final String ACTION_SYNC_STATE_CHANGED
1224 = "android.intent.action.SYNC_STATE_CHANGED";
1225 /**
1226 * Broadcast Action: This is broadcast once, after the system has finished
1227 * booting. It can be used to perform application-specific initialization,
1228 * such as installing alarms. You must hold the
1229 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1230 * in order to receive this broadcast.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001231 *
1232 * <p class="note">This is a protected intent that can only be sent
1233 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001234 */
1235 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1236 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1237 /**
1238 * Broadcast Action: This is broadcast when a user action should request a
1239 * temporary system dialog to dismiss. Some examples of temporary system
1240 * dialogs are the notification window-shade and the recent tasks dialog.
1241 */
1242 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1243 /**
1244 * Broadcast Action: Trigger the download and eventual installation
1245 * of a package.
1246 * <p>Input: {@link #getData} is the URI of the package file to download.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001247 *
1248 * <p class="note">This is a protected intent that can only be sent
1249 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001250 */
1251 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1252 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1253 /**
1254 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001255 * device. The data contains the name of the package. Note that the
1256 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001257 * <p>My include the following extras:
1258 * <ul>
1259 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1260 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1261 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1262 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001263 *
1264 * <p class="note">This is a protected intent that can only be sent
1265 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001266 */
1267 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1268 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1269 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001270 * Broadcast Action: A new version of an application package has been
1271 * installed, replacing an existing version that was previously installed.
1272 * The data contains the name of the package.
1273 * <p>My include the following extras:
1274 * <ul>
1275 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1276 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001277 *
1278 * <p class="note">This is a protected intent that can only be sent
1279 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001280 */
1281 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1282 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1283 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001284 * Broadcast Action: An existing application package has been removed from
1285 * the device. The data contains the name of the package. The package
1286 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001287 * <ul>
1288 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1289 * to the package.
1290 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1291 * application -- data and code -- is being removed.
1292 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1293 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1294 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001295 *
1296 * <p class="note">This is a protected intent that can only be sent
1297 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001298 */
1299 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1300 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1301 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001302 * Broadcast Action: An existing application package has been changed (e.g.
1303 * a component has been enabled or disabled). The data contains the name of
1304 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001305 * <ul>
1306 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001307 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1308 * of the changed components.
1309 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1310 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001311 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001312 *
1313 * <p class="note">This is a protected intent that can only be sent
1314 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001315 */
1316 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1317 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1318 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001319 * Broadcast Action: The user has restarted a package, and all of its
1320 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001321 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001322 * be removed. Note that the restarted package does <em>not</em>
1323 * receive this broadcast.
1324 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001325 * <ul>
1326 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1327 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001328 *
1329 * <p class="note">This is a protected intent that can only be sent
1330 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001331 */
1332 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1333 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1334 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001335 * Broadcast Action: The user has cleared the data of a package. This should
1336 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001337 * its persistent data is erased and this broadcast sent.
1338 * Note that the cleared package does <em>not</em>
1339 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001340 * <ul>
1341 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1342 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001343 *
1344 * <p class="note">This is a protected intent that can only be sent
1345 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001346 */
1347 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1348 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1349 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001350 * Broadcast Action: A user ID has been removed from the system. The user
1351 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001352 *
1353 * <p class="note">This is a protected intent that can only be sent
1354 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001355 */
1356 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1357 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1358 /**
1359 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001360 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001361 */
1362 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1363 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1364 /**
1365 * Broadcast Action: The current device {@link android.content.res.Configuration}
1366 * (orientation, locale, etc) has changed. When such a change happens, the
1367 * UIs (view hierarchy) will need to be rebuilt based on this new
1368 * information; for the most part, applications don't need to worry about
1369 * this, because the system will take care of stopping and restarting the
1370 * application to make sure it sees the new changes. Some system code that
1371 * can not be restarted will need to watch for this action and handle it
1372 * appropriately.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001373 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001374 * <p class="note">
1375 * You can <em>not</em> receive this through components declared
1376 * in manifests, only by explicitly registering for it with
1377 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1378 * Context.registerReceiver()}.
1379 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001380 * <p class="note">This is a protected intent that can only be sent
1381 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001382 *
1383 * @see android.content.res.Configuration
1384 */
1385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1386 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1387 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001388 * Broadcast Action: The current device's locale has changed.
1389 *
1390 * <p class="note">This is a protected intent that can only be sent
1391 * by the system.
1392 */
1393 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1394 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1395 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001396 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1397 * charging state, level, and other information about the battery.
1398 * See {@link android.os.BatteryManager} for documentation on the
1399 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001400 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001401 * <p class="note">
1402 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001403 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001404 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001405 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1406 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1407 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1408 * broadcasts that are sent and can be received through manifest
1409 * receivers.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001410 *
1411 * <p class="note">This is a protected intent that can only be sent
1412 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001413 */
1414 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1415 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1416 /**
1417 * Broadcast Action: Indicates low battery condition on the device.
1418 * This broadcast corresponds to the "Low battery warning" system dialog.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001419 *
1420 * <p class="note">This is a protected intent that can only be sent
1421 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001422 */
1423 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1424 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1425 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001426 * Broadcast Action: Indicates the battery is now okay after being low.
1427 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1428 * gone back up to an okay state.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001429 *
1430 * <p class="note">This is a protected intent that can only be sent
1431 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001432 */
1433 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1434 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1435 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001436 * Broadcast Action: External power has been connected to the device.
1437 * This is intended for applications that wish to register specifically to this notification.
1438 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1439 * stay active to receive this notification. This action can be used to implement actions
1440 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001441 *
1442 * <p class="note">This is a protected intent that can only be sent
1443 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001446 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001447 /**
1448 * Broadcast Action: External power has been removed from the device.
1449 * This is intended for applications that wish to register specifically to this notification.
1450 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1451 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001452 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001453 *
1454 * <p class="note">This is a protected intent that can only be sent
1455 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001456 */
1457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001458 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001459 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001460 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001461 * Broadcast Action: Device is shutting down.
1462 * This is broadcast when the device is being shut down (completely turned
1463 * off, not sleeping). Once the broadcast is complete, the final shutdown
1464 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001465 * to handle this, since the foreground activity will be paused as well.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001466 *
1467 * <p class="note">This is a protected intent that can only be sent
1468 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001469 */
1470 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001471 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001472 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001473 * Activity Action: Start this activity to request system shutdown.
1474 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1475 * to request confirmation from the user before shutting down.
1476 *
1477 * <p class="note">This is a protected intent that can only be sent
1478 * by the system.
1479 *
1480 * {@hide}
1481 */
1482 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1483 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001484 * Broadcast Action: A sticky broadcast that indicates low memory
1485 * condition on the device
Dianne Hackborn854060af2009-07-09 18:14:31 -07001486 *
1487 * <p class="note">This is a protected intent that can only be sent
1488 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001489 */
1490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1491 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1492 /**
1493 * Broadcast Action: Indicates low memory condition on the device no longer exists
Dianne Hackborn854060af2009-07-09 18:14:31 -07001494 *
1495 * <p class="note">This is a protected intent that can only be sent
1496 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001497 */
1498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1499 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1500 /**
1501 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1502 * and package management should be started.
1503 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1504 * notification.
1505 */
1506 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1507 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1508 /**
1509 * Broadcast Action: The device has entered USB Mass Storage mode.
1510 * This is used mainly for the USB Settings panel.
1511 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1512 * when the SD card file system is mounted or unmounted
1513 */
1514 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1515 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1516
1517 /**
1518 * Broadcast Action: The device has exited USB Mass Storage mode.
1519 * This is used mainly for the USB Settings panel.
1520 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1521 * when the SD card file system is mounted or unmounted
1522 */
1523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1524 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1525
1526 /**
1527 * Broadcast Action: External media has been removed.
1528 * The path to the mount point for the removed media is contained in the Intent.mData field.
1529 */
1530 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1531 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1532
1533 /**
1534 * Broadcast Action: External media is present, but not mounted at its mount point.
1535 * The path to the mount point for the removed media is contained in the Intent.mData field.
1536 */
1537 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1538 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1539
1540 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001541 * Broadcast Action: External media is present, and being disk-checked
1542 * 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 -08001543 */
1544 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1545 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1546
1547 /**
1548 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1549 * 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 -08001550 */
1551 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1552 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1553
1554 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001555 * Broadcast Action: External media is present and mounted at its mount point.
1556 * The path to the mount point for the removed media is contained in the Intent.mData field.
1557 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1558 * media was mounted read only.
1559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1562
1563 /**
1564 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1565 * The path to the mount point for the removed media is contained in the Intent.mData field.
1566 */
1567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1568 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1569
1570 /**
1571 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1572 * The path to the mount point for the removed media is contained in the Intent.mData field.
1573 */
1574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1575 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1576
1577 /**
1578 * Broadcast Action: External media is present but cannot be mounted.
1579 * The path to the mount point for the removed media is contained in the Intent.mData field.
1580 */
1581 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1582 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1583
1584 /**
1585 * Broadcast Action: User has expressed the desire to remove the external storage media.
1586 * Applications should close all files they have open within the mount point when they receive this intent.
1587 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1588 */
1589 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1590 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1591
1592 /**
1593 * Broadcast Action: The media scanner has started scanning a directory.
1594 * The path to the directory being scanned is contained in the Intent.mData field.
1595 */
1596 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1597 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1598
1599 /**
1600 * Broadcast Action: The media scanner has finished scanning a directory.
1601 * The path to the scanned directory is contained in the Intent.mData field.
1602 */
1603 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1604 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1605
1606 /**
1607 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1608 * The path to the file is contained in the Intent.mData field.
1609 */
1610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1611 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1612
1613 /**
1614 * Broadcast Action: The "Media Button" was pressed. Includes a single
1615 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1616 * caused the broadcast.
1617 */
1618 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1619 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1620
1621 /**
1622 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1623 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1624 * caused the broadcast.
1625 */
1626 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1627 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1628
1629 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1630 // location; they are not general-purpose actions.
1631
1632 /**
1633 * Broadcast Action: An GTalk connection has been established.
1634 */
1635 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1636 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1637 "android.intent.action.GTALK_CONNECTED";
1638
1639 /**
1640 * Broadcast Action: An GTalk connection has been disconnected.
1641 */
1642 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1643 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1644 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001645
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001646 /**
1647 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001648 */
1649 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1650 public static final String ACTION_INPUT_METHOD_CHANGED =
1651 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001652
1653 /**
1654 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1655 * more radios have been turned off or on. The intent will have the following extra value:</p>
1656 * <ul>
1657 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1658 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1659 * turned off</li>
1660 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001661 *
1662 * <p class="note">This is a protected intent that can only be sent
1663 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001664 */
1665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1666 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1667
1668 /**
1669 * Broadcast Action: Some content providers have parts of their namespace
1670 * where they publish new events or items that the user may be especially
1671 * interested in. For these things, they may broadcast this action when the
1672 * set of interesting items change.
1673 *
1674 * For example, GmailProvider sends this notification when the set of unread
1675 * mail in the inbox changes.
1676 *
1677 * <p>The data of the intent identifies which part of which provider
1678 * changed. When queried through the content resolver, the data URI will
1679 * return the data set in question.
1680 *
1681 * <p>The intent will have the following extra values:
1682 * <ul>
1683 * <li><em>count</em> - The number of items in the data set. This is the
1684 * same as the number of items in the cursor returned by querying the
1685 * data URI. </li>
1686 * </ul>
1687 *
1688 * This intent will be sent at boot (if the count is non-zero) and when the
1689 * data set changes. It is possible for the data set to change without the
1690 * count changing (for example, if a new unread message arrives in the same
1691 * sync operation in which a message is archived). The phone should still
1692 * ring/vibrate/etc as normal in this case.
1693 */
1694 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1695 public static final String ACTION_PROVIDER_CHANGED =
1696 "android.intent.action.PROVIDER_CHANGED";
1697
1698 /**
1699 * Broadcast Action: Wired Headset plugged in or unplugged.
1700 *
1701 * <p>The intent will have the following extra values:
1702 * <ul>
1703 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1704 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001705 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001706 * </ul>
1707 * </ul>
1708 */
1709 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1710 public static final String ACTION_HEADSET_PLUG =
1711 "android.intent.action.HEADSET_PLUG";
1712
1713 /**
1714 * Broadcast Action: An outgoing call is about to be placed.
1715 *
1716 * <p>The Intent will have the following extra value:
1717 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001718 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001719 * the phone number originally intended to be dialed.</li>
1720 * </ul>
1721 * <p>Once the broadcast is finished, the resultData is used as the actual
1722 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001723 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001724 * outgoing call in turn: for example, a parental control application
1725 * might verify that the user is authorized to place the call at that
1726 * time, then a number-rewriting application might add an area code if
1727 * one was not specified.</p>
1728 * <p>For consistency, any receiver whose purpose is to prohibit phone
1729 * calls should have a priority of 0, to ensure it will see the final
1730 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001731 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001732 * should have a positive priority.
1733 * Negative priorities are reserved for the system for this broadcast;
1734 * using them may cause problems.</p>
1735 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1736 * abort the broadcast.</p>
1737 * <p>Emergency calls cannot be intercepted using this mechanism, and
1738 * other calls cannot be modified to call emergency numbers using this
1739 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001740 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001741 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1742 * permission to receive this Intent.</p>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001743 *
1744 * <p class="note">This is a protected intent that can only be sent
1745 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001746 */
1747 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1748 public static final String ACTION_NEW_OUTGOING_CALL =
1749 "android.intent.action.NEW_OUTGOING_CALL";
1750
1751 /**
1752 * Broadcast Action: Have the device reboot. This is only for use by
1753 * system code.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001754 *
1755 * <p class="note">This is a protected intent that can only be sent
1756 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001757 */
1758 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1759 public static final String ACTION_REBOOT =
1760 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001761
Wei Huang97ecc9c2009-05-11 17:44:20 -07001762 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001763 * Broadcast Action: A sticky broadcast indicating the phone was docked
1764 * or undocked. Includes the extra
1765 * field {@link #EXTRA_DOCK_STATE}, containing the current dock state.
1766 * This is intended for monitoring the current dock state.
1767 * To launch an activity from a dock state change, use {@link #CATEGORY_CAR_DOCK}
1768 * or {@link #CATEGORY_DESK_DOCK} instead.
1769 */
1770 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1771 public static final String ACTION_DOCK_EVENT =
1772 "android.intent.action.DOCK_EVENT";
1773
1774 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07001775 * Broadcast Action: a remote intent is to be broadcasted.
1776 *
1777 * A remote intent is used for remote RPC between devices. The remote intent
1778 * is serialized and sent from one device to another device. The receiving
1779 * device parses the remote intent and broadcasts it. Note that anyone can
1780 * broadcast a remote intent. However, if the intent receiver of the remote intent
1781 * does not trust intent broadcasts from arbitrary intent senders, it should require
1782 * the sender to hold certain permissions so only trusted sender's broadcast will be
1783 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001784 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07001785 */
1786 public static final String ACTION_REMOTE_INTENT =
1787 "android.intent.action.REMOTE_INTENT";
1788
Dianne Hackborn9acc0302009-08-25 00:27:12 -07001789 /**
1790 * Broadcast Action: hook for permforming cleanup after a system update.
1791 *
1792 * The broadcast is sent when the system is booting, before the
1793 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
1794 * image. A receiver for this should do its work and then disable itself
1795 * so that it does not get run again at the next boot.
1796 * @hide
1797 */
1798 public static final String ACTION_PRE_BOOT_COMPLETED =
1799 "android.intent.action.PRE_BOOT_COMPLETED";
1800
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001801 // ---------------------------------------------------------------------
1802 // ---------------------------------------------------------------------
1803 // Standard intent categories (see addCategory()).
1804
1805 /**
1806 * Set if the activity should be an option for the default action
1807 * (center press) to perform on a piece of data. Setting this will
1808 * hide from the user any activities without it set when performing an
1809 * action on some data. Note that this is normal -not- set in the
1810 * Intent when initiating an action -- it is for use in intent filters
1811 * specified in packages.
1812 */
1813 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1814 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1815 /**
1816 * Activities that can be safely invoked from a browser must support this
1817 * category. For example, if the user is viewing a web page or an e-mail
1818 * and clicks on a link in the text, the Intent generated execute that
1819 * link will require the BROWSABLE category, so that only activities
1820 * supporting this category will be considered as possible actions. By
1821 * supporting this category, you are promising that there is nothing
1822 * damaging (without user intervention) that can happen by invoking any
1823 * matching Intent.
1824 */
1825 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1826 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1827 /**
1828 * Set if the activity should be considered as an alternative action to
1829 * the data the user is currently viewing. See also
1830 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1831 * applies to the selection in a list of items.
1832 *
1833 * <p>Supporting this category means that you would like your activity to be
1834 * displayed in the set of alternative things the user can do, usually as
1835 * part of the current activity's options menu. You will usually want to
1836 * include a specific label in the &lt;intent-filter&gt; of this action
1837 * describing to the user what it does.
1838 *
1839 * <p>The action of IntentFilter with this category is important in that it
1840 * describes the specific action the target will perform. This generally
1841 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1842 * a specific name such as "com.android.camera.action.CROP. Only one
1843 * alternative of any particular action will be shown to the user, so using
1844 * a specific action like this makes sure that your alternative will be
1845 * displayed while also allowing other applications to provide their own
1846 * overrides of that particular action.
1847 */
1848 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1849 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1850 /**
1851 * Set if the activity should be considered as an alternative selection
1852 * action to the data the user has currently selected. This is like
1853 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1854 * of items from which the user can select, giving them alternatives to the
1855 * default action that will be performed on it.
1856 */
1857 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1858 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1859 /**
1860 * Intended to be used as a tab inside of an containing TabActivity.
1861 */
1862 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1863 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1864 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001865 * Should be displayed in the top-level launcher.
1866 */
1867 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1868 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1869 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001870 * Provides information about the package it is in; typically used if
1871 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1872 * a front-door to the user without having to be shown in the all apps list.
1873 */
1874 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1875 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1876 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001877 * This is the home activity, that is the first activity that is displayed
1878 * when the device boots.
1879 */
1880 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1881 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1882 /**
1883 * This activity is a preference panel.
1884 */
1885 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1886 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1887 /**
1888 * This activity is a development preference panel.
1889 */
1890 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1891 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1892 /**
1893 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001894 */
1895 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1896 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1897 /**
1898 * This activity may be exercised by the monkey or other automated test tools.
1899 */
1900 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1901 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1902 /**
1903 * To be used as a test (not part of the normal user experience).
1904 */
1905 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1906 /**
1907 * To be used as a unit test (run through the Test Harness).
1908 */
1909 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1910 /**
1911 * To be used as an sample code example (not part of the normal user
1912 * experience).
1913 */
1914 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1915 /**
1916 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1917 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1918 * when queried, though it is allowable for those columns to be blank.
1919 */
1920 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1921 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1922
1923 /**
1924 * To be used as code under test for framework instrumentation tests.
1925 */
1926 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1927 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04001928 /**
1929 * An activity to run when device is inserted into a car dock.
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07001930 * Used with {@link #ACTION_MAIN} to launch an activity.
Mike Lockwood9092ab42009-09-16 13:01:32 -04001931 * To monitor dock state, use {@link #ACTION_DOCK_EVENT} instead.
1932 */
1933 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1934 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
1935 /**
1936 * An activity to run when device is inserted into a car dock.
1937 * Used with {@link #ACTION_MAIN} to launch an activity.
1938 * To monitor dock state, use {@link #ACTION_DOCK_EVENT} instead.
1939 */
1940 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1941 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001942
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001943 // ---------------------------------------------------------------------
1944 // ---------------------------------------------------------------------
1945 // Standard extra data keys.
1946
1947 /**
1948 * The initial data to place in a newly created record. Use with
1949 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1950 * fields as would be given to the underlying ContentProvider.insert()
1951 * call.
1952 */
1953 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1954
1955 /**
1956 * A constant CharSequence that is associated with the Intent, used with
1957 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1958 * this may be a styled CharSequence, so you must use
1959 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1960 * retrieve it.
1961 */
1962 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1963
1964 /**
1965 * A content: URI holding a stream of data associated with the Intent,
1966 * used with {@link #ACTION_SEND} to supply the data being sent.
1967 */
1968 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1969
1970 /**
1971 * A String[] holding e-mail addresses that should be delivered to.
1972 */
1973 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1974
1975 /**
1976 * A String[] holding e-mail addresses that should be carbon copied.
1977 */
1978 public static final String EXTRA_CC = "android.intent.extra.CC";
1979
1980 /**
1981 * A String[] holding e-mail addresses that should be blind carbon copied.
1982 */
1983 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1984
1985 /**
1986 * A constant string holding the desired subject line of a message.
1987 */
1988 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1989
1990 /**
1991 * An Intent describing the choices you would like shown with
1992 * {@link #ACTION_PICK_ACTIVITY}.
1993 */
1994 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1995
1996 /**
1997 * A CharSequence dialog title to provide to the user when used with a
1998 * {@link #ACTION_CHOOSER}.
1999 */
2000 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2001
2002 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002003 * A Parcelable[] of {@link Intent} or
2004 * {@link android.content.pm.LabeledIntent} objects as set with
2005 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2006 * a the front of the list of choices, when shown to the user with a
2007 * {@link #ACTION_CHOOSER}.
2008 */
2009 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2010
2011 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 * A {@link android.view.KeyEvent} object containing the event that
2013 * triggered the creation of the Intent it is in.
2014 */
2015 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2016
2017 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002018 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2019 * before shutting down.
2020 *
2021 * {@hide}
2022 */
2023 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2024
2025 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002026 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2027 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2028 * of restarting the application.
2029 */
2030 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2031
2032 /**
2033 * A String holding the phone number originally entered in
2034 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2035 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2036 */
2037 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
2038 /**
2039 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2040 * intents to supply the uid the package had been assigned. Also an optional
2041 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2042 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2043 * purpose.
2044 */
2045 public static final String EXTRA_UID = "android.intent.extra.UID";
2046
2047 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002048 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2049 * intents to indicate whether this represents a full uninstall (removing
2050 * both the code and its data) or a partial uninstall (leaving its data,
2051 * implying that this is an update).
2052 */
2053 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002054
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002055 /**
2056 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2057 * intents to indicate that this is a replacement of the package, so this
2058 * broadcast will immediately be followed by an add broadcast for a
2059 * different version of the same package.
2060 */
2061 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002062
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002063 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 * Used as an int extra field in {@link android.app.AlarmManager} intents
2065 * to tell the application being invoked how many pending alarms are being
2066 * delievered with the intent. For one-shot alarms this will always be 1.
2067 * For recurring alarms, this might be greater than 1 if the device was
2068 * asleep or powered off at the time an earlier alarm would have been
2069 * delivered.
2070 */
2071 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002072
Jacek Surazski86b6c532009-05-13 14:38:28 +02002073 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002074 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2075 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002076 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2077 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
2078 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002079 */
2080 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2081
2082 /**
2083 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2084 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002085 */
2086 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2087
2088 /**
2089 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2090 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002091 */
2092 public static final int EXTRA_DOCK_STATE_DESK = 1;
2093
2094 /**
2095 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2096 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002097 */
2098 public static final int EXTRA_DOCK_STATE_CAR = 2;
2099
2100 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002101 * Boolean that can be supplied as meta-data with a dock activity, to
2102 * indicate that the dock should take over the home key when it is active.
2103 */
2104 public static final String METADATA_DOCK_HOME = "android.dock_home";
2105
2106 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002107 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2108 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002109 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002110 * @hide
2111 */
2112 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2113
2114 /**
Romain Guy4969af72009-06-17 10:53:19 -07002115 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002116 * package. Specifies the installer package name; this package will receive the
2117 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002118 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002119 * @hide
2120 */
Romain Guy4969af72009-06-17 10:53:19 -07002121 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002122 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002123
Wei Huang97ecc9c2009-05-11 17:44:20 -07002124 /**
2125 * Used in the extra field in the remote intent. It's astring token passed with the
2126 * remote intent.
2127 */
2128 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2129 "android.intent.extra.remote_intent_token";
2130
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002131 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002132 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002133 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002134 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002135 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002136 "android.intent.extra.changed_component_name";
2137
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002138 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002139 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED}
2140 * and contains a string array of all of the components that have changed.
2141 */
2142 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2143 "android.intent.extra.changed_component_name_list";
2144
2145 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002146 * @hide
2147 * Magic extra system code can use when binding, to give a label for
2148 * who it is that has bound to a service. This is an integer giving
2149 * a framework string resource that can be displayed to the user.
2150 */
2151 public static final String EXTRA_CLIENT_LABEL =
2152 "android.intent.extra.client_label";
2153
2154 /**
2155 * @hide
2156 * Magic extra system code can use when binding, to give a PendingIntent object
2157 * that can be launched for the user to disable the system's use of this
2158 * service.
2159 */
2160 public static final String EXTRA_CLIENT_INTENT =
2161 "android.intent.extra.client_intent";
2162
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002163 // ---------------------------------------------------------------------
2164 // ---------------------------------------------------------------------
2165 // Intent flags (see mFlags variable).
2166
2167 /**
2168 * If set, the recipient of this Intent will be granted permission to
2169 * perform read operations on the Uri in the Intent's data.
2170 */
2171 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2172 /**
2173 * If set, the recipient of this Intent will be granted permission to
2174 * perform write operations on the Uri in the Intent's data.
2175 */
2176 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2177 /**
2178 * Can be set by the caller to indicate that this Intent is coming from
2179 * a background operation, not from direct user interaction.
2180 */
2181 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2182 /**
2183 * A flag you can enable for debugging: when set, log messages will be
2184 * printed during the resolution of this intent to show you what has
2185 * been found to create the final resolved list.
2186 */
2187 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
2188
2189 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002190 * If set, the new activity is not kept in the history stack. As soon as
2191 * the user navigates away from it, the activity is finished. This may also
2192 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2193 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002194 */
2195 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2196 /**
2197 * If set, the activity will not be launched if it is already running
2198 * at the top of the history stack.
2199 */
2200 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2201 /**
2202 * If set, this activity will become the start of a new task on this
2203 * history stack. A task (from the activity that started it to the
2204 * next task activity) defines an atomic group of activities that the
2205 * user can move to. Tasks can be moved to the foreground and background;
2206 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002207 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002208 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2209 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002210 *
2211 * <p>This flag is generally used by activities that want
2212 * to present a "launcher" style behavior: they give the user a list of
2213 * separate things that can be done, which otherwise run completely
2214 * independently of the activity launching them.
2215 *
2216 * <p>When using this flag, if a task is already running for the activity
2217 * you are now starting, then a new activity will not be started; instead,
2218 * the current task will simply be brought to the front of the screen with
2219 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2220 * to disable this behavior.
2221 *
2222 * <p>This flag can not be used when the caller is requesting a result from
2223 * the activity being launched.
2224 */
2225 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2226 /**
2227 * <strong>Do not use this flag unless you are implementing your own
2228 * top-level application launcher.</strong> Used in conjunction with
2229 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2230 * behavior of bringing an existing task to the foreground. When set,
2231 * a new task is <em>always</em> started to host the Activity for the
2232 * Intent, regardless of whether there is already an existing task running
2233 * the same thing.
2234 *
2235 * <p><strong>Because the default system does not include graphical task management,
2236 * you should not use this flag unless you provide some way for a user to
2237 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002238 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002239 * <p>This flag is ignored if
2240 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2241 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002242 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2243 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002244 */
2245 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2246 /**
2247 * If set, and the activity being launched is already running in the
2248 * current task, then instead of launching a new instance of that activity,
2249 * all of the other activities on top of it will be closed and this Intent
2250 * will be delivered to the (now on top) old activity as a new Intent.
2251 *
2252 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2253 * If D calls startActivity() with an Intent that resolves to the component
2254 * of activity B, then C and D will be finished and B receive the given
2255 * Intent, resulting in the stack now being: A, B.
2256 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002257 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002258 * either receive the new intent you are starting here in its
2259 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002260 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002261 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2262 * the same intent, then it will be finished and re-created; for all other
2263 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2264 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002265 *
2266 * <p>This launch mode can also be used to good effect in conjunction with
2267 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2268 * of a task, it will bring any currently running instance of that task
2269 * to the foreground, and then clear it to its root state. This is
2270 * especially useful, for example, when launching an activity from the
2271 * notification manager.
2272 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002273 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2274 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 */
2276 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2277 /**
2278 * If set and this intent is being used to launch a new activity from an
2279 * existing one, then the reply target of the existing activity will be
2280 * transfered to the new activity. This way the new activity can call
2281 * {@link android.app.Activity#setResult} and have that result sent back to
2282 * the reply target of the original activity.
2283 */
2284 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2285 /**
2286 * If set and this intent is being used to launch a new activity from an
2287 * existing one, the current activity will not be counted as the top
2288 * activity for deciding whether the new intent should be delivered to
2289 * the top instead of starting a new one. The previous activity will
2290 * be used as the top, with the assumption being that the current activity
2291 * will finish itself immediately.
2292 */
2293 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2294 /**
2295 * If set, the new activity is not kept in the list of recently launched
2296 * activities.
2297 */
2298 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2299 /**
2300 * This flag is not normally set by application code, but set for you by
2301 * the system as described in the
2302 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2303 * launchMode} documentation for the singleTask mode.
2304 */
2305 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2306 /**
2307 * If set, and this activity is either being started in a new task or
2308 * bringing to the top an existing task, then it will be launched as
2309 * the front door of the task. This will result in the application of
2310 * any affinities needed to have that task in the proper state (either
2311 * moving activities to or from it), or simply resetting that task to
2312 * its initial state if needed.
2313 */
2314 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2315 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002316 * This flag is not normally set by application code, but set for you by
2317 * the system if this activity is being launched from history
2318 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002319 */
2320 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002321 /**
2322 * If set, this marks a point in the task's activity stack that should
2323 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002324 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002325 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2326 * the user re-launching it from home), this activity and all on top of
2327 * it will be finished so that the user does not return to them, but
2328 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002329 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002330 * <p>This is useful for cases where you have a logical break in your
2331 * application. For example, an e-mail application may have a command
2332 * to view an attachment, which launches an image view activity to
2333 * display it. This activity should be part of the e-mail application's
2334 * task, since it is a part of the task the user is involved in. However,
2335 * if the user leaves that task, and later selects the e-mail app from
2336 * home, we may like them to return to the conversation they were
2337 * viewing, not the picture attachment, since that is confusing. By
2338 * setting this flag when launching the image viewer, that viewer and
2339 * any activities it starts will be removed the next time the user returns
2340 * to mail.
2341 */
2342 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002343 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002344 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002345 * callback from occurring on the current frontmost activity before it is
2346 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002347 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002348 * <p>Typically, an activity can rely on that callback to indicate that an
2349 * explicit user action has caused their activity to be moved out of the
2350 * foreground. The callback marks an appropriate point in the activity's
2351 * lifecycle for it to dismiss any notifications that it intends to display
2352 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002353 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002354 * <p>If an activity is ever started via any non-user-driven events such as
2355 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2356 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002357 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002358 */
2359 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002360 /**
2361 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2362 * this flag will cause the launched activity to be brought to the front of its
2363 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002364 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002365 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2366 * If D calls startActivity() with an Intent that resolves to the component
2367 * of activity B, then B will be brought to the front of the history stack,
2368 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002369 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002370 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002371 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002372 */
2373 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002374 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002375 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2376 * this flag will prevent the system from applying an activity transition
2377 * animation to go to the next activity state. This doesn't mean an
2378 * animation will never run -- if another activity change happens that doesn't
2379 * specify this flag before the activity started here is displayed, then
2380 * that transition will be used. This this flag can be put to good use
2381 * when you are going to do a series of activity operations but the
2382 * animation seen by the user shouldn't be driven by the first activity
2383 * change but rather a later one.
2384 */
2385 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2386 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002387 * If set, when sending a broadcast only registered receivers will be
2388 * called -- no BroadcastReceiver components will be launched.
2389 */
2390 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002391 /**
2392 * If set, when sending a broadcast <i>before boot has completed</i> only
2393 * registered receivers will be called -- no BroadcastReceiver components
2394 * will be launched. Sticky intent state will be recorded properly even
2395 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2396 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002397 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002398 * <p>This flag is only for use by system sevices as a convenience to
2399 * avoid having to implement a more complex mechanism around detection
2400 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002401 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002402 * @hide
2403 */
2404 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002405 /**
2406 * Set when this broadcast is for a boot upgrade, a special mode that
2407 * allows the broadcast to be sent before the system is ready and launches
2408 * the app process with no providers running in it.
2409 * @hide
2410 */
2411 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x10000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002412
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002413 /**
2414 * @hide Flags that can't be changed with PendingIntent.
2415 */
2416 public static final int IMMUTABLE_FLAGS =
2417 FLAG_GRANT_READ_URI_PERMISSION
2418 | FLAG_GRANT_WRITE_URI_PERMISSION;
2419
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002420 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002421 // ---------------------------------------------------------------------
2422 // toUri() and parseUri() options.
2423
2424 /**
2425 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2426 * always has the "intent:" scheme. This syntax can be used when you want
2427 * to later disambiguate between URIs that are intended to describe an
2428 * Intent vs. all others that should be treated as raw URIs. When used
2429 * with {@link #parseUri}, any other scheme will result in a generic
2430 * VIEW action for that raw URI.
2431 */
2432 public static final int URI_INTENT_SCHEME = 1<<0;
2433
2434 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002435
2436 private String mAction;
2437 private Uri mData;
2438 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002439 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002440 private ComponentName mComponent;
2441 private int mFlags;
2442 private HashSet<String> mCategories;
2443 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002444 private Rect mSourceBounds;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002445
2446 // ---------------------------------------------------------------------
2447
2448 /**
2449 * Create an empty intent.
2450 */
2451 public Intent() {
2452 }
2453
2454 /**
2455 * Copy constructor.
2456 */
2457 public Intent(Intent o) {
2458 this.mAction = o.mAction;
2459 this.mData = o.mData;
2460 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002461 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002462 this.mComponent = o.mComponent;
2463 this.mFlags = o.mFlags;
2464 if (o.mCategories != null) {
2465 this.mCategories = new HashSet<String>(o.mCategories);
2466 }
2467 if (o.mExtras != null) {
2468 this.mExtras = new Bundle(o.mExtras);
2469 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002470 if (o.mSourceBounds != null) {
2471 this.mSourceBounds = new Rect(o.mSourceBounds);
2472 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002473 }
2474
2475 @Override
2476 public Object clone() {
2477 return new Intent(this);
2478 }
2479
2480 private Intent(Intent o, boolean all) {
2481 this.mAction = o.mAction;
2482 this.mData = o.mData;
2483 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002484 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002485 this.mComponent = o.mComponent;
2486 if (o.mCategories != null) {
2487 this.mCategories = new HashSet<String>(o.mCategories);
2488 }
2489 }
2490
2491 /**
2492 * Make a clone of only the parts of the Intent that are relevant for
2493 * filter matching: the action, data, type, component, and categories.
2494 */
2495 public Intent cloneFilter() {
2496 return new Intent(this, false);
2497 }
2498
2499 /**
2500 * Create an intent with a given action. All other fields (data, type,
2501 * class) are null. Note that the action <em>must</em> be in a
2502 * namespace because Intents are used globally in the system -- for
2503 * example the system VIEW action is android.intent.action.VIEW; an
2504 * application's custom action would be something like
2505 * com.google.app.myapp.CUSTOM_ACTION.
2506 *
2507 * @param action The Intent action, such as ACTION_VIEW.
2508 */
2509 public Intent(String action) {
2510 mAction = action;
2511 }
2512
2513 /**
2514 * Create an intent with a given action and for a given data url. Note
2515 * that the action <em>must</em> be in a namespace because Intents are
2516 * used globally in the system -- for example the system VIEW action is
2517 * android.intent.action.VIEW; an application's custom action would be
2518 * something like com.google.app.myapp.CUSTOM_ACTION.
2519 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002520 * <p><em>Note: scheme and host name matching in the Android framework is
2521 * case-sensitive, unlike the formal RFC. As a result,
2522 * you should always ensure that you write your Uri with these elements
2523 * using lower case letters, and normalize any Uris you receive from
2524 * outside of Android to ensure the scheme and host is lower case.</em></p>
2525 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002526 * @param action The Intent action, such as ACTION_VIEW.
2527 * @param uri The Intent data URI.
2528 */
2529 public Intent(String action, Uri uri) {
2530 mAction = action;
2531 mData = uri;
2532 }
2533
2534 /**
2535 * Create an intent for a specific component. All other fields (action, data,
2536 * type, class) are null, though they can be modified later with explicit
2537 * calls. This provides a convenient way to create an intent that is
2538 * intended to execute a hard-coded class name, rather than relying on the
2539 * system to find an appropriate class for you; see {@link #setComponent}
2540 * for more information on the repercussions of this.
2541 *
2542 * @param packageContext A Context of the application package implementing
2543 * this class.
2544 * @param cls The component class that is to be used for the intent.
2545 *
2546 * @see #setClass
2547 * @see #setComponent
2548 * @see #Intent(String, android.net.Uri , Context, Class)
2549 */
2550 public Intent(Context packageContext, Class<?> cls) {
2551 mComponent = new ComponentName(packageContext, cls);
2552 }
2553
2554 /**
2555 * Create an intent for a specific component with a specified action and data.
2556 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2557 * construct the Intent and then calling {@link #setClass} to set its
2558 * class.
2559 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002560 * <p><em>Note: scheme and host name matching in the Android framework is
2561 * case-sensitive, unlike the formal RFC. As a result,
2562 * you should always ensure that you write your Uri with these elements
2563 * using lower case letters, and normalize any Uris you receive from
2564 * outside of Android to ensure the scheme and host is lower case.</em></p>
2565 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002566 * @param action The Intent action, such as ACTION_VIEW.
2567 * @param uri The Intent data URI.
2568 * @param packageContext A Context of the application package implementing
2569 * this class.
2570 * @param cls The component class that is to be used for the intent.
2571 *
2572 * @see #Intent(String, android.net.Uri)
2573 * @see #Intent(Context, Class)
2574 * @see #setClass
2575 * @see #setComponent
2576 */
2577 public Intent(String action, Uri uri,
2578 Context packageContext, Class<?> cls) {
2579 mAction = action;
2580 mData = uri;
2581 mComponent = new ComponentName(packageContext, cls);
2582 }
2583
2584 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002585 * Call {@link #parseUri} with 0 flags.
2586 * @deprecated Use {@link #parseUri} instead.
2587 */
2588 @Deprecated
2589 public static Intent getIntent(String uri) throws URISyntaxException {
2590 return parseUri(uri, 0);
2591 }
2592
2593 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002594 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002595 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002596 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002597 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002598 *
2599 * <p>The URI given here must not be relative -- that is, it must include
2600 * the scheme and full path.
2601 *
2602 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002603 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002604 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002605 *
2606 * @return Intent The newly created Intent object.
2607 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002608 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2609 * it bad (as parsed by the Uri class) or the Intent data within the
2610 * URI is invalid.
2611 *
2612 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002613 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002614 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002615 int i = 0;
2616 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002617 // Validate intent scheme for if requested.
2618 if ((flags&URI_INTENT_SCHEME) != 0) {
2619 if (!uri.startsWith("intent:")) {
2620 Intent intent = new Intent(ACTION_VIEW);
2621 try {
2622 intent.setData(Uri.parse(uri));
2623 } catch (IllegalArgumentException e) {
2624 throw new URISyntaxException(uri, e.getMessage());
2625 }
2626 return intent;
2627 }
2628 }
2629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002630 // simple case
2631 i = uri.lastIndexOf("#");
2632 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2633
2634 // old format Intent URI
2635 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002637 // new format
2638 Intent intent = new Intent(ACTION_VIEW);
2639
2640 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002641 String data = i >= 0 ? uri.substring(0, i) : null;
2642 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002643 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002644
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002645 // loop over contents of Intent, all name=value;
2646 while (!uri.startsWith("end", i)) {
2647 int eq = uri.indexOf('=', i);
2648 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002649 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002650
2651 // action
2652 if (uri.startsWith("action=", i)) {
2653 intent.mAction = value;
2654 }
2655
2656 // categories
2657 else if (uri.startsWith("category=", i)) {
2658 intent.addCategory(value);
2659 }
2660
2661 // type
2662 else if (uri.startsWith("type=", i)) {
2663 intent.mType = value;
2664 }
2665
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002666 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002667 else if (uri.startsWith("launchFlags=", i)) {
2668 intent.mFlags = Integer.decode(value).intValue();
2669 }
2670
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002671 // package
2672 else if (uri.startsWith("package=", i)) {
2673 intent.mPackage = value;
2674 }
2675
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002676 // component
2677 else if (uri.startsWith("component=", i)) {
2678 intent.mComponent = ComponentName.unflattenFromString(value);
2679 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002680
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002681 // scheme
2682 else if (uri.startsWith("scheme=", i)) {
2683 scheme = value;
2684 }
2685
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002686 // source bounds
2687 else if (uri.startsWith("sourceBounds=", i)) {
2688 intent.mSourceBounds = Rect.unflattenFromString(value);
2689 }
2690
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002691 // extra
2692 else {
2693 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002694 // create Bundle if it doesn't already exist
2695 if (intent.mExtras == null) intent.mExtras = new Bundle();
2696 Bundle b = intent.mExtras;
2697 // add EXTRA
2698 if (uri.startsWith("S.", i)) b.putString(key, value);
2699 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2700 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2701 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2702 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2703 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2704 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2705 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2706 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2707 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2708 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002709
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002710 // move to the next item
2711 i = semi + 1;
2712 }
2713
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002714 if (data != null) {
2715 if (data.startsWith("intent:")) {
2716 data = data.substring(7);
2717 if (scheme != null) {
2718 data = scheme + ':' + data;
2719 }
2720 }
2721
2722 if (data.length() > 0) {
2723 try {
2724 intent.mData = Uri.parse(data);
2725 } catch (IllegalArgumentException e) {
2726 throw new URISyntaxException(uri, e.getMessage());
2727 }
2728 }
2729 }
2730
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002731 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002732
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002733 } catch (IndexOutOfBoundsException e) {
2734 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2735 }
2736 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002737
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002738 public static Intent getIntentOld(String uri) throws URISyntaxException {
2739 Intent intent;
2740
2741 int i = uri.lastIndexOf('#');
2742 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002743 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002744 final int intentFragmentStart = i;
2745 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002746
2747 i++;
2748
2749 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002750 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002751 i += 7;
2752 int j = uri.indexOf(')', i);
2753 action = uri.substring(i, j);
2754 i = j + 1;
2755 }
2756
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002757 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002758
2759 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002760 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002761 i += 11;
2762 int j = uri.indexOf(')', i);
2763 while (i < j) {
2764 int sep = uri.indexOf('!', i);
2765 if (sep < 0) sep = j;
2766 if (i < sep) {
2767 intent.addCategory(uri.substring(i, sep));
2768 }
2769 i = sep + 1;
2770 }
2771 i = j + 1;
2772 }
2773
2774 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002775 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002776 i += 5;
2777 int j = uri.indexOf(')', i);
2778 intent.mType = uri.substring(i, j);
2779 i = j + 1;
2780 }
2781
2782 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002783 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002784 i += 12;
2785 int j = uri.indexOf(')', i);
2786 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2787 i = j + 1;
2788 }
2789
2790 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002791 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002792 i += 10;
2793 int j = uri.indexOf(')', i);
2794 int sep = uri.indexOf('!', i);
2795 if (sep >= 0 && sep < j) {
2796 String pkg = uri.substring(i, sep);
2797 String cls = uri.substring(sep + 1, j);
2798 intent.mComponent = new ComponentName(pkg, cls);
2799 }
2800 i = j + 1;
2801 }
2802
2803 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002804 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002805 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002806
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002807 final int closeParen = uri.indexOf(')', i);
2808 if (closeParen == -1) throw new URISyntaxException(uri,
2809 "EXTRA missing trailing ')'", i);
2810
2811 while (i < closeParen) {
2812 // fetch the key value
2813 int j = uri.indexOf('=', i);
2814 if (j <= i + 1 || i >= closeParen) {
2815 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2816 }
2817 char type = uri.charAt(i);
2818 i++;
2819 String key = uri.substring(i, j);
2820 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002821
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002822 // get type-value
2823 j = uri.indexOf('!', i);
2824 if (j == -1 || j >= closeParen) j = closeParen;
2825 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2826 String value = uri.substring(i, j);
2827 i = j;
2828
2829 // create Bundle if it doesn't already exist
2830 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002831
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002832 // add item to bundle
2833 try {
2834 switch (type) {
2835 case 'S':
2836 intent.mExtras.putString(key, Uri.decode(value));
2837 break;
2838 case 'B':
2839 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2840 break;
2841 case 'b':
2842 intent.mExtras.putByte(key, Byte.parseByte(value));
2843 break;
2844 case 'c':
2845 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2846 break;
2847 case 'd':
2848 intent.mExtras.putDouble(key, Double.parseDouble(value));
2849 break;
2850 case 'f':
2851 intent.mExtras.putFloat(key, Float.parseFloat(value));
2852 break;
2853 case 'i':
2854 intent.mExtras.putInt(key, Integer.parseInt(value));
2855 break;
2856 case 'l':
2857 intent.mExtras.putLong(key, Long.parseLong(value));
2858 break;
2859 case 's':
2860 intent.mExtras.putShort(key, Short.parseShort(value));
2861 break;
2862 default:
2863 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2864 }
2865 } catch (NumberFormatException e) {
2866 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2867 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002868
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002869 char ch = uri.charAt(i);
2870 if (ch == ')') break;
2871 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2872 i++;
2873 }
2874 }
2875
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002876 if (isIntentFragment) {
2877 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
2878 } else {
2879 intent.mData = Uri.parse(uri);
2880 }
2881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002882 if (intent.mAction == null) {
2883 // By default, if no action is specified, then use VIEW.
2884 intent.mAction = ACTION_VIEW;
2885 }
2886
2887 } else {
2888 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2889 }
2890
2891 return intent;
2892 }
2893
2894 /**
2895 * Retrieve the general action to be performed, such as
2896 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2897 * the information in the intent should be interpreted -- most importantly,
2898 * what to do with the data returned by {@link #getData}.
2899 *
2900 * @return The action of this intent or null if none is specified.
2901 *
2902 * @see #setAction
2903 */
2904 public String getAction() {
2905 return mAction;
2906 }
2907
2908 /**
2909 * Retrieve data this intent is operating on. This URI specifies the name
2910 * of the data; often it uses the content: scheme, specifying data in a
2911 * content provider. Other schemes may be handled by specific activities,
2912 * such as http: by the web browser.
2913 *
2914 * @return The URI of the data this intent is targeting or null.
2915 *
2916 * @see #getScheme
2917 * @see #setData
2918 */
2919 public Uri getData() {
2920 return mData;
2921 }
2922
2923 /**
2924 * The same as {@link #getData()}, but returns the URI as an encoded
2925 * String.
2926 */
2927 public String getDataString() {
2928 return mData != null ? mData.toString() : null;
2929 }
2930
2931 /**
2932 * Return the scheme portion of the intent's data. If the data is null or
2933 * does not include a scheme, null is returned. Otherwise, the scheme
2934 * prefix without the final ':' is returned, i.e. "http".
2935 *
2936 * <p>This is the same as calling getData().getScheme() (and checking for
2937 * null data).
2938 *
2939 * @return The scheme of this intent.
2940 *
2941 * @see #getData
2942 */
2943 public String getScheme() {
2944 return mData != null ? mData.getScheme() : null;
2945 }
2946
2947 /**
2948 * Retrieve any explicit MIME type included in the intent. This is usually
2949 * null, as the type is determined by the intent data.
2950 *
2951 * @return If a type was manually set, it is returned; else null is
2952 * returned.
2953 *
2954 * @see #resolveType(ContentResolver)
2955 * @see #setType
2956 */
2957 public String getType() {
2958 return mType;
2959 }
2960
2961 /**
2962 * Return the MIME data type of this intent. If the type field is
2963 * explicitly set, that is simply returned. Otherwise, if the data is set,
2964 * the type of that data is returned. If neither fields are set, a null is
2965 * returned.
2966 *
2967 * @return The MIME type of this intent.
2968 *
2969 * @see #getType
2970 * @see #resolveType(ContentResolver)
2971 */
2972 public String resolveType(Context context) {
2973 return resolveType(context.getContentResolver());
2974 }
2975
2976 /**
2977 * Return the MIME data type of this intent. If the type field is
2978 * explicitly set, that is simply returned. Otherwise, if the data is set,
2979 * the type of that data is returned. If neither fields are set, a null is
2980 * returned.
2981 *
2982 * @param resolver A ContentResolver that can be used to determine the MIME
2983 * type of the intent's data.
2984 *
2985 * @return The MIME type of this intent.
2986 *
2987 * @see #getType
2988 * @see #resolveType(Context)
2989 */
2990 public String resolveType(ContentResolver resolver) {
2991 if (mType != null) {
2992 return mType;
2993 }
2994 if (mData != null) {
2995 if ("content".equals(mData.getScheme())) {
2996 return resolver.getType(mData);
2997 }
2998 }
2999 return null;
3000 }
3001
3002 /**
3003 * Return the MIME data type of this intent, only if it will be needed for
3004 * intent resolution. This is not generally useful for application code;
3005 * it is used by the frameworks for communicating with back-end system
3006 * services.
3007 *
3008 * @param resolver A ContentResolver that can be used to determine the MIME
3009 * type of the intent's data.
3010 *
3011 * @return The MIME type of this intent, or null if it is unknown or not
3012 * needed.
3013 */
3014 public String resolveTypeIfNeeded(ContentResolver resolver) {
3015 if (mComponent != null) {
3016 return mType;
3017 }
3018 return resolveType(resolver);
3019 }
3020
3021 /**
3022 * Check if an category exists in the intent.
3023 *
3024 * @param category The category to check.
3025 *
3026 * @return boolean True if the intent contains the category, else false.
3027 *
3028 * @see #getCategories
3029 * @see #addCategory
3030 */
3031 public boolean hasCategory(String category) {
3032 return mCategories != null && mCategories.contains(category);
3033 }
3034
3035 /**
3036 * Return the set of all categories in the intent. If there are no categories,
3037 * returns NULL.
3038 *
3039 * @return Set The set of categories you can examine. Do not modify!
3040 *
3041 * @see #hasCategory
3042 * @see #addCategory
3043 */
3044 public Set<String> getCategories() {
3045 return mCategories;
3046 }
3047
3048 /**
3049 * Sets the ClassLoader that will be used when unmarshalling
3050 * any Parcelable values from the extras of this Intent.
3051 *
3052 * @param loader a ClassLoader, or null to use the default loader
3053 * at the time of unmarshalling.
3054 */
3055 public void setExtrasClassLoader(ClassLoader loader) {
3056 if (mExtras != null) {
3057 mExtras.setClassLoader(loader);
3058 }
3059 }
3060
3061 /**
3062 * Returns true if an extra value is associated with the given name.
3063 * @param name the extra's name
3064 * @return true if the given extra is present.
3065 */
3066 public boolean hasExtra(String name) {
3067 return mExtras != null && mExtras.containsKey(name);
3068 }
3069
3070 /**
3071 * Returns true if the Intent's extras contain a parcelled file descriptor.
3072 * @return true if the Intent contains a parcelled file descriptor.
3073 */
3074 public boolean hasFileDescriptors() {
3075 return mExtras != null && mExtras.hasFileDescriptors();
3076 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003077
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003078 /**
3079 * Retrieve extended data from the intent.
3080 *
3081 * @param name The name of the desired item.
3082 *
3083 * @return the value of an item that previously added with putExtra()
3084 * or null if none was found.
3085 *
3086 * @deprecated
3087 * @hide
3088 */
3089 @Deprecated
3090 public Object getExtra(String name) {
3091 return getExtra(name, null);
3092 }
3093
3094 /**
3095 * Retrieve extended data from the intent.
3096 *
3097 * @param name The name of the desired item.
3098 * @param defaultValue the value to be returned if no value of the desired
3099 * type is stored with the given name.
3100 *
3101 * @return the value of an item that previously added with putExtra()
3102 * or the default value if none was found.
3103 *
3104 * @see #putExtra(String, boolean)
3105 */
3106 public boolean getBooleanExtra(String name, boolean defaultValue) {
3107 return mExtras == null ? defaultValue :
3108 mExtras.getBoolean(name, defaultValue);
3109 }
3110
3111 /**
3112 * Retrieve extended data from the intent.
3113 *
3114 * @param name The name of the desired item.
3115 * @param defaultValue the value to be returned if no value of the desired
3116 * type is stored with the given name.
3117 *
3118 * @return the value of an item that previously added with putExtra()
3119 * or the default value if none was found.
3120 *
3121 * @see #putExtra(String, byte)
3122 */
3123 public byte getByteExtra(String name, byte defaultValue) {
3124 return mExtras == null ? defaultValue :
3125 mExtras.getByte(name, defaultValue);
3126 }
3127
3128 /**
3129 * Retrieve extended data from the intent.
3130 *
3131 * @param name The name of the desired item.
3132 * @param defaultValue the value to be returned if no value of the desired
3133 * type is stored with the given name.
3134 *
3135 * @return the value of an item that previously added with putExtra()
3136 * or the default value if none was found.
3137 *
3138 * @see #putExtra(String, short)
3139 */
3140 public short getShortExtra(String name, short defaultValue) {
3141 return mExtras == null ? defaultValue :
3142 mExtras.getShort(name, defaultValue);
3143 }
3144
3145 /**
3146 * Retrieve extended data from the intent.
3147 *
3148 * @param name The name of the desired item.
3149 * @param defaultValue the value to be returned if no value of the desired
3150 * type is stored with the given name.
3151 *
3152 * @return the value of an item that previously added with putExtra()
3153 * or the default value if none was found.
3154 *
3155 * @see #putExtra(String, char)
3156 */
3157 public char getCharExtra(String name, char defaultValue) {
3158 return mExtras == null ? defaultValue :
3159 mExtras.getChar(name, defaultValue);
3160 }
3161
3162 /**
3163 * Retrieve extended data from the intent.
3164 *
3165 * @param name The name of the desired item.
3166 * @param defaultValue the value to be returned if no value of the desired
3167 * type is stored with the given name.
3168 *
3169 * @return the value of an item that previously added with putExtra()
3170 * or the default value if none was found.
3171 *
3172 * @see #putExtra(String, int)
3173 */
3174 public int getIntExtra(String name, int defaultValue) {
3175 return mExtras == null ? defaultValue :
3176 mExtras.getInt(name, defaultValue);
3177 }
3178
3179 /**
3180 * Retrieve extended data from the intent.
3181 *
3182 * @param name The name of the desired item.
3183 * @param defaultValue the value to be returned if no value of the desired
3184 * type is stored with the given name.
3185 *
3186 * @return the value of an item that previously added with putExtra()
3187 * or the default value if none was found.
3188 *
3189 * @see #putExtra(String, long)
3190 */
3191 public long getLongExtra(String name, long defaultValue) {
3192 return mExtras == null ? defaultValue :
3193 mExtras.getLong(name, defaultValue);
3194 }
3195
3196 /**
3197 * Retrieve extended data from the intent.
3198 *
3199 * @param name The name of the desired item.
3200 * @param defaultValue the value to be returned if no value of the desired
3201 * type is stored with the given name.
3202 *
3203 * @return the value of an item that previously added with putExtra(),
3204 * or the default value if no such item is present
3205 *
3206 * @see #putExtra(String, float)
3207 */
3208 public float getFloatExtra(String name, float defaultValue) {
3209 return mExtras == null ? defaultValue :
3210 mExtras.getFloat(name, defaultValue);
3211 }
3212
3213 /**
3214 * Retrieve extended data from the intent.
3215 *
3216 * @param name The name of the desired item.
3217 * @param defaultValue the value to be returned if no value of the desired
3218 * type is stored with the given name.
3219 *
3220 * @return the value of an item that previously added with putExtra()
3221 * or the default value if none was found.
3222 *
3223 * @see #putExtra(String, double)
3224 */
3225 public double getDoubleExtra(String name, double defaultValue) {
3226 return mExtras == null ? defaultValue :
3227 mExtras.getDouble(name, defaultValue);
3228 }
3229
3230 /**
3231 * Retrieve extended data from the intent.
3232 *
3233 * @param name The name of the desired item.
3234 *
3235 * @return the value of an item that previously added with putExtra()
3236 * or null if no String value was found.
3237 *
3238 * @see #putExtra(String, String)
3239 */
3240 public String getStringExtra(String name) {
3241 return mExtras == null ? null : mExtras.getString(name);
3242 }
3243
3244 /**
3245 * Retrieve extended data from the intent.
3246 *
3247 * @param name The name of the desired item.
3248 *
3249 * @return the value of an item that previously added with putExtra()
3250 * or null if no CharSequence value was found.
3251 *
3252 * @see #putExtra(String, CharSequence)
3253 */
3254 public CharSequence getCharSequenceExtra(String name) {
3255 return mExtras == null ? null : mExtras.getCharSequence(name);
3256 }
3257
3258 /**
3259 * Retrieve extended data from the intent.
3260 *
3261 * @param name The name of the desired item.
3262 *
3263 * @return the value of an item that previously added with putExtra()
3264 * or null if no Parcelable value was found.
3265 *
3266 * @see #putExtra(String, Parcelable)
3267 */
3268 public <T extends Parcelable> T getParcelableExtra(String name) {
3269 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3270 }
3271
3272 /**
3273 * Retrieve extended data from the intent.
3274 *
3275 * @param name The name of the desired item.
3276 *
3277 * @return the value of an item that previously added with putExtra()
3278 * or null if no Parcelable[] value was found.
3279 *
3280 * @see #putExtra(String, Parcelable[])
3281 */
3282 public Parcelable[] getParcelableArrayExtra(String name) {
3283 return mExtras == null ? null : mExtras.getParcelableArray(name);
3284 }
3285
3286 /**
3287 * Retrieve extended data from the intent.
3288 *
3289 * @param name The name of the desired item.
3290 *
3291 * @return the value of an item that previously added with putExtra()
3292 * or null if no ArrayList<Parcelable> value was found.
3293 *
3294 * @see #putParcelableArrayListExtra(String, ArrayList)
3295 */
3296 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3297 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3298 }
3299
3300 /**
3301 * Retrieve extended data from the intent.
3302 *
3303 * @param name The name of the desired item.
3304 *
3305 * @return the value of an item that previously added with putExtra()
3306 * or null if no Serializable value was found.
3307 *
3308 * @see #putExtra(String, Serializable)
3309 */
3310 public Serializable getSerializableExtra(String name) {
3311 return mExtras == null ? null : mExtras.getSerializable(name);
3312 }
3313
3314 /**
3315 * Retrieve extended data from the intent.
3316 *
3317 * @param name The name of the desired item.
3318 *
3319 * @return the value of an item that previously added with putExtra()
3320 * or null if no ArrayList<Integer> value was found.
3321 *
3322 * @see #putIntegerArrayListExtra(String, ArrayList)
3323 */
3324 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3325 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3326 }
3327
3328 /**
3329 * Retrieve extended data from the intent.
3330 *
3331 * @param name The name of the desired item.
3332 *
3333 * @return the value of an item that previously added with putExtra()
3334 * or null if no ArrayList<String> value was found.
3335 *
3336 * @see #putStringArrayListExtra(String, ArrayList)
3337 */
3338 public ArrayList<String> getStringArrayListExtra(String name) {
3339 return mExtras == null ? null : mExtras.getStringArrayList(name);
3340 }
3341
3342 /**
3343 * Retrieve extended data from the intent.
3344 *
3345 * @param name The name of the desired item.
3346 *
3347 * @return the value of an item that previously added with putExtra()
3348 * or null if no boolean array value was found.
3349 *
3350 * @see #putExtra(String, boolean[])
3351 */
3352 public boolean[] getBooleanArrayExtra(String name) {
3353 return mExtras == null ? null : mExtras.getBooleanArray(name);
3354 }
3355
3356 /**
3357 * Retrieve extended data from the intent.
3358 *
3359 * @param name The name of the desired item.
3360 *
3361 * @return the value of an item that previously added with putExtra()
3362 * or null if no byte array value was found.
3363 *
3364 * @see #putExtra(String, byte[])
3365 */
3366 public byte[] getByteArrayExtra(String name) {
3367 return mExtras == null ? null : mExtras.getByteArray(name);
3368 }
3369
3370 /**
3371 * Retrieve extended data from the intent.
3372 *
3373 * @param name The name of the desired item.
3374 *
3375 * @return the value of an item that previously added with putExtra()
3376 * or null if no short array value was found.
3377 *
3378 * @see #putExtra(String, short[])
3379 */
3380 public short[] getShortArrayExtra(String name) {
3381 return mExtras == null ? null : mExtras.getShortArray(name);
3382 }
3383
3384 /**
3385 * Retrieve extended data from the intent.
3386 *
3387 * @param name The name of the desired item.
3388 *
3389 * @return the value of an item that previously added with putExtra()
3390 * or null if no char array value was found.
3391 *
3392 * @see #putExtra(String, char[])
3393 */
3394 public char[] getCharArrayExtra(String name) {
3395 return mExtras == null ? null : mExtras.getCharArray(name);
3396 }
3397
3398 /**
3399 * Retrieve extended data from the intent.
3400 *
3401 * @param name The name of the desired item.
3402 *
3403 * @return the value of an item that previously added with putExtra()
3404 * or null if no int array value was found.
3405 *
3406 * @see #putExtra(String, int[])
3407 */
3408 public int[] getIntArrayExtra(String name) {
3409 return mExtras == null ? null : mExtras.getIntArray(name);
3410 }
3411
3412 /**
3413 * Retrieve extended data from the intent.
3414 *
3415 * @param name The name of the desired item.
3416 *
3417 * @return the value of an item that previously added with putExtra()
3418 * or null if no long array value was found.
3419 *
3420 * @see #putExtra(String, long[])
3421 */
3422 public long[] getLongArrayExtra(String name) {
3423 return mExtras == null ? null : mExtras.getLongArray(name);
3424 }
3425
3426 /**
3427 * Retrieve extended data from the intent.
3428 *
3429 * @param name The name of the desired item.
3430 *
3431 * @return the value of an item that previously added with putExtra()
3432 * or null if no float array value was found.
3433 *
3434 * @see #putExtra(String, float[])
3435 */
3436 public float[] getFloatArrayExtra(String name) {
3437 return mExtras == null ? null : mExtras.getFloatArray(name);
3438 }
3439
3440 /**
3441 * Retrieve extended data from the intent.
3442 *
3443 * @param name The name of the desired item.
3444 *
3445 * @return the value of an item that previously added with putExtra()
3446 * or null if no double array value was found.
3447 *
3448 * @see #putExtra(String, double[])
3449 */
3450 public double[] getDoubleArrayExtra(String name) {
3451 return mExtras == null ? null : mExtras.getDoubleArray(name);
3452 }
3453
3454 /**
3455 * Retrieve extended data from the intent.
3456 *
3457 * @param name The name of the desired item.
3458 *
3459 * @return the value of an item that previously added with putExtra()
3460 * or null if no String array value was found.
3461 *
3462 * @see #putExtra(String, String[])
3463 */
3464 public String[] getStringArrayExtra(String name) {
3465 return mExtras == null ? null : mExtras.getStringArray(name);
3466 }
3467
3468 /**
3469 * Retrieve extended data from the intent.
3470 *
3471 * @param name The name of the desired item.
3472 *
3473 * @return the value of an item that previously added with putExtra()
3474 * or null if no Bundle value was found.
3475 *
3476 * @see #putExtra(String, Bundle)
3477 */
3478 public Bundle getBundleExtra(String name) {
3479 return mExtras == null ? null : mExtras.getBundle(name);
3480 }
3481
3482 /**
3483 * Retrieve extended data from the intent.
3484 *
3485 * @param name The name of the desired item.
3486 *
3487 * @return the value of an item that previously added with putExtra()
3488 * or null if no IBinder value was found.
3489 *
3490 * @see #putExtra(String, IBinder)
3491 *
3492 * @deprecated
3493 * @hide
3494 */
3495 @Deprecated
3496 public IBinder getIBinderExtra(String name) {
3497 return mExtras == null ? null : mExtras.getIBinder(name);
3498 }
3499
3500 /**
3501 * Retrieve extended data from the intent.
3502 *
3503 * @param name The name of the desired item.
3504 * @param defaultValue The default value to return in case no item is
3505 * associated with the key 'name'
3506 *
3507 * @return the value of an item that previously added with putExtra()
3508 * or defaultValue if none was found.
3509 *
3510 * @see #putExtra
3511 *
3512 * @deprecated
3513 * @hide
3514 */
3515 @Deprecated
3516 public Object getExtra(String name, Object defaultValue) {
3517 Object result = defaultValue;
3518 if (mExtras != null) {
3519 Object result2 = mExtras.get(name);
3520 if (result2 != null) {
3521 result = result2;
3522 }
3523 }
3524
3525 return result;
3526 }
3527
3528 /**
3529 * Retrieves a map of extended data from the intent.
3530 *
3531 * @return the map of all extras previously added with putExtra(),
3532 * or null if none have been added.
3533 */
3534 public Bundle getExtras() {
3535 return (mExtras != null)
3536 ? new Bundle(mExtras)
3537 : null;
3538 }
3539
3540 /**
3541 * Retrieve any special flags associated with this intent. You will
3542 * normally just set them with {@link #setFlags} and let the system
3543 * take the appropriate action with them.
3544 *
3545 * @return int The currently set flags.
3546 *
3547 * @see #setFlags
3548 */
3549 public int getFlags() {
3550 return mFlags;
3551 }
3552
3553 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003554 * Retrieve the application package name this Intent is limited to. When
3555 * resolving an Intent, if non-null this limits the resolution to only
3556 * components in the given application package.
3557 *
3558 * @return The name of the application package for the Intent.
3559 *
3560 * @see #resolveActivity
3561 * @see #setPackage
3562 */
3563 public String getPackage() {
3564 return mPackage;
3565 }
3566
3567 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003568 * Retrieve the concrete component associated with the intent. When receiving
3569 * an intent, this is the component that was found to best handle it (that is,
3570 * yourself) and will always be non-null; in all other cases it will be
3571 * null unless explicitly set.
3572 *
3573 * @return The name of the application component to handle the intent.
3574 *
3575 * @see #resolveActivity
3576 * @see #setComponent
3577 */
3578 public ComponentName getComponent() {
3579 return mComponent;
3580 }
3581
3582 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003583 * Get the bounds of the sender of this intent, in screen coordinates. This can be
3584 * used as a hint to the receiver for animations and the like. Null means that there
3585 * is no source bounds.
3586 */
3587 public Rect getSourceBounds() {
3588 return mSourceBounds;
3589 }
3590
3591 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003592 * Return the Activity component that should be used to handle this intent.
3593 * The appropriate component is determined based on the information in the
3594 * intent, evaluated as follows:
3595 *
3596 * <p>If {@link #getComponent} returns an explicit class, that is returned
3597 * without any further consideration.
3598 *
3599 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3600 * category to be considered.
3601 *
3602 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3603 * action.
3604 *
3605 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3606 * this type.
3607 *
3608 * <p>If {@link #addCategory} has added any categories, the activity must
3609 * handle ALL of the categories specified.
3610 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003611 * <p>If {@link #getPackage} is non-NULL, only activity components in
3612 * that application package will be considered.
3613 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003614 * <p>If there are no activities that satisfy all of these conditions, a
3615 * null string is returned.
3616 *
3617 * <p>If multiple activities are found to satisfy the intent, the one with
3618 * the highest priority will be used. If there are multiple activities
3619 * with the same priority, the system will either pick the best activity
3620 * based on user preference, or resolve to a system class that will allow
3621 * the user to pick an activity and forward from there.
3622 *
3623 * <p>This method is implemented simply by calling
3624 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3625 * true.</p>
3626 * <p> This API is called for you as part of starting an activity from an
3627 * intent. You do not normally need to call it yourself.</p>
3628 *
3629 * @param pm The package manager with which to resolve the Intent.
3630 *
3631 * @return Name of the component implementing an activity that can
3632 * display the intent.
3633 *
3634 * @see #setComponent
3635 * @see #getComponent
3636 * @see #resolveActivityInfo
3637 */
3638 public ComponentName resolveActivity(PackageManager pm) {
3639 if (mComponent != null) {
3640 return mComponent;
3641 }
3642
3643 ResolveInfo info = pm.resolveActivity(
3644 this, PackageManager.MATCH_DEFAULT_ONLY);
3645 if (info != null) {
3646 return new ComponentName(
3647 info.activityInfo.applicationInfo.packageName,
3648 info.activityInfo.name);
3649 }
3650
3651 return null;
3652 }
3653
3654 /**
3655 * Resolve the Intent into an {@link ActivityInfo}
3656 * describing the activity that should execute the intent. Resolution
3657 * follows the same rules as described for {@link #resolveActivity}, but
3658 * you get back the completely information about the resolved activity
3659 * instead of just its class name.
3660 *
3661 * @param pm The package manager with which to resolve the Intent.
3662 * @param flags Addition information to retrieve as per
3663 * {@link PackageManager#getActivityInfo(ComponentName, int)
3664 * PackageManager.getActivityInfo()}.
3665 *
3666 * @return PackageManager.ActivityInfo
3667 *
3668 * @see #resolveActivity
3669 */
3670 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3671 ActivityInfo ai = null;
3672 if (mComponent != null) {
3673 try {
3674 ai = pm.getActivityInfo(mComponent, flags);
3675 } catch (PackageManager.NameNotFoundException e) {
3676 // ignore
3677 }
3678 } else {
3679 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003680 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003681 if (info != null) {
3682 ai = info.activityInfo;
3683 }
3684 }
3685
3686 return ai;
3687 }
3688
3689 /**
3690 * Set the general action to be performed.
3691 *
3692 * @param action An action name, such as ACTION_VIEW. Application-specific
3693 * actions should be prefixed with the vendor's package name.
3694 *
3695 * @return Returns the same Intent object, for chaining multiple calls
3696 * into a single statement.
3697 *
3698 * @see #getAction
3699 */
3700 public Intent setAction(String action) {
3701 mAction = action;
3702 return this;
3703 }
3704
3705 /**
3706 * Set the data this intent is operating on. This method automatically
3707 * clears any type that was previously set by {@link #setType}.
3708 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003709 * <p><em>Note: scheme and host name matching in the Android framework is
3710 * case-sensitive, unlike the formal RFC. As a result,
3711 * you should always ensure that you write your Uri with these elements
3712 * using lower case letters, and normalize any Uris you receive from
3713 * outside of Android to ensure the scheme and host is lower case.</em></p>
3714 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003715 * @param data The URI of the data this intent is now targeting.
3716 *
3717 * @return Returns the same Intent object, for chaining multiple calls
3718 * into a single statement.
3719 *
3720 * @see #getData
3721 * @see #setType
3722 * @see #setDataAndType
3723 */
3724 public Intent setData(Uri data) {
3725 mData = data;
3726 mType = null;
3727 return this;
3728 }
3729
3730 /**
3731 * Set an explicit MIME data type. This is used to create intents that
3732 * only specify a type and not data, for example to indicate the type of
3733 * data to return. This method automatically clears any data that was
3734 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07003735 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003736 * <p><em>Note: MIME type matching in the Android framework is
3737 * case-sensitive, unlike formal RFC MIME types. As a result,
3738 * you should always write your MIME types with lower case letters,
3739 * and any MIME types you receive from outside of Android should be
3740 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003741 *
3742 * @param type The MIME type of the data being handled by this intent.
3743 *
3744 * @return Returns the same Intent object, for chaining multiple calls
3745 * into a single statement.
3746 *
3747 * @see #getType
3748 * @see #setData
3749 * @see #setDataAndType
3750 */
3751 public Intent setType(String type) {
3752 mData = null;
3753 mType = type;
3754 return this;
3755 }
3756
3757 /**
3758 * (Usually optional) Set the data for the intent along with an explicit
3759 * MIME data type. This method should very rarely be used -- it allows you
3760 * to override the MIME type that would ordinarily be inferred from the
3761 * data with your own type given here.
3762 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003763 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3764 * Android framework is case-sensitive, unlike the formal RFC definitions.
3765 * As a result, you should always write these elements with lower case letters,
3766 * and normalize any MIME types or Uris you receive from
3767 * outside of Android to ensure these elements are lower case before
3768 * supplying them here.</em></p>
3769 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003770 * @param data The URI of the data this intent is now targeting.
3771 * @param type The MIME type of the data being handled by this intent.
3772 *
3773 * @return Returns the same Intent object, for chaining multiple calls
3774 * into a single statement.
3775 *
3776 * @see #setData
3777 * @see #setType
3778 */
3779 public Intent setDataAndType(Uri data, String type) {
3780 mData = data;
3781 mType = type;
3782 return this;
3783 }
3784
3785 /**
3786 * Add a new category to the intent. Categories provide additional detail
3787 * about the action the intent is perform. When resolving an intent, only
3788 * activities that provide <em>all</em> of the requested categories will be
3789 * used.
3790 *
3791 * @param category The desired category. This can be either one of the
3792 * predefined Intent categories, or a custom category in your own
3793 * namespace.
3794 *
3795 * @return Returns the same Intent object, for chaining multiple calls
3796 * into a single statement.
3797 *
3798 * @see #hasCategory
3799 * @see #removeCategory
3800 */
3801 public Intent addCategory(String category) {
3802 if (mCategories == null) {
3803 mCategories = new HashSet<String>();
3804 }
3805 mCategories.add(category);
3806 return this;
3807 }
3808
3809 /**
3810 * Remove an category from an intent.
3811 *
3812 * @param category The category to remove.
3813 *
3814 * @see #addCategory
3815 */
3816 public void removeCategory(String category) {
3817 if (mCategories != null) {
3818 mCategories.remove(category);
3819 if (mCategories.size() == 0) {
3820 mCategories = null;
3821 }
3822 }
3823 }
3824
3825 /**
3826 * Add extended data to the intent. The name must include a package
3827 * prefix, for example the app com.android.contacts would use names
3828 * like "com.android.contacts.ShowAll".
3829 *
3830 * @param name The name of the extra data, with package prefix.
3831 * @param value The boolean data value.
3832 *
3833 * @return Returns the same Intent object, for chaining multiple calls
3834 * into a single statement.
3835 *
3836 * @see #putExtras
3837 * @see #removeExtra
3838 * @see #getBooleanExtra(String, boolean)
3839 */
3840 public Intent putExtra(String name, boolean value) {
3841 if (mExtras == null) {
3842 mExtras = new Bundle();
3843 }
3844 mExtras.putBoolean(name, value);
3845 return this;
3846 }
3847
3848 /**
3849 * Add extended data to the intent. The name must include a package
3850 * prefix, for example the app com.android.contacts would use names
3851 * like "com.android.contacts.ShowAll".
3852 *
3853 * @param name The name of the extra data, with package prefix.
3854 * @param value The byte data value.
3855 *
3856 * @return Returns the same Intent object, for chaining multiple calls
3857 * into a single statement.
3858 *
3859 * @see #putExtras
3860 * @see #removeExtra
3861 * @see #getByteExtra(String, byte)
3862 */
3863 public Intent putExtra(String name, byte value) {
3864 if (mExtras == null) {
3865 mExtras = new Bundle();
3866 }
3867 mExtras.putByte(name, value);
3868 return this;
3869 }
3870
3871 /**
3872 * Add extended data to the intent. The name must include a package
3873 * prefix, for example the app com.android.contacts would use names
3874 * like "com.android.contacts.ShowAll".
3875 *
3876 * @param name The name of the extra data, with package prefix.
3877 * @param value The char data value.
3878 *
3879 * @return Returns the same Intent object, for chaining multiple calls
3880 * into a single statement.
3881 *
3882 * @see #putExtras
3883 * @see #removeExtra
3884 * @see #getCharExtra(String, char)
3885 */
3886 public Intent putExtra(String name, char value) {
3887 if (mExtras == null) {
3888 mExtras = new Bundle();
3889 }
3890 mExtras.putChar(name, value);
3891 return this;
3892 }
3893
3894 /**
3895 * Add extended data to the intent. The name must include a package
3896 * prefix, for example the app com.android.contacts would use names
3897 * like "com.android.contacts.ShowAll".
3898 *
3899 * @param name The name of the extra data, with package prefix.
3900 * @param value The short data value.
3901 *
3902 * @return Returns the same Intent object, for chaining multiple calls
3903 * into a single statement.
3904 *
3905 * @see #putExtras
3906 * @see #removeExtra
3907 * @see #getShortExtra(String, short)
3908 */
3909 public Intent putExtra(String name, short value) {
3910 if (mExtras == null) {
3911 mExtras = new Bundle();
3912 }
3913 mExtras.putShort(name, value);
3914 return this;
3915 }
3916
3917 /**
3918 * Add extended data to the intent. The name must include a package
3919 * prefix, for example the app com.android.contacts would use names
3920 * like "com.android.contacts.ShowAll".
3921 *
3922 * @param name The name of the extra data, with package prefix.
3923 * @param value The integer data value.
3924 *
3925 * @return Returns the same Intent object, for chaining multiple calls
3926 * into a single statement.
3927 *
3928 * @see #putExtras
3929 * @see #removeExtra
3930 * @see #getIntExtra(String, int)
3931 */
3932 public Intent putExtra(String name, int value) {
3933 if (mExtras == null) {
3934 mExtras = new Bundle();
3935 }
3936 mExtras.putInt(name, value);
3937 return this;
3938 }
3939
3940 /**
3941 * Add extended data to the intent. The name must include a package
3942 * prefix, for example the app com.android.contacts would use names
3943 * like "com.android.contacts.ShowAll".
3944 *
3945 * @param name The name of the extra data, with package prefix.
3946 * @param value The long data value.
3947 *
3948 * @return Returns the same Intent object, for chaining multiple calls
3949 * into a single statement.
3950 *
3951 * @see #putExtras
3952 * @see #removeExtra
3953 * @see #getLongExtra(String, long)
3954 */
3955 public Intent putExtra(String name, long value) {
3956 if (mExtras == null) {
3957 mExtras = new Bundle();
3958 }
3959 mExtras.putLong(name, value);
3960 return this;
3961 }
3962
3963 /**
3964 * Add extended data to the intent. The name must include a package
3965 * prefix, for example the app com.android.contacts would use names
3966 * like "com.android.contacts.ShowAll".
3967 *
3968 * @param name The name of the extra data, with package prefix.
3969 * @param value The float data value.
3970 *
3971 * @return Returns the same Intent object, for chaining multiple calls
3972 * into a single statement.
3973 *
3974 * @see #putExtras
3975 * @see #removeExtra
3976 * @see #getFloatExtra(String, float)
3977 */
3978 public Intent putExtra(String name, float value) {
3979 if (mExtras == null) {
3980 mExtras = new Bundle();
3981 }
3982 mExtras.putFloat(name, value);
3983 return this;
3984 }
3985
3986 /**
3987 * Add extended data to the intent. The name must include a package
3988 * prefix, for example the app com.android.contacts would use names
3989 * like "com.android.contacts.ShowAll".
3990 *
3991 * @param name The name of the extra data, with package prefix.
3992 * @param value The double data value.
3993 *
3994 * @return Returns the same Intent object, for chaining multiple calls
3995 * into a single statement.
3996 *
3997 * @see #putExtras
3998 * @see #removeExtra
3999 * @see #getDoubleExtra(String, double)
4000 */
4001 public Intent putExtra(String name, double value) {
4002 if (mExtras == null) {
4003 mExtras = new Bundle();
4004 }
4005 mExtras.putDouble(name, value);
4006 return this;
4007 }
4008
4009 /**
4010 * Add extended data to the intent. The name must include a package
4011 * prefix, for example the app com.android.contacts would use names
4012 * like "com.android.contacts.ShowAll".
4013 *
4014 * @param name The name of the extra data, with package prefix.
4015 * @param value The String data value.
4016 *
4017 * @return Returns the same Intent object, for chaining multiple calls
4018 * into a single statement.
4019 *
4020 * @see #putExtras
4021 * @see #removeExtra
4022 * @see #getStringExtra(String)
4023 */
4024 public Intent putExtra(String name, String value) {
4025 if (mExtras == null) {
4026 mExtras = new Bundle();
4027 }
4028 mExtras.putString(name, value);
4029 return this;
4030 }
4031
4032 /**
4033 * Add extended data to the intent. The name must include a package
4034 * prefix, for example the app com.android.contacts would use names
4035 * like "com.android.contacts.ShowAll".
4036 *
4037 * @param name The name of the extra data, with package prefix.
4038 * @param value The CharSequence data value.
4039 *
4040 * @return Returns the same Intent object, for chaining multiple calls
4041 * into a single statement.
4042 *
4043 * @see #putExtras
4044 * @see #removeExtra
4045 * @see #getCharSequenceExtra(String)
4046 */
4047 public Intent putExtra(String name, CharSequence value) {
4048 if (mExtras == null) {
4049 mExtras = new Bundle();
4050 }
4051 mExtras.putCharSequence(name, value);
4052 return this;
4053 }
4054
4055 /**
4056 * Add extended data to the intent. The name must include a package
4057 * prefix, for example the app com.android.contacts would use names
4058 * like "com.android.contacts.ShowAll".
4059 *
4060 * @param name The name of the extra data, with package prefix.
4061 * @param value The Parcelable data value.
4062 *
4063 * @return Returns the same Intent object, for chaining multiple calls
4064 * into a single statement.
4065 *
4066 * @see #putExtras
4067 * @see #removeExtra
4068 * @see #getParcelableExtra(String)
4069 */
4070 public Intent putExtra(String name, Parcelable value) {
4071 if (mExtras == null) {
4072 mExtras = new Bundle();
4073 }
4074 mExtras.putParcelable(name, value);
4075 return this;
4076 }
4077
4078 /**
4079 * Add extended data to the intent. The name must include a package
4080 * prefix, for example the app com.android.contacts would use names
4081 * like "com.android.contacts.ShowAll".
4082 *
4083 * @param name The name of the extra data, with package prefix.
4084 * @param value The Parcelable[] data value.
4085 *
4086 * @return Returns the same Intent object, for chaining multiple calls
4087 * into a single statement.
4088 *
4089 * @see #putExtras
4090 * @see #removeExtra
4091 * @see #getParcelableArrayExtra(String)
4092 */
4093 public Intent putExtra(String name, Parcelable[] value) {
4094 if (mExtras == null) {
4095 mExtras = new Bundle();
4096 }
4097 mExtras.putParcelableArray(name, value);
4098 return this;
4099 }
4100
4101 /**
4102 * Add extended data to the intent. The name must include a package
4103 * prefix, for example the app com.android.contacts would use names
4104 * like "com.android.contacts.ShowAll".
4105 *
4106 * @param name The name of the extra data, with package prefix.
4107 * @param value The ArrayList<Parcelable> data value.
4108 *
4109 * @return Returns the same Intent object, for chaining multiple calls
4110 * into a single statement.
4111 *
4112 * @see #putExtras
4113 * @see #removeExtra
4114 * @see #getParcelableArrayListExtra(String)
4115 */
4116 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4117 if (mExtras == null) {
4118 mExtras = new Bundle();
4119 }
4120 mExtras.putParcelableArrayList(name, value);
4121 return this;
4122 }
4123
4124 /**
4125 * Add extended data to the intent. The name must include a package
4126 * prefix, for example the app com.android.contacts would use names
4127 * like "com.android.contacts.ShowAll".
4128 *
4129 * @param name The name of the extra data, with package prefix.
4130 * @param value The ArrayList<Integer> data value.
4131 *
4132 * @return Returns the same Intent object, for chaining multiple calls
4133 * into a single statement.
4134 *
4135 * @see #putExtras
4136 * @see #removeExtra
4137 * @see #getIntegerArrayListExtra(String)
4138 */
4139 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4140 if (mExtras == null) {
4141 mExtras = new Bundle();
4142 }
4143 mExtras.putIntegerArrayList(name, value);
4144 return this;
4145 }
4146
4147 /**
4148 * Add extended data to the intent. The name must include a package
4149 * prefix, for example the app com.android.contacts would use names
4150 * like "com.android.contacts.ShowAll".
4151 *
4152 * @param name The name of the extra data, with package prefix.
4153 * @param value The ArrayList<String> data value.
4154 *
4155 * @return Returns the same Intent object, for chaining multiple calls
4156 * into a single statement.
4157 *
4158 * @see #putExtras
4159 * @see #removeExtra
4160 * @see #getStringArrayListExtra(String)
4161 */
4162 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4163 if (mExtras == null) {
4164 mExtras = new Bundle();
4165 }
4166 mExtras.putStringArrayList(name, value);
4167 return this;
4168 }
4169
4170 /**
4171 * Add extended data to the intent. The name must include a package
4172 * prefix, for example the app com.android.contacts would use names
4173 * like "com.android.contacts.ShowAll".
4174 *
4175 * @param name The name of the extra data, with package prefix.
4176 * @param value The Serializable data value.
4177 *
4178 * @return Returns the same Intent object, for chaining multiple calls
4179 * into a single statement.
4180 *
4181 * @see #putExtras
4182 * @see #removeExtra
4183 * @see #getSerializableExtra(String)
4184 */
4185 public Intent putExtra(String name, Serializable value) {
4186 if (mExtras == null) {
4187 mExtras = new Bundle();
4188 }
4189 mExtras.putSerializable(name, value);
4190 return this;
4191 }
4192
4193 /**
4194 * Add extended data to the intent. The name must include a package
4195 * prefix, for example the app com.android.contacts would use names
4196 * like "com.android.contacts.ShowAll".
4197 *
4198 * @param name The name of the extra data, with package prefix.
4199 * @param value The boolean array data value.
4200 *
4201 * @return Returns the same Intent object, for chaining multiple calls
4202 * into a single statement.
4203 *
4204 * @see #putExtras
4205 * @see #removeExtra
4206 * @see #getBooleanArrayExtra(String)
4207 */
4208 public Intent putExtra(String name, boolean[] value) {
4209 if (mExtras == null) {
4210 mExtras = new Bundle();
4211 }
4212 mExtras.putBooleanArray(name, value);
4213 return this;
4214 }
4215
4216 /**
4217 * Add extended data to the intent. The name must include a package
4218 * prefix, for example the app com.android.contacts would use names
4219 * like "com.android.contacts.ShowAll".
4220 *
4221 * @param name The name of the extra data, with package prefix.
4222 * @param value The byte array data value.
4223 *
4224 * @return Returns the same Intent object, for chaining multiple calls
4225 * into a single statement.
4226 *
4227 * @see #putExtras
4228 * @see #removeExtra
4229 * @see #getByteArrayExtra(String)
4230 */
4231 public Intent putExtra(String name, byte[] value) {
4232 if (mExtras == null) {
4233 mExtras = new Bundle();
4234 }
4235 mExtras.putByteArray(name, value);
4236 return this;
4237 }
4238
4239 /**
4240 * Add extended data to the intent. The name must include a package
4241 * prefix, for example the app com.android.contacts would use names
4242 * like "com.android.contacts.ShowAll".
4243 *
4244 * @param name The name of the extra data, with package prefix.
4245 * @param value The short array data value.
4246 *
4247 * @return Returns the same Intent object, for chaining multiple calls
4248 * into a single statement.
4249 *
4250 * @see #putExtras
4251 * @see #removeExtra
4252 * @see #getShortArrayExtra(String)
4253 */
4254 public Intent putExtra(String name, short[] value) {
4255 if (mExtras == null) {
4256 mExtras = new Bundle();
4257 }
4258 mExtras.putShortArray(name, value);
4259 return this;
4260 }
4261
4262 /**
4263 * Add extended data to the intent. The name must include a package
4264 * prefix, for example the app com.android.contacts would use names
4265 * like "com.android.contacts.ShowAll".
4266 *
4267 * @param name The name of the extra data, with package prefix.
4268 * @param value The char array data value.
4269 *
4270 * @return Returns the same Intent object, for chaining multiple calls
4271 * into a single statement.
4272 *
4273 * @see #putExtras
4274 * @see #removeExtra
4275 * @see #getCharArrayExtra(String)
4276 */
4277 public Intent putExtra(String name, char[] value) {
4278 if (mExtras == null) {
4279 mExtras = new Bundle();
4280 }
4281 mExtras.putCharArray(name, value);
4282 return this;
4283 }
4284
4285 /**
4286 * Add extended data to the intent. The name must include a package
4287 * prefix, for example the app com.android.contacts would use names
4288 * like "com.android.contacts.ShowAll".
4289 *
4290 * @param name The name of the extra data, with package prefix.
4291 * @param value The int array data value.
4292 *
4293 * @return Returns the same Intent object, for chaining multiple calls
4294 * into a single statement.
4295 *
4296 * @see #putExtras
4297 * @see #removeExtra
4298 * @see #getIntArrayExtra(String)
4299 */
4300 public Intent putExtra(String name, int[] value) {
4301 if (mExtras == null) {
4302 mExtras = new Bundle();
4303 }
4304 mExtras.putIntArray(name, value);
4305 return this;
4306 }
4307
4308 /**
4309 * Add extended data to the intent. The name must include a package
4310 * prefix, for example the app com.android.contacts would use names
4311 * like "com.android.contacts.ShowAll".
4312 *
4313 * @param name The name of the extra data, with package prefix.
4314 * @param value The byte array data value.
4315 *
4316 * @return Returns the same Intent object, for chaining multiple calls
4317 * into a single statement.
4318 *
4319 * @see #putExtras
4320 * @see #removeExtra
4321 * @see #getLongArrayExtra(String)
4322 */
4323 public Intent putExtra(String name, long[] value) {
4324 if (mExtras == null) {
4325 mExtras = new Bundle();
4326 }
4327 mExtras.putLongArray(name, value);
4328 return this;
4329 }
4330
4331 /**
4332 * Add extended data to the intent. The name must include a package
4333 * prefix, for example the app com.android.contacts would use names
4334 * like "com.android.contacts.ShowAll".
4335 *
4336 * @param name The name of the extra data, with package prefix.
4337 * @param value The float array data value.
4338 *
4339 * @return Returns the same Intent object, for chaining multiple calls
4340 * into a single statement.
4341 *
4342 * @see #putExtras
4343 * @see #removeExtra
4344 * @see #getFloatArrayExtra(String)
4345 */
4346 public Intent putExtra(String name, float[] value) {
4347 if (mExtras == null) {
4348 mExtras = new Bundle();
4349 }
4350 mExtras.putFloatArray(name, value);
4351 return this;
4352 }
4353
4354 /**
4355 * Add extended data to the intent. The name must include a package
4356 * prefix, for example the app com.android.contacts would use names
4357 * like "com.android.contacts.ShowAll".
4358 *
4359 * @param name The name of the extra data, with package prefix.
4360 * @param value The double array data value.
4361 *
4362 * @return Returns the same Intent object, for chaining multiple calls
4363 * into a single statement.
4364 *
4365 * @see #putExtras
4366 * @see #removeExtra
4367 * @see #getDoubleArrayExtra(String)
4368 */
4369 public Intent putExtra(String name, double[] value) {
4370 if (mExtras == null) {
4371 mExtras = new Bundle();
4372 }
4373 mExtras.putDoubleArray(name, value);
4374 return this;
4375 }
4376
4377 /**
4378 * Add extended data to the intent. The name must include a package
4379 * prefix, for example the app com.android.contacts would use names
4380 * like "com.android.contacts.ShowAll".
4381 *
4382 * @param name The name of the extra data, with package prefix.
4383 * @param value The String array data value.
4384 *
4385 * @return Returns the same Intent object, for chaining multiple calls
4386 * into a single statement.
4387 *
4388 * @see #putExtras
4389 * @see #removeExtra
4390 * @see #getStringArrayExtra(String)
4391 */
4392 public Intent putExtra(String name, String[] value) {
4393 if (mExtras == null) {
4394 mExtras = new Bundle();
4395 }
4396 mExtras.putStringArray(name, value);
4397 return this;
4398 }
4399
4400 /**
4401 * Add extended data to the intent. The name must include a package
4402 * prefix, for example the app com.android.contacts would use names
4403 * like "com.android.contacts.ShowAll".
4404 *
4405 * @param name The name of the extra data, with package prefix.
4406 * @param value The Bundle data value.
4407 *
4408 * @return Returns the same Intent object, for chaining multiple calls
4409 * into a single statement.
4410 *
4411 * @see #putExtras
4412 * @see #removeExtra
4413 * @see #getBundleExtra(String)
4414 */
4415 public Intent putExtra(String name, Bundle value) {
4416 if (mExtras == null) {
4417 mExtras = new Bundle();
4418 }
4419 mExtras.putBundle(name, value);
4420 return this;
4421 }
4422
4423 /**
4424 * Add extended data to the intent. The name must include a package
4425 * prefix, for example the app com.android.contacts would use names
4426 * like "com.android.contacts.ShowAll".
4427 *
4428 * @param name The name of the extra data, with package prefix.
4429 * @param value The IBinder data value.
4430 *
4431 * @return Returns the same Intent object, for chaining multiple calls
4432 * into a single statement.
4433 *
4434 * @see #putExtras
4435 * @see #removeExtra
4436 * @see #getIBinderExtra(String)
4437 *
4438 * @deprecated
4439 * @hide
4440 */
4441 @Deprecated
4442 public Intent putExtra(String name, IBinder value) {
4443 if (mExtras == null) {
4444 mExtras = new Bundle();
4445 }
4446 mExtras.putIBinder(name, value);
4447 return this;
4448 }
4449
4450 /**
4451 * Copy all extras in 'src' in to this intent.
4452 *
4453 * @param src Contains the extras to copy.
4454 *
4455 * @see #putExtra
4456 */
4457 public Intent putExtras(Intent src) {
4458 if (src.mExtras != null) {
4459 if (mExtras == null) {
4460 mExtras = new Bundle(src.mExtras);
4461 } else {
4462 mExtras.putAll(src.mExtras);
4463 }
4464 }
4465 return this;
4466 }
4467
4468 /**
4469 * Add a set of extended data to the intent. The keys must include a package
4470 * prefix, for example the app com.android.contacts would use names
4471 * like "com.android.contacts.ShowAll".
4472 *
4473 * @param extras The Bundle of extras to add to this intent.
4474 *
4475 * @see #putExtra
4476 * @see #removeExtra
4477 */
4478 public Intent putExtras(Bundle extras) {
4479 if (mExtras == null) {
4480 mExtras = new Bundle();
4481 }
4482 mExtras.putAll(extras);
4483 return this;
4484 }
4485
4486 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004487 * Completely replace the extras in the Intent with the extras in the
4488 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004489 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004490 * @param src The exact extras contained in this Intent are copied
4491 * into the target intent, replacing any that were previously there.
4492 */
4493 public Intent replaceExtras(Intent src) {
4494 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4495 return this;
4496 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004497
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004498 /**
4499 * Completely replace the extras in the Intent with the given Bundle of
4500 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004501 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004502 * @param extras The new set of extras in the Intent, or null to erase
4503 * all extras.
4504 */
4505 public Intent replaceExtras(Bundle extras) {
4506 mExtras = extras != null ? new Bundle(extras) : null;
4507 return this;
4508 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004509
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004510 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004511 * Remove extended data from the intent.
4512 *
4513 * @see #putExtra
4514 */
4515 public void removeExtra(String name) {
4516 if (mExtras != null) {
4517 mExtras.remove(name);
4518 if (mExtras.size() == 0) {
4519 mExtras = null;
4520 }
4521 }
4522 }
4523
4524 /**
4525 * Set special flags controlling how this intent is handled. Most values
4526 * here depend on the type of component being executed by the Intent,
4527 * specifically the FLAG_ACTIVITY_* flags are all for use with
4528 * {@link Context#startActivity Context.startActivity()} and the
4529 * FLAG_RECEIVER_* flags are all for use with
4530 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4531 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004532 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4533 * Activities and Tasks</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004534 * the behavior of your application.
4535 *
4536 * @param flags The desired flags.
4537 *
4538 * @return Returns the same Intent object, for chaining multiple calls
4539 * into a single statement.
4540 *
4541 * @see #getFlags
4542 * @see #addFlags
4543 *
4544 * @see #FLAG_GRANT_READ_URI_PERMISSION
4545 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4546 * @see #FLAG_DEBUG_LOG_RESOLUTION
4547 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004548 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004549 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004550 * @see #FLAG_ACTIVITY_CLEAR_TOP
4551 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4552 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004553 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004554 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4555 * @see #FLAG_ACTIVITY_NEW_TASK
4556 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004557 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004558 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4559 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004560 * @see #FLAG_ACTIVITY_SINGLE_TOP
4561 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4562 */
4563 public Intent setFlags(int flags) {
4564 mFlags = flags;
4565 return this;
4566 }
4567
4568 /**
4569 * Add additional flags to the intent (or with existing flags
4570 * value).
4571 *
4572 * @param flags The new flags to set.
4573 *
4574 * @return Returns the same Intent object, for chaining multiple calls
4575 * into a single statement.
4576 *
4577 * @see #setFlags
4578 */
4579 public Intent addFlags(int flags) {
4580 mFlags |= flags;
4581 return this;
4582 }
4583
4584 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004585 * (Usually optional) Set an explicit application package name that limits
4586 * the components this Intent will resolve to. If left to the default
4587 * value of null, all components in all applications will considered.
4588 * If non-null, the Intent can only match the components in the given
4589 * application package.
4590 *
4591 * @param packageName The name of the application package to handle the
4592 * intent, or null to allow any application package.
4593 *
4594 * @return Returns the same Intent object, for chaining multiple calls
4595 * into a single statement.
4596 *
4597 * @see #getPackage
4598 * @see #resolveActivity
4599 */
4600 public Intent setPackage(String packageName) {
4601 mPackage = packageName;
4602 return this;
4603 }
4604
4605 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004606 * (Usually optional) Explicitly set the component to handle the intent.
4607 * If left with the default value of null, the system will determine the
4608 * appropriate class to use based on the other fields (action, data,
4609 * type, categories) in the Intent. If this class is defined, the
4610 * specified class will always be used regardless of the other fields. You
4611 * should only set this value when you know you absolutely want a specific
4612 * class to be used; otherwise it is better to let the system find the
4613 * appropriate class so that you will respect the installed applications
4614 * and user preferences.
4615 *
4616 * @param component The name of the application component to handle the
4617 * intent, or null to let the system find one for you.
4618 *
4619 * @return Returns the same Intent object, for chaining multiple calls
4620 * into a single statement.
4621 *
4622 * @see #setClass
4623 * @see #setClassName(Context, String)
4624 * @see #setClassName(String, String)
4625 * @see #getComponent
4626 * @see #resolveActivity
4627 */
4628 public Intent setComponent(ComponentName component) {
4629 mComponent = component;
4630 return this;
4631 }
4632
4633 /**
4634 * Convenience for calling {@link #setComponent} with an
4635 * explicit class name.
4636 *
4637 * @param packageContext A Context of the application package implementing
4638 * this class.
4639 * @param className The name of a class inside of the application package
4640 * that will be used as the component for this Intent.
4641 *
4642 * @return Returns the same Intent object, for chaining multiple calls
4643 * into a single statement.
4644 *
4645 * @see #setComponent
4646 * @see #setClass
4647 */
4648 public Intent setClassName(Context packageContext, String className) {
4649 mComponent = new ComponentName(packageContext, className);
4650 return this;
4651 }
4652
4653 /**
4654 * Convenience for calling {@link #setComponent} with an
4655 * explicit application package name and class name.
4656 *
4657 * @param packageName The name of the package implementing the desired
4658 * component.
4659 * @param className The name of a class inside of the application package
4660 * that will be used as the component for this Intent.
4661 *
4662 * @return Returns the same Intent object, for chaining multiple calls
4663 * into a single statement.
4664 *
4665 * @see #setComponent
4666 * @see #setClass
4667 */
4668 public Intent setClassName(String packageName, String className) {
4669 mComponent = new ComponentName(packageName, className);
4670 return this;
4671 }
4672
4673 /**
4674 * Convenience for calling {@link #setComponent(ComponentName)} with the
4675 * name returned by a {@link Class} object.
4676 *
4677 * @param packageContext A Context of the application package implementing
4678 * this class.
4679 * @param cls The class name to set, equivalent to
4680 * <code>setClassName(context, cls.getName())</code>.
4681 *
4682 * @return Returns the same Intent object, for chaining multiple calls
4683 * into a single statement.
4684 *
4685 * @see #setComponent
4686 */
4687 public Intent setClass(Context packageContext, Class<?> cls) {
4688 mComponent = new ComponentName(packageContext, cls);
4689 return this;
4690 }
4691
4692 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004693 * Set the bounds of the sender of this intent, in screen coordinates. This can be
4694 * used as a hint to the receiver for animations and the like. Null means that there
4695 * is no source bounds.
4696 */
4697 public void setSourceBounds(Rect r) {
4698 if (r != null) {
4699 mSourceBounds = new Rect(r);
4700 } else {
4701 r = null;
4702 }
4703 }
4704
4705 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004706 * Use with {@link #fillIn} to allow the current action value to be
4707 * overwritten, even if it is already set.
4708 */
4709 public static final int FILL_IN_ACTION = 1<<0;
4710
4711 /**
4712 * Use with {@link #fillIn} to allow the current data or type value
4713 * overwritten, even if it is already set.
4714 */
4715 public static final int FILL_IN_DATA = 1<<1;
4716
4717 /**
4718 * Use with {@link #fillIn} to allow the current categories to be
4719 * overwritten, even if they are already set.
4720 */
4721 public static final int FILL_IN_CATEGORIES = 1<<2;
4722
4723 /**
4724 * Use with {@link #fillIn} to allow the current component value to be
4725 * overwritten, even if it is already set.
4726 */
4727 public static final int FILL_IN_COMPONENT = 1<<3;
4728
4729 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004730 * Use with {@link #fillIn} to allow the current package value to be
4731 * overwritten, even if it is already set.
4732 */
4733 public static final int FILL_IN_PACKAGE = 1<<4;
4734
4735 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004736 * Use with {@link #fillIn} to allow the current package value to be
4737 * overwritten, even if it is already set.
4738 */
4739 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
4740
4741 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004742 * Copy the contents of <var>other</var> in to this object, but only
4743 * where fields are not defined by this object. For purposes of a field
4744 * being defined, the following pieces of data in the Intent are
4745 * considered to be separate fields:
4746 *
4747 * <ul>
4748 * <li> action, as set by {@link #setAction}.
4749 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4750 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4751 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004752 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004753 * <li> component, as set by {@link #setComponent(ComponentName)} or
4754 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004755 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004756 * <li> each top-level name in the associated extras.
4757 * </ul>
4758 *
4759 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004760 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4761 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004762 * corresponding field will not be replaced if it is already set.
4763 *
Brett Chabot3e391752009-07-21 16:07:23 -07004764 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
4765 * specified.
4766 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004767 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4768 * and Intent B with {action="gotit", data-type="some/thing",
4769 * categories="one","two"}.
4770 *
4771 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4772 * containing: {action="gotit", data-type="some/thing",
4773 * categories="bar"}.
4774 *
4775 * @param other Another Intent whose values are to be used to fill in
4776 * the current one.
4777 * @param flags Options to control which fields can be filled in.
4778 *
4779 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004780 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4781 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004782 */
4783 public int fillIn(Intent other, int flags) {
4784 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004785 if (other.mAction != null
4786 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004787 mAction = other.mAction;
4788 changes |= FILL_IN_ACTION;
4789 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004790 if ((other.mData != null || other.mType != null)
4791 && ((mData == null && mType == null)
4792 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004793 mData = other.mData;
4794 mType = other.mType;
4795 changes |= FILL_IN_DATA;
4796 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004797 if (other.mCategories != null
4798 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004799 if (other.mCategories != null) {
4800 mCategories = new HashSet<String>(other.mCategories);
4801 }
4802 changes |= FILL_IN_CATEGORIES;
4803 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004804 if (other.mPackage != null
4805 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
4806 mPackage = other.mPackage;
4807 changes |= FILL_IN_PACKAGE;
4808 }
4809 // Component is special: it can -only- be set if explicitly allowed,
4810 // since otherwise the sender could force the intent somewhere the
4811 // originator didn't intend.
4812 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004813 mComponent = other.mComponent;
4814 changes |= FILL_IN_COMPONENT;
4815 }
4816 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004817 if (other.mSourceBounds != null
4818 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
4819 mSourceBounds = new Rect(other.mSourceBounds);
4820 changes |= FILL_IN_SOURCE_BOUNDS;
4821 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004822 if (mExtras == null) {
4823 if (other.mExtras != null) {
4824 mExtras = new Bundle(other.mExtras);
4825 }
4826 } else if (other.mExtras != null) {
4827 try {
4828 Bundle newb = new Bundle(other.mExtras);
4829 newb.putAll(mExtras);
4830 mExtras = newb;
4831 } catch (RuntimeException e) {
4832 // Modifying the extras can cause us to unparcel the contents
4833 // of the bundle, and if we do this in the system process that
4834 // may fail. We really should handle this (i.e., the Bundle
4835 // impl shouldn't be on top of a plain map), but for now just
4836 // ignore it and keep the original contents. :(
4837 Log.w("Intent", "Failure filling in extras", e);
4838 }
4839 }
4840 return changes;
4841 }
4842
4843 /**
4844 * Wrapper class holding an Intent and implementing comparisons on it for
4845 * the purpose of filtering. The class implements its
4846 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4847 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4848 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4849 * on the wrapped Intent.
4850 */
4851 public static final class FilterComparison {
4852 private final Intent mIntent;
4853 private final int mHashCode;
4854
4855 public FilterComparison(Intent intent) {
4856 mIntent = intent;
4857 mHashCode = intent.filterHashCode();
4858 }
4859
4860 /**
4861 * Return the Intent that this FilterComparison represents.
4862 * @return Returns the Intent held by the FilterComparison. Do
4863 * not modify!
4864 */
4865 public Intent getIntent() {
4866 return mIntent;
4867 }
4868
4869 @Override
4870 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004871 if (obj instanceof FilterComparison) {
4872 Intent other = ((FilterComparison)obj).mIntent;
4873 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004874 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004875 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004876 }
4877
4878 @Override
4879 public int hashCode() {
4880 return mHashCode;
4881 }
4882 }
4883
4884 /**
4885 * Determine if two intents are the same for the purposes of intent
4886 * resolution (filtering). That is, if their action, data, type,
4887 * class, and categories are the same. This does <em>not</em> compare
4888 * any extra data included in the intents.
4889 *
4890 * @param other The other Intent to compare against.
4891 *
4892 * @return Returns true if action, data, type, class, and categories
4893 * are the same.
4894 */
4895 public boolean filterEquals(Intent other) {
4896 if (other == null) {
4897 return false;
4898 }
4899 if (mAction != other.mAction) {
4900 if (mAction != null) {
4901 if (!mAction.equals(other.mAction)) {
4902 return false;
4903 }
4904 } else {
4905 if (!other.mAction.equals(mAction)) {
4906 return false;
4907 }
4908 }
4909 }
4910 if (mData != other.mData) {
4911 if (mData != null) {
4912 if (!mData.equals(other.mData)) {
4913 return false;
4914 }
4915 } else {
4916 if (!other.mData.equals(mData)) {
4917 return false;
4918 }
4919 }
4920 }
4921 if (mType != other.mType) {
4922 if (mType != null) {
4923 if (!mType.equals(other.mType)) {
4924 return false;
4925 }
4926 } else {
4927 if (!other.mType.equals(mType)) {
4928 return false;
4929 }
4930 }
4931 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004932 if (mPackage != other.mPackage) {
4933 if (mPackage != null) {
4934 if (!mPackage.equals(other.mPackage)) {
4935 return false;
4936 }
4937 } else {
4938 if (!other.mPackage.equals(mPackage)) {
4939 return false;
4940 }
4941 }
4942 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004943 if (mComponent != other.mComponent) {
4944 if (mComponent != null) {
4945 if (!mComponent.equals(other.mComponent)) {
4946 return false;
4947 }
4948 } else {
4949 if (!other.mComponent.equals(mComponent)) {
4950 return false;
4951 }
4952 }
4953 }
4954 if (mCategories != other.mCategories) {
4955 if (mCategories != null) {
4956 if (!mCategories.equals(other.mCategories)) {
4957 return false;
4958 }
4959 } else {
4960 if (!other.mCategories.equals(mCategories)) {
4961 return false;
4962 }
4963 }
4964 }
4965
4966 return true;
4967 }
4968
4969 /**
4970 * Generate hash code that matches semantics of filterEquals().
4971 *
4972 * @return Returns the hash value of the action, data, type, class, and
4973 * categories.
4974 *
4975 * @see #filterEquals
4976 */
4977 public int filterHashCode() {
4978 int code = 0;
4979 if (mAction != null) {
4980 code += mAction.hashCode();
4981 }
4982 if (mData != null) {
4983 code += mData.hashCode();
4984 }
4985 if (mType != null) {
4986 code += mType.hashCode();
4987 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004988 if (mPackage != null) {
4989 code += mPackage.hashCode();
4990 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004991 if (mComponent != null) {
4992 code += mComponent.hashCode();
4993 }
4994 if (mCategories != null) {
4995 code += mCategories.hashCode();
4996 }
4997 return code;
4998 }
4999
5000 @Override
5001 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005002 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005003
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005004 b.append("Intent { ");
5005 toShortString(b, true, true);
5006 b.append(" }");
5007
5008 return b.toString();
5009 }
5010
5011 /** @hide */
5012 public String toShortString(boolean comp, boolean extras) {
5013 StringBuilder b = new StringBuilder(128);
5014 toShortString(b, comp, extras);
5015 return b.toString();
5016 }
Romain Guy4969af72009-06-17 10:53:19 -07005017
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005018 /** @hide */
5019 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
5020 boolean first = true;
5021 if (mAction != null) {
5022 b.append("act=").append(mAction);
5023 first = false;
5024 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005025 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005026 if (!first) {
5027 b.append(' ');
5028 }
5029 first = false;
5030 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005031 Iterator<String> i = mCategories.iterator();
5032 boolean didone = false;
5033 while (i.hasNext()) {
5034 if (didone) b.append(",");
5035 didone = true;
5036 b.append(i.next());
5037 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005038 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005039 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005040 if (mData != null) {
5041 if (!first) {
5042 b.append(' ');
5043 }
5044 first = false;
5045 b.append("dat=").append(mData);
5046 }
5047 if (mType != null) {
5048 if (!first) {
5049 b.append(' ');
5050 }
5051 first = false;
5052 b.append("typ=").append(mType);
5053 }
5054 if (mFlags != 0) {
5055 if (!first) {
5056 b.append(' ');
5057 }
5058 first = false;
5059 b.append("flg=0x").append(Integer.toHexString(mFlags));
5060 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005061 if (mPackage != null) {
5062 if (!first) {
5063 b.append(' ');
5064 }
5065 first = false;
5066 b.append("pkg=").append(mPackage);
5067 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005068 if (comp && mComponent != null) {
5069 if (!first) {
5070 b.append(' ');
5071 }
5072 first = false;
5073 b.append("cmp=").append(mComponent.flattenToShortString());
5074 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005075 if (mSourceBounds != null) {
5076 if (!first) {
5077 b.append(' ');
5078 }
5079 first = false;
5080 b.append("bnds=").append(mSourceBounds.toShortString());
5081 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005082 if (extras && mExtras != null) {
5083 if (!first) {
5084 b.append(' ');
5085 }
5086 first = false;
5087 b.append("(has extras)");
5088 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005089 }
5090
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005091 /**
5092 * Call {@link #toUri} with 0 flags.
5093 * @deprecated Use {@link #toUri} instead.
5094 */
5095 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005096 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005097 return toUri(0);
5098 }
5099
5100 /**
5101 * Convert this Intent into a String holding a URI representation of it.
5102 * The returned URI string has been properly URI encoded, so it can be
5103 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5104 * Intent's data as the base URI, with an additional fragment describing
5105 * the action, categories, type, flags, package, component, and extras.
5106 *
5107 * <p>You can convert the returned string back to an Intent with
5108 * {@link #getIntent}.
5109 *
5110 * @param flags Additional operating flags. Either 0 or
5111 * {@link #URI_INTENT_SCHEME}.
5112 *
5113 * @return Returns a URI encoding URI string describing the entire contents
5114 * of the Intent.
5115 */
5116 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005117 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005118 String scheme = null;
5119 if (mData != null) {
5120 String data = mData.toString();
5121 if ((flags&URI_INTENT_SCHEME) != 0) {
5122 final int N = data.length();
5123 for (int i=0; i<N; i++) {
5124 char c = data.charAt(i);
5125 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5126 || c == '.' || c == '-') {
5127 continue;
5128 }
5129 if (c == ':' && i > 0) {
5130 // Valid scheme.
5131 scheme = data.substring(0, i);
5132 uri.append("intent:");
5133 data = data.substring(i+1);
5134 break;
5135 }
5136
5137 // No scheme.
5138 break;
5139 }
5140 }
5141 uri.append(data);
5142
5143 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5144 uri.append("intent:");
5145 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005146
5147 uri.append("#Intent;");
5148
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005149 if (scheme != null) {
5150 uri.append("scheme=").append(scheme).append(';');
5151 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005152 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005153 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005154 }
5155 if (mCategories != null) {
5156 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005157 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005158 }
5159 }
5160 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005161 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005162 }
5163 if (mFlags != 0) {
5164 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5165 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005166 if (mPackage != null) {
5167 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5168 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005169 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005170 uri.append("component=").append(Uri.encode(
5171 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005172 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005173 if (mSourceBounds != null) {
5174 uri.append("sourceBounds=")
5175 .append(Uri.encode(mSourceBounds.flattenToString()))
5176 .append(';');
5177 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005178 if (mExtras != null) {
5179 for (String key : mExtras.keySet()) {
5180 final Object value = mExtras.get(key);
5181 char entryType =
5182 value instanceof String ? 'S' :
5183 value instanceof Boolean ? 'B' :
5184 value instanceof Byte ? 'b' :
5185 value instanceof Character ? 'c' :
5186 value instanceof Double ? 'd' :
5187 value instanceof Float ? 'f' :
5188 value instanceof Integer ? 'i' :
5189 value instanceof Long ? 'l' :
5190 value instanceof Short ? 's' :
5191 '\0';
5192
5193 if (entryType != '\0') {
5194 uri.append(entryType);
5195 uri.append('.');
5196 uri.append(Uri.encode(key));
5197 uri.append('=');
5198 uri.append(Uri.encode(value.toString()));
5199 uri.append(';');
5200 }
5201 }
5202 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005203
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005204 uri.append("end");
5205
5206 return uri.toString();
5207 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005208
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005209 public int describeContents() {
5210 return (mExtras != null) ? mExtras.describeContents() : 0;
5211 }
5212
5213 public void writeToParcel(Parcel out, int flags) {
5214 out.writeString(mAction);
5215 Uri.writeToParcel(out, mData);
5216 out.writeString(mType);
5217 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005218 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005219 ComponentName.writeToParcel(mComponent, out);
5220
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005221 if (mSourceBounds != null) {
5222 out.writeInt(1);
5223 mSourceBounds.writeToParcel(out, flags);
5224 } else {
5225 out.writeInt(0);
5226 }
5227
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005228 if (mCategories != null) {
5229 out.writeInt(mCategories.size());
5230 for (String category : mCategories) {
5231 out.writeString(category);
5232 }
5233 } else {
5234 out.writeInt(0);
5235 }
5236
5237 out.writeBundle(mExtras);
5238 }
5239
5240 public static final Parcelable.Creator<Intent> CREATOR
5241 = new Parcelable.Creator<Intent>() {
5242 public Intent createFromParcel(Parcel in) {
5243 return new Intent(in);
5244 }
5245 public Intent[] newArray(int size) {
5246 return new Intent[size];
5247 }
5248 };
5249
Dianne Hackborneb034652009-09-07 00:49:58 -07005250 /** @hide */
5251 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005252 readFromParcel(in);
5253 }
5254
5255 public void readFromParcel(Parcel in) {
5256 mAction = in.readString();
5257 mData = Uri.CREATOR.createFromParcel(in);
5258 mType = in.readString();
5259 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005260 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005261 mComponent = ComponentName.readFromParcel(in);
5262
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005263 if (in.readInt() != 0) {
5264 mSourceBounds = Rect.CREATOR.createFromParcel(in);
5265 }
5266
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005267 int N = in.readInt();
5268 if (N > 0) {
5269 mCategories = new HashSet<String>();
5270 int i;
5271 for (i=0; i<N; i++) {
5272 mCategories.add(in.readString());
5273 }
5274 } else {
5275 mCategories = null;
5276 }
5277
5278 mExtras = in.readBundle();
5279 }
5280
5281 /**
5282 * Parses the "intent" element (and its children) from XML and instantiates
5283 * an Intent object. The given XML parser should be located at the tag
5284 * where parsing should start (often named "intent"), from which the
5285 * basic action, data, type, and package and class name will be
5286 * retrieved. The function will then parse in to any child elements,
5287 * looking for <category android:name="xxx"> tags to add categories and
5288 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5289 * to the intent.
5290 *
5291 * @param resources The Resources to use when inflating resources.
5292 * @param parser The XML parser pointing at an "intent" tag.
5293 * @param attrs The AttributeSet interface for retrieving extended
5294 * attribute data at the current <var>parser</var> location.
5295 * @return An Intent object matching the XML data.
5296 * @throws XmlPullParserException If there was an XML parsing error.
5297 * @throws IOException If there was an I/O error.
5298 */
5299 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5300 throws XmlPullParserException, IOException {
5301 Intent intent = new Intent();
5302
5303 TypedArray sa = resources.obtainAttributes(attrs,
5304 com.android.internal.R.styleable.Intent);
5305
5306 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5307
5308 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5309 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5310 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5311
5312 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5313 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5314 if (packageName != null && className != null) {
5315 intent.setComponent(new ComponentName(packageName, className));
5316 }
5317
5318 sa.recycle();
5319
5320 int outerDepth = parser.getDepth();
5321 int type;
5322 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5323 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5324 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5325 continue;
5326 }
5327
5328 String nodeName = parser.getName();
5329 if (nodeName.equals("category")) {
5330 sa = resources.obtainAttributes(attrs,
5331 com.android.internal.R.styleable.IntentCategory);
5332 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5333 sa.recycle();
5334
5335 if (cat != null) {
5336 intent.addCategory(cat);
5337 }
5338 XmlUtils.skipCurrentTag(parser);
5339
5340 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005341 if (intent.mExtras == null) {
5342 intent.mExtras = new Bundle();
5343 }
5344 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5345 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005346
5347 } else {
5348 XmlUtils.skipCurrentTag(parser);
5349 }
5350 }
5351
5352 return intent;
5353 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005354}