blob: 4b6333e3b7e171918415f3de8e9f2911f5632dff [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
46import java.util.Set;
47
48/**
49 * An intent is an abstract description of an operation to be performed. It
50 * can be used with {@link Context#startActivity(Intent) startActivity} to
51 * launch an {@link android.app.Activity},
52 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
53 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
54 * and {@link android.content.Context#startService} or
55 * {@link android.content.Context#bindService} to communicate with a
56 * background {@link android.app.Service}.
57 *
58 * <p>An Intent provides a facility for performing late runtime binding between
59 * the code in different applications. Its most significant use is in the
60 * launching of activities, where it can be thought of as the glue between
61 * activities. It is
62 * basically a passive data structure holding an abstract description of an
63 * action to be performed. The primary pieces of information in an intent
64 * are:</p>
65 *
66 * <ul>
67 * <li> <p><b>action</b> -- The general action to be performed, such as
68 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
69 * etc.</p>
70 * </li>
71 * <li> <p><b>data</b> -- The data to operate on, such as a person record
72 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
73 * </li>
74 * </ul>
75 *
76 *
77 * <p>Some examples of action/data pairs are:</p>
78 *
79 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070080 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070081 * information about the person whose identifier is "1".</p>
82 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070083 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070084 * the phone dialer with the person filled in.</p>
85 * </li>
86 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
87 * the phone dialer with the given number filled in. Note how the
88 * VIEW action does what what is considered the most reasonable thing for
89 * a particular URI.</p>
90 * </li>
91 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
92 * the phone dialer with the given number filled in.</p>
93 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070094 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 * information about the person whose identifier is "1".</p>
96 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070097 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070098 * a list of people, which the user can browse through. This example is a
99 * typical top-level entry into the Contacts application, showing you the
100 * list of people. Selecting a particular person to view would result in a
101 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
102 * being used to start an activity to display that person.</p>
103 * </li>
104 * </ul>
105 *
106 * <p>In addition to these primary attributes, there are a number of secondary
107 * attributes that you can also include with an intent:</p>
108 *
109 * <ul>
110 * <li> <p><b>category</b> -- Gives additional information about the action
111 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
112 * appear in the Launcher as a top-level application, while
113 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
114 * of alternative actions the user can perform on a piece of data.</p>
115 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
116 * intent data. Normally the type is inferred from the data itself.
117 * By setting this attribute, you disable that evaluation and force
118 * an explicit type.</p>
119 * <li> <p><b>component</b> -- Specifies an explicit name of a component
120 * class to use for the intent. Normally this is determined by looking
121 * at the other information in the intent (the action, data/type, and
122 * categories) and matching that with a component that can handle it.
123 * If this attribute is set then none of the evaluation is performed,
124 * and this component is used exactly as is. By specifying this attribute,
125 * all of the other Intent attributes become optional.</p>
126 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
127 * This can be used to provide extended information to the component.
128 * For example, if we have a action to send an e-mail message, we could
129 * also include extra pieces of data here to supply a subject, body,
130 * etc.</p>
131 * </ul>
132 *
133 * <p>Here are some examples of other operations you can specify as intents
134 * using these additional parameters:</p>
135 *
136 * <ul>
137 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
138 * Launch the home screen.</p>
139 * </li>
140 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
141 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
142 * vnd.android.cursor.item/phone}</i></b>
143 * -- Display the list of people's phone numbers, allowing the user to
144 * browse through them and pick one and return it to the parent activity.</p>
145 * </li>
146 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
147 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
148 * -- Display all pickers for data that can be opened with
149 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
150 * allowing the user to pick one of them and then some data inside of it
151 * and returning the resulting URI to the caller. This can be used,
152 * for example, in an e-mail application to allow the user to pick some
153 * data to include as an attachment.</p>
154 * </li>
155 * </ul>
156 *
157 * <p>There are a variety of standard Intent action and category constants
158 * defined in the Intent class, but applications can also define their own.
159 * These strings use java style scoping, to ensure they are unique -- for
160 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700161 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700162 *
163 * <p>Put together, the set of actions, data types, categories, and extra data
164 * defines a language for the system allowing for the expression of phrases
165 * such as "call john smith's cell". As applications are added to the system,
166 * they can extend this language by adding new actions, types, and categories, or
167 * they can modify the behavior of existing phrases by supplying their own
168 * activities that handle them.</p>
169 *
170 * <a name="IntentResolution"></a>
171 * <h3>Intent Resolution</h3>
172 *
173 * <p>There are two primary forms of intents you will use.
174 *
175 * <ul>
176 * <li> <p><b>Explicit Intents</b> have specified a component (via
177 * {@link #setComponent} or {@link #setClass}), which provides the exact
178 * class to be run. Often these will not include any other information,
179 * simply being a way for an application to launch various internal
180 * activities it has as the user interacts with the application.
181 *
182 * <li> <p><b>Implicit Intents</b> have not specified a component;
183 * instead, they must include enough information for the system to
184 * determine which of the available components is best to run for that
185 * intent.
186 * </ul>
187 *
188 * <p>When using implicit intents, given such an arbitrary intent we need to
189 * know what to do with it. This is handled by the process of <em>Intent
190 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
191 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
192 * more activities/receivers) that can handle it.</p>
193 *
194 * <p>The intent resolution mechanism basically revolves around matching an
195 * Intent against all of the &lt;intent-filter&gt; descriptions in the
196 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
197 * objects explicitly registered with {@link Context#registerReceiver}.) More
198 * details on this can be found in the documentation on the {@link
199 * IntentFilter} class.</p>
200 *
201 * <p>There are three pieces of information in the Intent that are used for
202 * resolution: the action, type, and category. Using this information, a query
203 * is done on the {@link PackageManager} for a component that can handle the
204 * intent. The appropriate component is determined based on the intent
205 * information supplied in the <code>AndroidManifest.xml</code> file as
206 * follows:</p>
207 *
208 * <ul>
209 * <li> <p>The <b>action</b>, if given, must be listed by the component as
210 * one it handles.</p>
211 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
212 * already supplied in the Intent. Like the action, if a type is
213 * included in the intent (either explicitly or implicitly in its
214 * data), then this must be listed by the component as one it handles.</p>
215 * <li> For data that is not a <code>content:</code> URI and where no explicit
216 * type is included in the Intent, instead the <b>scheme</b> of the
217 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
218 * considered. Again like the action, if we are matching a scheme it
219 * must be listed by the component as one it can handle.
220 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
221 * by the activity as categories it handles. That is, if you include
222 * the categories {@link #CATEGORY_LAUNCHER} and
223 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
224 * with an intent that lists <em>both</em> of those categories.
225 * Activities will very often need to support the
226 * {@link #CATEGORY_DEFAULT} so that they can be found by
227 * {@link Context#startActivity Context.startActivity()}.</p>
228 * </ul>
229 *
230 * <p>For example, consider the Note Pad sample application that
231 * allows user to browse through a list of notes data and view details about
232 * individual items. Text in italics indicate places were you would replace a
233 * name with one specific to your own package.</p>
234 *
235 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
236 * package="<i>com.android.notepad</i>"&gt;
237 * &lt;application android:icon="@drawable/app_notes"
238 * android:label="@string/app_name"&gt;
239 *
240 * &lt;provider class=".NotePadProvider"
241 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
242 *
243 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
244 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700245 * &lt;action android:name="android.intent.action.MAIN" /&gt;
246 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700247 * &lt;/intent-filter&gt;
248 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700249 * &lt;action android:name="android.intent.action.VIEW" /&gt;
250 * &lt;action android:name="android.intent.action.EDIT" /&gt;
251 * &lt;action android:name="android.intent.action.PICK" /&gt;
252 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
253 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700254 * &lt;/intent-filter&gt;
255 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700256 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
257 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
258 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700259 * &lt;/intent-filter&gt;
260 * &lt;/activity&gt;
261 *
262 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
263 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700264 * &lt;action android:name="android.intent.action.VIEW" /&gt;
265 * &lt;action android:name="android.intent.action.EDIT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 *
270 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700271 * &lt;action android:name="android.intent.action.INSERT" /&gt;
272 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
273 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700274 * &lt;/intent-filter&gt;
275 *
276 * &lt;/activity&gt;
277 *
278 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
279 * android:theme="@android:style/Theme.Dialog"&gt;
280 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
284 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
285 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 * &lt;/activity&gt;
288 *
289 * &lt;/application&gt;
290 * &lt;/manifest&gt;</pre>
291 *
292 * <p>The first activity,
293 * <code>com.android.notepad.NotesList</code>, serves as our main
294 * entry into the app. It can do three things as described by its three intent
295 * templates:
296 * <ol>
297 * <li><pre>
298 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700299 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
300 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700301 * &lt;/intent-filter&gt;</pre>
302 * <p>This provides a top-level entry into the NotePad application: the standard
303 * MAIN action is a main entry point (not requiring any other information in
304 * the Intent), and the LAUNCHER category says that this entry point should be
305 * listed in the application launcher.</p>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
309 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
310 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
311 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
312 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700313 * &lt;/intent-filter&gt;</pre>
314 * <p>This declares the things that the activity can do on a directory of
315 * notes. The type being supported is given with the &lt;type&gt; tag, where
316 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
317 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
318 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
319 * The activity allows the user to view or edit the directory of data (via
320 * the VIEW and EDIT actions), or to pick a particular note and return it
321 * to the caller (via the PICK action). Note also the DEFAULT category
322 * supplied here: this is <em>required</em> for the
323 * {@link Context#startActivity Context.startActivity} method to resolve your
324 * activity when its component name is not explicitly specified.</p>
325 * <li><pre>
326 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700327 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
328 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
329 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700330 * &lt;/intent-filter&gt;</pre>
331 * <p>This filter describes the ability return to the caller a note selected by
332 * the user without needing to know where it came from. The data type
333 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
334 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
335 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
336 * The GET_CONTENT action is similar to the PICK action, where the activity
337 * will return to its caller a piece of data selected by the user. Here,
338 * however, the caller specifies the type of data they desire instead of
339 * the type of data the user will be picking from.</p>
340 * </ol>
341 *
342 * <p>Given these capabilities, the following intents will resolve to the
343 * NotesList activity:</p>
344 *
345 * <ul>
346 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
347 * activities that can be used as top-level entry points into an
348 * application.</p>
349 * <li> <p><b>{ action=android.app.action.MAIN,
350 * category=android.app.category.LAUNCHER }</b> is the actual intent
351 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700352 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700353 * data=content://com.google.provider.NotePad/notes }</b>
354 * displays a list of all the notes under
355 * "content://com.google.provider.NotePad/notes", which
356 * the user can browse through and see the details on.</p>
357 * <li> <p><b>{ action=android.app.action.PICK
358 * data=content://com.google.provider.NotePad/notes }</b>
359 * provides a list of the notes under
360 * "content://com.google.provider.NotePad/notes", from which
361 * the user can pick a note whose data URL is returned back to the caller.</p>
362 * <li> <p><b>{ action=android.app.action.GET_CONTENT
363 * type=vnd.android.cursor.item/vnd.google.note }</b>
364 * is similar to the pick action, but allows the caller to specify the
365 * kind of data they want back so that the system can find the appropriate
366 * activity to pick something of that data type.</p>
367 * </ul>
368 *
369 * <p>The second activity,
370 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
371 * note entry and allows them to edit it. It can do two things as described
372 * by its two intent templates:
373 * <ol>
374 * <li><pre>
375 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700376 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
377 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
378 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
379 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700380 * &lt;/intent-filter&gt;</pre>
381 * <p>The first, primary, purpose of this activity is to let the user interact
382 * with a single note, as decribed by the MIME type
383 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
384 * either VIEW a note or allow the user to EDIT it. Again we support the
385 * DEFAULT category to allow the activity to be launched without explicitly
386 * specifying its component.</p>
387 * <li><pre>
388 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700389 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
390 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
391 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700392 * &lt;/intent-filter&gt;</pre>
393 * <p>The secondary use of this activity is to insert a new note entry into
394 * an existing directory of notes. This is used when the user creates a new
395 * note: the INSERT action is executed on the directory of notes, causing
396 * this activity to run and have the user create the new note data which
397 * it then adds to the content provider.</p>
398 * </ol>
399 *
400 * <p>Given these capabilities, the following intents will resolve to the
401 * NoteEditor activity:</p>
402 *
403 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700404 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700405 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
406 * shows the user the content of note <var>{ID}</var>.</p>
407 * <li> <p><b>{ action=android.app.action.EDIT
408 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
409 * allows the user to edit the content of note <var>{ID}</var>.</p>
410 * <li> <p><b>{ action=android.app.action.INSERT
411 * data=content://com.google.provider.NotePad/notes }</b>
412 * creates a new, empty note in the notes list at
413 * "content://com.google.provider.NotePad/notes"
414 * and allows the user to edit it. If they keep their changes, the URI
415 * of the newly created note is returned to the caller.</p>
416 * </ul>
417 *
418 * <p>The last activity,
419 * <code>com.android.notepad.TitleEditor</code>, allows the user to
420 * edit the title of a note. This could be implemented as a class that the
421 * application directly invokes (by explicitly setting its component in
422 * the Intent), but here we show a way you can publish alternative
423 * operations on existing data:</p>
424 *
425 * <pre>
426 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700427 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
429 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
430 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
431 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700432 * &lt;/intent-filter&gt;</pre>
433 *
434 * <p>In the single intent template here, we
435 * have created our own private action called
436 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
437 * edit the title of a note. It must be invoked on a specific note
438 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
439 * view and edit actions, but here displays and edits the title contained
440 * in the note data.
441 *
442 * <p>In addition to supporting the default category as usual, our title editor
443 * also supports two other standard categories: ALTERNATIVE and
444 * SELECTED_ALTERNATIVE. Implementing
445 * these categories allows others to find the special action it provides
446 * without directly knowing about it, through the
447 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
448 * more often to build dynamic menu items with
449 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
450 * template here was also supply an explicit name for the template
451 * (via <code>android:label="@string/resolve_title"</code>) to better control
452 * what the user sees when presented with this activity as an alternative
453 * action to the data they are viewing.
454 *
455 * <p>Given these capabilities, the following intent will resolve to the
456 * TitleEditor activity:</p>
457 *
458 * <ul>
459 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
460 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
461 * displays and allows the user to edit the title associated
462 * with note <var>{ID}</var>.</p>
463 * </ul>
464 *
465 * <h3>Standard Activity Actions</h3>
466 *
467 * <p>These are the current standard actions that Intent defines for launching
468 * activities (usually through {@link Context#startActivity}. The most
469 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
470 * {@link #ACTION_EDIT}.
471 *
472 * <ul>
473 * <li> {@link #ACTION_MAIN}
474 * <li> {@link #ACTION_VIEW}
475 * <li> {@link #ACTION_ATTACH_DATA}
476 * <li> {@link #ACTION_EDIT}
477 * <li> {@link #ACTION_PICK}
478 * <li> {@link #ACTION_CHOOSER}
479 * <li> {@link #ACTION_GET_CONTENT}
480 * <li> {@link #ACTION_DIAL}
481 * <li> {@link #ACTION_CALL}
482 * <li> {@link #ACTION_SEND}
483 * <li> {@link #ACTION_SENDTO}
484 * <li> {@link #ACTION_ANSWER}
485 * <li> {@link #ACTION_INSERT}
486 * <li> {@link #ACTION_DELETE}
487 * <li> {@link #ACTION_RUN}
488 * <li> {@link #ACTION_SYNC}
489 * <li> {@link #ACTION_PICK_ACTIVITY}
490 * <li> {@link #ACTION_SEARCH}
491 * <li> {@link #ACTION_WEB_SEARCH}
492 * <li> {@link #ACTION_FACTORY_TEST}
493 * </ul>
494 *
495 * <h3>Standard Broadcast Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for receiving
498 * broadcasts (usually through {@link Context#registerReceiver} or a
499 * &lt;receiver&gt; tag in a manifest).
500 *
501 * <ul>
502 * <li> {@link #ACTION_TIME_TICK}
503 * <li> {@link #ACTION_TIME_CHANGED}
504 * <li> {@link #ACTION_TIMEZONE_CHANGED}
505 * <li> {@link #ACTION_BOOT_COMPLETED}
506 * <li> {@link #ACTION_PACKAGE_ADDED}
507 * <li> {@link #ACTION_PACKAGE_CHANGED}
508 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800509 * <li> {@link #ACTION_PACKAGE_RESTARTED}
510 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700511 * <li> {@link #ACTION_UID_REMOVED}
512 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700513 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700514 * <li> {@link #ACTION_POWER_DISCONNECTED}
515 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700516 * </ul>
517 *
518 * <h3>Standard Categories</h3>
519 *
520 * <p>These are the current standard categories that can be used to further
521 * clarify an Intent via {@link #addCategory}.
522 *
523 * <ul>
524 * <li> {@link #CATEGORY_DEFAULT}
525 * <li> {@link #CATEGORY_BROWSABLE}
526 * <li> {@link #CATEGORY_TAB}
527 * <li> {@link #CATEGORY_ALTERNATIVE}
528 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
529 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800530 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700531 * <li> {@link #CATEGORY_HOME}
532 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700533 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400534 * <li> {@link #CATEGORY_CAR_DOCK}
535 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500536 * <li> {@link #CATEGORY_LE_DESK_DOCK}
537 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200538 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700539 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * </ul>
541 *
542 * <h3>Standard Extra Data</h3>
543 *
544 * <p>These are the current standard fields that can be used as extra data via
545 * {@link #putExtra}.
546 *
547 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800548 * <li> {@link #EXTRA_ALARM_COUNT}
549 * <li> {@link #EXTRA_BCC}
550 * <li> {@link #EXTRA_CC}
551 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
552 * <li> {@link #EXTRA_DATA_REMOVED}
553 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500554 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
555 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800556 * <li> {@link #EXTRA_DOCK_STATE_CAR}
557 * <li> {@link #EXTRA_DOCK_STATE_DESK}
558 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
559 * <li> {@link #EXTRA_DONT_KILL_APP}
560 * <li> {@link #EXTRA_EMAIL}
561 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700562 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800563 * <li> {@link #EXTRA_KEY_EVENT}
564 * <li> {@link #EXTRA_PHONE_NUMBER}
565 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
566 * <li> {@link #EXTRA_REPLACING}
567 * <li> {@link #EXTRA_SHORTCUT_ICON}
568 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
569 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700570 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800571 * <li> {@link #EXTRA_SHORTCUT_NAME}
572 * <li> {@link #EXTRA_SUBJECT}
573 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700574 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_TITLE}
576 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700577 * </ul>
578 *
579 * <h3>Flags</h3>
580 *
581 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800582 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
583 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700584 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800585public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 // ---------------------------------------------------------------------
587 // ---------------------------------------------------------------------
588 // Standard intent activity actions (see action variable).
589
590 /**
591 * Activity Action: Start as a main entry point, does not expect to
592 * receive data.
593 * <p>Input: nothing
594 * <p>Output: nothing
595 */
596 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
597 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800598
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 /**
600 * Activity Action: Display the data to the user. This is the most common
601 * action performed on data -- it is the generic action you can use on
602 * a piece of data to get the most reasonable thing to occur. For example,
603 * when used on a contacts entry it will view the entry; when used on a
604 * mailto: URI it will bring up a compose window filled with the information
605 * supplied by the URI; when used with a tel: URI it will invoke the
606 * dialer.
607 * <p>Input: {@link #getData} is URI from which to retrieve data.
608 * <p>Output: nothing.
609 */
610 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
611 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800612
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 /**
614 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
615 * performed on a piece of data.
616 */
617 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800618
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 /**
620 * Used to indicate that some piece of data should be attached to some other
621 * place. For example, image data could be attached to a contact. It is up
622 * to the recipient to decide where the data should be attached; the intent
623 * does not specify the ultimate destination.
624 * <p>Input: {@link #getData} is URI of data to be attached.
625 * <p>Output: nothing.
626 */
627 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
628 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Activity Action: Provide explicit editable access to the given data.
632 * <p>Input: {@link #getData} is URI of data to be edited.
633 * <p>Output: nothing.
634 */
635 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
636 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800637
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700638 /**
639 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
640 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
641 * The extras can contain type specific data to pass through to the editing/creating
642 * activity.
643 * <p>Output: The URI of the item that was picked. This must be a content:
644 * URI so that any receiver can access it.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Pick an item from the data, returning what was selected.
651 * <p>Input: {@link #getData} is URI containing a directory of data
652 * (vnd.android.cursor.dir/*) from which to pick an item.
653 * <p>Output: The URI of the item that was picked.
654 */
655 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
656 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800660 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700661 * <p>Output: An Intent representing the shortcut. The intent must contain three
662 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
663 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800664 * (value: ShortcutIconResource).</p>
665 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700666 * @see #EXTRA_SHORTCUT_INTENT
667 * @see #EXTRA_SHORTCUT_NAME
668 * @see #EXTRA_SHORTCUT_ICON
669 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
670 * @see android.content.Intent.ShortcutIconResource
671 */
672 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
673 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
674
675 /**
676 * The name of the extra used to define the Intent of a shortcut.
677 *
678 * @see #ACTION_CREATE_SHORTCUT
679 */
680 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
681 /**
682 * The name of the extra used to define the name of a shortcut.
683 *
684 * @see #ACTION_CREATE_SHORTCUT
685 */
686 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
687 /**
688 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
689 *
690 * @see #ACTION_CREATE_SHORTCUT
691 */
692 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
693 /**
694 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
695 *
696 * @see #ACTION_CREATE_SHORTCUT
697 * @see android.content.Intent.ShortcutIconResource
698 */
699 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
700 "android.intent.extra.shortcut.ICON_RESOURCE";
701
702 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800703 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700704 *
705 * @see Intent#ACTION_CREATE_SHORTCUT
706 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800707 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
708 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700709 */
710 public static class ShortcutIconResource implements Parcelable {
711 /**
712 * The package name of the application containing the icon.
713 */
714 public String packageName;
715
716 /**
717 * The resource name of the icon, including package, name and type.
718 */
719 public String resourceName;
720
721 /**
722 * Creates a new ShortcutIconResource for the specified context and resource
723 * identifier.
724 *
725 * @param context The context of the application.
726 * @param resourceId The resource idenfitier for the icon.
727 * @return A new ShortcutIconResource with the specified's context package name
728 * and icon resource idenfitier.
729 */
730 public static ShortcutIconResource fromContext(Context context, int resourceId) {
731 ShortcutIconResource icon = new ShortcutIconResource();
732 icon.packageName = context.getPackageName();
733 icon.resourceName = context.getResources().getResourceName(resourceId);
734 return icon;
735 }
736
737 /**
738 * Used to read a ShortcutIconResource from a Parcel.
739 */
740 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
741 new Parcelable.Creator<ShortcutIconResource>() {
742
743 public ShortcutIconResource createFromParcel(Parcel source) {
744 ShortcutIconResource icon = new ShortcutIconResource();
745 icon.packageName = source.readString();
746 icon.resourceName = source.readString();
747 return icon;
748 }
749
750 public ShortcutIconResource[] newArray(int size) {
751 return new ShortcutIconResource[size];
752 }
753 };
754
755 /**
756 * No special parcel contents.
757 */
758 public int describeContents() {
759 return 0;
760 }
761
762 public void writeToParcel(Parcel dest, int flags) {
763 dest.writeString(packageName);
764 dest.writeString(resourceName);
765 }
766
767 @Override
768 public String toString() {
769 return resourceName;
770 }
771 }
772
773 /**
774 * Activity Action: Display an activity chooser, allowing the user to pick
775 * what they want to before proceeding. This can be used as an alternative
776 * to the standard activity picker that is displayed by the system when
777 * you try to start an activity with multiple possible matches, with these
778 * differences in behavior:
779 * <ul>
780 * <li>You can specify the title that will appear in the activity chooser.
781 * <li>The user does not have the option to make one of the matching
782 * activities a preferred activity, and all possible activities will
783 * always be shown even if one of them is currently marked as the
784 * preferred activity.
785 * </ul>
786 * <p>
787 * This action should be used when the user will naturally expect to
788 * select an activity in order to proceed. An example if when not to use
789 * it is when the user clicks on a "mailto:" link. They would naturally
790 * expect to go directly to their mail app, so startActivity() should be
791 * called directly: it will
792 * either launch the current preferred app, or put up a dialog allowing the
793 * user to pick an app to use and optionally marking that as preferred.
794 * <p>
795 * In contrast, if the user is selecting a menu item to send a picture
796 * they are viewing to someone else, there are many different things they
797 * may want to do at this point: send it through e-mail, upload it to a
798 * web service, etc. In this case the CHOOSER action should be used, to
799 * always present to the user a list of the things they can do, with a
800 * nice title given by the caller such as "Send this photo with:".
801 * <p>
802 * As a convenience, an Intent of this form can be created with the
803 * {@link #createChooser} function.
804 * <p>Input: No data should be specified. get*Extra must have
805 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
806 * and can optionally have a {@link #EXTRA_TITLE} field containing the
807 * title text to display in the chooser.
808 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
809 */
810 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
811 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
812
813 /**
814 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
815 *
816 * @param target The Intent that the user will be selecting an activity
817 * to perform.
818 * @param title Optional title that will be displayed in the chooser.
819 * @return Return a new Intent object that you can hand to
820 * {@link Context#startActivity(Intent) Context.startActivity()} and
821 * related methods.
822 */
823 public static Intent createChooser(Intent target, CharSequence title) {
824 Intent intent = new Intent(ACTION_CHOOSER);
825 intent.putExtra(EXTRA_INTENT, target);
826 if (title != null) {
827 intent.putExtra(EXTRA_TITLE, title);
828 }
829 return intent;
830 }
831 /**
832 * Activity Action: Allow the user to select a particular kind of data and
833 * return it. This is different than {@link #ACTION_PICK} in that here we
834 * just say what kind of data is desired, not a URI of existing data from
835 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
836 * create the data as it runs (for example taking a picture or recording a
837 * sound), let them browser over the web and download the desired data,
838 * etc.
839 * <p>
840 * There are two main ways to use this action: if you want an specific kind
841 * of data, such as a person contact, you set the MIME type to the kind of
842 * data you want and launch it with {@link Context#startActivity(Intent)}.
843 * The system will then launch the best application to select that kind
844 * of data for you.
845 * <p>
846 * You may also be interested in any of a set of types of content the user
847 * can pick. For example, an e-mail application that wants to allow the
848 * user to add an attachment to an e-mail message can use this action to
849 * bring up a list of all of the types of content the user can attach.
850 * <p>
851 * In this case, you should wrap the GET_CONTENT intent with a chooser
852 * (through {@link #createChooser}), which will give the proper interface
853 * for the user to pick how to send your data and allow you to specify
854 * a prompt indicating what they are doing. You will usually specify a
855 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
856 * broad range of content types the user can select from.
857 * <p>
858 * When using such a broad GET_CONTENT action, it is often desireable to
859 * only pick from data that can be represented as a stream. This is
860 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
861 * <p>
862 * Input: {@link #getType} is the desired MIME type to retrieve. Note
863 * that no URI is supplied in the intent, as there are no constraints on
864 * where the returned data originally comes from. You may also include the
865 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
866 * opened as a stream.
867 * <p>
868 * Output: The URI of the item that was picked. This must be a content:
869 * URI so that any receiver can access it.
870 */
871 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
872 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
873 /**
874 * Activity Action: Dial a number as specified by the data. This shows a
875 * UI with the number being dialed, allowing the user to explicitly
876 * initiate the call.
877 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
878 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
879 * number.
880 * <p>Output: nothing.
881 */
882 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
883 public static final String ACTION_DIAL = "android.intent.action.DIAL";
884 /**
885 * Activity Action: Perform a call to someone specified by the data.
886 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
887 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
888 * number.
889 * <p>Output: nothing.
890 *
891 * <p>Note: there will be restrictions on which applications can initiate a
892 * call; most applications should use the {@link #ACTION_DIAL}.
893 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
894 * numbers. Applications can <strong>dial</strong> emergency numbers using
895 * {@link #ACTION_DIAL}, however.
896 */
897 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
898 public static final String ACTION_CALL = "android.intent.action.CALL";
899 /**
900 * Activity Action: Perform a call to an emergency number specified by the
901 * data.
902 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
903 * tel: URI of an explicit phone number.
904 * <p>Output: nothing.
905 * @hide
906 */
907 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
908 /**
909 * Activity action: Perform a call to any number (emergency or not)
910 * specified by the data.
911 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
912 * tel: URI of an explicit phone number.
913 * <p>Output: nothing.
914 * @hide
915 */
916 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
917 /**
918 * Activity Action: Send a message to someone specified by the data.
919 * <p>Input: {@link #getData} is URI describing the target.
920 * <p>Output: nothing.
921 */
922 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
923 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
924 /**
925 * Activity Action: Deliver some data to someone else. Who the data is
926 * being delivered to is not specified; it is up to the receiver of this
927 * action to ask the user where the data should be sent.
928 * <p>
929 * When launching a SEND intent, you should usually wrap it in a chooser
930 * (through {@link #createChooser}), which will give the proper interface
931 * for the user to pick how to send your data and allow you to specify
932 * a prompt indicating what they are doing.
933 * <p>
934 * Input: {@link #getType} is the MIME type of the data being sent.
935 * get*Extra can have either a {@link #EXTRA_TEXT}
936 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
937 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
938 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
939 * if the MIME type is unknown (this will only allow senders that can
940 * handle generic data streams).
941 * <p>
942 * Optional standard extras, which may be interpreted by some recipients as
943 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
944 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
945 * <p>
946 * Output: nothing.
947 */
948 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
949 public static final String ACTION_SEND = "android.intent.action.SEND";
950 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800951 * Activity Action: Deliver multiple data to someone else.
952 * <p>
953 * Like ACTION_SEND, except the data is multiple.
954 * <p>
955 * Input: {@link #getType} is the MIME type of the data being sent.
956 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
957 * #EXTRA_STREAM} field, containing the data to be sent.
958 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800959 * Multiple types are supported, and receivers should handle mixed types
960 * whenever possible. The right way for the receiver to check them is to
961 * use the content resolver on each URI. The intent sender should try to
962 * put the most concrete mime type in the intent type, but it can fall
963 * back to {@literal <type>/*} or {@literal *}/* as needed.
964 * <p>
965 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
966 * be image/jpg, but if you are sending image/jpg and image/png, then the
967 * intent's type should be image/*.
968 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800969 * Optional standard extras, which may be interpreted by some recipients as
970 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
971 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
972 * <p>
973 * Output: nothing.
974 */
975 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
976 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
977 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700978 * Activity Action: Handle an incoming phone call.
979 * <p>Input: nothing.
980 * <p>Output: nothing.
981 */
982 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
983 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
984 /**
985 * Activity Action: Insert an empty item into the given container.
986 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
987 * in which to place the data.
988 * <p>Output: URI of the new data that was created.
989 */
990 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
991 public static final String ACTION_INSERT = "android.intent.action.INSERT";
992 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -0700993 * Activity Action: Create a new item in the given container, initializing it
994 * from the current contents of the clipboard.
995 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
996 * in which to place the data.
997 * <p>Output: URI of the new data that was created.
998 */
999 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1000 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1001 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001002 * Activity Action: Delete the given data from its container.
1003 * <p>Input: {@link #getData} is URI of data to be deleted.
1004 * <p>Output: nothing.
1005 */
1006 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1007 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1008 /**
1009 * Activity Action: Run the data, whatever that means.
1010 * <p>Input: ? (Note: this is currently specific to the test harness.)
1011 * <p>Output: nothing.
1012 */
1013 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1014 public static final String ACTION_RUN = "android.intent.action.RUN";
1015 /**
1016 * Activity Action: Perform a data synchronization.
1017 * <p>Input: ?
1018 * <p>Output: ?
1019 */
1020 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1021 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1022 /**
1023 * Activity Action: Pick an activity given an intent, returning the class
1024 * selected.
1025 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1026 * used with {@link PackageManager#queryIntentActivities} to determine the
1027 * set of activities from which to pick.
1028 * <p>Output: Class name of the activity that was selected.
1029 */
1030 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1031 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1032 /**
1033 * Activity Action: Perform a search.
1034 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1035 * is the text to search for. If empty, simply
1036 * enter your search results Activity with the search UI activated.
1037 * <p>Output: nothing.
1038 */
1039 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1040 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1041 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001042 * Activity Action: Start the platform-defined tutorial
1043 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1044 * is the text to search for. If empty, simply
1045 * enter your search results Activity with the search UI activated.
1046 * <p>Output: nothing.
1047 */
1048 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1049 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1050 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001051 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001052 * <p>
1053 * Input: {@link android.app.SearchManager#QUERY
1054 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1055 * a url starts with http or https, the site will be opened. If it is plain
1056 * text, Google search will be applied.
1057 * <p>
1058 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 */
1060 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1061 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1062 /**
1063 * Activity Action: List all available applications
1064 * <p>Input: Nothing.
1065 * <p>Output: nothing.
1066 */
1067 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1068 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1069 /**
1070 * Activity Action: Show settings for choosing wallpaper
1071 * <p>Input: Nothing.
1072 * <p>Output: Nothing.
1073 */
1074 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1075 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1076
1077 /**
1078 * Activity Action: Show activity for reporting a bug.
1079 * <p>Input: Nothing.
1080 * <p>Output: Nothing.
1081 */
1082 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1083 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1084
1085 /**
1086 * Activity Action: Main entry point for factory tests. Only used when
1087 * the device is booting in factory test node. The implementing package
1088 * must be installed in the system image.
1089 * <p>Input: nothing
1090 * <p>Output: nothing
1091 */
1092 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1093
1094 /**
1095 * Activity Action: The user pressed the "call" button to go to the dialer
1096 * or other appropriate UI for placing a call.
1097 * <p>Input: Nothing.
1098 * <p>Output: Nothing.
1099 */
1100 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1101 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1102
1103 /**
1104 * Activity Action: Start Voice Command.
1105 * <p>Input: Nothing.
1106 * <p>Output: Nothing.
1107 */
1108 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1109 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001110
1111 /**
1112 * Activity Action: Start action associated with long pressing on the
1113 * search key.
1114 * <p>Input: Nothing.
1115 * <p>Output: Nothing.
1116 */
1117 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1118 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001119
Jacek Surazski86b6c532009-05-13 14:38:28 +02001120 /**
1121 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1122 * This intent is delivered to the package which installed the application, usually
1123 * the Market.
1124 * <p>Input: No data is specified. The bug report is passed in using
1125 * an {@link #EXTRA_BUG_REPORT} field.
1126 * <p>Output: Nothing.
1127 * @hide
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001131
1132 /**
1133 * Activity Action: Show power usage information to the user.
1134 * <p>Input: Nothing.
1135 * <p>Output: Nothing.
1136 */
1137 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1138 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001139
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001140 /**
1141 * Activity Action: Setup wizard to launch after a platform update. This
1142 * activity should have a string meta-data field associated with it,
1143 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1144 * the platform for setup. The activity will be launched only if
1145 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1146 * same value.
1147 * <p>Input: Nothing.
1148 * <p>Output: Nothing.
1149 * @hide
1150 */
1151 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1152 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001153
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001154 /**
1155 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1156 * describing the last run version of the platform that was setup.
1157 * @hide
1158 */
1159 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1160
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001161 // ---------------------------------------------------------------------
1162 // ---------------------------------------------------------------------
1163 // Standard intent broadcast actions (see action variable).
1164
1165 /**
1166 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001167 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001168 * <p class="note">This is a protected intent that can only be sent
1169 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001170 */
1171 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1172 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1173 /**
1174 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001175 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001176 * <p class="note">This is a protected intent that can only be sent
1177 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001178 */
1179 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1180 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001181
1182 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001183 * 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 -07001184 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001185 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001186 * <p class="note">This is a protected intent that can only be sent
1187 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001188 */
1189 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001190 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001191
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001192 /**
1193 * Broadcast Action: The current time has changed. Sent every
1194 * minute. You can <em>not</em> receive this through components declared
1195 * in manifests, only by exlicitly registering for it with
1196 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1197 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001198 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001199 * <p class="note">This is a protected intent that can only be sent
1200 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001201 */
1202 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1203 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1204 /**
1205 * Broadcast Action: The time was set.
1206 */
1207 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1208 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1209 /**
1210 * Broadcast Action: The date has changed.
1211 */
1212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1213 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1214 /**
1215 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1216 * <ul>
1217 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1218 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001219 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001220 * <p class="note">This is a protected intent that can only be sent
1221 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001222 */
1223 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1224 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1225 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001226 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1227 * DNS entries should be tossed.
1228 * @hide
1229 */
1230 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1231 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1232 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001233 * Alarm Changed Action: This is broadcast when the AlarmClock
1234 * application's alarm is set or unset. It is used by the
1235 * AlarmClock application and the StatusBar service.
1236 * @hide
1237 */
1238 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1239 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1240 /**
1241 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1242 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1243 * @hide
1244 */
1245 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1246 public static final String ACTION_SYNC_STATE_CHANGED
1247 = "android.intent.action.SYNC_STATE_CHANGED";
1248 /**
1249 * Broadcast Action: This is broadcast once, after the system has finished
1250 * booting. It can be used to perform application-specific initialization,
1251 * such as installing alarms. You must hold the
1252 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1253 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001254 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001255 * <p class="note">This is a protected intent that can only be sent
1256 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001257 */
1258 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1259 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1260 /**
1261 * Broadcast Action: This is broadcast when a user action should request a
1262 * temporary system dialog to dismiss. Some examples of temporary system
1263 * dialogs are the notification window-shade and the recent tasks dialog.
1264 */
1265 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1266 /**
1267 * Broadcast Action: Trigger the download and eventual installation
1268 * of a package.
1269 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001270 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001271 * <p class="note">This is a protected intent that can only be sent
1272 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001273 */
1274 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1275 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1276 /**
1277 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001278 * device. The data contains the name of the package. Note that the
1279 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001280 * <p>My include the following extras:
1281 * <ul>
1282 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1283 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1284 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1285 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001286 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001287 * <p class="note">This is a protected intent that can only be sent
1288 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001289 */
1290 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1291 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1292 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001293 * Broadcast Action: A new version of an application package has been
1294 * installed, replacing an existing version that was previously installed.
1295 * The data contains the name of the package.
1296 * <p>My include the following extras:
1297 * <ul>
1298 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1299 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001300 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001301 * <p class="note">This is a protected intent that can only be sent
1302 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001303 */
1304 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1305 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1306 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001307 * Broadcast Action: An existing application package has been removed from
1308 * the device. The data contains the name of the package. The package
1309 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001310 * <ul>
1311 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1312 * to the package.
1313 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1314 * application -- data and code -- is being removed.
1315 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1316 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1317 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001318 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001319 * <p class="note">This is a protected intent that can only be sent
1320 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001321 */
1322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1323 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1324 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001325 * Broadcast Action: An existing application package has been changed (e.g.
1326 * a component has been enabled or disabled). The data contains the name of
1327 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001328 * <ul>
1329 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001330 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1331 * of the changed components.
1332 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1333 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001334 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001335 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001336 * <p class="note">This is a protected intent that can only be sent
1337 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001338 */
1339 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1340 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1341 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001342 * @hide
1343 * Broadcast Action: Ask system services if there is any reason to
1344 * restart the given package. The data contains the name of the
1345 * package.
1346 * <ul>
1347 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1348 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1349 * </ul>
1350 *
1351 * <p class="note">This is a protected intent that can only be sent
1352 * by the system.
1353 */
1354 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1355 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1356 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001357 * Broadcast Action: The user has restarted a package, and all of its
1358 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001359 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001360 * be removed. Note that the restarted package does <em>not</em>
1361 * receive this broadcast.
1362 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001363 * <ul>
1364 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1365 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001366 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001367 * <p class="note">This is a protected intent that can only be sent
1368 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001369 */
1370 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1371 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1372 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001373 * Broadcast Action: The user has cleared the data of a package. This should
1374 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001375 * its persistent data is erased and this broadcast sent.
1376 * Note that the cleared package does <em>not</em>
1377 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001378 * <ul>
1379 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1380 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001381 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001382 * <p class="note">This is a protected intent that can only be sent
1383 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001384 */
1385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1386 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1387 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001388 * Broadcast Action: A user ID has been removed from the system. The user
1389 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001390 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001391 * <p class="note">This is a protected intent that can only be sent
1392 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001393 */
1394 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1395 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001396
1397 /**
1398 * Broadcast Action: Resources for a set of packages (which were
1399 * previously unavailable) are currently
1400 * available since the media on which they exist is available.
1401 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1402 * list of packages whose availability changed.
1403 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1404 * list of uids of packages whose availability changed.
1405 * Note that the
1406 * packages in this list do <em>not</em> receive this broadcast.
1407 * The specified set of packages are now available on the system.
1408 * <p>Includes the following extras:
1409 * <ul>
1410 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1411 * whose resources(were previously unavailable) are currently available.
1412 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1413 * packages whose resources(were previously unavailable)
1414 * are currently available.
1415 * </ul>
1416 *
1417 * <p class="note">This is a protected intent that can only be sent
1418 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001419 */
1420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001421 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1422 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001423
1424 /**
1425 * Broadcast Action: Resources for a set of packages are currently
1426 * unavailable since the media on which they exist is unavailable.
1427 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1428 * list of packages whose availability changed.
1429 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1430 * list of uids of packages whose availability changed.
1431 * The specified set of packages can no longer be
1432 * launched and are practically unavailable on the system.
1433 * <p>Inclues the following extras:
1434 * <ul>
1435 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1436 * whose resources are no longer available.
1437 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1438 * whose resources are no longer available.
1439 * </ul>
1440 *
1441 * <p class="note">This is a protected intent that can only be sent
1442 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001443 */
1444 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001445 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001446 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001447
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001448 /**
1449 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001450 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001451 */
1452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1453 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1454 /**
1455 * Broadcast Action: The current device {@link android.content.res.Configuration}
1456 * (orientation, locale, etc) has changed. When such a change happens, the
1457 * UIs (view hierarchy) will need to be rebuilt based on this new
1458 * information; for the most part, applications don't need to worry about
1459 * this, because the system will take care of stopping and restarting the
1460 * application to make sure it sees the new changes. Some system code that
1461 * can not be restarted will need to watch for this action and handle it
1462 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001463 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001464 * <p class="note">
1465 * You can <em>not</em> receive this through components declared
1466 * in manifests, only by explicitly registering for it with
1467 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1468 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001469 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001470 * <p class="note">This is a protected intent that can only be sent
1471 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001472 *
1473 * @see android.content.res.Configuration
1474 */
1475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1476 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1477 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001478 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001479 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001480 * <p class="note">This is a protected intent that can only be sent
1481 * by the system.
1482 */
1483 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1484 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1485 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001486 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1487 * charging state, level, and other information about the battery.
1488 * See {@link android.os.BatteryManager} for documentation on the
1489 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001490 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001491 * <p class="note">
1492 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001493 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001494 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001495 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1496 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1497 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1498 * broadcasts that are sent and can be received through manifest
1499 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001500 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001501 * <p class="note">This is a protected intent that can only be sent
1502 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001503 */
1504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1505 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1506 /**
1507 * Broadcast Action: Indicates low battery condition on the device.
1508 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001509 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001510 * <p class="note">This is a protected intent that can only be sent
1511 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001512 */
1513 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1514 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1515 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001516 * Broadcast Action: Indicates the battery is now okay after being low.
1517 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1518 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001519 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001520 * <p class="note">This is a protected intent that can only be sent
1521 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001522 */
1523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1524 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1525 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001526 * Broadcast Action: External power has been connected to the device.
1527 * This is intended for applications that wish to register specifically to this notification.
1528 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1529 * stay active to receive this notification. This action can be used to implement actions
1530 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001531 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001532 * <p class="note">This is a protected intent that can only be sent
1533 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001534 */
1535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001536 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001537 /**
1538 * Broadcast Action: External power has been removed from the device.
1539 * This is intended for applications that wish to register specifically to this notification.
1540 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1541 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001542 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001543 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001544 * <p class="note">This is a protected intent that can only be sent
1545 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001546 */
1547 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001548 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001549 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001550 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001551 * Broadcast Action: Device is shutting down.
1552 * This is broadcast when the device is being shut down (completely turned
1553 * off, not sleeping). Once the broadcast is complete, the final shutdown
1554 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001555 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001556 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001557 * <p class="note">This is a protected intent that can only be sent
1558 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001561 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001562 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001563 * Activity Action: Start this activity to request system shutdown.
1564 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1565 * to request confirmation from the user before shutting down.
1566 *
1567 * <p class="note">This is a protected intent that can only be sent
1568 * by the system.
1569 *
1570 * {@hide}
1571 */
1572 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1573 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001574 * Broadcast Action: A sticky broadcast that indicates low memory
1575 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001576 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001577 * <p class="note">This is a protected intent that can only be sent
1578 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001579 */
1580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1581 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1582 /**
1583 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001584 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001585 * <p class="note">This is a protected intent that can only be sent
1586 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001587 */
1588 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1589 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1590 /**
Jake Hambybb371632010-08-23 18:16:48 -07001591 * Broadcast Action: A sticky broadcast that indicates a memory full
1592 * condition on the device. This is intended for activities that want
1593 * to be able to fill the data partition completely, leaving only
1594 * enough free space to prevent system-wide SQLite failures.
1595 *
1596 * <p class="note">This is a protected intent that can only be sent
1597 * by the system.
1598 *
1599 * {@hide}
1600 */
1601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1602 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1603 /**
1604 * Broadcast Action: Indicates memory full condition on the device
1605 * no longer exists.
1606 *
1607 * <p class="note">This is a protected intent that can only be sent
1608 * by the system.
1609 *
1610 * {@hide}
1611 */
1612 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1613 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1614 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001615 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1616 * and package management should be started.
1617 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1618 * notification.
1619 */
1620 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1621 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1622 /**
1623 * Broadcast Action: The device has entered USB Mass Storage mode.
1624 * This is used mainly for the USB Settings panel.
1625 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1626 * when the SD card file system is mounted or unmounted
1627 */
1628 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1629 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1630
1631 /**
1632 * Broadcast Action: The device has exited USB Mass Storage mode.
1633 * This is used mainly for the USB Settings panel.
1634 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1635 * when the SD card file system is mounted or unmounted
1636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1639
1640 /**
1641 * Broadcast Action: External media has been removed.
1642 * The path to the mount point for the removed media is contained in the Intent.mData field.
1643 */
1644 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1645 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1646
1647 /**
1648 * Broadcast Action: External media is present, but not mounted at its mount point.
1649 * The path to the mount point for the removed media is contained in the Intent.mData field.
1650 */
1651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1652 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1653
1654 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001655 * Broadcast Action: External media is present, and being disk-checked
1656 * 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 -08001657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1660
1661 /**
1662 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1663 * 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 -08001664 */
1665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1666 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1667
1668 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001669 * Broadcast Action: External media is present and mounted at its mount point.
1670 * The path to the mount point for the removed media is contained in the Intent.mData field.
1671 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1672 * media was mounted read only.
1673 */
1674 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1675 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1676
1677 /**
1678 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001679 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001680 */
1681 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1682 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1683
1684 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001685 * Broadcast Action: External media is no longer being shared via USB mass storage.
1686 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1687 *
1688 * @hide
1689 */
1690 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1691
1692 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001693 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1694 * The path to the mount point for the removed media is contained in the Intent.mData field.
1695 */
1696 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1697 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1698
1699 /**
1700 * Broadcast Action: External media is present but cannot be mounted.
1701 * The path to the mount point for the removed media is contained in the Intent.mData field.
1702 */
1703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1704 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1705
1706 /**
1707 * Broadcast Action: User has expressed the desire to remove the external storage media.
1708 * Applications should close all files they have open within the mount point when they receive this intent.
1709 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1710 */
1711 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1712 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1713
1714 /**
1715 * Broadcast Action: The media scanner has started scanning a directory.
1716 * The path to the directory being scanned is contained in the Intent.mData field.
1717 */
1718 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1719 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1720
1721 /**
1722 * Broadcast Action: The media scanner has finished scanning a directory.
1723 * The path to the scanned directory is contained in the Intent.mData field.
1724 */
1725 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1726 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1727
1728 /**
1729 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1730 * The path to the file is contained in the Intent.mData field.
1731 */
1732 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1733 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1734
1735 /**
1736 * Broadcast Action: The "Media Button" was pressed. Includes a single
1737 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1738 * caused the broadcast.
1739 */
1740 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1741 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1742
1743 /**
1744 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1745 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1746 * caused the broadcast.
1747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1749 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1750
1751 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1752 // location; they are not general-purpose actions.
1753
1754 /**
1755 * Broadcast Action: An GTalk connection has been established.
1756 */
1757 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1758 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1759 "android.intent.action.GTALK_CONNECTED";
1760
1761 /**
1762 * Broadcast Action: An GTalk connection has been disconnected.
1763 */
1764 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1765 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1766 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001767
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001768 /**
1769 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001770 */
1771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1772 public static final String ACTION_INPUT_METHOD_CHANGED =
1773 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001774
1775 /**
1776 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1777 * more radios have been turned off or on. The intent will have the following extra value:</p>
1778 * <ul>
1779 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1780 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1781 * turned off</li>
1782 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001783 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001784 * <p class="note">This is a protected intent that can only be sent
1785 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001786 */
1787 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1788 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1789
1790 /**
1791 * Broadcast Action: Some content providers have parts of their namespace
1792 * where they publish new events or items that the user may be especially
1793 * interested in. For these things, they may broadcast this action when the
1794 * set of interesting items change.
1795 *
1796 * For example, GmailProvider sends this notification when the set of unread
1797 * mail in the inbox changes.
1798 *
1799 * <p>The data of the intent identifies which part of which provider
1800 * changed. When queried through the content resolver, the data URI will
1801 * return the data set in question.
1802 *
1803 * <p>The intent will have the following extra values:
1804 * <ul>
1805 * <li><em>count</em> - The number of items in the data set. This is the
1806 * same as the number of items in the cursor returned by querying the
1807 * data URI. </li>
1808 * </ul>
1809 *
1810 * This intent will be sent at boot (if the count is non-zero) and when the
1811 * data set changes. It is possible for the data set to change without the
1812 * count changing (for example, if a new unread message arrives in the same
1813 * sync operation in which a message is archived). The phone should still
1814 * ring/vibrate/etc as normal in this case.
1815 */
1816 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1817 public static final String ACTION_PROVIDER_CHANGED =
1818 "android.intent.action.PROVIDER_CHANGED";
1819
1820 /**
1821 * Broadcast Action: Wired Headset plugged in or unplugged.
1822 *
1823 * <p>The intent will have the following extra values:
1824 * <ul>
1825 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1826 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001827 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001828 * </ul>
1829 * </ul>
1830 */
1831 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1832 public static final String ACTION_HEADSET_PLUG =
1833 "android.intent.action.HEADSET_PLUG";
1834
1835 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001836 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
1837 *
1838 * <p>The intent will have the following extra values:
1839 * <ul>
1840 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1841 * <li><em>name</em> - Headset type, human readable string </li>
1842 * </ul>
1843 * </ul>
1844 * @hide
1845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_USB_ANLG_HEADSET_PLUG =
1848 "android.intent.action.DOCK_HEADSET_PLUG";
1849
1850 /**
1851 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
1852 *
1853 * <p>The intent will have the following extra values:
1854 * <ul>
1855 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1856 * <li><em>name</em> - Headset type, human readable string </li>
1857 * </ul>
1858 * </ul>
1859 * @hide
1860 */
1861 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1862 public static final String ACTION_USB_DGTL_HEADSET_PLUG =
Praveen Bharathi26e37342010-11-02 19:23:30 -07001863 "android.intent.action.HDMI_AUDIO_PLUG";
1864
1865 /**
1866 * Broadcast Action: A HMDI cable was plugged or unplugged
1867 *
1868 * <p>The intent will have the following extra values:
1869 * <ul>
1870 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1871 * <li><em>name</em> - HDMI cable, human readable string </li>
1872 * </ul>
1873 * </ul>
1874 * @hide
1875 */
1876 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1877 public static final String ACTION_HDMI_AUDIO_PLUG =
1878 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001879
1880 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 * Broadcast Action: An outgoing call is about to be placed.
1882 *
1883 * <p>The Intent will have the following extra value:
1884 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001885 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001886 * the phone number originally intended to be dialed.</li>
1887 * </ul>
1888 * <p>Once the broadcast is finished, the resultData is used as the actual
1889 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001890 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001891 * outgoing call in turn: for example, a parental control application
1892 * might verify that the user is authorized to place the call at that
1893 * time, then a number-rewriting application might add an area code if
1894 * one was not specified.</p>
1895 * <p>For consistency, any receiver whose purpose is to prohibit phone
1896 * calls should have a priority of 0, to ensure it will see the final
1897 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001898 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001899 * should have a positive priority.
1900 * Negative priorities are reserved for the system for this broadcast;
1901 * using them may cause problems.</p>
1902 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1903 * abort the broadcast.</p>
1904 * <p>Emergency calls cannot be intercepted using this mechanism, and
1905 * other calls cannot be modified to call emergency numbers using this
1906 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001907 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001908 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1909 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08001910 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001911 * <p class="note">This is a protected intent that can only be sent
1912 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001913 */
1914 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1915 public static final String ACTION_NEW_OUTGOING_CALL =
1916 "android.intent.action.NEW_OUTGOING_CALL";
1917
1918 /**
1919 * Broadcast Action: Have the device reboot. This is only for use by
1920 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08001921 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001922 * <p class="note">This is a protected intent that can only be sent
1923 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001924 */
1925 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1926 public static final String ACTION_REBOOT =
1927 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001928
Wei Huang97ecc9c2009-05-11 17:44:20 -07001929 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08001930 * Broadcast Action: A sticky broadcast for changes in the physical
1931 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08001932 *
1933 * <p>The intent will have the following extra values:
1934 * <ul>
1935 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08001936 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08001937 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08001938 * <p>This is intended for monitoring the current physical dock state.
1939 * See {@link android.app.UiModeManager} for the normal API dealing with
1940 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001941 */
1942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1943 public static final String ACTION_DOCK_EVENT =
1944 "android.intent.action.DOCK_EVENT";
1945
1946 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07001947 * Broadcast Action: a remote intent is to be broadcasted.
1948 *
1949 * A remote intent is used for remote RPC between devices. The remote intent
1950 * is serialized and sent from one device to another device. The receiving
1951 * device parses the remote intent and broadcasts it. Note that anyone can
1952 * broadcast a remote intent. However, if the intent receiver of the remote intent
1953 * does not trust intent broadcasts from arbitrary intent senders, it should require
1954 * the sender to hold certain permissions so only trusted sender's broadcast will be
1955 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001956 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07001957 */
1958 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07001959 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07001960
Dianne Hackborn9acc0302009-08-25 00:27:12 -07001961 /**
1962 * Broadcast Action: hook for permforming cleanup after a system update.
1963 *
1964 * The broadcast is sent when the system is booting, before the
1965 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
1966 * image. A receiver for this should do its work and then disable itself
1967 * so that it does not get run again at the next boot.
1968 * @hide
1969 */
1970 public static final String ACTION_PRE_BOOT_COMPLETED =
1971 "android.intent.action.PRE_BOOT_COMPLETED";
1972
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 // ---------------------------------------------------------------------
1974 // ---------------------------------------------------------------------
1975 // Standard intent categories (see addCategory()).
1976
1977 /**
1978 * Set if the activity should be an option for the default action
1979 * (center press) to perform on a piece of data. Setting this will
1980 * hide from the user any activities without it set when performing an
1981 * action on some data. Note that this is normal -not- set in the
1982 * Intent when initiating an action -- it is for use in intent filters
1983 * specified in packages.
1984 */
1985 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1986 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1987 /**
1988 * Activities that can be safely invoked from a browser must support this
1989 * category. For example, if the user is viewing a web page or an e-mail
1990 * and clicks on a link in the text, the Intent generated execute that
1991 * link will require the BROWSABLE category, so that only activities
1992 * supporting this category will be considered as possible actions. By
1993 * supporting this category, you are promising that there is nothing
1994 * damaging (without user intervention) that can happen by invoking any
1995 * matching Intent.
1996 */
1997 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1998 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1999 /**
2000 * Set if the activity should be considered as an alternative action to
2001 * the data the user is currently viewing. See also
2002 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2003 * applies to the selection in a list of items.
2004 *
2005 * <p>Supporting this category means that you would like your activity to be
2006 * displayed in the set of alternative things the user can do, usually as
2007 * part of the current activity's options menu. You will usually want to
2008 * include a specific label in the &lt;intent-filter&gt; of this action
2009 * describing to the user what it does.
2010 *
2011 * <p>The action of IntentFilter with this category is important in that it
2012 * describes the specific action the target will perform. This generally
2013 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2014 * a specific name such as "com.android.camera.action.CROP. Only one
2015 * alternative of any particular action will be shown to the user, so using
2016 * a specific action like this makes sure that your alternative will be
2017 * displayed while also allowing other applications to provide their own
2018 * overrides of that particular action.
2019 */
2020 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2021 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2022 /**
2023 * Set if the activity should be considered as an alternative selection
2024 * action to the data the user has currently selected. This is like
2025 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2026 * of items from which the user can select, giving them alternatives to the
2027 * default action that will be performed on it.
2028 */
2029 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2030 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2031 /**
2032 * Intended to be used as a tab inside of an containing TabActivity.
2033 */
2034 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2035 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2036 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002037 * Should be displayed in the top-level launcher.
2038 */
2039 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2040 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2041 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002042 * Provides information about the package it is in; typically used if
2043 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2044 * a front-door to the user without having to be shown in the all apps list.
2045 */
2046 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2047 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2048 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002049 * This is the home activity, that is the first activity that is displayed
2050 * when the device boots.
2051 */
2052 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2053 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2054 /**
2055 * This activity is a preference panel.
2056 */
2057 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2058 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2059 /**
2060 * This activity is a development preference panel.
2061 */
2062 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2063 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2064 /**
2065 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002066 */
2067 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2068 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2069 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002070 * This activity allows the user to browse and download new applications.
2071 */
2072 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2073 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2074 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002075 * This activity may be exercised by the monkey or other automated test tools.
2076 */
2077 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2078 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2079 /**
2080 * To be used as a test (not part of the normal user experience).
2081 */
2082 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2083 /**
2084 * To be used as a unit test (run through the Test Harness).
2085 */
2086 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2087 /**
2088 * To be used as an sample code example (not part of the normal user
2089 * experience).
2090 */
2091 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2092 /**
2093 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2094 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2095 * when queried, though it is allowable for those columns to be blank.
2096 */
2097 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2098 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2099
2100 /**
2101 * To be used as code under test for framework instrumentation tests.
2102 */
2103 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2104 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002105 /**
2106 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002107 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2108 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002109 */
2110 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2111 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2112 /**
2113 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002114 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2115 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002116 */
2117 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2118 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002119 /**
2120 * An activity to run when device is inserted into a analog (low end) dock.
2121 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2122 * information, see {@link android.app.UiModeManager}.
2123 */
2124 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2125 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2126
2127 /**
2128 * An activity to run when device is inserted into a digital (high end) dock.
2129 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2130 * information, see {@link android.app.UiModeManager}.
2131 */
2132 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2133 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002134
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002135 /**
2136 * Used to indicate that the activity can be used in a car environment.
2137 */
2138 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2139 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2140
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002141 // ---------------------------------------------------------------------
2142 // ---------------------------------------------------------------------
2143 // Standard extra data keys.
2144
2145 /**
2146 * The initial data to place in a newly created record. Use with
2147 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2148 * fields as would be given to the underlying ContentProvider.insert()
2149 * call.
2150 */
2151 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2152
2153 /**
2154 * A constant CharSequence that is associated with the Intent, used with
2155 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2156 * this may be a styled CharSequence, so you must use
2157 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2158 * retrieve it.
2159 */
2160 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2161
2162 /**
2163 * A content: URI holding a stream of data associated with the Intent,
2164 * used with {@link #ACTION_SEND} to supply the data being sent.
2165 */
2166 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2167
2168 /**
2169 * A String[] holding e-mail addresses that should be delivered to.
2170 */
2171 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2172
2173 /**
2174 * A String[] holding e-mail addresses that should be carbon copied.
2175 */
2176 public static final String EXTRA_CC = "android.intent.extra.CC";
2177
2178 /**
2179 * A String[] holding e-mail addresses that should be blind carbon copied.
2180 */
2181 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2182
2183 /**
2184 * A constant string holding the desired subject line of a message.
2185 */
2186 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2187
2188 /**
2189 * An Intent describing the choices you would like shown with
2190 * {@link #ACTION_PICK_ACTIVITY}.
2191 */
2192 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2193
2194 /**
2195 * A CharSequence dialog title to provide to the user when used with a
2196 * {@link #ACTION_CHOOSER}.
2197 */
2198 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2199
2200 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002201 * A Parcelable[] of {@link Intent} or
2202 * {@link android.content.pm.LabeledIntent} objects as set with
2203 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2204 * a the front of the list of choices, when shown to the user with a
2205 * {@link #ACTION_CHOOSER}.
2206 */
2207 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2208
2209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002210 * A {@link android.view.KeyEvent} object containing the event that
2211 * triggered the creation of the Intent it is in.
2212 */
2213 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2214
2215 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002216 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2217 * before shutting down.
2218 *
2219 * {@hide}
2220 */
2221 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2222
2223 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002224 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2225 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2226 * of restarting the application.
2227 */
2228 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2229
2230 /**
2231 * A String holding the phone number originally entered in
2232 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2233 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2234 */
2235 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002236
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002237 /**
2238 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2239 * intents to supply the uid the package had been assigned. Also an optional
2240 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2241 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2242 * purpose.
2243 */
2244 public static final String EXTRA_UID = "android.intent.extra.UID";
2245
2246 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002247 * @hide String array of package names.
2248 */
2249 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2250
2251 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002252 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2253 * intents to indicate whether this represents a full uninstall (removing
2254 * both the code and its data) or a partial uninstall (leaving its data,
2255 * implying that this is an update).
2256 */
2257 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002258
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002259 /**
2260 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2261 * intents to indicate that this is a replacement of the package, so this
2262 * broadcast will immediately be followed by an add broadcast for a
2263 * different version of the same package.
2264 */
2265 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002266
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002267 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002268 * Used as an int extra field in {@link android.app.AlarmManager} intents
2269 * to tell the application being invoked how many pending alarms are being
2270 * delievered with the intent. For one-shot alarms this will always be 1.
2271 * For recurring alarms, this might be greater than 1 if the device was
2272 * asleep or powered off at the time an earlier alarm would have been
2273 * delivered.
2274 */
2275 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002276
Jacek Surazski86b6c532009-05-13 14:38:28 +02002277 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002278 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2279 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002280 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2281 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002282 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2283 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2284 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002285 */
2286 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2287
2288 /**
2289 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2290 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002291 */
2292 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2293
2294 /**
2295 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2296 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002297 */
2298 public static final int EXTRA_DOCK_STATE_DESK = 1;
2299
2300 /**
2301 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2302 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002303 */
2304 public static final int EXTRA_DOCK_STATE_CAR = 2;
2305
2306 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002307 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2308 * to represent that the phone is in a analog (low end) dock.
2309 */
2310 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2311
2312 /**
2313 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2314 * to represent that the phone is in a digital (high end) dock.
2315 */
2316 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2317
2318 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002319 * Boolean that can be supplied as meta-data with a dock activity, to
2320 * indicate that the dock should take over the home key when it is active.
2321 */
2322 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002323
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002324 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002325 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2326 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002327 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002328 * @hide
2329 */
2330 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2331
2332 /**
Romain Guy4969af72009-06-17 10:53:19 -07002333 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002334 * package. Specifies the installer package name; this package will receive the
2335 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002336 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002337 * @hide
2338 */
Romain Guy4969af72009-06-17 10:53:19 -07002339 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002340 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002341
Wei Huang97ecc9c2009-05-11 17:44:20 -07002342 /**
2343 * Used in the extra field in the remote intent. It's astring token passed with the
2344 * remote intent.
2345 */
2346 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2347 "android.intent.extra.remote_intent_token";
2348
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002349 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002350 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002351 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002352 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002353 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002354 "android.intent.extra.changed_component_name";
2355
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002356 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002357 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002358 * and contains a string array of all of the components that have changed.
2359 */
2360 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2361 "android.intent.extra.changed_component_name_list";
2362
2363 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002364 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002365 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2366 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002367 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002368 */
2369 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2370 "android.intent.extra.changed_package_list";
2371
2372 /**
2373 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002374 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2375 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002376 * and contains an integer array of uids of all of the components
2377 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002378 */
2379 public static final String EXTRA_CHANGED_UID_LIST =
2380 "android.intent.extra.changed_uid_list";
2381
2382 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002383 * @hide
2384 * Magic extra system code can use when binding, to give a label for
2385 * who it is that has bound to a service. This is an integer giving
2386 * a framework string resource that can be displayed to the user.
2387 */
2388 public static final String EXTRA_CLIENT_LABEL =
2389 "android.intent.extra.client_label";
2390
2391 /**
2392 * @hide
2393 * Magic extra system code can use when binding, to give a PendingIntent object
2394 * that can be launched for the user to disable the system's use of this
2395 * service.
2396 */
2397 public static final String EXTRA_CLIENT_INTENT =
2398 "android.intent.extra.client_intent";
2399
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002400 // ---------------------------------------------------------------------
2401 // ---------------------------------------------------------------------
2402 // Intent flags (see mFlags variable).
2403
2404 /**
2405 * If set, the recipient of this Intent will be granted permission to
2406 * perform read operations on the Uri in the Intent's data.
2407 */
2408 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2409 /**
2410 * If set, the recipient of this Intent will be granted permission to
2411 * perform write operations on the Uri in the Intent's data.
2412 */
2413 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2414 /**
2415 * Can be set by the caller to indicate that this Intent is coming from
2416 * a background operation, not from direct user interaction.
2417 */
2418 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2419 /**
2420 * A flag you can enable for debugging: when set, log messages will be
2421 * printed during the resolution of this intent to show you what has
2422 * been found to create the final resolved list.
2423 */
2424 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
2425
2426 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002427 * If set, the new activity is not kept in the history stack. As soon as
2428 * the user navigates away from it, the activity is finished. This may also
2429 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2430 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002431 */
2432 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2433 /**
2434 * If set, the activity will not be launched if it is already running
2435 * at the top of the history stack.
2436 */
2437 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2438 /**
2439 * If set, this activity will become the start of a new task on this
2440 * history stack. A task (from the activity that started it to the
2441 * next task activity) defines an atomic group of activities that the
2442 * user can move to. Tasks can be moved to the foreground and background;
2443 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002444 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002445 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2446 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002447 *
2448 * <p>This flag is generally used by activities that want
2449 * to present a "launcher" style behavior: they give the user a list of
2450 * separate things that can be done, which otherwise run completely
2451 * independently of the activity launching them.
2452 *
2453 * <p>When using this flag, if a task is already running for the activity
2454 * you are now starting, then a new activity will not be started; instead,
2455 * the current task will simply be brought to the front of the screen with
2456 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2457 * to disable this behavior.
2458 *
2459 * <p>This flag can not be used when the caller is requesting a result from
2460 * the activity being launched.
2461 */
2462 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2463 /**
2464 * <strong>Do not use this flag unless you are implementing your own
2465 * top-level application launcher.</strong> Used in conjunction with
2466 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2467 * behavior of bringing an existing task to the foreground. When set,
2468 * a new task is <em>always</em> started to host the Activity for the
2469 * Intent, regardless of whether there is already an existing task running
2470 * the same thing.
2471 *
2472 * <p><strong>Because the default system does not include graphical task management,
2473 * you should not use this flag unless you provide some way for a user to
2474 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002475 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002476 * <p>This flag is ignored if
2477 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2478 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002479 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2480 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002481 */
2482 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2483 /**
2484 * If set, and the activity being launched is already running in the
2485 * current task, then instead of launching a new instance of that activity,
2486 * all of the other activities on top of it will be closed and this Intent
2487 * will be delivered to the (now on top) old activity as a new Intent.
2488 *
2489 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2490 * If D calls startActivity() with an Intent that resolves to the component
2491 * of activity B, then C and D will be finished and B receive the given
2492 * Intent, resulting in the stack now being: A, B.
2493 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002494 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002495 * either receive the new intent you are starting here in its
2496 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002497 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002498 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2499 * the same intent, then it will be finished and re-created; for all other
2500 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2501 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002502 *
2503 * <p>This launch mode can also be used to good effect in conjunction with
2504 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2505 * of a task, it will bring any currently running instance of that task
2506 * to the foreground, and then clear it to its root state. This is
2507 * especially useful, for example, when launching an activity from the
2508 * notification manager.
2509 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002510 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2511 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002512 */
2513 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2514 /**
2515 * If set and this intent is being used to launch a new activity from an
2516 * existing one, then the reply target of the existing activity will be
2517 * transfered to the new activity. This way the new activity can call
2518 * {@link android.app.Activity#setResult} and have that result sent back to
2519 * the reply target of the original activity.
2520 */
2521 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2522 /**
2523 * If set and this intent is being used to launch a new activity from an
2524 * existing one, the current activity will not be counted as the top
2525 * activity for deciding whether the new intent should be delivered to
2526 * the top instead of starting a new one. The previous activity will
2527 * be used as the top, with the assumption being that the current activity
2528 * will finish itself immediately.
2529 */
2530 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2531 /**
2532 * If set, the new activity is not kept in the list of recently launched
2533 * activities.
2534 */
2535 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2536 /**
2537 * This flag is not normally set by application code, but set for you by
2538 * the system as described in the
2539 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2540 * launchMode} documentation for the singleTask mode.
2541 */
2542 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2543 /**
2544 * If set, and this activity is either being started in a new task or
2545 * bringing to the top an existing task, then it will be launched as
2546 * the front door of the task. This will result in the application of
2547 * any affinities needed to have that task in the proper state (either
2548 * moving activities to or from it), or simply resetting that task to
2549 * its initial state if needed.
2550 */
2551 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2552 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002553 * This flag is not normally set by application code, but set for you by
2554 * the system if this activity is being launched from history
2555 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002556 */
2557 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002558 /**
2559 * If set, this marks a point in the task's activity stack that should
2560 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002561 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002562 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2563 * the user re-launching it from home), this activity and all on top of
2564 * it will be finished so that the user does not return to them, but
2565 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002566 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002567 * <p>This is useful for cases where you have a logical break in your
2568 * application. For example, an e-mail application may have a command
2569 * to view an attachment, which launches an image view activity to
2570 * display it. This activity should be part of the e-mail application's
2571 * task, since it is a part of the task the user is involved in. However,
2572 * if the user leaves that task, and later selects the e-mail app from
2573 * home, we may like them to return to the conversation they were
2574 * viewing, not the picture attachment, since that is confusing. By
2575 * setting this flag when launching the image viewer, that viewer and
2576 * any activities it starts will be removed the next time the user returns
2577 * to mail.
2578 */
2579 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002580 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002581 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002582 * callback from occurring on the current frontmost activity before it is
2583 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002584 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002585 * <p>Typically, an activity can rely on that callback to indicate that an
2586 * explicit user action has caused their activity to be moved out of the
2587 * foreground. The callback marks an appropriate point in the activity's
2588 * lifecycle for it to dismiss any notifications that it intends to display
2589 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002590 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002591 * <p>If an activity is ever started via any non-user-driven events such as
2592 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2593 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002594 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002595 */
2596 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002597 /**
2598 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2599 * this flag will cause the launched activity to be brought to the front of its
2600 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002601 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002602 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2603 * If D calls startActivity() with an Intent that resolves to the component
2604 * of activity B, then B will be brought to the front of the history stack,
2605 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002606 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002607 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002608 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002609 */
2610 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002611 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002612 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2613 * this flag will prevent the system from applying an activity transition
2614 * animation to go to the next activity state. This doesn't mean an
2615 * animation will never run -- if another activity change happens that doesn't
2616 * specify this flag before the activity started here is displayed, then
2617 * that transition will be used. This this flag can be put to good use
2618 * when you are going to do a series of activity operations but the
2619 * animation seen by the user shouldn't be driven by the first activity
2620 * change but rather a later one.
2621 */
2622 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2623 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002624 * If set, when sending a broadcast only registered receivers will be
2625 * called -- no BroadcastReceiver components will be launched.
2626 */
2627 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002628 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002629 * If set, when sending a broadcast the new broadcast will replace
2630 * any existing pending broadcast that matches it. Matching is defined
2631 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
2632 * true for the intents of the two broadcasts. When a match is found,
2633 * the new broadcast (and receivers associated with it) will replace the
2634 * existing one in the pending broadcast list, remaining at the same
2635 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08002636 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002637 * <p>This flag is most typically used with sticky broadcasts, which
2638 * only care about delivering the most recent values of the broadcast
2639 * to their receivers.
2640 */
2641 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
2642 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002643 * If set, when sending a broadcast <i>before boot has completed</i> only
2644 * registered receivers will be called -- no BroadcastReceiver components
2645 * will be launched. Sticky intent state will be recorded properly even
2646 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2647 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002648 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002649 * <p>This flag is only for use by system sevices as a convenience to
2650 * avoid having to implement a more complex mechanism around detection
2651 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002652 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002653 * @hide
2654 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002655 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x10000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002656 /**
2657 * Set when this broadcast is for a boot upgrade, a special mode that
2658 * allows the broadcast to be sent before the system is ready and launches
2659 * the app process with no providers running in it.
2660 * @hide
2661 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002662 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x08000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002663
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002664 /**
2665 * @hide Flags that can't be changed with PendingIntent.
2666 */
2667 public static final int IMMUTABLE_FLAGS =
2668 FLAG_GRANT_READ_URI_PERMISSION
2669 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08002670
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002671 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002672 // ---------------------------------------------------------------------
2673 // toUri() and parseUri() options.
2674
2675 /**
2676 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2677 * always has the "intent:" scheme. This syntax can be used when you want
2678 * to later disambiguate between URIs that are intended to describe an
2679 * Intent vs. all others that should be treated as raw URIs. When used
2680 * with {@link #parseUri}, any other scheme will result in a generic
2681 * VIEW action for that raw URI.
2682 */
2683 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08002684
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002685 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002686
2687 private String mAction;
2688 private Uri mData;
2689 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002690 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002691 private ComponentName mComponent;
2692 private int mFlags;
2693 private HashSet<String> mCategories;
2694 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002695 private Rect mSourceBounds;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002696
2697 // ---------------------------------------------------------------------
2698
2699 /**
2700 * Create an empty intent.
2701 */
2702 public Intent() {
2703 }
2704
2705 /**
2706 * Copy constructor.
2707 */
2708 public Intent(Intent o) {
2709 this.mAction = o.mAction;
2710 this.mData = o.mData;
2711 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002712 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002713 this.mComponent = o.mComponent;
2714 this.mFlags = o.mFlags;
2715 if (o.mCategories != null) {
2716 this.mCategories = new HashSet<String>(o.mCategories);
2717 }
2718 if (o.mExtras != null) {
2719 this.mExtras = new Bundle(o.mExtras);
2720 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002721 if (o.mSourceBounds != null) {
2722 this.mSourceBounds = new Rect(o.mSourceBounds);
2723 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002724 }
2725
2726 @Override
2727 public Object clone() {
2728 return new Intent(this);
2729 }
2730
2731 private Intent(Intent o, boolean all) {
2732 this.mAction = o.mAction;
2733 this.mData = o.mData;
2734 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002735 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002736 this.mComponent = o.mComponent;
2737 if (o.mCategories != null) {
2738 this.mCategories = new HashSet<String>(o.mCategories);
2739 }
2740 }
2741
2742 /**
2743 * Make a clone of only the parts of the Intent that are relevant for
2744 * filter matching: the action, data, type, component, and categories.
2745 */
2746 public Intent cloneFilter() {
2747 return new Intent(this, false);
2748 }
2749
2750 /**
2751 * Create an intent with a given action. All other fields (data, type,
2752 * class) are null. Note that the action <em>must</em> be in a
2753 * namespace because Intents are used globally in the system -- for
2754 * example the system VIEW action is android.intent.action.VIEW; an
2755 * application's custom action would be something like
2756 * com.google.app.myapp.CUSTOM_ACTION.
2757 *
2758 * @param action The Intent action, such as ACTION_VIEW.
2759 */
2760 public Intent(String action) {
2761 mAction = action;
2762 }
2763
2764 /**
2765 * Create an intent with a given action and for a given data url. Note
2766 * that the action <em>must</em> be in a namespace because Intents are
2767 * used globally in the system -- for example the system VIEW action is
2768 * android.intent.action.VIEW; an application's custom action would be
2769 * something like com.google.app.myapp.CUSTOM_ACTION.
2770 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002771 * <p><em>Note: scheme and host name matching in the Android framework is
2772 * case-sensitive, unlike the formal RFC. As a result,
2773 * you should always ensure that you write your Uri with these elements
2774 * using lower case letters, and normalize any Uris you receive from
2775 * outside of Android to ensure the scheme and host is lower case.</em></p>
2776 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002777 * @param action The Intent action, such as ACTION_VIEW.
2778 * @param uri The Intent data URI.
2779 */
2780 public Intent(String action, Uri uri) {
2781 mAction = action;
2782 mData = uri;
2783 }
2784
2785 /**
2786 * Create an intent for a specific component. All other fields (action, data,
2787 * type, class) are null, though they can be modified later with explicit
2788 * calls. This provides a convenient way to create an intent that is
2789 * intended to execute a hard-coded class name, rather than relying on the
2790 * system to find an appropriate class for you; see {@link #setComponent}
2791 * for more information on the repercussions of this.
2792 *
2793 * @param packageContext A Context of the application package implementing
2794 * this class.
2795 * @param cls The component class that is to be used for the intent.
2796 *
2797 * @see #setClass
2798 * @see #setComponent
2799 * @see #Intent(String, android.net.Uri , Context, Class)
2800 */
2801 public Intent(Context packageContext, Class<?> cls) {
2802 mComponent = new ComponentName(packageContext, cls);
2803 }
2804
2805 /**
2806 * Create an intent for a specific component with a specified action and data.
2807 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2808 * construct the Intent and then calling {@link #setClass} to set its
2809 * class.
2810 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002811 * <p><em>Note: scheme and host name matching in the Android framework is
2812 * case-sensitive, unlike the formal RFC. As a result,
2813 * you should always ensure that you write your Uri with these elements
2814 * using lower case letters, and normalize any Uris you receive from
2815 * outside of Android to ensure the scheme and host is lower case.</em></p>
2816 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002817 * @param action The Intent action, such as ACTION_VIEW.
2818 * @param uri The Intent data URI.
2819 * @param packageContext A Context of the application package implementing
2820 * this class.
2821 * @param cls The component class that is to be used for the intent.
2822 *
2823 * @see #Intent(String, android.net.Uri)
2824 * @see #Intent(Context, Class)
2825 * @see #setClass
2826 * @see #setComponent
2827 */
2828 public Intent(String action, Uri uri,
2829 Context packageContext, Class<?> cls) {
2830 mAction = action;
2831 mData = uri;
2832 mComponent = new ComponentName(packageContext, cls);
2833 }
2834
2835 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002836 * Call {@link #parseUri} with 0 flags.
2837 * @deprecated Use {@link #parseUri} instead.
2838 */
2839 @Deprecated
2840 public static Intent getIntent(String uri) throws URISyntaxException {
2841 return parseUri(uri, 0);
2842 }
Tom Taylord4a47292009-12-21 13:59:18 -08002843
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002844 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002845 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002846 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002847 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002848 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002849 *
2850 * <p>The URI given here must not be relative -- that is, it must include
2851 * the scheme and full path.
2852 *
2853 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002854 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002855 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002856 *
2857 * @return Intent The newly created Intent object.
2858 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002859 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2860 * it bad (as parsed by the Uri class) or the Intent data within the
2861 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08002862 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002863 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002864 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002865 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002866 int i = 0;
2867 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002868 // Validate intent scheme for if requested.
2869 if ((flags&URI_INTENT_SCHEME) != 0) {
2870 if (!uri.startsWith("intent:")) {
2871 Intent intent = new Intent(ACTION_VIEW);
2872 try {
2873 intent.setData(Uri.parse(uri));
2874 } catch (IllegalArgumentException e) {
2875 throw new URISyntaxException(uri, e.getMessage());
2876 }
2877 return intent;
2878 }
2879 }
Tom Taylord4a47292009-12-21 13:59:18 -08002880
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002881 // simple case
2882 i = uri.lastIndexOf("#");
2883 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2884
2885 // old format Intent URI
2886 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002887
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002888 // new format
2889 Intent intent = new Intent(ACTION_VIEW);
2890
2891 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002892 String data = i >= 0 ? uri.substring(0, i) : null;
2893 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002894 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002895
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002896 // loop over contents of Intent, all name=value;
2897 while (!uri.startsWith("end", i)) {
2898 int eq = uri.indexOf('=', i);
2899 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002900 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002901
2902 // action
2903 if (uri.startsWith("action=", i)) {
2904 intent.mAction = value;
2905 }
2906
2907 // categories
2908 else if (uri.startsWith("category=", i)) {
2909 intent.addCategory(value);
2910 }
2911
2912 // type
2913 else if (uri.startsWith("type=", i)) {
2914 intent.mType = value;
2915 }
2916
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002917 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002918 else if (uri.startsWith("launchFlags=", i)) {
2919 intent.mFlags = Integer.decode(value).intValue();
2920 }
2921
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002922 // package
2923 else if (uri.startsWith("package=", i)) {
2924 intent.mPackage = value;
2925 }
2926
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002927 // component
2928 else if (uri.startsWith("component=", i)) {
2929 intent.mComponent = ComponentName.unflattenFromString(value);
2930 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002931
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002932 // scheme
2933 else if (uri.startsWith("scheme=", i)) {
2934 scheme = value;
2935 }
2936
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002937 // source bounds
2938 else if (uri.startsWith("sourceBounds=", i)) {
2939 intent.mSourceBounds = Rect.unflattenFromString(value);
2940 }
2941
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002942 // extra
2943 else {
2944 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002945 // create Bundle if it doesn't already exist
2946 if (intent.mExtras == null) intent.mExtras = new Bundle();
2947 Bundle b = intent.mExtras;
2948 // add EXTRA
2949 if (uri.startsWith("S.", i)) b.putString(key, value);
2950 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2951 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2952 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2953 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2954 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2955 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2956 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2957 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2958 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2959 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002960
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002961 // move to the next item
2962 i = semi + 1;
2963 }
2964
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002965 if (data != null) {
2966 if (data.startsWith("intent:")) {
2967 data = data.substring(7);
2968 if (scheme != null) {
2969 data = scheme + ':' + data;
2970 }
2971 }
Tom Taylord4a47292009-12-21 13:59:18 -08002972
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002973 if (data.length() > 0) {
2974 try {
2975 intent.mData = Uri.parse(data);
2976 } catch (IllegalArgumentException e) {
2977 throw new URISyntaxException(uri, e.getMessage());
2978 }
2979 }
2980 }
Tom Taylord4a47292009-12-21 13:59:18 -08002981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002982 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002983
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002984 } catch (IndexOutOfBoundsException e) {
2985 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2986 }
2987 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002988
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002989 public static Intent getIntentOld(String uri) throws URISyntaxException {
2990 Intent intent;
2991
2992 int i = uri.lastIndexOf('#');
2993 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002994 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002995 final int intentFragmentStart = i;
2996 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002997
2998 i++;
2999
3000 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003001 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003002 i += 7;
3003 int j = uri.indexOf(')', i);
3004 action = uri.substring(i, j);
3005 i = j + 1;
3006 }
3007
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003008 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003009
3010 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003011 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003012 i += 11;
3013 int j = uri.indexOf(')', i);
3014 while (i < j) {
3015 int sep = uri.indexOf('!', i);
3016 if (sep < 0) sep = j;
3017 if (i < sep) {
3018 intent.addCategory(uri.substring(i, sep));
3019 }
3020 i = sep + 1;
3021 }
3022 i = j + 1;
3023 }
3024
3025 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003026 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003027 i += 5;
3028 int j = uri.indexOf(')', i);
3029 intent.mType = uri.substring(i, j);
3030 i = j + 1;
3031 }
3032
3033 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003034 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003035 i += 12;
3036 int j = uri.indexOf(')', i);
3037 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3038 i = j + 1;
3039 }
3040
3041 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003042 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003043 i += 10;
3044 int j = uri.indexOf(')', i);
3045 int sep = uri.indexOf('!', i);
3046 if (sep >= 0 && sep < j) {
3047 String pkg = uri.substring(i, sep);
3048 String cls = uri.substring(sep + 1, j);
3049 intent.mComponent = new ComponentName(pkg, cls);
3050 }
3051 i = j + 1;
3052 }
3053
3054 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003055 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003056 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003057
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003058 final int closeParen = uri.indexOf(')', i);
3059 if (closeParen == -1) throw new URISyntaxException(uri,
3060 "EXTRA missing trailing ')'", i);
3061
3062 while (i < closeParen) {
3063 // fetch the key value
3064 int j = uri.indexOf('=', i);
3065 if (j <= i + 1 || i >= closeParen) {
3066 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3067 }
3068 char type = uri.charAt(i);
3069 i++;
3070 String key = uri.substring(i, j);
3071 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003072
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003073 // get type-value
3074 j = uri.indexOf('!', i);
3075 if (j == -1 || j >= closeParen) j = closeParen;
3076 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3077 String value = uri.substring(i, j);
3078 i = j;
3079
3080 // create Bundle if it doesn't already exist
3081 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003082
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003083 // add item to bundle
3084 try {
3085 switch (type) {
3086 case 'S':
3087 intent.mExtras.putString(key, Uri.decode(value));
3088 break;
3089 case 'B':
3090 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3091 break;
3092 case 'b':
3093 intent.mExtras.putByte(key, Byte.parseByte(value));
3094 break;
3095 case 'c':
3096 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3097 break;
3098 case 'd':
3099 intent.mExtras.putDouble(key, Double.parseDouble(value));
3100 break;
3101 case 'f':
3102 intent.mExtras.putFloat(key, Float.parseFloat(value));
3103 break;
3104 case 'i':
3105 intent.mExtras.putInt(key, Integer.parseInt(value));
3106 break;
3107 case 'l':
3108 intent.mExtras.putLong(key, Long.parseLong(value));
3109 break;
3110 case 's':
3111 intent.mExtras.putShort(key, Short.parseShort(value));
3112 break;
3113 default:
3114 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3115 }
3116 } catch (NumberFormatException e) {
3117 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3118 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003119
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003120 char ch = uri.charAt(i);
3121 if (ch == ')') break;
3122 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3123 i++;
3124 }
3125 }
3126
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003127 if (isIntentFragment) {
3128 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3129 } else {
3130 intent.mData = Uri.parse(uri);
3131 }
Tom Taylord4a47292009-12-21 13:59:18 -08003132
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003133 if (intent.mAction == null) {
3134 // By default, if no action is specified, then use VIEW.
3135 intent.mAction = ACTION_VIEW;
3136 }
3137
3138 } else {
3139 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3140 }
3141
3142 return intent;
3143 }
3144
3145 /**
3146 * Retrieve the general action to be performed, such as
3147 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3148 * the information in the intent should be interpreted -- most importantly,
3149 * what to do with the data returned by {@link #getData}.
3150 *
3151 * @return The action of this intent or null if none is specified.
3152 *
3153 * @see #setAction
3154 */
3155 public String getAction() {
3156 return mAction;
3157 }
3158
3159 /**
3160 * Retrieve data this intent is operating on. This URI specifies the name
3161 * of the data; often it uses the content: scheme, specifying data in a
3162 * content provider. Other schemes may be handled by specific activities,
3163 * such as http: by the web browser.
3164 *
3165 * @return The URI of the data this intent is targeting or null.
3166 *
3167 * @see #getScheme
3168 * @see #setData
3169 */
3170 public Uri getData() {
3171 return mData;
3172 }
3173
3174 /**
3175 * The same as {@link #getData()}, but returns the URI as an encoded
3176 * String.
3177 */
3178 public String getDataString() {
3179 return mData != null ? mData.toString() : null;
3180 }
3181
3182 /**
3183 * Return the scheme portion of the intent's data. If the data is null or
3184 * does not include a scheme, null is returned. Otherwise, the scheme
3185 * prefix without the final ':' is returned, i.e. "http".
3186 *
3187 * <p>This is the same as calling getData().getScheme() (and checking for
3188 * null data).
3189 *
3190 * @return The scheme of this intent.
3191 *
3192 * @see #getData
3193 */
3194 public String getScheme() {
3195 return mData != null ? mData.getScheme() : null;
3196 }
3197
3198 /**
3199 * Retrieve any explicit MIME type included in the intent. This is usually
3200 * null, as the type is determined by the intent data.
3201 *
3202 * @return If a type was manually set, it is returned; else null is
3203 * returned.
3204 *
3205 * @see #resolveType(ContentResolver)
3206 * @see #setType
3207 */
3208 public String getType() {
3209 return mType;
3210 }
3211
3212 /**
3213 * Return the MIME data type of this intent. If the type field is
3214 * explicitly set, that is simply returned. Otherwise, if the data is set,
3215 * the type of that data is returned. If neither fields are set, a null is
3216 * returned.
3217 *
3218 * @return The MIME type of this intent.
3219 *
3220 * @see #getType
3221 * @see #resolveType(ContentResolver)
3222 */
3223 public String resolveType(Context context) {
3224 return resolveType(context.getContentResolver());
3225 }
3226
3227 /**
3228 * Return the MIME data type of this intent. If the type field is
3229 * explicitly set, that is simply returned. Otherwise, if the data is set,
3230 * the type of that data is returned. If neither fields are set, a null is
3231 * returned.
3232 *
3233 * @param resolver A ContentResolver that can be used to determine the MIME
3234 * type of the intent's data.
3235 *
3236 * @return The MIME type of this intent.
3237 *
3238 * @see #getType
3239 * @see #resolveType(Context)
3240 */
3241 public String resolveType(ContentResolver resolver) {
3242 if (mType != null) {
3243 return mType;
3244 }
3245 if (mData != null) {
3246 if ("content".equals(mData.getScheme())) {
3247 return resolver.getType(mData);
3248 }
3249 }
3250 return null;
3251 }
3252
3253 /**
3254 * Return the MIME data type of this intent, only if it will be needed for
3255 * intent resolution. This is not generally useful for application code;
3256 * it is used by the frameworks for communicating with back-end system
3257 * services.
3258 *
3259 * @param resolver A ContentResolver that can be used to determine the MIME
3260 * type of the intent's data.
3261 *
3262 * @return The MIME type of this intent, or null if it is unknown or not
3263 * needed.
3264 */
3265 public String resolveTypeIfNeeded(ContentResolver resolver) {
3266 if (mComponent != null) {
3267 return mType;
3268 }
3269 return resolveType(resolver);
3270 }
3271
3272 /**
3273 * Check if an category exists in the intent.
3274 *
3275 * @param category The category to check.
3276 *
3277 * @return boolean True if the intent contains the category, else false.
3278 *
3279 * @see #getCategories
3280 * @see #addCategory
3281 */
3282 public boolean hasCategory(String category) {
3283 return mCategories != null && mCategories.contains(category);
3284 }
3285
3286 /**
3287 * Return the set of all categories in the intent. If there are no categories,
3288 * returns NULL.
3289 *
3290 * @return Set The set of categories you can examine. Do not modify!
3291 *
3292 * @see #hasCategory
3293 * @see #addCategory
3294 */
3295 public Set<String> getCategories() {
3296 return mCategories;
3297 }
3298
3299 /**
3300 * Sets the ClassLoader that will be used when unmarshalling
3301 * any Parcelable values from the extras of this Intent.
3302 *
3303 * @param loader a ClassLoader, or null to use the default loader
3304 * at the time of unmarshalling.
3305 */
3306 public void setExtrasClassLoader(ClassLoader loader) {
3307 if (mExtras != null) {
3308 mExtras.setClassLoader(loader);
3309 }
3310 }
3311
3312 /**
3313 * Returns true if an extra value is associated with the given name.
3314 * @param name the extra's name
3315 * @return true if the given extra is present.
3316 */
3317 public boolean hasExtra(String name) {
3318 return mExtras != null && mExtras.containsKey(name);
3319 }
3320
3321 /**
3322 * Returns true if the Intent's extras contain a parcelled file descriptor.
3323 * @return true if the Intent contains a parcelled file descriptor.
3324 */
3325 public boolean hasFileDescriptors() {
3326 return mExtras != null && mExtras.hasFileDescriptors();
3327 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003328
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003329 /**
3330 * Retrieve extended data from the intent.
3331 *
3332 * @param name The name of the desired item.
3333 *
3334 * @return the value of an item that previously added with putExtra()
3335 * or null if none was found.
3336 *
3337 * @deprecated
3338 * @hide
3339 */
3340 @Deprecated
3341 public Object getExtra(String name) {
3342 return getExtra(name, null);
3343 }
3344
3345 /**
3346 * Retrieve extended data from the intent.
3347 *
3348 * @param name The name of the desired item.
3349 * @param defaultValue the value to be returned if no value of the desired
3350 * type is stored with the given name.
3351 *
3352 * @return the value of an item that previously added with putExtra()
3353 * or the default value if none was found.
3354 *
3355 * @see #putExtra(String, boolean)
3356 */
3357 public boolean getBooleanExtra(String name, boolean defaultValue) {
3358 return mExtras == null ? defaultValue :
3359 mExtras.getBoolean(name, defaultValue);
3360 }
3361
3362 /**
3363 * Retrieve extended data from the intent.
3364 *
3365 * @param name The name of the desired item.
3366 * @param defaultValue the value to be returned if no value of the desired
3367 * type is stored with the given name.
3368 *
3369 * @return the value of an item that previously added with putExtra()
3370 * or the default value if none was found.
3371 *
3372 * @see #putExtra(String, byte)
3373 */
3374 public byte getByteExtra(String name, byte defaultValue) {
3375 return mExtras == null ? defaultValue :
3376 mExtras.getByte(name, defaultValue);
3377 }
3378
3379 /**
3380 * Retrieve extended data from the intent.
3381 *
3382 * @param name The name of the desired item.
3383 * @param defaultValue the value to be returned if no value of the desired
3384 * type is stored with the given name.
3385 *
3386 * @return the value of an item that previously added with putExtra()
3387 * or the default value if none was found.
3388 *
3389 * @see #putExtra(String, short)
3390 */
3391 public short getShortExtra(String name, short defaultValue) {
3392 return mExtras == null ? defaultValue :
3393 mExtras.getShort(name, defaultValue);
3394 }
3395
3396 /**
3397 * Retrieve extended data from the intent.
3398 *
3399 * @param name The name of the desired item.
3400 * @param defaultValue the value to be returned if no value of the desired
3401 * type is stored with the given name.
3402 *
3403 * @return the value of an item that previously added with putExtra()
3404 * or the default value if none was found.
3405 *
3406 * @see #putExtra(String, char)
3407 */
3408 public char getCharExtra(String name, char defaultValue) {
3409 return mExtras == null ? defaultValue :
3410 mExtras.getChar(name, defaultValue);
3411 }
3412
3413 /**
3414 * Retrieve extended data from the intent.
3415 *
3416 * @param name The name of the desired item.
3417 * @param defaultValue the value to be returned if no value of the desired
3418 * type is stored with the given name.
3419 *
3420 * @return the value of an item that previously added with putExtra()
3421 * or the default value if none was found.
3422 *
3423 * @see #putExtra(String, int)
3424 */
3425 public int getIntExtra(String name, int defaultValue) {
3426 return mExtras == null ? defaultValue :
3427 mExtras.getInt(name, defaultValue);
3428 }
3429
3430 /**
3431 * Retrieve extended data from the intent.
3432 *
3433 * @param name The name of the desired item.
3434 * @param defaultValue the value to be returned if no value of the desired
3435 * type is stored with the given name.
3436 *
3437 * @return the value of an item that previously added with putExtra()
3438 * or the default value if none was found.
3439 *
3440 * @see #putExtra(String, long)
3441 */
3442 public long getLongExtra(String name, long defaultValue) {
3443 return mExtras == null ? defaultValue :
3444 mExtras.getLong(name, defaultValue);
3445 }
3446
3447 /**
3448 * Retrieve extended data from the intent.
3449 *
3450 * @param name The name of the desired item.
3451 * @param defaultValue the value to be returned if no value of the desired
3452 * type is stored with the given name.
3453 *
3454 * @return the value of an item that previously added with putExtra(),
3455 * or the default value if no such item is present
3456 *
3457 * @see #putExtra(String, float)
3458 */
3459 public float getFloatExtra(String name, float defaultValue) {
3460 return mExtras == null ? defaultValue :
3461 mExtras.getFloat(name, defaultValue);
3462 }
3463
3464 /**
3465 * Retrieve extended data from the intent.
3466 *
3467 * @param name The name of the desired item.
3468 * @param defaultValue the value to be returned if no value of the desired
3469 * type is stored with the given name.
3470 *
3471 * @return the value of an item that previously added with putExtra()
3472 * or the default value if none was found.
3473 *
3474 * @see #putExtra(String, double)
3475 */
3476 public double getDoubleExtra(String name, double defaultValue) {
3477 return mExtras == null ? defaultValue :
3478 mExtras.getDouble(name, defaultValue);
3479 }
3480
3481 /**
3482 * Retrieve extended data from the intent.
3483 *
3484 * @param name The name of the desired item.
3485 *
3486 * @return the value of an item that previously added with putExtra()
3487 * or null if no String value was found.
3488 *
3489 * @see #putExtra(String, String)
3490 */
3491 public String getStringExtra(String name) {
3492 return mExtras == null ? null : mExtras.getString(name);
3493 }
3494
3495 /**
3496 * Retrieve extended data from the intent.
3497 *
3498 * @param name The name of the desired item.
3499 *
3500 * @return the value of an item that previously added with putExtra()
3501 * or null if no CharSequence value was found.
3502 *
3503 * @see #putExtra(String, CharSequence)
3504 */
3505 public CharSequence getCharSequenceExtra(String name) {
3506 return mExtras == null ? null : mExtras.getCharSequence(name);
3507 }
3508
3509 /**
3510 * Retrieve extended data from the intent.
3511 *
3512 * @param name The name of the desired item.
3513 *
3514 * @return the value of an item that previously added with putExtra()
3515 * or null if no Parcelable value was found.
3516 *
3517 * @see #putExtra(String, Parcelable)
3518 */
3519 public <T extends Parcelable> T getParcelableExtra(String name) {
3520 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3521 }
3522
3523 /**
3524 * Retrieve extended data from the intent.
3525 *
3526 * @param name The name of the desired item.
3527 *
3528 * @return the value of an item that previously added with putExtra()
3529 * or null if no Parcelable[] value was found.
3530 *
3531 * @see #putExtra(String, Parcelable[])
3532 */
3533 public Parcelable[] getParcelableArrayExtra(String name) {
3534 return mExtras == null ? null : mExtras.getParcelableArray(name);
3535 }
3536
3537 /**
3538 * Retrieve extended data from the intent.
3539 *
3540 * @param name The name of the desired item.
3541 *
3542 * @return the value of an item that previously added with putExtra()
3543 * or null if no ArrayList<Parcelable> value was found.
3544 *
3545 * @see #putParcelableArrayListExtra(String, ArrayList)
3546 */
3547 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3548 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3549 }
3550
3551 /**
3552 * Retrieve extended data from the intent.
3553 *
3554 * @param name The name of the desired item.
3555 *
3556 * @return the value of an item that previously added with putExtra()
3557 * or null if no Serializable value was found.
3558 *
3559 * @see #putExtra(String, Serializable)
3560 */
3561 public Serializable getSerializableExtra(String name) {
3562 return mExtras == null ? null : mExtras.getSerializable(name);
3563 }
3564
3565 /**
3566 * Retrieve extended data from the intent.
3567 *
3568 * @param name The name of the desired item.
3569 *
3570 * @return the value of an item that previously added with putExtra()
3571 * or null if no ArrayList<Integer> value was found.
3572 *
3573 * @see #putIntegerArrayListExtra(String, ArrayList)
3574 */
3575 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3576 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3577 }
3578
3579 /**
3580 * Retrieve extended data from the intent.
3581 *
3582 * @param name The name of the desired item.
3583 *
3584 * @return the value of an item that previously added with putExtra()
3585 * or null if no ArrayList<String> value was found.
3586 *
3587 * @see #putStringArrayListExtra(String, ArrayList)
3588 */
3589 public ArrayList<String> getStringArrayListExtra(String name) {
3590 return mExtras == null ? null : mExtras.getStringArrayList(name);
3591 }
3592
3593 /**
3594 * Retrieve extended data from the intent.
3595 *
3596 * @param name The name of the desired item.
3597 *
3598 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003599 * or null if no ArrayList<CharSequence> value was found.
3600 *
3601 * @see #putCharSequenceArrayListExtra(String, ArrayList)
3602 */
3603 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
3604 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
3605 }
3606
3607 /**
3608 * Retrieve extended data from the intent.
3609 *
3610 * @param name The name of the desired item.
3611 *
3612 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 * or null if no boolean array value was found.
3614 *
3615 * @see #putExtra(String, boolean[])
3616 */
3617 public boolean[] getBooleanArrayExtra(String name) {
3618 return mExtras == null ? null : mExtras.getBooleanArray(name);
3619 }
3620
3621 /**
3622 * Retrieve extended data from the intent.
3623 *
3624 * @param name The name of the desired item.
3625 *
3626 * @return the value of an item that previously added with putExtra()
3627 * or null if no byte array value was found.
3628 *
3629 * @see #putExtra(String, byte[])
3630 */
3631 public byte[] getByteArrayExtra(String name) {
3632 return mExtras == null ? null : mExtras.getByteArray(name);
3633 }
3634
3635 /**
3636 * Retrieve extended data from the intent.
3637 *
3638 * @param name The name of the desired item.
3639 *
3640 * @return the value of an item that previously added with putExtra()
3641 * or null if no short array value was found.
3642 *
3643 * @see #putExtra(String, short[])
3644 */
3645 public short[] getShortArrayExtra(String name) {
3646 return mExtras == null ? null : mExtras.getShortArray(name);
3647 }
3648
3649 /**
3650 * Retrieve extended data from the intent.
3651 *
3652 * @param name The name of the desired item.
3653 *
3654 * @return the value of an item that previously added with putExtra()
3655 * or null if no char array value was found.
3656 *
3657 * @see #putExtra(String, char[])
3658 */
3659 public char[] getCharArrayExtra(String name) {
3660 return mExtras == null ? null : mExtras.getCharArray(name);
3661 }
3662
3663 /**
3664 * Retrieve extended data from the intent.
3665 *
3666 * @param name The name of the desired item.
3667 *
3668 * @return the value of an item that previously added with putExtra()
3669 * or null if no int array value was found.
3670 *
3671 * @see #putExtra(String, int[])
3672 */
3673 public int[] getIntArrayExtra(String name) {
3674 return mExtras == null ? null : mExtras.getIntArray(name);
3675 }
3676
3677 /**
3678 * Retrieve extended data from the intent.
3679 *
3680 * @param name The name of the desired item.
3681 *
3682 * @return the value of an item that previously added with putExtra()
3683 * or null if no long array value was found.
3684 *
3685 * @see #putExtra(String, long[])
3686 */
3687 public long[] getLongArrayExtra(String name) {
3688 return mExtras == null ? null : mExtras.getLongArray(name);
3689 }
3690
3691 /**
3692 * Retrieve extended data from the intent.
3693 *
3694 * @param name The name of the desired item.
3695 *
3696 * @return the value of an item that previously added with putExtra()
3697 * or null if no float array value was found.
3698 *
3699 * @see #putExtra(String, float[])
3700 */
3701 public float[] getFloatArrayExtra(String name) {
3702 return mExtras == null ? null : mExtras.getFloatArray(name);
3703 }
3704
3705 /**
3706 * Retrieve extended data from the intent.
3707 *
3708 * @param name The name of the desired item.
3709 *
3710 * @return the value of an item that previously added with putExtra()
3711 * or null if no double array value was found.
3712 *
3713 * @see #putExtra(String, double[])
3714 */
3715 public double[] getDoubleArrayExtra(String name) {
3716 return mExtras == null ? null : mExtras.getDoubleArray(name);
3717 }
3718
3719 /**
3720 * Retrieve extended data from the intent.
3721 *
3722 * @param name The name of the desired item.
3723 *
3724 * @return the value of an item that previously added with putExtra()
3725 * or null if no String array value was found.
3726 *
3727 * @see #putExtra(String, String[])
3728 */
3729 public String[] getStringArrayExtra(String name) {
3730 return mExtras == null ? null : mExtras.getStringArray(name);
3731 }
3732
3733 /**
3734 * Retrieve extended data from the intent.
3735 *
3736 * @param name The name of the desired item.
3737 *
3738 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003739 * or null if no CharSequence array value was found.
3740 *
3741 * @see #putExtra(String, CharSequence[])
3742 */
3743 public CharSequence[] getCharSequenceArrayExtra(String name) {
3744 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
3745 }
3746
3747 /**
3748 * Retrieve extended data from the intent.
3749 *
3750 * @param name The name of the desired item.
3751 *
3752 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003753 * or null if no Bundle value was found.
3754 *
3755 * @see #putExtra(String, Bundle)
3756 */
3757 public Bundle getBundleExtra(String name) {
3758 return mExtras == null ? null : mExtras.getBundle(name);
3759 }
3760
3761 /**
3762 * Retrieve extended data from the intent.
3763 *
3764 * @param name The name of the desired item.
3765 *
3766 * @return the value of an item that previously added with putExtra()
3767 * or null if no IBinder value was found.
3768 *
3769 * @see #putExtra(String, IBinder)
3770 *
3771 * @deprecated
3772 * @hide
3773 */
3774 @Deprecated
3775 public IBinder getIBinderExtra(String name) {
3776 return mExtras == null ? null : mExtras.getIBinder(name);
3777 }
3778
3779 /**
3780 * Retrieve extended data from the intent.
3781 *
3782 * @param name The name of the desired item.
3783 * @param defaultValue The default value to return in case no item is
3784 * associated with the key 'name'
3785 *
3786 * @return the value of an item that previously added with putExtra()
3787 * or defaultValue if none was found.
3788 *
3789 * @see #putExtra
3790 *
3791 * @deprecated
3792 * @hide
3793 */
3794 @Deprecated
3795 public Object getExtra(String name, Object defaultValue) {
3796 Object result = defaultValue;
3797 if (mExtras != null) {
3798 Object result2 = mExtras.get(name);
3799 if (result2 != null) {
3800 result = result2;
3801 }
3802 }
3803
3804 return result;
3805 }
3806
3807 /**
3808 * Retrieves a map of extended data from the intent.
3809 *
3810 * @return the map of all extras previously added with putExtra(),
3811 * or null if none have been added.
3812 */
3813 public Bundle getExtras() {
3814 return (mExtras != null)
3815 ? new Bundle(mExtras)
3816 : null;
3817 }
3818
3819 /**
3820 * Retrieve any special flags associated with this intent. You will
3821 * normally just set them with {@link #setFlags} and let the system
3822 * take the appropriate action with them.
3823 *
3824 * @return int The currently set flags.
3825 *
3826 * @see #setFlags
3827 */
3828 public int getFlags() {
3829 return mFlags;
3830 }
3831
3832 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003833 * Retrieve the application package name this Intent is limited to. When
3834 * resolving an Intent, if non-null this limits the resolution to only
3835 * components in the given application package.
3836 *
3837 * @return The name of the application package for the Intent.
3838 *
3839 * @see #resolveActivity
3840 * @see #setPackage
3841 */
3842 public String getPackage() {
3843 return mPackage;
3844 }
3845
3846 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003847 * Retrieve the concrete component associated with the intent. When receiving
3848 * an intent, this is the component that was found to best handle it (that is,
3849 * yourself) and will always be non-null; in all other cases it will be
3850 * null unless explicitly set.
3851 *
3852 * @return The name of the application component to handle the intent.
3853 *
3854 * @see #resolveActivity
3855 * @see #setComponent
3856 */
3857 public ComponentName getComponent() {
3858 return mComponent;
3859 }
3860
3861 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003862 * Get the bounds of the sender of this intent, in screen coordinates. This can be
3863 * used as a hint to the receiver for animations and the like. Null means that there
3864 * is no source bounds.
3865 */
3866 public Rect getSourceBounds() {
3867 return mSourceBounds;
3868 }
3869
3870 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003871 * Return the Activity component that should be used to handle this intent.
3872 * The appropriate component is determined based on the information in the
3873 * intent, evaluated as follows:
3874 *
3875 * <p>If {@link #getComponent} returns an explicit class, that is returned
3876 * without any further consideration.
3877 *
3878 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3879 * category to be considered.
3880 *
3881 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3882 * action.
3883 *
3884 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3885 * this type.
3886 *
3887 * <p>If {@link #addCategory} has added any categories, the activity must
3888 * handle ALL of the categories specified.
3889 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003890 * <p>If {@link #getPackage} is non-NULL, only activity components in
3891 * that application package will be considered.
3892 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003893 * <p>If there are no activities that satisfy all of these conditions, a
3894 * null string is returned.
3895 *
3896 * <p>If multiple activities are found to satisfy the intent, the one with
3897 * the highest priority will be used. If there are multiple activities
3898 * with the same priority, the system will either pick the best activity
3899 * based on user preference, or resolve to a system class that will allow
3900 * the user to pick an activity and forward from there.
3901 *
3902 * <p>This method is implemented simply by calling
3903 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3904 * true.</p>
3905 * <p> This API is called for you as part of starting an activity from an
3906 * intent. You do not normally need to call it yourself.</p>
3907 *
3908 * @param pm The package manager with which to resolve the Intent.
3909 *
3910 * @return Name of the component implementing an activity that can
3911 * display the intent.
3912 *
3913 * @see #setComponent
3914 * @see #getComponent
3915 * @see #resolveActivityInfo
3916 */
3917 public ComponentName resolveActivity(PackageManager pm) {
3918 if (mComponent != null) {
3919 return mComponent;
3920 }
3921
3922 ResolveInfo info = pm.resolveActivity(
3923 this, PackageManager.MATCH_DEFAULT_ONLY);
3924 if (info != null) {
3925 return new ComponentName(
3926 info.activityInfo.applicationInfo.packageName,
3927 info.activityInfo.name);
3928 }
3929
3930 return null;
3931 }
3932
3933 /**
3934 * Resolve the Intent into an {@link ActivityInfo}
3935 * describing the activity that should execute the intent. Resolution
3936 * follows the same rules as described for {@link #resolveActivity}, but
3937 * you get back the completely information about the resolved activity
3938 * instead of just its class name.
3939 *
3940 * @param pm The package manager with which to resolve the Intent.
3941 * @param flags Addition information to retrieve as per
3942 * {@link PackageManager#getActivityInfo(ComponentName, int)
3943 * PackageManager.getActivityInfo()}.
3944 *
3945 * @return PackageManager.ActivityInfo
3946 *
3947 * @see #resolveActivity
3948 */
3949 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3950 ActivityInfo ai = null;
3951 if (mComponent != null) {
3952 try {
3953 ai = pm.getActivityInfo(mComponent, flags);
3954 } catch (PackageManager.NameNotFoundException e) {
3955 // ignore
3956 }
3957 } else {
3958 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003959 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003960 if (info != null) {
3961 ai = info.activityInfo;
3962 }
3963 }
3964
3965 return ai;
3966 }
3967
3968 /**
3969 * Set the general action to be performed.
3970 *
3971 * @param action An action name, such as ACTION_VIEW. Application-specific
3972 * actions should be prefixed with the vendor's package name.
3973 *
3974 * @return Returns the same Intent object, for chaining multiple calls
3975 * into a single statement.
3976 *
3977 * @see #getAction
3978 */
3979 public Intent setAction(String action) {
3980 mAction = action;
3981 return this;
3982 }
3983
3984 /**
3985 * Set the data this intent is operating on. This method automatically
3986 * clears any type that was previously set by {@link #setType}.
3987 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003988 * <p><em>Note: scheme and host name matching in the Android framework is
3989 * case-sensitive, unlike the formal RFC. As a result,
3990 * you should always ensure that you write your Uri with these elements
3991 * using lower case letters, and normalize any Uris you receive from
3992 * outside of Android to ensure the scheme and host is lower case.</em></p>
3993 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003994 * @param data The URI of the data this intent is now targeting.
3995 *
3996 * @return Returns the same Intent object, for chaining multiple calls
3997 * into a single statement.
3998 *
3999 * @see #getData
4000 * @see #setType
4001 * @see #setDataAndType
4002 */
4003 public Intent setData(Uri data) {
4004 mData = data;
4005 mType = null;
4006 return this;
4007 }
4008
4009 /**
4010 * Set an explicit MIME data type. This is used to create intents that
4011 * only specify a type and not data, for example to indicate the type of
4012 * data to return. This method automatically clears any data that was
4013 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07004014 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004015 * <p><em>Note: MIME type matching in the Android framework is
4016 * case-sensitive, unlike formal RFC MIME types. As a result,
4017 * you should always write your MIME types with lower case letters,
4018 * and any MIME types you receive from outside of Android should be
4019 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004020 *
4021 * @param type The MIME type of the data being handled by this intent.
4022 *
4023 * @return Returns the same Intent object, for chaining multiple calls
4024 * into a single statement.
4025 *
4026 * @see #getType
4027 * @see #setData
4028 * @see #setDataAndType
4029 */
4030 public Intent setType(String type) {
4031 mData = null;
4032 mType = type;
4033 return this;
4034 }
4035
4036 /**
4037 * (Usually optional) Set the data for the intent along with an explicit
4038 * MIME data type. This method should very rarely be used -- it allows you
4039 * to override the MIME type that would ordinarily be inferred from the
4040 * data with your own type given here.
4041 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004042 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
4043 * Android framework is case-sensitive, unlike the formal RFC definitions.
4044 * As a result, you should always write these elements with lower case letters,
4045 * and normalize any MIME types or Uris you receive from
4046 * outside of Android to ensure these elements are lower case before
4047 * supplying them here.</em></p>
4048 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004049 * @param data The URI of the data this intent is now targeting.
4050 * @param type The MIME type of the data being handled by this intent.
4051 *
4052 * @return Returns the same Intent object, for chaining multiple calls
4053 * into a single statement.
4054 *
4055 * @see #setData
4056 * @see #setType
4057 */
4058 public Intent setDataAndType(Uri data, String type) {
4059 mData = data;
4060 mType = type;
4061 return this;
4062 }
4063
4064 /**
4065 * Add a new category to the intent. Categories provide additional detail
4066 * about the action the intent is perform. When resolving an intent, only
4067 * activities that provide <em>all</em> of the requested categories will be
4068 * used.
4069 *
4070 * @param category The desired category. This can be either one of the
4071 * predefined Intent categories, or a custom category in your own
4072 * namespace.
4073 *
4074 * @return Returns the same Intent object, for chaining multiple calls
4075 * into a single statement.
4076 *
4077 * @see #hasCategory
4078 * @see #removeCategory
4079 */
4080 public Intent addCategory(String category) {
4081 if (mCategories == null) {
4082 mCategories = new HashSet<String>();
4083 }
4084 mCategories.add(category);
4085 return this;
4086 }
4087
4088 /**
4089 * Remove an category from an intent.
4090 *
4091 * @param category The category to remove.
4092 *
4093 * @see #addCategory
4094 */
4095 public void removeCategory(String category) {
4096 if (mCategories != null) {
4097 mCategories.remove(category);
4098 if (mCategories.size() == 0) {
4099 mCategories = null;
4100 }
4101 }
4102 }
4103
4104 /**
4105 * Add extended data to the intent. The name must include a package
4106 * prefix, for example the app com.android.contacts would use names
4107 * like "com.android.contacts.ShowAll".
4108 *
4109 * @param name The name of the extra data, with package prefix.
4110 * @param value The boolean data value.
4111 *
4112 * @return Returns the same Intent object, for chaining multiple calls
4113 * into a single statement.
4114 *
4115 * @see #putExtras
4116 * @see #removeExtra
4117 * @see #getBooleanExtra(String, boolean)
4118 */
4119 public Intent putExtra(String name, boolean value) {
4120 if (mExtras == null) {
4121 mExtras = new Bundle();
4122 }
4123 mExtras.putBoolean(name, value);
4124 return this;
4125 }
4126
4127 /**
4128 * Add extended data to the intent. The name must include a package
4129 * prefix, for example the app com.android.contacts would use names
4130 * like "com.android.contacts.ShowAll".
4131 *
4132 * @param name The name of the extra data, with package prefix.
4133 * @param value The byte data value.
4134 *
4135 * @return Returns the same Intent object, for chaining multiple calls
4136 * into a single statement.
4137 *
4138 * @see #putExtras
4139 * @see #removeExtra
4140 * @see #getByteExtra(String, byte)
4141 */
4142 public Intent putExtra(String name, byte value) {
4143 if (mExtras == null) {
4144 mExtras = new Bundle();
4145 }
4146 mExtras.putByte(name, value);
4147 return this;
4148 }
4149
4150 /**
4151 * Add extended data to the intent. The name must include a package
4152 * prefix, for example the app com.android.contacts would use names
4153 * like "com.android.contacts.ShowAll".
4154 *
4155 * @param name The name of the extra data, with package prefix.
4156 * @param value The char data value.
4157 *
4158 * @return Returns the same Intent object, for chaining multiple calls
4159 * into a single statement.
4160 *
4161 * @see #putExtras
4162 * @see #removeExtra
4163 * @see #getCharExtra(String, char)
4164 */
4165 public Intent putExtra(String name, char value) {
4166 if (mExtras == null) {
4167 mExtras = new Bundle();
4168 }
4169 mExtras.putChar(name, value);
4170 return this;
4171 }
4172
4173 /**
4174 * Add extended data to the intent. The name must include a package
4175 * prefix, for example the app com.android.contacts would use names
4176 * like "com.android.contacts.ShowAll".
4177 *
4178 * @param name The name of the extra data, with package prefix.
4179 * @param value The short data value.
4180 *
4181 * @return Returns the same Intent object, for chaining multiple calls
4182 * into a single statement.
4183 *
4184 * @see #putExtras
4185 * @see #removeExtra
4186 * @see #getShortExtra(String, short)
4187 */
4188 public Intent putExtra(String name, short value) {
4189 if (mExtras == null) {
4190 mExtras = new Bundle();
4191 }
4192 mExtras.putShort(name, value);
4193 return this;
4194 }
4195
4196 /**
4197 * Add extended data to the intent. The name must include a package
4198 * prefix, for example the app com.android.contacts would use names
4199 * like "com.android.contacts.ShowAll".
4200 *
4201 * @param name The name of the extra data, with package prefix.
4202 * @param value The integer data value.
4203 *
4204 * @return Returns the same Intent object, for chaining multiple calls
4205 * into a single statement.
4206 *
4207 * @see #putExtras
4208 * @see #removeExtra
4209 * @see #getIntExtra(String, int)
4210 */
4211 public Intent putExtra(String name, int value) {
4212 if (mExtras == null) {
4213 mExtras = new Bundle();
4214 }
4215 mExtras.putInt(name, value);
4216 return this;
4217 }
4218
4219 /**
4220 * Add extended data to the intent. The name must include a package
4221 * prefix, for example the app com.android.contacts would use names
4222 * like "com.android.contacts.ShowAll".
4223 *
4224 * @param name The name of the extra data, with package prefix.
4225 * @param value The long data value.
4226 *
4227 * @return Returns the same Intent object, for chaining multiple calls
4228 * into a single statement.
4229 *
4230 * @see #putExtras
4231 * @see #removeExtra
4232 * @see #getLongExtra(String, long)
4233 */
4234 public Intent putExtra(String name, long value) {
4235 if (mExtras == null) {
4236 mExtras = new Bundle();
4237 }
4238 mExtras.putLong(name, value);
4239 return this;
4240 }
4241
4242 /**
4243 * Add extended data to the intent. The name must include a package
4244 * prefix, for example the app com.android.contacts would use names
4245 * like "com.android.contacts.ShowAll".
4246 *
4247 * @param name The name of the extra data, with package prefix.
4248 * @param value The float data value.
4249 *
4250 * @return Returns the same Intent object, for chaining multiple calls
4251 * into a single statement.
4252 *
4253 * @see #putExtras
4254 * @see #removeExtra
4255 * @see #getFloatExtra(String, float)
4256 */
4257 public Intent putExtra(String name, float value) {
4258 if (mExtras == null) {
4259 mExtras = new Bundle();
4260 }
4261 mExtras.putFloat(name, value);
4262 return this;
4263 }
4264
4265 /**
4266 * Add extended data to the intent. The name must include a package
4267 * prefix, for example the app com.android.contacts would use names
4268 * like "com.android.contacts.ShowAll".
4269 *
4270 * @param name The name of the extra data, with package prefix.
4271 * @param value The double data value.
4272 *
4273 * @return Returns the same Intent object, for chaining multiple calls
4274 * into a single statement.
4275 *
4276 * @see #putExtras
4277 * @see #removeExtra
4278 * @see #getDoubleExtra(String, double)
4279 */
4280 public Intent putExtra(String name, double value) {
4281 if (mExtras == null) {
4282 mExtras = new Bundle();
4283 }
4284 mExtras.putDouble(name, value);
4285 return this;
4286 }
4287
4288 /**
4289 * Add extended data to the intent. The name must include a package
4290 * prefix, for example the app com.android.contacts would use names
4291 * like "com.android.contacts.ShowAll".
4292 *
4293 * @param name The name of the extra data, with package prefix.
4294 * @param value The String data value.
4295 *
4296 * @return Returns the same Intent object, for chaining multiple calls
4297 * into a single statement.
4298 *
4299 * @see #putExtras
4300 * @see #removeExtra
4301 * @see #getStringExtra(String)
4302 */
4303 public Intent putExtra(String name, String value) {
4304 if (mExtras == null) {
4305 mExtras = new Bundle();
4306 }
4307 mExtras.putString(name, value);
4308 return this;
4309 }
4310
4311 /**
4312 * Add extended data to the intent. The name must include a package
4313 * prefix, for example the app com.android.contacts would use names
4314 * like "com.android.contacts.ShowAll".
4315 *
4316 * @param name The name of the extra data, with package prefix.
4317 * @param value The CharSequence data value.
4318 *
4319 * @return Returns the same Intent object, for chaining multiple calls
4320 * into a single statement.
4321 *
4322 * @see #putExtras
4323 * @see #removeExtra
4324 * @see #getCharSequenceExtra(String)
4325 */
4326 public Intent putExtra(String name, CharSequence value) {
4327 if (mExtras == null) {
4328 mExtras = new Bundle();
4329 }
4330 mExtras.putCharSequence(name, value);
4331 return this;
4332 }
4333
4334 /**
4335 * Add extended data to the intent. The name must include a package
4336 * prefix, for example the app com.android.contacts would use names
4337 * like "com.android.contacts.ShowAll".
4338 *
4339 * @param name The name of the extra data, with package prefix.
4340 * @param value The Parcelable data value.
4341 *
4342 * @return Returns the same Intent object, for chaining multiple calls
4343 * into a single statement.
4344 *
4345 * @see #putExtras
4346 * @see #removeExtra
4347 * @see #getParcelableExtra(String)
4348 */
4349 public Intent putExtra(String name, Parcelable value) {
4350 if (mExtras == null) {
4351 mExtras = new Bundle();
4352 }
4353 mExtras.putParcelable(name, value);
4354 return this;
4355 }
4356
4357 /**
4358 * Add extended data to the intent. The name must include a package
4359 * prefix, for example the app com.android.contacts would use names
4360 * like "com.android.contacts.ShowAll".
4361 *
4362 * @param name The name of the extra data, with package prefix.
4363 * @param value The Parcelable[] data value.
4364 *
4365 * @return Returns the same Intent object, for chaining multiple calls
4366 * into a single statement.
4367 *
4368 * @see #putExtras
4369 * @see #removeExtra
4370 * @see #getParcelableArrayExtra(String)
4371 */
4372 public Intent putExtra(String name, Parcelable[] value) {
4373 if (mExtras == null) {
4374 mExtras = new Bundle();
4375 }
4376 mExtras.putParcelableArray(name, value);
4377 return this;
4378 }
4379
4380 /**
4381 * Add extended data to the intent. The name must include a package
4382 * prefix, for example the app com.android.contacts would use names
4383 * like "com.android.contacts.ShowAll".
4384 *
4385 * @param name The name of the extra data, with package prefix.
4386 * @param value The ArrayList<Parcelable> data value.
4387 *
4388 * @return Returns the same Intent object, for chaining multiple calls
4389 * into a single statement.
4390 *
4391 * @see #putExtras
4392 * @see #removeExtra
4393 * @see #getParcelableArrayListExtra(String)
4394 */
4395 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4396 if (mExtras == null) {
4397 mExtras = new Bundle();
4398 }
4399 mExtras.putParcelableArrayList(name, value);
4400 return this;
4401 }
4402
4403 /**
4404 * Add extended data to the intent. The name must include a package
4405 * prefix, for example the app com.android.contacts would use names
4406 * like "com.android.contacts.ShowAll".
4407 *
4408 * @param name The name of the extra data, with package prefix.
4409 * @param value The ArrayList<Integer> data value.
4410 *
4411 * @return Returns the same Intent object, for chaining multiple calls
4412 * into a single statement.
4413 *
4414 * @see #putExtras
4415 * @see #removeExtra
4416 * @see #getIntegerArrayListExtra(String)
4417 */
4418 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4419 if (mExtras == null) {
4420 mExtras = new Bundle();
4421 }
4422 mExtras.putIntegerArrayList(name, value);
4423 return this;
4424 }
4425
4426 /**
4427 * Add extended data to the intent. The name must include a package
4428 * prefix, for example the app com.android.contacts would use names
4429 * like "com.android.contacts.ShowAll".
4430 *
4431 * @param name The name of the extra data, with package prefix.
4432 * @param value The ArrayList<String> data value.
4433 *
4434 * @return Returns the same Intent object, for chaining multiple calls
4435 * into a single statement.
4436 *
4437 * @see #putExtras
4438 * @see #removeExtra
4439 * @see #getStringArrayListExtra(String)
4440 */
4441 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4442 if (mExtras == null) {
4443 mExtras = new Bundle();
4444 }
4445 mExtras.putStringArrayList(name, value);
4446 return this;
4447 }
4448
4449 /**
4450 * Add extended data to the intent. The name must include a package
4451 * prefix, for example the app com.android.contacts would use names
4452 * like "com.android.contacts.ShowAll".
4453 *
4454 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004455 * @param value The ArrayList<CharSequence> data value.
4456 *
4457 * @return Returns the same Intent object, for chaining multiple calls
4458 * into a single statement.
4459 *
4460 * @see #putExtras
4461 * @see #removeExtra
4462 * @see #getCharSequenceArrayListExtra(String)
4463 */
4464 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
4465 if (mExtras == null) {
4466 mExtras = new Bundle();
4467 }
4468 mExtras.putCharSequenceArrayList(name, value);
4469 return this;
4470 }
4471
4472 /**
4473 * Add extended data to the intent. The name must include a package
4474 * prefix, for example the app com.android.contacts would use names
4475 * like "com.android.contacts.ShowAll".
4476 *
4477 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004478 * @param value The Serializable data value.
4479 *
4480 * @return Returns the same Intent object, for chaining multiple calls
4481 * into a single statement.
4482 *
4483 * @see #putExtras
4484 * @see #removeExtra
4485 * @see #getSerializableExtra(String)
4486 */
4487 public Intent putExtra(String name, Serializable value) {
4488 if (mExtras == null) {
4489 mExtras = new Bundle();
4490 }
4491 mExtras.putSerializable(name, value);
4492 return this;
4493 }
4494
4495 /**
4496 * Add extended data to the intent. The name must include a package
4497 * prefix, for example the app com.android.contacts would use names
4498 * like "com.android.contacts.ShowAll".
4499 *
4500 * @param name The name of the extra data, with package prefix.
4501 * @param value The boolean array data value.
4502 *
4503 * @return Returns the same Intent object, for chaining multiple calls
4504 * into a single statement.
4505 *
4506 * @see #putExtras
4507 * @see #removeExtra
4508 * @see #getBooleanArrayExtra(String)
4509 */
4510 public Intent putExtra(String name, boolean[] value) {
4511 if (mExtras == null) {
4512 mExtras = new Bundle();
4513 }
4514 mExtras.putBooleanArray(name, value);
4515 return this;
4516 }
4517
4518 /**
4519 * Add extended data to the intent. The name must include a package
4520 * prefix, for example the app com.android.contacts would use names
4521 * like "com.android.contacts.ShowAll".
4522 *
4523 * @param name The name of the extra data, with package prefix.
4524 * @param value The byte array data value.
4525 *
4526 * @return Returns the same Intent object, for chaining multiple calls
4527 * into a single statement.
4528 *
4529 * @see #putExtras
4530 * @see #removeExtra
4531 * @see #getByteArrayExtra(String)
4532 */
4533 public Intent putExtra(String name, byte[] value) {
4534 if (mExtras == null) {
4535 mExtras = new Bundle();
4536 }
4537 mExtras.putByteArray(name, value);
4538 return this;
4539 }
4540
4541 /**
4542 * Add extended data to the intent. The name must include a package
4543 * prefix, for example the app com.android.contacts would use names
4544 * like "com.android.contacts.ShowAll".
4545 *
4546 * @param name The name of the extra data, with package prefix.
4547 * @param value The short array data value.
4548 *
4549 * @return Returns the same Intent object, for chaining multiple calls
4550 * into a single statement.
4551 *
4552 * @see #putExtras
4553 * @see #removeExtra
4554 * @see #getShortArrayExtra(String)
4555 */
4556 public Intent putExtra(String name, short[] value) {
4557 if (mExtras == null) {
4558 mExtras = new Bundle();
4559 }
4560 mExtras.putShortArray(name, value);
4561 return this;
4562 }
4563
4564 /**
4565 * Add extended data to the intent. The name must include a package
4566 * prefix, for example the app com.android.contacts would use names
4567 * like "com.android.contacts.ShowAll".
4568 *
4569 * @param name The name of the extra data, with package prefix.
4570 * @param value The char array data value.
4571 *
4572 * @return Returns the same Intent object, for chaining multiple calls
4573 * into a single statement.
4574 *
4575 * @see #putExtras
4576 * @see #removeExtra
4577 * @see #getCharArrayExtra(String)
4578 */
4579 public Intent putExtra(String name, char[] value) {
4580 if (mExtras == null) {
4581 mExtras = new Bundle();
4582 }
4583 mExtras.putCharArray(name, value);
4584 return this;
4585 }
4586
4587 /**
4588 * Add extended data to the intent. The name must include a package
4589 * prefix, for example the app com.android.contacts would use names
4590 * like "com.android.contacts.ShowAll".
4591 *
4592 * @param name The name of the extra data, with package prefix.
4593 * @param value The int array data value.
4594 *
4595 * @return Returns the same Intent object, for chaining multiple calls
4596 * into a single statement.
4597 *
4598 * @see #putExtras
4599 * @see #removeExtra
4600 * @see #getIntArrayExtra(String)
4601 */
4602 public Intent putExtra(String name, int[] value) {
4603 if (mExtras == null) {
4604 mExtras = new Bundle();
4605 }
4606 mExtras.putIntArray(name, value);
4607 return this;
4608 }
4609
4610 /**
4611 * Add extended data to the intent. The name must include a package
4612 * prefix, for example the app com.android.contacts would use names
4613 * like "com.android.contacts.ShowAll".
4614 *
4615 * @param name The name of the extra data, with package prefix.
4616 * @param value The byte array data value.
4617 *
4618 * @return Returns the same Intent object, for chaining multiple calls
4619 * into a single statement.
4620 *
4621 * @see #putExtras
4622 * @see #removeExtra
4623 * @see #getLongArrayExtra(String)
4624 */
4625 public Intent putExtra(String name, long[] value) {
4626 if (mExtras == null) {
4627 mExtras = new Bundle();
4628 }
4629 mExtras.putLongArray(name, value);
4630 return this;
4631 }
4632
4633 /**
4634 * Add extended data to the intent. The name must include a package
4635 * prefix, for example the app com.android.contacts would use names
4636 * like "com.android.contacts.ShowAll".
4637 *
4638 * @param name The name of the extra data, with package prefix.
4639 * @param value The float array data value.
4640 *
4641 * @return Returns the same Intent object, for chaining multiple calls
4642 * into a single statement.
4643 *
4644 * @see #putExtras
4645 * @see #removeExtra
4646 * @see #getFloatArrayExtra(String)
4647 */
4648 public Intent putExtra(String name, float[] value) {
4649 if (mExtras == null) {
4650 mExtras = new Bundle();
4651 }
4652 mExtras.putFloatArray(name, value);
4653 return this;
4654 }
4655
4656 /**
4657 * Add extended data to the intent. The name must include a package
4658 * prefix, for example the app com.android.contacts would use names
4659 * like "com.android.contacts.ShowAll".
4660 *
4661 * @param name The name of the extra data, with package prefix.
4662 * @param value The double array data value.
4663 *
4664 * @return Returns the same Intent object, for chaining multiple calls
4665 * into a single statement.
4666 *
4667 * @see #putExtras
4668 * @see #removeExtra
4669 * @see #getDoubleArrayExtra(String)
4670 */
4671 public Intent putExtra(String name, double[] value) {
4672 if (mExtras == null) {
4673 mExtras = new Bundle();
4674 }
4675 mExtras.putDoubleArray(name, value);
4676 return this;
4677 }
4678
4679 /**
4680 * Add extended data to the intent. The name must include a package
4681 * prefix, for example the app com.android.contacts would use names
4682 * like "com.android.contacts.ShowAll".
4683 *
4684 * @param name The name of the extra data, with package prefix.
4685 * @param value The String array data value.
4686 *
4687 * @return Returns the same Intent object, for chaining multiple calls
4688 * into a single statement.
4689 *
4690 * @see #putExtras
4691 * @see #removeExtra
4692 * @see #getStringArrayExtra(String)
4693 */
4694 public Intent putExtra(String name, String[] value) {
4695 if (mExtras == null) {
4696 mExtras = new Bundle();
4697 }
4698 mExtras.putStringArray(name, value);
4699 return this;
4700 }
4701
4702 /**
4703 * Add extended data to the intent. The name must include a package
4704 * prefix, for example the app com.android.contacts would use names
4705 * like "com.android.contacts.ShowAll".
4706 *
4707 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004708 * @param value The CharSequence array data value.
4709 *
4710 * @return Returns the same Intent object, for chaining multiple calls
4711 * into a single statement.
4712 *
4713 * @see #putExtras
4714 * @see #removeExtra
4715 * @see #getCharSequenceArrayExtra(String)
4716 */
4717 public Intent putExtra(String name, CharSequence[] value) {
4718 if (mExtras == null) {
4719 mExtras = new Bundle();
4720 }
4721 mExtras.putCharSequenceArray(name, value);
4722 return this;
4723 }
4724
4725 /**
4726 * Add extended data to the intent. The name must include a package
4727 * prefix, for example the app com.android.contacts would use names
4728 * like "com.android.contacts.ShowAll".
4729 *
4730 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004731 * @param value The Bundle data value.
4732 *
4733 * @return Returns the same Intent object, for chaining multiple calls
4734 * into a single statement.
4735 *
4736 * @see #putExtras
4737 * @see #removeExtra
4738 * @see #getBundleExtra(String)
4739 */
4740 public Intent putExtra(String name, Bundle value) {
4741 if (mExtras == null) {
4742 mExtras = new Bundle();
4743 }
4744 mExtras.putBundle(name, value);
4745 return this;
4746 }
4747
4748 /**
4749 * Add extended data to the intent. The name must include a package
4750 * prefix, for example the app com.android.contacts would use names
4751 * like "com.android.contacts.ShowAll".
4752 *
4753 * @param name The name of the extra data, with package prefix.
4754 * @param value The IBinder data value.
4755 *
4756 * @return Returns the same Intent object, for chaining multiple calls
4757 * into a single statement.
4758 *
4759 * @see #putExtras
4760 * @see #removeExtra
4761 * @see #getIBinderExtra(String)
4762 *
4763 * @deprecated
4764 * @hide
4765 */
4766 @Deprecated
4767 public Intent putExtra(String name, IBinder value) {
4768 if (mExtras == null) {
4769 mExtras = new Bundle();
4770 }
4771 mExtras.putIBinder(name, value);
4772 return this;
4773 }
4774
4775 /**
4776 * Copy all extras in 'src' in to this intent.
4777 *
4778 * @param src Contains the extras to copy.
4779 *
4780 * @see #putExtra
4781 */
4782 public Intent putExtras(Intent src) {
4783 if (src.mExtras != null) {
4784 if (mExtras == null) {
4785 mExtras = new Bundle(src.mExtras);
4786 } else {
4787 mExtras.putAll(src.mExtras);
4788 }
4789 }
4790 return this;
4791 }
4792
4793 /**
4794 * Add a set of extended data to the intent. The keys must include a package
4795 * prefix, for example the app com.android.contacts would use names
4796 * like "com.android.contacts.ShowAll".
4797 *
4798 * @param extras The Bundle of extras to add to this intent.
4799 *
4800 * @see #putExtra
4801 * @see #removeExtra
4802 */
4803 public Intent putExtras(Bundle extras) {
4804 if (mExtras == null) {
4805 mExtras = new Bundle();
4806 }
4807 mExtras.putAll(extras);
4808 return this;
4809 }
4810
4811 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004812 * Completely replace the extras in the Intent with the extras in the
4813 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004814 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004815 * @param src The exact extras contained in this Intent are copied
4816 * into the target intent, replacing any that were previously there.
4817 */
4818 public Intent replaceExtras(Intent src) {
4819 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4820 return this;
4821 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004822
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004823 /**
4824 * Completely replace the extras in the Intent with the given Bundle of
4825 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004826 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004827 * @param extras The new set of extras in the Intent, or null to erase
4828 * all extras.
4829 */
4830 public Intent replaceExtras(Bundle extras) {
4831 mExtras = extras != null ? new Bundle(extras) : null;
4832 return this;
4833 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004834
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004835 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004836 * Remove extended data from the intent.
4837 *
4838 * @see #putExtra
4839 */
4840 public void removeExtra(String name) {
4841 if (mExtras != null) {
4842 mExtras.remove(name);
4843 if (mExtras.size() == 0) {
4844 mExtras = null;
4845 }
4846 }
4847 }
4848
4849 /**
4850 * Set special flags controlling how this intent is handled. Most values
4851 * here depend on the type of component being executed by the Intent,
4852 * specifically the FLAG_ACTIVITY_* flags are all for use with
4853 * {@link Context#startActivity Context.startActivity()} and the
4854 * FLAG_RECEIVER_* flags are all for use with
4855 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4856 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004857 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4858 * 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 -07004859 * the behavior of your application.
4860 *
4861 * @param flags The desired flags.
4862 *
4863 * @return Returns the same Intent object, for chaining multiple calls
4864 * into a single statement.
4865 *
4866 * @see #getFlags
4867 * @see #addFlags
4868 *
4869 * @see #FLAG_GRANT_READ_URI_PERMISSION
4870 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4871 * @see #FLAG_DEBUG_LOG_RESOLUTION
4872 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004873 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004874 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004875 * @see #FLAG_ACTIVITY_CLEAR_TOP
4876 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4877 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004878 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004879 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4880 * @see #FLAG_ACTIVITY_NEW_TASK
4881 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004882 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004883 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4884 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004885 * @see #FLAG_ACTIVITY_SINGLE_TOP
4886 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4887 */
4888 public Intent setFlags(int flags) {
4889 mFlags = flags;
4890 return this;
4891 }
4892
4893 /**
4894 * Add additional flags to the intent (or with existing flags
4895 * value).
4896 *
4897 * @param flags The new flags to set.
4898 *
4899 * @return Returns the same Intent object, for chaining multiple calls
4900 * into a single statement.
4901 *
4902 * @see #setFlags
4903 */
4904 public Intent addFlags(int flags) {
4905 mFlags |= flags;
4906 return this;
4907 }
4908
4909 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004910 * (Usually optional) Set an explicit application package name that limits
4911 * the components this Intent will resolve to. If left to the default
4912 * value of null, all components in all applications will considered.
4913 * If non-null, the Intent can only match the components in the given
4914 * application package.
4915 *
4916 * @param packageName The name of the application package to handle the
4917 * intent, or null to allow any application package.
4918 *
4919 * @return Returns the same Intent object, for chaining multiple calls
4920 * into a single statement.
4921 *
4922 * @see #getPackage
4923 * @see #resolveActivity
4924 */
4925 public Intent setPackage(String packageName) {
4926 mPackage = packageName;
4927 return this;
4928 }
4929
4930 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004931 * (Usually optional) Explicitly set the component to handle the intent.
4932 * If left with the default value of null, the system will determine the
4933 * appropriate class to use based on the other fields (action, data,
4934 * type, categories) in the Intent. If this class is defined, the
4935 * specified class will always be used regardless of the other fields. You
4936 * should only set this value when you know you absolutely want a specific
4937 * class to be used; otherwise it is better to let the system find the
4938 * appropriate class so that you will respect the installed applications
4939 * and user preferences.
4940 *
4941 * @param component The name of the application component to handle the
4942 * intent, or null to let the system find one for you.
4943 *
4944 * @return Returns the same Intent object, for chaining multiple calls
4945 * into a single statement.
4946 *
4947 * @see #setClass
4948 * @see #setClassName(Context, String)
4949 * @see #setClassName(String, String)
4950 * @see #getComponent
4951 * @see #resolveActivity
4952 */
4953 public Intent setComponent(ComponentName component) {
4954 mComponent = component;
4955 return this;
4956 }
4957
4958 /**
4959 * Convenience for calling {@link #setComponent} with an
4960 * explicit class name.
4961 *
4962 * @param packageContext A Context of the application package implementing
4963 * this class.
4964 * @param className The name of a class inside of the application package
4965 * that will be used as the component for this Intent.
4966 *
4967 * @return Returns the same Intent object, for chaining multiple calls
4968 * into a single statement.
4969 *
4970 * @see #setComponent
4971 * @see #setClass
4972 */
4973 public Intent setClassName(Context packageContext, String className) {
4974 mComponent = new ComponentName(packageContext, className);
4975 return this;
4976 }
4977
4978 /**
4979 * Convenience for calling {@link #setComponent} with an
4980 * explicit application package name and class name.
4981 *
4982 * @param packageName The name of the package implementing the desired
4983 * component.
4984 * @param className The name of a class inside of the application package
4985 * that will be used as the component for this Intent.
4986 *
4987 * @return Returns the same Intent object, for chaining multiple calls
4988 * into a single statement.
4989 *
4990 * @see #setComponent
4991 * @see #setClass
4992 */
4993 public Intent setClassName(String packageName, String className) {
4994 mComponent = new ComponentName(packageName, className);
4995 return this;
4996 }
4997
4998 /**
4999 * Convenience for calling {@link #setComponent(ComponentName)} with the
5000 * name returned by a {@link Class} object.
5001 *
5002 * @param packageContext A Context of the application package implementing
5003 * this class.
5004 * @param cls The class name to set, equivalent to
5005 * <code>setClassName(context, cls.getName())</code>.
5006 *
5007 * @return Returns the same Intent object, for chaining multiple calls
5008 * into a single statement.
5009 *
5010 * @see #setComponent
5011 */
5012 public Intent setClass(Context packageContext, Class<?> cls) {
5013 mComponent = new ComponentName(packageContext, cls);
5014 return this;
5015 }
5016
5017 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005018 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5019 * used as a hint to the receiver for animations and the like. Null means that there
5020 * is no source bounds.
5021 */
5022 public void setSourceBounds(Rect r) {
5023 if (r != null) {
5024 mSourceBounds = new Rect(r);
5025 } else {
5026 r = null;
5027 }
5028 }
5029
5030 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005031 * Use with {@link #fillIn} to allow the current action value to be
5032 * overwritten, even if it is already set.
5033 */
5034 public static final int FILL_IN_ACTION = 1<<0;
5035
5036 /**
5037 * Use with {@link #fillIn} to allow the current data or type value
5038 * overwritten, even if it is already set.
5039 */
5040 public static final int FILL_IN_DATA = 1<<1;
5041
5042 /**
5043 * Use with {@link #fillIn} to allow the current categories to be
5044 * overwritten, even if they are already set.
5045 */
5046 public static final int FILL_IN_CATEGORIES = 1<<2;
5047
5048 /**
5049 * Use with {@link #fillIn} to allow the current component value to be
5050 * overwritten, even if it is already set.
5051 */
5052 public static final int FILL_IN_COMPONENT = 1<<3;
5053
5054 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005055 * Use with {@link #fillIn} to allow the current package value to be
5056 * overwritten, even if it is already set.
5057 */
5058 public static final int FILL_IN_PACKAGE = 1<<4;
5059
5060 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005061 * Use with {@link #fillIn} to allow the current package value to be
5062 * overwritten, even if it is already set.
5063 */
5064 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5065
5066 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005067 * Copy the contents of <var>other</var> in to this object, but only
5068 * where fields are not defined by this object. For purposes of a field
5069 * being defined, the following pieces of data in the Intent are
5070 * considered to be separate fields:
5071 *
5072 * <ul>
5073 * <li> action, as set by {@link #setAction}.
5074 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
5075 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5076 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005077 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005078 * <li> component, as set by {@link #setComponent(ComponentName)} or
5079 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005080 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005081 * <li> each top-level name in the associated extras.
5082 * </ul>
5083 *
5084 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005085 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5086 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005087 * corresponding field will not be replaced if it is already set.
5088 *
Brett Chabot3e391752009-07-21 16:07:23 -07005089 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
5090 * specified.
5091 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005092 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5093 * and Intent B with {action="gotit", data-type="some/thing",
5094 * categories="one","two"}.
5095 *
5096 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5097 * containing: {action="gotit", data-type="some/thing",
5098 * categories="bar"}.
5099 *
5100 * @param other Another Intent whose values are to be used to fill in
5101 * the current one.
5102 * @param flags Options to control which fields can be filled in.
5103 *
5104 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005105 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5106 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005107 */
5108 public int fillIn(Intent other, int flags) {
5109 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005110 if (other.mAction != null
5111 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005112 mAction = other.mAction;
5113 changes |= FILL_IN_ACTION;
5114 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005115 if ((other.mData != null || other.mType != null)
5116 && ((mData == null && mType == null)
5117 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005118 mData = other.mData;
5119 mType = other.mType;
5120 changes |= FILL_IN_DATA;
5121 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005122 if (other.mCategories != null
5123 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005124 if (other.mCategories != null) {
5125 mCategories = new HashSet<String>(other.mCategories);
5126 }
5127 changes |= FILL_IN_CATEGORIES;
5128 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005129 if (other.mPackage != null
5130 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
5131 mPackage = other.mPackage;
5132 changes |= FILL_IN_PACKAGE;
5133 }
5134 // Component is special: it can -only- be set if explicitly allowed,
5135 // since otherwise the sender could force the intent somewhere the
5136 // originator didn't intend.
5137 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005138 mComponent = other.mComponent;
5139 changes |= FILL_IN_COMPONENT;
5140 }
5141 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005142 if (other.mSourceBounds != null
5143 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5144 mSourceBounds = new Rect(other.mSourceBounds);
5145 changes |= FILL_IN_SOURCE_BOUNDS;
5146 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005147 if (mExtras == null) {
5148 if (other.mExtras != null) {
5149 mExtras = new Bundle(other.mExtras);
5150 }
5151 } else if (other.mExtras != null) {
5152 try {
5153 Bundle newb = new Bundle(other.mExtras);
5154 newb.putAll(mExtras);
5155 mExtras = newb;
5156 } catch (RuntimeException e) {
5157 // Modifying the extras can cause us to unparcel the contents
5158 // of the bundle, and if we do this in the system process that
5159 // may fail. We really should handle this (i.e., the Bundle
5160 // impl shouldn't be on top of a plain map), but for now just
5161 // ignore it and keep the original contents. :(
5162 Log.w("Intent", "Failure filling in extras", e);
5163 }
5164 }
5165 return changes;
5166 }
5167
5168 /**
5169 * Wrapper class holding an Intent and implementing comparisons on it for
5170 * the purpose of filtering. The class implements its
5171 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5172 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5173 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5174 * on the wrapped Intent.
5175 */
5176 public static final class FilterComparison {
5177 private final Intent mIntent;
5178 private final int mHashCode;
5179
5180 public FilterComparison(Intent intent) {
5181 mIntent = intent;
5182 mHashCode = intent.filterHashCode();
5183 }
5184
5185 /**
5186 * Return the Intent that this FilterComparison represents.
5187 * @return Returns the Intent held by the FilterComparison. Do
5188 * not modify!
5189 */
5190 public Intent getIntent() {
5191 return mIntent;
5192 }
5193
5194 @Override
5195 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005196 if (obj instanceof FilterComparison) {
5197 Intent other = ((FilterComparison)obj).mIntent;
5198 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005199 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005200 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005201 }
5202
5203 @Override
5204 public int hashCode() {
5205 return mHashCode;
5206 }
5207 }
5208
5209 /**
5210 * Determine if two intents are the same for the purposes of intent
5211 * resolution (filtering). That is, if their action, data, type,
5212 * class, and categories are the same. This does <em>not</em> compare
5213 * any extra data included in the intents.
5214 *
5215 * @param other The other Intent to compare against.
5216 *
5217 * @return Returns true if action, data, type, class, and categories
5218 * are the same.
5219 */
5220 public boolean filterEquals(Intent other) {
5221 if (other == null) {
5222 return false;
5223 }
5224 if (mAction != other.mAction) {
5225 if (mAction != null) {
5226 if (!mAction.equals(other.mAction)) {
5227 return false;
5228 }
5229 } else {
5230 if (!other.mAction.equals(mAction)) {
5231 return false;
5232 }
5233 }
5234 }
5235 if (mData != other.mData) {
5236 if (mData != null) {
5237 if (!mData.equals(other.mData)) {
5238 return false;
5239 }
5240 } else {
5241 if (!other.mData.equals(mData)) {
5242 return false;
5243 }
5244 }
5245 }
5246 if (mType != other.mType) {
5247 if (mType != null) {
5248 if (!mType.equals(other.mType)) {
5249 return false;
5250 }
5251 } else {
5252 if (!other.mType.equals(mType)) {
5253 return false;
5254 }
5255 }
5256 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005257 if (mPackage != other.mPackage) {
5258 if (mPackage != null) {
5259 if (!mPackage.equals(other.mPackage)) {
5260 return false;
5261 }
5262 } else {
5263 if (!other.mPackage.equals(mPackage)) {
5264 return false;
5265 }
5266 }
5267 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005268 if (mComponent != other.mComponent) {
5269 if (mComponent != null) {
5270 if (!mComponent.equals(other.mComponent)) {
5271 return false;
5272 }
5273 } else {
5274 if (!other.mComponent.equals(mComponent)) {
5275 return false;
5276 }
5277 }
5278 }
5279 if (mCategories != other.mCategories) {
5280 if (mCategories != null) {
5281 if (!mCategories.equals(other.mCategories)) {
5282 return false;
5283 }
5284 } else {
5285 if (!other.mCategories.equals(mCategories)) {
5286 return false;
5287 }
5288 }
5289 }
5290
5291 return true;
5292 }
5293
5294 /**
5295 * Generate hash code that matches semantics of filterEquals().
5296 *
5297 * @return Returns the hash value of the action, data, type, class, and
5298 * categories.
5299 *
5300 * @see #filterEquals
5301 */
5302 public int filterHashCode() {
5303 int code = 0;
5304 if (mAction != null) {
5305 code += mAction.hashCode();
5306 }
5307 if (mData != null) {
5308 code += mData.hashCode();
5309 }
5310 if (mType != null) {
5311 code += mType.hashCode();
5312 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005313 if (mPackage != null) {
5314 code += mPackage.hashCode();
5315 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005316 if (mComponent != null) {
5317 code += mComponent.hashCode();
5318 }
5319 if (mCategories != null) {
5320 code += mCategories.hashCode();
5321 }
5322 return code;
5323 }
5324
5325 @Override
5326 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005327 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005328
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005329 b.append("Intent { ");
5330 toShortString(b, true, true);
5331 b.append(" }");
5332
5333 return b.toString();
5334 }
5335
5336 /** @hide */
5337 public String toShortString(boolean comp, boolean extras) {
5338 StringBuilder b = new StringBuilder(128);
5339 toShortString(b, comp, extras);
5340 return b.toString();
5341 }
Romain Guy4969af72009-06-17 10:53:19 -07005342
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005343 /** @hide */
5344 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
5345 boolean first = true;
5346 if (mAction != null) {
5347 b.append("act=").append(mAction);
5348 first = false;
5349 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005350 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005351 if (!first) {
5352 b.append(' ');
5353 }
5354 first = false;
5355 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005356 Iterator<String> i = mCategories.iterator();
5357 boolean didone = false;
5358 while (i.hasNext()) {
5359 if (didone) b.append(",");
5360 didone = true;
5361 b.append(i.next());
5362 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005363 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005364 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005365 if (mData != null) {
5366 if (!first) {
5367 b.append(' ');
5368 }
5369 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07005370 b.append("dat=");
Wink Savillec491ee02010-10-13 11:40:10 -07005371 String scheme = mData.getScheme();
5372 if (scheme != null) {
5373 if (scheme.equalsIgnoreCase("tel")) {
5374 b.append("tel:xxx-xxx-xxxx");
5375 } else if (scheme.equalsIgnoreCase("smsto")) {
5376 b.append("smsto:xxx-xxx-xxxx");
5377 } else {
5378 b.append(mData);
5379 }
Wink Savillea4288072010-10-12 12:36:38 -07005380 } else {
5381 b.append(mData);
5382 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005383 }
5384 if (mType != null) {
5385 if (!first) {
5386 b.append(' ');
5387 }
5388 first = false;
5389 b.append("typ=").append(mType);
5390 }
5391 if (mFlags != 0) {
5392 if (!first) {
5393 b.append(' ');
5394 }
5395 first = false;
5396 b.append("flg=0x").append(Integer.toHexString(mFlags));
5397 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005398 if (mPackage != null) {
5399 if (!first) {
5400 b.append(' ');
5401 }
5402 first = false;
5403 b.append("pkg=").append(mPackage);
5404 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005405 if (comp && mComponent != null) {
5406 if (!first) {
5407 b.append(' ');
5408 }
5409 first = false;
5410 b.append("cmp=").append(mComponent.flattenToShortString());
5411 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005412 if (mSourceBounds != null) {
5413 if (!first) {
5414 b.append(' ');
5415 }
5416 first = false;
5417 b.append("bnds=").append(mSourceBounds.toShortString());
5418 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005419 if (extras && mExtras != null) {
5420 if (!first) {
5421 b.append(' ');
5422 }
5423 first = false;
5424 b.append("(has extras)");
5425 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005426 }
5427
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005428 /**
5429 * Call {@link #toUri} with 0 flags.
5430 * @deprecated Use {@link #toUri} instead.
5431 */
5432 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005433 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005434 return toUri(0);
5435 }
5436
5437 /**
5438 * Convert this Intent into a String holding a URI representation of it.
5439 * The returned URI string has been properly URI encoded, so it can be
5440 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5441 * Intent's data as the base URI, with an additional fragment describing
5442 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08005443 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005444 * <p>You can convert the returned string back to an Intent with
5445 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08005446 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005447 * @param flags Additional operating flags. Either 0 or
5448 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08005449 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005450 * @return Returns a URI encoding URI string describing the entire contents
5451 * of the Intent.
5452 */
5453 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005454 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005455 String scheme = null;
5456 if (mData != null) {
5457 String data = mData.toString();
5458 if ((flags&URI_INTENT_SCHEME) != 0) {
5459 final int N = data.length();
5460 for (int i=0; i<N; i++) {
5461 char c = data.charAt(i);
5462 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5463 || c == '.' || c == '-') {
5464 continue;
5465 }
5466 if (c == ':' && i > 0) {
5467 // Valid scheme.
5468 scheme = data.substring(0, i);
5469 uri.append("intent:");
5470 data = data.substring(i+1);
5471 break;
5472 }
Tom Taylord4a47292009-12-21 13:59:18 -08005473
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005474 // No scheme.
5475 break;
5476 }
5477 }
5478 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08005479
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005480 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5481 uri.append("intent:");
5482 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005483
5484 uri.append("#Intent;");
5485
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005486 if (scheme != null) {
5487 uri.append("scheme=").append(scheme).append(';');
5488 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005489 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005490 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005491 }
5492 if (mCategories != null) {
5493 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005494 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005495 }
5496 }
5497 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005498 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005499 }
5500 if (mFlags != 0) {
5501 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5502 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005503 if (mPackage != null) {
5504 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5505 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005506 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005507 uri.append("component=").append(Uri.encode(
5508 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005509 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005510 if (mSourceBounds != null) {
5511 uri.append("sourceBounds=")
5512 .append(Uri.encode(mSourceBounds.flattenToString()))
5513 .append(';');
5514 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005515 if (mExtras != null) {
5516 for (String key : mExtras.keySet()) {
5517 final Object value = mExtras.get(key);
5518 char entryType =
5519 value instanceof String ? 'S' :
5520 value instanceof Boolean ? 'B' :
5521 value instanceof Byte ? 'b' :
5522 value instanceof Character ? 'c' :
5523 value instanceof Double ? 'd' :
5524 value instanceof Float ? 'f' :
5525 value instanceof Integer ? 'i' :
5526 value instanceof Long ? 'l' :
5527 value instanceof Short ? 's' :
5528 '\0';
5529
5530 if (entryType != '\0') {
5531 uri.append(entryType);
5532 uri.append('.');
5533 uri.append(Uri.encode(key));
5534 uri.append('=');
5535 uri.append(Uri.encode(value.toString()));
5536 uri.append(';');
5537 }
5538 }
5539 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005540
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005541 uri.append("end");
5542
5543 return uri.toString();
5544 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005545
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005546 public int describeContents() {
5547 return (mExtras != null) ? mExtras.describeContents() : 0;
5548 }
5549
5550 public void writeToParcel(Parcel out, int flags) {
5551 out.writeString(mAction);
5552 Uri.writeToParcel(out, mData);
5553 out.writeString(mType);
5554 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005555 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005556 ComponentName.writeToParcel(mComponent, out);
5557
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005558 if (mSourceBounds != null) {
5559 out.writeInt(1);
5560 mSourceBounds.writeToParcel(out, flags);
5561 } else {
5562 out.writeInt(0);
5563 }
5564
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005565 if (mCategories != null) {
5566 out.writeInt(mCategories.size());
5567 for (String category : mCategories) {
5568 out.writeString(category);
5569 }
5570 } else {
5571 out.writeInt(0);
5572 }
5573
5574 out.writeBundle(mExtras);
5575 }
5576
5577 public static final Parcelable.Creator<Intent> CREATOR
5578 = new Parcelable.Creator<Intent>() {
5579 public Intent createFromParcel(Parcel in) {
5580 return new Intent(in);
5581 }
5582 public Intent[] newArray(int size) {
5583 return new Intent[size];
5584 }
5585 };
5586
Dianne Hackborneb034652009-09-07 00:49:58 -07005587 /** @hide */
5588 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005589 readFromParcel(in);
5590 }
5591
5592 public void readFromParcel(Parcel in) {
5593 mAction = in.readString();
5594 mData = Uri.CREATOR.createFromParcel(in);
5595 mType = in.readString();
5596 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005597 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005598 mComponent = ComponentName.readFromParcel(in);
5599
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005600 if (in.readInt() != 0) {
5601 mSourceBounds = Rect.CREATOR.createFromParcel(in);
5602 }
5603
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005604 int N = in.readInt();
5605 if (N > 0) {
5606 mCategories = new HashSet<String>();
5607 int i;
5608 for (i=0; i<N; i++) {
5609 mCategories.add(in.readString());
5610 }
5611 } else {
5612 mCategories = null;
5613 }
5614
5615 mExtras = in.readBundle();
5616 }
5617
5618 /**
5619 * Parses the "intent" element (and its children) from XML and instantiates
5620 * an Intent object. The given XML parser should be located at the tag
5621 * where parsing should start (often named "intent"), from which the
5622 * basic action, data, type, and package and class name will be
5623 * retrieved. The function will then parse in to any child elements,
5624 * looking for <category android:name="xxx"> tags to add categories and
5625 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5626 * to the intent.
5627 *
5628 * @param resources The Resources to use when inflating resources.
5629 * @param parser The XML parser pointing at an "intent" tag.
5630 * @param attrs The AttributeSet interface for retrieving extended
5631 * attribute data at the current <var>parser</var> location.
5632 * @return An Intent object matching the XML data.
5633 * @throws XmlPullParserException If there was an XML parsing error.
5634 * @throws IOException If there was an I/O error.
5635 */
5636 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5637 throws XmlPullParserException, IOException {
5638 Intent intent = new Intent();
5639
5640 TypedArray sa = resources.obtainAttributes(attrs,
5641 com.android.internal.R.styleable.Intent);
5642
5643 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5644
5645 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5646 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5647 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5648
5649 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5650 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5651 if (packageName != null && className != null) {
5652 intent.setComponent(new ComponentName(packageName, className));
5653 }
5654
5655 sa.recycle();
5656
5657 int outerDepth = parser.getDepth();
5658 int type;
5659 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5660 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5661 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5662 continue;
5663 }
5664
5665 String nodeName = parser.getName();
5666 if (nodeName.equals("category")) {
5667 sa = resources.obtainAttributes(attrs,
5668 com.android.internal.R.styleable.IntentCategory);
5669 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5670 sa.recycle();
5671
5672 if (cat != null) {
5673 intent.addCategory(cat);
5674 }
5675 XmlUtils.skipCurrentTag(parser);
5676
5677 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005678 if (intent.mExtras == null) {
5679 intent.mExtras = new Bundle();
5680 }
5681 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5682 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005683
5684 } else {
5685 XmlUtils.skipCurrentTag(parser);
5686 }
5687 }
5688
5689 return intent;
5690 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005691}