blob: 90e8c14ae90b930223179fa56576b05fb5ef5fcf [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
46import java.util.Set;
47
48/**
49 * An intent is an abstract description of an operation to be performed. It
50 * can be used with {@link Context#startActivity(Intent) startActivity} to
51 * launch an {@link android.app.Activity},
52 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
53 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
54 * and {@link android.content.Context#startService} or
55 * {@link android.content.Context#bindService} to communicate with a
56 * background {@link android.app.Service}.
57 *
58 * <p>An Intent provides a facility for performing late runtime binding between
59 * the code in different applications. Its most significant use is in the
60 * launching of activities, where it can be thought of as the glue between
61 * activities. It is
62 * basically a passive data structure holding an abstract description of an
63 * action to be performed. The primary pieces of information in an intent
64 * are:</p>
65 *
66 * <ul>
67 * <li> <p><b>action</b> -- The general action to be performed, such as
68 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
69 * etc.</p>
70 * </li>
71 * <li> <p><b>data</b> -- The data to operate on, such as a person record
72 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
73 * </li>
74 * </ul>
75 *
76 *
77 * <p>Some examples of action/data pairs are:</p>
78 *
79 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070080 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070081 * information about the person whose identifier is "1".</p>
82 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070083 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070084 * the phone dialer with the person filled in.</p>
85 * </li>
86 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
87 * the phone dialer with the given number filled in. Note how the
88 * VIEW action does what what is considered the most reasonable thing for
89 * a particular URI.</p>
90 * </li>
91 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
92 * the phone dialer with the given number filled in.</p>
93 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070094 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070095 * information about the person whose identifier is "1".</p>
96 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070097 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070098 * a list of people, which the user can browse through. This example is a
99 * typical top-level entry into the Contacts application, showing you the
100 * list of people. Selecting a particular person to view would result in a
101 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
102 * being used to start an activity to display that person.</p>
103 * </li>
104 * </ul>
105 *
106 * <p>In addition to these primary attributes, there are a number of secondary
107 * attributes that you can also include with an intent:</p>
108 *
109 * <ul>
110 * <li> <p><b>category</b> -- Gives additional information about the action
111 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
112 * appear in the Launcher as a top-level application, while
113 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
114 * of alternative actions the user can perform on a piece of data.</p>
115 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
116 * intent data. Normally the type is inferred from the data itself.
117 * By setting this attribute, you disable that evaluation and force
118 * an explicit type.</p>
119 * <li> <p><b>component</b> -- Specifies an explicit name of a component
120 * class to use for the intent. Normally this is determined by looking
121 * at the other information in the intent (the action, data/type, and
122 * categories) and matching that with a component that can handle it.
123 * If this attribute is set then none of the evaluation is performed,
124 * and this component is used exactly as is. By specifying this attribute,
125 * all of the other Intent attributes become optional.</p>
126 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
127 * This can be used to provide extended information to the component.
128 * For example, if we have a action to send an e-mail message, we could
129 * also include extra pieces of data here to supply a subject, body,
130 * etc.</p>
131 * </ul>
132 *
133 * <p>Here are some examples of other operations you can specify as intents
134 * using these additional parameters:</p>
135 *
136 * <ul>
137 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
138 * Launch the home screen.</p>
139 * </li>
140 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
141 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
142 * vnd.android.cursor.item/phone}</i></b>
143 * -- Display the list of people's phone numbers, allowing the user to
144 * browse through them and pick one and return it to the parent activity.</p>
145 * </li>
146 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
147 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
148 * -- Display all pickers for data that can be opened with
149 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
150 * allowing the user to pick one of them and then some data inside of it
151 * and returning the resulting URI to the caller. This can be used,
152 * for example, in an e-mail application to allow the user to pick some
153 * data to include as an attachment.</p>
154 * </li>
155 * </ul>
156 *
157 * <p>There are a variety of standard Intent action and category constants
158 * defined in the Intent class, but applications can also define their own.
159 * These strings use java style scoping, to ensure they are unique -- for
160 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700161 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700162 *
163 * <p>Put together, the set of actions, data types, categories, and extra data
164 * defines a language for the system allowing for the expression of phrases
165 * such as "call john smith's cell". As applications are added to the system,
166 * they can extend this language by adding new actions, types, and categories, or
167 * they can modify the behavior of existing phrases by supplying their own
168 * activities that handle them.</p>
169 *
170 * <a name="IntentResolution"></a>
171 * <h3>Intent Resolution</h3>
172 *
173 * <p>There are two primary forms of intents you will use.
174 *
175 * <ul>
176 * <li> <p><b>Explicit Intents</b> have specified a component (via
177 * {@link #setComponent} or {@link #setClass}), which provides the exact
178 * class to be run. Often these will not include any other information,
179 * simply being a way for an application to launch various internal
180 * activities it has as the user interacts with the application.
181 *
182 * <li> <p><b>Implicit Intents</b> have not specified a component;
183 * instead, they must include enough information for the system to
184 * determine which of the available components is best to run for that
185 * intent.
186 * </ul>
187 *
188 * <p>When using implicit intents, given such an arbitrary intent we need to
189 * know what to do with it. This is handled by the process of <em>Intent
190 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
191 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
192 * more activities/receivers) that can handle it.</p>
193 *
194 * <p>The intent resolution mechanism basically revolves around matching an
195 * Intent against all of the &lt;intent-filter&gt; descriptions in the
196 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
197 * objects explicitly registered with {@link Context#registerReceiver}.) More
198 * details on this can be found in the documentation on the {@link
199 * IntentFilter} class.</p>
200 *
201 * <p>There are three pieces of information in the Intent that are used for
202 * resolution: the action, type, and category. Using this information, a query
203 * is done on the {@link PackageManager} for a component that can handle the
204 * intent. The appropriate component is determined based on the intent
205 * information supplied in the <code>AndroidManifest.xml</code> file as
206 * follows:</p>
207 *
208 * <ul>
209 * <li> <p>The <b>action</b>, if given, must be listed by the component as
210 * one it handles.</p>
211 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
212 * already supplied in the Intent. Like the action, if a type is
213 * included in the intent (either explicitly or implicitly in its
214 * data), then this must be listed by the component as one it handles.</p>
215 * <li> For data that is not a <code>content:</code> URI and where no explicit
216 * type is included in the Intent, instead the <b>scheme</b> of the
217 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
218 * considered. Again like the action, if we are matching a scheme it
219 * must be listed by the component as one it can handle.
220 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
221 * by the activity as categories it handles. That is, if you include
222 * the categories {@link #CATEGORY_LAUNCHER} and
223 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
224 * with an intent that lists <em>both</em> of those categories.
225 * Activities will very often need to support the
226 * {@link #CATEGORY_DEFAULT} so that they can be found by
227 * {@link Context#startActivity Context.startActivity()}.</p>
228 * </ul>
229 *
230 * <p>For example, consider the Note Pad sample application that
231 * allows user to browse through a list of notes data and view details about
232 * individual items. Text in italics indicate places were you would replace a
233 * name with one specific to your own package.</p>
234 *
235 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
236 * package="<i>com.android.notepad</i>"&gt;
237 * &lt;application android:icon="@drawable/app_notes"
238 * android:label="@string/app_name"&gt;
239 *
240 * &lt;provider class=".NotePadProvider"
241 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
242 *
243 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
244 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700245 * &lt;action android:name="android.intent.action.MAIN" /&gt;
246 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700247 * &lt;/intent-filter&gt;
248 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700249 * &lt;action android:name="android.intent.action.VIEW" /&gt;
250 * &lt;action android:name="android.intent.action.EDIT" /&gt;
251 * &lt;action android:name="android.intent.action.PICK" /&gt;
252 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
253 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700254 * &lt;/intent-filter&gt;
255 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700256 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
257 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
258 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700259 * &lt;/intent-filter&gt;
260 * &lt;/activity&gt;
261 *
262 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
263 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700264 * &lt;action android:name="android.intent.action.VIEW" /&gt;
265 * &lt;action android:name="android.intent.action.EDIT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 *
270 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700271 * &lt;action android:name="android.intent.action.INSERT" /&gt;
272 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
273 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700274 * &lt;/intent-filter&gt;
275 *
276 * &lt;/activity&gt;
277 *
278 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
279 * android:theme="@android:style/Theme.Dialog"&gt;
280 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
284 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
285 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 * &lt;/activity&gt;
288 *
289 * &lt;/application&gt;
290 * &lt;/manifest&gt;</pre>
291 *
292 * <p>The first activity,
293 * <code>com.android.notepad.NotesList</code>, serves as our main
294 * entry into the app. It can do three things as described by its three intent
295 * templates:
296 * <ol>
297 * <li><pre>
298 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700299 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
300 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700301 * &lt;/intent-filter&gt;</pre>
302 * <p>This provides a top-level entry into the NotePad application: the standard
303 * MAIN action is a main entry point (not requiring any other information in
304 * the Intent), and the LAUNCHER category says that this entry point should be
305 * listed in the application launcher.</p>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
309 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
310 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
311 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
312 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700313 * &lt;/intent-filter&gt;</pre>
314 * <p>This declares the things that the activity can do on a directory of
315 * notes. The type being supported is given with the &lt;type&gt; tag, where
316 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
317 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
318 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
319 * The activity allows the user to view or edit the directory of data (via
320 * the VIEW and EDIT actions), or to pick a particular note and return it
321 * to the caller (via the PICK action). Note also the DEFAULT category
322 * supplied here: this is <em>required</em> for the
323 * {@link Context#startActivity Context.startActivity} method to resolve your
324 * activity when its component name is not explicitly specified.</p>
325 * <li><pre>
326 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700327 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
328 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
329 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700330 * &lt;/intent-filter&gt;</pre>
331 * <p>This filter describes the ability return to the caller a note selected by
332 * the user without needing to know where it came from. The data type
333 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
334 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
335 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
336 * The GET_CONTENT action is similar to the PICK action, where the activity
337 * will return to its caller a piece of data selected by the user. Here,
338 * however, the caller specifies the type of data they desire instead of
339 * the type of data the user will be picking from.</p>
340 * </ol>
341 *
342 * <p>Given these capabilities, the following intents will resolve to the
343 * NotesList activity:</p>
344 *
345 * <ul>
346 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
347 * activities that can be used as top-level entry points into an
348 * application.</p>
349 * <li> <p><b>{ action=android.app.action.MAIN,
350 * category=android.app.category.LAUNCHER }</b> is the actual intent
351 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700352 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700353 * data=content://com.google.provider.NotePad/notes }</b>
354 * displays a list of all the notes under
355 * "content://com.google.provider.NotePad/notes", which
356 * the user can browse through and see the details on.</p>
357 * <li> <p><b>{ action=android.app.action.PICK
358 * data=content://com.google.provider.NotePad/notes }</b>
359 * provides a list of the notes under
360 * "content://com.google.provider.NotePad/notes", from which
361 * the user can pick a note whose data URL is returned back to the caller.</p>
362 * <li> <p><b>{ action=android.app.action.GET_CONTENT
363 * type=vnd.android.cursor.item/vnd.google.note }</b>
364 * is similar to the pick action, but allows the caller to specify the
365 * kind of data they want back so that the system can find the appropriate
366 * activity to pick something of that data type.</p>
367 * </ul>
368 *
369 * <p>The second activity,
370 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
371 * note entry and allows them to edit it. It can do two things as described
372 * by its two intent templates:
373 * <ol>
374 * <li><pre>
375 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700376 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
377 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
378 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
379 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700380 * &lt;/intent-filter&gt;</pre>
381 * <p>The first, primary, purpose of this activity is to let the user interact
382 * with a single note, as decribed by the MIME type
383 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
384 * either VIEW a note or allow the user to EDIT it. Again we support the
385 * DEFAULT category to allow the activity to be launched without explicitly
386 * specifying its component.</p>
387 * <li><pre>
388 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700389 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
390 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
391 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700392 * &lt;/intent-filter&gt;</pre>
393 * <p>The secondary use of this activity is to insert a new note entry into
394 * an existing directory of notes. This is used when the user creates a new
395 * note: the INSERT action is executed on the directory of notes, causing
396 * this activity to run and have the user create the new note data which
397 * it then adds to the content provider.</p>
398 * </ol>
399 *
400 * <p>Given these capabilities, the following intents will resolve to the
401 * NoteEditor activity:</p>
402 *
403 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700404 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700405 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
406 * shows the user the content of note <var>{ID}</var>.</p>
407 * <li> <p><b>{ action=android.app.action.EDIT
408 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
409 * allows the user to edit the content of note <var>{ID}</var>.</p>
410 * <li> <p><b>{ action=android.app.action.INSERT
411 * data=content://com.google.provider.NotePad/notes }</b>
412 * creates a new, empty note in the notes list at
413 * "content://com.google.provider.NotePad/notes"
414 * and allows the user to edit it. If they keep their changes, the URI
415 * of the newly created note is returned to the caller.</p>
416 * </ul>
417 *
418 * <p>The last activity,
419 * <code>com.android.notepad.TitleEditor</code>, allows the user to
420 * edit the title of a note. This could be implemented as a class that the
421 * application directly invokes (by explicitly setting its component in
422 * the Intent), but here we show a way you can publish alternative
423 * operations on existing data:</p>
424 *
425 * <pre>
426 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700427 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
428 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
429 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
430 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
431 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700432 * &lt;/intent-filter&gt;</pre>
433 *
434 * <p>In the single intent template here, we
435 * have created our own private action called
436 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
437 * edit the title of a note. It must be invoked on a specific note
438 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
439 * view and edit actions, but here displays and edits the title contained
440 * in the note data.
441 *
442 * <p>In addition to supporting the default category as usual, our title editor
443 * also supports two other standard categories: ALTERNATIVE and
444 * SELECTED_ALTERNATIVE. Implementing
445 * these categories allows others to find the special action it provides
446 * without directly knowing about it, through the
447 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
448 * more often to build dynamic menu items with
449 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
450 * template here was also supply an explicit name for the template
451 * (via <code>android:label="@string/resolve_title"</code>) to better control
452 * what the user sees when presented with this activity as an alternative
453 * action to the data they are viewing.
454 *
455 * <p>Given these capabilities, the following intent will resolve to the
456 * TitleEditor activity:</p>
457 *
458 * <ul>
459 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
460 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
461 * displays and allows the user to edit the title associated
462 * with note <var>{ID}</var>.</p>
463 * </ul>
464 *
465 * <h3>Standard Activity Actions</h3>
466 *
467 * <p>These are the current standard actions that Intent defines for launching
468 * activities (usually through {@link Context#startActivity}. The most
469 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
470 * {@link #ACTION_EDIT}.
471 *
472 * <ul>
473 * <li> {@link #ACTION_MAIN}
474 * <li> {@link #ACTION_VIEW}
475 * <li> {@link #ACTION_ATTACH_DATA}
476 * <li> {@link #ACTION_EDIT}
477 * <li> {@link #ACTION_PICK}
478 * <li> {@link #ACTION_CHOOSER}
479 * <li> {@link #ACTION_GET_CONTENT}
480 * <li> {@link #ACTION_DIAL}
481 * <li> {@link #ACTION_CALL}
482 * <li> {@link #ACTION_SEND}
483 * <li> {@link #ACTION_SENDTO}
484 * <li> {@link #ACTION_ANSWER}
485 * <li> {@link #ACTION_INSERT}
486 * <li> {@link #ACTION_DELETE}
487 * <li> {@link #ACTION_RUN}
488 * <li> {@link #ACTION_SYNC}
489 * <li> {@link #ACTION_PICK_ACTIVITY}
490 * <li> {@link #ACTION_SEARCH}
491 * <li> {@link #ACTION_WEB_SEARCH}
492 * <li> {@link #ACTION_FACTORY_TEST}
493 * </ul>
494 *
495 * <h3>Standard Broadcast Actions</h3>
496 *
497 * <p>These are the current standard actions that Intent defines for receiving
498 * broadcasts (usually through {@link Context#registerReceiver} or a
499 * &lt;receiver&gt; tag in a manifest).
500 *
501 * <ul>
502 * <li> {@link #ACTION_TIME_TICK}
503 * <li> {@link #ACTION_TIME_CHANGED}
504 * <li> {@link #ACTION_TIMEZONE_CHANGED}
505 * <li> {@link #ACTION_BOOT_COMPLETED}
506 * <li> {@link #ACTION_PACKAGE_ADDED}
507 * <li> {@link #ACTION_PACKAGE_CHANGED}
508 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800509 * <li> {@link #ACTION_PACKAGE_RESTARTED}
510 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700511 * <li> {@link #ACTION_UID_REMOVED}
512 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700513 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700514 * <li> {@link #ACTION_POWER_DISCONNECTED}
515 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700516 * </ul>
517 *
518 * <h3>Standard Categories</h3>
519 *
520 * <p>These are the current standard categories that can be used to further
521 * clarify an Intent via {@link #addCategory}.
522 *
523 * <ul>
524 * <li> {@link #CATEGORY_DEFAULT}
525 * <li> {@link #CATEGORY_BROWSABLE}
526 * <li> {@link #CATEGORY_TAB}
527 * <li> {@link #CATEGORY_ALTERNATIVE}
528 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
529 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800530 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700531 * <li> {@link #CATEGORY_HOME}
532 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700533 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400534 * <li> {@link #CATEGORY_CAR_DOCK}
535 * <li> {@link #CATEGORY_DESK_DOCK}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700536 * </ul>
537 *
538 * <h3>Standard Extra Data</h3>
539 *
540 * <p>These are the current standard fields that can be used as extra data via
541 * {@link #putExtra}.
542 *
543 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800544 * <li> {@link #EXTRA_ALARM_COUNT}
545 * <li> {@link #EXTRA_BCC}
546 * <li> {@link #EXTRA_CC}
547 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
548 * <li> {@link #EXTRA_DATA_REMOVED}
549 * <li> {@link #EXTRA_DOCK_STATE}
550 * <li> {@link #EXTRA_DOCK_STATE_CAR}
551 * <li> {@link #EXTRA_DOCK_STATE_DESK}
552 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
553 * <li> {@link #EXTRA_DONT_KILL_APP}
554 * <li> {@link #EXTRA_EMAIL}
555 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700556 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_KEY_EVENT}
558 * <li> {@link #EXTRA_PHONE_NUMBER}
559 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
560 * <li> {@link #EXTRA_REPLACING}
561 * <li> {@link #EXTRA_SHORTCUT_ICON}
562 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
563 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700564 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_SHORTCUT_NAME}
566 * <li> {@link #EXTRA_SUBJECT}
567 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700568 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800569 * <li> {@link #EXTRA_TITLE}
570 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * </ul>
572 *
573 * <h3>Flags</h3>
574 *
575 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800576 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
577 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700578 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800579public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700580 // ---------------------------------------------------------------------
581 // ---------------------------------------------------------------------
582 // Standard intent activity actions (see action variable).
583
584 /**
585 * Activity Action: Start as a main entry point, does not expect to
586 * receive data.
587 * <p>Input: nothing
588 * <p>Output: nothing
589 */
590 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
591 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800592
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700593 /**
594 * Activity Action: Display the data to the user. This is the most common
595 * action performed on data -- it is the generic action you can use on
596 * a piece of data to get the most reasonable thing to occur. For example,
597 * when used on a contacts entry it will view the entry; when used on a
598 * mailto: URI it will bring up a compose window filled with the information
599 * supplied by the URI; when used with a tel: URI it will invoke the
600 * dialer.
601 * <p>Input: {@link #getData} is URI from which to retrieve data.
602 * <p>Output: nothing.
603 */
604 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
605 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800606
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700607 /**
608 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
609 * performed on a piece of data.
610 */
611 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800612
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 /**
614 * Used to indicate that some piece of data should be attached to some other
615 * place. For example, image data could be attached to a contact. It is up
616 * to the recipient to decide where the data should be attached; the intent
617 * does not specify the ultimate destination.
618 * <p>Input: {@link #getData} is URI of data to be attached.
619 * <p>Output: nothing.
620 */
621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
622 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 /**
625 * Activity Action: Provide explicit editable access to the given data.
626 * <p>Input: {@link #getData} is URI of data to be edited.
627 * <p>Output: nothing.
628 */
629 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
630 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800631
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700632 /**
633 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
634 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
635 * The extras can contain type specific data to pass through to the editing/creating
636 * activity.
637 * <p>Output: The URI of the item that was picked. This must be a content:
638 * URI so that any receiver can access it.
639 */
640 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
641 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800642
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700643 /**
644 * Activity Action: Pick an item from the data, returning what was selected.
645 * <p>Input: {@link #getData} is URI containing a directory of data
646 * (vnd.android.cursor.dir/*) from which to pick an item.
647 * <p>Output: The URI of the item that was picked.
648 */
649 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
650 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800651
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700652 /**
653 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800654 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700655 * <p>Output: An Intent representing the shortcut. The intent must contain three
656 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
657 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800658 * (value: ShortcutIconResource).</p>
659 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 * @see #EXTRA_SHORTCUT_INTENT
661 * @see #EXTRA_SHORTCUT_NAME
662 * @see #EXTRA_SHORTCUT_ICON
663 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
664 * @see android.content.Intent.ShortcutIconResource
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
668
669 /**
670 * The name of the extra used to define the Intent of a shortcut.
671 *
672 * @see #ACTION_CREATE_SHORTCUT
673 */
674 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
675 /**
676 * The name of the extra used to define the name of a shortcut.
677 *
678 * @see #ACTION_CREATE_SHORTCUT
679 */
680 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
681 /**
682 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
683 *
684 * @see #ACTION_CREATE_SHORTCUT
685 */
686 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
687 /**
688 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
689 *
690 * @see #ACTION_CREATE_SHORTCUT
691 * @see android.content.Intent.ShortcutIconResource
692 */
693 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
694 "android.intent.extra.shortcut.ICON_RESOURCE";
695
696 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800697 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700698 *
699 * @see Intent#ACTION_CREATE_SHORTCUT
700 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800701 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
702 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700703 */
704 public static class ShortcutIconResource implements Parcelable {
705 /**
706 * The package name of the application containing the icon.
707 */
708 public String packageName;
709
710 /**
711 * The resource name of the icon, including package, name and type.
712 */
713 public String resourceName;
714
715 /**
716 * Creates a new ShortcutIconResource for the specified context and resource
717 * identifier.
718 *
719 * @param context The context of the application.
720 * @param resourceId The resource idenfitier for the icon.
721 * @return A new ShortcutIconResource with the specified's context package name
722 * and icon resource idenfitier.
723 */
724 public static ShortcutIconResource fromContext(Context context, int resourceId) {
725 ShortcutIconResource icon = new ShortcutIconResource();
726 icon.packageName = context.getPackageName();
727 icon.resourceName = context.getResources().getResourceName(resourceId);
728 return icon;
729 }
730
731 /**
732 * Used to read a ShortcutIconResource from a Parcel.
733 */
734 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
735 new Parcelable.Creator<ShortcutIconResource>() {
736
737 public ShortcutIconResource createFromParcel(Parcel source) {
738 ShortcutIconResource icon = new ShortcutIconResource();
739 icon.packageName = source.readString();
740 icon.resourceName = source.readString();
741 return icon;
742 }
743
744 public ShortcutIconResource[] newArray(int size) {
745 return new ShortcutIconResource[size];
746 }
747 };
748
749 /**
750 * No special parcel contents.
751 */
752 public int describeContents() {
753 return 0;
754 }
755
756 public void writeToParcel(Parcel dest, int flags) {
757 dest.writeString(packageName);
758 dest.writeString(resourceName);
759 }
760
761 @Override
762 public String toString() {
763 return resourceName;
764 }
765 }
766
767 /**
768 * Activity Action: Display an activity chooser, allowing the user to pick
769 * what they want to before proceeding. This can be used as an alternative
770 * to the standard activity picker that is displayed by the system when
771 * you try to start an activity with multiple possible matches, with these
772 * differences in behavior:
773 * <ul>
774 * <li>You can specify the title that will appear in the activity chooser.
775 * <li>The user does not have the option to make one of the matching
776 * activities a preferred activity, and all possible activities will
777 * always be shown even if one of them is currently marked as the
778 * preferred activity.
779 * </ul>
780 * <p>
781 * This action should be used when the user will naturally expect to
782 * select an activity in order to proceed. An example if when not to use
783 * it is when the user clicks on a "mailto:" link. They would naturally
784 * expect to go directly to their mail app, so startActivity() should be
785 * called directly: it will
786 * either launch the current preferred app, or put up a dialog allowing the
787 * user to pick an app to use and optionally marking that as preferred.
788 * <p>
789 * In contrast, if the user is selecting a menu item to send a picture
790 * they are viewing to someone else, there are many different things they
791 * may want to do at this point: send it through e-mail, upload it to a
792 * web service, etc. In this case the CHOOSER action should be used, to
793 * always present to the user a list of the things they can do, with a
794 * nice title given by the caller such as "Send this photo with:".
795 * <p>
796 * As a convenience, an Intent of this form can be created with the
797 * {@link #createChooser} function.
798 * <p>Input: No data should be specified. get*Extra must have
799 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
800 * and can optionally have a {@link #EXTRA_TITLE} field containing the
801 * title text to display in the chooser.
802 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
803 */
804 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
805 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
806
807 /**
808 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
809 *
810 * @param target The Intent that the user will be selecting an activity
811 * to perform.
812 * @param title Optional title that will be displayed in the chooser.
813 * @return Return a new Intent object that you can hand to
814 * {@link Context#startActivity(Intent) Context.startActivity()} and
815 * related methods.
816 */
817 public static Intent createChooser(Intent target, CharSequence title) {
818 Intent intent = new Intent(ACTION_CHOOSER);
819 intent.putExtra(EXTRA_INTENT, target);
820 if (title != null) {
821 intent.putExtra(EXTRA_TITLE, title);
822 }
823 return intent;
824 }
825 /**
826 * Activity Action: Allow the user to select a particular kind of data and
827 * return it. This is different than {@link #ACTION_PICK} in that here we
828 * just say what kind of data is desired, not a URI of existing data from
829 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
830 * create the data as it runs (for example taking a picture or recording a
831 * sound), let them browser over the web and download the desired data,
832 * etc.
833 * <p>
834 * There are two main ways to use this action: if you want an specific kind
835 * of data, such as a person contact, you set the MIME type to the kind of
836 * data you want and launch it with {@link Context#startActivity(Intent)}.
837 * The system will then launch the best application to select that kind
838 * of data for you.
839 * <p>
840 * You may also be interested in any of a set of types of content the user
841 * can pick. For example, an e-mail application that wants to allow the
842 * user to add an attachment to an e-mail message can use this action to
843 * bring up a list of all of the types of content the user can attach.
844 * <p>
845 * In this case, you should wrap the GET_CONTENT intent with a chooser
846 * (through {@link #createChooser}), which will give the proper interface
847 * for the user to pick how to send your data and allow you to specify
848 * a prompt indicating what they are doing. You will usually specify a
849 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
850 * broad range of content types the user can select from.
851 * <p>
852 * When using such a broad GET_CONTENT action, it is often desireable to
853 * only pick from data that can be represented as a stream. This is
854 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
855 * <p>
856 * Input: {@link #getType} is the desired MIME type to retrieve. Note
857 * that no URI is supplied in the intent, as there are no constraints on
858 * where the returned data originally comes from. You may also include the
859 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
860 * opened as a stream.
861 * <p>
862 * Output: The URI of the item that was picked. This must be a content:
863 * URI so that any receiver can access it.
864 */
865 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
866 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
867 /**
868 * Activity Action: Dial a number as specified by the data. This shows a
869 * UI with the number being dialed, allowing the user to explicitly
870 * initiate the call.
871 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
872 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
873 * number.
874 * <p>Output: nothing.
875 */
876 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
877 public static final String ACTION_DIAL = "android.intent.action.DIAL";
878 /**
879 * Activity Action: Perform a call to someone specified by the data.
880 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
881 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
882 * number.
883 * <p>Output: nothing.
884 *
885 * <p>Note: there will be restrictions on which applications can initiate a
886 * call; most applications should use the {@link #ACTION_DIAL}.
887 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
888 * numbers. Applications can <strong>dial</strong> emergency numbers using
889 * {@link #ACTION_DIAL}, however.
890 */
891 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
892 public static final String ACTION_CALL = "android.intent.action.CALL";
893 /**
894 * Activity Action: Perform a call to an emergency number specified by the
895 * data.
896 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
897 * tel: URI of an explicit phone number.
898 * <p>Output: nothing.
899 * @hide
900 */
901 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
902 /**
903 * Activity action: Perform a call to any number (emergency or not)
904 * specified by the data.
905 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
906 * tel: URI of an explicit phone number.
907 * <p>Output: nothing.
908 * @hide
909 */
910 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
911 /**
912 * Activity Action: Send a message to someone specified by the data.
913 * <p>Input: {@link #getData} is URI describing the target.
914 * <p>Output: nothing.
915 */
916 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
917 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
918 /**
919 * Activity Action: Deliver some data to someone else. Who the data is
920 * being delivered to is not specified; it is up to the receiver of this
921 * action to ask the user where the data should be sent.
922 * <p>
923 * When launching a SEND intent, you should usually wrap it in a chooser
924 * (through {@link #createChooser}), which will give the proper interface
925 * for the user to pick how to send your data and allow you to specify
926 * a prompt indicating what they are doing.
927 * <p>
928 * Input: {@link #getType} is the MIME type of the data being sent.
929 * get*Extra can have either a {@link #EXTRA_TEXT}
930 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
931 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
932 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
933 * if the MIME type is unknown (this will only allow senders that can
934 * handle generic data streams).
935 * <p>
936 * Optional standard extras, which may be interpreted by some recipients as
937 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
938 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
939 * <p>
940 * Output: nothing.
941 */
942 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
943 public static final String ACTION_SEND = "android.intent.action.SEND";
944 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800945 * Activity Action: Deliver multiple data to someone else.
946 * <p>
947 * Like ACTION_SEND, except the data is multiple.
948 * <p>
949 * Input: {@link #getType} is the MIME type of the data being sent.
950 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
951 * #EXTRA_STREAM} field, containing the data to be sent.
952 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800953 * Multiple types are supported, and receivers should handle mixed types
954 * whenever possible. The right way for the receiver to check them is to
955 * use the content resolver on each URI. The intent sender should try to
956 * put the most concrete mime type in the intent type, but it can fall
957 * back to {@literal <type>/*} or {@literal *}/* as needed.
958 * <p>
959 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
960 * be image/jpg, but if you are sending image/jpg and image/png, then the
961 * intent's type should be image/*.
962 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800963 * Optional standard extras, which may be interpreted by some recipients as
964 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
965 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
966 * <p>
967 * Output: nothing.
968 */
969 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
970 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
971 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700972 * Activity Action: Handle an incoming phone call.
973 * <p>Input: nothing.
974 * <p>Output: nothing.
975 */
976 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
977 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
978 /**
979 * Activity Action: Insert an empty item into the given container.
980 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
981 * in which to place the data.
982 * <p>Output: URI of the new data that was created.
983 */
984 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
985 public static final String ACTION_INSERT = "android.intent.action.INSERT";
986 /**
987 * Activity Action: Delete the given data from its container.
988 * <p>Input: {@link #getData} is URI of data to be deleted.
989 * <p>Output: nothing.
990 */
991 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
992 public static final String ACTION_DELETE = "android.intent.action.DELETE";
993 /**
994 * Activity Action: Run the data, whatever that means.
995 * <p>Input: ? (Note: this is currently specific to the test harness.)
996 * <p>Output: nothing.
997 */
998 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
999 public static final String ACTION_RUN = "android.intent.action.RUN";
1000 /**
1001 * Activity Action: Perform a data synchronization.
1002 * <p>Input: ?
1003 * <p>Output: ?
1004 */
1005 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1006 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1007 /**
1008 * Activity Action: Pick an activity given an intent, returning the class
1009 * selected.
1010 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1011 * used with {@link PackageManager#queryIntentActivities} to determine the
1012 * set of activities from which to pick.
1013 * <p>Output: Class name of the activity that was selected.
1014 */
1015 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1016 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1017 /**
1018 * Activity Action: Perform a search.
1019 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1020 * is the text to search for. If empty, simply
1021 * enter your search results Activity with the search UI activated.
1022 * <p>Output: nothing.
1023 */
1024 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1025 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1026 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001027 * Activity Action: Start the platform-defined tutorial
1028 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1029 * is the text to search for. If empty, simply
1030 * enter your search results Activity with the search UI activated.
1031 * <p>Output: nothing.
1032 */
1033 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1034 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1035 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001036 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001037 * <p>
1038 * Input: {@link android.app.SearchManager#QUERY
1039 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1040 * a url starts with http or https, the site will be opened. If it is plain
1041 * text, Google search will be applied.
1042 * <p>
1043 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001044 */
1045 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1046 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1047 /**
1048 * Activity Action: List all available applications
1049 * <p>Input: Nothing.
1050 * <p>Output: nothing.
1051 */
1052 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1053 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1054 /**
1055 * Activity Action: Show settings for choosing wallpaper
1056 * <p>Input: Nothing.
1057 * <p>Output: Nothing.
1058 */
1059 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1060 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1061
1062 /**
1063 * Activity Action: Show activity for reporting a bug.
1064 * <p>Input: Nothing.
1065 * <p>Output: Nothing.
1066 */
1067 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1068 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1069
1070 /**
1071 * Activity Action: Main entry point for factory tests. Only used when
1072 * the device is booting in factory test node. The implementing package
1073 * must be installed in the system image.
1074 * <p>Input: nothing
1075 * <p>Output: nothing
1076 */
1077 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1078
1079 /**
1080 * Activity Action: The user pressed the "call" button to go to the dialer
1081 * or other appropriate UI for placing a call.
1082 * <p>Input: Nothing.
1083 * <p>Output: Nothing.
1084 */
1085 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1086 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1087
1088 /**
1089 * Activity Action: Start Voice Command.
1090 * <p>Input: Nothing.
1091 * <p>Output: Nothing.
1092 */
1093 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1094 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001095
1096 /**
1097 * Activity Action: Start action associated with long pressing on the
1098 * search key.
1099 * <p>Input: Nothing.
1100 * <p>Output: Nothing.
1101 */
1102 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1103 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001104
Jacek Surazski86b6c532009-05-13 14:38:28 +02001105 /**
1106 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1107 * This intent is delivered to the package which installed the application, usually
1108 * the Market.
1109 * <p>Input: No data is specified. The bug report is passed in using
1110 * an {@link #EXTRA_BUG_REPORT} field.
1111 * <p>Output: Nothing.
1112 * @hide
1113 */
1114 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1115 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001116
1117 /**
1118 * Activity Action: Show power usage information to the user.
1119 * <p>Input: Nothing.
1120 * <p>Output: Nothing.
1121 */
1122 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1123 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001124
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001125 /**
1126 * Activity Action: Setup wizard to launch after a platform update. This
1127 * activity should have a string meta-data field associated with it,
1128 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1129 * the platform for setup. The activity will be launched only if
1130 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1131 * same value.
1132 * <p>Input: Nothing.
1133 * <p>Output: Nothing.
1134 * @hide
1135 */
1136 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1137 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001138
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001139 /**
1140 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1141 * describing the last run version of the platform that was setup.
1142 * @hide
1143 */
1144 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1145
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001146 // ---------------------------------------------------------------------
1147 // ---------------------------------------------------------------------
1148 // Standard intent broadcast actions (see action variable).
1149
1150 /**
1151 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001152 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001153 * <p class="note">This is a protected intent that can only be sent
1154 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001155 */
1156 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1157 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1158 /**
1159 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001160 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001161 * <p class="note">This is a protected intent that can only be sent
1162 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001163 */
1164 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1165 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001166
1167 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001168 * 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 -07001169 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001170 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001171 * <p class="note">This is a protected intent that can only be sent
1172 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001173 */
1174 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001175 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001176
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001177 /**
1178 * Broadcast Action: The current time has changed. Sent every
1179 * minute. You can <em>not</em> receive this through components declared
1180 * in manifests, only by exlicitly registering for it with
1181 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1182 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001183 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001184 * <p class="note">This is a protected intent that can only be sent
1185 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001186 */
1187 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1188 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1189 /**
1190 * Broadcast Action: The time was set.
1191 */
1192 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1193 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1194 /**
1195 * Broadcast Action: The date has changed.
1196 */
1197 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1198 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1199 /**
1200 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1201 * <ul>
1202 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1203 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001204 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001205 * <p class="note">This is a protected intent that can only be sent
1206 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001207 */
1208 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1209 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1210 /**
1211 * Alarm Changed Action: This is broadcast when the AlarmClock
1212 * application's alarm is set or unset. It is used by the
1213 * AlarmClock application and the StatusBar service.
1214 * @hide
1215 */
1216 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1217 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1218 /**
1219 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1220 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1221 * @hide
1222 */
1223 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1224 public static final String ACTION_SYNC_STATE_CHANGED
1225 = "android.intent.action.SYNC_STATE_CHANGED";
1226 /**
1227 * Broadcast Action: This is broadcast once, after the system has finished
1228 * booting. It can be used to perform application-specific initialization,
1229 * such as installing alarms. You must hold the
1230 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1231 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001232 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001233 * <p class="note">This is a protected intent that can only be sent
1234 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001235 */
1236 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1237 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1238 /**
1239 * Broadcast Action: This is broadcast when a user action should request a
1240 * temporary system dialog to dismiss. Some examples of temporary system
1241 * dialogs are the notification window-shade and the recent tasks dialog.
1242 */
1243 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1244 /**
1245 * Broadcast Action: Trigger the download and eventual installation
1246 * of a package.
1247 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001248 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001249 * <p class="note">This is a protected intent that can only be sent
1250 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001251 */
1252 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1253 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1254 /**
1255 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001256 * device. The data contains the name of the package. Note that the
1257 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001258 * <p>My include the following extras:
1259 * <ul>
1260 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1261 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1262 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1263 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001264 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001265 * <p class="note">This is a protected intent that can only be sent
1266 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001267 */
1268 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1269 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1270 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001271 * Broadcast Action: A new version of an application package has been
1272 * installed, replacing an existing version that was previously installed.
1273 * The data contains the name of the package.
1274 * <p>My include the following extras:
1275 * <ul>
1276 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1277 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001278 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001279 * <p class="note">This is a protected intent that can only be sent
1280 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001281 */
1282 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1283 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1284 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001285 * Broadcast Action: An existing application package has been removed from
1286 * the device. The data contains the name of the package. The package
1287 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001288 * <ul>
1289 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1290 * to the package.
1291 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1292 * application -- data and code -- is being removed.
1293 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1294 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1295 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001296 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001297 * <p class="note">This is a protected intent that can only be sent
1298 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001299 */
1300 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1301 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1302 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001303 * Broadcast Action: An existing application package has been changed (e.g.
1304 * a component has been enabled or disabled). The data contains the name of
1305 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001306 * <ul>
1307 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001308 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1309 * of the changed components.
1310 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1311 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001312 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001313 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001314 * <p class="note">This is a protected intent that can only be sent
1315 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001316 */
1317 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1318 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1319 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001320 * @hide
1321 * Broadcast Action: Ask system services if there is any reason to
1322 * restart the given package. The data contains the name of the
1323 * package.
1324 * <ul>
1325 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1326 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1327 * </ul>
1328 *
1329 * <p class="note">This is a protected intent that can only be sent
1330 * by the system.
1331 */
1332 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1333 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1334 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001335 * Broadcast Action: The user has restarted a package, and all of its
1336 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001337 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001338 * be removed. Note that the restarted package does <em>not</em>
1339 * receive this broadcast.
1340 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001341 * <ul>
1342 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1343 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001344 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001345 * <p class="note">This is a protected intent that can only be sent
1346 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001347 */
1348 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1349 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1350 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001351 * Broadcast Action: The user has cleared the data of a package. This should
1352 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001353 * its persistent data is erased and this broadcast sent.
1354 * Note that the cleared package does <em>not</em>
1355 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001356 * <ul>
1357 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1358 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001359 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001360 * <p class="note">This is a protected intent that can only be sent
1361 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001362 */
1363 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1364 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1365 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001366 * Broadcast Action: A user ID has been removed from the system. The user
1367 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001368 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001369 * <p class="note">This is a protected intent that can only be sent
1370 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001371 */
1372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1373 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001374
1375 /**
1376 * Broadcast Action: Resources for a set of packages (which were
1377 * previously unavailable) are currently
1378 * available since the media on which they exist is available.
1379 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1380 * list of packages whose availability changed.
1381 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1382 * list of uids of packages whose availability changed.
1383 * Note that the
1384 * packages in this list do <em>not</em> receive this broadcast.
1385 * The specified set of packages are now available on the system.
1386 * <p>Includes the following extras:
1387 * <ul>
1388 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1389 * whose resources(were previously unavailable) are currently available.
1390 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1391 * packages whose resources(were previously unavailable)
1392 * are currently available.
1393 * </ul>
1394 *
1395 * <p class="note">This is a protected intent that can only be sent
1396 * by the system.
1397 * @hide
1398 */
1399 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001400 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1401 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001402
1403 /**
1404 * Broadcast Action: Resources for a set of packages are currently
1405 * unavailable since the media on which they exist is unavailable.
1406 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1407 * list of packages whose availability changed.
1408 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1409 * list of uids of packages whose availability changed.
1410 * The specified set of packages can no longer be
1411 * launched and are practically unavailable on the system.
1412 * <p>Inclues the following extras:
1413 * <ul>
1414 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1415 * whose resources are no longer available.
1416 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1417 * whose resources are no longer available.
1418 * </ul>
1419 *
1420 * <p class="note">This is a protected intent that can only be sent
1421 * by the system.
1422 * @hide
1423 */
1424 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001425 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
1426 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABILE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001427
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001428 /**
1429 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001430 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001431 */
1432 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1433 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1434 /**
1435 * Broadcast Action: The current device {@link android.content.res.Configuration}
1436 * (orientation, locale, etc) has changed. When such a change happens, the
1437 * UIs (view hierarchy) will need to be rebuilt based on this new
1438 * information; for the most part, applications don't need to worry about
1439 * this, because the system will take care of stopping and restarting the
1440 * application to make sure it sees the new changes. Some system code that
1441 * can not be restarted will need to watch for this action and handle it
1442 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001443 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001444 * <p class="note">
1445 * You can <em>not</em> receive this through components declared
1446 * in manifests, only by explicitly registering for it with
1447 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1448 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001449 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001450 * <p class="note">This is a protected intent that can only be sent
1451 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001452 *
1453 * @see android.content.res.Configuration
1454 */
1455 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1456 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1457 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001458 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001459 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001460 * <p class="note">This is a protected intent that can only be sent
1461 * by the system.
1462 */
1463 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1464 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1465 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001466 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1467 * charging state, level, and other information about the battery.
1468 * See {@link android.os.BatteryManager} for documentation on the
1469 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001470 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001471 * <p class="note">
1472 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001473 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001474 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001475 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1476 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1477 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1478 * broadcasts that are sent and can be received through manifest
1479 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001480 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001481 * <p class="note">This is a protected intent that can only be sent
1482 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001483 */
1484 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1485 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1486 /**
1487 * Broadcast Action: Indicates low battery condition on the device.
1488 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001489 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001490 * <p class="note">This is a protected intent that can only be sent
1491 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001492 */
1493 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1494 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1495 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001496 * Broadcast Action: Indicates the battery is now okay after being low.
1497 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1498 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001499 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001500 * <p class="note">This is a protected intent that can only be sent
1501 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001502 */
1503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1505 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001506 * Broadcast Action: External power has been connected to the device.
1507 * This is intended for applications that wish to register specifically to this notification.
1508 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1509 * stay active to receive this notification. This action can be used to implement actions
1510 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001511 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001512 * <p class="note">This is a protected intent that can only be sent
1513 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001514 */
1515 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001516 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001517 /**
1518 * Broadcast Action: External power has been removed from the device.
1519 * This is intended for applications that wish to register specifically to this notification.
1520 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1521 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001522 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001523 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001524 * <p class="note">This is a protected intent that can only be sent
1525 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001526 */
1527 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001528 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001529 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001530 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001531 * Broadcast Action: Device is shutting down.
1532 * This is broadcast when the device is being shut down (completely turned
1533 * off, not sleeping). Once the broadcast is complete, the final shutdown
1534 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001535 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001536 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001537 * <p class="note">This is a protected intent that can only be sent
1538 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001539 */
1540 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001541 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001542 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001543 * Activity Action: Start this activity to request system shutdown.
1544 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1545 * to request confirmation from the user before shutting down.
1546 *
1547 * <p class="note">This is a protected intent that can only be sent
1548 * by the system.
1549 *
1550 * {@hide}
1551 */
1552 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1553 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001554 * Broadcast Action: A sticky broadcast that indicates low memory
1555 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001556 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001557 * <p class="note">This is a protected intent that can only be sent
1558 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1562 /**
1563 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001564 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001565 * <p class="note">This is a protected intent that can only be sent
1566 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001567 */
1568 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1569 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1570 /**
1571 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1572 * and package management should be started.
1573 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1574 * notification.
1575 */
1576 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1577 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1578 /**
1579 * Broadcast Action: The device has entered USB Mass Storage mode.
1580 * This is used mainly for the USB Settings panel.
1581 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1582 * when the SD card file system is mounted or unmounted
1583 */
1584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1585 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1586
1587 /**
1588 * Broadcast Action: The device has exited USB Mass Storage mode.
1589 * This is used mainly for the USB Settings panel.
1590 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1591 * when the SD card file system is mounted or unmounted
1592 */
1593 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1594 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1595
1596 /**
1597 * Broadcast Action: External media has been removed.
1598 * The path to the mount point for the removed media is contained in the Intent.mData field.
1599 */
1600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1601 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1602
1603 /**
1604 * Broadcast Action: External media is present, but not mounted at its mount point.
1605 * The path to the mount point for the removed media is contained in the Intent.mData field.
1606 */
1607 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1608 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1609
1610 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001611 * Broadcast Action: External media is present, and being disk-checked
1612 * 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 -08001613 */
1614 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1615 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1616
1617 /**
1618 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1619 * 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 -08001620 */
1621 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1622 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1623
1624 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001625 * Broadcast Action: External media is present and mounted at its mount point.
1626 * The path to the mount point for the removed media is contained in the Intent.mData field.
1627 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1628 * media was mounted read only.
1629 */
1630 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1631 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1632
1633 /**
1634 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
1635 * The path to the mount point for the removed media is contained in the Intent.mData field.
1636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1639
1640 /**
1641 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1642 * The path to the mount point for the removed media is contained in the Intent.mData field.
1643 */
1644 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1645 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1646
1647 /**
1648 * Broadcast Action: External media is present but cannot be mounted.
1649 * The path to the mount point for the removed media is contained in the Intent.mData field.
1650 */
1651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1652 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1653
1654 /**
1655 * Broadcast Action: User has expressed the desire to remove the external storage media.
1656 * Applications should close all files they have open within the mount point when they receive this intent.
1657 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1658 */
1659 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1660 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1661
1662 /**
1663 * Broadcast Action: The media scanner has started scanning a directory.
1664 * The path to the directory being scanned is contained in the Intent.mData field.
1665 */
1666 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1667 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1668
1669 /**
1670 * Broadcast Action: The media scanner has finished scanning a directory.
1671 * The path to the scanned directory is contained in the Intent.mData field.
1672 */
1673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1674 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1675
1676 /**
1677 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1678 * The path to the file is contained in the Intent.mData field.
1679 */
1680 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1681 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1682
1683 /**
1684 * Broadcast Action: The "Media Button" was pressed. Includes a single
1685 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1686 * caused the broadcast.
1687 */
1688 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1689 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1690
1691 /**
1692 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1693 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1694 * caused the broadcast.
1695 */
1696 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1697 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1698
1699 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1700 // location; they are not general-purpose actions.
1701
1702 /**
1703 * Broadcast Action: An GTalk connection has been established.
1704 */
1705 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1706 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1707 "android.intent.action.GTALK_CONNECTED";
1708
1709 /**
1710 * Broadcast Action: An GTalk connection has been disconnected.
1711 */
1712 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1713 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1714 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001715
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001716 /**
1717 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001718 */
1719 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1720 public static final String ACTION_INPUT_METHOD_CHANGED =
1721 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001722
1723 /**
1724 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1725 * more radios have been turned off or on. The intent will have the following extra value:</p>
1726 * <ul>
1727 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1728 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1729 * turned off</li>
1730 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001731 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001732 * <p class="note">This is a protected intent that can only be sent
1733 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001734 */
1735 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1736 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1737
1738 /**
1739 * Broadcast Action: Some content providers have parts of their namespace
1740 * where they publish new events or items that the user may be especially
1741 * interested in. For these things, they may broadcast this action when the
1742 * set of interesting items change.
1743 *
1744 * For example, GmailProvider sends this notification when the set of unread
1745 * mail in the inbox changes.
1746 *
1747 * <p>The data of the intent identifies which part of which provider
1748 * changed. When queried through the content resolver, the data URI will
1749 * return the data set in question.
1750 *
1751 * <p>The intent will have the following extra values:
1752 * <ul>
1753 * <li><em>count</em> - The number of items in the data set. This is the
1754 * same as the number of items in the cursor returned by querying the
1755 * data URI. </li>
1756 * </ul>
1757 *
1758 * This intent will be sent at boot (if the count is non-zero) and when the
1759 * data set changes. It is possible for the data set to change without the
1760 * count changing (for example, if a new unread message arrives in the same
1761 * sync operation in which a message is archived). The phone should still
1762 * ring/vibrate/etc as normal in this case.
1763 */
1764 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1765 public static final String ACTION_PROVIDER_CHANGED =
1766 "android.intent.action.PROVIDER_CHANGED";
1767
1768 /**
1769 * Broadcast Action: Wired Headset plugged in or unplugged.
1770 *
1771 * <p>The intent will have the following extra values:
1772 * <ul>
1773 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1774 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001775 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001776 * </ul>
1777 * </ul>
1778 */
1779 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1780 public static final String ACTION_HEADSET_PLUG =
1781 "android.intent.action.HEADSET_PLUG";
1782
1783 /**
1784 * Broadcast Action: An outgoing call is about to be placed.
1785 *
1786 * <p>The Intent will have the following extra value:
1787 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001788 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001789 * the phone number originally intended to be dialed.</li>
1790 * </ul>
1791 * <p>Once the broadcast is finished, the resultData is used as the actual
1792 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001793 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001794 * outgoing call in turn: for example, a parental control application
1795 * might verify that the user is authorized to place the call at that
1796 * time, then a number-rewriting application might add an area code if
1797 * one was not specified.</p>
1798 * <p>For consistency, any receiver whose purpose is to prohibit phone
1799 * calls should have a priority of 0, to ensure it will see the final
1800 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001801 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001802 * should have a positive priority.
1803 * Negative priorities are reserved for the system for this broadcast;
1804 * using them may cause problems.</p>
1805 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1806 * abort the broadcast.</p>
1807 * <p>Emergency calls cannot be intercepted using this mechanism, and
1808 * other calls cannot be modified to call emergency numbers using this
1809 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001810 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001811 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1812 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08001813 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001814 * <p class="note">This is a protected intent that can only be sent
1815 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001816 */
1817 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1818 public static final String ACTION_NEW_OUTGOING_CALL =
1819 "android.intent.action.NEW_OUTGOING_CALL";
1820
1821 /**
1822 * Broadcast Action: Have the device reboot. This is only for use by
1823 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08001824 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001825 * <p class="note">This is a protected intent that can only be sent
1826 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001827 */
1828 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1829 public static final String ACTION_REBOOT =
1830 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001831
Wei Huang97ecc9c2009-05-11 17:44:20 -07001832 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001833 * Broadcast Action: A sticky broadcast indicating the phone was docked
Tobias Haamel154f7a12010-02-17 11:56:39 -08001834 * or undocked.
1835 *
1836 * <p>The intent will have the following extra values:
1837 * <ul>
1838 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
1839 * state, which depends on the state of the car mode.</li>
1840 * <li><em>{@link #EXTRA_PHYSICAL_DOCK_STATE}</em> - the physical dock
1841 * state.</li>
1842 * <li><em>{@link #EXTRA_CAR_MODE_ENABLED}</em> - a boolean indicating the
1843 * state of the car mode.</li>
1844 * </ul>
1845 * <p>This is intended for monitoring the current dock state.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001846 * To launch an activity from a dock state change, use {@link #CATEGORY_CAR_DOCK}
1847 * or {@link #CATEGORY_DESK_DOCK} instead.
1848 */
1849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1850 public static final String ACTION_DOCK_EVENT =
1851 "android.intent.action.DOCK_EVENT";
1852
1853 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07001854 * Broadcast Action: a remote intent is to be broadcasted.
1855 *
1856 * A remote intent is used for remote RPC between devices. The remote intent
1857 * is serialized and sent from one device to another device. The receiving
1858 * device parses the remote intent and broadcasts it. Note that anyone can
1859 * broadcast a remote intent. However, if the intent receiver of the remote intent
1860 * does not trust intent broadcasts from arbitrary intent senders, it should require
1861 * the sender to hold certain permissions so only trusted sender's broadcast will be
1862 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001863 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07001864 */
1865 public static final String ACTION_REMOTE_INTENT =
Costin Manolache63cfebf2010-02-04 16:52:34 -08001866 "com.google.android.pushmessaging.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07001867
Dianne Hackborn9acc0302009-08-25 00:27:12 -07001868 /**
1869 * Broadcast Action: hook for permforming cleanup after a system update.
1870 *
1871 * The broadcast is sent when the system is booting, before the
1872 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
1873 * image. A receiver for this should do its work and then disable itself
1874 * so that it does not get run again at the next boot.
1875 * @hide
1876 */
1877 public static final String ACTION_PRE_BOOT_COMPLETED =
1878 "android.intent.action.PRE_BOOT_COMPLETED";
1879
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001880 // ---------------------------------------------------------------------
1881 // ---------------------------------------------------------------------
1882 // Standard intent categories (see addCategory()).
1883
1884 /**
1885 * Set if the activity should be an option for the default action
1886 * (center press) to perform on a piece of data. Setting this will
1887 * hide from the user any activities without it set when performing an
1888 * action on some data. Note that this is normal -not- set in the
1889 * Intent when initiating an action -- it is for use in intent filters
1890 * specified in packages.
1891 */
1892 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1893 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1894 /**
1895 * Activities that can be safely invoked from a browser must support this
1896 * category. For example, if the user is viewing a web page or an e-mail
1897 * and clicks on a link in the text, the Intent generated execute that
1898 * link will require the BROWSABLE category, so that only activities
1899 * supporting this category will be considered as possible actions. By
1900 * supporting this category, you are promising that there is nothing
1901 * damaging (without user intervention) that can happen by invoking any
1902 * matching Intent.
1903 */
1904 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1905 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1906 /**
1907 * Set if the activity should be considered as an alternative action to
1908 * the data the user is currently viewing. See also
1909 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1910 * applies to the selection in a list of items.
1911 *
1912 * <p>Supporting this category means that you would like your activity to be
1913 * displayed in the set of alternative things the user can do, usually as
1914 * part of the current activity's options menu. You will usually want to
1915 * include a specific label in the &lt;intent-filter&gt; of this action
1916 * describing to the user what it does.
1917 *
1918 * <p>The action of IntentFilter with this category is important in that it
1919 * describes the specific action the target will perform. This generally
1920 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1921 * a specific name such as "com.android.camera.action.CROP. Only one
1922 * alternative of any particular action will be shown to the user, so using
1923 * a specific action like this makes sure that your alternative will be
1924 * displayed while also allowing other applications to provide their own
1925 * overrides of that particular action.
1926 */
1927 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1928 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1929 /**
1930 * Set if the activity should be considered as an alternative selection
1931 * action to the data the user has currently selected. This is like
1932 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1933 * of items from which the user can select, giving them alternatives to the
1934 * default action that will be performed on it.
1935 */
1936 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1937 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1938 /**
1939 * Intended to be used as a tab inside of an containing TabActivity.
1940 */
1941 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1942 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1943 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001944 * Should be displayed in the top-level launcher.
1945 */
1946 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1947 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1948 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001949 * Provides information about the package it is in; typically used if
1950 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1951 * a front-door to the user without having to be shown in the all apps list.
1952 */
1953 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1954 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1955 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001956 * This is the home activity, that is the first activity that is displayed
1957 * when the device boots.
1958 */
1959 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1960 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1961 /**
1962 * This activity is a preference panel.
1963 */
1964 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1965 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1966 /**
1967 * This activity is a development preference panel.
1968 */
1969 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1970 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1971 /**
1972 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 */
1974 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1975 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1976 /**
1977 * This activity may be exercised by the monkey or other automated test tools.
1978 */
1979 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1980 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1981 /**
1982 * To be used as a test (not part of the normal user experience).
1983 */
1984 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1985 /**
1986 * To be used as a unit test (run through the Test Harness).
1987 */
1988 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1989 /**
1990 * To be used as an sample code example (not part of the normal user
1991 * experience).
1992 */
1993 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1994 /**
1995 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
1996 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
1997 * when queried, though it is allowable for those columns to be blank.
1998 */
1999 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2000 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2001
2002 /**
2003 * To be used as code under test for framework instrumentation tests.
2004 */
2005 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2006 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002007 /**
2008 * An activity to run when device is inserted into a car dock.
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002009 * Used with {@link #ACTION_MAIN} to launch an activity.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002010 * To monitor dock state, use {@link #ACTION_DOCK_EVENT} instead.
2011 */
2012 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2013 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2014 /**
2015 * An activity to run when device is inserted into a car dock.
2016 * Used with {@link #ACTION_MAIN} to launch an activity.
2017 * To monitor dock state, use {@link #ACTION_DOCK_EVENT} instead.
2018 */
2019 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2020 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002021
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002022 // ---------------------------------------------------------------------
2023 // ---------------------------------------------------------------------
2024 // Standard extra data keys.
2025
2026 /**
2027 * The initial data to place in a newly created record. Use with
2028 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2029 * fields as would be given to the underlying ContentProvider.insert()
2030 * call.
2031 */
2032 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2033
2034 /**
2035 * A constant CharSequence that is associated with the Intent, used with
2036 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2037 * this may be a styled CharSequence, so you must use
2038 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2039 * retrieve it.
2040 */
2041 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2042
2043 /**
2044 * A content: URI holding a stream of data associated with the Intent,
2045 * used with {@link #ACTION_SEND} to supply the data being sent.
2046 */
2047 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2048
2049 /**
2050 * A String[] holding e-mail addresses that should be delivered to.
2051 */
2052 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2053
2054 /**
2055 * A String[] holding e-mail addresses that should be carbon copied.
2056 */
2057 public static final String EXTRA_CC = "android.intent.extra.CC";
2058
2059 /**
2060 * A String[] holding e-mail addresses that should be blind carbon copied.
2061 */
2062 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2063
2064 /**
2065 * A constant string holding the desired subject line of a message.
2066 */
2067 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2068
2069 /**
2070 * An Intent describing the choices you would like shown with
2071 * {@link #ACTION_PICK_ACTIVITY}.
2072 */
2073 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2074
2075 /**
2076 * A CharSequence dialog title to provide to the user when used with a
2077 * {@link #ACTION_CHOOSER}.
2078 */
2079 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2080
2081 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002082 * A Parcelable[] of {@link Intent} or
2083 * {@link android.content.pm.LabeledIntent} objects as set with
2084 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2085 * a the front of the list of choices, when shown to the user with a
2086 * {@link #ACTION_CHOOSER}.
2087 */
2088 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2089
2090 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002091 * A {@link android.view.KeyEvent} object containing the event that
2092 * triggered the creation of the Intent it is in.
2093 */
2094 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2095
2096 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002097 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2098 * before shutting down.
2099 *
2100 * {@hide}
2101 */
2102 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2103
2104 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2106 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2107 * of restarting the application.
2108 */
2109 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2110
2111 /**
2112 * A String holding the phone number originally entered in
2113 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2114 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2115 */
2116 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002117
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002118 /**
2119 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2120 * intents to supply the uid the package had been assigned. Also an optional
2121 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2122 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2123 * purpose.
2124 */
2125 public static final String EXTRA_UID = "android.intent.extra.UID";
2126
2127 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002128 * @hide String array of package names.
2129 */
2130 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2131
2132 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002133 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2134 * intents to indicate whether this represents a full uninstall (removing
2135 * both the code and its data) or a partial uninstall (leaving its data,
2136 * implying that this is an update).
2137 */
2138 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002139
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002140 /**
2141 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2142 * intents to indicate that this is a replacement of the package, so this
2143 * broadcast will immediately be followed by an add broadcast for a
2144 * different version of the same package.
2145 */
2146 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002147
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002148 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002149 * Used as an int extra field in {@link android.app.AlarmManager} intents
2150 * to tell the application being invoked how many pending alarms are being
2151 * delievered with the intent. For one-shot alarms this will always be 1.
2152 * For recurring alarms, this might be greater than 1 if the device was
2153 * asleep or powered off at the time an earlier alarm would have been
2154 * delivered.
2155 */
2156 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002157
Jacek Surazski86b6c532009-05-13 14:38:28 +02002158 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002159 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2160 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002161 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2162 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
2163 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002164 */
2165 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2166
2167 /**
2168 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2169 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002170 */
2171 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2172
2173 /**
2174 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2175 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002176 */
2177 public static final int EXTRA_DOCK_STATE_DESK = 1;
2178
2179 /**
2180 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2181 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002182 */
2183 public static final int EXTRA_DOCK_STATE_CAR = 2;
2184
2185 /**
Tobias Haamel154f7a12010-02-17 11:56:39 -08002186 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2187 * intents to request the physical dock state. Possible values are
2188 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2189 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
2190 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}.
2191 */
2192 public static final String EXTRA_PHYSICAL_DOCK_STATE =
2193 "android.intent.extra.PHYSICAL_DOCK_STATE";
2194
2195 /**
Tobias Haamel27b28b32010-02-09 23:09:17 +01002196 * Used as an boolean extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2197 * intents to indicate that the car mode is enabled or not.
2198 */
2199 public static final String EXTRA_CAR_MODE_ENABLED = "android.intent.extra.CAR_MODE_ENABLED";
2200
2201 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002202 * Boolean that can be supplied as meta-data with a dock activity, to
2203 * indicate that the dock should take over the home key when it is active.
2204 */
2205 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002206
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002207 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002208 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2209 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002210 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002211 * @hide
2212 */
2213 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2214
2215 /**
Romain Guy4969af72009-06-17 10:53:19 -07002216 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002217 * package. Specifies the installer package name; this package will receive the
2218 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002219 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002220 * @hide
2221 */
Romain Guy4969af72009-06-17 10:53:19 -07002222 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002223 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002224
Wei Huang97ecc9c2009-05-11 17:44:20 -07002225 /**
2226 * Used in the extra field in the remote intent. It's astring token passed with the
2227 * remote intent.
2228 */
2229 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2230 "android.intent.extra.remote_intent_token";
2231
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002232 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002233 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002234 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002235 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002236 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002237 "android.intent.extra.changed_component_name";
2238
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002239 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002240 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002241 * and contains a string array of all of the components that have changed.
2242 */
2243 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2244 "android.intent.extra.changed_component_name_list";
2245
2246 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002247 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002248 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2249 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002250 * and contains a string array of all of the components that have changed.
2251 * @hide
2252 */
2253 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2254 "android.intent.extra.changed_package_list";
2255
2256 /**
2257 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002258 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2259 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002260 * and contains an integer array of uids of all of the components
2261 * that have changed.
2262 * @hide
2263 */
2264 public static final String EXTRA_CHANGED_UID_LIST =
2265 "android.intent.extra.changed_uid_list";
2266
2267 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002268 * @hide
2269 * Magic extra system code can use when binding, to give a label for
2270 * who it is that has bound to a service. This is an integer giving
2271 * a framework string resource that can be displayed to the user.
2272 */
2273 public static final String EXTRA_CLIENT_LABEL =
2274 "android.intent.extra.client_label";
2275
2276 /**
2277 * @hide
2278 * Magic extra system code can use when binding, to give a PendingIntent object
2279 * that can be launched for the user to disable the system's use of this
2280 * service.
2281 */
2282 public static final String EXTRA_CLIENT_INTENT =
2283 "android.intent.extra.client_intent";
2284
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002285 // ---------------------------------------------------------------------
2286 // ---------------------------------------------------------------------
2287 // Intent flags (see mFlags variable).
2288
2289 /**
2290 * If set, the recipient of this Intent will be granted permission to
2291 * perform read operations on the Uri in the Intent's data.
2292 */
2293 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2294 /**
2295 * If set, the recipient of this Intent will be granted permission to
2296 * perform write operations on the Uri in the Intent's data.
2297 */
2298 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2299 /**
2300 * Can be set by the caller to indicate that this Intent is coming from
2301 * a background operation, not from direct user interaction.
2302 */
2303 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2304 /**
2305 * A flag you can enable for debugging: when set, log messages will be
2306 * printed during the resolution of this intent to show you what has
2307 * been found to create the final resolved list.
2308 */
2309 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
2310
2311 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002312 * If set, the new activity is not kept in the history stack. As soon as
2313 * the user navigates away from it, the activity is finished. This may also
2314 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2315 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002316 */
2317 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2318 /**
2319 * If set, the activity will not be launched if it is already running
2320 * at the top of the history stack.
2321 */
2322 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2323 /**
2324 * If set, this activity will become the start of a new task on this
2325 * history stack. A task (from the activity that started it to the
2326 * next task activity) defines an atomic group of activities that the
2327 * user can move to. Tasks can be moved to the foreground and background;
2328 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002329 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002330 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2331 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002332 *
2333 * <p>This flag is generally used by activities that want
2334 * to present a "launcher" style behavior: they give the user a list of
2335 * separate things that can be done, which otherwise run completely
2336 * independently of the activity launching them.
2337 *
2338 * <p>When using this flag, if a task is already running for the activity
2339 * you are now starting, then a new activity will not be started; instead,
2340 * the current task will simply be brought to the front of the screen with
2341 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2342 * to disable this behavior.
2343 *
2344 * <p>This flag can not be used when the caller is requesting a result from
2345 * the activity being launched.
2346 */
2347 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2348 /**
2349 * <strong>Do not use this flag unless you are implementing your own
2350 * top-level application launcher.</strong> Used in conjunction with
2351 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2352 * behavior of bringing an existing task to the foreground. When set,
2353 * a new task is <em>always</em> started to host the Activity for the
2354 * Intent, regardless of whether there is already an existing task running
2355 * the same thing.
2356 *
2357 * <p><strong>Because the default system does not include graphical task management,
2358 * you should not use this flag unless you provide some way for a user to
2359 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002360 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002361 * <p>This flag is ignored if
2362 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2363 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002364 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2365 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002366 */
2367 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2368 /**
2369 * If set, and the activity being launched is already running in the
2370 * current task, then instead of launching a new instance of that activity,
2371 * all of the other activities on top of it will be closed and this Intent
2372 * will be delivered to the (now on top) old activity as a new Intent.
2373 *
2374 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2375 * If D calls startActivity() with an Intent that resolves to the component
2376 * of activity B, then C and D will be finished and B receive the given
2377 * Intent, resulting in the stack now being: A, B.
2378 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002379 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002380 * either receive the new intent you are starting here in its
2381 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002382 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002383 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2384 * the same intent, then it will be finished and re-created; for all other
2385 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2386 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002387 *
2388 * <p>This launch mode can also be used to good effect in conjunction with
2389 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2390 * of a task, it will bring any currently running instance of that task
2391 * to the foreground, and then clear it to its root state. This is
2392 * especially useful, for example, when launching an activity from the
2393 * notification manager.
2394 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002395 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2396 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002397 */
2398 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2399 /**
2400 * If set and this intent is being used to launch a new activity from an
2401 * existing one, then the reply target of the existing activity will be
2402 * transfered to the new activity. This way the new activity can call
2403 * {@link android.app.Activity#setResult} and have that result sent back to
2404 * the reply target of the original activity.
2405 */
2406 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2407 /**
2408 * If set and this intent is being used to launch a new activity from an
2409 * existing one, the current activity will not be counted as the top
2410 * activity for deciding whether the new intent should be delivered to
2411 * the top instead of starting a new one. The previous activity will
2412 * be used as the top, with the assumption being that the current activity
2413 * will finish itself immediately.
2414 */
2415 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2416 /**
2417 * If set, the new activity is not kept in the list of recently launched
2418 * activities.
2419 */
2420 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2421 /**
2422 * This flag is not normally set by application code, but set for you by
2423 * the system as described in the
2424 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2425 * launchMode} documentation for the singleTask mode.
2426 */
2427 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2428 /**
2429 * If set, and this activity is either being started in a new task or
2430 * bringing to the top an existing task, then it will be launched as
2431 * the front door of the task. This will result in the application of
2432 * any affinities needed to have that task in the proper state (either
2433 * moving activities to or from it), or simply resetting that task to
2434 * its initial state if needed.
2435 */
2436 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2437 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002438 * This flag is not normally set by application code, but set for you by
2439 * the system if this activity is being launched from history
2440 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002441 */
2442 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002443 /**
2444 * If set, this marks a point in the task's activity stack that should
2445 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002446 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002447 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2448 * the user re-launching it from home), this activity and all on top of
2449 * it will be finished so that the user does not return to them, but
2450 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002451 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002452 * <p>This is useful for cases where you have a logical break in your
2453 * application. For example, an e-mail application may have a command
2454 * to view an attachment, which launches an image view activity to
2455 * display it. This activity should be part of the e-mail application's
2456 * task, since it is a part of the task the user is involved in. However,
2457 * if the user leaves that task, and later selects the e-mail app from
2458 * home, we may like them to return to the conversation they were
2459 * viewing, not the picture attachment, since that is confusing. By
2460 * setting this flag when launching the image viewer, that viewer and
2461 * any activities it starts will be removed the next time the user returns
2462 * to mail.
2463 */
2464 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002465 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002466 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002467 * callback from occurring on the current frontmost activity before it is
2468 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002469 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002470 * <p>Typically, an activity can rely on that callback to indicate that an
2471 * explicit user action has caused their activity to be moved out of the
2472 * foreground. The callback marks an appropriate point in the activity's
2473 * lifecycle for it to dismiss any notifications that it intends to display
2474 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002475 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002476 * <p>If an activity is ever started via any non-user-driven events such as
2477 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2478 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002479 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002480 */
2481 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002482 /**
2483 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2484 * this flag will cause the launched activity to be brought to the front of its
2485 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002486 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002487 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2488 * If D calls startActivity() with an Intent that resolves to the component
2489 * of activity B, then B will be brought to the front of the history stack,
2490 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002491 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002492 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002493 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002494 */
2495 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002496 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002497 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2498 * this flag will prevent the system from applying an activity transition
2499 * animation to go to the next activity state. This doesn't mean an
2500 * animation will never run -- if another activity change happens that doesn't
2501 * specify this flag before the activity started here is displayed, then
2502 * that transition will be used. This this flag can be put to good use
2503 * when you are going to do a series of activity operations but the
2504 * animation seen by the user shouldn't be driven by the first activity
2505 * change but rather a later one.
2506 */
2507 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2508 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002509 * If set, when sending a broadcast only registered receivers will be
2510 * called -- no BroadcastReceiver components will be launched.
2511 */
2512 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002513 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002514 * If set, when sending a broadcast the new broadcast will replace
2515 * any existing pending broadcast that matches it. Matching is defined
2516 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
2517 * true for the intents of the two broadcasts. When a match is found,
2518 * the new broadcast (and receivers associated with it) will replace the
2519 * existing one in the pending broadcast list, remaining at the same
2520 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08002521 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002522 * <p>This flag is most typically used with sticky broadcasts, which
2523 * only care about delivering the most recent values of the broadcast
2524 * to their receivers.
2525 */
2526 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
2527 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002528 * If set, when sending a broadcast <i>before boot has completed</i> only
2529 * registered receivers will be called -- no BroadcastReceiver components
2530 * will be launched. Sticky intent state will be recorded properly even
2531 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2532 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002533 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002534 * <p>This flag is only for use by system sevices as a convenience to
2535 * avoid having to implement a more complex mechanism around detection
2536 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002537 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002538 * @hide
2539 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002540 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x10000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002541 /**
2542 * Set when this broadcast is for a boot upgrade, a special mode that
2543 * allows the broadcast to be sent before the system is ready and launches
2544 * the app process with no providers running in it.
2545 * @hide
2546 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002547 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x08000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002548
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002549 /**
2550 * @hide Flags that can't be changed with PendingIntent.
2551 */
2552 public static final int IMMUTABLE_FLAGS =
2553 FLAG_GRANT_READ_URI_PERMISSION
2554 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08002555
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002556 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002557 // ---------------------------------------------------------------------
2558 // toUri() and parseUri() options.
2559
2560 /**
2561 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2562 * always has the "intent:" scheme. This syntax can be used when you want
2563 * to later disambiguate between URIs that are intended to describe an
2564 * Intent vs. all others that should be treated as raw URIs. When used
2565 * with {@link #parseUri}, any other scheme will result in a generic
2566 * VIEW action for that raw URI.
2567 */
2568 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08002569
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002570 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002571
2572 private String mAction;
2573 private Uri mData;
2574 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002575 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002576 private ComponentName mComponent;
2577 private int mFlags;
2578 private HashSet<String> mCategories;
2579 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002580 private Rect mSourceBounds;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002581
2582 // ---------------------------------------------------------------------
2583
2584 /**
2585 * Create an empty intent.
2586 */
2587 public Intent() {
2588 }
2589
2590 /**
2591 * Copy constructor.
2592 */
2593 public Intent(Intent o) {
2594 this.mAction = o.mAction;
2595 this.mData = o.mData;
2596 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002597 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002598 this.mComponent = o.mComponent;
2599 this.mFlags = o.mFlags;
2600 if (o.mCategories != null) {
2601 this.mCategories = new HashSet<String>(o.mCategories);
2602 }
2603 if (o.mExtras != null) {
2604 this.mExtras = new Bundle(o.mExtras);
2605 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002606 if (o.mSourceBounds != null) {
2607 this.mSourceBounds = new Rect(o.mSourceBounds);
2608 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002609 }
2610
2611 @Override
2612 public Object clone() {
2613 return new Intent(this);
2614 }
2615
2616 private Intent(Intent o, boolean all) {
2617 this.mAction = o.mAction;
2618 this.mData = o.mData;
2619 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002620 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002621 this.mComponent = o.mComponent;
2622 if (o.mCategories != null) {
2623 this.mCategories = new HashSet<String>(o.mCategories);
2624 }
2625 }
2626
2627 /**
2628 * Make a clone of only the parts of the Intent that are relevant for
2629 * filter matching: the action, data, type, component, and categories.
2630 */
2631 public Intent cloneFilter() {
2632 return new Intent(this, false);
2633 }
2634
2635 /**
2636 * Create an intent with a given action. All other fields (data, type,
2637 * class) are null. Note that the action <em>must</em> be in a
2638 * namespace because Intents are used globally in the system -- for
2639 * example the system VIEW action is android.intent.action.VIEW; an
2640 * application's custom action would be something like
2641 * com.google.app.myapp.CUSTOM_ACTION.
2642 *
2643 * @param action The Intent action, such as ACTION_VIEW.
2644 */
2645 public Intent(String action) {
2646 mAction = action;
2647 }
2648
2649 /**
2650 * Create an intent with a given action and for a given data url. Note
2651 * that the action <em>must</em> be in a namespace because Intents are
2652 * used globally in the system -- for example the system VIEW action is
2653 * android.intent.action.VIEW; an application's custom action would be
2654 * something like com.google.app.myapp.CUSTOM_ACTION.
2655 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002656 * <p><em>Note: scheme and host name matching in the Android framework is
2657 * case-sensitive, unlike the formal RFC. As a result,
2658 * you should always ensure that you write your Uri with these elements
2659 * using lower case letters, and normalize any Uris you receive from
2660 * outside of Android to ensure the scheme and host is lower case.</em></p>
2661 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002662 * @param action The Intent action, such as ACTION_VIEW.
2663 * @param uri The Intent data URI.
2664 */
2665 public Intent(String action, Uri uri) {
2666 mAction = action;
2667 mData = uri;
2668 }
2669
2670 /**
2671 * Create an intent for a specific component. All other fields (action, data,
2672 * type, class) are null, though they can be modified later with explicit
2673 * calls. This provides a convenient way to create an intent that is
2674 * intended to execute a hard-coded class name, rather than relying on the
2675 * system to find an appropriate class for you; see {@link #setComponent}
2676 * for more information on the repercussions of this.
2677 *
2678 * @param packageContext A Context of the application package implementing
2679 * this class.
2680 * @param cls The component class that is to be used for the intent.
2681 *
2682 * @see #setClass
2683 * @see #setComponent
2684 * @see #Intent(String, android.net.Uri , Context, Class)
2685 */
2686 public Intent(Context packageContext, Class<?> cls) {
2687 mComponent = new ComponentName(packageContext, cls);
2688 }
2689
2690 /**
2691 * Create an intent for a specific component with a specified action and data.
2692 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2693 * construct the Intent and then calling {@link #setClass} to set its
2694 * class.
2695 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002696 * <p><em>Note: scheme and host name matching in the Android framework is
2697 * case-sensitive, unlike the formal RFC. As a result,
2698 * you should always ensure that you write your Uri with these elements
2699 * using lower case letters, and normalize any Uris you receive from
2700 * outside of Android to ensure the scheme and host is lower case.</em></p>
2701 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002702 * @param action The Intent action, such as ACTION_VIEW.
2703 * @param uri The Intent data URI.
2704 * @param packageContext A Context of the application package implementing
2705 * this class.
2706 * @param cls The component class that is to be used for the intent.
2707 *
2708 * @see #Intent(String, android.net.Uri)
2709 * @see #Intent(Context, Class)
2710 * @see #setClass
2711 * @see #setComponent
2712 */
2713 public Intent(String action, Uri uri,
2714 Context packageContext, Class<?> cls) {
2715 mAction = action;
2716 mData = uri;
2717 mComponent = new ComponentName(packageContext, cls);
2718 }
2719
2720 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002721 * Call {@link #parseUri} with 0 flags.
2722 * @deprecated Use {@link #parseUri} instead.
2723 */
2724 @Deprecated
2725 public static Intent getIntent(String uri) throws URISyntaxException {
2726 return parseUri(uri, 0);
2727 }
Tom Taylord4a47292009-12-21 13:59:18 -08002728
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002729 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002730 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002731 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002732 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002733 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002734 *
2735 * <p>The URI given here must not be relative -- that is, it must include
2736 * the scheme and full path.
2737 *
2738 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002739 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002740 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002741 *
2742 * @return Intent The newly created Intent object.
2743 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002744 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2745 * it bad (as parsed by the Uri class) or the Intent data within the
2746 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08002747 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002748 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002749 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002750 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002751 int i = 0;
2752 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002753 // Validate intent scheme for if requested.
2754 if ((flags&URI_INTENT_SCHEME) != 0) {
2755 if (!uri.startsWith("intent:")) {
2756 Intent intent = new Intent(ACTION_VIEW);
2757 try {
2758 intent.setData(Uri.parse(uri));
2759 } catch (IllegalArgumentException e) {
2760 throw new URISyntaxException(uri, e.getMessage());
2761 }
2762 return intent;
2763 }
2764 }
Tom Taylord4a47292009-12-21 13:59:18 -08002765
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002766 // simple case
2767 i = uri.lastIndexOf("#");
2768 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2769
2770 // old format Intent URI
2771 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002772
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002773 // new format
2774 Intent intent = new Intent(ACTION_VIEW);
2775
2776 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002777 String data = i >= 0 ? uri.substring(0, i) : null;
2778 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002779 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002780
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002781 // loop over contents of Intent, all name=value;
2782 while (!uri.startsWith("end", i)) {
2783 int eq = uri.indexOf('=', i);
2784 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002785 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002786
2787 // action
2788 if (uri.startsWith("action=", i)) {
2789 intent.mAction = value;
2790 }
2791
2792 // categories
2793 else if (uri.startsWith("category=", i)) {
2794 intent.addCategory(value);
2795 }
2796
2797 // type
2798 else if (uri.startsWith("type=", i)) {
2799 intent.mType = value;
2800 }
2801
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002802 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002803 else if (uri.startsWith("launchFlags=", i)) {
2804 intent.mFlags = Integer.decode(value).intValue();
2805 }
2806
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002807 // package
2808 else if (uri.startsWith("package=", i)) {
2809 intent.mPackage = value;
2810 }
2811
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002812 // component
2813 else if (uri.startsWith("component=", i)) {
2814 intent.mComponent = ComponentName.unflattenFromString(value);
2815 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002816
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002817 // scheme
2818 else if (uri.startsWith("scheme=", i)) {
2819 scheme = value;
2820 }
2821
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002822 // source bounds
2823 else if (uri.startsWith("sourceBounds=", i)) {
2824 intent.mSourceBounds = Rect.unflattenFromString(value);
2825 }
2826
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002827 // extra
2828 else {
2829 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002830 // create Bundle if it doesn't already exist
2831 if (intent.mExtras == null) intent.mExtras = new Bundle();
2832 Bundle b = intent.mExtras;
2833 // add EXTRA
2834 if (uri.startsWith("S.", i)) b.putString(key, value);
2835 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2836 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2837 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2838 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2839 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2840 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2841 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2842 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2843 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2844 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002845
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002846 // move to the next item
2847 i = semi + 1;
2848 }
2849
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002850 if (data != null) {
2851 if (data.startsWith("intent:")) {
2852 data = data.substring(7);
2853 if (scheme != null) {
2854 data = scheme + ':' + data;
2855 }
2856 }
Tom Taylord4a47292009-12-21 13:59:18 -08002857
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002858 if (data.length() > 0) {
2859 try {
2860 intent.mData = Uri.parse(data);
2861 } catch (IllegalArgumentException e) {
2862 throw new URISyntaxException(uri, e.getMessage());
2863 }
2864 }
2865 }
Tom Taylord4a47292009-12-21 13:59:18 -08002866
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002867 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002868
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002869 } catch (IndexOutOfBoundsException e) {
2870 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2871 }
2872 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002873
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002874 public static Intent getIntentOld(String uri) throws URISyntaxException {
2875 Intent intent;
2876
2877 int i = uri.lastIndexOf('#');
2878 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002879 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002880 final int intentFragmentStart = i;
2881 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002882
2883 i++;
2884
2885 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002886 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002887 i += 7;
2888 int j = uri.indexOf(')', i);
2889 action = uri.substring(i, j);
2890 i = j + 1;
2891 }
2892
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002893 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002894
2895 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002896 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002897 i += 11;
2898 int j = uri.indexOf(')', i);
2899 while (i < j) {
2900 int sep = uri.indexOf('!', i);
2901 if (sep < 0) sep = j;
2902 if (i < sep) {
2903 intent.addCategory(uri.substring(i, sep));
2904 }
2905 i = sep + 1;
2906 }
2907 i = j + 1;
2908 }
2909
2910 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002911 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002912 i += 5;
2913 int j = uri.indexOf(')', i);
2914 intent.mType = uri.substring(i, j);
2915 i = j + 1;
2916 }
2917
2918 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002919 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002920 i += 12;
2921 int j = uri.indexOf(')', i);
2922 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2923 i = j + 1;
2924 }
2925
2926 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002927 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002928 i += 10;
2929 int j = uri.indexOf(')', i);
2930 int sep = uri.indexOf('!', i);
2931 if (sep >= 0 && sep < j) {
2932 String pkg = uri.substring(i, sep);
2933 String cls = uri.substring(sep + 1, j);
2934 intent.mComponent = new ComponentName(pkg, cls);
2935 }
2936 i = j + 1;
2937 }
2938
2939 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002940 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002941 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002942
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002943 final int closeParen = uri.indexOf(')', i);
2944 if (closeParen == -1) throw new URISyntaxException(uri,
2945 "EXTRA missing trailing ')'", i);
2946
2947 while (i < closeParen) {
2948 // fetch the key value
2949 int j = uri.indexOf('=', i);
2950 if (j <= i + 1 || i >= closeParen) {
2951 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2952 }
2953 char type = uri.charAt(i);
2954 i++;
2955 String key = uri.substring(i, j);
2956 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002957
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002958 // get type-value
2959 j = uri.indexOf('!', i);
2960 if (j == -1 || j >= closeParen) j = closeParen;
2961 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2962 String value = uri.substring(i, j);
2963 i = j;
2964
2965 // create Bundle if it doesn't already exist
2966 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002967
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002968 // add item to bundle
2969 try {
2970 switch (type) {
2971 case 'S':
2972 intent.mExtras.putString(key, Uri.decode(value));
2973 break;
2974 case 'B':
2975 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2976 break;
2977 case 'b':
2978 intent.mExtras.putByte(key, Byte.parseByte(value));
2979 break;
2980 case 'c':
2981 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2982 break;
2983 case 'd':
2984 intent.mExtras.putDouble(key, Double.parseDouble(value));
2985 break;
2986 case 'f':
2987 intent.mExtras.putFloat(key, Float.parseFloat(value));
2988 break;
2989 case 'i':
2990 intent.mExtras.putInt(key, Integer.parseInt(value));
2991 break;
2992 case 'l':
2993 intent.mExtras.putLong(key, Long.parseLong(value));
2994 break;
2995 case 's':
2996 intent.mExtras.putShort(key, Short.parseShort(value));
2997 break;
2998 default:
2999 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3000 }
3001 } catch (NumberFormatException e) {
3002 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3003 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003004
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003005 char ch = uri.charAt(i);
3006 if (ch == ')') break;
3007 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3008 i++;
3009 }
3010 }
3011
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003012 if (isIntentFragment) {
3013 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3014 } else {
3015 intent.mData = Uri.parse(uri);
3016 }
Tom Taylord4a47292009-12-21 13:59:18 -08003017
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003018 if (intent.mAction == null) {
3019 // By default, if no action is specified, then use VIEW.
3020 intent.mAction = ACTION_VIEW;
3021 }
3022
3023 } else {
3024 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3025 }
3026
3027 return intent;
3028 }
3029
3030 /**
3031 * Retrieve the general action to be performed, such as
3032 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3033 * the information in the intent should be interpreted -- most importantly,
3034 * what to do with the data returned by {@link #getData}.
3035 *
3036 * @return The action of this intent or null if none is specified.
3037 *
3038 * @see #setAction
3039 */
3040 public String getAction() {
3041 return mAction;
3042 }
3043
3044 /**
3045 * Retrieve data this intent is operating on. This URI specifies the name
3046 * of the data; often it uses the content: scheme, specifying data in a
3047 * content provider. Other schemes may be handled by specific activities,
3048 * such as http: by the web browser.
3049 *
3050 * @return The URI of the data this intent is targeting or null.
3051 *
3052 * @see #getScheme
3053 * @see #setData
3054 */
3055 public Uri getData() {
3056 return mData;
3057 }
3058
3059 /**
3060 * The same as {@link #getData()}, but returns the URI as an encoded
3061 * String.
3062 */
3063 public String getDataString() {
3064 return mData != null ? mData.toString() : null;
3065 }
3066
3067 /**
3068 * Return the scheme portion of the intent's data. If the data is null or
3069 * does not include a scheme, null is returned. Otherwise, the scheme
3070 * prefix without the final ':' is returned, i.e. "http".
3071 *
3072 * <p>This is the same as calling getData().getScheme() (and checking for
3073 * null data).
3074 *
3075 * @return The scheme of this intent.
3076 *
3077 * @see #getData
3078 */
3079 public String getScheme() {
3080 return mData != null ? mData.getScheme() : null;
3081 }
3082
3083 /**
3084 * Retrieve any explicit MIME type included in the intent. This is usually
3085 * null, as the type is determined by the intent data.
3086 *
3087 * @return If a type was manually set, it is returned; else null is
3088 * returned.
3089 *
3090 * @see #resolveType(ContentResolver)
3091 * @see #setType
3092 */
3093 public String getType() {
3094 return mType;
3095 }
3096
3097 /**
3098 * Return the MIME data type of this intent. If the type field is
3099 * explicitly set, that is simply returned. Otherwise, if the data is set,
3100 * the type of that data is returned. If neither fields are set, a null is
3101 * returned.
3102 *
3103 * @return The MIME type of this intent.
3104 *
3105 * @see #getType
3106 * @see #resolveType(ContentResolver)
3107 */
3108 public String resolveType(Context context) {
3109 return resolveType(context.getContentResolver());
3110 }
3111
3112 /**
3113 * Return the MIME data type of this intent. If the type field is
3114 * explicitly set, that is simply returned. Otherwise, if the data is set,
3115 * the type of that data is returned. If neither fields are set, a null is
3116 * returned.
3117 *
3118 * @param resolver A ContentResolver that can be used to determine the MIME
3119 * type of the intent's data.
3120 *
3121 * @return The MIME type of this intent.
3122 *
3123 * @see #getType
3124 * @see #resolveType(Context)
3125 */
3126 public String resolveType(ContentResolver resolver) {
3127 if (mType != null) {
3128 return mType;
3129 }
3130 if (mData != null) {
3131 if ("content".equals(mData.getScheme())) {
3132 return resolver.getType(mData);
3133 }
3134 }
3135 return null;
3136 }
3137
3138 /**
3139 * Return the MIME data type of this intent, only if it will be needed for
3140 * intent resolution. This is not generally useful for application code;
3141 * it is used by the frameworks for communicating with back-end system
3142 * services.
3143 *
3144 * @param resolver A ContentResolver that can be used to determine the MIME
3145 * type of the intent's data.
3146 *
3147 * @return The MIME type of this intent, or null if it is unknown or not
3148 * needed.
3149 */
3150 public String resolveTypeIfNeeded(ContentResolver resolver) {
3151 if (mComponent != null) {
3152 return mType;
3153 }
3154 return resolveType(resolver);
3155 }
3156
3157 /**
3158 * Check if an category exists in the intent.
3159 *
3160 * @param category The category to check.
3161 *
3162 * @return boolean True if the intent contains the category, else false.
3163 *
3164 * @see #getCategories
3165 * @see #addCategory
3166 */
3167 public boolean hasCategory(String category) {
3168 return mCategories != null && mCategories.contains(category);
3169 }
3170
3171 /**
3172 * Return the set of all categories in the intent. If there are no categories,
3173 * returns NULL.
3174 *
3175 * @return Set The set of categories you can examine. Do not modify!
3176 *
3177 * @see #hasCategory
3178 * @see #addCategory
3179 */
3180 public Set<String> getCategories() {
3181 return mCategories;
3182 }
3183
3184 /**
3185 * Sets the ClassLoader that will be used when unmarshalling
3186 * any Parcelable values from the extras of this Intent.
3187 *
3188 * @param loader a ClassLoader, or null to use the default loader
3189 * at the time of unmarshalling.
3190 */
3191 public void setExtrasClassLoader(ClassLoader loader) {
3192 if (mExtras != null) {
3193 mExtras.setClassLoader(loader);
3194 }
3195 }
3196
3197 /**
3198 * Returns true if an extra value is associated with the given name.
3199 * @param name the extra's name
3200 * @return true if the given extra is present.
3201 */
3202 public boolean hasExtra(String name) {
3203 return mExtras != null && mExtras.containsKey(name);
3204 }
3205
3206 /**
3207 * Returns true if the Intent's extras contain a parcelled file descriptor.
3208 * @return true if the Intent contains a parcelled file descriptor.
3209 */
3210 public boolean hasFileDescriptors() {
3211 return mExtras != null && mExtras.hasFileDescriptors();
3212 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003213
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003214 /**
3215 * Retrieve extended data from the intent.
3216 *
3217 * @param name The name of the desired item.
3218 *
3219 * @return the value of an item that previously added with putExtra()
3220 * or null if none was found.
3221 *
3222 * @deprecated
3223 * @hide
3224 */
3225 @Deprecated
3226 public Object getExtra(String name) {
3227 return getExtra(name, null);
3228 }
3229
3230 /**
3231 * Retrieve extended data from the intent.
3232 *
3233 * @param name The name of the desired item.
3234 * @param defaultValue the value to be returned if no value of the desired
3235 * type is stored with the given name.
3236 *
3237 * @return the value of an item that previously added with putExtra()
3238 * or the default value if none was found.
3239 *
3240 * @see #putExtra(String, boolean)
3241 */
3242 public boolean getBooleanExtra(String name, boolean defaultValue) {
3243 return mExtras == null ? defaultValue :
3244 mExtras.getBoolean(name, defaultValue);
3245 }
3246
3247 /**
3248 * Retrieve extended data from the intent.
3249 *
3250 * @param name The name of the desired item.
3251 * @param defaultValue the value to be returned if no value of the desired
3252 * type is stored with the given name.
3253 *
3254 * @return the value of an item that previously added with putExtra()
3255 * or the default value if none was found.
3256 *
3257 * @see #putExtra(String, byte)
3258 */
3259 public byte getByteExtra(String name, byte defaultValue) {
3260 return mExtras == null ? defaultValue :
3261 mExtras.getByte(name, defaultValue);
3262 }
3263
3264 /**
3265 * Retrieve extended data from the intent.
3266 *
3267 * @param name The name of the desired item.
3268 * @param defaultValue the value to be returned if no value of the desired
3269 * type is stored with the given name.
3270 *
3271 * @return the value of an item that previously added with putExtra()
3272 * or the default value if none was found.
3273 *
3274 * @see #putExtra(String, short)
3275 */
3276 public short getShortExtra(String name, short defaultValue) {
3277 return mExtras == null ? defaultValue :
3278 mExtras.getShort(name, defaultValue);
3279 }
3280
3281 /**
3282 * Retrieve extended data from the intent.
3283 *
3284 * @param name The name of the desired item.
3285 * @param defaultValue the value to be returned if no value of the desired
3286 * type is stored with the given name.
3287 *
3288 * @return the value of an item that previously added with putExtra()
3289 * or the default value if none was found.
3290 *
3291 * @see #putExtra(String, char)
3292 */
3293 public char getCharExtra(String name, char defaultValue) {
3294 return mExtras == null ? defaultValue :
3295 mExtras.getChar(name, defaultValue);
3296 }
3297
3298 /**
3299 * Retrieve extended data from the intent.
3300 *
3301 * @param name The name of the desired item.
3302 * @param defaultValue the value to be returned if no value of the desired
3303 * type is stored with the given name.
3304 *
3305 * @return the value of an item that previously added with putExtra()
3306 * or the default value if none was found.
3307 *
3308 * @see #putExtra(String, int)
3309 */
3310 public int getIntExtra(String name, int defaultValue) {
3311 return mExtras == null ? defaultValue :
3312 mExtras.getInt(name, defaultValue);
3313 }
3314
3315 /**
3316 * Retrieve extended data from the intent.
3317 *
3318 * @param name The name of the desired item.
3319 * @param defaultValue the value to be returned if no value of the desired
3320 * type is stored with the given name.
3321 *
3322 * @return the value of an item that previously added with putExtra()
3323 * or the default value if none was found.
3324 *
3325 * @see #putExtra(String, long)
3326 */
3327 public long getLongExtra(String name, long defaultValue) {
3328 return mExtras == null ? defaultValue :
3329 mExtras.getLong(name, defaultValue);
3330 }
3331
3332 /**
3333 * Retrieve extended data from the intent.
3334 *
3335 * @param name The name of the desired item.
3336 * @param defaultValue the value to be returned if no value of the desired
3337 * type is stored with the given name.
3338 *
3339 * @return the value of an item that previously added with putExtra(),
3340 * or the default value if no such item is present
3341 *
3342 * @see #putExtra(String, float)
3343 */
3344 public float getFloatExtra(String name, float defaultValue) {
3345 return mExtras == null ? defaultValue :
3346 mExtras.getFloat(name, defaultValue);
3347 }
3348
3349 /**
3350 * Retrieve extended data from the intent.
3351 *
3352 * @param name The name of the desired item.
3353 * @param defaultValue the value to be returned if no value of the desired
3354 * type is stored with the given name.
3355 *
3356 * @return the value of an item that previously added with putExtra()
3357 * or the default value if none was found.
3358 *
3359 * @see #putExtra(String, double)
3360 */
3361 public double getDoubleExtra(String name, double defaultValue) {
3362 return mExtras == null ? defaultValue :
3363 mExtras.getDouble(name, defaultValue);
3364 }
3365
3366 /**
3367 * Retrieve extended data from the intent.
3368 *
3369 * @param name The name of the desired item.
3370 *
3371 * @return the value of an item that previously added with putExtra()
3372 * or null if no String value was found.
3373 *
3374 * @see #putExtra(String, String)
3375 */
3376 public String getStringExtra(String name) {
3377 return mExtras == null ? null : mExtras.getString(name);
3378 }
3379
3380 /**
3381 * Retrieve extended data from the intent.
3382 *
3383 * @param name The name of the desired item.
3384 *
3385 * @return the value of an item that previously added with putExtra()
3386 * or null if no CharSequence value was found.
3387 *
3388 * @see #putExtra(String, CharSequence)
3389 */
3390 public CharSequence getCharSequenceExtra(String name) {
3391 return mExtras == null ? null : mExtras.getCharSequence(name);
3392 }
3393
3394 /**
3395 * Retrieve extended data from the intent.
3396 *
3397 * @param name The name of the desired item.
3398 *
3399 * @return the value of an item that previously added with putExtra()
3400 * or null if no Parcelable value was found.
3401 *
3402 * @see #putExtra(String, Parcelable)
3403 */
3404 public <T extends Parcelable> T getParcelableExtra(String name) {
3405 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3406 }
3407
3408 /**
3409 * Retrieve extended data from the intent.
3410 *
3411 * @param name The name of the desired item.
3412 *
3413 * @return the value of an item that previously added with putExtra()
3414 * or null if no Parcelable[] value was found.
3415 *
3416 * @see #putExtra(String, Parcelable[])
3417 */
3418 public Parcelable[] getParcelableArrayExtra(String name) {
3419 return mExtras == null ? null : mExtras.getParcelableArray(name);
3420 }
3421
3422 /**
3423 * Retrieve extended data from the intent.
3424 *
3425 * @param name The name of the desired item.
3426 *
3427 * @return the value of an item that previously added with putExtra()
3428 * or null if no ArrayList<Parcelable> value was found.
3429 *
3430 * @see #putParcelableArrayListExtra(String, ArrayList)
3431 */
3432 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3433 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3434 }
3435
3436 /**
3437 * Retrieve extended data from the intent.
3438 *
3439 * @param name The name of the desired item.
3440 *
3441 * @return the value of an item that previously added with putExtra()
3442 * or null if no Serializable value was found.
3443 *
3444 * @see #putExtra(String, Serializable)
3445 */
3446 public Serializable getSerializableExtra(String name) {
3447 return mExtras == null ? null : mExtras.getSerializable(name);
3448 }
3449
3450 /**
3451 * Retrieve extended data from the intent.
3452 *
3453 * @param name The name of the desired item.
3454 *
3455 * @return the value of an item that previously added with putExtra()
3456 * or null if no ArrayList<Integer> value was found.
3457 *
3458 * @see #putIntegerArrayListExtra(String, ArrayList)
3459 */
3460 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3461 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3462 }
3463
3464 /**
3465 * Retrieve extended data from the intent.
3466 *
3467 * @param name The name of the desired item.
3468 *
3469 * @return the value of an item that previously added with putExtra()
3470 * or null if no ArrayList<String> value was found.
3471 *
3472 * @see #putStringArrayListExtra(String, ArrayList)
3473 */
3474 public ArrayList<String> getStringArrayListExtra(String name) {
3475 return mExtras == null ? null : mExtras.getStringArrayList(name);
3476 }
3477
3478 /**
3479 * Retrieve extended data from the intent.
3480 *
3481 * @param name The name of the desired item.
3482 *
3483 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003484 * or null if no ArrayList<CharSequence> value was found.
3485 *
3486 * @see #putCharSequenceArrayListExtra(String, ArrayList)
3487 */
3488 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
3489 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
3490 }
3491
3492 /**
3493 * Retrieve extended data from the intent.
3494 *
3495 * @param name The name of the desired item.
3496 *
3497 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003498 * or null if no boolean array value was found.
3499 *
3500 * @see #putExtra(String, boolean[])
3501 */
3502 public boolean[] getBooleanArrayExtra(String name) {
3503 return mExtras == null ? null : mExtras.getBooleanArray(name);
3504 }
3505
3506 /**
3507 * Retrieve extended data from the intent.
3508 *
3509 * @param name The name of the desired item.
3510 *
3511 * @return the value of an item that previously added with putExtra()
3512 * or null if no byte array value was found.
3513 *
3514 * @see #putExtra(String, byte[])
3515 */
3516 public byte[] getByteArrayExtra(String name) {
3517 return mExtras == null ? null : mExtras.getByteArray(name);
3518 }
3519
3520 /**
3521 * Retrieve extended data from the intent.
3522 *
3523 * @param name The name of the desired item.
3524 *
3525 * @return the value of an item that previously added with putExtra()
3526 * or null if no short array value was found.
3527 *
3528 * @see #putExtra(String, short[])
3529 */
3530 public short[] getShortArrayExtra(String name) {
3531 return mExtras == null ? null : mExtras.getShortArray(name);
3532 }
3533
3534 /**
3535 * Retrieve extended data from the intent.
3536 *
3537 * @param name The name of the desired item.
3538 *
3539 * @return the value of an item that previously added with putExtra()
3540 * or null if no char array value was found.
3541 *
3542 * @see #putExtra(String, char[])
3543 */
3544 public char[] getCharArrayExtra(String name) {
3545 return mExtras == null ? null : mExtras.getCharArray(name);
3546 }
3547
3548 /**
3549 * Retrieve extended data from the intent.
3550 *
3551 * @param name The name of the desired item.
3552 *
3553 * @return the value of an item that previously added with putExtra()
3554 * or null if no int array value was found.
3555 *
3556 * @see #putExtra(String, int[])
3557 */
3558 public int[] getIntArrayExtra(String name) {
3559 return mExtras == null ? null : mExtras.getIntArray(name);
3560 }
3561
3562 /**
3563 * Retrieve extended data from the intent.
3564 *
3565 * @param name The name of the desired item.
3566 *
3567 * @return the value of an item that previously added with putExtra()
3568 * or null if no long array value was found.
3569 *
3570 * @see #putExtra(String, long[])
3571 */
3572 public long[] getLongArrayExtra(String name) {
3573 return mExtras == null ? null : mExtras.getLongArray(name);
3574 }
3575
3576 /**
3577 * Retrieve extended data from the intent.
3578 *
3579 * @param name The name of the desired item.
3580 *
3581 * @return the value of an item that previously added with putExtra()
3582 * or null if no float array value was found.
3583 *
3584 * @see #putExtra(String, float[])
3585 */
3586 public float[] getFloatArrayExtra(String name) {
3587 return mExtras == null ? null : mExtras.getFloatArray(name);
3588 }
3589
3590 /**
3591 * Retrieve extended data from the intent.
3592 *
3593 * @param name The name of the desired item.
3594 *
3595 * @return the value of an item that previously added with putExtra()
3596 * or null if no double array value was found.
3597 *
3598 * @see #putExtra(String, double[])
3599 */
3600 public double[] getDoubleArrayExtra(String name) {
3601 return mExtras == null ? null : mExtras.getDoubleArray(name);
3602 }
3603
3604 /**
3605 * Retrieve extended data from the intent.
3606 *
3607 * @param name The name of the desired item.
3608 *
3609 * @return the value of an item that previously added with putExtra()
3610 * or null if no String array value was found.
3611 *
3612 * @see #putExtra(String, String[])
3613 */
3614 public String[] getStringArrayExtra(String name) {
3615 return mExtras == null ? null : mExtras.getStringArray(name);
3616 }
3617
3618 /**
3619 * Retrieve extended data from the intent.
3620 *
3621 * @param name The name of the desired item.
3622 *
3623 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003624 * or null if no CharSequence array value was found.
3625 *
3626 * @see #putExtra(String, CharSequence[])
3627 */
3628 public CharSequence[] getCharSequenceArrayExtra(String name) {
3629 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
3630 }
3631
3632 /**
3633 * Retrieve extended data from the intent.
3634 *
3635 * @param name The name of the desired item.
3636 *
3637 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003638 * or null if no Bundle value was found.
3639 *
3640 * @see #putExtra(String, Bundle)
3641 */
3642 public Bundle getBundleExtra(String name) {
3643 return mExtras == null ? null : mExtras.getBundle(name);
3644 }
3645
3646 /**
3647 * Retrieve extended data from the intent.
3648 *
3649 * @param name The name of the desired item.
3650 *
3651 * @return the value of an item that previously added with putExtra()
3652 * or null if no IBinder value was found.
3653 *
3654 * @see #putExtra(String, IBinder)
3655 *
3656 * @deprecated
3657 * @hide
3658 */
3659 @Deprecated
3660 public IBinder getIBinderExtra(String name) {
3661 return mExtras == null ? null : mExtras.getIBinder(name);
3662 }
3663
3664 /**
3665 * Retrieve extended data from the intent.
3666 *
3667 * @param name The name of the desired item.
3668 * @param defaultValue The default value to return in case no item is
3669 * associated with the key 'name'
3670 *
3671 * @return the value of an item that previously added with putExtra()
3672 * or defaultValue if none was found.
3673 *
3674 * @see #putExtra
3675 *
3676 * @deprecated
3677 * @hide
3678 */
3679 @Deprecated
3680 public Object getExtra(String name, Object defaultValue) {
3681 Object result = defaultValue;
3682 if (mExtras != null) {
3683 Object result2 = mExtras.get(name);
3684 if (result2 != null) {
3685 result = result2;
3686 }
3687 }
3688
3689 return result;
3690 }
3691
3692 /**
3693 * Retrieves a map of extended data from the intent.
3694 *
3695 * @return the map of all extras previously added with putExtra(),
3696 * or null if none have been added.
3697 */
3698 public Bundle getExtras() {
3699 return (mExtras != null)
3700 ? new Bundle(mExtras)
3701 : null;
3702 }
3703
3704 /**
3705 * Retrieve any special flags associated with this intent. You will
3706 * normally just set them with {@link #setFlags} and let the system
3707 * take the appropriate action with them.
3708 *
3709 * @return int The currently set flags.
3710 *
3711 * @see #setFlags
3712 */
3713 public int getFlags() {
3714 return mFlags;
3715 }
3716
3717 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003718 * Retrieve the application package name this Intent is limited to. When
3719 * resolving an Intent, if non-null this limits the resolution to only
3720 * components in the given application package.
3721 *
3722 * @return The name of the application package for the Intent.
3723 *
3724 * @see #resolveActivity
3725 * @see #setPackage
3726 */
3727 public String getPackage() {
3728 return mPackage;
3729 }
3730
3731 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003732 * Retrieve the concrete component associated with the intent. When receiving
3733 * an intent, this is the component that was found to best handle it (that is,
3734 * yourself) and will always be non-null; in all other cases it will be
3735 * null unless explicitly set.
3736 *
3737 * @return The name of the application component to handle the intent.
3738 *
3739 * @see #resolveActivity
3740 * @see #setComponent
3741 */
3742 public ComponentName getComponent() {
3743 return mComponent;
3744 }
3745
3746 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003747 * Get the bounds of the sender of this intent, in screen coordinates. This can be
3748 * used as a hint to the receiver for animations and the like. Null means that there
3749 * is no source bounds.
3750 */
3751 public Rect getSourceBounds() {
3752 return mSourceBounds;
3753 }
3754
3755 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003756 * Return the Activity component that should be used to handle this intent.
3757 * The appropriate component is determined based on the information in the
3758 * intent, evaluated as follows:
3759 *
3760 * <p>If {@link #getComponent} returns an explicit class, that is returned
3761 * without any further consideration.
3762 *
3763 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3764 * category to be considered.
3765 *
3766 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3767 * action.
3768 *
3769 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3770 * this type.
3771 *
3772 * <p>If {@link #addCategory} has added any categories, the activity must
3773 * handle ALL of the categories specified.
3774 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003775 * <p>If {@link #getPackage} is non-NULL, only activity components in
3776 * that application package will be considered.
3777 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003778 * <p>If there are no activities that satisfy all of these conditions, a
3779 * null string is returned.
3780 *
3781 * <p>If multiple activities are found to satisfy the intent, the one with
3782 * the highest priority will be used. If there are multiple activities
3783 * with the same priority, the system will either pick the best activity
3784 * based on user preference, or resolve to a system class that will allow
3785 * the user to pick an activity and forward from there.
3786 *
3787 * <p>This method is implemented simply by calling
3788 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3789 * true.</p>
3790 * <p> This API is called for you as part of starting an activity from an
3791 * intent. You do not normally need to call it yourself.</p>
3792 *
3793 * @param pm The package manager with which to resolve the Intent.
3794 *
3795 * @return Name of the component implementing an activity that can
3796 * display the intent.
3797 *
3798 * @see #setComponent
3799 * @see #getComponent
3800 * @see #resolveActivityInfo
3801 */
3802 public ComponentName resolveActivity(PackageManager pm) {
3803 if (mComponent != null) {
3804 return mComponent;
3805 }
3806
3807 ResolveInfo info = pm.resolveActivity(
3808 this, PackageManager.MATCH_DEFAULT_ONLY);
3809 if (info != null) {
3810 return new ComponentName(
3811 info.activityInfo.applicationInfo.packageName,
3812 info.activityInfo.name);
3813 }
3814
3815 return null;
3816 }
3817
3818 /**
3819 * Resolve the Intent into an {@link ActivityInfo}
3820 * describing the activity that should execute the intent. Resolution
3821 * follows the same rules as described for {@link #resolveActivity}, but
3822 * you get back the completely information about the resolved activity
3823 * instead of just its class name.
3824 *
3825 * @param pm The package manager with which to resolve the Intent.
3826 * @param flags Addition information to retrieve as per
3827 * {@link PackageManager#getActivityInfo(ComponentName, int)
3828 * PackageManager.getActivityInfo()}.
3829 *
3830 * @return PackageManager.ActivityInfo
3831 *
3832 * @see #resolveActivity
3833 */
3834 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3835 ActivityInfo ai = null;
3836 if (mComponent != null) {
3837 try {
3838 ai = pm.getActivityInfo(mComponent, flags);
3839 } catch (PackageManager.NameNotFoundException e) {
3840 // ignore
3841 }
3842 } else {
3843 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003844 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003845 if (info != null) {
3846 ai = info.activityInfo;
3847 }
3848 }
3849
3850 return ai;
3851 }
3852
3853 /**
3854 * Set the general action to be performed.
3855 *
3856 * @param action An action name, such as ACTION_VIEW. Application-specific
3857 * actions should be prefixed with the vendor's package name.
3858 *
3859 * @return Returns the same Intent object, for chaining multiple calls
3860 * into a single statement.
3861 *
3862 * @see #getAction
3863 */
3864 public Intent setAction(String action) {
3865 mAction = action;
3866 return this;
3867 }
3868
3869 /**
3870 * Set the data this intent is operating on. This method automatically
3871 * clears any type that was previously set by {@link #setType}.
3872 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003873 * <p><em>Note: scheme and host name matching in the Android framework is
3874 * case-sensitive, unlike the formal RFC. As a result,
3875 * you should always ensure that you write your Uri with these elements
3876 * using lower case letters, and normalize any Uris you receive from
3877 * outside of Android to ensure the scheme and host is lower case.</em></p>
3878 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003879 * @param data The URI of the data this intent is now targeting.
3880 *
3881 * @return Returns the same Intent object, for chaining multiple calls
3882 * into a single statement.
3883 *
3884 * @see #getData
3885 * @see #setType
3886 * @see #setDataAndType
3887 */
3888 public Intent setData(Uri data) {
3889 mData = data;
3890 mType = null;
3891 return this;
3892 }
3893
3894 /**
3895 * Set an explicit MIME data type. This is used to create intents that
3896 * only specify a type and not data, for example to indicate the type of
3897 * data to return. This method automatically clears any data that was
3898 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07003899 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003900 * <p><em>Note: MIME type matching in the Android framework is
3901 * case-sensitive, unlike formal RFC MIME types. As a result,
3902 * you should always write your MIME types with lower case letters,
3903 * and any MIME types you receive from outside of Android should be
3904 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003905 *
3906 * @param type The MIME type of the data being handled by this intent.
3907 *
3908 * @return Returns the same Intent object, for chaining multiple calls
3909 * into a single statement.
3910 *
3911 * @see #getType
3912 * @see #setData
3913 * @see #setDataAndType
3914 */
3915 public Intent setType(String type) {
3916 mData = null;
3917 mType = type;
3918 return this;
3919 }
3920
3921 /**
3922 * (Usually optional) Set the data for the intent along with an explicit
3923 * MIME data type. This method should very rarely be used -- it allows you
3924 * to override the MIME type that would ordinarily be inferred from the
3925 * data with your own type given here.
3926 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003927 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3928 * Android framework is case-sensitive, unlike the formal RFC definitions.
3929 * As a result, you should always write these elements with lower case letters,
3930 * and normalize any MIME types or Uris you receive from
3931 * outside of Android to ensure these elements are lower case before
3932 * supplying them here.</em></p>
3933 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003934 * @param data The URI of the data this intent is now targeting.
3935 * @param type The MIME type of the data being handled by this intent.
3936 *
3937 * @return Returns the same Intent object, for chaining multiple calls
3938 * into a single statement.
3939 *
3940 * @see #setData
3941 * @see #setType
3942 */
3943 public Intent setDataAndType(Uri data, String type) {
3944 mData = data;
3945 mType = type;
3946 return this;
3947 }
3948
3949 /**
3950 * Add a new category to the intent. Categories provide additional detail
3951 * about the action the intent is perform. When resolving an intent, only
3952 * activities that provide <em>all</em> of the requested categories will be
3953 * used.
3954 *
3955 * @param category The desired category. This can be either one of the
3956 * predefined Intent categories, or a custom category in your own
3957 * namespace.
3958 *
3959 * @return Returns the same Intent object, for chaining multiple calls
3960 * into a single statement.
3961 *
3962 * @see #hasCategory
3963 * @see #removeCategory
3964 */
3965 public Intent addCategory(String category) {
3966 if (mCategories == null) {
3967 mCategories = new HashSet<String>();
3968 }
3969 mCategories.add(category);
3970 return this;
3971 }
3972
3973 /**
3974 * Remove an category from an intent.
3975 *
3976 * @param category The category to remove.
3977 *
3978 * @see #addCategory
3979 */
3980 public void removeCategory(String category) {
3981 if (mCategories != null) {
3982 mCategories.remove(category);
3983 if (mCategories.size() == 0) {
3984 mCategories = null;
3985 }
3986 }
3987 }
3988
3989 /**
3990 * Add extended data to the intent. The name must include a package
3991 * prefix, for example the app com.android.contacts would use names
3992 * like "com.android.contacts.ShowAll".
3993 *
3994 * @param name The name of the extra data, with package prefix.
3995 * @param value The boolean data value.
3996 *
3997 * @return Returns the same Intent object, for chaining multiple calls
3998 * into a single statement.
3999 *
4000 * @see #putExtras
4001 * @see #removeExtra
4002 * @see #getBooleanExtra(String, boolean)
4003 */
4004 public Intent putExtra(String name, boolean value) {
4005 if (mExtras == null) {
4006 mExtras = new Bundle();
4007 }
4008 mExtras.putBoolean(name, value);
4009 return this;
4010 }
4011
4012 /**
4013 * Add extended data to the intent. The name must include a package
4014 * prefix, for example the app com.android.contacts would use names
4015 * like "com.android.contacts.ShowAll".
4016 *
4017 * @param name The name of the extra data, with package prefix.
4018 * @param value The byte data value.
4019 *
4020 * @return Returns the same Intent object, for chaining multiple calls
4021 * into a single statement.
4022 *
4023 * @see #putExtras
4024 * @see #removeExtra
4025 * @see #getByteExtra(String, byte)
4026 */
4027 public Intent putExtra(String name, byte value) {
4028 if (mExtras == null) {
4029 mExtras = new Bundle();
4030 }
4031 mExtras.putByte(name, value);
4032 return this;
4033 }
4034
4035 /**
4036 * Add extended data to the intent. The name must include a package
4037 * prefix, for example the app com.android.contacts would use names
4038 * like "com.android.contacts.ShowAll".
4039 *
4040 * @param name The name of the extra data, with package prefix.
4041 * @param value The char data value.
4042 *
4043 * @return Returns the same Intent object, for chaining multiple calls
4044 * into a single statement.
4045 *
4046 * @see #putExtras
4047 * @see #removeExtra
4048 * @see #getCharExtra(String, char)
4049 */
4050 public Intent putExtra(String name, char value) {
4051 if (mExtras == null) {
4052 mExtras = new Bundle();
4053 }
4054 mExtras.putChar(name, value);
4055 return this;
4056 }
4057
4058 /**
4059 * Add extended data to the intent. The name must include a package
4060 * prefix, for example the app com.android.contacts would use names
4061 * like "com.android.contacts.ShowAll".
4062 *
4063 * @param name The name of the extra data, with package prefix.
4064 * @param value The short data value.
4065 *
4066 * @return Returns the same Intent object, for chaining multiple calls
4067 * into a single statement.
4068 *
4069 * @see #putExtras
4070 * @see #removeExtra
4071 * @see #getShortExtra(String, short)
4072 */
4073 public Intent putExtra(String name, short value) {
4074 if (mExtras == null) {
4075 mExtras = new Bundle();
4076 }
4077 mExtras.putShort(name, value);
4078 return this;
4079 }
4080
4081 /**
4082 * Add extended data to the intent. The name must include a package
4083 * prefix, for example the app com.android.contacts would use names
4084 * like "com.android.contacts.ShowAll".
4085 *
4086 * @param name The name of the extra data, with package prefix.
4087 * @param value The integer data value.
4088 *
4089 * @return Returns the same Intent object, for chaining multiple calls
4090 * into a single statement.
4091 *
4092 * @see #putExtras
4093 * @see #removeExtra
4094 * @see #getIntExtra(String, int)
4095 */
4096 public Intent putExtra(String name, int value) {
4097 if (mExtras == null) {
4098 mExtras = new Bundle();
4099 }
4100 mExtras.putInt(name, value);
4101 return this;
4102 }
4103
4104 /**
4105 * Add extended data to the intent. The name must include a package
4106 * prefix, for example the app com.android.contacts would use names
4107 * like "com.android.contacts.ShowAll".
4108 *
4109 * @param name The name of the extra data, with package prefix.
4110 * @param value The long data value.
4111 *
4112 * @return Returns the same Intent object, for chaining multiple calls
4113 * into a single statement.
4114 *
4115 * @see #putExtras
4116 * @see #removeExtra
4117 * @see #getLongExtra(String, long)
4118 */
4119 public Intent putExtra(String name, long value) {
4120 if (mExtras == null) {
4121 mExtras = new Bundle();
4122 }
4123 mExtras.putLong(name, value);
4124 return this;
4125 }
4126
4127 /**
4128 * Add extended data to the intent. The name must include a package
4129 * prefix, for example the app com.android.contacts would use names
4130 * like "com.android.contacts.ShowAll".
4131 *
4132 * @param name The name of the extra data, with package prefix.
4133 * @param value The float data value.
4134 *
4135 * @return Returns the same Intent object, for chaining multiple calls
4136 * into a single statement.
4137 *
4138 * @see #putExtras
4139 * @see #removeExtra
4140 * @see #getFloatExtra(String, float)
4141 */
4142 public Intent putExtra(String name, float value) {
4143 if (mExtras == null) {
4144 mExtras = new Bundle();
4145 }
4146 mExtras.putFloat(name, value);
4147 return this;
4148 }
4149
4150 /**
4151 * Add extended data to the intent. The name must include a package
4152 * prefix, for example the app com.android.contacts would use names
4153 * like "com.android.contacts.ShowAll".
4154 *
4155 * @param name The name of the extra data, with package prefix.
4156 * @param value The double data value.
4157 *
4158 * @return Returns the same Intent object, for chaining multiple calls
4159 * into a single statement.
4160 *
4161 * @see #putExtras
4162 * @see #removeExtra
4163 * @see #getDoubleExtra(String, double)
4164 */
4165 public Intent putExtra(String name, double value) {
4166 if (mExtras == null) {
4167 mExtras = new Bundle();
4168 }
4169 mExtras.putDouble(name, value);
4170 return this;
4171 }
4172
4173 /**
4174 * Add extended data to the intent. The name must include a package
4175 * prefix, for example the app com.android.contacts would use names
4176 * like "com.android.contacts.ShowAll".
4177 *
4178 * @param name The name of the extra data, with package prefix.
4179 * @param value The String data value.
4180 *
4181 * @return Returns the same Intent object, for chaining multiple calls
4182 * into a single statement.
4183 *
4184 * @see #putExtras
4185 * @see #removeExtra
4186 * @see #getStringExtra(String)
4187 */
4188 public Intent putExtra(String name, String value) {
4189 if (mExtras == null) {
4190 mExtras = new Bundle();
4191 }
4192 mExtras.putString(name, value);
4193 return this;
4194 }
4195
4196 /**
4197 * Add extended data to the intent. The name must include a package
4198 * prefix, for example the app com.android.contacts would use names
4199 * like "com.android.contacts.ShowAll".
4200 *
4201 * @param name The name of the extra data, with package prefix.
4202 * @param value The CharSequence data value.
4203 *
4204 * @return Returns the same Intent object, for chaining multiple calls
4205 * into a single statement.
4206 *
4207 * @see #putExtras
4208 * @see #removeExtra
4209 * @see #getCharSequenceExtra(String)
4210 */
4211 public Intent putExtra(String name, CharSequence value) {
4212 if (mExtras == null) {
4213 mExtras = new Bundle();
4214 }
4215 mExtras.putCharSequence(name, value);
4216 return this;
4217 }
4218
4219 /**
4220 * Add extended data to the intent. The name must include a package
4221 * prefix, for example the app com.android.contacts would use names
4222 * like "com.android.contacts.ShowAll".
4223 *
4224 * @param name The name of the extra data, with package prefix.
4225 * @param value The Parcelable data value.
4226 *
4227 * @return Returns the same Intent object, for chaining multiple calls
4228 * into a single statement.
4229 *
4230 * @see #putExtras
4231 * @see #removeExtra
4232 * @see #getParcelableExtra(String)
4233 */
4234 public Intent putExtra(String name, Parcelable value) {
4235 if (mExtras == null) {
4236 mExtras = new Bundle();
4237 }
4238 mExtras.putParcelable(name, value);
4239 return this;
4240 }
4241
4242 /**
4243 * Add extended data to the intent. The name must include a package
4244 * prefix, for example the app com.android.contacts would use names
4245 * like "com.android.contacts.ShowAll".
4246 *
4247 * @param name The name of the extra data, with package prefix.
4248 * @param value The Parcelable[] data value.
4249 *
4250 * @return Returns the same Intent object, for chaining multiple calls
4251 * into a single statement.
4252 *
4253 * @see #putExtras
4254 * @see #removeExtra
4255 * @see #getParcelableArrayExtra(String)
4256 */
4257 public Intent putExtra(String name, Parcelable[] value) {
4258 if (mExtras == null) {
4259 mExtras = new Bundle();
4260 }
4261 mExtras.putParcelableArray(name, value);
4262 return this;
4263 }
4264
4265 /**
4266 * Add extended data to the intent. The name must include a package
4267 * prefix, for example the app com.android.contacts would use names
4268 * like "com.android.contacts.ShowAll".
4269 *
4270 * @param name The name of the extra data, with package prefix.
4271 * @param value The ArrayList<Parcelable> data value.
4272 *
4273 * @return Returns the same Intent object, for chaining multiple calls
4274 * into a single statement.
4275 *
4276 * @see #putExtras
4277 * @see #removeExtra
4278 * @see #getParcelableArrayListExtra(String)
4279 */
4280 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4281 if (mExtras == null) {
4282 mExtras = new Bundle();
4283 }
4284 mExtras.putParcelableArrayList(name, value);
4285 return this;
4286 }
4287
4288 /**
4289 * Add extended data to the intent. The name must include a package
4290 * prefix, for example the app com.android.contacts would use names
4291 * like "com.android.contacts.ShowAll".
4292 *
4293 * @param name The name of the extra data, with package prefix.
4294 * @param value The ArrayList<Integer> data value.
4295 *
4296 * @return Returns the same Intent object, for chaining multiple calls
4297 * into a single statement.
4298 *
4299 * @see #putExtras
4300 * @see #removeExtra
4301 * @see #getIntegerArrayListExtra(String)
4302 */
4303 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4304 if (mExtras == null) {
4305 mExtras = new Bundle();
4306 }
4307 mExtras.putIntegerArrayList(name, value);
4308 return this;
4309 }
4310
4311 /**
4312 * Add extended data to the intent. The name must include a package
4313 * prefix, for example the app com.android.contacts would use names
4314 * like "com.android.contacts.ShowAll".
4315 *
4316 * @param name The name of the extra data, with package prefix.
4317 * @param value The ArrayList<String> data value.
4318 *
4319 * @return Returns the same Intent object, for chaining multiple calls
4320 * into a single statement.
4321 *
4322 * @see #putExtras
4323 * @see #removeExtra
4324 * @see #getStringArrayListExtra(String)
4325 */
4326 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4327 if (mExtras == null) {
4328 mExtras = new Bundle();
4329 }
4330 mExtras.putStringArrayList(name, value);
4331 return this;
4332 }
4333
4334 /**
4335 * Add extended data to the intent. The name must include a package
4336 * prefix, for example the app com.android.contacts would use names
4337 * like "com.android.contacts.ShowAll".
4338 *
4339 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004340 * @param value The ArrayList<CharSequence> data value.
4341 *
4342 * @return Returns the same Intent object, for chaining multiple calls
4343 * into a single statement.
4344 *
4345 * @see #putExtras
4346 * @see #removeExtra
4347 * @see #getCharSequenceArrayListExtra(String)
4348 */
4349 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
4350 if (mExtras == null) {
4351 mExtras = new Bundle();
4352 }
4353 mExtras.putCharSequenceArrayList(name, value);
4354 return this;
4355 }
4356
4357 /**
4358 * Add extended data to the intent. The name must include a package
4359 * prefix, for example the app com.android.contacts would use names
4360 * like "com.android.contacts.ShowAll".
4361 *
4362 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004363 * @param value The Serializable data value.
4364 *
4365 * @return Returns the same Intent object, for chaining multiple calls
4366 * into a single statement.
4367 *
4368 * @see #putExtras
4369 * @see #removeExtra
4370 * @see #getSerializableExtra(String)
4371 */
4372 public Intent putExtra(String name, Serializable value) {
4373 if (mExtras == null) {
4374 mExtras = new Bundle();
4375 }
4376 mExtras.putSerializable(name, value);
4377 return this;
4378 }
4379
4380 /**
4381 * Add extended data to the intent. The name must include a package
4382 * prefix, for example the app com.android.contacts would use names
4383 * like "com.android.contacts.ShowAll".
4384 *
4385 * @param name The name of the extra data, with package prefix.
4386 * @param value The boolean array data value.
4387 *
4388 * @return Returns the same Intent object, for chaining multiple calls
4389 * into a single statement.
4390 *
4391 * @see #putExtras
4392 * @see #removeExtra
4393 * @see #getBooleanArrayExtra(String)
4394 */
4395 public Intent putExtra(String name, boolean[] value) {
4396 if (mExtras == null) {
4397 mExtras = new Bundle();
4398 }
4399 mExtras.putBooleanArray(name, value);
4400 return this;
4401 }
4402
4403 /**
4404 * Add extended data to the intent. The name must include a package
4405 * prefix, for example the app com.android.contacts would use names
4406 * like "com.android.contacts.ShowAll".
4407 *
4408 * @param name The name of the extra data, with package prefix.
4409 * @param value The byte array data value.
4410 *
4411 * @return Returns the same Intent object, for chaining multiple calls
4412 * into a single statement.
4413 *
4414 * @see #putExtras
4415 * @see #removeExtra
4416 * @see #getByteArrayExtra(String)
4417 */
4418 public Intent putExtra(String name, byte[] value) {
4419 if (mExtras == null) {
4420 mExtras = new Bundle();
4421 }
4422 mExtras.putByteArray(name, value);
4423 return this;
4424 }
4425
4426 /**
4427 * Add extended data to the intent. The name must include a package
4428 * prefix, for example the app com.android.contacts would use names
4429 * like "com.android.contacts.ShowAll".
4430 *
4431 * @param name The name of the extra data, with package prefix.
4432 * @param value The short array data value.
4433 *
4434 * @return Returns the same Intent object, for chaining multiple calls
4435 * into a single statement.
4436 *
4437 * @see #putExtras
4438 * @see #removeExtra
4439 * @see #getShortArrayExtra(String)
4440 */
4441 public Intent putExtra(String name, short[] value) {
4442 if (mExtras == null) {
4443 mExtras = new Bundle();
4444 }
4445 mExtras.putShortArray(name, value);
4446 return this;
4447 }
4448
4449 /**
4450 * Add extended data to the intent. The name must include a package
4451 * prefix, for example the app com.android.contacts would use names
4452 * like "com.android.contacts.ShowAll".
4453 *
4454 * @param name The name of the extra data, with package prefix.
4455 * @param value The char array data value.
4456 *
4457 * @return Returns the same Intent object, for chaining multiple calls
4458 * into a single statement.
4459 *
4460 * @see #putExtras
4461 * @see #removeExtra
4462 * @see #getCharArrayExtra(String)
4463 */
4464 public Intent putExtra(String name, char[] value) {
4465 if (mExtras == null) {
4466 mExtras = new Bundle();
4467 }
4468 mExtras.putCharArray(name, value);
4469 return this;
4470 }
4471
4472 /**
4473 * Add extended data to the intent. The name must include a package
4474 * prefix, for example the app com.android.contacts would use names
4475 * like "com.android.contacts.ShowAll".
4476 *
4477 * @param name The name of the extra data, with package prefix.
4478 * @param value The int array data value.
4479 *
4480 * @return Returns the same Intent object, for chaining multiple calls
4481 * into a single statement.
4482 *
4483 * @see #putExtras
4484 * @see #removeExtra
4485 * @see #getIntArrayExtra(String)
4486 */
4487 public Intent putExtra(String name, int[] value) {
4488 if (mExtras == null) {
4489 mExtras = new Bundle();
4490 }
4491 mExtras.putIntArray(name, value);
4492 return this;
4493 }
4494
4495 /**
4496 * Add extended data to the intent. The name must include a package
4497 * prefix, for example the app com.android.contacts would use names
4498 * like "com.android.contacts.ShowAll".
4499 *
4500 * @param name The name of the extra data, with package prefix.
4501 * @param value The byte array data value.
4502 *
4503 * @return Returns the same Intent object, for chaining multiple calls
4504 * into a single statement.
4505 *
4506 * @see #putExtras
4507 * @see #removeExtra
4508 * @see #getLongArrayExtra(String)
4509 */
4510 public Intent putExtra(String name, long[] value) {
4511 if (mExtras == null) {
4512 mExtras = new Bundle();
4513 }
4514 mExtras.putLongArray(name, value);
4515 return this;
4516 }
4517
4518 /**
4519 * Add extended data to the intent. The name must include a package
4520 * prefix, for example the app com.android.contacts would use names
4521 * like "com.android.contacts.ShowAll".
4522 *
4523 * @param name The name of the extra data, with package prefix.
4524 * @param value The float array data value.
4525 *
4526 * @return Returns the same Intent object, for chaining multiple calls
4527 * into a single statement.
4528 *
4529 * @see #putExtras
4530 * @see #removeExtra
4531 * @see #getFloatArrayExtra(String)
4532 */
4533 public Intent putExtra(String name, float[] value) {
4534 if (mExtras == null) {
4535 mExtras = new Bundle();
4536 }
4537 mExtras.putFloatArray(name, value);
4538 return this;
4539 }
4540
4541 /**
4542 * Add extended data to the intent. The name must include a package
4543 * prefix, for example the app com.android.contacts would use names
4544 * like "com.android.contacts.ShowAll".
4545 *
4546 * @param name The name of the extra data, with package prefix.
4547 * @param value The double array data value.
4548 *
4549 * @return Returns the same Intent object, for chaining multiple calls
4550 * into a single statement.
4551 *
4552 * @see #putExtras
4553 * @see #removeExtra
4554 * @see #getDoubleArrayExtra(String)
4555 */
4556 public Intent putExtra(String name, double[] value) {
4557 if (mExtras == null) {
4558 mExtras = new Bundle();
4559 }
4560 mExtras.putDoubleArray(name, value);
4561 return this;
4562 }
4563
4564 /**
4565 * Add extended data to the intent. The name must include a package
4566 * prefix, for example the app com.android.contacts would use names
4567 * like "com.android.contacts.ShowAll".
4568 *
4569 * @param name The name of the extra data, with package prefix.
4570 * @param value The String array data value.
4571 *
4572 * @return Returns the same Intent object, for chaining multiple calls
4573 * into a single statement.
4574 *
4575 * @see #putExtras
4576 * @see #removeExtra
4577 * @see #getStringArrayExtra(String)
4578 */
4579 public Intent putExtra(String name, String[] value) {
4580 if (mExtras == null) {
4581 mExtras = new Bundle();
4582 }
4583 mExtras.putStringArray(name, value);
4584 return this;
4585 }
4586
4587 /**
4588 * Add extended data to the intent. The name must include a package
4589 * prefix, for example the app com.android.contacts would use names
4590 * like "com.android.contacts.ShowAll".
4591 *
4592 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004593 * @param value The CharSequence array data value.
4594 *
4595 * @return Returns the same Intent object, for chaining multiple calls
4596 * into a single statement.
4597 *
4598 * @see #putExtras
4599 * @see #removeExtra
4600 * @see #getCharSequenceArrayExtra(String)
4601 */
4602 public Intent putExtra(String name, CharSequence[] value) {
4603 if (mExtras == null) {
4604 mExtras = new Bundle();
4605 }
4606 mExtras.putCharSequenceArray(name, value);
4607 return this;
4608 }
4609
4610 /**
4611 * Add extended data to the intent. The name must include a package
4612 * prefix, for example the app com.android.contacts would use names
4613 * like "com.android.contacts.ShowAll".
4614 *
4615 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004616 * @param value The Bundle data value.
4617 *
4618 * @return Returns the same Intent object, for chaining multiple calls
4619 * into a single statement.
4620 *
4621 * @see #putExtras
4622 * @see #removeExtra
4623 * @see #getBundleExtra(String)
4624 */
4625 public Intent putExtra(String name, Bundle value) {
4626 if (mExtras == null) {
4627 mExtras = new Bundle();
4628 }
4629 mExtras.putBundle(name, value);
4630 return this;
4631 }
4632
4633 /**
4634 * Add extended data to the intent. The name must include a package
4635 * prefix, for example the app com.android.contacts would use names
4636 * like "com.android.contacts.ShowAll".
4637 *
4638 * @param name The name of the extra data, with package prefix.
4639 * @param value The IBinder data value.
4640 *
4641 * @return Returns the same Intent object, for chaining multiple calls
4642 * into a single statement.
4643 *
4644 * @see #putExtras
4645 * @see #removeExtra
4646 * @see #getIBinderExtra(String)
4647 *
4648 * @deprecated
4649 * @hide
4650 */
4651 @Deprecated
4652 public Intent putExtra(String name, IBinder value) {
4653 if (mExtras == null) {
4654 mExtras = new Bundle();
4655 }
4656 mExtras.putIBinder(name, value);
4657 return this;
4658 }
4659
4660 /**
4661 * Copy all extras in 'src' in to this intent.
4662 *
4663 * @param src Contains the extras to copy.
4664 *
4665 * @see #putExtra
4666 */
4667 public Intent putExtras(Intent src) {
4668 if (src.mExtras != null) {
4669 if (mExtras == null) {
4670 mExtras = new Bundle(src.mExtras);
4671 } else {
4672 mExtras.putAll(src.mExtras);
4673 }
4674 }
4675 return this;
4676 }
4677
4678 /**
4679 * Add a set of extended data to the intent. The keys must include a package
4680 * prefix, for example the app com.android.contacts would use names
4681 * like "com.android.contacts.ShowAll".
4682 *
4683 * @param extras The Bundle of extras to add to this intent.
4684 *
4685 * @see #putExtra
4686 * @see #removeExtra
4687 */
4688 public Intent putExtras(Bundle extras) {
4689 if (mExtras == null) {
4690 mExtras = new Bundle();
4691 }
4692 mExtras.putAll(extras);
4693 return this;
4694 }
4695
4696 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004697 * Completely replace the extras in the Intent with the extras in the
4698 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004699 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004700 * @param src The exact extras contained in this Intent are copied
4701 * into the target intent, replacing any that were previously there.
4702 */
4703 public Intent replaceExtras(Intent src) {
4704 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4705 return this;
4706 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004707
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004708 /**
4709 * Completely replace the extras in the Intent with the given Bundle of
4710 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004711 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004712 * @param extras The new set of extras in the Intent, or null to erase
4713 * all extras.
4714 */
4715 public Intent replaceExtras(Bundle extras) {
4716 mExtras = extras != null ? new Bundle(extras) : null;
4717 return this;
4718 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004719
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004720 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004721 * Remove extended data from the intent.
4722 *
4723 * @see #putExtra
4724 */
4725 public void removeExtra(String name) {
4726 if (mExtras != null) {
4727 mExtras.remove(name);
4728 if (mExtras.size() == 0) {
4729 mExtras = null;
4730 }
4731 }
4732 }
4733
4734 /**
4735 * Set special flags controlling how this intent is handled. Most values
4736 * here depend on the type of component being executed by the Intent,
4737 * specifically the FLAG_ACTIVITY_* flags are all for use with
4738 * {@link Context#startActivity Context.startActivity()} and the
4739 * FLAG_RECEIVER_* flags are all for use with
4740 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4741 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004742 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4743 * 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 -07004744 * the behavior of your application.
4745 *
4746 * @param flags The desired flags.
4747 *
4748 * @return Returns the same Intent object, for chaining multiple calls
4749 * into a single statement.
4750 *
4751 * @see #getFlags
4752 * @see #addFlags
4753 *
4754 * @see #FLAG_GRANT_READ_URI_PERMISSION
4755 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4756 * @see #FLAG_DEBUG_LOG_RESOLUTION
4757 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004758 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004759 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004760 * @see #FLAG_ACTIVITY_CLEAR_TOP
4761 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4762 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004763 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004764 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4765 * @see #FLAG_ACTIVITY_NEW_TASK
4766 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004767 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004768 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4769 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004770 * @see #FLAG_ACTIVITY_SINGLE_TOP
4771 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4772 */
4773 public Intent setFlags(int flags) {
4774 mFlags = flags;
4775 return this;
4776 }
4777
4778 /**
4779 * Add additional flags to the intent (or with existing flags
4780 * value).
4781 *
4782 * @param flags The new flags to set.
4783 *
4784 * @return Returns the same Intent object, for chaining multiple calls
4785 * into a single statement.
4786 *
4787 * @see #setFlags
4788 */
4789 public Intent addFlags(int flags) {
4790 mFlags |= flags;
4791 return this;
4792 }
4793
4794 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004795 * (Usually optional) Set an explicit application package name that limits
4796 * the components this Intent will resolve to. If left to the default
4797 * value of null, all components in all applications will considered.
4798 * If non-null, the Intent can only match the components in the given
4799 * application package.
4800 *
4801 * @param packageName The name of the application package to handle the
4802 * intent, or null to allow any application package.
4803 *
4804 * @return Returns the same Intent object, for chaining multiple calls
4805 * into a single statement.
4806 *
4807 * @see #getPackage
4808 * @see #resolveActivity
4809 */
4810 public Intent setPackage(String packageName) {
4811 mPackage = packageName;
4812 return this;
4813 }
4814
4815 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004816 * (Usually optional) Explicitly set the component to handle the intent.
4817 * If left with the default value of null, the system will determine the
4818 * appropriate class to use based on the other fields (action, data,
4819 * type, categories) in the Intent. If this class is defined, the
4820 * specified class will always be used regardless of the other fields. You
4821 * should only set this value when you know you absolutely want a specific
4822 * class to be used; otherwise it is better to let the system find the
4823 * appropriate class so that you will respect the installed applications
4824 * and user preferences.
4825 *
4826 * @param component The name of the application component to handle the
4827 * intent, or null to let the system find one for you.
4828 *
4829 * @return Returns the same Intent object, for chaining multiple calls
4830 * into a single statement.
4831 *
4832 * @see #setClass
4833 * @see #setClassName(Context, String)
4834 * @see #setClassName(String, String)
4835 * @see #getComponent
4836 * @see #resolveActivity
4837 */
4838 public Intent setComponent(ComponentName component) {
4839 mComponent = component;
4840 return this;
4841 }
4842
4843 /**
4844 * Convenience for calling {@link #setComponent} with an
4845 * explicit class name.
4846 *
4847 * @param packageContext A Context of the application package implementing
4848 * this class.
4849 * @param className The name of a class inside of the application package
4850 * that will be used as the component for this Intent.
4851 *
4852 * @return Returns the same Intent object, for chaining multiple calls
4853 * into a single statement.
4854 *
4855 * @see #setComponent
4856 * @see #setClass
4857 */
4858 public Intent setClassName(Context packageContext, String className) {
4859 mComponent = new ComponentName(packageContext, className);
4860 return this;
4861 }
4862
4863 /**
4864 * Convenience for calling {@link #setComponent} with an
4865 * explicit application package name and class name.
4866 *
4867 * @param packageName The name of the package implementing the desired
4868 * component.
4869 * @param className The name of a class inside of the application package
4870 * that will be used as the component for this Intent.
4871 *
4872 * @return Returns the same Intent object, for chaining multiple calls
4873 * into a single statement.
4874 *
4875 * @see #setComponent
4876 * @see #setClass
4877 */
4878 public Intent setClassName(String packageName, String className) {
4879 mComponent = new ComponentName(packageName, className);
4880 return this;
4881 }
4882
4883 /**
4884 * Convenience for calling {@link #setComponent(ComponentName)} with the
4885 * name returned by a {@link Class} object.
4886 *
4887 * @param packageContext A Context of the application package implementing
4888 * this class.
4889 * @param cls The class name to set, equivalent to
4890 * <code>setClassName(context, cls.getName())</code>.
4891 *
4892 * @return Returns the same Intent object, for chaining multiple calls
4893 * into a single statement.
4894 *
4895 * @see #setComponent
4896 */
4897 public Intent setClass(Context packageContext, Class<?> cls) {
4898 mComponent = new ComponentName(packageContext, cls);
4899 return this;
4900 }
4901
4902 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004903 * Set the bounds of the sender of this intent, in screen coordinates. This can be
4904 * used as a hint to the receiver for animations and the like. Null means that there
4905 * is no source bounds.
4906 */
4907 public void setSourceBounds(Rect r) {
4908 if (r != null) {
4909 mSourceBounds = new Rect(r);
4910 } else {
4911 r = null;
4912 }
4913 }
4914
4915 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004916 * Use with {@link #fillIn} to allow the current action value to be
4917 * overwritten, even if it is already set.
4918 */
4919 public static final int FILL_IN_ACTION = 1<<0;
4920
4921 /**
4922 * Use with {@link #fillIn} to allow the current data or type value
4923 * overwritten, even if it is already set.
4924 */
4925 public static final int FILL_IN_DATA = 1<<1;
4926
4927 /**
4928 * Use with {@link #fillIn} to allow the current categories to be
4929 * overwritten, even if they are already set.
4930 */
4931 public static final int FILL_IN_CATEGORIES = 1<<2;
4932
4933 /**
4934 * Use with {@link #fillIn} to allow the current component value to be
4935 * overwritten, even if it is already set.
4936 */
4937 public static final int FILL_IN_COMPONENT = 1<<3;
4938
4939 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004940 * Use with {@link #fillIn} to allow the current package value to be
4941 * overwritten, even if it is already set.
4942 */
4943 public static final int FILL_IN_PACKAGE = 1<<4;
4944
4945 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004946 * Use with {@link #fillIn} to allow the current package value to be
4947 * overwritten, even if it is already set.
4948 */
4949 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
4950
4951 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004952 * Copy the contents of <var>other</var> in to this object, but only
4953 * where fields are not defined by this object. For purposes of a field
4954 * being defined, the following pieces of data in the Intent are
4955 * considered to be separate fields:
4956 *
4957 * <ul>
4958 * <li> action, as set by {@link #setAction}.
4959 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4960 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4961 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004962 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004963 * <li> component, as set by {@link #setComponent(ComponentName)} or
4964 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004965 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004966 * <li> each top-level name in the associated extras.
4967 * </ul>
4968 *
4969 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004970 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4971 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004972 * corresponding field will not be replaced if it is already set.
4973 *
Brett Chabot3e391752009-07-21 16:07:23 -07004974 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
4975 * specified.
4976 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004977 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4978 * and Intent B with {action="gotit", data-type="some/thing",
4979 * categories="one","two"}.
4980 *
4981 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4982 * containing: {action="gotit", data-type="some/thing",
4983 * categories="bar"}.
4984 *
4985 * @param other Another Intent whose values are to be used to fill in
4986 * the current one.
4987 * @param flags Options to control which fields can be filled in.
4988 *
4989 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004990 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4991 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004992 */
4993 public int fillIn(Intent other, int flags) {
4994 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004995 if (other.mAction != null
4996 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004997 mAction = other.mAction;
4998 changes |= FILL_IN_ACTION;
4999 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005000 if ((other.mData != null || other.mType != null)
5001 && ((mData == null && mType == null)
5002 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005003 mData = other.mData;
5004 mType = other.mType;
5005 changes |= FILL_IN_DATA;
5006 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005007 if (other.mCategories != null
5008 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005009 if (other.mCategories != null) {
5010 mCategories = new HashSet<String>(other.mCategories);
5011 }
5012 changes |= FILL_IN_CATEGORIES;
5013 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005014 if (other.mPackage != null
5015 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
5016 mPackage = other.mPackage;
5017 changes |= FILL_IN_PACKAGE;
5018 }
5019 // Component is special: it can -only- be set if explicitly allowed,
5020 // since otherwise the sender could force the intent somewhere the
5021 // originator didn't intend.
5022 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005023 mComponent = other.mComponent;
5024 changes |= FILL_IN_COMPONENT;
5025 }
5026 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005027 if (other.mSourceBounds != null
5028 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5029 mSourceBounds = new Rect(other.mSourceBounds);
5030 changes |= FILL_IN_SOURCE_BOUNDS;
5031 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005032 if (mExtras == null) {
5033 if (other.mExtras != null) {
5034 mExtras = new Bundle(other.mExtras);
5035 }
5036 } else if (other.mExtras != null) {
5037 try {
5038 Bundle newb = new Bundle(other.mExtras);
5039 newb.putAll(mExtras);
5040 mExtras = newb;
5041 } catch (RuntimeException e) {
5042 // Modifying the extras can cause us to unparcel the contents
5043 // of the bundle, and if we do this in the system process that
5044 // may fail. We really should handle this (i.e., the Bundle
5045 // impl shouldn't be on top of a plain map), but for now just
5046 // ignore it and keep the original contents. :(
5047 Log.w("Intent", "Failure filling in extras", e);
5048 }
5049 }
5050 return changes;
5051 }
5052
5053 /**
5054 * Wrapper class holding an Intent and implementing comparisons on it for
5055 * the purpose of filtering. The class implements its
5056 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5057 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5058 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5059 * on the wrapped Intent.
5060 */
5061 public static final class FilterComparison {
5062 private final Intent mIntent;
5063 private final int mHashCode;
5064
5065 public FilterComparison(Intent intent) {
5066 mIntent = intent;
5067 mHashCode = intent.filterHashCode();
5068 }
5069
5070 /**
5071 * Return the Intent that this FilterComparison represents.
5072 * @return Returns the Intent held by the FilterComparison. Do
5073 * not modify!
5074 */
5075 public Intent getIntent() {
5076 return mIntent;
5077 }
5078
5079 @Override
5080 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005081 if (obj instanceof FilterComparison) {
5082 Intent other = ((FilterComparison)obj).mIntent;
5083 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005084 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005085 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005086 }
5087
5088 @Override
5089 public int hashCode() {
5090 return mHashCode;
5091 }
5092 }
5093
5094 /**
5095 * Determine if two intents are the same for the purposes of intent
5096 * resolution (filtering). That is, if their action, data, type,
5097 * class, and categories are the same. This does <em>not</em> compare
5098 * any extra data included in the intents.
5099 *
5100 * @param other The other Intent to compare against.
5101 *
5102 * @return Returns true if action, data, type, class, and categories
5103 * are the same.
5104 */
5105 public boolean filterEquals(Intent other) {
5106 if (other == null) {
5107 return false;
5108 }
5109 if (mAction != other.mAction) {
5110 if (mAction != null) {
5111 if (!mAction.equals(other.mAction)) {
5112 return false;
5113 }
5114 } else {
5115 if (!other.mAction.equals(mAction)) {
5116 return false;
5117 }
5118 }
5119 }
5120 if (mData != other.mData) {
5121 if (mData != null) {
5122 if (!mData.equals(other.mData)) {
5123 return false;
5124 }
5125 } else {
5126 if (!other.mData.equals(mData)) {
5127 return false;
5128 }
5129 }
5130 }
5131 if (mType != other.mType) {
5132 if (mType != null) {
5133 if (!mType.equals(other.mType)) {
5134 return false;
5135 }
5136 } else {
5137 if (!other.mType.equals(mType)) {
5138 return false;
5139 }
5140 }
5141 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005142 if (mPackage != other.mPackage) {
5143 if (mPackage != null) {
5144 if (!mPackage.equals(other.mPackage)) {
5145 return false;
5146 }
5147 } else {
5148 if (!other.mPackage.equals(mPackage)) {
5149 return false;
5150 }
5151 }
5152 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005153 if (mComponent != other.mComponent) {
5154 if (mComponent != null) {
5155 if (!mComponent.equals(other.mComponent)) {
5156 return false;
5157 }
5158 } else {
5159 if (!other.mComponent.equals(mComponent)) {
5160 return false;
5161 }
5162 }
5163 }
5164 if (mCategories != other.mCategories) {
5165 if (mCategories != null) {
5166 if (!mCategories.equals(other.mCategories)) {
5167 return false;
5168 }
5169 } else {
5170 if (!other.mCategories.equals(mCategories)) {
5171 return false;
5172 }
5173 }
5174 }
5175
5176 return true;
5177 }
5178
5179 /**
5180 * Generate hash code that matches semantics of filterEquals().
5181 *
5182 * @return Returns the hash value of the action, data, type, class, and
5183 * categories.
5184 *
5185 * @see #filterEquals
5186 */
5187 public int filterHashCode() {
5188 int code = 0;
5189 if (mAction != null) {
5190 code += mAction.hashCode();
5191 }
5192 if (mData != null) {
5193 code += mData.hashCode();
5194 }
5195 if (mType != null) {
5196 code += mType.hashCode();
5197 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005198 if (mPackage != null) {
5199 code += mPackage.hashCode();
5200 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005201 if (mComponent != null) {
5202 code += mComponent.hashCode();
5203 }
5204 if (mCategories != null) {
5205 code += mCategories.hashCode();
5206 }
5207 return code;
5208 }
5209
5210 @Override
5211 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005212 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005213
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005214 b.append("Intent { ");
5215 toShortString(b, true, true);
5216 b.append(" }");
5217
5218 return b.toString();
5219 }
5220
5221 /** @hide */
5222 public String toShortString(boolean comp, boolean extras) {
5223 StringBuilder b = new StringBuilder(128);
5224 toShortString(b, comp, extras);
5225 return b.toString();
5226 }
Romain Guy4969af72009-06-17 10:53:19 -07005227
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005228 /** @hide */
5229 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
5230 boolean first = true;
5231 if (mAction != null) {
5232 b.append("act=").append(mAction);
5233 first = false;
5234 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005235 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005236 if (!first) {
5237 b.append(' ');
5238 }
5239 first = false;
5240 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005241 Iterator<String> i = mCategories.iterator();
5242 boolean didone = false;
5243 while (i.hasNext()) {
5244 if (didone) b.append(",");
5245 didone = true;
5246 b.append(i.next());
5247 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005248 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005249 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005250 if (mData != null) {
5251 if (!first) {
5252 b.append(' ');
5253 }
5254 first = false;
5255 b.append("dat=").append(mData);
5256 }
5257 if (mType != null) {
5258 if (!first) {
5259 b.append(' ');
5260 }
5261 first = false;
5262 b.append("typ=").append(mType);
5263 }
5264 if (mFlags != 0) {
5265 if (!first) {
5266 b.append(' ');
5267 }
5268 first = false;
5269 b.append("flg=0x").append(Integer.toHexString(mFlags));
5270 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005271 if (mPackage != null) {
5272 if (!first) {
5273 b.append(' ');
5274 }
5275 first = false;
5276 b.append("pkg=").append(mPackage);
5277 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005278 if (comp && mComponent != null) {
5279 if (!first) {
5280 b.append(' ');
5281 }
5282 first = false;
5283 b.append("cmp=").append(mComponent.flattenToShortString());
5284 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005285 if (mSourceBounds != null) {
5286 if (!first) {
5287 b.append(' ');
5288 }
5289 first = false;
5290 b.append("bnds=").append(mSourceBounds.toShortString());
5291 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005292 if (extras && mExtras != null) {
5293 if (!first) {
5294 b.append(' ');
5295 }
5296 first = false;
5297 b.append("(has extras)");
5298 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005299 }
5300
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005301 /**
5302 * Call {@link #toUri} with 0 flags.
5303 * @deprecated Use {@link #toUri} instead.
5304 */
5305 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005306 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005307 return toUri(0);
5308 }
5309
5310 /**
5311 * Convert this Intent into a String holding a URI representation of it.
5312 * The returned URI string has been properly URI encoded, so it can be
5313 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5314 * Intent's data as the base URI, with an additional fragment describing
5315 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08005316 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005317 * <p>You can convert the returned string back to an Intent with
5318 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08005319 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005320 * @param flags Additional operating flags. Either 0 or
5321 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08005322 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005323 * @return Returns a URI encoding URI string describing the entire contents
5324 * of the Intent.
5325 */
5326 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005327 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005328 String scheme = null;
5329 if (mData != null) {
5330 String data = mData.toString();
5331 if ((flags&URI_INTENT_SCHEME) != 0) {
5332 final int N = data.length();
5333 for (int i=0; i<N; i++) {
5334 char c = data.charAt(i);
5335 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5336 || c == '.' || c == '-') {
5337 continue;
5338 }
5339 if (c == ':' && i > 0) {
5340 // Valid scheme.
5341 scheme = data.substring(0, i);
5342 uri.append("intent:");
5343 data = data.substring(i+1);
5344 break;
5345 }
Tom Taylord4a47292009-12-21 13:59:18 -08005346
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005347 // No scheme.
5348 break;
5349 }
5350 }
5351 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08005352
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005353 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5354 uri.append("intent:");
5355 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005356
5357 uri.append("#Intent;");
5358
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005359 if (scheme != null) {
5360 uri.append("scheme=").append(scheme).append(';');
5361 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005362 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005363 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005364 }
5365 if (mCategories != null) {
5366 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005367 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005368 }
5369 }
5370 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005371 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005372 }
5373 if (mFlags != 0) {
5374 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5375 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005376 if (mPackage != null) {
5377 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5378 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005379 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005380 uri.append("component=").append(Uri.encode(
5381 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005382 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005383 if (mSourceBounds != null) {
5384 uri.append("sourceBounds=")
5385 .append(Uri.encode(mSourceBounds.flattenToString()))
5386 .append(';');
5387 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005388 if (mExtras != null) {
5389 for (String key : mExtras.keySet()) {
5390 final Object value = mExtras.get(key);
5391 char entryType =
5392 value instanceof String ? 'S' :
5393 value instanceof Boolean ? 'B' :
5394 value instanceof Byte ? 'b' :
5395 value instanceof Character ? 'c' :
5396 value instanceof Double ? 'd' :
5397 value instanceof Float ? 'f' :
5398 value instanceof Integer ? 'i' :
5399 value instanceof Long ? 'l' :
5400 value instanceof Short ? 's' :
5401 '\0';
5402
5403 if (entryType != '\0') {
5404 uri.append(entryType);
5405 uri.append('.');
5406 uri.append(Uri.encode(key));
5407 uri.append('=');
5408 uri.append(Uri.encode(value.toString()));
5409 uri.append(';');
5410 }
5411 }
5412 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005413
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005414 uri.append("end");
5415
5416 return uri.toString();
5417 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005418
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005419 public int describeContents() {
5420 return (mExtras != null) ? mExtras.describeContents() : 0;
5421 }
5422
5423 public void writeToParcel(Parcel out, int flags) {
5424 out.writeString(mAction);
5425 Uri.writeToParcel(out, mData);
5426 out.writeString(mType);
5427 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005428 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005429 ComponentName.writeToParcel(mComponent, out);
5430
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005431 if (mSourceBounds != null) {
5432 out.writeInt(1);
5433 mSourceBounds.writeToParcel(out, flags);
5434 } else {
5435 out.writeInt(0);
5436 }
5437
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005438 if (mCategories != null) {
5439 out.writeInt(mCategories.size());
5440 for (String category : mCategories) {
5441 out.writeString(category);
5442 }
5443 } else {
5444 out.writeInt(0);
5445 }
5446
5447 out.writeBundle(mExtras);
5448 }
5449
5450 public static final Parcelable.Creator<Intent> CREATOR
5451 = new Parcelable.Creator<Intent>() {
5452 public Intent createFromParcel(Parcel in) {
5453 return new Intent(in);
5454 }
5455 public Intent[] newArray(int size) {
5456 return new Intent[size];
5457 }
5458 };
5459
Dianne Hackborneb034652009-09-07 00:49:58 -07005460 /** @hide */
5461 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005462 readFromParcel(in);
5463 }
5464
5465 public void readFromParcel(Parcel in) {
5466 mAction = in.readString();
5467 mData = Uri.CREATOR.createFromParcel(in);
5468 mType = in.readString();
5469 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005470 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005471 mComponent = ComponentName.readFromParcel(in);
5472
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005473 if (in.readInt() != 0) {
5474 mSourceBounds = Rect.CREATOR.createFromParcel(in);
5475 }
5476
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005477 int N = in.readInt();
5478 if (N > 0) {
5479 mCategories = new HashSet<String>();
5480 int i;
5481 for (i=0; i<N; i++) {
5482 mCategories.add(in.readString());
5483 }
5484 } else {
5485 mCategories = null;
5486 }
5487
5488 mExtras = in.readBundle();
5489 }
5490
5491 /**
5492 * Parses the "intent" element (and its children) from XML and instantiates
5493 * an Intent object. The given XML parser should be located at the tag
5494 * where parsing should start (often named "intent"), from which the
5495 * basic action, data, type, and package and class name will be
5496 * retrieved. The function will then parse in to any child elements,
5497 * looking for <category android:name="xxx"> tags to add categories and
5498 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5499 * to the intent.
5500 *
5501 * @param resources The Resources to use when inflating resources.
5502 * @param parser The XML parser pointing at an "intent" tag.
5503 * @param attrs The AttributeSet interface for retrieving extended
5504 * attribute data at the current <var>parser</var> location.
5505 * @return An Intent object matching the XML data.
5506 * @throws XmlPullParserException If there was an XML parsing error.
5507 * @throws IOException If there was an I/O error.
5508 */
5509 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5510 throws XmlPullParserException, IOException {
5511 Intent intent = new Intent();
5512
5513 TypedArray sa = resources.obtainAttributes(attrs,
5514 com.android.internal.R.styleable.Intent);
5515
5516 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5517
5518 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5519 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5520 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5521
5522 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5523 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5524 if (packageName != null && className != null) {
5525 intent.setComponent(new ComponentName(packageName, className));
5526 }
5527
5528 sa.recycle();
5529
5530 int outerDepth = parser.getDepth();
5531 int type;
5532 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5533 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5534 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5535 continue;
5536 }
5537
5538 String nodeName = parser.getName();
5539 if (nodeName.equals("category")) {
5540 sa = resources.obtainAttributes(attrs,
5541 com.android.internal.R.styleable.IntentCategory);
5542 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5543 sa.recycle();
5544
5545 if (cat != null) {
5546 intent.addCategory(cat);
5547 }
5548 XmlUtils.skipCurrentTag(parser);
5549
5550 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005551 if (intent.mExtras == null) {
5552 intent.mExtras = new Bundle();
5553 }
5554 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5555 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005556
5557 } else {
5558 XmlUtils.skipCurrentTag(parser);
5559 }
5560 }
5561
5562 return intent;
5563 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005564}