blob: 9dedca6ac61265e38855578a89e1ef9c65f0960a [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
Wei Huang97ecc9c2009-05-11 17:44:20 -07001699 /**
1700 * Broadcast Action: a remote intent is to be broadcasted.
1701 *
1702 * A remote intent is used for remote RPC between devices. The remote intent
1703 * is serialized and sent from one device to another device. The receiving
1704 * device parses the remote intent and broadcasts it. Note that anyone can
1705 * broadcast a remote intent. However, if the intent receiver of the remote intent
1706 * does not trust intent broadcasts from arbitrary intent senders, it should require
1707 * the sender to hold certain permissions so only trusted sender's broadcast will be
1708 * let through.
1709 */
1710 public static final String ACTION_REMOTE_INTENT =
1711 "android.intent.action.REMOTE_INTENT";
1712
Dianne Hackborn9acc0302009-08-25 00:27:12 -07001713 /**
1714 * Broadcast Action: hook for permforming cleanup after a system update.
1715 *
1716 * The broadcast is sent when the system is booting, before the
1717 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
1718 * image. A receiver for this should do its work and then disable itself
1719 * so that it does not get run again at the next boot.
1720 * @hide
1721 */
1722 public static final String ACTION_PRE_BOOT_COMPLETED =
1723 "android.intent.action.PRE_BOOT_COMPLETED";
1724
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001725 // ---------------------------------------------------------------------
1726 // ---------------------------------------------------------------------
1727 // Standard intent categories (see addCategory()).
1728
1729 /**
1730 * Set if the activity should be an option for the default action
1731 * (center press) to perform on a piece of data. Setting this will
1732 * hide from the user any activities without it set when performing an
1733 * action on some data. Note that this is normal -not- set in the
1734 * Intent when initiating an action -- it is for use in intent filters
1735 * specified in packages.
1736 */
1737 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1738 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1739 /**
1740 * Activities that can be safely invoked from a browser must support this
1741 * category. For example, if the user is viewing a web page or an e-mail
1742 * and clicks on a link in the text, the Intent generated execute that
1743 * link will require the BROWSABLE category, so that only activities
1744 * supporting this category will be considered as possible actions. By
1745 * supporting this category, you are promising that there is nothing
1746 * damaging (without user intervention) that can happen by invoking any
1747 * matching Intent.
1748 */
1749 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1750 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1751 /**
1752 * Set if the activity should be considered as an alternative action to
1753 * the data the user is currently viewing. See also
1754 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1755 * applies to the selection in a list of items.
1756 *
1757 * <p>Supporting this category means that you would like your activity to be
1758 * displayed in the set of alternative things the user can do, usually as
1759 * part of the current activity's options menu. You will usually want to
1760 * include a specific label in the &lt;intent-filter&gt; of this action
1761 * describing to the user what it does.
1762 *
1763 * <p>The action of IntentFilter with this category is important in that it
1764 * describes the specific action the target will perform. This generally
1765 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1766 * a specific name such as "com.android.camera.action.CROP. Only one
1767 * alternative of any particular action will be shown to the user, so using
1768 * a specific action like this makes sure that your alternative will be
1769 * displayed while also allowing other applications to provide their own
1770 * overrides of that particular action.
1771 */
1772 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1773 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1774 /**
1775 * Set if the activity should be considered as an alternative selection
1776 * action to the data the user has currently selected. This is like
1777 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1778 * of items from which the user can select, giving them alternatives to the
1779 * default action that will be performed on it.
1780 */
1781 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1782 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1783 /**
1784 * Intended to be used as a tab inside of an containing TabActivity.
1785 */
1786 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1787 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1788 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001789 * Should be displayed in the top-level launcher.
1790 */
1791 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1792 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1793 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001794 * Provides information about the package it is in; typically used if
1795 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1796 * a front-door to the user without having to be shown in the all apps list.
1797 */
1798 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1799 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1800 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001801 * This is the home activity, that is the first activity that is displayed
1802 * when the device boots.
1803 */
1804 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1805 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1806 /**
1807 * This activity is a preference panel.
1808 */
1809 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1810 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1811 /**
1812 * This activity is a development preference panel.
1813 */
1814 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1815 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1816 /**
1817 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001818 */
1819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1820 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1821 /**
1822 * This activity may be exercised by the monkey or other automated test tools.
1823 */
1824 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1825 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1826 /**
1827 * To be used as a test (not part of the normal user experience).
1828 */
1829 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1830 /**
1831 * To be used as a unit test (run through the Test Harness).
1832 */
1833 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1834 /**
1835 * To be used as an sample code example (not part of the normal user
1836 * experience).
1837 */
1838 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1839 /**
1840 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1841 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1842 * when queried, though it is allowable for those columns to be blank.
1843 */
1844 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1845 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
1846
1847 /**
1848 * To be used as code under test for framework instrumentation tests.
1849 */
1850 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
1851 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001852
1853 /**
1854 * Broadcast Action: The phone was docked or undocked. Includes the extra
1855 * field {@link #EXTRA_DOCK_STATE}, containing the current dock state.
1856 * @hide
1857 */
1858 public static final String ACTION_DOCK_EVENT = "android.intent.action.DOCK_EVENT";
1859
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001860 // ---------------------------------------------------------------------
1861 // ---------------------------------------------------------------------
1862 // Standard extra data keys.
1863
1864 /**
1865 * The initial data to place in a newly created record. Use with
1866 * {@link #ACTION_INSERT}. The data here is a Map containing the same
1867 * fields as would be given to the underlying ContentProvider.insert()
1868 * call.
1869 */
1870 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
1871
1872 /**
1873 * A constant CharSequence that is associated with the Intent, used with
1874 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
1875 * this may be a styled CharSequence, so you must use
1876 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
1877 * retrieve it.
1878 */
1879 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
1880
1881 /**
1882 * A content: URI holding a stream of data associated with the Intent,
1883 * used with {@link #ACTION_SEND} to supply the data being sent.
1884 */
1885 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
1886
1887 /**
1888 * A String[] holding e-mail addresses that should be delivered to.
1889 */
1890 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
1891
1892 /**
1893 * A String[] holding e-mail addresses that should be carbon copied.
1894 */
1895 public static final String EXTRA_CC = "android.intent.extra.CC";
1896
1897 /**
1898 * A String[] holding e-mail addresses that should be blind carbon copied.
1899 */
1900 public static final String EXTRA_BCC = "android.intent.extra.BCC";
1901
1902 /**
1903 * A constant string holding the desired subject line of a message.
1904 */
1905 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
1906
1907 /**
1908 * An Intent describing the choices you would like shown with
1909 * {@link #ACTION_PICK_ACTIVITY}.
1910 */
1911 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
1912
1913 /**
1914 * A CharSequence dialog title to provide to the user when used with a
1915 * {@link #ACTION_CHOOSER}.
1916 */
1917 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
1918
1919 /**
1920 * A {@link android.view.KeyEvent} object containing the event that
1921 * triggered the creation of the Intent it is in.
1922 */
1923 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
1924
1925 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001926 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
1927 * before shutting down.
1928 *
1929 * {@hide}
1930 */
1931 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
1932
1933 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001934 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1935 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
1936 * of restarting the application.
1937 */
1938 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
1939
1940 /**
1941 * A String holding the phone number originally entered in
1942 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
1943 * number to call in a {@link android.content.Intent#ACTION_CALL}.
1944 */
1945 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
1946 /**
1947 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
1948 * intents to supply the uid the package had been assigned. Also an optional
1949 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
1950 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
1951 * purpose.
1952 */
1953 public static final String EXTRA_UID = "android.intent.extra.UID";
1954
1955 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001956 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1957 * intents to indicate whether this represents a full uninstall (removing
1958 * both the code and its data) or a partial uninstall (leaving its data,
1959 * implying that this is an update).
1960 */
1961 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001962
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001963 /**
1964 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
1965 * intents to indicate that this is a replacement of the package, so this
1966 * broadcast will immediately be followed by an add broadcast for a
1967 * different version of the same package.
1968 */
1969 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07001970
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001971 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001972 * Used as an int extra field in {@link android.app.AlarmManager} intents
1973 * to tell the application being invoked how many pending alarms are being
1974 * delievered with the intent. For one-shot alarms this will always be 1.
1975 * For recurring alarms, this might be greater than 1 if the device was
1976 * asleep or powered off at the time an earlier alarm would have been
1977 * delivered.
1978 */
1979 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07001980
Jacek Surazski86b6c532009-05-13 14:38:28 +02001981 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001982 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
1983 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07001984 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
1985 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
1986 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05001987 * @hide
1988 */
1989 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
1990
1991 /**
1992 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
1993 * to represent that the phone is not in any dock.
1994 * @hide
1995 */
1996 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
1997
1998 /**
1999 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2000 * to represent that the phone is in a desk dock.
2001 * @hide
2002 */
2003 public static final int EXTRA_DOCK_STATE_DESK = 1;
2004
2005 /**
2006 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2007 * to represent that the phone is in a car dock.
2008 * @hide
2009 */
2010 public static final int EXTRA_DOCK_STATE_CAR = 2;
2011
2012 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002013 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2014 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002015 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002016 * @hide
2017 */
2018 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2019
2020 /**
Romain Guy4969af72009-06-17 10:53:19 -07002021 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002022 * package. Specifies the installer package name; this package will receive the
2023 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002024 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002025 * @hide
2026 */
Romain Guy4969af72009-06-17 10:53:19 -07002027 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002028 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002029
Wei Huang97ecc9c2009-05-11 17:44:20 -07002030 /**
2031 * Used in the extra field in the remote intent. It's astring token passed with the
2032 * remote intent.
2033 */
2034 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2035 "android.intent.extra.remote_intent_token";
2036
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002037 // ---------------------------------------------------------------------
2038 // ---------------------------------------------------------------------
2039 // Intent flags (see mFlags variable).
2040
2041 /**
2042 * If set, the recipient of this Intent will be granted permission to
2043 * perform read operations on the Uri in the Intent's data.
2044 */
2045 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2046 /**
2047 * If set, the recipient of this Intent will be granted permission to
2048 * perform write operations on the Uri in the Intent's data.
2049 */
2050 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2051 /**
2052 * Can be set by the caller to indicate that this Intent is coming from
2053 * a background operation, not from direct user interaction.
2054 */
2055 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2056 /**
2057 * A flag you can enable for debugging: when set, log messages will be
2058 * printed during the resolution of this intent to show you what has
2059 * been found to create the final resolved list.
2060 */
2061 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
2062
2063 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002064 * If set, the new activity is not kept in the history stack. As soon as
2065 * the user navigates away from it, the activity is finished. This may also
2066 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2067 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002068 */
2069 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2070 /**
2071 * If set, the activity will not be launched if it is already running
2072 * at the top of the history stack.
2073 */
2074 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2075 /**
2076 * If set, this activity will become the start of a new task on this
2077 * history stack. A task (from the activity that started it to the
2078 * next task activity) defines an atomic group of activities that the
2079 * user can move to. Tasks can be moved to the foreground and background;
2080 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002081 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002082 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2083 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 *
2085 * <p>This flag is generally used by activities that want
2086 * to present a "launcher" style behavior: they give the user a list of
2087 * separate things that can be done, which otherwise run completely
2088 * independently of the activity launching them.
2089 *
2090 * <p>When using this flag, if a task is already running for the activity
2091 * you are now starting, then a new activity will not be started; instead,
2092 * the current task will simply be brought to the front of the screen with
2093 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2094 * to disable this behavior.
2095 *
2096 * <p>This flag can not be used when the caller is requesting a result from
2097 * the activity being launched.
2098 */
2099 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2100 /**
2101 * <strong>Do not use this flag unless you are implementing your own
2102 * top-level application launcher.</strong> Used in conjunction with
2103 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2104 * behavior of bringing an existing task to the foreground. When set,
2105 * a new task is <em>always</em> started to host the Activity for the
2106 * Intent, regardless of whether there is already an existing task running
2107 * the same thing.
2108 *
2109 * <p><strong>Because the default system does not include graphical task management,
2110 * you should not use this flag unless you provide some way for a user to
2111 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002112 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002113 * <p>This flag is ignored if
2114 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2115 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002116 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2117 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002118 */
2119 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2120 /**
2121 * If set, and the activity being launched is already running in the
2122 * current task, then instead of launching a new instance of that activity,
2123 * all of the other activities on top of it will be closed and this Intent
2124 * will be delivered to the (now on top) old activity as a new Intent.
2125 *
2126 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2127 * If D calls startActivity() with an Intent that resolves to the component
2128 * of activity B, then C and D will be finished and B receive the given
2129 * Intent, resulting in the stack now being: A, B.
2130 *
2131 * <p>The currently running instance of task B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002132 * either receive the new intent you are starting here in its
2133 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002134 * new intent. If it has declared its launch mode to be "multiple" (the
2135 * default) it will be finished and re-created; for all other launch modes
2136 * it will receive the Intent in the current instance.
2137 *
2138 * <p>This launch mode can also be used to good effect in conjunction with
2139 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2140 * of a task, it will bring any currently running instance of that task
2141 * to the foreground, and then clear it to its root state. This is
2142 * especially useful, for example, when launching an activity from the
2143 * notification manager.
2144 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002145 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2146 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002147 */
2148 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2149 /**
2150 * If set and this intent is being used to launch a new activity from an
2151 * existing one, then the reply target of the existing activity will be
2152 * transfered to the new activity. This way the new activity can call
2153 * {@link android.app.Activity#setResult} and have that result sent back to
2154 * the reply target of the original activity.
2155 */
2156 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2157 /**
2158 * If set and this intent is being used to launch a new activity from an
2159 * existing one, the current activity will not be counted as the top
2160 * activity for deciding whether the new intent should be delivered to
2161 * the top instead of starting a new one. The previous activity will
2162 * be used as the top, with the assumption being that the current activity
2163 * will finish itself immediately.
2164 */
2165 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2166 /**
2167 * If set, the new activity is not kept in the list of recently launched
2168 * activities.
2169 */
2170 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2171 /**
2172 * This flag is not normally set by application code, but set for you by
2173 * the system as described in the
2174 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2175 * launchMode} documentation for the singleTask mode.
2176 */
2177 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2178 /**
2179 * If set, and this activity is either being started in a new task or
2180 * bringing to the top an existing task, then it will be launched as
2181 * the front door of the task. This will result in the application of
2182 * any affinities needed to have that task in the proper state (either
2183 * moving activities to or from it), or simply resetting that task to
2184 * its initial state if needed.
2185 */
2186 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2187 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002188 * This flag is not normally set by application code, but set for you by
2189 * the system if this activity is being launched from history
2190 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002191 */
2192 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002193 /**
2194 * If set, this marks a point in the task's activity stack that should
2195 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002196 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002197 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2198 * the user re-launching it from home), this activity and all on top of
2199 * it will be finished so that the user does not return to them, but
2200 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002201 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002202 * <p>This is useful for cases where you have a logical break in your
2203 * application. For example, an e-mail application may have a command
2204 * to view an attachment, which launches an image view activity to
2205 * display it. This activity should be part of the e-mail application's
2206 * task, since it is a part of the task the user is involved in. However,
2207 * if the user leaves that task, and later selects the e-mail app from
2208 * home, we may like them to return to the conversation they were
2209 * viewing, not the picture attachment, since that is confusing. By
2210 * setting this flag when launching the image viewer, that viewer and
2211 * any activities it starts will be removed the next time the user returns
2212 * to mail.
2213 */
2214 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002215 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002216 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002217 * callback from occurring on the current frontmost activity before it is
2218 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002219 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002220 * <p>Typically, an activity can rely on that callback to indicate that an
2221 * explicit user action has caused their activity to be moved out of the
2222 * foreground. The callback marks an appropriate point in the activity's
2223 * lifecycle for it to dismiss any notifications that it intends to display
2224 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002225 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002226 * <p>If an activity is ever started via any non-user-driven events such as
2227 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2228 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002229 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002230 */
2231 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002232 /**
2233 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2234 * this flag will cause the launched activity to be brought to the front of its
2235 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002236 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002237 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2238 * If D calls startActivity() with an Intent that resolves to the component
2239 * of activity B, then B will be brought to the front of the history stack,
2240 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002241 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002242 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002243 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002244 */
2245 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002246 /**
2247 * If set, when sending a broadcast only registered receivers will be
2248 * called -- no BroadcastReceiver components will be launched.
2249 */
2250 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002251 /**
2252 * If set, when sending a broadcast <i>before boot has completed</i> only
2253 * registered receivers will be called -- no BroadcastReceiver components
2254 * will be launched. Sticky intent state will be recorded properly even
2255 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2256 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002257 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002258 * <p>This flag is only for use by system sevices as a convenience to
2259 * avoid having to implement a more complex mechanism around detection
2260 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002261 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002262 * @hide
2263 */
2264 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x20000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002265 /**
2266 * Set when this broadcast is for a boot upgrade, a special mode that
2267 * allows the broadcast to be sent before the system is ready and launches
2268 * the app process with no providers running in it.
2269 * @hide
2270 */
2271 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x10000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002272
2273 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002274 // ---------------------------------------------------------------------
2275 // toUri() and parseUri() options.
2276
2277 /**
2278 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2279 * always has the "intent:" scheme. This syntax can be used when you want
2280 * to later disambiguate between URIs that are intended to describe an
2281 * Intent vs. all others that should be treated as raw URIs. When used
2282 * with {@link #parseUri}, any other scheme will result in a generic
2283 * VIEW action for that raw URI.
2284 */
2285 public static final int URI_INTENT_SCHEME = 1<<0;
2286
2287 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288
2289 private String mAction;
2290 private Uri mData;
2291 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002292 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002293 private ComponentName mComponent;
2294 private int mFlags;
2295 private HashSet<String> mCategories;
2296 private Bundle mExtras;
2297
2298 // ---------------------------------------------------------------------
2299
2300 /**
2301 * Create an empty intent.
2302 */
2303 public Intent() {
2304 }
2305
2306 /**
2307 * Copy constructor.
2308 */
2309 public Intent(Intent o) {
2310 this.mAction = o.mAction;
2311 this.mData = o.mData;
2312 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002313 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002314 this.mComponent = o.mComponent;
2315 this.mFlags = o.mFlags;
2316 if (o.mCategories != null) {
2317 this.mCategories = new HashSet<String>(o.mCategories);
2318 }
2319 if (o.mExtras != null) {
2320 this.mExtras = new Bundle(o.mExtras);
2321 }
2322 }
2323
2324 @Override
2325 public Object clone() {
2326 return new Intent(this);
2327 }
2328
2329 private Intent(Intent o, boolean all) {
2330 this.mAction = o.mAction;
2331 this.mData = o.mData;
2332 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002333 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002334 this.mComponent = o.mComponent;
2335 if (o.mCategories != null) {
2336 this.mCategories = new HashSet<String>(o.mCategories);
2337 }
2338 }
2339
2340 /**
2341 * Make a clone of only the parts of the Intent that are relevant for
2342 * filter matching: the action, data, type, component, and categories.
2343 */
2344 public Intent cloneFilter() {
2345 return new Intent(this, false);
2346 }
2347
2348 /**
2349 * Create an intent with a given action. All other fields (data, type,
2350 * class) are null. Note that the action <em>must</em> be in a
2351 * namespace because Intents are used globally in the system -- for
2352 * example the system VIEW action is android.intent.action.VIEW; an
2353 * application's custom action would be something like
2354 * com.google.app.myapp.CUSTOM_ACTION.
2355 *
2356 * @param action The Intent action, such as ACTION_VIEW.
2357 */
2358 public Intent(String action) {
2359 mAction = action;
2360 }
2361
2362 /**
2363 * Create an intent with a given action and for a given data url. Note
2364 * that the action <em>must</em> be in a namespace because Intents are
2365 * used globally in the system -- for example the system VIEW action is
2366 * android.intent.action.VIEW; an application's custom action would be
2367 * something like com.google.app.myapp.CUSTOM_ACTION.
2368 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002369 * <p><em>Note: scheme and host name matching in the Android framework is
2370 * case-sensitive, unlike the formal RFC. As a result,
2371 * you should always ensure that you write your Uri with these elements
2372 * using lower case letters, and normalize any Uris you receive from
2373 * outside of Android to ensure the scheme and host is lower case.</em></p>
2374 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002375 * @param action The Intent action, such as ACTION_VIEW.
2376 * @param uri The Intent data URI.
2377 */
2378 public Intent(String action, Uri uri) {
2379 mAction = action;
2380 mData = uri;
2381 }
2382
2383 /**
2384 * Create an intent for a specific component. All other fields (action, data,
2385 * type, class) are null, though they can be modified later with explicit
2386 * calls. This provides a convenient way to create an intent that is
2387 * intended to execute a hard-coded class name, rather than relying on the
2388 * system to find an appropriate class for you; see {@link #setComponent}
2389 * for more information on the repercussions of this.
2390 *
2391 * @param packageContext A Context of the application package implementing
2392 * this class.
2393 * @param cls The component class that is to be used for the intent.
2394 *
2395 * @see #setClass
2396 * @see #setComponent
2397 * @see #Intent(String, android.net.Uri , Context, Class)
2398 */
2399 public Intent(Context packageContext, Class<?> cls) {
2400 mComponent = new ComponentName(packageContext, cls);
2401 }
2402
2403 /**
2404 * Create an intent for a specific component with a specified action and data.
2405 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2406 * construct the Intent and then calling {@link #setClass} to set its
2407 * class.
2408 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002409 * <p><em>Note: scheme and host name matching in the Android framework is
2410 * case-sensitive, unlike the formal RFC. As a result,
2411 * you should always ensure that you write your Uri with these elements
2412 * using lower case letters, and normalize any Uris you receive from
2413 * outside of Android to ensure the scheme and host is lower case.</em></p>
2414 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002415 * @param action The Intent action, such as ACTION_VIEW.
2416 * @param uri The Intent data URI.
2417 * @param packageContext A Context of the application package implementing
2418 * this class.
2419 * @param cls The component class that is to be used for the intent.
2420 *
2421 * @see #Intent(String, android.net.Uri)
2422 * @see #Intent(Context, Class)
2423 * @see #setClass
2424 * @see #setComponent
2425 */
2426 public Intent(String action, Uri uri,
2427 Context packageContext, Class<?> cls) {
2428 mAction = action;
2429 mData = uri;
2430 mComponent = new ComponentName(packageContext, cls);
2431 }
2432
2433 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002434 * Call {@link #parseUri} with 0 flags.
2435 * @deprecated Use {@link #parseUri} instead.
2436 */
2437 @Deprecated
2438 public static Intent getIntent(String uri) throws URISyntaxException {
2439 return parseUri(uri, 0);
2440 }
2441
2442 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002443 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002444 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002445 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002446 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002447 *
2448 * <p>The URI given here must not be relative -- that is, it must include
2449 * the scheme and full path.
2450 *
2451 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002452 * @param flags Additional processing flags. Either 0 or
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002453 *
2454 * @return Intent The newly created Intent object.
2455 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002456 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2457 * it bad (as parsed by the Uri class) or the Intent data within the
2458 * URI is invalid.
2459 *
2460 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002461 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002462 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002463 int i = 0;
2464 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002465 // Validate intent scheme for if requested.
2466 if ((flags&URI_INTENT_SCHEME) != 0) {
2467 if (!uri.startsWith("intent:")) {
2468 Intent intent = new Intent(ACTION_VIEW);
2469 try {
2470 intent.setData(Uri.parse(uri));
2471 } catch (IllegalArgumentException e) {
2472 throw new URISyntaxException(uri, e.getMessage());
2473 }
2474 return intent;
2475 }
2476 }
2477
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002478 // simple case
2479 i = uri.lastIndexOf("#");
2480 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2481
2482 // old format Intent URI
2483 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002484
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002485 // new format
2486 Intent intent = new Intent(ACTION_VIEW);
2487
2488 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002489 String data = i >= 0 ? uri.substring(0, i) : null;
2490 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002491 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002492
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002493 // loop over contents of Intent, all name=value;
2494 while (!uri.startsWith("end", i)) {
2495 int eq = uri.indexOf('=', i);
2496 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002497 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002498
2499 // action
2500 if (uri.startsWith("action=", i)) {
2501 intent.mAction = value;
2502 }
2503
2504 // categories
2505 else if (uri.startsWith("category=", i)) {
2506 intent.addCategory(value);
2507 }
2508
2509 // type
2510 else if (uri.startsWith("type=", i)) {
2511 intent.mType = value;
2512 }
2513
2514 // launch flags
2515 else if (uri.startsWith("launchFlags=", i)) {
2516 intent.mFlags = Integer.decode(value).intValue();
2517 }
2518
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002519 // package
2520 else if (uri.startsWith("package=", i)) {
2521 intent.mPackage = value;
2522 }
2523
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002524 // component
2525 else if (uri.startsWith("component=", i)) {
2526 intent.mComponent = ComponentName.unflattenFromString(value);
2527 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002528
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002529 // scheme
2530 else if (uri.startsWith("scheme=", i)) {
2531 scheme = value;
2532 }
2533
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002534 // extra
2535 else {
2536 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002537 // create Bundle if it doesn't already exist
2538 if (intent.mExtras == null) intent.mExtras = new Bundle();
2539 Bundle b = intent.mExtras;
2540 // add EXTRA
2541 if (uri.startsWith("S.", i)) b.putString(key, value);
2542 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2543 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2544 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2545 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2546 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2547 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2548 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2549 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2550 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2551 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002552
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002553 // move to the next item
2554 i = semi + 1;
2555 }
2556
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002557 if (data != null) {
2558 if (data.startsWith("intent:")) {
2559 data = data.substring(7);
2560 if (scheme != null) {
2561 data = scheme + ':' + data;
2562 }
2563 }
2564
2565 if (data.length() > 0) {
2566 try {
2567 intent.mData = Uri.parse(data);
2568 } catch (IllegalArgumentException e) {
2569 throw new URISyntaxException(uri, e.getMessage());
2570 }
2571 }
2572 }
2573
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002574 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002575
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002576 } catch (IndexOutOfBoundsException e) {
2577 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2578 }
2579 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002580
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002581 public static Intent getIntentOld(String uri) throws URISyntaxException {
2582 Intent intent;
2583
2584 int i = uri.lastIndexOf('#');
2585 if (i >= 0) {
2586 Uri data = null;
2587 String action = null;
2588 if (i > 0) {
2589 data = Uri.parse(uri.substring(0, i));
2590 }
2591
2592 i++;
2593
2594 if (uri.regionMatches(i, "action(", 0, 7)) {
2595 i += 7;
2596 int j = uri.indexOf(')', i);
2597 action = uri.substring(i, j);
2598 i = j + 1;
2599 }
2600
2601 intent = new Intent(action, data);
2602
2603 if (uri.regionMatches(i, "categories(", 0, 11)) {
2604 i += 11;
2605 int j = uri.indexOf(')', i);
2606 while (i < j) {
2607 int sep = uri.indexOf('!', i);
2608 if (sep < 0) sep = j;
2609 if (i < sep) {
2610 intent.addCategory(uri.substring(i, sep));
2611 }
2612 i = sep + 1;
2613 }
2614 i = j + 1;
2615 }
2616
2617 if (uri.regionMatches(i, "type(", 0, 5)) {
2618 i += 5;
2619 int j = uri.indexOf(')', i);
2620 intent.mType = uri.substring(i, j);
2621 i = j + 1;
2622 }
2623
2624 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
2625 i += 12;
2626 int j = uri.indexOf(')', i);
2627 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2628 i = j + 1;
2629 }
2630
2631 if (uri.regionMatches(i, "component(", 0, 10)) {
2632 i += 10;
2633 int j = uri.indexOf(')', i);
2634 int sep = uri.indexOf('!', i);
2635 if (sep >= 0 && sep < j) {
2636 String pkg = uri.substring(i, sep);
2637 String cls = uri.substring(sep + 1, j);
2638 intent.mComponent = new ComponentName(pkg, cls);
2639 }
2640 i = j + 1;
2641 }
2642
2643 if (uri.regionMatches(i, "extras(", 0, 7)) {
2644 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002645
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002646 final int closeParen = uri.indexOf(')', i);
2647 if (closeParen == -1) throw new URISyntaxException(uri,
2648 "EXTRA missing trailing ')'", i);
2649
2650 while (i < closeParen) {
2651 // fetch the key value
2652 int j = uri.indexOf('=', i);
2653 if (j <= i + 1 || i >= closeParen) {
2654 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2655 }
2656 char type = uri.charAt(i);
2657 i++;
2658 String key = uri.substring(i, j);
2659 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002661 // get type-value
2662 j = uri.indexOf('!', i);
2663 if (j == -1 || j >= closeParen) j = closeParen;
2664 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2665 String value = uri.substring(i, j);
2666 i = j;
2667
2668 // create Bundle if it doesn't already exist
2669 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002670
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002671 // add item to bundle
2672 try {
2673 switch (type) {
2674 case 'S':
2675 intent.mExtras.putString(key, Uri.decode(value));
2676 break;
2677 case 'B':
2678 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2679 break;
2680 case 'b':
2681 intent.mExtras.putByte(key, Byte.parseByte(value));
2682 break;
2683 case 'c':
2684 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2685 break;
2686 case 'd':
2687 intent.mExtras.putDouble(key, Double.parseDouble(value));
2688 break;
2689 case 'f':
2690 intent.mExtras.putFloat(key, Float.parseFloat(value));
2691 break;
2692 case 'i':
2693 intent.mExtras.putInt(key, Integer.parseInt(value));
2694 break;
2695 case 'l':
2696 intent.mExtras.putLong(key, Long.parseLong(value));
2697 break;
2698 case 's':
2699 intent.mExtras.putShort(key, Short.parseShort(value));
2700 break;
2701 default:
2702 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2703 }
2704 } catch (NumberFormatException e) {
2705 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2706 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002707
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002708 char ch = uri.charAt(i);
2709 if (ch == ')') break;
2710 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2711 i++;
2712 }
2713 }
2714
2715 if (intent.mAction == null) {
2716 // By default, if no action is specified, then use VIEW.
2717 intent.mAction = ACTION_VIEW;
2718 }
2719
2720 } else {
2721 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
2722 }
2723
2724 return intent;
2725 }
2726
2727 /**
2728 * Retrieve the general action to be performed, such as
2729 * {@link #ACTION_VIEW}. The action describes the general way the rest of
2730 * the information in the intent should be interpreted -- most importantly,
2731 * what to do with the data returned by {@link #getData}.
2732 *
2733 * @return The action of this intent or null if none is specified.
2734 *
2735 * @see #setAction
2736 */
2737 public String getAction() {
2738 return mAction;
2739 }
2740
2741 /**
2742 * Retrieve data this intent is operating on. This URI specifies the name
2743 * of the data; often it uses the content: scheme, specifying data in a
2744 * content provider. Other schemes may be handled by specific activities,
2745 * such as http: by the web browser.
2746 *
2747 * @return The URI of the data this intent is targeting or null.
2748 *
2749 * @see #getScheme
2750 * @see #setData
2751 */
2752 public Uri getData() {
2753 return mData;
2754 }
2755
2756 /**
2757 * The same as {@link #getData()}, but returns the URI as an encoded
2758 * String.
2759 */
2760 public String getDataString() {
2761 return mData != null ? mData.toString() : null;
2762 }
2763
2764 /**
2765 * Return the scheme portion of the intent's data. If the data is null or
2766 * does not include a scheme, null is returned. Otherwise, the scheme
2767 * prefix without the final ':' is returned, i.e. "http".
2768 *
2769 * <p>This is the same as calling getData().getScheme() (and checking for
2770 * null data).
2771 *
2772 * @return The scheme of this intent.
2773 *
2774 * @see #getData
2775 */
2776 public String getScheme() {
2777 return mData != null ? mData.getScheme() : null;
2778 }
2779
2780 /**
2781 * Retrieve any explicit MIME type included in the intent. This is usually
2782 * null, as the type is determined by the intent data.
2783 *
2784 * @return If a type was manually set, it is returned; else null is
2785 * returned.
2786 *
2787 * @see #resolveType(ContentResolver)
2788 * @see #setType
2789 */
2790 public String getType() {
2791 return mType;
2792 }
2793
2794 /**
2795 * Return the MIME data type of this intent. If the type field is
2796 * explicitly set, that is simply returned. Otherwise, if the data is set,
2797 * the type of that data is returned. If neither fields are set, a null is
2798 * returned.
2799 *
2800 * @return The MIME type of this intent.
2801 *
2802 * @see #getType
2803 * @see #resolveType(ContentResolver)
2804 */
2805 public String resolveType(Context context) {
2806 return resolveType(context.getContentResolver());
2807 }
2808
2809 /**
2810 * Return the MIME data type of this intent. If the type field is
2811 * explicitly set, that is simply returned. Otherwise, if the data is set,
2812 * the type of that data is returned. If neither fields are set, a null is
2813 * returned.
2814 *
2815 * @param resolver A ContentResolver that can be used to determine the MIME
2816 * type of the intent's data.
2817 *
2818 * @return The MIME type of this intent.
2819 *
2820 * @see #getType
2821 * @see #resolveType(Context)
2822 */
2823 public String resolveType(ContentResolver resolver) {
2824 if (mType != null) {
2825 return mType;
2826 }
2827 if (mData != null) {
2828 if ("content".equals(mData.getScheme())) {
2829 return resolver.getType(mData);
2830 }
2831 }
2832 return null;
2833 }
2834
2835 /**
2836 * Return the MIME data type of this intent, only if it will be needed for
2837 * intent resolution. This is not generally useful for application code;
2838 * it is used by the frameworks for communicating with back-end system
2839 * services.
2840 *
2841 * @param resolver A ContentResolver that can be used to determine the MIME
2842 * type of the intent's data.
2843 *
2844 * @return The MIME type of this intent, or null if it is unknown or not
2845 * needed.
2846 */
2847 public String resolveTypeIfNeeded(ContentResolver resolver) {
2848 if (mComponent != null) {
2849 return mType;
2850 }
2851 return resolveType(resolver);
2852 }
2853
2854 /**
2855 * Check if an category exists in the intent.
2856 *
2857 * @param category The category to check.
2858 *
2859 * @return boolean True if the intent contains the category, else false.
2860 *
2861 * @see #getCategories
2862 * @see #addCategory
2863 */
2864 public boolean hasCategory(String category) {
2865 return mCategories != null && mCategories.contains(category);
2866 }
2867
2868 /**
2869 * Return the set of all categories in the intent. If there are no categories,
2870 * returns NULL.
2871 *
2872 * @return Set The set of categories you can examine. Do not modify!
2873 *
2874 * @see #hasCategory
2875 * @see #addCategory
2876 */
2877 public Set<String> getCategories() {
2878 return mCategories;
2879 }
2880
2881 /**
2882 * Sets the ClassLoader that will be used when unmarshalling
2883 * any Parcelable values from the extras of this Intent.
2884 *
2885 * @param loader a ClassLoader, or null to use the default loader
2886 * at the time of unmarshalling.
2887 */
2888 public void setExtrasClassLoader(ClassLoader loader) {
2889 if (mExtras != null) {
2890 mExtras.setClassLoader(loader);
2891 }
2892 }
2893
2894 /**
2895 * Returns true if an extra value is associated with the given name.
2896 * @param name the extra's name
2897 * @return true if the given extra is present.
2898 */
2899 public boolean hasExtra(String name) {
2900 return mExtras != null && mExtras.containsKey(name);
2901 }
2902
2903 /**
2904 * Returns true if the Intent's extras contain a parcelled file descriptor.
2905 * @return true if the Intent contains a parcelled file descriptor.
2906 */
2907 public boolean hasFileDescriptors() {
2908 return mExtras != null && mExtras.hasFileDescriptors();
2909 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002910
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002911 /**
2912 * Retrieve extended data from the intent.
2913 *
2914 * @param name The name of the desired item.
2915 *
2916 * @return the value of an item that previously added with putExtra()
2917 * or null if none was found.
2918 *
2919 * @deprecated
2920 * @hide
2921 */
2922 @Deprecated
2923 public Object getExtra(String name) {
2924 return getExtra(name, null);
2925 }
2926
2927 /**
2928 * Retrieve extended data from the intent.
2929 *
2930 * @param name The name of the desired item.
2931 * @param defaultValue the value to be returned if no value of the desired
2932 * type is stored with the given name.
2933 *
2934 * @return the value of an item that previously added with putExtra()
2935 * or the default value if none was found.
2936 *
2937 * @see #putExtra(String, boolean)
2938 */
2939 public boolean getBooleanExtra(String name, boolean defaultValue) {
2940 return mExtras == null ? defaultValue :
2941 mExtras.getBoolean(name, defaultValue);
2942 }
2943
2944 /**
2945 * Retrieve extended data from the intent.
2946 *
2947 * @param name The name of the desired item.
2948 * @param defaultValue the value to be returned if no value of the desired
2949 * type is stored with the given name.
2950 *
2951 * @return the value of an item that previously added with putExtra()
2952 * or the default value if none was found.
2953 *
2954 * @see #putExtra(String, byte)
2955 */
2956 public byte getByteExtra(String name, byte defaultValue) {
2957 return mExtras == null ? defaultValue :
2958 mExtras.getByte(name, defaultValue);
2959 }
2960
2961 /**
2962 * Retrieve extended data from the intent.
2963 *
2964 * @param name The name of the desired item.
2965 * @param defaultValue the value to be returned if no value of the desired
2966 * type is stored with the given name.
2967 *
2968 * @return the value of an item that previously added with putExtra()
2969 * or the default value if none was found.
2970 *
2971 * @see #putExtra(String, short)
2972 */
2973 public short getShortExtra(String name, short defaultValue) {
2974 return mExtras == null ? defaultValue :
2975 mExtras.getShort(name, defaultValue);
2976 }
2977
2978 /**
2979 * Retrieve extended data from the intent.
2980 *
2981 * @param name The name of the desired item.
2982 * @param defaultValue the value to be returned if no value of the desired
2983 * type is stored with the given name.
2984 *
2985 * @return the value of an item that previously added with putExtra()
2986 * or the default value if none was found.
2987 *
2988 * @see #putExtra(String, char)
2989 */
2990 public char getCharExtra(String name, char defaultValue) {
2991 return mExtras == null ? defaultValue :
2992 mExtras.getChar(name, defaultValue);
2993 }
2994
2995 /**
2996 * Retrieve extended data from the intent.
2997 *
2998 * @param name The name of the desired item.
2999 * @param defaultValue the value to be returned if no value of the desired
3000 * type is stored with the given name.
3001 *
3002 * @return the value of an item that previously added with putExtra()
3003 * or the default value if none was found.
3004 *
3005 * @see #putExtra(String, int)
3006 */
3007 public int getIntExtra(String name, int defaultValue) {
3008 return mExtras == null ? defaultValue :
3009 mExtras.getInt(name, defaultValue);
3010 }
3011
3012 /**
3013 * Retrieve extended data from the intent.
3014 *
3015 * @param name The name of the desired item.
3016 * @param defaultValue the value to be returned if no value of the desired
3017 * type is stored with the given name.
3018 *
3019 * @return the value of an item that previously added with putExtra()
3020 * or the default value if none was found.
3021 *
3022 * @see #putExtra(String, long)
3023 */
3024 public long getLongExtra(String name, long defaultValue) {
3025 return mExtras == null ? defaultValue :
3026 mExtras.getLong(name, defaultValue);
3027 }
3028
3029 /**
3030 * Retrieve extended data from the intent.
3031 *
3032 * @param name The name of the desired item.
3033 * @param defaultValue the value to be returned if no value of the desired
3034 * type is stored with the given name.
3035 *
3036 * @return the value of an item that previously added with putExtra(),
3037 * or the default value if no such item is present
3038 *
3039 * @see #putExtra(String, float)
3040 */
3041 public float getFloatExtra(String name, float defaultValue) {
3042 return mExtras == null ? defaultValue :
3043 mExtras.getFloat(name, defaultValue);
3044 }
3045
3046 /**
3047 * Retrieve extended data from the intent.
3048 *
3049 * @param name The name of the desired item.
3050 * @param defaultValue the value to be returned if no value of the desired
3051 * type is stored with the given name.
3052 *
3053 * @return the value of an item that previously added with putExtra()
3054 * or the default value if none was found.
3055 *
3056 * @see #putExtra(String, double)
3057 */
3058 public double getDoubleExtra(String name, double defaultValue) {
3059 return mExtras == null ? defaultValue :
3060 mExtras.getDouble(name, defaultValue);
3061 }
3062
3063 /**
3064 * Retrieve extended data from the intent.
3065 *
3066 * @param name The name of the desired item.
3067 *
3068 * @return the value of an item that previously added with putExtra()
3069 * or null if no String value was found.
3070 *
3071 * @see #putExtra(String, String)
3072 */
3073 public String getStringExtra(String name) {
3074 return mExtras == null ? null : mExtras.getString(name);
3075 }
3076
3077 /**
3078 * Retrieve extended data from the intent.
3079 *
3080 * @param name The name of the desired item.
3081 *
3082 * @return the value of an item that previously added with putExtra()
3083 * or null if no CharSequence value was found.
3084 *
3085 * @see #putExtra(String, CharSequence)
3086 */
3087 public CharSequence getCharSequenceExtra(String name) {
3088 return mExtras == null ? null : mExtras.getCharSequence(name);
3089 }
3090
3091 /**
3092 * Retrieve extended data from the intent.
3093 *
3094 * @param name The name of the desired item.
3095 *
3096 * @return the value of an item that previously added with putExtra()
3097 * or null if no Parcelable value was found.
3098 *
3099 * @see #putExtra(String, Parcelable)
3100 */
3101 public <T extends Parcelable> T getParcelableExtra(String name) {
3102 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3103 }
3104
3105 /**
3106 * Retrieve extended data from the intent.
3107 *
3108 * @param name The name of the desired item.
3109 *
3110 * @return the value of an item that previously added with putExtra()
3111 * or null if no Parcelable[] value was found.
3112 *
3113 * @see #putExtra(String, Parcelable[])
3114 */
3115 public Parcelable[] getParcelableArrayExtra(String name) {
3116 return mExtras == null ? null : mExtras.getParcelableArray(name);
3117 }
3118
3119 /**
3120 * Retrieve extended data from the intent.
3121 *
3122 * @param name The name of the desired item.
3123 *
3124 * @return the value of an item that previously added with putExtra()
3125 * or null if no ArrayList<Parcelable> value was found.
3126 *
3127 * @see #putParcelableArrayListExtra(String, ArrayList)
3128 */
3129 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3130 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3131 }
3132
3133 /**
3134 * Retrieve extended data from the intent.
3135 *
3136 * @param name The name of the desired item.
3137 *
3138 * @return the value of an item that previously added with putExtra()
3139 * or null if no Serializable value was found.
3140 *
3141 * @see #putExtra(String, Serializable)
3142 */
3143 public Serializable getSerializableExtra(String name) {
3144 return mExtras == null ? null : mExtras.getSerializable(name);
3145 }
3146
3147 /**
3148 * Retrieve extended data from the intent.
3149 *
3150 * @param name The name of the desired item.
3151 *
3152 * @return the value of an item that previously added with putExtra()
3153 * or null if no ArrayList<Integer> value was found.
3154 *
3155 * @see #putIntegerArrayListExtra(String, ArrayList)
3156 */
3157 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3158 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3159 }
3160
3161 /**
3162 * Retrieve extended data from the intent.
3163 *
3164 * @param name The name of the desired item.
3165 *
3166 * @return the value of an item that previously added with putExtra()
3167 * or null if no ArrayList<String> value was found.
3168 *
3169 * @see #putStringArrayListExtra(String, ArrayList)
3170 */
3171 public ArrayList<String> getStringArrayListExtra(String name) {
3172 return mExtras == null ? null : mExtras.getStringArrayList(name);
3173 }
3174
3175 /**
3176 * Retrieve extended data from the intent.
3177 *
3178 * @param name The name of the desired item.
3179 *
3180 * @return the value of an item that previously added with putExtra()
3181 * or null if no boolean array value was found.
3182 *
3183 * @see #putExtra(String, boolean[])
3184 */
3185 public boolean[] getBooleanArrayExtra(String name) {
3186 return mExtras == null ? null : mExtras.getBooleanArray(name);
3187 }
3188
3189 /**
3190 * Retrieve extended data from the intent.
3191 *
3192 * @param name The name of the desired item.
3193 *
3194 * @return the value of an item that previously added with putExtra()
3195 * or null if no byte array value was found.
3196 *
3197 * @see #putExtra(String, byte[])
3198 */
3199 public byte[] getByteArrayExtra(String name) {
3200 return mExtras == null ? null : mExtras.getByteArray(name);
3201 }
3202
3203 /**
3204 * Retrieve extended data from the intent.
3205 *
3206 * @param name The name of the desired item.
3207 *
3208 * @return the value of an item that previously added with putExtra()
3209 * or null if no short array value was found.
3210 *
3211 * @see #putExtra(String, short[])
3212 */
3213 public short[] getShortArrayExtra(String name) {
3214 return mExtras == null ? null : mExtras.getShortArray(name);
3215 }
3216
3217 /**
3218 * Retrieve extended data from the intent.
3219 *
3220 * @param name The name of the desired item.
3221 *
3222 * @return the value of an item that previously added with putExtra()
3223 * or null if no char array value was found.
3224 *
3225 * @see #putExtra(String, char[])
3226 */
3227 public char[] getCharArrayExtra(String name) {
3228 return mExtras == null ? null : mExtras.getCharArray(name);
3229 }
3230
3231 /**
3232 * Retrieve extended data from the intent.
3233 *
3234 * @param name The name of the desired item.
3235 *
3236 * @return the value of an item that previously added with putExtra()
3237 * or null if no int array value was found.
3238 *
3239 * @see #putExtra(String, int[])
3240 */
3241 public int[] getIntArrayExtra(String name) {
3242 return mExtras == null ? null : mExtras.getIntArray(name);
3243 }
3244
3245 /**
3246 * Retrieve extended data from the intent.
3247 *
3248 * @param name The name of the desired item.
3249 *
3250 * @return the value of an item that previously added with putExtra()
3251 * or null if no long array value was found.
3252 *
3253 * @see #putExtra(String, long[])
3254 */
3255 public long[] getLongArrayExtra(String name) {
3256 return mExtras == null ? null : mExtras.getLongArray(name);
3257 }
3258
3259 /**
3260 * Retrieve extended data from the intent.
3261 *
3262 * @param name The name of the desired item.
3263 *
3264 * @return the value of an item that previously added with putExtra()
3265 * or null if no float array value was found.
3266 *
3267 * @see #putExtra(String, float[])
3268 */
3269 public float[] getFloatArrayExtra(String name) {
3270 return mExtras == null ? null : mExtras.getFloatArray(name);
3271 }
3272
3273 /**
3274 * Retrieve extended data from the intent.
3275 *
3276 * @param name The name of the desired item.
3277 *
3278 * @return the value of an item that previously added with putExtra()
3279 * or null if no double array value was found.
3280 *
3281 * @see #putExtra(String, double[])
3282 */
3283 public double[] getDoubleArrayExtra(String name) {
3284 return mExtras == null ? null : mExtras.getDoubleArray(name);
3285 }
3286
3287 /**
3288 * Retrieve extended data from the intent.
3289 *
3290 * @param name The name of the desired item.
3291 *
3292 * @return the value of an item that previously added with putExtra()
3293 * or null if no String array value was found.
3294 *
3295 * @see #putExtra(String, String[])
3296 */
3297 public String[] getStringArrayExtra(String name) {
3298 return mExtras == null ? null : mExtras.getStringArray(name);
3299 }
3300
3301 /**
3302 * Retrieve extended data from the intent.
3303 *
3304 * @param name The name of the desired item.
3305 *
3306 * @return the value of an item that previously added with putExtra()
3307 * or null if no Bundle value was found.
3308 *
3309 * @see #putExtra(String, Bundle)
3310 */
3311 public Bundle getBundleExtra(String name) {
3312 return mExtras == null ? null : mExtras.getBundle(name);
3313 }
3314
3315 /**
3316 * Retrieve extended data from the intent.
3317 *
3318 * @param name The name of the desired item.
3319 *
3320 * @return the value of an item that previously added with putExtra()
3321 * or null if no IBinder value was found.
3322 *
3323 * @see #putExtra(String, IBinder)
3324 *
3325 * @deprecated
3326 * @hide
3327 */
3328 @Deprecated
3329 public IBinder getIBinderExtra(String name) {
3330 return mExtras == null ? null : mExtras.getIBinder(name);
3331 }
3332
3333 /**
3334 * Retrieve extended data from the intent.
3335 *
3336 * @param name The name of the desired item.
3337 * @param defaultValue The default value to return in case no item is
3338 * associated with the key 'name'
3339 *
3340 * @return the value of an item that previously added with putExtra()
3341 * or defaultValue if none was found.
3342 *
3343 * @see #putExtra
3344 *
3345 * @deprecated
3346 * @hide
3347 */
3348 @Deprecated
3349 public Object getExtra(String name, Object defaultValue) {
3350 Object result = defaultValue;
3351 if (mExtras != null) {
3352 Object result2 = mExtras.get(name);
3353 if (result2 != null) {
3354 result = result2;
3355 }
3356 }
3357
3358 return result;
3359 }
3360
3361 /**
3362 * Retrieves a map of extended data from the intent.
3363 *
3364 * @return the map of all extras previously added with putExtra(),
3365 * or null if none have been added.
3366 */
3367 public Bundle getExtras() {
3368 return (mExtras != null)
3369 ? new Bundle(mExtras)
3370 : null;
3371 }
3372
3373 /**
3374 * Retrieve any special flags associated with this intent. You will
3375 * normally just set them with {@link #setFlags} and let the system
3376 * take the appropriate action with them.
3377 *
3378 * @return int The currently set flags.
3379 *
3380 * @see #setFlags
3381 */
3382 public int getFlags() {
3383 return mFlags;
3384 }
3385
3386 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003387 * Retrieve the application package name this Intent is limited to. When
3388 * resolving an Intent, if non-null this limits the resolution to only
3389 * components in the given application package.
3390 *
3391 * @return The name of the application package for the Intent.
3392 *
3393 * @see #resolveActivity
3394 * @see #setPackage
3395 */
3396 public String getPackage() {
3397 return mPackage;
3398 }
3399
3400 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003401 * Retrieve the concrete component associated with the intent. When receiving
3402 * an intent, this is the component that was found to best handle it (that is,
3403 * yourself) and will always be non-null; in all other cases it will be
3404 * null unless explicitly set.
3405 *
3406 * @return The name of the application component to handle the intent.
3407 *
3408 * @see #resolveActivity
3409 * @see #setComponent
3410 */
3411 public ComponentName getComponent() {
3412 return mComponent;
3413 }
3414
3415 /**
3416 * Return the Activity component that should be used to handle this intent.
3417 * The appropriate component is determined based on the information in the
3418 * intent, evaluated as follows:
3419 *
3420 * <p>If {@link #getComponent} returns an explicit class, that is returned
3421 * without any further consideration.
3422 *
3423 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3424 * category to be considered.
3425 *
3426 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3427 * action.
3428 *
3429 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3430 * this type.
3431 *
3432 * <p>If {@link #addCategory} has added any categories, the activity must
3433 * handle ALL of the categories specified.
3434 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003435 * <p>If {@link #getPackage} is non-NULL, only activity components in
3436 * that application package will be considered.
3437 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003438 * <p>If there are no activities that satisfy all of these conditions, a
3439 * null string is returned.
3440 *
3441 * <p>If multiple activities are found to satisfy the intent, the one with
3442 * the highest priority will be used. If there are multiple activities
3443 * with the same priority, the system will either pick the best activity
3444 * based on user preference, or resolve to a system class that will allow
3445 * the user to pick an activity and forward from there.
3446 *
3447 * <p>This method is implemented simply by calling
3448 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3449 * true.</p>
3450 * <p> This API is called for you as part of starting an activity from an
3451 * intent. You do not normally need to call it yourself.</p>
3452 *
3453 * @param pm The package manager with which to resolve the Intent.
3454 *
3455 * @return Name of the component implementing an activity that can
3456 * display the intent.
3457 *
3458 * @see #setComponent
3459 * @see #getComponent
3460 * @see #resolveActivityInfo
3461 */
3462 public ComponentName resolveActivity(PackageManager pm) {
3463 if (mComponent != null) {
3464 return mComponent;
3465 }
3466
3467 ResolveInfo info = pm.resolveActivity(
3468 this, PackageManager.MATCH_DEFAULT_ONLY);
3469 if (info != null) {
3470 return new ComponentName(
3471 info.activityInfo.applicationInfo.packageName,
3472 info.activityInfo.name);
3473 }
3474
3475 return null;
3476 }
3477
3478 /**
3479 * Resolve the Intent into an {@link ActivityInfo}
3480 * describing the activity that should execute the intent. Resolution
3481 * follows the same rules as described for {@link #resolveActivity}, but
3482 * you get back the completely information about the resolved activity
3483 * instead of just its class name.
3484 *
3485 * @param pm The package manager with which to resolve the Intent.
3486 * @param flags Addition information to retrieve as per
3487 * {@link PackageManager#getActivityInfo(ComponentName, int)
3488 * PackageManager.getActivityInfo()}.
3489 *
3490 * @return PackageManager.ActivityInfo
3491 *
3492 * @see #resolveActivity
3493 */
3494 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3495 ActivityInfo ai = null;
3496 if (mComponent != null) {
3497 try {
3498 ai = pm.getActivityInfo(mComponent, flags);
3499 } catch (PackageManager.NameNotFoundException e) {
3500 // ignore
3501 }
3502 } else {
3503 ResolveInfo info = pm.resolveActivity(
3504 this, PackageManager.MATCH_DEFAULT_ONLY);
3505 if (info != null) {
3506 ai = info.activityInfo;
3507 }
3508 }
3509
3510 return ai;
3511 }
3512
3513 /**
3514 * Set the general action to be performed.
3515 *
3516 * @param action An action name, such as ACTION_VIEW. Application-specific
3517 * actions should be prefixed with the vendor's package name.
3518 *
3519 * @return Returns the same Intent object, for chaining multiple calls
3520 * into a single statement.
3521 *
3522 * @see #getAction
3523 */
3524 public Intent setAction(String action) {
3525 mAction = action;
3526 return this;
3527 }
3528
3529 /**
3530 * Set the data this intent is operating on. This method automatically
3531 * clears any type that was previously set by {@link #setType}.
3532 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003533 * <p><em>Note: scheme and host name matching in the Android framework is
3534 * case-sensitive, unlike the formal RFC. As a result,
3535 * you should always ensure that you write your Uri with these elements
3536 * using lower case letters, and normalize any Uris you receive from
3537 * outside of Android to ensure the scheme and host is lower case.</em></p>
3538 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003539 * @param data The URI of the data this intent is now targeting.
3540 *
3541 * @return Returns the same Intent object, for chaining multiple calls
3542 * into a single statement.
3543 *
3544 * @see #getData
3545 * @see #setType
3546 * @see #setDataAndType
3547 */
3548 public Intent setData(Uri data) {
3549 mData = data;
3550 mType = null;
3551 return this;
3552 }
3553
3554 /**
3555 * Set an explicit MIME data type. This is used to create intents that
3556 * only specify a type and not data, for example to indicate the type of
3557 * data to return. This method automatically clears any data that was
3558 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07003559 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003560 * <p><em>Note: MIME type matching in the Android framework is
3561 * case-sensitive, unlike formal RFC MIME types. As a result,
3562 * you should always write your MIME types with lower case letters,
3563 * and any MIME types you receive from outside of Android should be
3564 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003565 *
3566 * @param type The MIME type of the data being handled by this intent.
3567 *
3568 * @return Returns the same Intent object, for chaining multiple calls
3569 * into a single statement.
3570 *
3571 * @see #getType
3572 * @see #setData
3573 * @see #setDataAndType
3574 */
3575 public Intent setType(String type) {
3576 mData = null;
3577 mType = type;
3578 return this;
3579 }
3580
3581 /**
3582 * (Usually optional) Set the data for the intent along with an explicit
3583 * MIME data type. This method should very rarely be used -- it allows you
3584 * to override the MIME type that would ordinarily be inferred from the
3585 * data with your own type given here.
3586 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003587 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3588 * Android framework is case-sensitive, unlike the formal RFC definitions.
3589 * As a result, you should always write these elements with lower case letters,
3590 * and normalize any MIME types or Uris you receive from
3591 * outside of Android to ensure these elements are lower case before
3592 * supplying them here.</em></p>
3593 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003594 * @param data The URI of the data this intent is now targeting.
3595 * @param type The MIME type of the data being handled by this intent.
3596 *
3597 * @return Returns the same Intent object, for chaining multiple calls
3598 * into a single statement.
3599 *
3600 * @see #setData
3601 * @see #setType
3602 */
3603 public Intent setDataAndType(Uri data, String type) {
3604 mData = data;
3605 mType = type;
3606 return this;
3607 }
3608
3609 /**
3610 * Add a new category to the intent. Categories provide additional detail
3611 * about the action the intent is perform. When resolving an intent, only
3612 * activities that provide <em>all</em> of the requested categories will be
3613 * used.
3614 *
3615 * @param category The desired category. This can be either one of the
3616 * predefined Intent categories, or a custom category in your own
3617 * namespace.
3618 *
3619 * @return Returns the same Intent object, for chaining multiple calls
3620 * into a single statement.
3621 *
3622 * @see #hasCategory
3623 * @see #removeCategory
3624 */
3625 public Intent addCategory(String category) {
3626 if (mCategories == null) {
3627 mCategories = new HashSet<String>();
3628 }
3629 mCategories.add(category);
3630 return this;
3631 }
3632
3633 /**
3634 * Remove an category from an intent.
3635 *
3636 * @param category The category to remove.
3637 *
3638 * @see #addCategory
3639 */
3640 public void removeCategory(String category) {
3641 if (mCategories != null) {
3642 mCategories.remove(category);
3643 if (mCategories.size() == 0) {
3644 mCategories = null;
3645 }
3646 }
3647 }
3648
3649 /**
3650 * Add extended data to the intent. The name must include a package
3651 * prefix, for example the app com.android.contacts would use names
3652 * like "com.android.contacts.ShowAll".
3653 *
3654 * @param name The name of the extra data, with package prefix.
3655 * @param value The boolean data value.
3656 *
3657 * @return Returns the same Intent object, for chaining multiple calls
3658 * into a single statement.
3659 *
3660 * @see #putExtras
3661 * @see #removeExtra
3662 * @see #getBooleanExtra(String, boolean)
3663 */
3664 public Intent putExtra(String name, boolean value) {
3665 if (mExtras == null) {
3666 mExtras = new Bundle();
3667 }
3668 mExtras.putBoolean(name, value);
3669 return this;
3670 }
3671
3672 /**
3673 * Add extended data to the intent. The name must include a package
3674 * prefix, for example the app com.android.contacts would use names
3675 * like "com.android.contacts.ShowAll".
3676 *
3677 * @param name The name of the extra data, with package prefix.
3678 * @param value The byte data value.
3679 *
3680 * @return Returns the same Intent object, for chaining multiple calls
3681 * into a single statement.
3682 *
3683 * @see #putExtras
3684 * @see #removeExtra
3685 * @see #getByteExtra(String, byte)
3686 */
3687 public Intent putExtra(String name, byte value) {
3688 if (mExtras == null) {
3689 mExtras = new Bundle();
3690 }
3691 mExtras.putByte(name, value);
3692 return this;
3693 }
3694
3695 /**
3696 * Add extended data to the intent. The name must include a package
3697 * prefix, for example the app com.android.contacts would use names
3698 * like "com.android.contacts.ShowAll".
3699 *
3700 * @param name The name of the extra data, with package prefix.
3701 * @param value The char data value.
3702 *
3703 * @return Returns the same Intent object, for chaining multiple calls
3704 * into a single statement.
3705 *
3706 * @see #putExtras
3707 * @see #removeExtra
3708 * @see #getCharExtra(String, char)
3709 */
3710 public Intent putExtra(String name, char value) {
3711 if (mExtras == null) {
3712 mExtras = new Bundle();
3713 }
3714 mExtras.putChar(name, value);
3715 return this;
3716 }
3717
3718 /**
3719 * Add extended data to the intent. The name must include a package
3720 * prefix, for example the app com.android.contacts would use names
3721 * like "com.android.contacts.ShowAll".
3722 *
3723 * @param name The name of the extra data, with package prefix.
3724 * @param value The short data value.
3725 *
3726 * @return Returns the same Intent object, for chaining multiple calls
3727 * into a single statement.
3728 *
3729 * @see #putExtras
3730 * @see #removeExtra
3731 * @see #getShortExtra(String, short)
3732 */
3733 public Intent putExtra(String name, short value) {
3734 if (mExtras == null) {
3735 mExtras = new Bundle();
3736 }
3737 mExtras.putShort(name, value);
3738 return this;
3739 }
3740
3741 /**
3742 * Add extended data to the intent. The name must include a package
3743 * prefix, for example the app com.android.contacts would use names
3744 * like "com.android.contacts.ShowAll".
3745 *
3746 * @param name The name of the extra data, with package prefix.
3747 * @param value The integer data value.
3748 *
3749 * @return Returns the same Intent object, for chaining multiple calls
3750 * into a single statement.
3751 *
3752 * @see #putExtras
3753 * @see #removeExtra
3754 * @see #getIntExtra(String, int)
3755 */
3756 public Intent putExtra(String name, int value) {
3757 if (mExtras == null) {
3758 mExtras = new Bundle();
3759 }
3760 mExtras.putInt(name, value);
3761 return this;
3762 }
3763
3764 /**
3765 * Add extended data to the intent. The name must include a package
3766 * prefix, for example the app com.android.contacts would use names
3767 * like "com.android.contacts.ShowAll".
3768 *
3769 * @param name The name of the extra data, with package prefix.
3770 * @param value The long data value.
3771 *
3772 * @return Returns the same Intent object, for chaining multiple calls
3773 * into a single statement.
3774 *
3775 * @see #putExtras
3776 * @see #removeExtra
3777 * @see #getLongExtra(String, long)
3778 */
3779 public Intent putExtra(String name, long value) {
3780 if (mExtras == null) {
3781 mExtras = new Bundle();
3782 }
3783 mExtras.putLong(name, value);
3784 return this;
3785 }
3786
3787 /**
3788 * Add extended data to the intent. The name must include a package
3789 * prefix, for example the app com.android.contacts would use names
3790 * like "com.android.contacts.ShowAll".
3791 *
3792 * @param name The name of the extra data, with package prefix.
3793 * @param value The float data value.
3794 *
3795 * @return Returns the same Intent object, for chaining multiple calls
3796 * into a single statement.
3797 *
3798 * @see #putExtras
3799 * @see #removeExtra
3800 * @see #getFloatExtra(String, float)
3801 */
3802 public Intent putExtra(String name, float value) {
3803 if (mExtras == null) {
3804 mExtras = new Bundle();
3805 }
3806 mExtras.putFloat(name, value);
3807 return this;
3808 }
3809
3810 /**
3811 * Add extended data to the intent. The name must include a package
3812 * prefix, for example the app com.android.contacts would use names
3813 * like "com.android.contacts.ShowAll".
3814 *
3815 * @param name The name of the extra data, with package prefix.
3816 * @param value The double data value.
3817 *
3818 * @return Returns the same Intent object, for chaining multiple calls
3819 * into a single statement.
3820 *
3821 * @see #putExtras
3822 * @see #removeExtra
3823 * @see #getDoubleExtra(String, double)
3824 */
3825 public Intent putExtra(String name, double value) {
3826 if (mExtras == null) {
3827 mExtras = new Bundle();
3828 }
3829 mExtras.putDouble(name, value);
3830 return this;
3831 }
3832
3833 /**
3834 * Add extended data to the intent. The name must include a package
3835 * prefix, for example the app com.android.contacts would use names
3836 * like "com.android.contacts.ShowAll".
3837 *
3838 * @param name The name of the extra data, with package prefix.
3839 * @param value The String data value.
3840 *
3841 * @return Returns the same Intent object, for chaining multiple calls
3842 * into a single statement.
3843 *
3844 * @see #putExtras
3845 * @see #removeExtra
3846 * @see #getStringExtra(String)
3847 */
3848 public Intent putExtra(String name, String value) {
3849 if (mExtras == null) {
3850 mExtras = new Bundle();
3851 }
3852 mExtras.putString(name, value);
3853 return this;
3854 }
3855
3856 /**
3857 * Add extended data to the intent. The name must include a package
3858 * prefix, for example the app com.android.contacts would use names
3859 * like "com.android.contacts.ShowAll".
3860 *
3861 * @param name The name of the extra data, with package prefix.
3862 * @param value The CharSequence data value.
3863 *
3864 * @return Returns the same Intent object, for chaining multiple calls
3865 * into a single statement.
3866 *
3867 * @see #putExtras
3868 * @see #removeExtra
3869 * @see #getCharSequenceExtra(String)
3870 */
3871 public Intent putExtra(String name, CharSequence value) {
3872 if (mExtras == null) {
3873 mExtras = new Bundle();
3874 }
3875 mExtras.putCharSequence(name, value);
3876 return this;
3877 }
3878
3879 /**
3880 * Add extended data to the intent. The name must include a package
3881 * prefix, for example the app com.android.contacts would use names
3882 * like "com.android.contacts.ShowAll".
3883 *
3884 * @param name The name of the extra data, with package prefix.
3885 * @param value The Parcelable data value.
3886 *
3887 * @return Returns the same Intent object, for chaining multiple calls
3888 * into a single statement.
3889 *
3890 * @see #putExtras
3891 * @see #removeExtra
3892 * @see #getParcelableExtra(String)
3893 */
3894 public Intent putExtra(String name, Parcelable value) {
3895 if (mExtras == null) {
3896 mExtras = new Bundle();
3897 }
3898 mExtras.putParcelable(name, value);
3899 return this;
3900 }
3901
3902 /**
3903 * Add extended data to the intent. The name must include a package
3904 * prefix, for example the app com.android.contacts would use names
3905 * like "com.android.contacts.ShowAll".
3906 *
3907 * @param name The name of the extra data, with package prefix.
3908 * @param value The Parcelable[] data value.
3909 *
3910 * @return Returns the same Intent object, for chaining multiple calls
3911 * into a single statement.
3912 *
3913 * @see #putExtras
3914 * @see #removeExtra
3915 * @see #getParcelableArrayExtra(String)
3916 */
3917 public Intent putExtra(String name, Parcelable[] value) {
3918 if (mExtras == null) {
3919 mExtras = new Bundle();
3920 }
3921 mExtras.putParcelableArray(name, value);
3922 return this;
3923 }
3924
3925 /**
3926 * Add extended data to the intent. The name must include a package
3927 * prefix, for example the app com.android.contacts would use names
3928 * like "com.android.contacts.ShowAll".
3929 *
3930 * @param name The name of the extra data, with package prefix.
3931 * @param value The ArrayList<Parcelable> data value.
3932 *
3933 * @return Returns the same Intent object, for chaining multiple calls
3934 * into a single statement.
3935 *
3936 * @see #putExtras
3937 * @see #removeExtra
3938 * @see #getParcelableArrayListExtra(String)
3939 */
3940 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
3941 if (mExtras == null) {
3942 mExtras = new Bundle();
3943 }
3944 mExtras.putParcelableArrayList(name, value);
3945 return this;
3946 }
3947
3948 /**
3949 * Add extended data to the intent. The name must include a package
3950 * prefix, for example the app com.android.contacts would use names
3951 * like "com.android.contacts.ShowAll".
3952 *
3953 * @param name The name of the extra data, with package prefix.
3954 * @param value The ArrayList<Integer> data value.
3955 *
3956 * @return Returns the same Intent object, for chaining multiple calls
3957 * into a single statement.
3958 *
3959 * @see #putExtras
3960 * @see #removeExtra
3961 * @see #getIntegerArrayListExtra(String)
3962 */
3963 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
3964 if (mExtras == null) {
3965 mExtras = new Bundle();
3966 }
3967 mExtras.putIntegerArrayList(name, value);
3968 return this;
3969 }
3970
3971 /**
3972 * Add extended data to the intent. The name must include a package
3973 * prefix, for example the app com.android.contacts would use names
3974 * like "com.android.contacts.ShowAll".
3975 *
3976 * @param name The name of the extra data, with package prefix.
3977 * @param value The ArrayList<String> data value.
3978 *
3979 * @return Returns the same Intent object, for chaining multiple calls
3980 * into a single statement.
3981 *
3982 * @see #putExtras
3983 * @see #removeExtra
3984 * @see #getStringArrayListExtra(String)
3985 */
3986 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
3987 if (mExtras == null) {
3988 mExtras = new Bundle();
3989 }
3990 mExtras.putStringArrayList(name, value);
3991 return this;
3992 }
3993
3994 /**
3995 * Add extended data to the intent. The name must include a package
3996 * prefix, for example the app com.android.contacts would use names
3997 * like "com.android.contacts.ShowAll".
3998 *
3999 * @param name The name of the extra data, with package prefix.
4000 * @param value The Serializable data value.
4001 *
4002 * @return Returns the same Intent object, for chaining multiple calls
4003 * into a single statement.
4004 *
4005 * @see #putExtras
4006 * @see #removeExtra
4007 * @see #getSerializableExtra(String)
4008 */
4009 public Intent putExtra(String name, Serializable value) {
4010 if (mExtras == null) {
4011 mExtras = new Bundle();
4012 }
4013 mExtras.putSerializable(name, value);
4014 return this;
4015 }
4016
4017 /**
4018 * Add extended data to the intent. The name must include a package
4019 * prefix, for example the app com.android.contacts would use names
4020 * like "com.android.contacts.ShowAll".
4021 *
4022 * @param name The name of the extra data, with package prefix.
4023 * @param value The boolean array data value.
4024 *
4025 * @return Returns the same Intent object, for chaining multiple calls
4026 * into a single statement.
4027 *
4028 * @see #putExtras
4029 * @see #removeExtra
4030 * @see #getBooleanArrayExtra(String)
4031 */
4032 public Intent putExtra(String name, boolean[] value) {
4033 if (mExtras == null) {
4034 mExtras = new Bundle();
4035 }
4036 mExtras.putBooleanArray(name, value);
4037 return this;
4038 }
4039
4040 /**
4041 * Add extended data to the intent. The name must include a package
4042 * prefix, for example the app com.android.contacts would use names
4043 * like "com.android.contacts.ShowAll".
4044 *
4045 * @param name The name of the extra data, with package prefix.
4046 * @param value The byte array data value.
4047 *
4048 * @return Returns the same Intent object, for chaining multiple calls
4049 * into a single statement.
4050 *
4051 * @see #putExtras
4052 * @see #removeExtra
4053 * @see #getByteArrayExtra(String)
4054 */
4055 public Intent putExtra(String name, byte[] value) {
4056 if (mExtras == null) {
4057 mExtras = new Bundle();
4058 }
4059 mExtras.putByteArray(name, value);
4060 return this;
4061 }
4062
4063 /**
4064 * Add extended data to the intent. The name must include a package
4065 * prefix, for example the app com.android.contacts would use names
4066 * like "com.android.contacts.ShowAll".
4067 *
4068 * @param name The name of the extra data, with package prefix.
4069 * @param value The short array data value.
4070 *
4071 * @return Returns the same Intent object, for chaining multiple calls
4072 * into a single statement.
4073 *
4074 * @see #putExtras
4075 * @see #removeExtra
4076 * @see #getShortArrayExtra(String)
4077 */
4078 public Intent putExtra(String name, short[] value) {
4079 if (mExtras == null) {
4080 mExtras = new Bundle();
4081 }
4082 mExtras.putShortArray(name, value);
4083 return this;
4084 }
4085
4086 /**
4087 * Add extended data to the intent. The name must include a package
4088 * prefix, for example the app com.android.contacts would use names
4089 * like "com.android.contacts.ShowAll".
4090 *
4091 * @param name The name of the extra data, with package prefix.
4092 * @param value The char array data value.
4093 *
4094 * @return Returns the same Intent object, for chaining multiple calls
4095 * into a single statement.
4096 *
4097 * @see #putExtras
4098 * @see #removeExtra
4099 * @see #getCharArrayExtra(String)
4100 */
4101 public Intent putExtra(String name, char[] value) {
4102 if (mExtras == null) {
4103 mExtras = new Bundle();
4104 }
4105 mExtras.putCharArray(name, value);
4106 return this;
4107 }
4108
4109 /**
4110 * Add extended data to the intent. The name must include a package
4111 * prefix, for example the app com.android.contacts would use names
4112 * like "com.android.contacts.ShowAll".
4113 *
4114 * @param name The name of the extra data, with package prefix.
4115 * @param value The int array data value.
4116 *
4117 * @return Returns the same Intent object, for chaining multiple calls
4118 * into a single statement.
4119 *
4120 * @see #putExtras
4121 * @see #removeExtra
4122 * @see #getIntArrayExtra(String)
4123 */
4124 public Intent putExtra(String name, int[] value) {
4125 if (mExtras == null) {
4126 mExtras = new Bundle();
4127 }
4128 mExtras.putIntArray(name, value);
4129 return this;
4130 }
4131
4132 /**
4133 * Add extended data to the intent. The name must include a package
4134 * prefix, for example the app com.android.contacts would use names
4135 * like "com.android.contacts.ShowAll".
4136 *
4137 * @param name The name of the extra data, with package prefix.
4138 * @param value The byte array data value.
4139 *
4140 * @return Returns the same Intent object, for chaining multiple calls
4141 * into a single statement.
4142 *
4143 * @see #putExtras
4144 * @see #removeExtra
4145 * @see #getLongArrayExtra(String)
4146 */
4147 public Intent putExtra(String name, long[] value) {
4148 if (mExtras == null) {
4149 mExtras = new Bundle();
4150 }
4151 mExtras.putLongArray(name, value);
4152 return this;
4153 }
4154
4155 /**
4156 * Add extended data to the intent. The name must include a package
4157 * prefix, for example the app com.android.contacts would use names
4158 * like "com.android.contacts.ShowAll".
4159 *
4160 * @param name The name of the extra data, with package prefix.
4161 * @param value The float array data value.
4162 *
4163 * @return Returns the same Intent object, for chaining multiple calls
4164 * into a single statement.
4165 *
4166 * @see #putExtras
4167 * @see #removeExtra
4168 * @see #getFloatArrayExtra(String)
4169 */
4170 public Intent putExtra(String name, float[] value) {
4171 if (mExtras == null) {
4172 mExtras = new Bundle();
4173 }
4174 mExtras.putFloatArray(name, value);
4175 return this;
4176 }
4177
4178 /**
4179 * Add extended data to the intent. The name must include a package
4180 * prefix, for example the app com.android.contacts would use names
4181 * like "com.android.contacts.ShowAll".
4182 *
4183 * @param name The name of the extra data, with package prefix.
4184 * @param value The double array data value.
4185 *
4186 * @return Returns the same Intent object, for chaining multiple calls
4187 * into a single statement.
4188 *
4189 * @see #putExtras
4190 * @see #removeExtra
4191 * @see #getDoubleArrayExtra(String)
4192 */
4193 public Intent putExtra(String name, double[] value) {
4194 if (mExtras == null) {
4195 mExtras = new Bundle();
4196 }
4197 mExtras.putDoubleArray(name, value);
4198 return this;
4199 }
4200
4201 /**
4202 * Add extended data to the intent. The name must include a package
4203 * prefix, for example the app com.android.contacts would use names
4204 * like "com.android.contacts.ShowAll".
4205 *
4206 * @param name The name of the extra data, with package prefix.
4207 * @param value The String array data value.
4208 *
4209 * @return Returns the same Intent object, for chaining multiple calls
4210 * into a single statement.
4211 *
4212 * @see #putExtras
4213 * @see #removeExtra
4214 * @see #getStringArrayExtra(String)
4215 */
4216 public Intent putExtra(String name, String[] value) {
4217 if (mExtras == null) {
4218 mExtras = new Bundle();
4219 }
4220 mExtras.putStringArray(name, value);
4221 return this;
4222 }
4223
4224 /**
4225 * Add extended data to the intent. The name must include a package
4226 * prefix, for example the app com.android.contacts would use names
4227 * like "com.android.contacts.ShowAll".
4228 *
4229 * @param name The name of the extra data, with package prefix.
4230 * @param value The Bundle data value.
4231 *
4232 * @return Returns the same Intent object, for chaining multiple calls
4233 * into a single statement.
4234 *
4235 * @see #putExtras
4236 * @see #removeExtra
4237 * @see #getBundleExtra(String)
4238 */
4239 public Intent putExtra(String name, Bundle value) {
4240 if (mExtras == null) {
4241 mExtras = new Bundle();
4242 }
4243 mExtras.putBundle(name, value);
4244 return this;
4245 }
4246
4247 /**
4248 * Add extended data to the intent. The name must include a package
4249 * prefix, for example the app com.android.contacts would use names
4250 * like "com.android.contacts.ShowAll".
4251 *
4252 * @param name The name of the extra data, with package prefix.
4253 * @param value The IBinder data value.
4254 *
4255 * @return Returns the same Intent object, for chaining multiple calls
4256 * into a single statement.
4257 *
4258 * @see #putExtras
4259 * @see #removeExtra
4260 * @see #getIBinderExtra(String)
4261 *
4262 * @deprecated
4263 * @hide
4264 */
4265 @Deprecated
4266 public Intent putExtra(String name, IBinder value) {
4267 if (mExtras == null) {
4268 mExtras = new Bundle();
4269 }
4270 mExtras.putIBinder(name, value);
4271 return this;
4272 }
4273
4274 /**
4275 * Copy all extras in 'src' in to this intent.
4276 *
4277 * @param src Contains the extras to copy.
4278 *
4279 * @see #putExtra
4280 */
4281 public Intent putExtras(Intent src) {
4282 if (src.mExtras != null) {
4283 if (mExtras == null) {
4284 mExtras = new Bundle(src.mExtras);
4285 } else {
4286 mExtras.putAll(src.mExtras);
4287 }
4288 }
4289 return this;
4290 }
4291
4292 /**
4293 * Add a set of extended data to the intent. The keys must include a package
4294 * prefix, for example the app com.android.contacts would use names
4295 * like "com.android.contacts.ShowAll".
4296 *
4297 * @param extras The Bundle of extras to add to this intent.
4298 *
4299 * @see #putExtra
4300 * @see #removeExtra
4301 */
4302 public Intent putExtras(Bundle extras) {
4303 if (mExtras == null) {
4304 mExtras = new Bundle();
4305 }
4306 mExtras.putAll(extras);
4307 return this;
4308 }
4309
4310 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004311 * Completely replace the extras in the Intent with the extras in the
4312 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004313 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004314 * @param src The exact extras contained in this Intent are copied
4315 * into the target intent, replacing any that were previously there.
4316 */
4317 public Intent replaceExtras(Intent src) {
4318 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4319 return this;
4320 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004321
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004322 /**
4323 * Completely replace the extras in the Intent with the given Bundle of
4324 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004325 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004326 * @param extras The new set of extras in the Intent, or null to erase
4327 * all extras.
4328 */
4329 public Intent replaceExtras(Bundle extras) {
4330 mExtras = extras != null ? new Bundle(extras) : null;
4331 return this;
4332 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004333
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004334 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004335 * Remove extended data from the intent.
4336 *
4337 * @see #putExtra
4338 */
4339 public void removeExtra(String name) {
4340 if (mExtras != null) {
4341 mExtras.remove(name);
4342 if (mExtras.size() == 0) {
4343 mExtras = null;
4344 }
4345 }
4346 }
4347
4348 /**
4349 * Set special flags controlling how this intent is handled. Most values
4350 * here depend on the type of component being executed by the Intent,
4351 * specifically the FLAG_ACTIVITY_* flags are all for use with
4352 * {@link Context#startActivity Context.startActivity()} and the
4353 * FLAG_RECEIVER_* flags are all for use with
4354 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4355 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004356 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4357 * 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 -07004358 * the behavior of your application.
4359 *
4360 * @param flags The desired flags.
4361 *
4362 * @return Returns the same Intent object, for chaining multiple calls
4363 * into a single statement.
4364 *
4365 * @see #getFlags
4366 * @see #addFlags
4367 *
4368 * @see #FLAG_GRANT_READ_URI_PERMISSION
4369 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4370 * @see #FLAG_DEBUG_LOG_RESOLUTION
4371 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004372 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004373 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004374 * @see #FLAG_ACTIVITY_CLEAR_TOP
4375 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4376 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004377 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004378 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4379 * @see #FLAG_ACTIVITY_NEW_TASK
4380 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004381 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004382 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4383 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004384 * @see #FLAG_ACTIVITY_SINGLE_TOP
4385 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4386 */
4387 public Intent setFlags(int flags) {
4388 mFlags = flags;
4389 return this;
4390 }
4391
4392 /**
4393 * Add additional flags to the intent (or with existing flags
4394 * value).
4395 *
4396 * @param flags The new flags to set.
4397 *
4398 * @return Returns the same Intent object, for chaining multiple calls
4399 * into a single statement.
4400 *
4401 * @see #setFlags
4402 */
4403 public Intent addFlags(int flags) {
4404 mFlags |= flags;
4405 return this;
4406 }
4407
4408 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004409 * (Usually optional) Set an explicit application package name that limits
4410 * the components this Intent will resolve to. If left to the default
4411 * value of null, all components in all applications will considered.
4412 * If non-null, the Intent can only match the components in the given
4413 * application package.
4414 *
4415 * @param packageName The name of the application package to handle the
4416 * intent, or null to allow any application package.
4417 *
4418 * @return Returns the same Intent object, for chaining multiple calls
4419 * into a single statement.
4420 *
4421 * @see #getPackage
4422 * @see #resolveActivity
4423 */
4424 public Intent setPackage(String packageName) {
4425 mPackage = packageName;
4426 return this;
4427 }
4428
4429 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004430 * (Usually optional) Explicitly set the component to handle the intent.
4431 * If left with the default value of null, the system will determine the
4432 * appropriate class to use based on the other fields (action, data,
4433 * type, categories) in the Intent. If this class is defined, the
4434 * specified class will always be used regardless of the other fields. You
4435 * should only set this value when you know you absolutely want a specific
4436 * class to be used; otherwise it is better to let the system find the
4437 * appropriate class so that you will respect the installed applications
4438 * and user preferences.
4439 *
4440 * @param component The name of the application component to handle the
4441 * intent, or null to let the system find one for you.
4442 *
4443 * @return Returns the same Intent object, for chaining multiple calls
4444 * into a single statement.
4445 *
4446 * @see #setClass
4447 * @see #setClassName(Context, String)
4448 * @see #setClassName(String, String)
4449 * @see #getComponent
4450 * @see #resolveActivity
4451 */
4452 public Intent setComponent(ComponentName component) {
4453 mComponent = component;
4454 return this;
4455 }
4456
4457 /**
4458 * Convenience for calling {@link #setComponent} with an
4459 * explicit class name.
4460 *
4461 * @param packageContext A Context of the application package implementing
4462 * this class.
4463 * @param className The name of a class inside of the application package
4464 * that will be used as the component for this Intent.
4465 *
4466 * @return Returns the same Intent object, for chaining multiple calls
4467 * into a single statement.
4468 *
4469 * @see #setComponent
4470 * @see #setClass
4471 */
4472 public Intent setClassName(Context packageContext, String className) {
4473 mComponent = new ComponentName(packageContext, className);
4474 return this;
4475 }
4476
4477 /**
4478 * Convenience for calling {@link #setComponent} with an
4479 * explicit application package name and class name.
4480 *
4481 * @param packageName The name of the package implementing the desired
4482 * component.
4483 * @param className The name of a class inside of the application package
4484 * that will be used as the component for this Intent.
4485 *
4486 * @return Returns the same Intent object, for chaining multiple calls
4487 * into a single statement.
4488 *
4489 * @see #setComponent
4490 * @see #setClass
4491 */
4492 public Intent setClassName(String packageName, String className) {
4493 mComponent = new ComponentName(packageName, className);
4494 return this;
4495 }
4496
4497 /**
4498 * Convenience for calling {@link #setComponent(ComponentName)} with the
4499 * name returned by a {@link Class} object.
4500 *
4501 * @param packageContext A Context of the application package implementing
4502 * this class.
4503 * @param cls The class name to set, equivalent to
4504 * <code>setClassName(context, cls.getName())</code>.
4505 *
4506 * @return Returns the same Intent object, for chaining multiple calls
4507 * into a single statement.
4508 *
4509 * @see #setComponent
4510 */
4511 public Intent setClass(Context packageContext, Class<?> cls) {
4512 mComponent = new ComponentName(packageContext, cls);
4513 return this;
4514 }
4515
4516 /**
4517 * Use with {@link #fillIn} to allow the current action value to be
4518 * overwritten, even if it is already set.
4519 */
4520 public static final int FILL_IN_ACTION = 1<<0;
4521
4522 /**
4523 * Use with {@link #fillIn} to allow the current data or type value
4524 * overwritten, even if it is already set.
4525 */
4526 public static final int FILL_IN_DATA = 1<<1;
4527
4528 /**
4529 * Use with {@link #fillIn} to allow the current categories to be
4530 * overwritten, even if they are already set.
4531 */
4532 public static final int FILL_IN_CATEGORIES = 1<<2;
4533
4534 /**
4535 * Use with {@link #fillIn} to allow the current component value to be
4536 * overwritten, even if it is already set.
4537 */
4538 public static final int FILL_IN_COMPONENT = 1<<3;
4539
4540 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004541 * Use with {@link #fillIn} to allow the current package value to be
4542 * overwritten, even if it is already set.
4543 */
4544 public static final int FILL_IN_PACKAGE = 1<<4;
4545
4546 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004547 * Copy the contents of <var>other</var> in to this object, but only
4548 * where fields are not defined by this object. For purposes of a field
4549 * being defined, the following pieces of data in the Intent are
4550 * considered to be separate fields:
4551 *
4552 * <ul>
4553 * <li> action, as set by {@link #setAction}.
4554 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4555 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4556 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004557 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004558 * <li> component, as set by {@link #setComponent(ComponentName)} or
4559 * related methods.
4560 * <li> each top-level name in the associated extras.
4561 * </ul>
4562 *
4563 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004564 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4565 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004566 * corresponding field will not be replaced if it is already set.
4567 *
Brett Chabot3e391752009-07-21 16:07:23 -07004568 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
4569 * specified.
4570 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004571 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4572 * and Intent B with {action="gotit", data-type="some/thing",
4573 * categories="one","two"}.
4574 *
4575 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4576 * containing: {action="gotit", data-type="some/thing",
4577 * categories="bar"}.
4578 *
4579 * @param other Another Intent whose values are to be used to fill in
4580 * the current one.
4581 * @param flags Options to control which fields can be filled in.
4582 *
4583 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004584 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4585 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004586 */
4587 public int fillIn(Intent other, int flags) {
4588 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004589 if (other.mAction != null
4590 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004591 mAction = other.mAction;
4592 changes |= FILL_IN_ACTION;
4593 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004594 if ((other.mData != null || other.mType != null)
4595 && ((mData == null && mType == null)
4596 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004597 mData = other.mData;
4598 mType = other.mType;
4599 changes |= FILL_IN_DATA;
4600 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004601 if (other.mCategories != null
4602 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004603 if (other.mCategories != null) {
4604 mCategories = new HashSet<String>(other.mCategories);
4605 }
4606 changes |= FILL_IN_CATEGORIES;
4607 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004608 if (other.mPackage != null
4609 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
4610 mPackage = other.mPackage;
4611 changes |= FILL_IN_PACKAGE;
4612 }
4613 // Component is special: it can -only- be set if explicitly allowed,
4614 // since otherwise the sender could force the intent somewhere the
4615 // originator didn't intend.
4616 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004617 mComponent = other.mComponent;
4618 changes |= FILL_IN_COMPONENT;
4619 }
4620 mFlags |= other.mFlags;
4621 if (mExtras == null) {
4622 if (other.mExtras != null) {
4623 mExtras = new Bundle(other.mExtras);
4624 }
4625 } else if (other.mExtras != null) {
4626 try {
4627 Bundle newb = new Bundle(other.mExtras);
4628 newb.putAll(mExtras);
4629 mExtras = newb;
4630 } catch (RuntimeException e) {
4631 // Modifying the extras can cause us to unparcel the contents
4632 // of the bundle, and if we do this in the system process that
4633 // may fail. We really should handle this (i.e., the Bundle
4634 // impl shouldn't be on top of a plain map), but for now just
4635 // ignore it and keep the original contents. :(
4636 Log.w("Intent", "Failure filling in extras", e);
4637 }
4638 }
4639 return changes;
4640 }
4641
4642 /**
4643 * Wrapper class holding an Intent and implementing comparisons on it for
4644 * the purpose of filtering. The class implements its
4645 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
4646 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
4647 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
4648 * on the wrapped Intent.
4649 */
4650 public static final class FilterComparison {
4651 private final Intent mIntent;
4652 private final int mHashCode;
4653
4654 public FilterComparison(Intent intent) {
4655 mIntent = intent;
4656 mHashCode = intent.filterHashCode();
4657 }
4658
4659 /**
4660 * Return the Intent that this FilterComparison represents.
4661 * @return Returns the Intent held by the FilterComparison. Do
4662 * not modify!
4663 */
4664 public Intent getIntent() {
4665 return mIntent;
4666 }
4667
4668 @Override
4669 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004670 if (obj instanceof FilterComparison) {
4671 Intent other = ((FilterComparison)obj).mIntent;
4672 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004673 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004674 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004675 }
4676
4677 @Override
4678 public int hashCode() {
4679 return mHashCode;
4680 }
4681 }
4682
4683 /**
4684 * Determine if two intents are the same for the purposes of intent
4685 * resolution (filtering). That is, if their action, data, type,
4686 * class, and categories are the same. This does <em>not</em> compare
4687 * any extra data included in the intents.
4688 *
4689 * @param other The other Intent to compare against.
4690 *
4691 * @return Returns true if action, data, type, class, and categories
4692 * are the same.
4693 */
4694 public boolean filterEquals(Intent other) {
4695 if (other == null) {
4696 return false;
4697 }
4698 if (mAction != other.mAction) {
4699 if (mAction != null) {
4700 if (!mAction.equals(other.mAction)) {
4701 return false;
4702 }
4703 } else {
4704 if (!other.mAction.equals(mAction)) {
4705 return false;
4706 }
4707 }
4708 }
4709 if (mData != other.mData) {
4710 if (mData != null) {
4711 if (!mData.equals(other.mData)) {
4712 return false;
4713 }
4714 } else {
4715 if (!other.mData.equals(mData)) {
4716 return false;
4717 }
4718 }
4719 }
4720 if (mType != other.mType) {
4721 if (mType != null) {
4722 if (!mType.equals(other.mType)) {
4723 return false;
4724 }
4725 } else {
4726 if (!other.mType.equals(mType)) {
4727 return false;
4728 }
4729 }
4730 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004731 if (mPackage != other.mPackage) {
4732 if (mPackage != null) {
4733 if (!mPackage.equals(other.mPackage)) {
4734 return false;
4735 }
4736 } else {
4737 if (!other.mPackage.equals(mPackage)) {
4738 return false;
4739 }
4740 }
4741 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004742 if (mComponent != other.mComponent) {
4743 if (mComponent != null) {
4744 if (!mComponent.equals(other.mComponent)) {
4745 return false;
4746 }
4747 } else {
4748 if (!other.mComponent.equals(mComponent)) {
4749 return false;
4750 }
4751 }
4752 }
4753 if (mCategories != other.mCategories) {
4754 if (mCategories != null) {
4755 if (!mCategories.equals(other.mCategories)) {
4756 return false;
4757 }
4758 } else {
4759 if (!other.mCategories.equals(mCategories)) {
4760 return false;
4761 }
4762 }
4763 }
4764
4765 return true;
4766 }
4767
4768 /**
4769 * Generate hash code that matches semantics of filterEquals().
4770 *
4771 * @return Returns the hash value of the action, data, type, class, and
4772 * categories.
4773 *
4774 * @see #filterEquals
4775 */
4776 public int filterHashCode() {
4777 int code = 0;
4778 if (mAction != null) {
4779 code += mAction.hashCode();
4780 }
4781 if (mData != null) {
4782 code += mData.hashCode();
4783 }
4784 if (mType != null) {
4785 code += mType.hashCode();
4786 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004787 if (mPackage != null) {
4788 code += mPackage.hashCode();
4789 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004790 if (mComponent != null) {
4791 code += mComponent.hashCode();
4792 }
4793 if (mCategories != null) {
4794 code += mCategories.hashCode();
4795 }
4796 return code;
4797 }
4798
4799 @Override
4800 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004801 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004802
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004803 b.append("Intent { ");
4804 toShortString(b, true, true);
4805 b.append(" }");
4806
4807 return b.toString();
4808 }
4809
4810 /** @hide */
4811 public String toShortString(boolean comp, boolean extras) {
4812 StringBuilder b = new StringBuilder(128);
4813 toShortString(b, comp, extras);
4814 return b.toString();
4815 }
Romain Guy4969af72009-06-17 10:53:19 -07004816
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004817 /** @hide */
4818 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
4819 boolean first = true;
4820 if (mAction != null) {
4821 b.append("act=").append(mAction);
4822 first = false;
4823 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004824 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004825 if (!first) {
4826 b.append(' ');
4827 }
4828 first = false;
4829 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004830 Iterator<String> i = mCategories.iterator();
4831 boolean didone = false;
4832 while (i.hasNext()) {
4833 if (didone) b.append(",");
4834 didone = true;
4835 b.append(i.next());
4836 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004837 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004838 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004839 if (mData != null) {
4840 if (!first) {
4841 b.append(' ');
4842 }
4843 first = false;
4844 b.append("dat=").append(mData);
4845 }
4846 if (mType != null) {
4847 if (!first) {
4848 b.append(' ');
4849 }
4850 first = false;
4851 b.append("typ=").append(mType);
4852 }
4853 if (mFlags != 0) {
4854 if (!first) {
4855 b.append(' ');
4856 }
4857 first = false;
4858 b.append("flg=0x").append(Integer.toHexString(mFlags));
4859 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004860 if (mPackage != null) {
4861 if (!first) {
4862 b.append(' ');
4863 }
4864 first = false;
4865 b.append("pkg=").append(mPackage);
4866 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004867 if (comp && mComponent != null) {
4868 if (!first) {
4869 b.append(' ');
4870 }
4871 first = false;
4872 b.append("cmp=").append(mComponent.flattenToShortString());
4873 }
4874 if (extras && mExtras != null) {
4875 if (!first) {
4876 b.append(' ');
4877 }
4878 first = false;
4879 b.append("(has extras)");
4880 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004881 }
4882
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004883 /**
4884 * Call {@link #toUri} with 0 flags.
4885 * @deprecated Use {@link #toUri} instead.
4886 */
4887 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004888 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004889 return toUri(0);
4890 }
4891
4892 /**
4893 * Convert this Intent into a String holding a URI representation of it.
4894 * The returned URI string has been properly URI encoded, so it can be
4895 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
4896 * Intent's data as the base URI, with an additional fragment describing
4897 * the action, categories, type, flags, package, component, and extras.
4898 *
4899 * <p>You can convert the returned string back to an Intent with
4900 * {@link #getIntent}.
4901 *
4902 * @param flags Additional operating flags. Either 0 or
4903 * {@link #URI_INTENT_SCHEME}.
4904 *
4905 * @return Returns a URI encoding URI string describing the entire contents
4906 * of the Intent.
4907 */
4908 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07004909 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004910 String scheme = null;
4911 if (mData != null) {
4912 String data = mData.toString();
4913 if ((flags&URI_INTENT_SCHEME) != 0) {
4914 final int N = data.length();
4915 for (int i=0; i<N; i++) {
4916 char c = data.charAt(i);
4917 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
4918 || c == '.' || c == '-') {
4919 continue;
4920 }
4921 if (c == ':' && i > 0) {
4922 // Valid scheme.
4923 scheme = data.substring(0, i);
4924 uri.append("intent:");
4925 data = data.substring(i+1);
4926 break;
4927 }
4928
4929 // No scheme.
4930 break;
4931 }
4932 }
4933 uri.append(data);
4934
4935 } else if ((flags&URI_INTENT_SCHEME) != 0) {
4936 uri.append("intent:");
4937 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004938
4939 uri.append("#Intent;");
4940
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004941 if (scheme != null) {
4942 uri.append("scheme=").append(scheme).append(';');
4943 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004944 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004945 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004946 }
4947 if (mCategories != null) {
4948 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004949 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004950 }
4951 }
4952 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004953 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004954 }
4955 if (mFlags != 0) {
4956 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
4957 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004958 if (mPackage != null) {
4959 uri.append("package=").append(Uri.encode(mPackage)).append(';');
4960 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004961 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004962 uri.append("component=").append(Uri.encode(
4963 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004964 }
4965 if (mExtras != null) {
4966 for (String key : mExtras.keySet()) {
4967 final Object value = mExtras.get(key);
4968 char entryType =
4969 value instanceof String ? 'S' :
4970 value instanceof Boolean ? 'B' :
4971 value instanceof Byte ? 'b' :
4972 value instanceof Character ? 'c' :
4973 value instanceof Double ? 'd' :
4974 value instanceof Float ? 'f' :
4975 value instanceof Integer ? 'i' :
4976 value instanceof Long ? 'l' :
4977 value instanceof Short ? 's' :
4978 '\0';
4979
4980 if (entryType != '\0') {
4981 uri.append(entryType);
4982 uri.append('.');
4983 uri.append(Uri.encode(key));
4984 uri.append('=');
4985 uri.append(Uri.encode(value.toString()));
4986 uri.append(';');
4987 }
4988 }
4989 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004990
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004991 uri.append("end");
4992
4993 return uri.toString();
4994 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004995
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004996 public int describeContents() {
4997 return (mExtras != null) ? mExtras.describeContents() : 0;
4998 }
4999
5000 public void writeToParcel(Parcel out, int flags) {
5001 out.writeString(mAction);
5002 Uri.writeToParcel(out, mData);
5003 out.writeString(mType);
5004 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005005 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005006 ComponentName.writeToParcel(mComponent, out);
5007
5008 if (mCategories != null) {
5009 out.writeInt(mCategories.size());
5010 for (String category : mCategories) {
5011 out.writeString(category);
5012 }
5013 } else {
5014 out.writeInt(0);
5015 }
5016
5017 out.writeBundle(mExtras);
5018 }
5019
5020 public static final Parcelable.Creator<Intent> CREATOR
5021 = new Parcelable.Creator<Intent>() {
5022 public Intent createFromParcel(Parcel in) {
5023 return new Intent(in);
5024 }
5025 public Intent[] newArray(int size) {
5026 return new Intent[size];
5027 }
5028 };
5029
5030 private Intent(Parcel in) {
5031 readFromParcel(in);
5032 }
5033
5034 public void readFromParcel(Parcel in) {
5035 mAction = in.readString();
5036 mData = Uri.CREATOR.createFromParcel(in);
5037 mType = in.readString();
5038 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005039 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005040 mComponent = ComponentName.readFromParcel(in);
5041
5042 int N = in.readInt();
5043 if (N > 0) {
5044 mCategories = new HashSet<String>();
5045 int i;
5046 for (i=0; i<N; i++) {
5047 mCategories.add(in.readString());
5048 }
5049 } else {
5050 mCategories = null;
5051 }
5052
5053 mExtras = in.readBundle();
5054 }
5055
5056 /**
5057 * Parses the "intent" element (and its children) from XML and instantiates
5058 * an Intent object. The given XML parser should be located at the tag
5059 * where parsing should start (often named "intent"), from which the
5060 * basic action, data, type, and package and class name will be
5061 * retrieved. The function will then parse in to any child elements,
5062 * looking for <category android:name="xxx"> tags to add categories and
5063 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5064 * to the intent.
5065 *
5066 * @param resources The Resources to use when inflating resources.
5067 * @param parser The XML parser pointing at an "intent" tag.
5068 * @param attrs The AttributeSet interface for retrieving extended
5069 * attribute data at the current <var>parser</var> location.
5070 * @return An Intent object matching the XML data.
5071 * @throws XmlPullParserException If there was an XML parsing error.
5072 * @throws IOException If there was an I/O error.
5073 */
5074 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5075 throws XmlPullParserException, IOException {
5076 Intent intent = new Intent();
5077
5078 TypedArray sa = resources.obtainAttributes(attrs,
5079 com.android.internal.R.styleable.Intent);
5080
5081 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5082
5083 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5084 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5085 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5086
5087 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5088 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5089 if (packageName != null && className != null) {
5090 intent.setComponent(new ComponentName(packageName, className));
5091 }
5092
5093 sa.recycle();
5094
5095 int outerDepth = parser.getDepth();
5096 int type;
5097 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5098 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5099 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5100 continue;
5101 }
5102
5103 String nodeName = parser.getName();
5104 if (nodeName.equals("category")) {
5105 sa = resources.obtainAttributes(attrs,
5106 com.android.internal.R.styleable.IntentCategory);
5107 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5108 sa.recycle();
5109
5110 if (cat != null) {
5111 intent.addCategory(cat);
5112 }
5113 XmlUtils.skipCurrentTag(parser);
5114
5115 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005116 if (intent.mExtras == null) {
5117 intent.mExtras = new Bundle();
5118 }
5119 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5120 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005121
5122 } else {
5123 XmlUtils.skipCurrentTag(parser);
5124 }
5125 }
5126
5127 return intent;
5128 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005129}