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