blob: 496ab76d5921118b73dde39ed8ba723d6db6cd43 [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;
29import android.net.Uri;
30import android.os.Bundle;
31import android.os.IBinder;
32import android.os.Parcel;
33import android.os.Parcelable;
34import android.util.AttributeSet;
35import android.util.Log;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070036import com.android.internal.util.XmlUtils;
37
38import java.io.IOException;
39import java.io.Serializable;
40import java.net.URISyntaxException;
41import java.util.ArrayList;
42import java.util.HashSet;
43import java.util.Iterator;
44import java.util.Set;
45
46/**
47 * An intent is an abstract description of an operation to be performed. It
48 * can be used with {@link Context#startActivity(Intent) startActivity} to
49 * launch an {@link android.app.Activity},
50 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
51 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
52 * and {@link android.content.Context#startService} or
53 * {@link android.content.Context#bindService} to communicate with a
54 * background {@link android.app.Service}.
55 *
56 * <p>An Intent provides a facility for performing late runtime binding between
57 * the code in different applications. Its most significant use is in the
58 * launching of activities, where it can be thought of as the glue between
59 * activities. It is
60 * basically a passive data structure holding an abstract description of an
61 * action to be performed. The primary pieces of information in an intent
62 * are:</p>
63 *
64 * <ul>
65 * <li> <p><b>action</b> -- The general action to be performed, such as
66 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
67 * etc.</p>
68 * </li>
69 * <li> <p><b>data</b> -- The data to operate on, such as a person record
70 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
71 * </li>
72 * </ul>
73 *
74 *
75 * <p>Some examples of action/data pairs are:</p>
76 *
77 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070078 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070079 * information about the person whose identifier is "1".</p>
80 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070081 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070082 * the phone dialer with the person filled in.</p>
83 * </li>
84 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
85 * the phone dialer with the given number filled in. Note how the
86 * VIEW action does what what is considered the most reasonable thing for
87 * a particular URI.</p>
88 * </li>
89 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
90 * the phone dialer with the given number filled in.</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * information about the person whose identifier is "1".</p>
94 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070095 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070096 * a list of people, which the user can browse through. This example is a
97 * typical top-level entry into the Contacts application, showing you the
98 * list of people. Selecting a particular person to view would result in a
99 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
100 * being used to start an activity to display that person.</p>
101 * </li>
102 * </ul>
103 *
104 * <p>In addition to these primary attributes, there are a number of secondary
105 * attributes that you can also include with an intent:</p>
106 *
107 * <ul>
108 * <li> <p><b>category</b> -- Gives additional information about the action
109 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
110 * appear in the Launcher as a top-level application, while
111 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
112 * of alternative actions the user can perform on a piece of data.</p>
113 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
114 * intent data. Normally the type is inferred from the data itself.
115 * By setting this attribute, you disable that evaluation and force
116 * an explicit type.</p>
117 * <li> <p><b>component</b> -- Specifies an explicit name of a component
118 * class to use for the intent. Normally this is determined by looking
119 * at the other information in the intent (the action, data/type, and
120 * categories) and matching that with a component that can handle it.
121 * If this attribute is set then none of the evaluation is performed,
122 * and this component is used exactly as is. By specifying this attribute,
123 * all of the other Intent attributes become optional.</p>
124 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
125 * This can be used to provide extended information to the component.
126 * For example, if we have a action to send an e-mail message, we could
127 * also include extra pieces of data here to supply a subject, body,
128 * etc.</p>
129 * </ul>
130 *
131 * <p>Here are some examples of other operations you can specify as intents
132 * using these additional parameters:</p>
133 *
134 * <ul>
135 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
136 * Launch the home screen.</p>
137 * </li>
138 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
139 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
140 * vnd.android.cursor.item/phone}</i></b>
141 * -- Display the list of people's phone numbers, allowing the user to
142 * browse through them and pick one and return it to the parent activity.</p>
143 * </li>
144 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
145 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
146 * -- Display all pickers for data that can be opened with
147 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
148 * allowing the user to pick one of them and then some data inside of it
149 * and returning the resulting URI to the caller. This can be used,
150 * for example, in an e-mail application to allow the user to pick some
151 * data to include as an attachment.</p>
152 * </li>
153 * </ul>
154 *
155 * <p>There are a variety of standard Intent action and category constants
156 * defined in the Intent class, but applications can also define their own.
157 * These strings use java style scoping, to ensure they are unique -- for
158 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700159 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700160 *
161 * <p>Put together, the set of actions, data types, categories, and extra data
162 * defines a language for the system allowing for the expression of phrases
163 * such as "call john smith's cell". As applications are added to the system,
164 * they can extend this language by adding new actions, types, and categories, or
165 * they can modify the behavior of existing phrases by supplying their own
166 * activities that handle them.</p>
167 *
168 * <a name="IntentResolution"></a>
169 * <h3>Intent Resolution</h3>
170 *
171 * <p>There are two primary forms of intents you will use.
172 *
173 * <ul>
174 * <li> <p><b>Explicit Intents</b> have specified a component (via
175 * {@link #setComponent} or {@link #setClass}), which provides the exact
176 * class to be run. Often these will not include any other information,
177 * simply being a way for an application to launch various internal
178 * activities it has as the user interacts with the application.
179 *
180 * <li> <p><b>Implicit Intents</b> have not specified a component;
181 * instead, they must include enough information for the system to
182 * determine which of the available components is best to run for that
183 * intent.
184 * </ul>
185 *
186 * <p>When using implicit intents, given such an arbitrary intent we need to
187 * know what to do with it. This is handled by the process of <em>Intent
188 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
189 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
190 * more activities/receivers) that can handle it.</p>
191 *
192 * <p>The intent resolution mechanism basically revolves around matching an
193 * Intent against all of the &lt;intent-filter&gt; descriptions in the
194 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
195 * objects explicitly registered with {@link Context#registerReceiver}.) More
196 * details on this can be found in the documentation on the {@link
197 * IntentFilter} class.</p>
198 *
199 * <p>There are three pieces of information in the Intent that are used for
200 * resolution: the action, type, and category. Using this information, a query
201 * is done on the {@link PackageManager} for a component that can handle the
202 * intent. The appropriate component is determined based on the intent
203 * information supplied in the <code>AndroidManifest.xml</code> file as
204 * follows:</p>
205 *
206 * <ul>
207 * <li> <p>The <b>action</b>, if given, must be listed by the component as
208 * one it handles.</p>
209 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
210 * already supplied in the Intent. Like the action, if a type is
211 * included in the intent (either explicitly or implicitly in its
212 * data), then this must be listed by the component as one it handles.</p>
213 * <li> For data that is not a <code>content:</code> URI and where no explicit
214 * type is included in the Intent, instead the <b>scheme</b> of the
215 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
216 * considered. Again like the action, if we are matching a scheme it
217 * must be listed by the component as one it can handle.
218 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
219 * by the activity as categories it handles. That is, if you include
220 * the categories {@link #CATEGORY_LAUNCHER} and
221 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
222 * with an intent that lists <em>both</em> of those categories.
223 * Activities will very often need to support the
224 * {@link #CATEGORY_DEFAULT} so that they can be found by
225 * {@link Context#startActivity Context.startActivity()}.</p>
226 * </ul>
227 *
228 * <p>For example, consider the Note Pad sample application that
229 * allows user to browse through a list of notes data and view details about
230 * individual items. Text in italics indicate places were you would replace a
231 * name with one specific to your own package.</p>
232 *
233 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
234 * package="<i>com.android.notepad</i>"&gt;
235 * &lt;application android:icon="@drawable/app_notes"
236 * android:label="@string/app_name"&gt;
237 *
238 * &lt;provider class=".NotePadProvider"
239 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
240 *
241 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
242 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700243 * &lt;action android:name="android.intent.action.MAIN" /&gt;
244 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700245 * &lt;/intent-filter&gt;
246 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700247 * &lt;action android:name="android.intent.action.VIEW" /&gt;
248 * &lt;action android:name="android.intent.action.EDIT" /&gt;
249 * &lt;action android:name="android.intent.action.PICK" /&gt;
250 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
251 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700252 * &lt;/intent-filter&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
255 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
256 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700257 * &lt;/intent-filter&gt;
258 * &lt;/activity&gt;
259 *
260 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
261 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700262 * &lt;action android:name="android.intent.action.VIEW" /&gt;
263 * &lt;action android:name="android.intent.action.EDIT" /&gt;
264 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
265 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700266 * &lt;/intent-filter&gt;
267 *
268 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700269 * &lt;action android:name="android.intent.action.INSERT" /&gt;
270 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
271 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700272 * &lt;/intent-filter&gt;
273 *
274 * &lt;/activity&gt;
275 *
276 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
277 * android:theme="@android:style/Theme.Dialog"&gt;
278 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700279 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
280 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
281 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
282 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 * &lt;/activity&gt;
286 *
287 * &lt;/application&gt;
288 * &lt;/manifest&gt;</pre>
289 *
290 * <p>The first activity,
291 * <code>com.android.notepad.NotesList</code>, serves as our main
292 * entry into the app. It can do three things as described by its three intent
293 * templates:
294 * <ol>
295 * <li><pre>
296 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700297 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
298 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700299 * &lt;/intent-filter&gt;</pre>
300 * <p>This provides a top-level entry into the NotePad application: the standard
301 * MAIN action is a main entry point (not requiring any other information in
302 * the Intent), and the LAUNCHER category says that this entry point should be
303 * listed in the application launcher.</p>
304 * <li><pre>
305 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700306 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
307 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
308 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
310 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700311 * &lt;/intent-filter&gt;</pre>
312 * <p>This declares the things that the activity can do on a directory of
313 * notes. The type being supported is given with the &lt;type&gt; tag, where
314 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
315 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
316 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
317 * The activity allows the user to view or edit the directory of data (via
318 * the VIEW and EDIT actions), or to pick a particular note and return it
319 * to the caller (via the PICK action). Note also the DEFAULT category
320 * supplied here: this is <em>required</em> for the
321 * {@link Context#startActivity Context.startActivity} method to resolve your
322 * activity when its component name is not explicitly specified.</p>
323 * <li><pre>
324 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700325 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
326 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
327 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700328 * &lt;/intent-filter&gt;</pre>
329 * <p>This filter describes the ability return to the caller a note selected by
330 * the user without needing to know where it came from. The data type
331 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
332 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
333 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
334 * The GET_CONTENT action is similar to the PICK action, where the activity
335 * will return to its caller a piece of data selected by the user. Here,
336 * however, the caller specifies the type of data they desire instead of
337 * the type of data the user will be picking from.</p>
338 * </ol>
339 *
340 * <p>Given these capabilities, the following intents will resolve to the
341 * NotesList activity:</p>
342 *
343 * <ul>
344 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
345 * activities that can be used as top-level entry points into an
346 * application.</p>
347 * <li> <p><b>{ action=android.app.action.MAIN,
348 * category=android.app.category.LAUNCHER }</b> is the actual intent
349 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700350 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700351 * data=content://com.google.provider.NotePad/notes }</b>
352 * displays a list of all the notes under
353 * "content://com.google.provider.NotePad/notes", which
354 * the user can browse through and see the details on.</p>
355 * <li> <p><b>{ action=android.app.action.PICK
356 * data=content://com.google.provider.NotePad/notes }</b>
357 * provides a list of the notes under
358 * "content://com.google.provider.NotePad/notes", from which
359 * the user can pick a note whose data URL is returned back to the caller.</p>
360 * <li> <p><b>{ action=android.app.action.GET_CONTENT
361 * type=vnd.android.cursor.item/vnd.google.note }</b>
362 * is similar to the pick action, but allows the caller to specify the
363 * kind of data they want back so that the system can find the appropriate
364 * activity to pick something of that data type.</p>
365 * </ul>
366 *
367 * <p>The second activity,
368 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
369 * note entry and allows them to edit it. It can do two things as described
370 * by its two intent templates:
371 * <ol>
372 * <li><pre>
373 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700374 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
375 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
376 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
377 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700378 * &lt;/intent-filter&gt;</pre>
379 * <p>The first, primary, purpose of this activity is to let the user interact
380 * with a single note, as decribed by the MIME type
381 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
382 * either VIEW a note or allow the user to EDIT it. Again we support the
383 * DEFAULT category to allow the activity to be launched without explicitly
384 * specifying its component.</p>
385 * <li><pre>
386 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700387 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
388 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
389 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700390 * &lt;/intent-filter&gt;</pre>
391 * <p>The secondary use of this activity is to insert a new note entry into
392 * an existing directory of notes. This is used when the user creates a new
393 * note: the INSERT action is executed on the directory of notes, causing
394 * this activity to run and have the user create the new note data which
395 * it then adds to the content provider.</p>
396 * </ol>
397 *
398 * <p>Given these capabilities, the following intents will resolve to the
399 * NoteEditor activity:</p>
400 *
401 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700402 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700403 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
404 * shows the user the content of note <var>{ID}</var>.</p>
405 * <li> <p><b>{ action=android.app.action.EDIT
406 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
407 * allows the user to edit the content of note <var>{ID}</var>.</p>
408 * <li> <p><b>{ action=android.app.action.INSERT
409 * data=content://com.google.provider.NotePad/notes }</b>
410 * creates a new, empty note in the notes list at
411 * "content://com.google.provider.NotePad/notes"
412 * and allows the user to edit it. If they keep their changes, the URI
413 * of the newly created note is returned to the caller.</p>
414 * </ul>
415 *
416 * <p>The last activity,
417 * <code>com.android.notepad.TitleEditor</code>, allows the user to
418 * edit the title of a note. This could be implemented as a class that the
419 * application directly invokes (by explicitly setting its component in
420 * the Intent), but here we show a way you can publish alternative
421 * operations on existing data:</p>
422 *
423 * <pre>
424 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700425 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
426 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
427 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
429 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700430 * &lt;/intent-filter&gt;</pre>
431 *
432 * <p>In the single intent template here, we
433 * have created our own private action called
434 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
435 * edit the title of a note. It must be invoked on a specific note
436 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
437 * view and edit actions, but here displays and edits the title contained
438 * in the note data.
439 *
440 * <p>In addition to supporting the default category as usual, our title editor
441 * also supports two other standard categories: ALTERNATIVE and
442 * SELECTED_ALTERNATIVE. Implementing
443 * these categories allows others to find the special action it provides
444 * without directly knowing about it, through the
445 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
446 * more often to build dynamic menu items with
447 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
448 * template here was also supply an explicit name for the template
449 * (via <code>android:label="@string/resolve_title"</code>) to better control
450 * what the user sees when presented with this activity as an alternative
451 * action to the data they are viewing.
452 *
453 * <p>Given these capabilities, the following intent will resolve to the
454 * TitleEditor activity:</p>
455 *
456 * <ul>
457 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
458 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
459 * displays and allows the user to edit the title associated
460 * with note <var>{ID}</var>.</p>
461 * </ul>
462 *
463 * <h3>Standard Activity Actions</h3>
464 *
465 * <p>These are the current standard actions that Intent defines for launching
466 * activities (usually through {@link Context#startActivity}. The most
467 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
468 * {@link #ACTION_EDIT}.
469 *
470 * <ul>
471 * <li> {@link #ACTION_MAIN}
472 * <li> {@link #ACTION_VIEW}
473 * <li> {@link #ACTION_ATTACH_DATA}
474 * <li> {@link #ACTION_EDIT}
475 * <li> {@link #ACTION_PICK}
476 * <li> {@link #ACTION_CHOOSER}
477 * <li> {@link #ACTION_GET_CONTENT}
478 * <li> {@link #ACTION_DIAL}
479 * <li> {@link #ACTION_CALL}
480 * <li> {@link #ACTION_SEND}
481 * <li> {@link #ACTION_SENDTO}
482 * <li> {@link #ACTION_ANSWER}
483 * <li> {@link #ACTION_INSERT}
484 * <li> {@link #ACTION_DELETE}
485 * <li> {@link #ACTION_RUN}
486 * <li> {@link #ACTION_SYNC}
487 * <li> {@link #ACTION_PICK_ACTIVITY}
488 * <li> {@link #ACTION_SEARCH}
489 * <li> {@link #ACTION_WEB_SEARCH}
490 * <li> {@link #ACTION_FACTORY_TEST}
491 * </ul>
492 *
493 * <h3>Standard Broadcast Actions</h3>
494 *
495 * <p>These are the current standard actions that Intent defines for receiving
496 * broadcasts (usually through {@link Context#registerReceiver} or a
497 * &lt;receiver&gt; tag in a manifest).
498 *
499 * <ul>
500 * <li> {@link #ACTION_TIME_TICK}
501 * <li> {@link #ACTION_TIME_CHANGED}
502 * <li> {@link #ACTION_TIMEZONE_CHANGED}
503 * <li> {@link #ACTION_BOOT_COMPLETED}
504 * <li> {@link #ACTION_PACKAGE_ADDED}
505 * <li> {@link #ACTION_PACKAGE_CHANGED}
506 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800507 * <li> {@link #ACTION_PACKAGE_RESTARTED}
508 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700509 * <li> {@link #ACTION_UID_REMOVED}
510 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700511 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700512 * <li> {@link #ACTION_POWER_DISCONNECTED}
513 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700514 * </ul>
515 *
516 * <h3>Standard Categories</h3>
517 *
518 * <p>These are the current standard categories that can be used to further
519 * clarify an Intent via {@link #addCategory}.
520 *
521 * <ul>
522 * <li> {@link #CATEGORY_DEFAULT}
523 * <li> {@link #CATEGORY_BROWSABLE}
524 * <li> {@link #CATEGORY_TAB}
525 * <li> {@link #CATEGORY_ALTERNATIVE}
526 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
527 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800528 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700529 * <li> {@link #CATEGORY_HOME}
530 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700531 * <li> {@link #CATEGORY_TEST}
532 * </ul>
533 *
534 * <h3>Standard Extra Data</h3>
535 *
536 * <p>These are the current standard fields that can be used as extra data via
537 * {@link #putExtra}.
538 *
539 * <ul>
540 * <li> {@link #EXTRA_TEMPLATE}
541 * <li> {@link #EXTRA_INTENT}
542 * <li> {@link #EXTRA_STREAM}
543 * <li> {@link #EXTRA_TEXT}
544 * </ul>
545 *
546 * <h3>Flags</h3>
547 *
548 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800549 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
550 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700551 */
552public class Intent implements Parcelable {
553 // ---------------------------------------------------------------------
554 // ---------------------------------------------------------------------
555 // Standard intent activity actions (see action variable).
556
557 /**
558 * Activity Action: Start as a main entry point, does not expect to
559 * receive data.
560 * <p>Input: nothing
561 * <p>Output: nothing
562 */
563 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
564 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800565
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700566 /**
567 * Activity Action: Display the data to the user. This is the most common
568 * action performed on data -- it is the generic action you can use on
569 * a piece of data to get the most reasonable thing to occur. For example,
570 * when used on a contacts entry it will view the entry; when used on a
571 * mailto: URI it will bring up a compose window filled with the information
572 * supplied by the URI; when used with a tel: URI it will invoke the
573 * dialer.
574 * <p>Input: {@link #getData} is URI from which to retrieve data.
575 * <p>Output: nothing.
576 */
577 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
578 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800579
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700580 /**
581 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
582 * performed on a piece of data.
583 */
584 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800585
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 /**
587 * Used to indicate that some piece of data should be attached to some other
588 * place. For example, image data could be attached to a contact. It is up
589 * to the recipient to decide where the data should be attached; the intent
590 * does not specify the ultimate destination.
591 * <p>Input: {@link #getData} is URI of data to be attached.
592 * <p>Output: nothing.
593 */
594 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
595 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800596
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 /**
598 * Activity Action: Provide explicit editable access to the given data.
599 * <p>Input: {@link #getData} is URI of data to be edited.
600 * <p>Output: nothing.
601 */
602 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
603 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800604
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700605 /**
606 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
607 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
608 * The extras can contain type specific data to pass through to the editing/creating
609 * activity.
610 * <p>Output: The URI of the item that was picked. This must be a content:
611 * URI so that any receiver can access it.
612 */
613 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
614 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800615
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700616 /**
617 * Activity Action: Pick an item from the data, returning what was selected.
618 * <p>Input: {@link #getData} is URI containing a directory of data
619 * (vnd.android.cursor.dir/*) from which to pick an item.
620 * <p>Output: The URI of the item that was picked.
621 */
622 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
623 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700625 /**
626 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800627 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700628 * <p>Output: An Intent representing the shortcut. The intent must contain three
629 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
630 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800631 * (value: ShortcutIconResource).</p>
632 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700633 * @see #EXTRA_SHORTCUT_INTENT
634 * @see #EXTRA_SHORTCUT_NAME
635 * @see #EXTRA_SHORTCUT_ICON
636 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
637 * @see android.content.Intent.ShortcutIconResource
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
641
642 /**
643 * The name of the extra used to define the Intent of a shortcut.
644 *
645 * @see #ACTION_CREATE_SHORTCUT
646 */
647 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
648 /**
649 * The name of the extra used to define the name of a shortcut.
650 *
651 * @see #ACTION_CREATE_SHORTCUT
652 */
653 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
654 /**
655 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
656 *
657 * @see #ACTION_CREATE_SHORTCUT
658 */
659 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
660 /**
661 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
662 *
663 * @see #ACTION_CREATE_SHORTCUT
664 * @see android.content.Intent.ShortcutIconResource
665 */
666 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
667 "android.intent.extra.shortcut.ICON_RESOURCE";
668
669 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800670 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700671 *
672 * @see Intent#ACTION_CREATE_SHORTCUT
673 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800674 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
675 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700676 */
677 public static class ShortcutIconResource implements Parcelable {
678 /**
679 * The package name of the application containing the icon.
680 */
681 public String packageName;
682
683 /**
684 * The resource name of the icon, including package, name and type.
685 */
686 public String resourceName;
687
688 /**
689 * Creates a new ShortcutIconResource for the specified context and resource
690 * identifier.
691 *
692 * @param context The context of the application.
693 * @param resourceId The resource idenfitier for the icon.
694 * @return A new ShortcutIconResource with the specified's context package name
695 * and icon resource idenfitier.
696 */
697 public static ShortcutIconResource fromContext(Context context, int resourceId) {
698 ShortcutIconResource icon = new ShortcutIconResource();
699 icon.packageName = context.getPackageName();
700 icon.resourceName = context.getResources().getResourceName(resourceId);
701 return icon;
702 }
703
704 /**
705 * Used to read a ShortcutIconResource from a Parcel.
706 */
707 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
708 new Parcelable.Creator<ShortcutIconResource>() {
709
710 public ShortcutIconResource createFromParcel(Parcel source) {
711 ShortcutIconResource icon = new ShortcutIconResource();
712 icon.packageName = source.readString();
713 icon.resourceName = source.readString();
714 return icon;
715 }
716
717 public ShortcutIconResource[] newArray(int size) {
718 return new ShortcutIconResource[size];
719 }
720 };
721
722 /**
723 * No special parcel contents.
724 */
725 public int describeContents() {
726 return 0;
727 }
728
729 public void writeToParcel(Parcel dest, int flags) {
730 dest.writeString(packageName);
731 dest.writeString(resourceName);
732 }
733
734 @Override
735 public String toString() {
736 return resourceName;
737 }
738 }
739
740 /**
741 * Activity Action: Display an activity chooser, allowing the user to pick
742 * what they want to before proceeding. This can be used as an alternative
743 * to the standard activity picker that is displayed by the system when
744 * you try to start an activity with multiple possible matches, with these
745 * differences in behavior:
746 * <ul>
747 * <li>You can specify the title that will appear in the activity chooser.
748 * <li>The user does not have the option to make one of the matching
749 * activities a preferred activity, and all possible activities will
750 * always be shown even if one of them is currently marked as the
751 * preferred activity.
752 * </ul>
753 * <p>
754 * This action should be used when the user will naturally expect to
755 * select an activity in order to proceed. An example if when not to use
756 * it is when the user clicks on a "mailto:" link. They would naturally
757 * expect to go directly to their mail app, so startActivity() should be
758 * called directly: it will
759 * either launch the current preferred app, or put up a dialog allowing the
760 * user to pick an app to use and optionally marking that as preferred.
761 * <p>
762 * In contrast, if the user is selecting a menu item to send a picture
763 * they are viewing to someone else, there are many different things they
764 * may want to do at this point: send it through e-mail, upload it to a
765 * web service, etc. In this case the CHOOSER action should be used, to
766 * always present to the user a list of the things they can do, with a
767 * nice title given by the caller such as "Send this photo with:".
768 * <p>
769 * As a convenience, an Intent of this form can be created with the
770 * {@link #createChooser} function.
771 * <p>Input: No data should be specified. get*Extra must have
772 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
773 * and can optionally have a {@link #EXTRA_TITLE} field containing the
774 * title text to display in the chooser.
775 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
776 */
777 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
778 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
779
780 /**
781 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
782 *
783 * @param target The Intent that the user will be selecting an activity
784 * to perform.
785 * @param title Optional title that will be displayed in the chooser.
786 * @return Return a new Intent object that you can hand to
787 * {@link Context#startActivity(Intent) Context.startActivity()} and
788 * related methods.
789 */
790 public static Intent createChooser(Intent target, CharSequence title) {
791 Intent intent = new Intent(ACTION_CHOOSER);
792 intent.putExtra(EXTRA_INTENT, target);
793 if (title != null) {
794 intent.putExtra(EXTRA_TITLE, title);
795 }
796 return intent;
797 }
798 /**
799 * Activity Action: Allow the user to select a particular kind of data and
800 * return it. This is different than {@link #ACTION_PICK} in that here we
801 * just say what kind of data is desired, not a URI of existing data from
802 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
803 * create the data as it runs (for example taking a picture or recording a
804 * sound), let them browser over the web and download the desired data,
805 * etc.
806 * <p>
807 * There are two main ways to use this action: if you want an specific kind
808 * of data, such as a person contact, you set the MIME type to the kind of
809 * data you want and launch it with {@link Context#startActivity(Intent)}.
810 * The system will then launch the best application to select that kind
811 * of data for you.
812 * <p>
813 * You may also be interested in any of a set of types of content the user
814 * can pick. For example, an e-mail application that wants to allow the
815 * user to add an attachment to an e-mail message can use this action to
816 * bring up a list of all of the types of content the user can attach.
817 * <p>
818 * In this case, you should wrap the GET_CONTENT intent with a chooser
819 * (through {@link #createChooser}), which will give the proper interface
820 * for the user to pick how to send your data and allow you to specify
821 * a prompt indicating what they are doing. You will usually specify a
822 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
823 * broad range of content types the user can select from.
824 * <p>
825 * When using such a broad GET_CONTENT action, it is often desireable to
826 * only pick from data that can be represented as a stream. This is
827 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
828 * <p>
829 * Input: {@link #getType} is the desired MIME type to retrieve. Note
830 * that no URI is supplied in the intent, as there are no constraints on
831 * where the returned data originally comes from. You may also include the
832 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
833 * opened as a stream.
834 * <p>
835 * Output: The URI of the item that was picked. This must be a content:
836 * URI so that any receiver can access it.
837 */
838 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
839 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
840 /**
841 * Activity Action: Dial a number as specified by the data. This shows a
842 * UI with the number being dialed, allowing the user to explicitly
843 * initiate the call.
844 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
845 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
846 * number.
847 * <p>Output: nothing.
848 */
849 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
850 public static final String ACTION_DIAL = "android.intent.action.DIAL";
851 /**
852 * Activity Action: Perform a call to someone specified by the data.
853 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
854 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
855 * number.
856 * <p>Output: nothing.
857 *
858 * <p>Note: there will be restrictions on which applications can initiate a
859 * call; most applications should use the {@link #ACTION_DIAL}.
860 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
861 * numbers. Applications can <strong>dial</strong> emergency numbers using
862 * {@link #ACTION_DIAL}, however.
863 */
864 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
865 public static final String ACTION_CALL = "android.intent.action.CALL";
866 /**
867 * Activity Action: Perform a call to an emergency number specified by the
868 * data.
869 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
870 * tel: URI of an explicit phone number.
871 * <p>Output: nothing.
872 * @hide
873 */
874 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
875 /**
876 * Activity action: Perform a call to any number (emergency or not)
877 * specified by the data.
878 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
879 * tel: URI of an explicit phone number.
880 * <p>Output: nothing.
881 * @hide
882 */
883 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
884 /**
885 * Activity Action: Send a message to someone specified by the data.
886 * <p>Input: {@link #getData} is URI describing the target.
887 * <p>Output: nothing.
888 */
889 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
890 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
891 /**
892 * Activity Action: Deliver some data to someone else. Who the data is
893 * being delivered to is not specified; it is up to the receiver of this
894 * action to ask the user where the data should be sent.
895 * <p>
896 * When launching a SEND intent, you should usually wrap it in a chooser
897 * (through {@link #createChooser}), which will give the proper interface
898 * for the user to pick how to send your data and allow you to specify
899 * a prompt indicating what they are doing.
900 * <p>
901 * Input: {@link #getType} is the MIME type of the data being sent.
902 * get*Extra can have either a {@link #EXTRA_TEXT}
903 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
904 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
905 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
906 * if the MIME type is unknown (this will only allow senders that can
907 * handle generic data streams).
908 * <p>
909 * Optional standard extras, which may be interpreted by some recipients as
910 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
911 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
912 * <p>
913 * Output: nothing.
914 */
915 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
916 public static final String ACTION_SEND = "android.intent.action.SEND";
917 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800918 * Activity Action: Deliver multiple data to someone else.
919 * <p>
920 * Like ACTION_SEND, except the data is multiple.
921 * <p>
922 * Input: {@link #getType} is the MIME type of the data being sent.
923 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
924 * #EXTRA_STREAM} field, containing the data to be sent.
925 * <p>
926 * Optional standard extras, which may be interpreted by some recipients as
927 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
928 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
929 * <p>
930 * Output: nothing.
931 */
932 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
933 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
934 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700935 * Activity Action: Handle an incoming phone call.
936 * <p>Input: nothing.
937 * <p>Output: nothing.
938 */
939 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
940 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
941 /**
942 * Activity Action: Insert an empty item into the given container.
943 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
944 * in which to place the data.
945 * <p>Output: URI of the new data that was created.
946 */
947 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
948 public static final String ACTION_INSERT = "android.intent.action.INSERT";
949 /**
950 * Activity Action: Delete the given data from its container.
951 * <p>Input: {@link #getData} is URI of data to be deleted.
952 * <p>Output: nothing.
953 */
954 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
955 public static final String ACTION_DELETE = "android.intent.action.DELETE";
956 /**
957 * Activity Action: Run the data, whatever that means.
958 * <p>Input: ? (Note: this is currently specific to the test harness.)
959 * <p>Output: nothing.
960 */
961 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
962 public static final String ACTION_RUN = "android.intent.action.RUN";
963 /**
964 * Activity Action: Perform a data synchronization.
965 * <p>Input: ?
966 * <p>Output: ?
967 */
968 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
969 public static final String ACTION_SYNC = "android.intent.action.SYNC";
970 /**
971 * Activity Action: Pick an activity given an intent, returning the class
972 * selected.
973 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
974 * used with {@link PackageManager#queryIntentActivities} to determine the
975 * set of activities from which to pick.
976 * <p>Output: Class name of the activity that was selected.
977 */
978 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
979 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
980 /**
981 * Activity Action: Perform a search.
982 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
983 * is the text to search for. If empty, simply
984 * enter your search results Activity with the search UI activated.
985 * <p>Output: nothing.
986 */
987 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
988 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
989 /**
Jim Miller7e4ad352009-03-25 18:16:41 -0700990 * Activity Action: Start the platform-defined tutorial
991 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
992 * is the text to search for. If empty, simply
993 * enter your search results Activity with the search UI activated.
994 * <p>Output: nothing.
995 */
996 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
997 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
998 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700999 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001000 * <p>
1001 * Input: {@link android.app.SearchManager#QUERY
1002 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1003 * a url starts with http or https, the site will be opened. If it is plain
1004 * text, Google search will be applied.
1005 * <p>
1006 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001007 */
1008 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1009 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1010 /**
1011 * Activity Action: List all available applications
1012 * <p>Input: Nothing.
1013 * <p>Output: nothing.
1014 */
1015 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1016 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1017 /**
1018 * Activity Action: Show settings for choosing wallpaper
1019 * <p>Input: Nothing.
1020 * <p>Output: Nothing.
1021 */
1022 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1023 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1024
1025 /**
1026 * Activity Action: Show activity for reporting a bug.
1027 * <p>Input: Nothing.
1028 * <p>Output: Nothing.
1029 */
1030 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1031 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1032
1033 /**
1034 * Activity Action: Main entry point for factory tests. Only used when
1035 * the device is booting in factory test node. The implementing package
1036 * must be installed in the system image.
1037 * <p>Input: nothing
1038 * <p>Output: nothing
1039 */
1040 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1041
1042 /**
1043 * Activity Action: The user pressed the "call" button to go to the dialer
1044 * or other appropriate UI for placing a call.
1045 * <p>Input: Nothing.
1046 * <p>Output: Nothing.
1047 */
1048 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1049 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1050
1051 /**
1052 * Activity Action: Start Voice Command.
1053 * <p>Input: Nothing.
1054 * <p>Output: Nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001058
1059 /**
1060 * Activity Action: Start action associated with long pressing on the
1061 * search key.
1062 * <p>Input: Nothing.
1063 * <p>Output: Nothing.
1064 */
1065 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1066 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001067
Jacek Surazski86b6c532009-05-13 14:38:28 +02001068 /**
1069 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1070 * This intent is delivered to the package which installed the application, usually
1071 * the Market.
1072 * <p>Input: No data is specified. The bug report is passed in using
1073 * an {@link #EXTRA_BUG_REPORT} field.
1074 * <p>Output: Nothing.
1075 * @hide
1076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001079
1080 /**
1081 * Activity Action: Show power usage information to the user.
1082 * <p>Input: Nothing.
1083 * <p>Output: Nothing.
1084 */
1085 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1086 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
1087
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001088 /**
1089 * Activity Action: Setup wizard to launch after a platform update. This
1090 * activity should have a string meta-data field associated with it,
1091 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1092 * the platform for setup. The activity will be launched only if
1093 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1094 * same value.
1095 * <p>Input: Nothing.
1096 * <p>Output: Nothing.
1097 * @hide
1098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
1101
1102 /**
1103 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1104 * describing the last run version of the platform that was setup.
1105 * @hide
1106 */
1107 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1108
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001109 // ---------------------------------------------------------------------
1110 // ---------------------------------------------------------------------
1111 // Standard intent broadcast actions (see action variable).
1112
1113 /**
1114 * Broadcast Action: Sent after the screen turns off.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001115 *
1116 * <p class="note">This is a protected intent that can only be sent
1117 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001118 */
1119 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1120 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1121 /**
1122 * Broadcast Action: Sent after the screen turns on.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001123 *
1124 * <p class="note">This is a protected intent that can only be sent
1125 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001126 */
1127 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1128 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001129
1130 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001131 * 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 -07001132 * keyguard is gone).
Dianne Hackborn854060af2009-07-09 18:14:31 -07001133 *
1134 * <p class="note">This is a protected intent that can only be sent
1135 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001136 */
1137 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1138 public static final String ACTION_USER_PRESENT= "android.intent.action.USER_PRESENT";
1139
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001140 /**
1141 * Broadcast Action: The current time has changed. Sent every
1142 * minute. You can <em>not</em> receive this through components declared
1143 * in manifests, only by exlicitly registering for it with
1144 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1145 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001146 *
1147 * <p class="note">This is a protected intent that can only be sent
1148 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001149 */
1150 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1151 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1152 /**
1153 * Broadcast Action: The time was set.
1154 */
1155 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1156 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1157 /**
1158 * Broadcast Action: The date has changed.
1159 */
1160 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1161 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1162 /**
1163 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1164 * <ul>
1165 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1166 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001167 *
1168 * <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_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1173 /**
1174 * Alarm Changed Action: This is broadcast when the AlarmClock
1175 * application's alarm is set or unset. It is used by the
1176 * AlarmClock application and the StatusBar service.
1177 * @hide
1178 */
1179 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1180 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1181 /**
1182 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1183 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1184 * @hide
1185 */
1186 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1187 public static final String ACTION_SYNC_STATE_CHANGED
1188 = "android.intent.action.SYNC_STATE_CHANGED";
1189 /**
1190 * Broadcast Action: This is broadcast once, after the system has finished
1191 * booting. It can be used to perform application-specific initialization,
1192 * such as installing alarms. You must hold the
1193 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1194 * in order to receive this broadcast.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001195 *
1196 * <p class="note">This is a protected intent that can only be sent
1197 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001198 */
1199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1200 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1201 /**
1202 * Broadcast Action: This is broadcast when a user action should request a
1203 * temporary system dialog to dismiss. Some examples of temporary system
1204 * dialogs are the notification window-shade and the recent tasks dialog.
1205 */
1206 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1207 /**
1208 * Broadcast Action: Trigger the download and eventual installation
1209 * of a package.
1210 * <p>Input: {@link #getData} is the URI of the package file to download.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001211 *
1212 * <p class="note">This is a protected intent that can only be sent
1213 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001214 */
1215 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1216 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1217 /**
1218 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001219 * device. The data contains the name of the package. Note that the
1220 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001221 * <p>My include the following extras:
1222 * <ul>
1223 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1224 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1225 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1226 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001227 *
1228 * <p class="note">This is a protected intent that can only be sent
1229 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001230 */
1231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1232 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1233 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001234 * Broadcast Action: A new version of an application package has been
1235 * installed, replacing an existing version that was previously installed.
1236 * The data contains the name of the package.
1237 * <p>My include the following extras:
1238 * <ul>
1239 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1240 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001241 *
1242 * <p class="note">This is a protected intent that can only be sent
1243 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001244 */
1245 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1246 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1247 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001248 * Broadcast Action: An existing application package has been removed from
1249 * the device. The data contains the name of the package. The package
1250 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001251 * <ul>
1252 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1253 * to the package.
1254 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1255 * application -- data and code -- is being removed.
1256 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1257 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1258 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001259 *
1260 * <p class="note">This is a protected intent that can only be sent
1261 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001262 */
1263 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1264 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1265 /**
1266 * Broadcast Action: An existing application package has been changed (e.g. a component has been
1267 * enabled or disabled. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001268 * <ul>
1269 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1270 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001271 *
1272 * <p class="note">This is a protected intent that can only be sent
1273 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001274 */
1275 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1276 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1277 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001278 * Broadcast Action: The user has restarted a package, and all of its
1279 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001280 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001281 * be removed. Note that the restarted package does <em>not</em>
1282 * receive this broadcast.
1283 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001284 * <ul>
1285 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1286 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001287 *
1288 * <p class="note">This is a protected intent that can only be sent
1289 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001290 */
1291 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1292 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1293 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001294 * Broadcast Action: The user has cleared the data of a package. This should
1295 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001296 * its persistent data is erased and this broadcast sent.
1297 * Note that the cleared package does <em>not</em>
1298 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001299 * <ul>
1300 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1301 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001302 *
1303 * <p class="note">This is a protected intent that can only be sent
1304 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001305 */
1306 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1307 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1308 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001309 * Broadcast Action: A user ID has been removed from the system. The user
1310 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001311 *
1312 * <p class="note">This is a protected intent that can only be sent
1313 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001314 */
1315 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1316 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
1317 /**
1318 * Broadcast Action: The current system wallpaper has changed. See
1319 * {@link Context#getWallpaper} for retrieving the new wallpaper.
1320 */
1321 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1322 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1323 /**
1324 * Broadcast Action: The current device {@link android.content.res.Configuration}
1325 * (orientation, locale, etc) has changed. When such a change happens, the
1326 * UIs (view hierarchy) will need to be rebuilt based on this new
1327 * information; for the most part, applications don't need to worry about
1328 * this, because the system will take care of stopping and restarting the
1329 * application to make sure it sees the new changes. Some system code that
1330 * can not be restarted will need to watch for this action and handle it
1331 * appropriately.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001332 *
1333 * <p class="note">This is a protected intent that can only be sent
1334 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001335 *
1336 * @see android.content.res.Configuration
1337 */
1338 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1339 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1340 /**
1341 * Broadcast Action: The charging state, or charge level of the battery has
1342 * changed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001343 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001344 * <p class="note">
1345 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001346 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001347 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1348 * Context.registerReceiver()}.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001349 *
1350 * <p class="note">This is a protected intent that can only be sent
1351 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001352 */
1353 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1354 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1355 /**
1356 * Broadcast Action: Indicates low battery condition on the device.
1357 * This broadcast corresponds to the "Low battery warning" system dialog.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001358 *
1359 * <p class="note">This is a protected intent that can only be sent
1360 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001361 */
1362 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1363 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1364 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001365 * Broadcast Action: Indicates the battery is now okay after being low.
1366 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1367 * gone back up to an okay state.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001368 *
1369 * <p class="note">This is a protected intent that can only be sent
1370 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001371 */
1372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1373 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1374 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001375 * Broadcast Action: External power has been connected to the device.
1376 * This is intended for applications that wish to register specifically to this notification.
1377 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1378 * stay active to receive this notification. This action can be used to implement actions
1379 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001380 *
1381 * <p class="note">This is a protected intent that can only be sent
1382 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001383 */
1384 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001385 public static final String ACTION_POWER_CONNECTED = "android.intent.action.POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001386 /**
1387 * Broadcast Action: External power has been removed from the device.
1388 * This is intended for applications that wish to register specifically to this notification.
1389 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1390 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001391 * that wait until power is available to trigger.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001392 *
1393 * <p class="note">This is a protected intent that can only be sent
1394 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001395 */
1396 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001397 public static final String ACTION_POWER_DISCONNECTED =
Romain Guy31708d42009-06-17 15:55:53 -07001398 "android.intent.action.POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001399 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001400 * Broadcast Action: Device is shutting down.
1401 * This is broadcast when the device is being shut down (completely turned
1402 * off, not sleeping). Once the broadcast is complete, the final shutdown
1403 * will proceed and all unsaved data lost. Apps will not normally need
1404 * to handle this, since the forground activity will be paused as well.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001405 *
1406 * <p class="note">This is a protected intent that can only be sent
1407 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001408 */
1409 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001410 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001411 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001412 * Activity Action: Start this activity to request system shutdown.
1413 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1414 * to request confirmation from the user before shutting down.
1415 *
1416 * <p class="note">This is a protected intent that can only be sent
1417 * by the system.
1418 *
1419 * {@hide}
1420 */
1421 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1422 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001423 * Broadcast Action: Indicates low memory condition on the device
Dianne Hackborn854060af2009-07-09 18:14:31 -07001424 *
1425 * <p class="note">This is a protected intent that can only be sent
1426 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001427 */
1428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1429 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1430 /**
1431 * Broadcast Action: Indicates low memory condition on the device no longer exists
Dianne Hackborn854060af2009-07-09 18:14:31 -07001432 *
1433 * <p class="note">This is a protected intent that can only be sent
1434 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001435 */
1436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1437 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1438 /**
1439 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1440 * and package management should be started.
1441 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1442 * notification.
1443 */
1444 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1445 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1446 /**
1447 * Broadcast Action: The device has entered USB Mass Storage mode.
1448 * This is used mainly for the USB Settings panel.
1449 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1450 * when the SD card file system is mounted or unmounted
1451 */
1452 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1453 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1454
1455 /**
1456 * Broadcast Action: The device has exited USB Mass Storage mode.
1457 * This is used mainly for the USB Settings panel.
1458 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1459 * when the SD card file system is mounted or unmounted
1460 */
1461 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1462 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1463
1464 /**
1465 * Broadcast Action: External media has been removed.
1466 * The path to the mount point for the removed media is contained in the Intent.mData field.
1467 */
1468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1469 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1470
1471 /**
1472 * Broadcast Action: External media is present, but not mounted at its mount point.
1473 * The path to the mount point for the removed media is contained in the Intent.mData field.
1474 */
1475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1476 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1477
1478 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001479 * Broadcast Action: External media is present, and being disk-checked
1480 * 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 -08001481 */
1482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1483 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1484
1485 /**
1486 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1487 * 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 -08001488 */
1489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1490 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1491
1492 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001493 * Broadcast Action: External media is present and mounted at its mount point.
1494 * The path to the mount point for the removed media is contained in the Intent.mData field.
1495 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1496 * media was mounted read only.
1497 */
1498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1499 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1500
1501 /**
1502 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1503 * The path to the mount point for the removed media is contained in the Intent.mData field.
1504 */
1505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1506 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1507
1508 /**
1509 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1510 * The path to the mount point for the removed media is contained in the Intent.mData field.
1511 */
1512 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1513 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1514
1515 /**
1516 * Broadcast Action: External media is present but cannot be mounted.
1517 * The path to the mount point for the removed media is contained in the Intent.mData field.
1518 */
1519 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1520 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1521
1522 /**
1523 * Broadcast Action: User has expressed the desire to remove the external storage media.
1524 * Applications should close all files they have open within the mount point when they receive this intent.
1525 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1526 */
1527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1528 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1529
1530 /**
1531 * Broadcast Action: The media scanner has started scanning a directory.
1532 * The path to the directory being scanned is contained in the Intent.mData field.
1533 */
1534 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1535 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1536
1537 /**
1538 * Broadcast Action: The media scanner has finished scanning a directory.
1539 * The path to the scanned directory is contained in the Intent.mData field.
1540 */
1541 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1542 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1543
1544 /**
1545 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1546 * The path to the file is contained in the Intent.mData field.
1547 */
1548 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1549 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1550
1551 /**
1552 * Broadcast Action: The "Media Button" was pressed. Includes a single
1553 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1554 * caused the broadcast.
1555 */
1556 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1557 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1558
1559 /**
1560 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1561 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1562 * caused the broadcast.
1563 */
1564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1565 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1566
1567 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1568 // location; they are not general-purpose actions.
1569
1570 /**
1571 * Broadcast Action: An GTalk connection has been established.
1572 */
1573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1574 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1575 "android.intent.action.GTALK_CONNECTED";
1576
1577 /**
1578 * Broadcast Action: An GTalk connection has been disconnected.
1579 */
1580 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1581 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1582 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001583
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001584 /**
1585 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001586 */
1587 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1588 public static final String ACTION_INPUT_METHOD_CHANGED =
1589 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001590
1591 /**
1592 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1593 * more radios have been turned off or on. The intent will have the following extra value:</p>
1594 * <ul>
1595 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1596 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1597 * turned off</li>
1598 * </ul>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001599 *
1600 * <p class="note">This is a protected intent that can only be sent
1601 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001602 */
1603 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1604 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1605
1606 /**
1607 * Broadcast Action: Some content providers have parts of their namespace
1608 * where they publish new events or items that the user may be especially
1609 * interested in. For these things, they may broadcast this action when the
1610 * set of interesting items change.
1611 *
1612 * For example, GmailProvider sends this notification when the set of unread
1613 * mail in the inbox changes.
1614 *
1615 * <p>The data of the intent identifies which part of which provider
1616 * changed. When queried through the content resolver, the data URI will
1617 * return the data set in question.
1618 *
1619 * <p>The intent will have the following extra values:
1620 * <ul>
1621 * <li><em>count</em> - The number of items in the data set. This is the
1622 * same as the number of items in the cursor returned by querying the
1623 * data URI. </li>
1624 * </ul>
1625 *
1626 * This intent will be sent at boot (if the count is non-zero) and when the
1627 * data set changes. It is possible for the data set to change without the
1628 * count changing (for example, if a new unread message arrives in the same
1629 * sync operation in which a message is archived). The phone should still
1630 * ring/vibrate/etc as normal in this case.
1631 */
1632 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1633 public static final String ACTION_PROVIDER_CHANGED =
1634 "android.intent.action.PROVIDER_CHANGED";
1635
1636 /**
1637 * Broadcast Action: Wired Headset plugged in or unplugged.
1638 *
1639 * <p>The intent will have the following extra values:
1640 * <ul>
1641 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1642 * <li><em>name</em> - Headset type, human readable string </li>
1643 * </ul>
1644 * </ul>
1645 */
1646 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1647 public static final String ACTION_HEADSET_PLUG =
1648 "android.intent.action.HEADSET_PLUG";
1649
1650 /**
1651 * Broadcast Action: An outgoing call is about to be placed.
1652 *
1653 * <p>The Intent will have the following extra value:
1654 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001655 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001656 * the phone number originally intended to be dialed.</li>
1657 * </ul>
1658 * <p>Once the broadcast is finished, the resultData is used as the actual
1659 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001660 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001661 * outgoing call in turn: for example, a parental control application
1662 * might verify that the user is authorized to place the call at that
1663 * time, then a number-rewriting application might add an area code if
1664 * one was not specified.</p>
1665 * <p>For consistency, any receiver whose purpose is to prohibit phone
1666 * calls should have a priority of 0, to ensure it will see the final
1667 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001668 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001669 * should have a positive priority.
1670 * Negative priorities are reserved for the system for this broadcast;
1671 * using them may cause problems.</p>
1672 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1673 * abort the broadcast.</p>
1674 * <p>Emergency calls cannot be intercepted using this mechanism, and
1675 * other calls cannot be modified to call emergency numbers using this
1676 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001677 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001678 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1679 * permission to receive this Intent.</p>
Dianne Hackborn854060af2009-07-09 18:14:31 -07001680 *
1681 * <p class="note">This is a protected intent that can only be sent
1682 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1685 public static final String ACTION_NEW_OUTGOING_CALL =
1686 "android.intent.action.NEW_OUTGOING_CALL";
1687
1688 /**
1689 * Broadcast Action: Have the device reboot. This is only for use by
1690 * system code.
Dianne Hackborn854060af2009-07-09 18:14:31 -07001691 *
1692 * <p class="note">This is a protected intent that can only be sent
1693 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001694 */
1695 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1696 public static final String ACTION_REBOOT =
1697 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001698
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001699
Wei Huang97ecc9c2009-05-11 17:44:20 -07001700 /**
1701 * Broadcast Action: a remote intent is to be broadcasted.
1702 *
1703 * A remote intent is used for remote RPC between devices. The remote intent
1704 * is serialized and sent from one device to another device. The receiving
1705 * device parses the remote intent and broadcasts it. Note that anyone can
1706 * broadcast a remote intent. However, if the intent receiver of the remote intent
1707 * does not trust intent broadcasts from arbitrary intent senders, it should require
1708 * the sender to hold certain permissions so only trusted sender's broadcast will be
1709 * let through.
1710 */
1711 public static final String ACTION_REMOTE_INTENT =
1712 "android.intent.action.REMOTE_INTENT";
1713
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001714 // ---------------------------------------------------------------------
1715 // ---------------------------------------------------------------------
1716 // Standard intent categories (see addCategory()).
1717
1718 /**
1719 * Set if the activity should be an option for the default action
1720 * (center press) to perform on a piece of data. Setting this will
1721 * hide from the user any activities without it set when performing an
1722 * action on some data. Note that this is normal -not- set in the
1723 * Intent when initiating an action -- it is for use in intent filters
1724 * specified in packages.
1725 */
1726 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1727 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1728 /**
1729 * Activities that can be safely invoked from a browser must support this
1730 * category. For example, if the user is viewing a web page or an e-mail
1731 * and clicks on a link in the text, the Intent generated execute that
1732 * link will require the BROWSABLE category, so that only activities
1733 * supporting this category will be considered as possible actions. By
1734 * supporting this category, you are promising that there is nothing
1735 * damaging (without user intervention) that can happen by invoking any
1736 * matching Intent.
1737 */
1738 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1739 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1740 /**
1741 * Set if the activity should be considered as an alternative action to
1742 * the data the user is currently viewing. See also
1743 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1744 * applies to the selection in a list of items.
1745 *
1746 * <p>Supporting this category means that you would like your activity to be
1747 * displayed in the set of alternative things the user can do, usually as
1748 * part of the current activity's options menu. You will usually want to
1749 * include a specific label in the &lt;intent-filter&gt; of this action
1750 * describing to the user what it does.
1751 *
1752 * <p>The action of IntentFilter with this category is important in that it
1753 * describes the specific action the target will perform. This generally
1754 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1755 * a specific name such as "com.android.camera.action.CROP. Only one
1756 * alternative of any particular action will be shown to the user, so using
1757 * a specific action like this makes sure that your alternative will be
1758 * displayed while also allowing other applications to provide their own
1759 * overrides of that particular action.
1760 */
1761 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1762 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1763 /**
1764 * Set if the activity should be considered as an alternative selection
1765 * action to the data the user has currently selected. This is like
1766 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1767 * of items from which the user can select, giving them alternatives to the
1768 * default action that will be performed on it.
1769 */
1770 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1771 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1772 /**
1773 * Intended to be used as a tab inside of an containing TabActivity.
1774 */
1775 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1776 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1777 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001778 * Should be displayed in the top-level launcher.
1779 */
1780 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1781 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1782 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001783 * Provides information about the package it is in; typically used if
1784 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1785 * a front-door to the user without having to be shown in the all apps list.
1786 */
1787 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1788 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1789 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001790 * This is the home activity, that is the first activity that is displayed
1791 * when the device boots.
1792 */
1793 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1794 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1795 /**
1796 * This activity is a preference panel.
1797 */
1798 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1799 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1800 /**
1801 * This activity is a development preference panel.
1802 */
1803 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1804 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1805 /**
1806 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001807 */
1808 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1809 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1810 /**
1811 * This activity may be exercised by the monkey or other automated test tools.
1812 */
1813 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1814 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1815 /**
1816 * To be used as a test (not part of the normal user experience).
1817 */
1818 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1819 /**
1820 * To be used as a unit test (run through the Test Harness).
1821 */
1822 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1823 /**
1824 * To be used as an sample code example (not part of the normal user
1825 * experience).
1826 */
1827 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1828 /**
1829 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1830 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1831 * when queried, though it is allowable for those columns to be blank.
1832 */
1833 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1834 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1835
1836 /**
1837 * To be used as code under test for framework instrumentation tests.
1838 */
1839 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1840 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001841
1842 /**
1843 * Broadcast Action: The phone was docked or undocked. Includes the extra
1844 * field {@link #EXTRA_DOCK_STATE}, containing the current dock state.
1845 * @hide
1846 */
1847 public static final String ACTION_DOCK_EVENT = "android.intent.action.DOCK_EVENT";
1848
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001849 // ---------------------------------------------------------------------
1850 // ---------------------------------------------------------------------
1851 // Standard extra data keys.
1852
1853 /**
1854 * The initial data to place in a newly created record. Use with
1855 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1856 * fields as would be given to the underlying ContentProvider.insert()
1857 * call.
1858 */
1859 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1860
1861 /**
1862 * A constant CharSequence that is associated with the Intent, used with
1863 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1864 * this may be a styled CharSequence, so you must use
1865 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1866 * retrieve it.
1867 */
1868 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1869
1870 /**
1871 * A content: URI holding a stream of data associated with the Intent,
1872 * used with {@link #ACTION_SEND} to supply the data being sent.
1873 */
1874 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1875
1876 /**
1877 * A String[] holding e-mail addresses that should be delivered to.
1878 */
1879 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1880
1881 /**
1882 * A String[] holding e-mail addresses that should be carbon copied.
1883 */
1884 public static final String EXTRA_CC = "android.intent.extra.CC";
1885
1886 /**
1887 * A String[] holding e-mail addresses that should be blind carbon copied.
1888 */
1889 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1890
1891 /**
1892 * A constant string holding the desired subject line of a message.
1893 */
1894 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1895
1896 /**
1897 * An Intent describing the choices you would like shown with
1898 * {@link #ACTION_PICK_ACTIVITY}.
1899 */
1900 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1901
1902 /**
1903 * A CharSequence dialog title to provide to the user when used with a
1904 * {@link #ACTION_CHOOSER}.
1905 */
1906 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
1907
1908 /**
1909 * A {@link android.view.KeyEvent} object containing the event that
1910 * triggered the creation of the Intent it is in.
1911 */
1912 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
1913
1914 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001915 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
1916 * before shutting down.
1917 *
1918 * {@hide}
1919 */
1920 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
1921
1922 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001923 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1924 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
1925 * of restarting the application.
1926 */
1927 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
1928
1929 /**
1930 * A String holding the phone number originally entered in
1931 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
1932 * number to call in a {@link android.content.Intent#ACTION_CALL}.
1933 */
1934 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
1935 /**
1936 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
1937 * intents to supply the uid the package had been assigned. Also an optional
1938 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1939 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
1940 * purpose.
1941 */
1942 public static final String EXTRA_UID = "android.intent.extra.UID";
1943
1944 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001945 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1946 * intents to indicate whether this represents a full uninstall (removing
1947 * both the code and its data) or a partial uninstall (leaving its data,
1948 * implying that this is an update).
1949 */
1950 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001951
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001952 /**
1953 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1954 * intents to indicate that this is a replacement of the package, so this
1955 * broadcast will immediately be followed by an add broadcast for a
1956 * different version of the same package.
1957 */
1958 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07001959
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001960 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001961 * Used as an int extra field in {@link android.app.AlarmManager} intents
1962 * to tell the application being invoked how many pending alarms are being
1963 * delievered with the intent. For one-shot alarms this will always be 1.
1964 * For recurring alarms, this might be greater than 1 if the device was
1965 * asleep or powered off at the time an earlier alarm would have been
1966 * delivered.
1967 */
1968 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07001969
Jacek Surazski86b6c532009-05-13 14:38:28 +02001970 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001971 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
1972 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07001973 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
1974 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
1975 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001976 * @hide
1977 */
1978 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
1979
1980 /**
1981 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
1982 * to represent that the phone is not in any dock.
1983 * @hide
1984 */
1985 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
1986
1987 /**
1988 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
1989 * to represent that the phone is in a desk dock.
1990 * @hide
1991 */
1992 public static final int EXTRA_DOCK_STATE_DESK = 1;
1993
1994 /**
1995 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
1996 * to represent that the phone is in a car dock.
1997 * @hide
1998 */
1999 public static final int EXTRA_DOCK_STATE_CAR = 2;
2000
2001 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002002 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2003 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002004 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002005 * @hide
2006 */
2007 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2008
2009 /**
Romain Guy4969af72009-06-17 10:53:19 -07002010 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002011 * package. Specifies the installer package name; this package will receive the
2012 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002013 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002014 * @hide
2015 */
Romain Guy4969af72009-06-17 10:53:19 -07002016 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002017 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002018
Wei Huang97ecc9c2009-05-11 17:44:20 -07002019 /**
2020 * Used in the extra field in the remote intent. It's astring token passed with the
2021 * remote intent.
2022 */
2023 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2024 "android.intent.extra.remote_intent_token";
2025
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002026 // ---------------------------------------------------------------------
2027 // ---------------------------------------------------------------------
2028 // Intent flags (see mFlags variable).
2029
2030 /**
2031 * If set, the recipient of this Intent will be granted permission to
2032 * perform read operations on the Uri in the Intent's data.
2033 */
2034 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2035 /**
2036 * If set, the recipient of this Intent will be granted permission to
2037 * perform write operations on the Uri in the Intent's data.
2038 */
2039 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2040 /**
2041 * Can be set by the caller to indicate that this Intent is coming from
2042 * a background operation, not from direct user interaction.
2043 */
2044 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2045 /**
2046 * A flag you can enable for debugging: when set, log messages will be
2047 * printed during the resolution of this intent to show you what has
2048 * been found to create the final resolved list.
2049 */
2050 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
2051
2052 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002053 * If set, the new activity is not kept in the history stack. As soon as
2054 * the user navigates away from it, the activity is finished. This may also
2055 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2056 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002057 */
2058 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2059 /**
2060 * If set, the activity will not be launched if it is already running
2061 * at the top of the history stack.
2062 */
2063 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2064 /**
2065 * If set, this activity will become the start of a new task on this
2066 * history stack. A task (from the activity that started it to the
2067 * next task activity) defines an atomic group of activities that the
2068 * user can move to. Tasks can be moved to the foreground and background;
2069 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002070 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002071 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2072 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002073 *
2074 * <p>This flag is generally used by activities that want
2075 * to present a "launcher" style behavior: they give the user a list of
2076 * separate things that can be done, which otherwise run completely
2077 * independently of the activity launching them.
2078 *
2079 * <p>When using this flag, if a task is already running for the activity
2080 * you are now starting, then a new activity will not be started; instead,
2081 * the current task will simply be brought to the front of the screen with
2082 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2083 * to disable this behavior.
2084 *
2085 * <p>This flag can not be used when the caller is requesting a result from
2086 * the activity being launched.
2087 */
2088 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2089 /**
2090 * <strong>Do not use this flag unless you are implementing your own
2091 * top-level application launcher.</strong> Used in conjunction with
2092 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2093 * behavior of bringing an existing task to the foreground. When set,
2094 * a new task is <em>always</em> started to host the Activity for the
2095 * Intent, regardless of whether there is already an existing task running
2096 * the same thing.
2097 *
2098 * <p><strong>Because the default system does not include graphical task management,
2099 * you should not use this flag unless you provide some way for a user to
2100 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002101 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002102 * <p>This flag is ignored if
2103 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2104 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002105 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2106 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002107 */
2108 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2109 /**
2110 * If set, and the activity being launched is already running in the
2111 * current task, then instead of launching a new instance of that activity,
2112 * all of the other activities on top of it will be closed and this Intent
2113 * will be delivered to the (now on top) old activity as a new Intent.
2114 *
2115 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2116 * If D calls startActivity() with an Intent that resolves to the component
2117 * of activity B, then C and D will be finished and B receive the given
2118 * Intent, resulting in the stack now being: A, B.
2119 *
2120 * <p>The currently running instance of task B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002121 * either receive the new intent you are starting here in its
2122 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002123 * new intent. If it has declared its launch mode to be "multiple" (the
2124 * default) it will be finished and re-created; for all other launch modes
2125 * it will receive the Intent in the current instance.
2126 *
2127 * <p>This launch mode can also be used to good effect in conjunction with
2128 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2129 * of a task, it will bring any currently running instance of that task
2130 * to the foreground, and then clear it to its root state. This is
2131 * especially useful, for example, when launching an activity from the
2132 * notification manager.
2133 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002134 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2135 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002136 */
2137 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2138 /**
2139 * If set and this intent is being used to launch a new activity from an
2140 * existing one, then the reply target of the existing activity will be
2141 * transfered to the new activity. This way the new activity can call
2142 * {@link android.app.Activity#setResult} and have that result sent back to
2143 * the reply target of the original activity.
2144 */
2145 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2146 /**
2147 * If set and this intent is being used to launch a new activity from an
2148 * existing one, the current activity will not be counted as the top
2149 * activity for deciding whether the new intent should be delivered to
2150 * the top instead of starting a new one. The previous activity will
2151 * be used as the top, with the assumption being that the current activity
2152 * will finish itself immediately.
2153 */
2154 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2155 /**
2156 * If set, the new activity is not kept in the list of recently launched
2157 * activities.
2158 */
2159 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2160 /**
2161 * This flag is not normally set by application code, but set for you by
2162 * the system as described in the
2163 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2164 * launchMode} documentation for the singleTask mode.
2165 */
2166 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2167 /**
2168 * If set, and this activity is either being started in a new task or
2169 * bringing to the top an existing task, then it will be launched as
2170 * the front door of the task. This will result in the application of
2171 * any affinities needed to have that task in the proper state (either
2172 * moving activities to or from it), or simply resetting that task to
2173 * its initial state if needed.
2174 */
2175 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2176 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002177 * This flag is not normally set by application code, but set for you by
2178 * the system if this activity is being launched from history
2179 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002180 */
2181 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002182 /**
2183 * If set, this marks a point in the task's activity stack that should
2184 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002185 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002186 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2187 * the user re-launching it from home), this activity and all on top of
2188 * it will be finished so that the user does not return to them, but
2189 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002190 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002191 * <p>This is useful for cases where you have a logical break in your
2192 * application. For example, an e-mail application may have a command
2193 * to view an attachment, which launches an image view activity to
2194 * display it. This activity should be part of the e-mail application's
2195 * task, since it is a part of the task the user is involved in. However,
2196 * if the user leaves that task, and later selects the e-mail app from
2197 * home, we may like them to return to the conversation they were
2198 * viewing, not the picture attachment, since that is confusing. By
2199 * setting this flag when launching the image viewer, that viewer and
2200 * any activities it starts will be removed the next time the user returns
2201 * to mail.
2202 */
2203 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002204 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002205 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002206 * callback from occurring on the current frontmost activity before it is
2207 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002208 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002209 * <p>Typically, an activity can rely on that callback to indicate that an
2210 * explicit user action has caused their activity to be moved out of the
2211 * foreground. The callback marks an appropriate point in the activity's
2212 * lifecycle for it to dismiss any notifications that it intends to display
2213 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002214 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002215 * <p>If an activity is ever started via any non-user-driven events such as
2216 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2217 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002218 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002219 */
2220 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002221 /**
2222 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2223 * this flag will cause the launched activity to be brought to the front of its
2224 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002225 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002226 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2227 * If D calls startActivity() with an Intent that resolves to the component
2228 * of activity B, then B will be brought to the front of the history stack,
2229 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002230 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002231 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002232 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002233 */
2234 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002235 /**
2236 * If set, when sending a broadcast only registered receivers will be
2237 * called -- no BroadcastReceiver components will be launched.
2238 */
2239 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002240 /**
2241 * If set, when sending a broadcast <i>before boot has completed</i> only
2242 * registered receivers will be called -- no BroadcastReceiver components
2243 * will be launched. Sticky intent state will be recorded properly even
2244 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2245 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002246 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002247 * <p>This flag is only for use by system sevices as a convenience to
2248 * avoid having to implement a more complex mechanism around detection
2249 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002250 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002251 * @hide
2252 */
2253 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002254
2255 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002256 // ---------------------------------------------------------------------
2257 // toUri() and parseUri() options.
2258
2259 /**
2260 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2261 * always has the "intent:" scheme. This syntax can be used when you want
2262 * to later disambiguate between URIs that are intended to describe an
2263 * Intent vs. all others that should be treated as raw URIs. When used
2264 * with {@link #parseUri}, any other scheme will result in a generic
2265 * VIEW action for that raw URI.
2266 */
2267 public static final int URI_INTENT_SCHEME = 1<<0;
2268
2269 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002270
2271 private String mAction;
2272 private Uri mData;
2273 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002274 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 private ComponentName mComponent;
2276 private int mFlags;
2277 private HashSet<String> mCategories;
2278 private Bundle mExtras;
2279
2280 // ---------------------------------------------------------------------
2281
2282 /**
2283 * Create an empty intent.
2284 */
2285 public Intent() {
2286 }
2287
2288 /**
2289 * Copy constructor.
2290 */
2291 public Intent(Intent o) {
2292 this.mAction = o.mAction;
2293 this.mData = o.mData;
2294 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002295 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002296 this.mComponent = o.mComponent;
2297 this.mFlags = o.mFlags;
2298 if (o.mCategories != null) {
2299 this.mCategories = new HashSet<String>(o.mCategories);
2300 }
2301 if (o.mExtras != null) {
2302 this.mExtras = new Bundle(o.mExtras);
2303 }
2304 }
2305
2306 @Override
2307 public Object clone() {
2308 return new Intent(this);
2309 }
2310
2311 private Intent(Intent o, boolean all) {
2312 this.mAction = o.mAction;
2313 this.mData = o.mData;
2314 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002315 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002316 this.mComponent = o.mComponent;
2317 if (o.mCategories != null) {
2318 this.mCategories = new HashSet<String>(o.mCategories);
2319 }
2320 }
2321
2322 /**
2323 * Make a clone of only the parts of the Intent that are relevant for
2324 * filter matching: the action, data, type, component, and categories.
2325 */
2326 public Intent cloneFilter() {
2327 return new Intent(this, false);
2328 }
2329
2330 /**
2331 * Create an intent with a given action. All other fields (data, type,
2332 * class) are null. Note that the action <em>must</em> be in a
2333 * namespace because Intents are used globally in the system -- for
2334 * example the system VIEW action is android.intent.action.VIEW; an
2335 * application's custom action would be something like
2336 * com.google.app.myapp.CUSTOM_ACTION.
2337 *
2338 * @param action The Intent action, such as ACTION_VIEW.
2339 */
2340 public Intent(String action) {
2341 mAction = action;
2342 }
2343
2344 /**
2345 * Create an intent with a given action and for a given data url. Note
2346 * that the action <em>must</em> be in a namespace because Intents are
2347 * used globally in the system -- for example the system VIEW action is
2348 * android.intent.action.VIEW; an application's custom action would be
2349 * something like com.google.app.myapp.CUSTOM_ACTION.
2350 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002351 * <p><em>Note: scheme and host name matching in the Android framework is
2352 * case-sensitive, unlike the formal RFC. As a result,
2353 * you should always ensure that you write your Uri with these elements
2354 * using lower case letters, and normalize any Uris you receive from
2355 * outside of Android to ensure the scheme and host is lower case.</em></p>
2356 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002357 * @param action The Intent action, such as ACTION_VIEW.
2358 * @param uri The Intent data URI.
2359 */
2360 public Intent(String action, Uri uri) {
2361 mAction = action;
2362 mData = uri;
2363 }
2364
2365 /**
2366 * Create an intent for a specific component. All other fields (action, data,
2367 * type, class) are null, though they can be modified later with explicit
2368 * calls. This provides a convenient way to create an intent that is
2369 * intended to execute a hard-coded class name, rather than relying on the
2370 * system to find an appropriate class for you; see {@link #setComponent}
2371 * for more information on the repercussions of this.
2372 *
2373 * @param packageContext A Context of the application package implementing
2374 * this class.
2375 * @param cls The component class that is to be used for the intent.
2376 *
2377 * @see #setClass
2378 * @see #setComponent
2379 * @see #Intent(String, android.net.Uri , Context, Class)
2380 */
2381 public Intent(Context packageContext, Class<?> cls) {
2382 mComponent = new ComponentName(packageContext, cls);
2383 }
2384
2385 /**
2386 * Create an intent for a specific component with a specified action and data.
2387 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2388 * construct the Intent and then calling {@link #setClass} to set its
2389 * class.
2390 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002391 * <p><em>Note: scheme and host name matching in the Android framework is
2392 * case-sensitive, unlike the formal RFC. As a result,
2393 * you should always ensure that you write your Uri with these elements
2394 * using lower case letters, and normalize any Uris you receive from
2395 * outside of Android to ensure the scheme and host is lower case.</em></p>
2396 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002397 * @param action The Intent action, such as ACTION_VIEW.
2398 * @param uri The Intent data URI.
2399 * @param packageContext A Context of the application package implementing
2400 * this class.
2401 * @param cls The component class that is to be used for the intent.
2402 *
2403 * @see #Intent(String, android.net.Uri)
2404 * @see #Intent(Context, Class)
2405 * @see #setClass
2406 * @see #setComponent
2407 */
2408 public Intent(String action, Uri uri,
2409 Context packageContext, Class<?> cls) {
2410 mAction = action;
2411 mData = uri;
2412 mComponent = new ComponentName(packageContext, cls);
2413 }
2414
2415 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002416 * Call {@link #parseUri} with 0 flags.
2417 * @deprecated Use {@link #parseUri} instead.
2418 */
2419 @Deprecated
2420 public static Intent getIntent(String uri) throws URISyntaxException {
2421 return parseUri(uri, 0);
2422 }
2423
2424 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002425 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002426 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002427 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002428 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002429 *
2430 * <p>The URI given here must not be relative -- that is, it must include
2431 * the scheme and full path.
2432 *
2433 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002434 * @param flags Additional processing flags. Either 0 or
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002435 *
2436 * @return Intent The newly created Intent object.
2437 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002438 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2439 * it bad (as parsed by the Uri class) or the Intent data within the
2440 * URI is invalid.
2441 *
2442 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002443 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002444 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002445 int i = 0;
2446 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002447 // Validate intent scheme for if requested.
2448 if ((flags&URI_INTENT_SCHEME) != 0) {
2449 if (!uri.startsWith("intent:")) {
2450 Intent intent = new Intent(ACTION_VIEW);
2451 try {
2452 intent.setData(Uri.parse(uri));
2453 } catch (IllegalArgumentException e) {
2454 throw new URISyntaxException(uri, e.getMessage());
2455 }
2456 return intent;
2457 }
2458 }
2459
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002460 // simple case
2461 i = uri.lastIndexOf("#");
2462 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2463
2464 // old format Intent URI
2465 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002466
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002467 // new format
2468 Intent intent = new Intent(ACTION_VIEW);
2469
2470 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002471 String data = i >= 0 ? uri.substring(0, i) : null;
2472 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002473 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002474
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002475 // loop over contents of Intent, all name=value;
2476 while (!uri.startsWith("end", i)) {
2477 int eq = uri.indexOf('=', i);
2478 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002479 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002480
2481 // action
2482 if (uri.startsWith("action=", i)) {
2483 intent.mAction = value;
2484 }
2485
2486 // categories
2487 else if (uri.startsWith("category=", i)) {
2488 intent.addCategory(value);
2489 }
2490
2491 // type
2492 else if (uri.startsWith("type=", i)) {
2493 intent.mType = value;
2494 }
2495
2496 // launch flags
2497 else if (uri.startsWith("launchFlags=", i)) {
2498 intent.mFlags = Integer.decode(value).intValue();
2499 }
2500
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002501 // package
2502 else if (uri.startsWith("package=", i)) {
2503 intent.mPackage = value;
2504 }
2505
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002506 // component
2507 else if (uri.startsWith("component=", i)) {
2508 intent.mComponent = ComponentName.unflattenFromString(value);
2509 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002510
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002511 // scheme
2512 else if (uri.startsWith("scheme=", i)) {
2513 scheme = value;
2514 }
2515
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002516 // extra
2517 else {
2518 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002519 // create Bundle if it doesn't already exist
2520 if (intent.mExtras == null) intent.mExtras = new Bundle();
2521 Bundle b = intent.mExtras;
2522 // add EXTRA
2523 if (uri.startsWith("S.", i)) b.putString(key, value);
2524 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2525 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2526 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2527 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2528 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2529 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2530 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2531 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2532 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2533 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002534
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002535 // move to the next item
2536 i = semi + 1;
2537 }
2538
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002539 if (data != null) {
2540 if (data.startsWith("intent:")) {
2541 data = data.substring(7);
2542 if (scheme != null) {
2543 data = scheme + ':' + data;
2544 }
2545 }
2546
2547 if (data.length() > 0) {
2548 try {
2549 intent.mData = Uri.parse(data);
2550 } catch (IllegalArgumentException e) {
2551 throw new URISyntaxException(uri, e.getMessage());
2552 }
2553 }
2554 }
2555
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002556 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002557
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002558 } catch (IndexOutOfBoundsException e) {
2559 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2560 }
2561 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002562
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002563 public static Intent getIntentOld(String uri) throws URISyntaxException {
2564 Intent intent;
2565
2566 int i = uri.lastIndexOf('#');
2567 if (i >= 0) {
2568 Uri data = null;
2569 String action = null;
2570 if (i > 0) {
2571 data = Uri.parse(uri.substring(0, i));
2572 }
2573
2574 i++;
2575
2576 if (uri.regionMatches(i, "action(", 0, 7)) {
2577 i += 7;
2578 int j = uri.indexOf(')', i);
2579 action = uri.substring(i, j);
2580 i = j + 1;
2581 }
2582
2583 intent = new Intent(action, data);
2584
2585 if (uri.regionMatches(i, "categories(", 0, 11)) {
2586 i += 11;
2587 int j = uri.indexOf(')', i);
2588 while (i < j) {
2589 int sep = uri.indexOf('!', i);
2590 if (sep < 0) sep = j;
2591 if (i < sep) {
2592 intent.addCategory(uri.substring(i, sep));
2593 }
2594 i = sep + 1;
2595 }
2596 i = j + 1;
2597 }
2598
2599 if (uri.regionMatches(i, "type(", 0, 5)) {
2600 i += 5;
2601 int j = uri.indexOf(')', i);
2602 intent.mType = uri.substring(i, j);
2603 i = j + 1;
2604 }
2605
2606 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
2607 i += 12;
2608 int j = uri.indexOf(')', i);
2609 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2610 i = j + 1;
2611 }
2612
2613 if (uri.regionMatches(i, "component(", 0, 10)) {
2614 i += 10;
2615 int j = uri.indexOf(')', i);
2616 int sep = uri.indexOf('!', i);
2617 if (sep >= 0 && sep < j) {
2618 String pkg = uri.substring(i, sep);
2619 String cls = uri.substring(sep + 1, j);
2620 intent.mComponent = new ComponentName(pkg, cls);
2621 }
2622 i = j + 1;
2623 }
2624
2625 if (uri.regionMatches(i, "extras(", 0, 7)) {
2626 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002627
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002628 final int closeParen = uri.indexOf(')', i);
2629 if (closeParen == -1) throw new URISyntaxException(uri,
2630 "EXTRA missing trailing ')'", i);
2631
2632 while (i < closeParen) {
2633 // fetch the key value
2634 int j = uri.indexOf('=', i);
2635 if (j <= i + 1 || i >= closeParen) {
2636 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2637 }
2638 char type = uri.charAt(i);
2639 i++;
2640 String key = uri.substring(i, j);
2641 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002642
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002643 // get type-value
2644 j = uri.indexOf('!', i);
2645 if (j == -1 || j >= closeParen) j = closeParen;
2646 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2647 String value = uri.substring(i, j);
2648 i = j;
2649
2650 // create Bundle if it doesn't already exist
2651 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002652
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002653 // add item to bundle
2654 try {
2655 switch (type) {
2656 case 'S':
2657 intent.mExtras.putString(key, Uri.decode(value));
2658 break;
2659 case 'B':
2660 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2661 break;
2662 case 'b':
2663 intent.mExtras.putByte(key, Byte.parseByte(value));
2664 break;
2665 case 'c':
2666 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2667 break;
2668 case 'd':
2669 intent.mExtras.putDouble(key, Double.parseDouble(value));
2670 break;
2671 case 'f':
2672 intent.mExtras.putFloat(key, Float.parseFloat(value));
2673 break;
2674 case 'i':
2675 intent.mExtras.putInt(key, Integer.parseInt(value));
2676 break;
2677 case 'l':
2678 intent.mExtras.putLong(key, Long.parseLong(value));
2679 break;
2680 case 's':
2681 intent.mExtras.putShort(key, Short.parseShort(value));
2682 break;
2683 default:
2684 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2685 }
2686 } catch (NumberFormatException e) {
2687 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2688 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002689
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002690 char ch = uri.charAt(i);
2691 if (ch == ')') break;
2692 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2693 i++;
2694 }
2695 }
2696
2697 if (intent.mAction == null) {
2698 // By default, if no action is specified, then use VIEW.
2699 intent.mAction = ACTION_VIEW;
2700 }
2701
2702 } else {
2703 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2704 }
2705
2706 return intent;
2707 }
2708
2709 /**
2710 * Retrieve the general action to be performed, such as
2711 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2712 * the information in the intent should be interpreted -- most importantly,
2713 * what to do with the data returned by {@link #getData}.
2714 *
2715 * @return The action of this intent or null if none is specified.
2716 *
2717 * @see #setAction
2718 */
2719 public String getAction() {
2720 return mAction;
2721 }
2722
2723 /**
2724 * Retrieve data this intent is operating on. This URI specifies the name
2725 * of the data; often it uses the content: scheme, specifying data in a
2726 * content provider. Other schemes may be handled by specific activities,
2727 * such as http: by the web browser.
2728 *
2729 * @return The URI of the data this intent is targeting or null.
2730 *
2731 * @see #getScheme
2732 * @see #setData
2733 */
2734 public Uri getData() {
2735 return mData;
2736 }
2737
2738 /**
2739 * The same as {@link #getData()}, but returns the URI as an encoded
2740 * String.
2741 */
2742 public String getDataString() {
2743 return mData != null ? mData.toString() : null;
2744 }
2745
2746 /**
2747 * Return the scheme portion of the intent's data. If the data is null or
2748 * does not include a scheme, null is returned. Otherwise, the scheme
2749 * prefix without the final ':' is returned, i.e. "http".
2750 *
2751 * <p>This is the same as calling getData().getScheme() (and checking for
2752 * null data).
2753 *
2754 * @return The scheme of this intent.
2755 *
2756 * @see #getData
2757 */
2758 public String getScheme() {
2759 return mData != null ? mData.getScheme() : null;
2760 }
2761
2762 /**
2763 * Retrieve any explicit MIME type included in the intent. This is usually
2764 * null, as the type is determined by the intent data.
2765 *
2766 * @return If a type was manually set, it is returned; else null is
2767 * returned.
2768 *
2769 * @see #resolveType(ContentResolver)
2770 * @see #setType
2771 */
2772 public String getType() {
2773 return mType;
2774 }
2775
2776 /**
2777 * Return the MIME data type of this intent. If the type field is
2778 * explicitly set, that is simply returned. Otherwise, if the data is set,
2779 * the type of that data is returned. If neither fields are set, a null is
2780 * returned.
2781 *
2782 * @return The MIME type of this intent.
2783 *
2784 * @see #getType
2785 * @see #resolveType(ContentResolver)
2786 */
2787 public String resolveType(Context context) {
2788 return resolveType(context.getContentResolver());
2789 }
2790
2791 /**
2792 * Return the MIME data type of this intent. If the type field is
2793 * explicitly set, that is simply returned. Otherwise, if the data is set,
2794 * the type of that data is returned. If neither fields are set, a null is
2795 * returned.
2796 *
2797 * @param resolver A ContentResolver that can be used to determine the MIME
2798 * type of the intent's data.
2799 *
2800 * @return The MIME type of this intent.
2801 *
2802 * @see #getType
2803 * @see #resolveType(Context)
2804 */
2805 public String resolveType(ContentResolver resolver) {
2806 if (mType != null) {
2807 return mType;
2808 }
2809 if (mData != null) {
2810 if ("content".equals(mData.getScheme())) {
2811 return resolver.getType(mData);
2812 }
2813 }
2814 return null;
2815 }
2816
2817 /**
2818 * Return the MIME data type of this intent, only if it will be needed for
2819 * intent resolution. This is not generally useful for application code;
2820 * it is used by the frameworks for communicating with back-end system
2821 * services.
2822 *
2823 * @param resolver A ContentResolver that can be used to determine the MIME
2824 * type of the intent's data.
2825 *
2826 * @return The MIME type of this intent, or null if it is unknown or not
2827 * needed.
2828 */
2829 public String resolveTypeIfNeeded(ContentResolver resolver) {
2830 if (mComponent != null) {
2831 return mType;
2832 }
2833 return resolveType(resolver);
2834 }
2835
2836 /**
2837 * Check if an category exists in the intent.
2838 *
2839 * @param category The category to check.
2840 *
2841 * @return boolean True if the intent contains the category, else false.
2842 *
2843 * @see #getCategories
2844 * @see #addCategory
2845 */
2846 public boolean hasCategory(String category) {
2847 return mCategories != null && mCategories.contains(category);
2848 }
2849
2850 /**
2851 * Return the set of all categories in the intent. If there are no categories,
2852 * returns NULL.
2853 *
2854 * @return Set The set of categories you can examine. Do not modify!
2855 *
2856 * @see #hasCategory
2857 * @see #addCategory
2858 */
2859 public Set<String> getCategories() {
2860 return mCategories;
2861 }
2862
2863 /**
2864 * Sets the ClassLoader that will be used when unmarshalling
2865 * any Parcelable values from the extras of this Intent.
2866 *
2867 * @param loader a ClassLoader, or null to use the default loader
2868 * at the time of unmarshalling.
2869 */
2870 public void setExtrasClassLoader(ClassLoader loader) {
2871 if (mExtras != null) {
2872 mExtras.setClassLoader(loader);
2873 }
2874 }
2875
2876 /**
2877 * Returns true if an extra value is associated with the given name.
2878 * @param name the extra's name
2879 * @return true if the given extra is present.
2880 */
2881 public boolean hasExtra(String name) {
2882 return mExtras != null && mExtras.containsKey(name);
2883 }
2884
2885 /**
2886 * Returns true if the Intent's extras contain a parcelled file descriptor.
2887 * @return true if the Intent contains a parcelled file descriptor.
2888 */
2889 public boolean hasFileDescriptors() {
2890 return mExtras != null && mExtras.hasFileDescriptors();
2891 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002892
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002893 /**
2894 * Retrieve extended data from the intent.
2895 *
2896 * @param name The name of the desired item.
2897 *
2898 * @return the value of an item that previously added with putExtra()
2899 * or null if none was found.
2900 *
2901 * @deprecated
2902 * @hide
2903 */
2904 @Deprecated
2905 public Object getExtra(String name) {
2906 return getExtra(name, null);
2907 }
2908
2909 /**
2910 * Retrieve extended data from the intent.
2911 *
2912 * @param name The name of the desired item.
2913 * @param defaultValue the value to be returned if no value of the desired
2914 * type is stored with the given name.
2915 *
2916 * @return the value of an item that previously added with putExtra()
2917 * or the default value if none was found.
2918 *
2919 * @see #putExtra(String, boolean)
2920 */
2921 public boolean getBooleanExtra(String name, boolean defaultValue) {
2922 return mExtras == null ? defaultValue :
2923 mExtras.getBoolean(name, defaultValue);
2924 }
2925
2926 /**
2927 * Retrieve extended data from the intent.
2928 *
2929 * @param name The name of the desired item.
2930 * @param defaultValue the value to be returned if no value of the desired
2931 * type is stored with the given name.
2932 *
2933 * @return the value of an item that previously added with putExtra()
2934 * or the default value if none was found.
2935 *
2936 * @see #putExtra(String, byte)
2937 */
2938 public byte getByteExtra(String name, byte defaultValue) {
2939 return mExtras == null ? defaultValue :
2940 mExtras.getByte(name, defaultValue);
2941 }
2942
2943 /**
2944 * Retrieve extended data from the intent.
2945 *
2946 * @param name The name of the desired item.
2947 * @param defaultValue the value to be returned if no value of the desired
2948 * type is stored with the given name.
2949 *
2950 * @return the value of an item that previously added with putExtra()
2951 * or the default value if none was found.
2952 *
2953 * @see #putExtra(String, short)
2954 */
2955 public short getShortExtra(String name, short defaultValue) {
2956 return mExtras == null ? defaultValue :
2957 mExtras.getShort(name, defaultValue);
2958 }
2959
2960 /**
2961 * Retrieve extended data from the intent.
2962 *
2963 * @param name The name of the desired item.
2964 * @param defaultValue the value to be returned if no value of the desired
2965 * type is stored with the given name.
2966 *
2967 * @return the value of an item that previously added with putExtra()
2968 * or the default value if none was found.
2969 *
2970 * @see #putExtra(String, char)
2971 */
2972 public char getCharExtra(String name, char defaultValue) {
2973 return mExtras == null ? defaultValue :
2974 mExtras.getChar(name, defaultValue);
2975 }
2976
2977 /**
2978 * Retrieve extended data from the intent.
2979 *
2980 * @param name The name of the desired item.
2981 * @param defaultValue the value to be returned if no value of the desired
2982 * type is stored with the given name.
2983 *
2984 * @return the value of an item that previously added with putExtra()
2985 * or the default value if none was found.
2986 *
2987 * @see #putExtra(String, int)
2988 */
2989 public int getIntExtra(String name, int defaultValue) {
2990 return mExtras == null ? defaultValue :
2991 mExtras.getInt(name, defaultValue);
2992 }
2993
2994 /**
2995 * Retrieve extended data from the intent.
2996 *
2997 * @param name The name of the desired item.
2998 * @param defaultValue the value to be returned if no value of the desired
2999 * type is stored with the given name.
3000 *
3001 * @return the value of an item that previously added with putExtra()
3002 * or the default value if none was found.
3003 *
3004 * @see #putExtra(String, long)
3005 */
3006 public long getLongExtra(String name, long defaultValue) {
3007 return mExtras == null ? defaultValue :
3008 mExtras.getLong(name, defaultValue);
3009 }
3010
3011 /**
3012 * Retrieve extended data from the intent.
3013 *
3014 * @param name The name of the desired item.
3015 * @param defaultValue the value to be returned if no value of the desired
3016 * type is stored with the given name.
3017 *
3018 * @return the value of an item that previously added with putExtra(),
3019 * or the default value if no such item is present
3020 *
3021 * @see #putExtra(String, float)
3022 */
3023 public float getFloatExtra(String name, float defaultValue) {
3024 return mExtras == null ? defaultValue :
3025 mExtras.getFloat(name, defaultValue);
3026 }
3027
3028 /**
3029 * Retrieve extended data from the intent.
3030 *
3031 * @param name The name of the desired item.
3032 * @param defaultValue the value to be returned if no value of the desired
3033 * type is stored with the given name.
3034 *
3035 * @return the value of an item that previously added with putExtra()
3036 * or the default value if none was found.
3037 *
3038 * @see #putExtra(String, double)
3039 */
3040 public double getDoubleExtra(String name, double defaultValue) {
3041 return mExtras == null ? defaultValue :
3042 mExtras.getDouble(name, defaultValue);
3043 }
3044
3045 /**
3046 * Retrieve extended data from the intent.
3047 *
3048 * @param name The name of the desired item.
3049 *
3050 * @return the value of an item that previously added with putExtra()
3051 * or null if no String value was found.
3052 *
3053 * @see #putExtra(String, String)
3054 */
3055 public String getStringExtra(String name) {
3056 return mExtras == null ? null : mExtras.getString(name);
3057 }
3058
3059 /**
3060 * Retrieve extended data from the intent.
3061 *
3062 * @param name The name of the desired item.
3063 *
3064 * @return the value of an item that previously added with putExtra()
3065 * or null if no CharSequence value was found.
3066 *
3067 * @see #putExtra(String, CharSequence)
3068 */
3069 public CharSequence getCharSequenceExtra(String name) {
3070 return mExtras == null ? null : mExtras.getCharSequence(name);
3071 }
3072
3073 /**
3074 * Retrieve extended data from the intent.
3075 *
3076 * @param name The name of the desired item.
3077 *
3078 * @return the value of an item that previously added with putExtra()
3079 * or null if no Parcelable value was found.
3080 *
3081 * @see #putExtra(String, Parcelable)
3082 */
3083 public <T extends Parcelable> T getParcelableExtra(String name) {
3084 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3085 }
3086
3087 /**
3088 * Retrieve extended data from the intent.
3089 *
3090 * @param name The name of the desired item.
3091 *
3092 * @return the value of an item that previously added with putExtra()
3093 * or null if no Parcelable[] value was found.
3094 *
3095 * @see #putExtra(String, Parcelable[])
3096 */
3097 public Parcelable[] getParcelableArrayExtra(String name) {
3098 return mExtras == null ? null : mExtras.getParcelableArray(name);
3099 }
3100
3101 /**
3102 * Retrieve extended data from the intent.
3103 *
3104 * @param name The name of the desired item.
3105 *
3106 * @return the value of an item that previously added with putExtra()
3107 * or null if no ArrayList<Parcelable> value was found.
3108 *
3109 * @see #putParcelableArrayListExtra(String, ArrayList)
3110 */
3111 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3112 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3113 }
3114
3115 /**
3116 * Retrieve extended data from the intent.
3117 *
3118 * @param name The name of the desired item.
3119 *
3120 * @return the value of an item that previously added with putExtra()
3121 * or null if no Serializable value was found.
3122 *
3123 * @see #putExtra(String, Serializable)
3124 */
3125 public Serializable getSerializableExtra(String name) {
3126 return mExtras == null ? null : mExtras.getSerializable(name);
3127 }
3128
3129 /**
3130 * Retrieve extended data from the intent.
3131 *
3132 * @param name The name of the desired item.
3133 *
3134 * @return the value of an item that previously added with putExtra()
3135 * or null if no ArrayList<Integer> value was found.
3136 *
3137 * @see #putIntegerArrayListExtra(String, ArrayList)
3138 */
3139 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3140 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3141 }
3142
3143 /**
3144 * Retrieve extended data from the intent.
3145 *
3146 * @param name The name of the desired item.
3147 *
3148 * @return the value of an item that previously added with putExtra()
3149 * or null if no ArrayList<String> value was found.
3150 *
3151 * @see #putStringArrayListExtra(String, ArrayList)
3152 */
3153 public ArrayList<String> getStringArrayListExtra(String name) {
3154 return mExtras == null ? null : mExtras.getStringArrayList(name);
3155 }
3156
3157 /**
3158 * Retrieve extended data from the intent.
3159 *
3160 * @param name The name of the desired item.
3161 *
3162 * @return the value of an item that previously added with putExtra()
3163 * or null if no boolean array value was found.
3164 *
3165 * @see #putExtra(String, boolean[])
3166 */
3167 public boolean[] getBooleanArrayExtra(String name) {
3168 return mExtras == null ? null : mExtras.getBooleanArray(name);
3169 }
3170
3171 /**
3172 * Retrieve extended data from the intent.
3173 *
3174 * @param name The name of the desired item.
3175 *
3176 * @return the value of an item that previously added with putExtra()
3177 * or null if no byte array value was found.
3178 *
3179 * @see #putExtra(String, byte[])
3180 */
3181 public byte[] getByteArrayExtra(String name) {
3182 return mExtras == null ? null : mExtras.getByteArray(name);
3183 }
3184
3185 /**
3186 * Retrieve extended data from the intent.
3187 *
3188 * @param name The name of the desired item.
3189 *
3190 * @return the value of an item that previously added with putExtra()
3191 * or null if no short array value was found.
3192 *
3193 * @see #putExtra(String, short[])
3194 */
3195 public short[] getShortArrayExtra(String name) {
3196 return mExtras == null ? null : mExtras.getShortArray(name);
3197 }
3198
3199 /**
3200 * Retrieve extended data from the intent.
3201 *
3202 * @param name The name of the desired item.
3203 *
3204 * @return the value of an item that previously added with putExtra()
3205 * or null if no char array value was found.
3206 *
3207 * @see #putExtra(String, char[])
3208 */
3209 public char[] getCharArrayExtra(String name) {
3210 return mExtras == null ? null : mExtras.getCharArray(name);
3211 }
3212
3213 /**
3214 * Retrieve extended data from the intent.
3215 *
3216 * @param name The name of the desired item.
3217 *
3218 * @return the value of an item that previously added with putExtra()
3219 * or null if no int array value was found.
3220 *
3221 * @see #putExtra(String, int[])
3222 */
3223 public int[] getIntArrayExtra(String name) {
3224 return mExtras == null ? null : mExtras.getIntArray(name);
3225 }
3226
3227 /**
3228 * Retrieve extended data from the intent.
3229 *
3230 * @param name The name of the desired item.
3231 *
3232 * @return the value of an item that previously added with putExtra()
3233 * or null if no long array value was found.
3234 *
3235 * @see #putExtra(String, long[])
3236 */
3237 public long[] getLongArrayExtra(String name) {
3238 return mExtras == null ? null : mExtras.getLongArray(name);
3239 }
3240
3241 /**
3242 * Retrieve extended data from the intent.
3243 *
3244 * @param name The name of the desired item.
3245 *
3246 * @return the value of an item that previously added with putExtra()
3247 * or null if no float array value was found.
3248 *
3249 * @see #putExtra(String, float[])
3250 */
3251 public float[] getFloatArrayExtra(String name) {
3252 return mExtras == null ? null : mExtras.getFloatArray(name);
3253 }
3254
3255 /**
3256 * Retrieve extended data from the intent.
3257 *
3258 * @param name The name of the desired item.
3259 *
3260 * @return the value of an item that previously added with putExtra()
3261 * or null if no double array value was found.
3262 *
3263 * @see #putExtra(String, double[])
3264 */
3265 public double[] getDoubleArrayExtra(String name) {
3266 return mExtras == null ? null : mExtras.getDoubleArray(name);
3267 }
3268
3269 /**
3270 * Retrieve extended data from the intent.
3271 *
3272 * @param name The name of the desired item.
3273 *
3274 * @return the value of an item that previously added with putExtra()
3275 * or null if no String array value was found.
3276 *
3277 * @see #putExtra(String, String[])
3278 */
3279 public String[] getStringArrayExtra(String name) {
3280 return mExtras == null ? null : mExtras.getStringArray(name);
3281 }
3282
3283 /**
3284 * Retrieve extended data from the intent.
3285 *
3286 * @param name The name of the desired item.
3287 *
3288 * @return the value of an item that previously added with putExtra()
3289 * or null if no Bundle value was found.
3290 *
3291 * @see #putExtra(String, Bundle)
3292 */
3293 public Bundle getBundleExtra(String name) {
3294 return mExtras == null ? null : mExtras.getBundle(name);
3295 }
3296
3297 /**
3298 * Retrieve extended data from the intent.
3299 *
3300 * @param name The name of the desired item.
3301 *
3302 * @return the value of an item that previously added with putExtra()
3303 * or null if no IBinder value was found.
3304 *
3305 * @see #putExtra(String, IBinder)
3306 *
3307 * @deprecated
3308 * @hide
3309 */
3310 @Deprecated
3311 public IBinder getIBinderExtra(String name) {
3312 return mExtras == null ? null : mExtras.getIBinder(name);
3313 }
3314
3315 /**
3316 * Retrieve extended data from the intent.
3317 *
3318 * @param name The name of the desired item.
3319 * @param defaultValue The default value to return in case no item is
3320 * associated with the key 'name'
3321 *
3322 * @return the value of an item that previously added with putExtra()
3323 * or defaultValue if none was found.
3324 *
3325 * @see #putExtra
3326 *
3327 * @deprecated
3328 * @hide
3329 */
3330 @Deprecated
3331 public Object getExtra(String name, Object defaultValue) {
3332 Object result = defaultValue;
3333 if (mExtras != null) {
3334 Object result2 = mExtras.get(name);
3335 if (result2 != null) {
3336 result = result2;
3337 }
3338 }
3339
3340 return result;
3341 }
3342
3343 /**
3344 * Retrieves a map of extended data from the intent.
3345 *
3346 * @return the map of all extras previously added with putExtra(),
3347 * or null if none have been added.
3348 */
3349 public Bundle getExtras() {
3350 return (mExtras != null)
3351 ? new Bundle(mExtras)
3352 : null;
3353 }
3354
3355 /**
3356 * Retrieve any special flags associated with this intent. You will
3357 * normally just set them with {@link #setFlags} and let the system
3358 * take the appropriate action with them.
3359 *
3360 * @return int The currently set flags.
3361 *
3362 * @see #setFlags
3363 */
3364 public int getFlags() {
3365 return mFlags;
3366 }
3367
3368 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003369 * Retrieve the application package name this Intent is limited to. When
3370 * resolving an Intent, if non-null this limits the resolution to only
3371 * components in the given application package.
3372 *
3373 * @return The name of the application package for the Intent.
3374 *
3375 * @see #resolveActivity
3376 * @see #setPackage
3377 */
3378 public String getPackage() {
3379 return mPackage;
3380 }
3381
3382 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003383 * Retrieve the concrete component associated with the intent. When receiving
3384 * an intent, this is the component that was found to best handle it (that is,
3385 * yourself) and will always be non-null; in all other cases it will be
3386 * null unless explicitly set.
3387 *
3388 * @return The name of the application component to handle the intent.
3389 *
3390 * @see #resolveActivity
3391 * @see #setComponent
3392 */
3393 public ComponentName getComponent() {
3394 return mComponent;
3395 }
3396
3397 /**
3398 * Return the Activity component that should be used to handle this intent.
3399 * The appropriate component is determined based on the information in the
3400 * intent, evaluated as follows:
3401 *
3402 * <p>If {@link #getComponent} returns an explicit class, that is returned
3403 * without any further consideration.
3404 *
3405 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3406 * category to be considered.
3407 *
3408 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3409 * action.
3410 *
3411 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3412 * this type.
3413 *
3414 * <p>If {@link #addCategory} has added any categories, the activity must
3415 * handle ALL of the categories specified.
3416 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003417 * <p>If {@link #getPackage} is non-NULL, only activity components in
3418 * that application package will be considered.
3419 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003420 * <p>If there are no activities that satisfy all of these conditions, a
3421 * null string is returned.
3422 *
3423 * <p>If multiple activities are found to satisfy the intent, the one with
3424 * the highest priority will be used. If there are multiple activities
3425 * with the same priority, the system will either pick the best activity
3426 * based on user preference, or resolve to a system class that will allow
3427 * the user to pick an activity and forward from there.
3428 *
3429 * <p>This method is implemented simply by calling
3430 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3431 * true.</p>
3432 * <p> This API is called for you as part of starting an activity from an
3433 * intent. You do not normally need to call it yourself.</p>
3434 *
3435 * @param pm The package manager with which to resolve the Intent.
3436 *
3437 * @return Name of the component implementing an activity that can
3438 * display the intent.
3439 *
3440 * @see #setComponent
3441 * @see #getComponent
3442 * @see #resolveActivityInfo
3443 */
3444 public ComponentName resolveActivity(PackageManager pm) {
3445 if (mComponent != null) {
3446 return mComponent;
3447 }
3448
3449 ResolveInfo info = pm.resolveActivity(
3450 this, PackageManager.MATCH_DEFAULT_ONLY);
3451 if (info != null) {
3452 return new ComponentName(
3453 info.activityInfo.applicationInfo.packageName,
3454 info.activityInfo.name);
3455 }
3456
3457 return null;
3458 }
3459
3460 /**
3461 * Resolve the Intent into an {@link ActivityInfo}
3462 * describing the activity that should execute the intent. Resolution
3463 * follows the same rules as described for {@link #resolveActivity}, but
3464 * you get back the completely information about the resolved activity
3465 * instead of just its class name.
3466 *
3467 * @param pm The package manager with which to resolve the Intent.
3468 * @param flags Addition information to retrieve as per
3469 * {@link PackageManager#getActivityInfo(ComponentName, int)
3470 * PackageManager.getActivityInfo()}.
3471 *
3472 * @return PackageManager.ActivityInfo
3473 *
3474 * @see #resolveActivity
3475 */
3476 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3477 ActivityInfo ai = null;
3478 if (mComponent != null) {
3479 try {
3480 ai = pm.getActivityInfo(mComponent, flags);
3481 } catch (PackageManager.NameNotFoundException e) {
3482 // ignore
3483 }
3484 } else {
3485 ResolveInfo info = pm.resolveActivity(
3486 this, PackageManager.MATCH_DEFAULT_ONLY);
3487 if (info != null) {
3488 ai = info.activityInfo;
3489 }
3490 }
3491
3492 return ai;
3493 }
3494
3495 /**
3496 * Set the general action to be performed.
3497 *
3498 * @param action An action name, such as ACTION_VIEW. Application-specific
3499 * actions should be prefixed with the vendor's package name.
3500 *
3501 * @return Returns the same Intent object, for chaining multiple calls
3502 * into a single statement.
3503 *
3504 * @see #getAction
3505 */
3506 public Intent setAction(String action) {
3507 mAction = action;
3508 return this;
3509 }
3510
3511 /**
3512 * Set the data this intent is operating on. This method automatically
3513 * clears any type that was previously set by {@link #setType}.
3514 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003515 * <p><em>Note: scheme and host name matching in the Android framework is
3516 * case-sensitive, unlike the formal RFC. As a result,
3517 * you should always ensure that you write your Uri with these elements
3518 * using lower case letters, and normalize any Uris you receive from
3519 * outside of Android to ensure the scheme and host is lower case.</em></p>
3520 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003521 * @param data The URI of the data this intent is now targeting.
3522 *
3523 * @return Returns the same Intent object, for chaining multiple calls
3524 * into a single statement.
3525 *
3526 * @see #getData
3527 * @see #setType
3528 * @see #setDataAndType
3529 */
3530 public Intent setData(Uri data) {
3531 mData = data;
3532 mType = null;
3533 return this;
3534 }
3535
3536 /**
3537 * Set an explicit MIME data type. This is used to create intents that
3538 * only specify a type and not data, for example to indicate the type of
3539 * data to return. This method automatically clears any data that was
3540 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07003541 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003542 * <p><em>Note: MIME type matching in the Android framework is
3543 * case-sensitive, unlike formal RFC MIME types. As a result,
3544 * you should always write your MIME types with lower case letters,
3545 * and any MIME types you receive from outside of Android should be
3546 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003547 *
3548 * @param type The MIME type of the data being handled by this intent.
3549 *
3550 * @return Returns the same Intent object, for chaining multiple calls
3551 * into a single statement.
3552 *
3553 * @see #getType
3554 * @see #setData
3555 * @see #setDataAndType
3556 */
3557 public Intent setType(String type) {
3558 mData = null;
3559 mType = type;
3560 return this;
3561 }
3562
3563 /**
3564 * (Usually optional) Set the data for the intent along with an explicit
3565 * MIME data type. This method should very rarely be used -- it allows you
3566 * to override the MIME type that would ordinarily be inferred from the
3567 * data with your own type given here.
3568 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003569 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3570 * Android framework is case-sensitive, unlike the formal RFC definitions.
3571 * As a result, you should always write these elements with lower case letters,
3572 * and normalize any MIME types or Uris you receive from
3573 * outside of Android to ensure these elements are lower case before
3574 * supplying them here.</em></p>
3575 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003576 * @param data The URI of the data this intent is now targeting.
3577 * @param type The MIME type of the data being handled by this intent.
3578 *
3579 * @return Returns the same Intent object, for chaining multiple calls
3580 * into a single statement.
3581 *
3582 * @see #setData
3583 * @see #setType
3584 */
3585 public Intent setDataAndType(Uri data, String type) {
3586 mData = data;
3587 mType = type;
3588 return this;
3589 }
3590
3591 /**
3592 * Add a new category to the intent. Categories provide additional detail
3593 * about the action the intent is perform. When resolving an intent, only
3594 * activities that provide <em>all</em> of the requested categories will be
3595 * used.
3596 *
3597 * @param category The desired category. This can be either one of the
3598 * predefined Intent categories, or a custom category in your own
3599 * namespace.
3600 *
3601 * @return Returns the same Intent object, for chaining multiple calls
3602 * into a single statement.
3603 *
3604 * @see #hasCategory
3605 * @see #removeCategory
3606 */
3607 public Intent addCategory(String category) {
3608 if (mCategories == null) {
3609 mCategories = new HashSet<String>();
3610 }
3611 mCategories.add(category);
3612 return this;
3613 }
3614
3615 /**
3616 * Remove an category from an intent.
3617 *
3618 * @param category The category to remove.
3619 *
3620 * @see #addCategory
3621 */
3622 public void removeCategory(String category) {
3623 if (mCategories != null) {
3624 mCategories.remove(category);
3625 if (mCategories.size() == 0) {
3626 mCategories = null;
3627 }
3628 }
3629 }
3630
3631 /**
3632 * Add extended data to the intent. The name must include a package
3633 * prefix, for example the app com.android.contacts would use names
3634 * like "com.android.contacts.ShowAll".
3635 *
3636 * @param name The name of the extra data, with package prefix.
3637 * @param value The boolean data value.
3638 *
3639 * @return Returns the same Intent object, for chaining multiple calls
3640 * into a single statement.
3641 *
3642 * @see #putExtras
3643 * @see #removeExtra
3644 * @see #getBooleanExtra(String, boolean)
3645 */
3646 public Intent putExtra(String name, boolean value) {
3647 if (mExtras == null) {
3648 mExtras = new Bundle();
3649 }
3650 mExtras.putBoolean(name, value);
3651 return this;
3652 }
3653
3654 /**
3655 * Add extended data to the intent. The name must include a package
3656 * prefix, for example the app com.android.contacts would use names
3657 * like "com.android.contacts.ShowAll".
3658 *
3659 * @param name The name of the extra data, with package prefix.
3660 * @param value The byte data value.
3661 *
3662 * @return Returns the same Intent object, for chaining multiple calls
3663 * into a single statement.
3664 *
3665 * @see #putExtras
3666 * @see #removeExtra
3667 * @see #getByteExtra(String, byte)
3668 */
3669 public Intent putExtra(String name, byte value) {
3670 if (mExtras == null) {
3671 mExtras = new Bundle();
3672 }
3673 mExtras.putByte(name, value);
3674 return this;
3675 }
3676
3677 /**
3678 * Add extended data to the intent. The name must include a package
3679 * prefix, for example the app com.android.contacts would use names
3680 * like "com.android.contacts.ShowAll".
3681 *
3682 * @param name The name of the extra data, with package prefix.
3683 * @param value The char data value.
3684 *
3685 * @return Returns the same Intent object, for chaining multiple calls
3686 * into a single statement.
3687 *
3688 * @see #putExtras
3689 * @see #removeExtra
3690 * @see #getCharExtra(String, char)
3691 */
3692 public Intent putExtra(String name, char value) {
3693 if (mExtras == null) {
3694 mExtras = new Bundle();
3695 }
3696 mExtras.putChar(name, value);
3697 return this;
3698 }
3699
3700 /**
3701 * Add extended data to the intent. The name must include a package
3702 * prefix, for example the app com.android.contacts would use names
3703 * like "com.android.contacts.ShowAll".
3704 *
3705 * @param name The name of the extra data, with package prefix.
3706 * @param value The short data value.
3707 *
3708 * @return Returns the same Intent object, for chaining multiple calls
3709 * into a single statement.
3710 *
3711 * @see #putExtras
3712 * @see #removeExtra
3713 * @see #getShortExtra(String, short)
3714 */
3715 public Intent putExtra(String name, short value) {
3716 if (mExtras == null) {
3717 mExtras = new Bundle();
3718 }
3719 mExtras.putShort(name, value);
3720 return this;
3721 }
3722
3723 /**
3724 * Add extended data to the intent. The name must include a package
3725 * prefix, for example the app com.android.contacts would use names
3726 * like "com.android.contacts.ShowAll".
3727 *
3728 * @param name The name of the extra data, with package prefix.
3729 * @param value The integer data value.
3730 *
3731 * @return Returns the same Intent object, for chaining multiple calls
3732 * into a single statement.
3733 *
3734 * @see #putExtras
3735 * @see #removeExtra
3736 * @see #getIntExtra(String, int)
3737 */
3738 public Intent putExtra(String name, int value) {
3739 if (mExtras == null) {
3740 mExtras = new Bundle();
3741 }
3742 mExtras.putInt(name, value);
3743 return this;
3744 }
3745
3746 /**
3747 * Add extended data to the intent. The name must include a package
3748 * prefix, for example the app com.android.contacts would use names
3749 * like "com.android.contacts.ShowAll".
3750 *
3751 * @param name The name of the extra data, with package prefix.
3752 * @param value The long data value.
3753 *
3754 * @return Returns the same Intent object, for chaining multiple calls
3755 * into a single statement.
3756 *
3757 * @see #putExtras
3758 * @see #removeExtra
3759 * @see #getLongExtra(String, long)
3760 */
3761 public Intent putExtra(String name, long value) {
3762 if (mExtras == null) {
3763 mExtras = new Bundle();
3764 }
3765 mExtras.putLong(name, value);
3766 return this;
3767 }
3768
3769 /**
3770 * Add extended data to the intent. The name must include a package
3771 * prefix, for example the app com.android.contacts would use names
3772 * like "com.android.contacts.ShowAll".
3773 *
3774 * @param name The name of the extra data, with package prefix.
3775 * @param value The float data value.
3776 *
3777 * @return Returns the same Intent object, for chaining multiple calls
3778 * into a single statement.
3779 *
3780 * @see #putExtras
3781 * @see #removeExtra
3782 * @see #getFloatExtra(String, float)
3783 */
3784 public Intent putExtra(String name, float value) {
3785 if (mExtras == null) {
3786 mExtras = new Bundle();
3787 }
3788 mExtras.putFloat(name, value);
3789 return this;
3790 }
3791
3792 /**
3793 * Add extended data to the intent. The name must include a package
3794 * prefix, for example the app com.android.contacts would use names
3795 * like "com.android.contacts.ShowAll".
3796 *
3797 * @param name The name of the extra data, with package prefix.
3798 * @param value The double data value.
3799 *
3800 * @return Returns the same Intent object, for chaining multiple calls
3801 * into a single statement.
3802 *
3803 * @see #putExtras
3804 * @see #removeExtra
3805 * @see #getDoubleExtra(String, double)
3806 */
3807 public Intent putExtra(String name, double value) {
3808 if (mExtras == null) {
3809 mExtras = new Bundle();
3810 }
3811 mExtras.putDouble(name, value);
3812 return this;
3813 }
3814
3815 /**
3816 * Add extended data to the intent. The name must include a package
3817 * prefix, for example the app com.android.contacts would use names
3818 * like "com.android.contacts.ShowAll".
3819 *
3820 * @param name The name of the extra data, with package prefix.
3821 * @param value The String data value.
3822 *
3823 * @return Returns the same Intent object, for chaining multiple calls
3824 * into a single statement.
3825 *
3826 * @see #putExtras
3827 * @see #removeExtra
3828 * @see #getStringExtra(String)
3829 */
3830 public Intent putExtra(String name, String value) {
3831 if (mExtras == null) {
3832 mExtras = new Bundle();
3833 }
3834 mExtras.putString(name, value);
3835 return this;
3836 }
3837
3838 /**
3839 * Add extended data to the intent. The name must include a package
3840 * prefix, for example the app com.android.contacts would use names
3841 * like "com.android.contacts.ShowAll".
3842 *
3843 * @param name The name of the extra data, with package prefix.
3844 * @param value The CharSequence data value.
3845 *
3846 * @return Returns the same Intent object, for chaining multiple calls
3847 * into a single statement.
3848 *
3849 * @see #putExtras
3850 * @see #removeExtra
3851 * @see #getCharSequenceExtra(String)
3852 */
3853 public Intent putExtra(String name, CharSequence value) {
3854 if (mExtras == null) {
3855 mExtras = new Bundle();
3856 }
3857 mExtras.putCharSequence(name, value);
3858 return this;
3859 }
3860
3861 /**
3862 * Add extended data to the intent. The name must include a package
3863 * prefix, for example the app com.android.contacts would use names
3864 * like "com.android.contacts.ShowAll".
3865 *
3866 * @param name The name of the extra data, with package prefix.
3867 * @param value The Parcelable data value.
3868 *
3869 * @return Returns the same Intent object, for chaining multiple calls
3870 * into a single statement.
3871 *
3872 * @see #putExtras
3873 * @see #removeExtra
3874 * @see #getParcelableExtra(String)
3875 */
3876 public Intent putExtra(String name, Parcelable value) {
3877 if (mExtras == null) {
3878 mExtras = new Bundle();
3879 }
3880 mExtras.putParcelable(name, value);
3881 return this;
3882 }
3883
3884 /**
3885 * Add extended data to the intent. The name must include a package
3886 * prefix, for example the app com.android.contacts would use names
3887 * like "com.android.contacts.ShowAll".
3888 *
3889 * @param name The name of the extra data, with package prefix.
3890 * @param value The Parcelable[] data value.
3891 *
3892 * @return Returns the same Intent object, for chaining multiple calls
3893 * into a single statement.
3894 *
3895 * @see #putExtras
3896 * @see #removeExtra
3897 * @see #getParcelableArrayExtra(String)
3898 */
3899 public Intent putExtra(String name, Parcelable[] value) {
3900 if (mExtras == null) {
3901 mExtras = new Bundle();
3902 }
3903 mExtras.putParcelableArray(name, value);
3904 return this;
3905 }
3906
3907 /**
3908 * Add extended data to the intent. The name must include a package
3909 * prefix, for example the app com.android.contacts would use names
3910 * like "com.android.contacts.ShowAll".
3911 *
3912 * @param name The name of the extra data, with package prefix.
3913 * @param value The ArrayList<Parcelable> data value.
3914 *
3915 * @return Returns the same Intent object, for chaining multiple calls
3916 * into a single statement.
3917 *
3918 * @see #putExtras
3919 * @see #removeExtra
3920 * @see #getParcelableArrayListExtra(String)
3921 */
3922 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
3923 if (mExtras == null) {
3924 mExtras = new Bundle();
3925 }
3926 mExtras.putParcelableArrayList(name, value);
3927 return this;
3928 }
3929
3930 /**
3931 * Add extended data to the intent. The name must include a package
3932 * prefix, for example the app com.android.contacts would use names
3933 * like "com.android.contacts.ShowAll".
3934 *
3935 * @param name The name of the extra data, with package prefix.
3936 * @param value The ArrayList<Integer> data value.
3937 *
3938 * @return Returns the same Intent object, for chaining multiple calls
3939 * into a single statement.
3940 *
3941 * @see #putExtras
3942 * @see #removeExtra
3943 * @see #getIntegerArrayListExtra(String)
3944 */
3945 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
3946 if (mExtras == null) {
3947 mExtras = new Bundle();
3948 }
3949 mExtras.putIntegerArrayList(name, value);
3950 return this;
3951 }
3952
3953 /**
3954 * Add extended data to the intent. The name must include a package
3955 * prefix, for example the app com.android.contacts would use names
3956 * like "com.android.contacts.ShowAll".
3957 *
3958 * @param name The name of the extra data, with package prefix.
3959 * @param value The ArrayList<String> data value.
3960 *
3961 * @return Returns the same Intent object, for chaining multiple calls
3962 * into a single statement.
3963 *
3964 * @see #putExtras
3965 * @see #removeExtra
3966 * @see #getStringArrayListExtra(String)
3967 */
3968 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
3969 if (mExtras == null) {
3970 mExtras = new Bundle();
3971 }
3972 mExtras.putStringArrayList(name, value);
3973 return this;
3974 }
3975
3976 /**
3977 * Add extended data to the intent. The name must include a package
3978 * prefix, for example the app com.android.contacts would use names
3979 * like "com.android.contacts.ShowAll".
3980 *
3981 * @param name The name of the extra data, with package prefix.
3982 * @param value The Serializable data value.
3983 *
3984 * @return Returns the same Intent object, for chaining multiple calls
3985 * into a single statement.
3986 *
3987 * @see #putExtras
3988 * @see #removeExtra
3989 * @see #getSerializableExtra(String)
3990 */
3991 public Intent putExtra(String name, Serializable value) {
3992 if (mExtras == null) {
3993 mExtras = new Bundle();
3994 }
3995 mExtras.putSerializable(name, value);
3996 return this;
3997 }
3998
3999 /**
4000 * Add extended data to the intent. The name must include a package
4001 * prefix, for example the app com.android.contacts would use names
4002 * like "com.android.contacts.ShowAll".
4003 *
4004 * @param name The name of the extra data, with package prefix.
4005 * @param value The boolean array data value.
4006 *
4007 * @return Returns the same Intent object, for chaining multiple calls
4008 * into a single statement.
4009 *
4010 * @see #putExtras
4011 * @see #removeExtra
4012 * @see #getBooleanArrayExtra(String)
4013 */
4014 public Intent putExtra(String name, boolean[] value) {
4015 if (mExtras == null) {
4016 mExtras = new Bundle();
4017 }
4018 mExtras.putBooleanArray(name, value);
4019 return this;
4020 }
4021
4022 /**
4023 * Add extended data to the intent. The name must include a package
4024 * prefix, for example the app com.android.contacts would use names
4025 * like "com.android.contacts.ShowAll".
4026 *
4027 * @param name The name of the extra data, with package prefix.
4028 * @param value The byte array data value.
4029 *
4030 * @return Returns the same Intent object, for chaining multiple calls
4031 * into a single statement.
4032 *
4033 * @see #putExtras
4034 * @see #removeExtra
4035 * @see #getByteArrayExtra(String)
4036 */
4037 public Intent putExtra(String name, byte[] value) {
4038 if (mExtras == null) {
4039 mExtras = new Bundle();
4040 }
4041 mExtras.putByteArray(name, value);
4042 return this;
4043 }
4044
4045 /**
4046 * Add extended data to the intent. The name must include a package
4047 * prefix, for example the app com.android.contacts would use names
4048 * like "com.android.contacts.ShowAll".
4049 *
4050 * @param name The name of the extra data, with package prefix.
4051 * @param value The short array data value.
4052 *
4053 * @return Returns the same Intent object, for chaining multiple calls
4054 * into a single statement.
4055 *
4056 * @see #putExtras
4057 * @see #removeExtra
4058 * @see #getShortArrayExtra(String)
4059 */
4060 public Intent putExtra(String name, short[] value) {
4061 if (mExtras == null) {
4062 mExtras = new Bundle();
4063 }
4064 mExtras.putShortArray(name, value);
4065 return this;
4066 }
4067
4068 /**
4069 * Add extended data to the intent. The name must include a package
4070 * prefix, for example the app com.android.contacts would use names
4071 * like "com.android.contacts.ShowAll".
4072 *
4073 * @param name The name of the extra data, with package prefix.
4074 * @param value The char array data value.
4075 *
4076 * @return Returns the same Intent object, for chaining multiple calls
4077 * into a single statement.
4078 *
4079 * @see #putExtras
4080 * @see #removeExtra
4081 * @see #getCharArrayExtra(String)
4082 */
4083 public Intent putExtra(String name, char[] value) {
4084 if (mExtras == null) {
4085 mExtras = new Bundle();
4086 }
4087 mExtras.putCharArray(name, value);
4088 return this;
4089 }
4090
4091 /**
4092 * Add extended data to the intent. The name must include a package
4093 * prefix, for example the app com.android.contacts would use names
4094 * like "com.android.contacts.ShowAll".
4095 *
4096 * @param name The name of the extra data, with package prefix.
4097 * @param value The int array data value.
4098 *
4099 * @return Returns the same Intent object, for chaining multiple calls
4100 * into a single statement.
4101 *
4102 * @see #putExtras
4103 * @see #removeExtra
4104 * @see #getIntArrayExtra(String)
4105 */
4106 public Intent putExtra(String name, int[] value) {
4107 if (mExtras == null) {
4108 mExtras = new Bundle();
4109 }
4110 mExtras.putIntArray(name, value);
4111 return this;
4112 }
4113
4114 /**
4115 * Add extended data to the intent. The name must include a package
4116 * prefix, for example the app com.android.contacts would use names
4117 * like "com.android.contacts.ShowAll".
4118 *
4119 * @param name The name of the extra data, with package prefix.
4120 * @param value The byte array data value.
4121 *
4122 * @return Returns the same Intent object, for chaining multiple calls
4123 * into a single statement.
4124 *
4125 * @see #putExtras
4126 * @see #removeExtra
4127 * @see #getLongArrayExtra(String)
4128 */
4129 public Intent putExtra(String name, long[] value) {
4130 if (mExtras == null) {
4131 mExtras = new Bundle();
4132 }
4133 mExtras.putLongArray(name, value);
4134 return this;
4135 }
4136
4137 /**
4138 * Add extended data to the intent. The name must include a package
4139 * prefix, for example the app com.android.contacts would use names
4140 * like "com.android.contacts.ShowAll".
4141 *
4142 * @param name The name of the extra data, with package prefix.
4143 * @param value The float array data value.
4144 *
4145 * @return Returns the same Intent object, for chaining multiple calls
4146 * into a single statement.
4147 *
4148 * @see #putExtras
4149 * @see #removeExtra
4150 * @see #getFloatArrayExtra(String)
4151 */
4152 public Intent putExtra(String name, float[] value) {
4153 if (mExtras == null) {
4154 mExtras = new Bundle();
4155 }
4156 mExtras.putFloatArray(name, value);
4157 return this;
4158 }
4159
4160 /**
4161 * Add extended data to the intent. The name must include a package
4162 * prefix, for example the app com.android.contacts would use names
4163 * like "com.android.contacts.ShowAll".
4164 *
4165 * @param name The name of the extra data, with package prefix.
4166 * @param value The double array data value.
4167 *
4168 * @return Returns the same Intent object, for chaining multiple calls
4169 * into a single statement.
4170 *
4171 * @see #putExtras
4172 * @see #removeExtra
4173 * @see #getDoubleArrayExtra(String)
4174 */
4175 public Intent putExtra(String name, double[] value) {
4176 if (mExtras == null) {
4177 mExtras = new Bundle();
4178 }
4179 mExtras.putDoubleArray(name, value);
4180 return this;
4181 }
4182
4183 /**
4184 * Add extended data to the intent. The name must include a package
4185 * prefix, for example the app com.android.contacts would use names
4186 * like "com.android.contacts.ShowAll".
4187 *
4188 * @param name The name of the extra data, with package prefix.
4189 * @param value The String array data value.
4190 *
4191 * @return Returns the same Intent object, for chaining multiple calls
4192 * into a single statement.
4193 *
4194 * @see #putExtras
4195 * @see #removeExtra
4196 * @see #getStringArrayExtra(String)
4197 */
4198 public Intent putExtra(String name, String[] value) {
4199 if (mExtras == null) {
4200 mExtras = new Bundle();
4201 }
4202 mExtras.putStringArray(name, value);
4203 return this;
4204 }
4205
4206 /**
4207 * Add extended data to the intent. The name must include a package
4208 * prefix, for example the app com.android.contacts would use names
4209 * like "com.android.contacts.ShowAll".
4210 *
4211 * @param name The name of the extra data, with package prefix.
4212 * @param value The Bundle data value.
4213 *
4214 * @return Returns the same Intent object, for chaining multiple calls
4215 * into a single statement.
4216 *
4217 * @see #putExtras
4218 * @see #removeExtra
4219 * @see #getBundleExtra(String)
4220 */
4221 public Intent putExtra(String name, Bundle value) {
4222 if (mExtras == null) {
4223 mExtras = new Bundle();
4224 }
4225 mExtras.putBundle(name, value);
4226 return this;
4227 }
4228
4229 /**
4230 * Add extended data to the intent. The name must include a package
4231 * prefix, for example the app com.android.contacts would use names
4232 * like "com.android.contacts.ShowAll".
4233 *
4234 * @param name The name of the extra data, with package prefix.
4235 * @param value The IBinder data value.
4236 *
4237 * @return Returns the same Intent object, for chaining multiple calls
4238 * into a single statement.
4239 *
4240 * @see #putExtras
4241 * @see #removeExtra
4242 * @see #getIBinderExtra(String)
4243 *
4244 * @deprecated
4245 * @hide
4246 */
4247 @Deprecated
4248 public Intent putExtra(String name, IBinder value) {
4249 if (mExtras == null) {
4250 mExtras = new Bundle();
4251 }
4252 mExtras.putIBinder(name, value);
4253 return this;
4254 }
4255
4256 /**
4257 * Copy all extras in 'src' in to this intent.
4258 *
4259 * @param src Contains the extras to copy.
4260 *
4261 * @see #putExtra
4262 */
4263 public Intent putExtras(Intent src) {
4264 if (src.mExtras != null) {
4265 if (mExtras == null) {
4266 mExtras = new Bundle(src.mExtras);
4267 } else {
4268 mExtras.putAll(src.mExtras);
4269 }
4270 }
4271 return this;
4272 }
4273
4274 /**
4275 * Add a set of extended data to the intent. The keys must include a package
4276 * prefix, for example the app com.android.contacts would use names
4277 * like "com.android.contacts.ShowAll".
4278 *
4279 * @param extras The Bundle of extras to add to this intent.
4280 *
4281 * @see #putExtra
4282 * @see #removeExtra
4283 */
4284 public Intent putExtras(Bundle extras) {
4285 if (mExtras == null) {
4286 mExtras = new Bundle();
4287 }
4288 mExtras.putAll(extras);
4289 return this;
4290 }
4291
4292 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004293 * Completely replace the extras in the Intent with the extras in the
4294 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004295 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004296 * @param src The exact extras contained in this Intent are copied
4297 * into the target intent, replacing any that were previously there.
4298 */
4299 public Intent replaceExtras(Intent src) {
4300 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4301 return this;
4302 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004303
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004304 /**
4305 * Completely replace the extras in the Intent with the given Bundle of
4306 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004307 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004308 * @param extras The new set of extras in the Intent, or null to erase
4309 * all extras.
4310 */
4311 public Intent replaceExtras(Bundle extras) {
4312 mExtras = extras != null ? new Bundle(extras) : null;
4313 return this;
4314 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004315
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004316 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004317 * Remove extended data from the intent.
4318 *
4319 * @see #putExtra
4320 */
4321 public void removeExtra(String name) {
4322 if (mExtras != null) {
4323 mExtras.remove(name);
4324 if (mExtras.size() == 0) {
4325 mExtras = null;
4326 }
4327 }
4328 }
4329
4330 /**
4331 * Set special flags controlling how this intent is handled. Most values
4332 * here depend on the type of component being executed by the Intent,
4333 * specifically the FLAG_ACTIVITY_* flags are all for use with
4334 * {@link Context#startActivity Context.startActivity()} and the
4335 * FLAG_RECEIVER_* flags are all for use with
4336 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4337 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004338 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4339 * 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 -07004340 * the behavior of your application.
4341 *
4342 * @param flags The desired flags.
4343 *
4344 * @return Returns the same Intent object, for chaining multiple calls
4345 * into a single statement.
4346 *
4347 * @see #getFlags
4348 * @see #addFlags
4349 *
4350 * @see #FLAG_GRANT_READ_URI_PERMISSION
4351 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4352 * @see #FLAG_DEBUG_LOG_RESOLUTION
4353 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004354 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004355 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004356 * @see #FLAG_ACTIVITY_CLEAR_TOP
4357 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4358 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004359 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004360 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4361 * @see #FLAG_ACTIVITY_NEW_TASK
4362 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004363 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004364 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4365 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004366 * @see #FLAG_ACTIVITY_SINGLE_TOP
4367 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4368 */
4369 public Intent setFlags(int flags) {
4370 mFlags = flags;
4371 return this;
4372 }
4373
4374 /**
4375 * Add additional flags to the intent (or with existing flags
4376 * value).
4377 *
4378 * @param flags The new flags to set.
4379 *
4380 * @return Returns the same Intent object, for chaining multiple calls
4381 * into a single statement.
4382 *
4383 * @see #setFlags
4384 */
4385 public Intent addFlags(int flags) {
4386 mFlags |= flags;
4387 return this;
4388 }
4389
4390 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004391 * (Usually optional) Set an explicit application package name that limits
4392 * the components this Intent will resolve to. If left to the default
4393 * value of null, all components in all applications will considered.
4394 * If non-null, the Intent can only match the components in the given
4395 * application package.
4396 *
4397 * @param packageName The name of the application package to handle the
4398 * intent, or null to allow any application package.
4399 *
4400 * @return Returns the same Intent object, for chaining multiple calls
4401 * into a single statement.
4402 *
4403 * @see #getPackage
4404 * @see #resolveActivity
4405 */
4406 public Intent setPackage(String packageName) {
4407 mPackage = packageName;
4408 return this;
4409 }
4410
4411 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004412 * (Usually optional) Explicitly set the component to handle the intent.
4413 * If left with the default value of null, the system will determine the
4414 * appropriate class to use based on the other fields (action, data,
4415 * type, categories) in the Intent. If this class is defined, the
4416 * specified class will always be used regardless of the other fields. You
4417 * should only set this value when you know you absolutely want a specific
4418 * class to be used; otherwise it is better to let the system find the
4419 * appropriate class so that you will respect the installed applications
4420 * and user preferences.
4421 *
4422 * @param component The name of the application component to handle the
4423 * intent, or null to let the system find one for you.
4424 *
4425 * @return Returns the same Intent object, for chaining multiple calls
4426 * into a single statement.
4427 *
4428 * @see #setClass
4429 * @see #setClassName(Context, String)
4430 * @see #setClassName(String, String)
4431 * @see #getComponent
4432 * @see #resolveActivity
4433 */
4434 public Intent setComponent(ComponentName component) {
4435 mComponent = component;
4436 return this;
4437 }
4438
4439 /**
4440 * Convenience for calling {@link #setComponent} with an
4441 * explicit class name.
4442 *
4443 * @param packageContext A Context of the application package implementing
4444 * this class.
4445 * @param className The name of a class inside of the application package
4446 * that will be used as the component for this Intent.
4447 *
4448 * @return Returns the same Intent object, for chaining multiple calls
4449 * into a single statement.
4450 *
4451 * @see #setComponent
4452 * @see #setClass
4453 */
4454 public Intent setClassName(Context packageContext, String className) {
4455 mComponent = new ComponentName(packageContext, className);
4456 return this;
4457 }
4458
4459 /**
4460 * Convenience for calling {@link #setComponent} with an
4461 * explicit application package name and class name.
4462 *
4463 * @param packageName The name of the package implementing the desired
4464 * component.
4465 * @param className The name of a class inside of the application package
4466 * that will be used as the component for this Intent.
4467 *
4468 * @return Returns the same Intent object, for chaining multiple calls
4469 * into a single statement.
4470 *
4471 * @see #setComponent
4472 * @see #setClass
4473 */
4474 public Intent setClassName(String packageName, String className) {
4475 mComponent = new ComponentName(packageName, className);
4476 return this;
4477 }
4478
4479 /**
4480 * Convenience for calling {@link #setComponent(ComponentName)} with the
4481 * name returned by a {@link Class} object.
4482 *
4483 * @param packageContext A Context of the application package implementing
4484 * this class.
4485 * @param cls The class name to set, equivalent to
4486 * <code>setClassName(context, cls.getName())</code>.
4487 *
4488 * @return Returns the same Intent object, for chaining multiple calls
4489 * into a single statement.
4490 *
4491 * @see #setComponent
4492 */
4493 public Intent setClass(Context packageContext, Class<?> cls) {
4494 mComponent = new ComponentName(packageContext, cls);
4495 return this;
4496 }
4497
4498 /**
4499 * Use with {@link #fillIn} to allow the current action value to be
4500 * overwritten, even if it is already set.
4501 */
4502 public static final int FILL_IN_ACTION = 1<<0;
4503
4504 /**
4505 * Use with {@link #fillIn} to allow the current data or type value
4506 * overwritten, even if it is already set.
4507 */
4508 public static final int FILL_IN_DATA = 1<<1;
4509
4510 /**
4511 * Use with {@link #fillIn} to allow the current categories to be
4512 * overwritten, even if they are already set.
4513 */
4514 public static final int FILL_IN_CATEGORIES = 1<<2;
4515
4516 /**
4517 * Use with {@link #fillIn} to allow the current component value to be
4518 * overwritten, even if it is already set.
4519 */
4520 public static final int FILL_IN_COMPONENT = 1<<3;
4521
4522 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004523 * Use with {@link #fillIn} to allow the current package value to be
4524 * overwritten, even if it is already set.
4525 */
4526 public static final int FILL_IN_PACKAGE = 1<<4;
4527
4528 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004529 * Copy the contents of <var>other</var> in to this object, but only
4530 * where fields are not defined by this object. For purposes of a field
4531 * being defined, the following pieces of data in the Intent are
4532 * considered to be separate fields:
4533 *
4534 * <ul>
4535 * <li> action, as set by {@link #setAction}.
4536 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4537 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4538 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004539 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004540 * <li> component, as set by {@link #setComponent(ComponentName)} or
4541 * related methods.
4542 * <li> each top-level name in the associated extras.
4543 * </ul>
4544 *
4545 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004546 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4547 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004548 * corresponding field will not be replaced if it is already set.
4549 *
Brett Chabot3e391752009-07-21 16:07:23 -07004550 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
4551 * specified.
4552 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004553 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4554 * and Intent B with {action="gotit", data-type="some/thing",
4555 * categories="one","two"}.
4556 *
4557 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4558 * containing: {action="gotit", data-type="some/thing",
4559 * categories="bar"}.
4560 *
4561 * @param other Another Intent whose values are to be used to fill in
4562 * the current one.
4563 * @param flags Options to control which fields can be filled in.
4564 *
4565 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004566 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4567 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004568 */
4569 public int fillIn(Intent other, int flags) {
4570 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004571 if (other.mAction != null
4572 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004573 mAction = other.mAction;
4574 changes |= FILL_IN_ACTION;
4575 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004576 if ((other.mData != null || other.mType != null)
4577 && ((mData == null && mType == null)
4578 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004579 mData = other.mData;
4580 mType = other.mType;
4581 changes |= FILL_IN_DATA;
4582 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004583 if (other.mCategories != null
4584 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004585 if (other.mCategories != null) {
4586 mCategories = new HashSet<String>(other.mCategories);
4587 }
4588 changes |= FILL_IN_CATEGORIES;
4589 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004590 if (other.mPackage != null
4591 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
4592 mPackage = other.mPackage;
4593 changes |= FILL_IN_PACKAGE;
4594 }
4595 // Component is special: it can -only- be set if explicitly allowed,
4596 // since otherwise the sender could force the intent somewhere the
4597 // originator didn't intend.
4598 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004599 mComponent = other.mComponent;
4600 changes |= FILL_IN_COMPONENT;
4601 }
4602 mFlags |= other.mFlags;
4603 if (mExtras == null) {
4604 if (other.mExtras != null) {
4605 mExtras = new Bundle(other.mExtras);
4606 }
4607 } else if (other.mExtras != null) {
4608 try {
4609 Bundle newb = new Bundle(other.mExtras);
4610 newb.putAll(mExtras);
4611 mExtras = newb;
4612 } catch (RuntimeException e) {
4613 // Modifying the extras can cause us to unparcel the contents
4614 // of the bundle, and if we do this in the system process that
4615 // may fail. We really should handle this (i.e., the Bundle
4616 // impl shouldn't be on top of a plain map), but for now just
4617 // ignore it and keep the original contents. :(
4618 Log.w("Intent", "Failure filling in extras", e);
4619 }
4620 }
4621 return changes;
4622 }
4623
4624 /**
4625 * Wrapper class holding an Intent and implementing comparisons on it for
4626 * the purpose of filtering. The class implements its
4627 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4628 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4629 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4630 * on the wrapped Intent.
4631 */
4632 public static final class FilterComparison {
4633 private final Intent mIntent;
4634 private final int mHashCode;
4635
4636 public FilterComparison(Intent intent) {
4637 mIntent = intent;
4638 mHashCode = intent.filterHashCode();
4639 }
4640
4641 /**
4642 * Return the Intent that this FilterComparison represents.
4643 * @return Returns the Intent held by the FilterComparison. Do
4644 * not modify!
4645 */
4646 public Intent getIntent() {
4647 return mIntent;
4648 }
4649
4650 @Override
4651 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004652 if (obj instanceof FilterComparison) {
4653 Intent other = ((FilterComparison)obj).mIntent;
4654 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004655 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004656 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004657 }
4658
4659 @Override
4660 public int hashCode() {
4661 return mHashCode;
4662 }
4663 }
4664
4665 /**
4666 * Determine if two intents are the same for the purposes of intent
4667 * resolution (filtering). That is, if their action, data, type,
4668 * class, and categories are the same. This does <em>not</em> compare
4669 * any extra data included in the intents.
4670 *
4671 * @param other The other Intent to compare against.
4672 *
4673 * @return Returns true if action, data, type, class, and categories
4674 * are the same.
4675 */
4676 public boolean filterEquals(Intent other) {
4677 if (other == null) {
4678 return false;
4679 }
4680 if (mAction != other.mAction) {
4681 if (mAction != null) {
4682 if (!mAction.equals(other.mAction)) {
4683 return false;
4684 }
4685 } else {
4686 if (!other.mAction.equals(mAction)) {
4687 return false;
4688 }
4689 }
4690 }
4691 if (mData != other.mData) {
4692 if (mData != null) {
4693 if (!mData.equals(other.mData)) {
4694 return false;
4695 }
4696 } else {
4697 if (!other.mData.equals(mData)) {
4698 return false;
4699 }
4700 }
4701 }
4702 if (mType != other.mType) {
4703 if (mType != null) {
4704 if (!mType.equals(other.mType)) {
4705 return false;
4706 }
4707 } else {
4708 if (!other.mType.equals(mType)) {
4709 return false;
4710 }
4711 }
4712 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004713 if (mPackage != other.mPackage) {
4714 if (mPackage != null) {
4715 if (!mPackage.equals(other.mPackage)) {
4716 return false;
4717 }
4718 } else {
4719 if (!other.mPackage.equals(mPackage)) {
4720 return false;
4721 }
4722 }
4723 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004724 if (mComponent != other.mComponent) {
4725 if (mComponent != null) {
4726 if (!mComponent.equals(other.mComponent)) {
4727 return false;
4728 }
4729 } else {
4730 if (!other.mComponent.equals(mComponent)) {
4731 return false;
4732 }
4733 }
4734 }
4735 if (mCategories != other.mCategories) {
4736 if (mCategories != null) {
4737 if (!mCategories.equals(other.mCategories)) {
4738 return false;
4739 }
4740 } else {
4741 if (!other.mCategories.equals(mCategories)) {
4742 return false;
4743 }
4744 }
4745 }
4746
4747 return true;
4748 }
4749
4750 /**
4751 * Generate hash code that matches semantics of filterEquals().
4752 *
4753 * @return Returns the hash value of the action, data, type, class, and
4754 * categories.
4755 *
4756 * @see #filterEquals
4757 */
4758 public int filterHashCode() {
4759 int code = 0;
4760 if (mAction != null) {
4761 code += mAction.hashCode();
4762 }
4763 if (mData != null) {
4764 code += mData.hashCode();
4765 }
4766 if (mType != null) {
4767 code += mType.hashCode();
4768 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004769 if (mPackage != null) {
4770 code += mPackage.hashCode();
4771 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004772 if (mComponent != null) {
4773 code += mComponent.hashCode();
4774 }
4775 if (mCategories != null) {
4776 code += mCategories.hashCode();
4777 }
4778 return code;
4779 }
4780
4781 @Override
4782 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004783 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004784
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004785 b.append("Intent { ");
4786 toShortString(b, true, true);
4787 b.append(" }");
4788
4789 return b.toString();
4790 }
4791
4792 /** @hide */
4793 public String toShortString(boolean comp, boolean extras) {
4794 StringBuilder b = new StringBuilder(128);
4795 toShortString(b, comp, extras);
4796 return b.toString();
4797 }
Romain Guy4969af72009-06-17 10:53:19 -07004798
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004799 /** @hide */
4800 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
4801 boolean first = true;
4802 if (mAction != null) {
4803 b.append("act=").append(mAction);
4804 first = false;
4805 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004806 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004807 if (!first) {
4808 b.append(' ');
4809 }
4810 first = false;
4811 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004812 Iterator<String> i = mCategories.iterator();
4813 boolean didone = false;
4814 while (i.hasNext()) {
4815 if (didone) b.append(",");
4816 didone = true;
4817 b.append(i.next());
4818 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004819 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004820 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004821 if (mData != null) {
4822 if (!first) {
4823 b.append(' ');
4824 }
4825 first = false;
4826 b.append("dat=").append(mData);
4827 }
4828 if (mType != null) {
4829 if (!first) {
4830 b.append(' ');
4831 }
4832 first = false;
4833 b.append("typ=").append(mType);
4834 }
4835 if (mFlags != 0) {
4836 if (!first) {
4837 b.append(' ');
4838 }
4839 first = false;
4840 b.append("flg=0x").append(Integer.toHexString(mFlags));
4841 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004842 if (mPackage != null) {
4843 if (!first) {
4844 b.append(' ');
4845 }
4846 first = false;
4847 b.append("pkg=").append(mPackage);
4848 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004849 if (comp && mComponent != null) {
4850 if (!first) {
4851 b.append(' ');
4852 }
4853 first = false;
4854 b.append("cmp=").append(mComponent.flattenToShortString());
4855 }
4856 if (extras && mExtras != null) {
4857 if (!first) {
4858 b.append(' ');
4859 }
4860 first = false;
4861 b.append("(has extras)");
4862 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004863 }
4864
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004865 /**
4866 * Call {@link #toUri} with 0 flags.
4867 * @deprecated Use {@link #toUri} instead.
4868 */
4869 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004870 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004871 return toUri(0);
4872 }
4873
4874 /**
4875 * Convert this Intent into a String holding a URI representation of it.
4876 * The returned URI string has been properly URI encoded, so it can be
4877 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
4878 * Intent's data as the base URI, with an additional fragment describing
4879 * the action, categories, type, flags, package, component, and extras.
4880 *
4881 * <p>You can convert the returned string back to an Intent with
4882 * {@link #getIntent}.
4883 *
4884 * @param flags Additional operating flags. Either 0 or
4885 * {@link #URI_INTENT_SCHEME}.
4886 *
4887 * @return Returns a URI encoding URI string describing the entire contents
4888 * of the Intent.
4889 */
4890 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004891 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004892 String scheme = null;
4893 if (mData != null) {
4894 String data = mData.toString();
4895 if ((flags&URI_INTENT_SCHEME) != 0) {
4896 final int N = data.length();
4897 for (int i=0; i<N; i++) {
4898 char c = data.charAt(i);
4899 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
4900 || c == '.' || c == '-') {
4901 continue;
4902 }
4903 if (c == ':' && i > 0) {
4904 // Valid scheme.
4905 scheme = data.substring(0, i);
4906 uri.append("intent:");
4907 data = data.substring(i+1);
4908 break;
4909 }
4910
4911 // No scheme.
4912 break;
4913 }
4914 }
4915 uri.append(data);
4916
4917 } else if ((flags&URI_INTENT_SCHEME) != 0) {
4918 uri.append("intent:");
4919 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004920
4921 uri.append("#Intent;");
4922
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004923 if (scheme != null) {
4924 uri.append("scheme=").append(scheme).append(';');
4925 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004926 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004927 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004928 }
4929 if (mCategories != null) {
4930 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004931 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004932 }
4933 }
4934 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004935 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004936 }
4937 if (mFlags != 0) {
4938 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
4939 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004940 if (mPackage != null) {
4941 uri.append("package=").append(Uri.encode(mPackage)).append(';');
4942 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004943 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004944 uri.append("component=").append(Uri.encode(
4945 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004946 }
4947 if (mExtras != null) {
4948 for (String key : mExtras.keySet()) {
4949 final Object value = mExtras.get(key);
4950 char entryType =
4951 value instanceof String ? 'S' :
4952 value instanceof Boolean ? 'B' :
4953 value instanceof Byte ? 'b' :
4954 value instanceof Character ? 'c' :
4955 value instanceof Double ? 'd' :
4956 value instanceof Float ? 'f' :
4957 value instanceof Integer ? 'i' :
4958 value instanceof Long ? 'l' :
4959 value instanceof Short ? 's' :
4960 '\0';
4961
4962 if (entryType != '\0') {
4963 uri.append(entryType);
4964 uri.append('.');
4965 uri.append(Uri.encode(key));
4966 uri.append('=');
4967 uri.append(Uri.encode(value.toString()));
4968 uri.append(';');
4969 }
4970 }
4971 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004972
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004973 uri.append("end");
4974
4975 return uri.toString();
4976 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004977
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004978 public int describeContents() {
4979 return (mExtras != null) ? mExtras.describeContents() : 0;
4980 }
4981
4982 public void writeToParcel(Parcel out, int flags) {
4983 out.writeString(mAction);
4984 Uri.writeToParcel(out, mData);
4985 out.writeString(mType);
4986 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004987 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004988 ComponentName.writeToParcel(mComponent, out);
4989
4990 if (mCategories != null) {
4991 out.writeInt(mCategories.size());
4992 for (String category : mCategories) {
4993 out.writeString(category);
4994 }
4995 } else {
4996 out.writeInt(0);
4997 }
4998
4999 out.writeBundle(mExtras);
5000 }
5001
5002 public static final Parcelable.Creator<Intent> CREATOR
5003 = new Parcelable.Creator<Intent>() {
5004 public Intent createFromParcel(Parcel in) {
5005 return new Intent(in);
5006 }
5007 public Intent[] newArray(int size) {
5008 return new Intent[size];
5009 }
5010 };
5011
5012 private Intent(Parcel in) {
5013 readFromParcel(in);
5014 }
5015
5016 public void readFromParcel(Parcel in) {
5017 mAction = in.readString();
5018 mData = Uri.CREATOR.createFromParcel(in);
5019 mType = in.readString();
5020 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005021 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005022 mComponent = ComponentName.readFromParcel(in);
5023
5024 int N = in.readInt();
5025 if (N > 0) {
5026 mCategories = new HashSet<String>();
5027 int i;
5028 for (i=0; i<N; i++) {
5029 mCategories.add(in.readString());
5030 }
5031 } else {
5032 mCategories = null;
5033 }
5034
5035 mExtras = in.readBundle();
5036 }
5037
5038 /**
5039 * Parses the "intent" element (and its children) from XML and instantiates
5040 * an Intent object. The given XML parser should be located at the tag
5041 * where parsing should start (often named "intent"), from which the
5042 * basic action, data, type, and package and class name will be
5043 * retrieved. The function will then parse in to any child elements,
5044 * looking for <category android:name="xxx"> tags to add categories and
5045 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5046 * to the intent.
5047 *
5048 * @param resources The Resources to use when inflating resources.
5049 * @param parser The XML parser pointing at an "intent" tag.
5050 * @param attrs The AttributeSet interface for retrieving extended
5051 * attribute data at the current <var>parser</var> location.
5052 * @return An Intent object matching the XML data.
5053 * @throws XmlPullParserException If there was an XML parsing error.
5054 * @throws IOException If there was an I/O error.
5055 */
5056 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5057 throws XmlPullParserException, IOException {
5058 Intent intent = new Intent();
5059
5060 TypedArray sa = resources.obtainAttributes(attrs,
5061 com.android.internal.R.styleable.Intent);
5062
5063 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5064
5065 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5066 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5067 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5068
5069 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5070 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5071 if (packageName != null && className != null) {
5072 intent.setComponent(new ComponentName(packageName, className));
5073 }
5074
5075 sa.recycle();
5076
5077 int outerDepth = parser.getDepth();
5078 int type;
5079 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5080 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5081 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5082 continue;
5083 }
5084
5085 String nodeName = parser.getName();
5086 if (nodeName.equals("category")) {
5087 sa = resources.obtainAttributes(attrs,
5088 com.android.internal.R.styleable.IntentCategory);
5089 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5090 sa.recycle();
5091
5092 if (cat != null) {
5093 intent.addCategory(cat);
5094 }
5095 XmlUtils.skipCurrentTag(parser);
5096
5097 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005098 if (intent.mExtras == null) {
5099 intent.mExtras = new Bundle();
5100 }
5101 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5102 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005103
5104 } else {
5105 XmlUtils.skipCurrentTag(parser);
5106 }
5107 }
5108
5109 return intent;
5110 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005111}