blob: fd5591d674be05a99f695847ab1bc366cc76b3cb [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 =
Joe Onorato8a051a42010-03-04 15:54:50 -05001426 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
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.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001635 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1639
1640 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001641 * Broadcast Action: External media is no longer being shared via USB mass storage.
1642 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1643 *
1644 * @hide
1645 */
1646 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1647
1648 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001649 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1650 * The path to the mount point for the removed media is contained in the Intent.mData field.
1651 */
1652 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1653 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1654
1655 /**
1656 * Broadcast Action: External media is present but cannot be mounted.
1657 * The path to the mount point for the removed media is contained in the Intent.mData field.
1658 */
1659 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1660 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1661
1662 /**
1663 * Broadcast Action: User has expressed the desire to remove the external storage media.
1664 * Applications should close all files they have open within the mount point when they receive this intent.
1665 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1666 */
1667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1668 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1669
1670 /**
1671 * Broadcast Action: The media scanner has started scanning a directory.
1672 * The path to the directory being scanned is contained in the Intent.mData field.
1673 */
1674 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1675 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1676
1677 /**
1678 * Broadcast Action: The media scanner has finished scanning a directory.
1679 * The path to the scanned directory is contained in the Intent.mData field.
1680 */
1681 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1682 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1683
1684 /**
1685 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1686 * The path to the file is contained in the Intent.mData field.
1687 */
1688 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1689 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1690
1691 /**
1692 * Broadcast Action: The "Media 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_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1698
1699 /**
1700 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1701 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1702 * caused the broadcast.
1703 */
1704 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1705 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1706
1707 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1708 // location; they are not general-purpose actions.
1709
1710 /**
1711 * Broadcast Action: An GTalk connection has been established.
1712 */
1713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1714 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1715 "android.intent.action.GTALK_CONNECTED";
1716
1717 /**
1718 * Broadcast Action: An GTalk connection has been disconnected.
1719 */
1720 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1721 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1722 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001723
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001724 /**
1725 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001726 */
1727 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1728 public static final String ACTION_INPUT_METHOD_CHANGED =
1729 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001730
1731 /**
1732 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1733 * more radios have been turned off or on. The intent will have the following extra value:</p>
1734 * <ul>
1735 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1736 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1737 * turned off</li>
1738 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001739 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001740 * <p class="note">This is a protected intent that can only be sent
1741 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001742 */
1743 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1744 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1745
1746 /**
1747 * Broadcast Action: Some content providers have parts of their namespace
1748 * where they publish new events or items that the user may be especially
1749 * interested in. For these things, they may broadcast this action when the
1750 * set of interesting items change.
1751 *
1752 * For example, GmailProvider sends this notification when the set of unread
1753 * mail in the inbox changes.
1754 *
1755 * <p>The data of the intent identifies which part of which provider
1756 * changed. When queried through the content resolver, the data URI will
1757 * return the data set in question.
1758 *
1759 * <p>The intent will have the following extra values:
1760 * <ul>
1761 * <li><em>count</em> - The number of items in the data set. This is the
1762 * same as the number of items in the cursor returned by querying the
1763 * data URI. </li>
1764 * </ul>
1765 *
1766 * This intent will be sent at boot (if the count is non-zero) and when the
1767 * data set changes. It is possible for the data set to change without the
1768 * count changing (for example, if a new unread message arrives in the same
1769 * sync operation in which a message is archived). The phone should still
1770 * ring/vibrate/etc as normal in this case.
1771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1773 public static final String ACTION_PROVIDER_CHANGED =
1774 "android.intent.action.PROVIDER_CHANGED";
1775
1776 /**
1777 * Broadcast Action: Wired Headset plugged in or unplugged.
1778 *
1779 * <p>The intent will have the following extra values:
1780 * <ul>
1781 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1782 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001783 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001784 * </ul>
1785 * </ul>
1786 */
1787 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1788 public static final String ACTION_HEADSET_PLUG =
1789 "android.intent.action.HEADSET_PLUG";
1790
1791 /**
1792 * Broadcast Action: An outgoing call is about to be placed.
1793 *
1794 * <p>The Intent will have the following extra value:
1795 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07001796 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001797 * the phone number originally intended to be dialed.</li>
1798 * </ul>
1799 * <p>Once the broadcast is finished, the resultData is used as the actual
1800 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07001801 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001802 * outgoing call in turn: for example, a parental control application
1803 * might verify that the user is authorized to place the call at that
1804 * time, then a number-rewriting application might add an area code if
1805 * one was not specified.</p>
1806 * <p>For consistency, any receiver whose purpose is to prohibit phone
1807 * calls should have a priority of 0, to ensure it will see the final
1808 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07001809 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001810 * should have a positive priority.
1811 * Negative priorities are reserved for the system for this broadcast;
1812 * using them may cause problems.</p>
1813 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
1814 * abort the broadcast.</p>
1815 * <p>Emergency calls cannot be intercepted using this mechanism, and
1816 * other calls cannot be modified to call emergency numbers using this
1817 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07001818 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001819 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
1820 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08001821 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001822 * <p class="note">This is a protected intent that can only be sent
1823 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001824 */
1825 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1826 public static final String ACTION_NEW_OUTGOING_CALL =
1827 "android.intent.action.NEW_OUTGOING_CALL";
1828
1829 /**
1830 * Broadcast Action: Have the device reboot. This is only for use by
1831 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08001832 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001833 * <p class="note">This is a protected intent that can only be sent
1834 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001835 */
1836 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1837 public static final String ACTION_REBOOT =
1838 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001839
Wei Huang97ecc9c2009-05-11 17:44:20 -07001840 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08001841 * Broadcast Action: A sticky broadcast for changes in the physical
1842 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08001843 *
1844 * <p>The intent will have the following extra values:
1845 * <ul>
1846 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08001847 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08001848 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08001849 * <p>This is intended for monitoring the current physical dock state.
1850 * See {@link android.app.UiModeManager} for the normal API dealing with
1851 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001852 */
1853 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1854 public static final String ACTION_DOCK_EVENT =
1855 "android.intent.action.DOCK_EVENT";
1856
1857 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07001858 * Broadcast Action: a remote intent is to be broadcasted.
1859 *
1860 * A remote intent is used for remote RPC between devices. The remote intent
1861 * is serialized and sent from one device to another device. The receiving
1862 * device parses the remote intent and broadcasts it. Note that anyone can
1863 * broadcast a remote intent. However, if the intent receiver of the remote intent
1864 * does not trust intent broadcasts from arbitrary intent senders, it should require
1865 * the sender to hold certain permissions so only trusted sender's broadcast will be
1866 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07001867 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07001868 */
1869 public static final String ACTION_REMOTE_INTENT =
Costin Manolache63cfebf2010-02-04 16:52:34 -08001870 "com.google.android.pushmessaging.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07001871
Dianne Hackborn9acc0302009-08-25 00:27:12 -07001872 /**
1873 * Broadcast Action: hook for permforming cleanup after a system update.
1874 *
1875 * The broadcast is sent when the system is booting, before the
1876 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
1877 * image. A receiver for this should do its work and then disable itself
1878 * so that it does not get run again at the next boot.
1879 * @hide
1880 */
1881 public static final String ACTION_PRE_BOOT_COMPLETED =
1882 "android.intent.action.PRE_BOOT_COMPLETED";
1883
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001884 // ---------------------------------------------------------------------
1885 // ---------------------------------------------------------------------
1886 // Standard intent categories (see addCategory()).
1887
1888 /**
1889 * Set if the activity should be an option for the default action
1890 * (center press) to perform on a piece of data. Setting this will
1891 * hide from the user any activities without it set when performing an
1892 * action on some data. Note that this is normal -not- set in the
1893 * Intent when initiating an action -- it is for use in intent filters
1894 * specified in packages.
1895 */
1896 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1897 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
1898 /**
1899 * Activities that can be safely invoked from a browser must support this
1900 * category. For example, if the user is viewing a web page or an e-mail
1901 * and clicks on a link in the text, the Intent generated execute that
1902 * link will require the BROWSABLE category, so that only activities
1903 * supporting this category will be considered as possible actions. By
1904 * supporting this category, you are promising that there is nothing
1905 * damaging (without user intervention) that can happen by invoking any
1906 * matching Intent.
1907 */
1908 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1909 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
1910 /**
1911 * Set if the activity should be considered as an alternative action to
1912 * the data the user is currently viewing. See also
1913 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
1914 * applies to the selection in a list of items.
1915 *
1916 * <p>Supporting this category means that you would like your activity to be
1917 * displayed in the set of alternative things the user can do, usually as
1918 * part of the current activity's options menu. You will usually want to
1919 * include a specific label in the &lt;intent-filter&gt; of this action
1920 * describing to the user what it does.
1921 *
1922 * <p>The action of IntentFilter with this category is important in that it
1923 * describes the specific action the target will perform. This generally
1924 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
1925 * a specific name such as "com.android.camera.action.CROP. Only one
1926 * alternative of any particular action will be shown to the user, so using
1927 * a specific action like this makes sure that your alternative will be
1928 * displayed while also allowing other applications to provide their own
1929 * overrides of that particular action.
1930 */
1931 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1932 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
1933 /**
1934 * Set if the activity should be considered as an alternative selection
1935 * action to the data the user has currently selected. This is like
1936 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
1937 * of items from which the user can select, giving them alternatives to the
1938 * default action that will be performed on it.
1939 */
1940 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1941 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
1942 /**
1943 * Intended to be used as a tab inside of an containing TabActivity.
1944 */
1945 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1946 public static final String CATEGORY_TAB = "android.intent.category.TAB";
1947 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001948 * Should be displayed in the top-level launcher.
1949 */
1950 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1951 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
1952 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001953 * Provides information about the package it is in; typically used if
1954 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
1955 * a front-door to the user without having to be shown in the all apps list.
1956 */
1957 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1958 public static final String CATEGORY_INFO = "android.intent.category.INFO";
1959 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001960 * This is the home activity, that is the first activity that is displayed
1961 * when the device boots.
1962 */
1963 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1964 public static final String CATEGORY_HOME = "android.intent.category.HOME";
1965 /**
1966 * This activity is a preference panel.
1967 */
1968 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1969 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
1970 /**
1971 * This activity is a development preference panel.
1972 */
1973 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1974 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
1975 /**
1976 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001977 */
1978 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1979 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
1980 /**
1981 * This activity may be exercised by the monkey or other automated test tools.
1982 */
1983 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
1984 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
1985 /**
1986 * To be used as a test (not part of the normal user experience).
1987 */
1988 public static final String CATEGORY_TEST = "android.intent.category.TEST";
1989 /**
1990 * To be used as a unit test (run through the Test Harness).
1991 */
1992 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
1993 /**
1994 * To be used as an sample code example (not part of the normal user
1995 * experience).
1996 */
1997 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
1998 /**
1999 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2000 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2001 * when queried, though it is allowable for those columns to be blank.
2002 */
2003 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2004 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2005
2006 /**
2007 * To be used as code under test for framework instrumentation tests.
2008 */
2009 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2010 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002011 /**
2012 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002013 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2014 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002015 */
2016 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2017 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2018 /**
2019 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002020 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2021 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002022 */
2023 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2024 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002025
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002026 // ---------------------------------------------------------------------
2027 // ---------------------------------------------------------------------
2028 // Standard extra data keys.
2029
2030 /**
2031 * The initial data to place in a newly created record. Use with
2032 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2033 * fields as would be given to the underlying ContentProvider.insert()
2034 * call.
2035 */
2036 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2037
2038 /**
2039 * A constant CharSequence that is associated with the Intent, used with
2040 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2041 * this may be a styled CharSequence, so you must use
2042 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2043 * retrieve it.
2044 */
2045 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2046
2047 /**
2048 * A content: URI holding a stream of data associated with the Intent,
2049 * used with {@link #ACTION_SEND} to supply the data being sent.
2050 */
2051 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2052
2053 /**
2054 * A String[] holding e-mail addresses that should be delivered to.
2055 */
2056 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2057
2058 /**
2059 * A String[] holding e-mail addresses that should be carbon copied.
2060 */
2061 public static final String EXTRA_CC = "android.intent.extra.CC";
2062
2063 /**
2064 * A String[] holding e-mail addresses that should be blind carbon copied.
2065 */
2066 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2067
2068 /**
2069 * A constant string holding the desired subject line of a message.
2070 */
2071 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2072
2073 /**
2074 * An Intent describing the choices you would like shown with
2075 * {@link #ACTION_PICK_ACTIVITY}.
2076 */
2077 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2078
2079 /**
2080 * A CharSequence dialog title to provide to the user when used with a
2081 * {@link #ACTION_CHOOSER}.
2082 */
2083 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2084
2085 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002086 * A Parcelable[] of {@link Intent} or
2087 * {@link android.content.pm.LabeledIntent} objects as set with
2088 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2089 * a the front of the list of choices, when shown to the user with a
2090 * {@link #ACTION_CHOOSER}.
2091 */
2092 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2093
2094 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002095 * A {@link android.view.KeyEvent} object containing the event that
2096 * triggered the creation of the Intent it is in.
2097 */
2098 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2099
2100 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002101 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2102 * before shutting down.
2103 *
2104 * {@hide}
2105 */
2106 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2107
2108 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002109 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2110 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2111 * of restarting the application.
2112 */
2113 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2114
2115 /**
2116 * A String holding the phone number originally entered in
2117 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2118 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2119 */
2120 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002121
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002122 /**
2123 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2124 * intents to supply the uid the package had been assigned. Also an optional
2125 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2126 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2127 * purpose.
2128 */
2129 public static final String EXTRA_UID = "android.intent.extra.UID";
2130
2131 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002132 * @hide String array of package names.
2133 */
2134 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2135
2136 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002137 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2138 * intents to indicate whether this represents a full uninstall (removing
2139 * both the code and its data) or a partial uninstall (leaving its data,
2140 * implying that this is an update).
2141 */
2142 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002143
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002144 /**
2145 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2146 * intents to indicate that this is a replacement of the package, so this
2147 * broadcast will immediately be followed by an add broadcast for a
2148 * different version of the same package.
2149 */
2150 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002151
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002152 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002153 * Used as an int extra field in {@link android.app.AlarmManager} intents
2154 * to tell the application being invoked how many pending alarms are being
2155 * delievered with the intent. For one-shot alarms this will always be 1.
2156 * For recurring alarms, this might be greater than 1 if the device was
2157 * asleep or powered off at the time an earlier alarm would have been
2158 * delivered.
2159 */
2160 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002161
Jacek Surazski86b6c532009-05-13 14:38:28 +02002162 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002163 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2164 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002165 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2166 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
2167 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002168 */
2169 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2170
2171 /**
2172 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2173 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002174 */
2175 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2176
2177 /**
2178 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2179 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002180 */
2181 public static final int EXTRA_DOCK_STATE_DESK = 1;
2182
2183 /**
2184 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2185 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002186 */
2187 public static final int EXTRA_DOCK_STATE_CAR = 2;
2188
2189 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002190 * Boolean that can be supplied as meta-data with a dock activity, to
2191 * indicate that the dock should take over the home key when it is active.
2192 */
2193 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002194
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002195 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002196 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2197 * the bug report.
Romain Guy4969af72009-06-17 10:53:19 -07002198 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002199 * @hide
2200 */
2201 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2202
2203 /**
Romain Guy4969af72009-06-17 10:53:19 -07002204 * Used as a string extra field when sending an intent to PackageInstaller to install a
Jacek Surazski86b6c532009-05-13 14:38:28 +02002205 * package. Specifies the installer package name; this package will receive the
2206 * {@link #ACTION_APP_ERROR} intent.
Romain Guy4969af72009-06-17 10:53:19 -07002207 *
Jacek Surazski86b6c532009-05-13 14:38:28 +02002208 * @hide
2209 */
Romain Guy4969af72009-06-17 10:53:19 -07002210 public static final String EXTRA_INSTALLER_PACKAGE_NAME
Jacek Surazski86b6c532009-05-13 14:38:28 +02002211 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002212
Wei Huang97ecc9c2009-05-11 17:44:20 -07002213 /**
2214 * Used in the extra field in the remote intent. It's astring token passed with the
2215 * remote intent.
2216 */
2217 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2218 "android.intent.extra.remote_intent_token";
2219
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002220 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002221 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002222 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002223 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002224 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002225 "android.intent.extra.changed_component_name";
2226
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002227 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002228 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002229 * and contains a string array of all of the components that have changed.
2230 */
2231 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2232 "android.intent.extra.changed_component_name_list";
2233
2234 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002235 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002236 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2237 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002238 * and contains a string array of all of the components that have changed.
2239 * @hide
2240 */
2241 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2242 "android.intent.extra.changed_package_list";
2243
2244 /**
2245 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002246 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2247 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002248 * and contains an integer array of uids of all of the components
2249 * that have changed.
2250 * @hide
2251 */
2252 public static final String EXTRA_CHANGED_UID_LIST =
2253 "android.intent.extra.changed_uid_list";
2254
2255 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002256 * @hide
2257 * Magic extra system code can use when binding, to give a label for
2258 * who it is that has bound to a service. This is an integer giving
2259 * a framework string resource that can be displayed to the user.
2260 */
2261 public static final String EXTRA_CLIENT_LABEL =
2262 "android.intent.extra.client_label";
2263
2264 /**
2265 * @hide
2266 * Magic extra system code can use when binding, to give a PendingIntent object
2267 * that can be launched for the user to disable the system's use of this
2268 * service.
2269 */
2270 public static final String EXTRA_CLIENT_INTENT =
2271 "android.intent.extra.client_intent";
2272
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002273 // ---------------------------------------------------------------------
2274 // ---------------------------------------------------------------------
2275 // Intent flags (see mFlags variable).
2276
2277 /**
2278 * If set, the recipient of this Intent will be granted permission to
2279 * perform read operations on the Uri in the Intent's data.
2280 */
2281 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2282 /**
2283 * If set, the recipient of this Intent will be granted permission to
2284 * perform write operations on the Uri in the Intent's data.
2285 */
2286 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2287 /**
2288 * Can be set by the caller to indicate that this Intent is coming from
2289 * a background operation, not from direct user interaction.
2290 */
2291 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2292 /**
2293 * A flag you can enable for debugging: when set, log messages will be
2294 * printed during the resolution of this intent to show you what has
2295 * been found to create the final resolved list.
2296 */
2297 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
2298
2299 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002300 * If set, the new activity is not kept in the history stack. As soon as
2301 * the user navigates away from it, the activity is finished. This may also
2302 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2303 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 */
2305 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2306 /**
2307 * If set, the activity will not be launched if it is already running
2308 * at the top of the history stack.
2309 */
2310 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2311 /**
2312 * If set, this activity will become the start of a new task on this
2313 * history stack. A task (from the activity that started it to the
2314 * next task activity) defines an atomic group of activities that the
2315 * user can move to. Tasks can be moved to the foreground and background;
2316 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002317 * the same order. See
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002318 * <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2319 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002320 *
2321 * <p>This flag is generally used by activities that want
2322 * to present a "launcher" style behavior: they give the user a list of
2323 * separate things that can be done, which otherwise run completely
2324 * independently of the activity launching them.
2325 *
2326 * <p>When using this flag, if a task is already running for the activity
2327 * you are now starting, then a new activity will not be started; instead,
2328 * the current task will simply be brought to the front of the screen with
2329 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2330 * to disable this behavior.
2331 *
2332 * <p>This flag can not be used when the caller is requesting a result from
2333 * the activity being launched.
2334 */
2335 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2336 /**
2337 * <strong>Do not use this flag unless you are implementing your own
2338 * top-level application launcher.</strong> Used in conjunction with
2339 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2340 * behavior of bringing an existing task to the foreground. When set,
2341 * a new task is <em>always</em> started to host the Activity for the
2342 * Intent, regardless of whether there is already an existing task running
2343 * the same thing.
2344 *
2345 * <p><strong>Because the default system does not include graphical task management,
2346 * you should not use this flag unless you provide some way for a user to
2347 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002348 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002349 * <p>This flag is ignored if
2350 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2351 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002352 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2353 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002354 */
2355 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2356 /**
2357 * If set, and the activity being launched is already running in the
2358 * current task, then instead of launching a new instance of that activity,
2359 * all of the other activities on top of it will be closed and this Intent
2360 * will be delivered to the (now on top) old activity as a new Intent.
2361 *
2362 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2363 * If D calls startActivity() with an Intent that resolves to the component
2364 * of activity B, then C and D will be finished and B receive the given
2365 * Intent, resulting in the stack now being: A, B.
2366 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002367 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002368 * either receive the new intent you are starting here in its
2369 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002370 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002371 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2372 * the same intent, then it will be finished and re-created; for all other
2373 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2374 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002375 *
2376 * <p>This launch mode can also be used to good effect in conjunction with
2377 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2378 * of a task, it will bring any currently running instance of that task
2379 * to the foreground, and then clear it to its root state. This is
2380 * especially useful, for example, when launching an activity from the
2381 * notification manager.
2382 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002383 * <p>See <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
2384 * Activities and Tasks</a> for more details on tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002385 */
2386 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2387 /**
2388 * If set and this intent is being used to launch a new activity from an
2389 * existing one, then the reply target of the existing activity will be
2390 * transfered to the new activity. This way the new activity can call
2391 * {@link android.app.Activity#setResult} and have that result sent back to
2392 * the reply target of the original activity.
2393 */
2394 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2395 /**
2396 * If set and this intent is being used to launch a new activity from an
2397 * existing one, the current activity will not be counted as the top
2398 * activity for deciding whether the new intent should be delivered to
2399 * the top instead of starting a new one. The previous activity will
2400 * be used as the top, with the assumption being that the current activity
2401 * will finish itself immediately.
2402 */
2403 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2404 /**
2405 * If set, the new activity is not kept in the list of recently launched
2406 * activities.
2407 */
2408 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2409 /**
2410 * This flag is not normally set by application code, but set for you by
2411 * the system as described in the
2412 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2413 * launchMode} documentation for the singleTask mode.
2414 */
2415 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2416 /**
2417 * If set, and this activity is either being started in a new task or
2418 * bringing to the top an existing task, then it will be launched as
2419 * the front door of the task. This will result in the application of
2420 * any affinities needed to have that task in the proper state (either
2421 * moving activities to or from it), or simply resetting that task to
2422 * its initial state if needed.
2423 */
2424 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2425 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002426 * This flag is not normally set by application code, but set for you by
2427 * the system if this activity is being launched from history
2428 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002429 */
2430 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002431 /**
2432 * If set, this marks a point in the task's activity stack that should
2433 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002434 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002435 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2436 * the user re-launching it from home), this activity and all on top of
2437 * it will be finished so that the user does not return to them, but
2438 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002439 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002440 * <p>This is useful for cases where you have a logical break in your
2441 * application. For example, an e-mail application may have a command
2442 * to view an attachment, which launches an image view activity to
2443 * display it. This activity should be part of the e-mail application's
2444 * task, since it is a part of the task the user is involved in. However,
2445 * if the user leaves that task, and later selects the e-mail app from
2446 * home, we may like them to return to the conversation they were
2447 * viewing, not the picture attachment, since that is confusing. By
2448 * setting this flag when launching the image viewer, that viewer and
2449 * any activities it starts will be removed the next time the user returns
2450 * to mail.
2451 */
2452 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002453 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002454 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002455 * callback from occurring on the current frontmost activity before it is
2456 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002457 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002458 * <p>Typically, an activity can rely on that callback to indicate that an
2459 * explicit user action has caused their activity to be moved out of the
2460 * foreground. The callback marks an appropriate point in the activity's
2461 * lifecycle for it to dismiss any notifications that it intends to display
2462 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002463 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002464 * <p>If an activity is ever started via any non-user-driven events such as
2465 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2466 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002467 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002468 */
2469 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002470 /**
2471 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2472 * this flag will cause the launched activity to be brought to the front of its
2473 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002474 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002475 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2476 * If D calls startActivity() with an Intent that resolves to the component
2477 * of activity B, then B will be brought to the front of the history stack,
2478 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002479 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002480 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002481 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002482 */
2483 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002484 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002485 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2486 * this flag will prevent the system from applying an activity transition
2487 * animation to go to the next activity state. This doesn't mean an
2488 * animation will never run -- if another activity change happens that doesn't
2489 * specify this flag before the activity started here is displayed, then
2490 * that transition will be used. This this flag can be put to good use
2491 * when you are going to do a series of activity operations but the
2492 * animation seen by the user shouldn't be driven by the first activity
2493 * change but rather a later one.
2494 */
2495 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2496 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002497 * If set, when sending a broadcast only registered receivers will be
2498 * called -- no BroadcastReceiver components will be launched.
2499 */
2500 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002501 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002502 * If set, when sending a broadcast the new broadcast will replace
2503 * any existing pending broadcast that matches it. Matching is defined
2504 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
2505 * true for the intents of the two broadcasts. When a match is found,
2506 * the new broadcast (and receivers associated with it) will replace the
2507 * existing one in the pending broadcast list, remaining at the same
2508 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08002509 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002510 * <p>This flag is most typically used with sticky broadcasts, which
2511 * only care about delivering the most recent values of the broadcast
2512 * to their receivers.
2513 */
2514 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
2515 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002516 * If set, when sending a broadcast <i>before boot has completed</i> only
2517 * registered receivers will be called -- no BroadcastReceiver components
2518 * will be launched. Sticky intent state will be recorded properly even
2519 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2520 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002521 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002522 * <p>This flag is only for use by system sevices as a convenience to
2523 * avoid having to implement a more complex mechanism around detection
2524 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002525 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002526 * @hide
2527 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002528 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x10000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002529 /**
2530 * Set when this broadcast is for a boot upgrade, a special mode that
2531 * allows the broadcast to be sent before the system is ready and launches
2532 * the app process with no providers running in it.
2533 * @hide
2534 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002535 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x08000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002536
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002537 /**
2538 * @hide Flags that can't be changed with PendingIntent.
2539 */
2540 public static final int IMMUTABLE_FLAGS =
2541 FLAG_GRANT_READ_URI_PERMISSION
2542 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08002543
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002544 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002545 // ---------------------------------------------------------------------
2546 // toUri() and parseUri() options.
2547
2548 /**
2549 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2550 * always has the "intent:" scheme. This syntax can be used when you want
2551 * to later disambiguate between URIs that are intended to describe an
2552 * Intent vs. all others that should be treated as raw URIs. When used
2553 * with {@link #parseUri}, any other scheme will result in a generic
2554 * VIEW action for that raw URI.
2555 */
2556 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08002557
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002558 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002559
2560 private String mAction;
2561 private Uri mData;
2562 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002563 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002564 private ComponentName mComponent;
2565 private int mFlags;
2566 private HashSet<String> mCategories;
2567 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002568 private Rect mSourceBounds;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002569
2570 // ---------------------------------------------------------------------
2571
2572 /**
2573 * Create an empty intent.
2574 */
2575 public Intent() {
2576 }
2577
2578 /**
2579 * Copy constructor.
2580 */
2581 public Intent(Intent o) {
2582 this.mAction = o.mAction;
2583 this.mData = o.mData;
2584 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002585 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002586 this.mComponent = o.mComponent;
2587 this.mFlags = o.mFlags;
2588 if (o.mCategories != null) {
2589 this.mCategories = new HashSet<String>(o.mCategories);
2590 }
2591 if (o.mExtras != null) {
2592 this.mExtras = new Bundle(o.mExtras);
2593 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002594 if (o.mSourceBounds != null) {
2595 this.mSourceBounds = new Rect(o.mSourceBounds);
2596 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002597 }
2598
2599 @Override
2600 public Object clone() {
2601 return new Intent(this);
2602 }
2603
2604 private Intent(Intent o, boolean all) {
2605 this.mAction = o.mAction;
2606 this.mData = o.mData;
2607 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002608 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002609 this.mComponent = o.mComponent;
2610 if (o.mCategories != null) {
2611 this.mCategories = new HashSet<String>(o.mCategories);
2612 }
2613 }
2614
2615 /**
2616 * Make a clone of only the parts of the Intent that are relevant for
2617 * filter matching: the action, data, type, component, and categories.
2618 */
2619 public Intent cloneFilter() {
2620 return new Intent(this, false);
2621 }
2622
2623 /**
2624 * Create an intent with a given action. All other fields (data, type,
2625 * class) are null. Note that the action <em>must</em> be in a
2626 * namespace because Intents are used globally in the system -- for
2627 * example the system VIEW action is android.intent.action.VIEW; an
2628 * application's custom action would be something like
2629 * com.google.app.myapp.CUSTOM_ACTION.
2630 *
2631 * @param action The Intent action, such as ACTION_VIEW.
2632 */
2633 public Intent(String action) {
2634 mAction = action;
2635 }
2636
2637 /**
2638 * Create an intent with a given action and for a given data url. Note
2639 * that the action <em>must</em> be in a namespace because Intents are
2640 * used globally in the system -- for example the system VIEW action is
2641 * android.intent.action.VIEW; an application's custom action would be
2642 * something like com.google.app.myapp.CUSTOM_ACTION.
2643 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002644 * <p><em>Note: scheme and host name matching in the Android framework is
2645 * case-sensitive, unlike the formal RFC. As a result,
2646 * you should always ensure that you write your Uri with these elements
2647 * using lower case letters, and normalize any Uris you receive from
2648 * outside of Android to ensure the scheme and host is lower case.</em></p>
2649 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002650 * @param action The Intent action, such as ACTION_VIEW.
2651 * @param uri The Intent data URI.
2652 */
2653 public Intent(String action, Uri uri) {
2654 mAction = action;
2655 mData = uri;
2656 }
2657
2658 /**
2659 * Create an intent for a specific component. All other fields (action, data,
2660 * type, class) are null, though they can be modified later with explicit
2661 * calls. This provides a convenient way to create an intent that is
2662 * intended to execute a hard-coded class name, rather than relying on the
2663 * system to find an appropriate class for you; see {@link #setComponent}
2664 * for more information on the repercussions of this.
2665 *
2666 * @param packageContext A Context of the application package implementing
2667 * this class.
2668 * @param cls The component class that is to be used for the intent.
2669 *
2670 * @see #setClass
2671 * @see #setComponent
2672 * @see #Intent(String, android.net.Uri , Context, Class)
2673 */
2674 public Intent(Context packageContext, Class<?> cls) {
2675 mComponent = new ComponentName(packageContext, cls);
2676 }
2677
2678 /**
2679 * Create an intent for a specific component with a specified action and data.
2680 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2681 * construct the Intent and then calling {@link #setClass} to set its
2682 * class.
2683 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002684 * <p><em>Note: scheme and host name matching in the Android framework is
2685 * case-sensitive, unlike the formal RFC. As a result,
2686 * you should always ensure that you write your Uri with these elements
2687 * using lower case letters, and normalize any Uris you receive from
2688 * outside of Android to ensure the scheme and host is lower case.</em></p>
2689 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002690 * @param action The Intent action, such as ACTION_VIEW.
2691 * @param uri The Intent data URI.
2692 * @param packageContext A Context of the application package implementing
2693 * this class.
2694 * @param cls The component class that is to be used for the intent.
2695 *
2696 * @see #Intent(String, android.net.Uri)
2697 * @see #Intent(Context, Class)
2698 * @see #setClass
2699 * @see #setComponent
2700 */
2701 public Intent(String action, Uri uri,
2702 Context packageContext, Class<?> cls) {
2703 mAction = action;
2704 mData = uri;
2705 mComponent = new ComponentName(packageContext, cls);
2706 }
2707
2708 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002709 * Call {@link #parseUri} with 0 flags.
2710 * @deprecated Use {@link #parseUri} instead.
2711 */
2712 @Deprecated
2713 public static Intent getIntent(String uri) throws URISyntaxException {
2714 return parseUri(uri, 0);
2715 }
Tom Taylord4a47292009-12-21 13:59:18 -08002716
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002717 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002718 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002719 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07002720 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002721 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002722 *
2723 * <p>The URI given here must not be relative -- that is, it must include
2724 * the scheme and full path.
2725 *
2726 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002727 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002728 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002729 *
2730 * @return Intent The newly created Intent object.
2731 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002732 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
2733 * it bad (as parsed by the Uri class) or the Intent data within the
2734 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08002735 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002736 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002737 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002738 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002739 int i = 0;
2740 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002741 // Validate intent scheme for if requested.
2742 if ((flags&URI_INTENT_SCHEME) != 0) {
2743 if (!uri.startsWith("intent:")) {
2744 Intent intent = new Intent(ACTION_VIEW);
2745 try {
2746 intent.setData(Uri.parse(uri));
2747 } catch (IllegalArgumentException e) {
2748 throw new URISyntaxException(uri, e.getMessage());
2749 }
2750 return intent;
2751 }
2752 }
Tom Taylord4a47292009-12-21 13:59:18 -08002753
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002754 // simple case
2755 i = uri.lastIndexOf("#");
2756 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
2757
2758 // old format Intent URI
2759 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07002760
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002761 // new format
2762 Intent intent = new Intent(ACTION_VIEW);
2763
2764 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002765 String data = i >= 0 ? uri.substring(0, i) : null;
2766 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002767 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07002768
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002769 // loop over contents of Intent, all name=value;
2770 while (!uri.startsWith("end", i)) {
2771 int eq = uri.indexOf('=', i);
2772 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002773 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002774
2775 // action
2776 if (uri.startsWith("action=", i)) {
2777 intent.mAction = value;
2778 }
2779
2780 // categories
2781 else if (uri.startsWith("category=", i)) {
2782 intent.addCategory(value);
2783 }
2784
2785 // type
2786 else if (uri.startsWith("type=", i)) {
2787 intent.mType = value;
2788 }
2789
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002790 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002791 else if (uri.startsWith("launchFlags=", i)) {
2792 intent.mFlags = Integer.decode(value).intValue();
2793 }
2794
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002795 // package
2796 else if (uri.startsWith("package=", i)) {
2797 intent.mPackage = value;
2798 }
2799
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002800 // component
2801 else if (uri.startsWith("component=", i)) {
2802 intent.mComponent = ComponentName.unflattenFromString(value);
2803 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002804
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002805 // scheme
2806 else if (uri.startsWith("scheme=", i)) {
2807 scheme = value;
2808 }
2809
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002810 // source bounds
2811 else if (uri.startsWith("sourceBounds=", i)) {
2812 intent.mSourceBounds = Rect.unflattenFromString(value);
2813 }
2814
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002815 // extra
2816 else {
2817 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002818 // create Bundle if it doesn't already exist
2819 if (intent.mExtras == null) intent.mExtras = new Bundle();
2820 Bundle b = intent.mExtras;
2821 // add EXTRA
2822 if (uri.startsWith("S.", i)) b.putString(key, value);
2823 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
2824 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
2825 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
2826 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
2827 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
2828 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
2829 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
2830 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
2831 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
2832 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002833
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002834 // move to the next item
2835 i = semi + 1;
2836 }
2837
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002838 if (data != null) {
2839 if (data.startsWith("intent:")) {
2840 data = data.substring(7);
2841 if (scheme != null) {
2842 data = scheme + ':' + data;
2843 }
2844 }
Tom Taylord4a47292009-12-21 13:59:18 -08002845
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002846 if (data.length() > 0) {
2847 try {
2848 intent.mData = Uri.parse(data);
2849 } catch (IllegalArgumentException e) {
2850 throw new URISyntaxException(uri, e.getMessage());
2851 }
2852 }
2853 }
Tom Taylord4a47292009-12-21 13:59:18 -08002854
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002855 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07002856
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002857 } catch (IndexOutOfBoundsException e) {
2858 throw new URISyntaxException(uri, "illegal Intent URI format", i);
2859 }
2860 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002861
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002862 public static Intent getIntentOld(String uri) throws URISyntaxException {
2863 Intent intent;
2864
2865 int i = uri.lastIndexOf('#');
2866 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002867 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002868 final int intentFragmentStart = i;
2869 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870
2871 i++;
2872
2873 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002874 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002875 i += 7;
2876 int j = uri.indexOf(')', i);
2877 action = uri.substring(i, j);
2878 i = j + 1;
2879 }
2880
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002881 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002882
2883 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002884 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002885 i += 11;
2886 int j = uri.indexOf(')', i);
2887 while (i < j) {
2888 int sep = uri.indexOf('!', i);
2889 if (sep < 0) sep = j;
2890 if (i < sep) {
2891 intent.addCategory(uri.substring(i, sep));
2892 }
2893 i = sep + 1;
2894 }
2895 i = j + 1;
2896 }
2897
2898 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002899 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002900 i += 5;
2901 int j = uri.indexOf(')', i);
2902 intent.mType = uri.substring(i, j);
2903 i = j + 1;
2904 }
2905
2906 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002907 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002908 i += 12;
2909 int j = uri.indexOf(')', i);
2910 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
2911 i = j + 1;
2912 }
2913
2914 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002915 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002916 i += 10;
2917 int j = uri.indexOf(')', i);
2918 int sep = uri.indexOf('!', i);
2919 if (sep >= 0 && sep < j) {
2920 String pkg = uri.substring(i, sep);
2921 String cls = uri.substring(sep + 1, j);
2922 intent.mComponent = new ComponentName(pkg, cls);
2923 }
2924 i = j + 1;
2925 }
2926
2927 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07002928 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002929 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07002930
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002931 final int closeParen = uri.indexOf(')', i);
2932 if (closeParen == -1) throw new URISyntaxException(uri,
2933 "EXTRA missing trailing ')'", i);
2934
2935 while (i < closeParen) {
2936 // fetch the key value
2937 int j = uri.indexOf('=', i);
2938 if (j <= i + 1 || i >= closeParen) {
2939 throw new URISyntaxException(uri, "EXTRA missing '='", i);
2940 }
2941 char type = uri.charAt(i);
2942 i++;
2943 String key = uri.substring(i, j);
2944 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07002945
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002946 // get type-value
2947 j = uri.indexOf('!', i);
2948 if (j == -1 || j >= closeParen) j = closeParen;
2949 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2950 String value = uri.substring(i, j);
2951 i = j;
2952
2953 // create Bundle if it doesn't already exist
2954 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07002955
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002956 // add item to bundle
2957 try {
2958 switch (type) {
2959 case 'S':
2960 intent.mExtras.putString(key, Uri.decode(value));
2961 break;
2962 case 'B':
2963 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
2964 break;
2965 case 'b':
2966 intent.mExtras.putByte(key, Byte.parseByte(value));
2967 break;
2968 case 'c':
2969 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
2970 break;
2971 case 'd':
2972 intent.mExtras.putDouble(key, Double.parseDouble(value));
2973 break;
2974 case 'f':
2975 intent.mExtras.putFloat(key, Float.parseFloat(value));
2976 break;
2977 case 'i':
2978 intent.mExtras.putInt(key, Integer.parseInt(value));
2979 break;
2980 case 'l':
2981 intent.mExtras.putLong(key, Long.parseLong(value));
2982 break;
2983 case 's':
2984 intent.mExtras.putShort(key, Short.parseShort(value));
2985 break;
2986 default:
2987 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
2988 }
2989 } catch (NumberFormatException e) {
2990 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
2991 }
The Android Open Source Project10592532009-03-18 17:39:46 -07002992
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002993 char ch = uri.charAt(i);
2994 if (ch == ')') break;
2995 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
2996 i++;
2997 }
2998 }
2999
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003000 if (isIntentFragment) {
3001 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3002 } else {
3003 intent.mData = Uri.parse(uri);
3004 }
Tom Taylord4a47292009-12-21 13:59:18 -08003005
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003006 if (intent.mAction == null) {
3007 // By default, if no action is specified, then use VIEW.
3008 intent.mAction = ACTION_VIEW;
3009 }
3010
3011 } else {
3012 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3013 }
3014
3015 return intent;
3016 }
3017
3018 /**
3019 * Retrieve the general action to be performed, such as
3020 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3021 * the information in the intent should be interpreted -- most importantly,
3022 * what to do with the data returned by {@link #getData}.
3023 *
3024 * @return The action of this intent or null if none is specified.
3025 *
3026 * @see #setAction
3027 */
3028 public String getAction() {
3029 return mAction;
3030 }
3031
3032 /**
3033 * Retrieve data this intent is operating on. This URI specifies the name
3034 * of the data; often it uses the content: scheme, specifying data in a
3035 * content provider. Other schemes may be handled by specific activities,
3036 * such as http: by the web browser.
3037 *
3038 * @return The URI of the data this intent is targeting or null.
3039 *
3040 * @see #getScheme
3041 * @see #setData
3042 */
3043 public Uri getData() {
3044 return mData;
3045 }
3046
3047 /**
3048 * The same as {@link #getData()}, but returns the URI as an encoded
3049 * String.
3050 */
3051 public String getDataString() {
3052 return mData != null ? mData.toString() : null;
3053 }
3054
3055 /**
3056 * Return the scheme portion of the intent's data. If the data is null or
3057 * does not include a scheme, null is returned. Otherwise, the scheme
3058 * prefix without the final ':' is returned, i.e. "http".
3059 *
3060 * <p>This is the same as calling getData().getScheme() (and checking for
3061 * null data).
3062 *
3063 * @return The scheme of this intent.
3064 *
3065 * @see #getData
3066 */
3067 public String getScheme() {
3068 return mData != null ? mData.getScheme() : null;
3069 }
3070
3071 /**
3072 * Retrieve any explicit MIME type included in the intent. This is usually
3073 * null, as the type is determined by the intent data.
3074 *
3075 * @return If a type was manually set, it is returned; else null is
3076 * returned.
3077 *
3078 * @see #resolveType(ContentResolver)
3079 * @see #setType
3080 */
3081 public String getType() {
3082 return mType;
3083 }
3084
3085 /**
3086 * Return the MIME data type of this intent. If the type field is
3087 * explicitly set, that is simply returned. Otherwise, if the data is set,
3088 * the type of that data is returned. If neither fields are set, a null is
3089 * returned.
3090 *
3091 * @return The MIME type of this intent.
3092 *
3093 * @see #getType
3094 * @see #resolveType(ContentResolver)
3095 */
3096 public String resolveType(Context context) {
3097 return resolveType(context.getContentResolver());
3098 }
3099
3100 /**
3101 * Return the MIME data type of this intent. If the type field is
3102 * explicitly set, that is simply returned. Otherwise, if the data is set,
3103 * the type of that data is returned. If neither fields are set, a null is
3104 * returned.
3105 *
3106 * @param resolver A ContentResolver that can be used to determine the MIME
3107 * type of the intent's data.
3108 *
3109 * @return The MIME type of this intent.
3110 *
3111 * @see #getType
3112 * @see #resolveType(Context)
3113 */
3114 public String resolveType(ContentResolver resolver) {
3115 if (mType != null) {
3116 return mType;
3117 }
3118 if (mData != null) {
3119 if ("content".equals(mData.getScheme())) {
3120 return resolver.getType(mData);
3121 }
3122 }
3123 return null;
3124 }
3125
3126 /**
3127 * Return the MIME data type of this intent, only if it will be needed for
3128 * intent resolution. This is not generally useful for application code;
3129 * it is used by the frameworks for communicating with back-end system
3130 * services.
3131 *
3132 * @param resolver A ContentResolver that can be used to determine the MIME
3133 * type of the intent's data.
3134 *
3135 * @return The MIME type of this intent, or null if it is unknown or not
3136 * needed.
3137 */
3138 public String resolveTypeIfNeeded(ContentResolver resolver) {
3139 if (mComponent != null) {
3140 return mType;
3141 }
3142 return resolveType(resolver);
3143 }
3144
3145 /**
3146 * Check if an category exists in the intent.
3147 *
3148 * @param category The category to check.
3149 *
3150 * @return boolean True if the intent contains the category, else false.
3151 *
3152 * @see #getCategories
3153 * @see #addCategory
3154 */
3155 public boolean hasCategory(String category) {
3156 return mCategories != null && mCategories.contains(category);
3157 }
3158
3159 /**
3160 * Return the set of all categories in the intent. If there are no categories,
3161 * returns NULL.
3162 *
3163 * @return Set The set of categories you can examine. Do not modify!
3164 *
3165 * @see #hasCategory
3166 * @see #addCategory
3167 */
3168 public Set<String> getCategories() {
3169 return mCategories;
3170 }
3171
3172 /**
3173 * Sets the ClassLoader that will be used when unmarshalling
3174 * any Parcelable values from the extras of this Intent.
3175 *
3176 * @param loader a ClassLoader, or null to use the default loader
3177 * at the time of unmarshalling.
3178 */
3179 public void setExtrasClassLoader(ClassLoader loader) {
3180 if (mExtras != null) {
3181 mExtras.setClassLoader(loader);
3182 }
3183 }
3184
3185 /**
3186 * Returns true if an extra value is associated with the given name.
3187 * @param name the extra's name
3188 * @return true if the given extra is present.
3189 */
3190 public boolean hasExtra(String name) {
3191 return mExtras != null && mExtras.containsKey(name);
3192 }
3193
3194 /**
3195 * Returns true if the Intent's extras contain a parcelled file descriptor.
3196 * @return true if the Intent contains a parcelled file descriptor.
3197 */
3198 public boolean hasFileDescriptors() {
3199 return mExtras != null && mExtras.hasFileDescriptors();
3200 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003201
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003202 /**
3203 * Retrieve extended data from the intent.
3204 *
3205 * @param name The name of the desired item.
3206 *
3207 * @return the value of an item that previously added with putExtra()
3208 * or null if none was found.
3209 *
3210 * @deprecated
3211 * @hide
3212 */
3213 @Deprecated
3214 public Object getExtra(String name) {
3215 return getExtra(name, null);
3216 }
3217
3218 /**
3219 * Retrieve extended data from the intent.
3220 *
3221 * @param name The name of the desired item.
3222 * @param defaultValue the value to be returned if no value of the desired
3223 * type is stored with the given name.
3224 *
3225 * @return the value of an item that previously added with putExtra()
3226 * or the default value if none was found.
3227 *
3228 * @see #putExtra(String, boolean)
3229 */
3230 public boolean getBooleanExtra(String name, boolean defaultValue) {
3231 return mExtras == null ? defaultValue :
3232 mExtras.getBoolean(name, defaultValue);
3233 }
3234
3235 /**
3236 * Retrieve extended data from the intent.
3237 *
3238 * @param name The name of the desired item.
3239 * @param defaultValue the value to be returned if no value of the desired
3240 * type is stored with the given name.
3241 *
3242 * @return the value of an item that previously added with putExtra()
3243 * or the default value if none was found.
3244 *
3245 * @see #putExtra(String, byte)
3246 */
3247 public byte getByteExtra(String name, byte defaultValue) {
3248 return mExtras == null ? defaultValue :
3249 mExtras.getByte(name, defaultValue);
3250 }
3251
3252 /**
3253 * Retrieve extended data from the intent.
3254 *
3255 * @param name The name of the desired item.
3256 * @param defaultValue the value to be returned if no value of the desired
3257 * type is stored with the given name.
3258 *
3259 * @return the value of an item that previously added with putExtra()
3260 * or the default value if none was found.
3261 *
3262 * @see #putExtra(String, short)
3263 */
3264 public short getShortExtra(String name, short defaultValue) {
3265 return mExtras == null ? defaultValue :
3266 mExtras.getShort(name, defaultValue);
3267 }
3268
3269 /**
3270 * Retrieve extended data from the intent.
3271 *
3272 * @param name The name of the desired item.
3273 * @param defaultValue the value to be returned if no value of the desired
3274 * type is stored with the given name.
3275 *
3276 * @return the value of an item that previously added with putExtra()
3277 * or the default value if none was found.
3278 *
3279 * @see #putExtra(String, char)
3280 */
3281 public char getCharExtra(String name, char defaultValue) {
3282 return mExtras == null ? defaultValue :
3283 mExtras.getChar(name, defaultValue);
3284 }
3285
3286 /**
3287 * Retrieve extended data from the intent.
3288 *
3289 * @param name The name of the desired item.
3290 * @param defaultValue the value to be returned if no value of the desired
3291 * type is stored with the given name.
3292 *
3293 * @return the value of an item that previously added with putExtra()
3294 * or the default value if none was found.
3295 *
3296 * @see #putExtra(String, int)
3297 */
3298 public int getIntExtra(String name, int defaultValue) {
3299 return mExtras == null ? defaultValue :
3300 mExtras.getInt(name, defaultValue);
3301 }
3302
3303 /**
3304 * Retrieve extended data from the intent.
3305 *
3306 * @param name The name of the desired item.
3307 * @param defaultValue the value to be returned if no value of the desired
3308 * type is stored with the given name.
3309 *
3310 * @return the value of an item that previously added with putExtra()
3311 * or the default value if none was found.
3312 *
3313 * @see #putExtra(String, long)
3314 */
3315 public long getLongExtra(String name, long defaultValue) {
3316 return mExtras == null ? defaultValue :
3317 mExtras.getLong(name, defaultValue);
3318 }
3319
3320 /**
3321 * Retrieve extended data from the intent.
3322 *
3323 * @param name The name of the desired item.
3324 * @param defaultValue the value to be returned if no value of the desired
3325 * type is stored with the given name.
3326 *
3327 * @return the value of an item that previously added with putExtra(),
3328 * or the default value if no such item is present
3329 *
3330 * @see #putExtra(String, float)
3331 */
3332 public float getFloatExtra(String name, float defaultValue) {
3333 return mExtras == null ? defaultValue :
3334 mExtras.getFloat(name, defaultValue);
3335 }
3336
3337 /**
3338 * Retrieve extended data from the intent.
3339 *
3340 * @param name The name of the desired item.
3341 * @param defaultValue the value to be returned if no value of the desired
3342 * type is stored with the given name.
3343 *
3344 * @return the value of an item that previously added with putExtra()
3345 * or the default value if none was found.
3346 *
3347 * @see #putExtra(String, double)
3348 */
3349 public double getDoubleExtra(String name, double defaultValue) {
3350 return mExtras == null ? defaultValue :
3351 mExtras.getDouble(name, defaultValue);
3352 }
3353
3354 /**
3355 * Retrieve extended data from the intent.
3356 *
3357 * @param name The name of the desired item.
3358 *
3359 * @return the value of an item that previously added with putExtra()
3360 * or null if no String value was found.
3361 *
3362 * @see #putExtra(String, String)
3363 */
3364 public String getStringExtra(String name) {
3365 return mExtras == null ? null : mExtras.getString(name);
3366 }
3367
3368 /**
3369 * Retrieve extended data from the intent.
3370 *
3371 * @param name The name of the desired item.
3372 *
3373 * @return the value of an item that previously added with putExtra()
3374 * or null if no CharSequence value was found.
3375 *
3376 * @see #putExtra(String, CharSequence)
3377 */
3378 public CharSequence getCharSequenceExtra(String name) {
3379 return mExtras == null ? null : mExtras.getCharSequence(name);
3380 }
3381
3382 /**
3383 * Retrieve extended data from the intent.
3384 *
3385 * @param name The name of the desired item.
3386 *
3387 * @return the value of an item that previously added with putExtra()
3388 * or null if no Parcelable value was found.
3389 *
3390 * @see #putExtra(String, Parcelable)
3391 */
3392 public <T extends Parcelable> T getParcelableExtra(String name) {
3393 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3394 }
3395
3396 /**
3397 * Retrieve extended data from the intent.
3398 *
3399 * @param name The name of the desired item.
3400 *
3401 * @return the value of an item that previously added with putExtra()
3402 * or null if no Parcelable[] value was found.
3403 *
3404 * @see #putExtra(String, Parcelable[])
3405 */
3406 public Parcelable[] getParcelableArrayExtra(String name) {
3407 return mExtras == null ? null : mExtras.getParcelableArray(name);
3408 }
3409
3410 /**
3411 * Retrieve extended data from the intent.
3412 *
3413 * @param name The name of the desired item.
3414 *
3415 * @return the value of an item that previously added with putExtra()
3416 * or null if no ArrayList<Parcelable> value was found.
3417 *
3418 * @see #putParcelableArrayListExtra(String, ArrayList)
3419 */
3420 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3421 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3422 }
3423
3424 /**
3425 * Retrieve extended data from the intent.
3426 *
3427 * @param name The name of the desired item.
3428 *
3429 * @return the value of an item that previously added with putExtra()
3430 * or null if no Serializable value was found.
3431 *
3432 * @see #putExtra(String, Serializable)
3433 */
3434 public Serializable getSerializableExtra(String name) {
3435 return mExtras == null ? null : mExtras.getSerializable(name);
3436 }
3437
3438 /**
3439 * Retrieve extended data from the intent.
3440 *
3441 * @param name The name of the desired item.
3442 *
3443 * @return the value of an item that previously added with putExtra()
3444 * or null if no ArrayList<Integer> value was found.
3445 *
3446 * @see #putIntegerArrayListExtra(String, ArrayList)
3447 */
3448 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3449 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3450 }
3451
3452 /**
3453 * Retrieve extended data from the intent.
3454 *
3455 * @param name The name of the desired item.
3456 *
3457 * @return the value of an item that previously added with putExtra()
3458 * or null if no ArrayList<String> value was found.
3459 *
3460 * @see #putStringArrayListExtra(String, ArrayList)
3461 */
3462 public ArrayList<String> getStringArrayListExtra(String name) {
3463 return mExtras == null ? null : mExtras.getStringArrayList(name);
3464 }
3465
3466 /**
3467 * Retrieve extended data from the intent.
3468 *
3469 * @param name The name of the desired item.
3470 *
3471 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003472 * or null if no ArrayList<CharSequence> value was found.
3473 *
3474 * @see #putCharSequenceArrayListExtra(String, ArrayList)
3475 */
3476 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
3477 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
3478 }
3479
3480 /**
3481 * Retrieve extended data from the intent.
3482 *
3483 * @param name The name of the desired item.
3484 *
3485 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003486 * or null if no boolean array value was found.
3487 *
3488 * @see #putExtra(String, boolean[])
3489 */
3490 public boolean[] getBooleanArrayExtra(String name) {
3491 return mExtras == null ? null : mExtras.getBooleanArray(name);
3492 }
3493
3494 /**
3495 * Retrieve extended data from the intent.
3496 *
3497 * @param name The name of the desired item.
3498 *
3499 * @return the value of an item that previously added with putExtra()
3500 * or null if no byte array value was found.
3501 *
3502 * @see #putExtra(String, byte[])
3503 */
3504 public byte[] getByteArrayExtra(String name) {
3505 return mExtras == null ? null : mExtras.getByteArray(name);
3506 }
3507
3508 /**
3509 * Retrieve extended data from the intent.
3510 *
3511 * @param name The name of the desired item.
3512 *
3513 * @return the value of an item that previously added with putExtra()
3514 * or null if no short array value was found.
3515 *
3516 * @see #putExtra(String, short[])
3517 */
3518 public short[] getShortArrayExtra(String name) {
3519 return mExtras == null ? null : mExtras.getShortArray(name);
3520 }
3521
3522 /**
3523 * Retrieve extended data from the intent.
3524 *
3525 * @param name The name of the desired item.
3526 *
3527 * @return the value of an item that previously added with putExtra()
3528 * or null if no char array value was found.
3529 *
3530 * @see #putExtra(String, char[])
3531 */
3532 public char[] getCharArrayExtra(String name) {
3533 return mExtras == null ? null : mExtras.getCharArray(name);
3534 }
3535
3536 /**
3537 * Retrieve extended data from the intent.
3538 *
3539 * @param name The name of the desired item.
3540 *
3541 * @return the value of an item that previously added with putExtra()
3542 * or null if no int array value was found.
3543 *
3544 * @see #putExtra(String, int[])
3545 */
3546 public int[] getIntArrayExtra(String name) {
3547 return mExtras == null ? null : mExtras.getIntArray(name);
3548 }
3549
3550 /**
3551 * Retrieve extended data from the intent.
3552 *
3553 * @param name The name of the desired item.
3554 *
3555 * @return the value of an item that previously added with putExtra()
3556 * or null if no long array value was found.
3557 *
3558 * @see #putExtra(String, long[])
3559 */
3560 public long[] getLongArrayExtra(String name) {
3561 return mExtras == null ? null : mExtras.getLongArray(name);
3562 }
3563
3564 /**
3565 * Retrieve extended data from the intent.
3566 *
3567 * @param name The name of the desired item.
3568 *
3569 * @return the value of an item that previously added with putExtra()
3570 * or null if no float array value was found.
3571 *
3572 * @see #putExtra(String, float[])
3573 */
3574 public float[] getFloatArrayExtra(String name) {
3575 return mExtras == null ? null : mExtras.getFloatArray(name);
3576 }
3577
3578 /**
3579 * Retrieve extended data from the intent.
3580 *
3581 * @param name The name of the desired item.
3582 *
3583 * @return the value of an item that previously added with putExtra()
3584 * or null if no double array value was found.
3585 *
3586 * @see #putExtra(String, double[])
3587 */
3588 public double[] getDoubleArrayExtra(String name) {
3589 return mExtras == null ? null : mExtras.getDoubleArray(name);
3590 }
3591
3592 /**
3593 * Retrieve extended data from the intent.
3594 *
3595 * @param name The name of the desired item.
3596 *
3597 * @return the value of an item that previously added with putExtra()
3598 * or null if no String array value was found.
3599 *
3600 * @see #putExtra(String, String[])
3601 */
3602 public String[] getStringArrayExtra(String name) {
3603 return mExtras == null ? null : mExtras.getStringArray(name);
3604 }
3605
3606 /**
3607 * Retrieve extended data from the intent.
3608 *
3609 * @param name The name of the desired item.
3610 *
3611 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003612 * or null if no CharSequence array value was found.
3613 *
3614 * @see #putExtra(String, CharSequence[])
3615 */
3616 public CharSequence[] getCharSequenceArrayExtra(String name) {
3617 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
3618 }
3619
3620 /**
3621 * Retrieve extended data from the intent.
3622 *
3623 * @param name The name of the desired item.
3624 *
3625 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003626 * or null if no Bundle value was found.
3627 *
3628 * @see #putExtra(String, Bundle)
3629 */
3630 public Bundle getBundleExtra(String name) {
3631 return mExtras == null ? null : mExtras.getBundle(name);
3632 }
3633
3634 /**
3635 * Retrieve extended data from the intent.
3636 *
3637 * @param name The name of the desired item.
3638 *
3639 * @return the value of an item that previously added with putExtra()
3640 * or null if no IBinder value was found.
3641 *
3642 * @see #putExtra(String, IBinder)
3643 *
3644 * @deprecated
3645 * @hide
3646 */
3647 @Deprecated
3648 public IBinder getIBinderExtra(String name) {
3649 return mExtras == null ? null : mExtras.getIBinder(name);
3650 }
3651
3652 /**
3653 * Retrieve extended data from the intent.
3654 *
3655 * @param name The name of the desired item.
3656 * @param defaultValue The default value to return in case no item is
3657 * associated with the key 'name'
3658 *
3659 * @return the value of an item that previously added with putExtra()
3660 * or defaultValue if none was found.
3661 *
3662 * @see #putExtra
3663 *
3664 * @deprecated
3665 * @hide
3666 */
3667 @Deprecated
3668 public Object getExtra(String name, Object defaultValue) {
3669 Object result = defaultValue;
3670 if (mExtras != null) {
3671 Object result2 = mExtras.get(name);
3672 if (result2 != null) {
3673 result = result2;
3674 }
3675 }
3676
3677 return result;
3678 }
3679
3680 /**
3681 * Retrieves a map of extended data from the intent.
3682 *
3683 * @return the map of all extras previously added with putExtra(),
3684 * or null if none have been added.
3685 */
3686 public Bundle getExtras() {
3687 return (mExtras != null)
3688 ? new Bundle(mExtras)
3689 : null;
3690 }
3691
3692 /**
3693 * Retrieve any special flags associated with this intent. You will
3694 * normally just set them with {@link #setFlags} and let the system
3695 * take the appropriate action with them.
3696 *
3697 * @return int The currently set flags.
3698 *
3699 * @see #setFlags
3700 */
3701 public int getFlags() {
3702 return mFlags;
3703 }
3704
3705 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003706 * Retrieve the application package name this Intent is limited to. When
3707 * resolving an Intent, if non-null this limits the resolution to only
3708 * components in the given application package.
3709 *
3710 * @return The name of the application package for the Intent.
3711 *
3712 * @see #resolveActivity
3713 * @see #setPackage
3714 */
3715 public String getPackage() {
3716 return mPackage;
3717 }
3718
3719 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003720 * Retrieve the concrete component associated with the intent. When receiving
3721 * an intent, this is the component that was found to best handle it (that is,
3722 * yourself) and will always be non-null; in all other cases it will be
3723 * null unless explicitly set.
3724 *
3725 * @return The name of the application component to handle the intent.
3726 *
3727 * @see #resolveActivity
3728 * @see #setComponent
3729 */
3730 public ComponentName getComponent() {
3731 return mComponent;
3732 }
3733
3734 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003735 * Get the bounds of the sender of this intent, in screen coordinates. This can be
3736 * used as a hint to the receiver for animations and the like. Null means that there
3737 * is no source bounds.
3738 */
3739 public Rect getSourceBounds() {
3740 return mSourceBounds;
3741 }
3742
3743 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003744 * Return the Activity component that should be used to handle this intent.
3745 * The appropriate component is determined based on the information in the
3746 * intent, evaluated as follows:
3747 *
3748 * <p>If {@link #getComponent} returns an explicit class, that is returned
3749 * without any further consideration.
3750 *
3751 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
3752 * category to be considered.
3753 *
3754 * <p>If {@link #getAction} is non-NULL, the activity must handle this
3755 * action.
3756 *
3757 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
3758 * this type.
3759 *
3760 * <p>If {@link #addCategory} has added any categories, the activity must
3761 * handle ALL of the categories specified.
3762 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003763 * <p>If {@link #getPackage} is non-NULL, only activity components in
3764 * that application package will be considered.
3765 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003766 * <p>If there are no activities that satisfy all of these conditions, a
3767 * null string is returned.
3768 *
3769 * <p>If multiple activities are found to satisfy the intent, the one with
3770 * the highest priority will be used. If there are multiple activities
3771 * with the same priority, the system will either pick the best activity
3772 * based on user preference, or resolve to a system class that will allow
3773 * the user to pick an activity and forward from there.
3774 *
3775 * <p>This method is implemented simply by calling
3776 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
3777 * true.</p>
3778 * <p> This API is called for you as part of starting an activity from an
3779 * intent. You do not normally need to call it yourself.</p>
3780 *
3781 * @param pm The package manager with which to resolve the Intent.
3782 *
3783 * @return Name of the component implementing an activity that can
3784 * display the intent.
3785 *
3786 * @see #setComponent
3787 * @see #getComponent
3788 * @see #resolveActivityInfo
3789 */
3790 public ComponentName resolveActivity(PackageManager pm) {
3791 if (mComponent != null) {
3792 return mComponent;
3793 }
3794
3795 ResolveInfo info = pm.resolveActivity(
3796 this, PackageManager.MATCH_DEFAULT_ONLY);
3797 if (info != null) {
3798 return new ComponentName(
3799 info.activityInfo.applicationInfo.packageName,
3800 info.activityInfo.name);
3801 }
3802
3803 return null;
3804 }
3805
3806 /**
3807 * Resolve the Intent into an {@link ActivityInfo}
3808 * describing the activity that should execute the intent. Resolution
3809 * follows the same rules as described for {@link #resolveActivity}, but
3810 * you get back the completely information about the resolved activity
3811 * instead of just its class name.
3812 *
3813 * @param pm The package manager with which to resolve the Intent.
3814 * @param flags Addition information to retrieve as per
3815 * {@link PackageManager#getActivityInfo(ComponentName, int)
3816 * PackageManager.getActivityInfo()}.
3817 *
3818 * @return PackageManager.ActivityInfo
3819 *
3820 * @see #resolveActivity
3821 */
3822 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
3823 ActivityInfo ai = null;
3824 if (mComponent != null) {
3825 try {
3826 ai = pm.getActivityInfo(mComponent, flags);
3827 } catch (PackageManager.NameNotFoundException e) {
3828 // ignore
3829 }
3830 } else {
3831 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003832 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003833 if (info != null) {
3834 ai = info.activityInfo;
3835 }
3836 }
3837
3838 return ai;
3839 }
3840
3841 /**
3842 * Set the general action to be performed.
3843 *
3844 * @param action An action name, such as ACTION_VIEW. Application-specific
3845 * actions should be prefixed with the vendor's package name.
3846 *
3847 * @return Returns the same Intent object, for chaining multiple calls
3848 * into a single statement.
3849 *
3850 * @see #getAction
3851 */
3852 public Intent setAction(String action) {
3853 mAction = action;
3854 return this;
3855 }
3856
3857 /**
3858 * Set the data this intent is operating on. This method automatically
3859 * clears any type that was previously set by {@link #setType}.
3860 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003861 * <p><em>Note: scheme and host name matching in the Android framework is
3862 * case-sensitive, unlike the formal RFC. As a result,
3863 * you should always ensure that you write your Uri with these elements
3864 * using lower case letters, and normalize any Uris you receive from
3865 * outside of Android to ensure the scheme and host is lower case.</em></p>
3866 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003867 * @param data The URI of the data this intent is now targeting.
3868 *
3869 * @return Returns the same Intent object, for chaining multiple calls
3870 * into a single statement.
3871 *
3872 * @see #getData
3873 * @see #setType
3874 * @see #setDataAndType
3875 */
3876 public Intent setData(Uri data) {
3877 mData = data;
3878 mType = null;
3879 return this;
3880 }
3881
3882 /**
3883 * Set an explicit MIME data type. This is used to create intents that
3884 * only specify a type and not data, for example to indicate the type of
3885 * data to return. This method automatically clears any data that was
3886 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07003887 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003888 * <p><em>Note: MIME type matching in the Android framework is
3889 * case-sensitive, unlike formal RFC MIME types. As a result,
3890 * you should always write your MIME types with lower case letters,
3891 * and any MIME types you receive from outside of Android should be
3892 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003893 *
3894 * @param type The MIME type of the data being handled by this intent.
3895 *
3896 * @return Returns the same Intent object, for chaining multiple calls
3897 * into a single statement.
3898 *
3899 * @see #getType
3900 * @see #setData
3901 * @see #setDataAndType
3902 */
3903 public Intent setType(String type) {
3904 mData = null;
3905 mType = type;
3906 return this;
3907 }
3908
3909 /**
3910 * (Usually optional) Set the data for the intent along with an explicit
3911 * MIME data type. This method should very rarely be used -- it allows you
3912 * to override the MIME type that would ordinarily be inferred from the
3913 * data with your own type given here.
3914 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003915 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
3916 * Android framework is case-sensitive, unlike the formal RFC definitions.
3917 * As a result, you should always write these elements with lower case letters,
3918 * and normalize any MIME types or Uris you receive from
3919 * outside of Android to ensure these elements are lower case before
3920 * supplying them here.</em></p>
3921 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003922 * @param data The URI of the data this intent is now targeting.
3923 * @param type The MIME type of the data being handled by this intent.
3924 *
3925 * @return Returns the same Intent object, for chaining multiple calls
3926 * into a single statement.
3927 *
3928 * @see #setData
3929 * @see #setType
3930 */
3931 public Intent setDataAndType(Uri data, String type) {
3932 mData = data;
3933 mType = type;
3934 return this;
3935 }
3936
3937 /**
3938 * Add a new category to the intent. Categories provide additional detail
3939 * about the action the intent is perform. When resolving an intent, only
3940 * activities that provide <em>all</em> of the requested categories will be
3941 * used.
3942 *
3943 * @param category The desired category. This can be either one of the
3944 * predefined Intent categories, or a custom category in your own
3945 * namespace.
3946 *
3947 * @return Returns the same Intent object, for chaining multiple calls
3948 * into a single statement.
3949 *
3950 * @see #hasCategory
3951 * @see #removeCategory
3952 */
3953 public Intent addCategory(String category) {
3954 if (mCategories == null) {
3955 mCategories = new HashSet<String>();
3956 }
3957 mCategories.add(category);
3958 return this;
3959 }
3960
3961 /**
3962 * Remove an category from an intent.
3963 *
3964 * @param category The category to remove.
3965 *
3966 * @see #addCategory
3967 */
3968 public void removeCategory(String category) {
3969 if (mCategories != null) {
3970 mCategories.remove(category);
3971 if (mCategories.size() == 0) {
3972 mCategories = null;
3973 }
3974 }
3975 }
3976
3977 /**
3978 * Add extended data to the intent. The name must include a package
3979 * prefix, for example the app com.android.contacts would use names
3980 * like "com.android.contacts.ShowAll".
3981 *
3982 * @param name The name of the extra data, with package prefix.
3983 * @param value The boolean data value.
3984 *
3985 * @return Returns the same Intent object, for chaining multiple calls
3986 * into a single statement.
3987 *
3988 * @see #putExtras
3989 * @see #removeExtra
3990 * @see #getBooleanExtra(String, boolean)
3991 */
3992 public Intent putExtra(String name, boolean value) {
3993 if (mExtras == null) {
3994 mExtras = new Bundle();
3995 }
3996 mExtras.putBoolean(name, value);
3997 return this;
3998 }
3999
4000 /**
4001 * Add extended data to the intent. The name must include a package
4002 * prefix, for example the app com.android.contacts would use names
4003 * like "com.android.contacts.ShowAll".
4004 *
4005 * @param name The name of the extra data, with package prefix.
4006 * @param value The byte data value.
4007 *
4008 * @return Returns the same Intent object, for chaining multiple calls
4009 * into a single statement.
4010 *
4011 * @see #putExtras
4012 * @see #removeExtra
4013 * @see #getByteExtra(String, byte)
4014 */
4015 public Intent putExtra(String name, byte value) {
4016 if (mExtras == null) {
4017 mExtras = new Bundle();
4018 }
4019 mExtras.putByte(name, value);
4020 return this;
4021 }
4022
4023 /**
4024 * Add extended data to the intent. The name must include a package
4025 * prefix, for example the app com.android.contacts would use names
4026 * like "com.android.contacts.ShowAll".
4027 *
4028 * @param name The name of the extra data, with package prefix.
4029 * @param value The char data value.
4030 *
4031 * @return Returns the same Intent object, for chaining multiple calls
4032 * into a single statement.
4033 *
4034 * @see #putExtras
4035 * @see #removeExtra
4036 * @see #getCharExtra(String, char)
4037 */
4038 public Intent putExtra(String name, char value) {
4039 if (mExtras == null) {
4040 mExtras = new Bundle();
4041 }
4042 mExtras.putChar(name, value);
4043 return this;
4044 }
4045
4046 /**
4047 * Add extended data to the intent. The name must include a package
4048 * prefix, for example the app com.android.contacts would use names
4049 * like "com.android.contacts.ShowAll".
4050 *
4051 * @param name The name of the extra data, with package prefix.
4052 * @param value The short data value.
4053 *
4054 * @return Returns the same Intent object, for chaining multiple calls
4055 * into a single statement.
4056 *
4057 * @see #putExtras
4058 * @see #removeExtra
4059 * @see #getShortExtra(String, short)
4060 */
4061 public Intent putExtra(String name, short value) {
4062 if (mExtras == null) {
4063 mExtras = new Bundle();
4064 }
4065 mExtras.putShort(name, value);
4066 return this;
4067 }
4068
4069 /**
4070 * Add extended data to the intent. The name must include a package
4071 * prefix, for example the app com.android.contacts would use names
4072 * like "com.android.contacts.ShowAll".
4073 *
4074 * @param name The name of the extra data, with package prefix.
4075 * @param value The integer data value.
4076 *
4077 * @return Returns the same Intent object, for chaining multiple calls
4078 * into a single statement.
4079 *
4080 * @see #putExtras
4081 * @see #removeExtra
4082 * @see #getIntExtra(String, int)
4083 */
4084 public Intent putExtra(String name, int value) {
4085 if (mExtras == null) {
4086 mExtras = new Bundle();
4087 }
4088 mExtras.putInt(name, value);
4089 return this;
4090 }
4091
4092 /**
4093 * Add extended data to the intent. The name must include a package
4094 * prefix, for example the app com.android.contacts would use names
4095 * like "com.android.contacts.ShowAll".
4096 *
4097 * @param name The name of the extra data, with package prefix.
4098 * @param value The long data value.
4099 *
4100 * @return Returns the same Intent object, for chaining multiple calls
4101 * into a single statement.
4102 *
4103 * @see #putExtras
4104 * @see #removeExtra
4105 * @see #getLongExtra(String, long)
4106 */
4107 public Intent putExtra(String name, long value) {
4108 if (mExtras == null) {
4109 mExtras = new Bundle();
4110 }
4111 mExtras.putLong(name, value);
4112 return this;
4113 }
4114
4115 /**
4116 * Add extended data to the intent. The name must include a package
4117 * prefix, for example the app com.android.contacts would use names
4118 * like "com.android.contacts.ShowAll".
4119 *
4120 * @param name The name of the extra data, with package prefix.
4121 * @param value The float data value.
4122 *
4123 * @return Returns the same Intent object, for chaining multiple calls
4124 * into a single statement.
4125 *
4126 * @see #putExtras
4127 * @see #removeExtra
4128 * @see #getFloatExtra(String, float)
4129 */
4130 public Intent putExtra(String name, float value) {
4131 if (mExtras == null) {
4132 mExtras = new Bundle();
4133 }
4134 mExtras.putFloat(name, value);
4135 return this;
4136 }
4137
4138 /**
4139 * Add extended data to the intent. The name must include a package
4140 * prefix, for example the app com.android.contacts would use names
4141 * like "com.android.contacts.ShowAll".
4142 *
4143 * @param name The name of the extra data, with package prefix.
4144 * @param value The double data value.
4145 *
4146 * @return Returns the same Intent object, for chaining multiple calls
4147 * into a single statement.
4148 *
4149 * @see #putExtras
4150 * @see #removeExtra
4151 * @see #getDoubleExtra(String, double)
4152 */
4153 public Intent putExtra(String name, double value) {
4154 if (mExtras == null) {
4155 mExtras = new Bundle();
4156 }
4157 mExtras.putDouble(name, value);
4158 return this;
4159 }
4160
4161 /**
4162 * Add extended data to the intent. The name must include a package
4163 * prefix, for example the app com.android.contacts would use names
4164 * like "com.android.contacts.ShowAll".
4165 *
4166 * @param name The name of the extra data, with package prefix.
4167 * @param value The String data value.
4168 *
4169 * @return Returns the same Intent object, for chaining multiple calls
4170 * into a single statement.
4171 *
4172 * @see #putExtras
4173 * @see #removeExtra
4174 * @see #getStringExtra(String)
4175 */
4176 public Intent putExtra(String name, String value) {
4177 if (mExtras == null) {
4178 mExtras = new Bundle();
4179 }
4180 mExtras.putString(name, value);
4181 return this;
4182 }
4183
4184 /**
4185 * Add extended data to the intent. The name must include a package
4186 * prefix, for example the app com.android.contacts would use names
4187 * like "com.android.contacts.ShowAll".
4188 *
4189 * @param name The name of the extra data, with package prefix.
4190 * @param value The CharSequence data value.
4191 *
4192 * @return Returns the same Intent object, for chaining multiple calls
4193 * into a single statement.
4194 *
4195 * @see #putExtras
4196 * @see #removeExtra
4197 * @see #getCharSequenceExtra(String)
4198 */
4199 public Intent putExtra(String name, CharSequence value) {
4200 if (mExtras == null) {
4201 mExtras = new Bundle();
4202 }
4203 mExtras.putCharSequence(name, value);
4204 return this;
4205 }
4206
4207 /**
4208 * Add extended data to the intent. The name must include a package
4209 * prefix, for example the app com.android.contacts would use names
4210 * like "com.android.contacts.ShowAll".
4211 *
4212 * @param name The name of the extra data, with package prefix.
4213 * @param value The Parcelable data value.
4214 *
4215 * @return Returns the same Intent object, for chaining multiple calls
4216 * into a single statement.
4217 *
4218 * @see #putExtras
4219 * @see #removeExtra
4220 * @see #getParcelableExtra(String)
4221 */
4222 public Intent putExtra(String name, Parcelable value) {
4223 if (mExtras == null) {
4224 mExtras = new Bundle();
4225 }
4226 mExtras.putParcelable(name, value);
4227 return this;
4228 }
4229
4230 /**
4231 * Add extended data to the intent. The name must include a package
4232 * prefix, for example the app com.android.contacts would use names
4233 * like "com.android.contacts.ShowAll".
4234 *
4235 * @param name The name of the extra data, with package prefix.
4236 * @param value The Parcelable[] data value.
4237 *
4238 * @return Returns the same Intent object, for chaining multiple calls
4239 * into a single statement.
4240 *
4241 * @see #putExtras
4242 * @see #removeExtra
4243 * @see #getParcelableArrayExtra(String)
4244 */
4245 public Intent putExtra(String name, Parcelable[] value) {
4246 if (mExtras == null) {
4247 mExtras = new Bundle();
4248 }
4249 mExtras.putParcelableArray(name, value);
4250 return this;
4251 }
4252
4253 /**
4254 * Add extended data to the intent. The name must include a package
4255 * prefix, for example the app com.android.contacts would use names
4256 * like "com.android.contacts.ShowAll".
4257 *
4258 * @param name The name of the extra data, with package prefix.
4259 * @param value The ArrayList<Parcelable> data value.
4260 *
4261 * @return Returns the same Intent object, for chaining multiple calls
4262 * into a single statement.
4263 *
4264 * @see #putExtras
4265 * @see #removeExtra
4266 * @see #getParcelableArrayListExtra(String)
4267 */
4268 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4269 if (mExtras == null) {
4270 mExtras = new Bundle();
4271 }
4272 mExtras.putParcelableArrayList(name, value);
4273 return this;
4274 }
4275
4276 /**
4277 * Add extended data to the intent. The name must include a package
4278 * prefix, for example the app com.android.contacts would use names
4279 * like "com.android.contacts.ShowAll".
4280 *
4281 * @param name The name of the extra data, with package prefix.
4282 * @param value The ArrayList<Integer> data value.
4283 *
4284 * @return Returns the same Intent object, for chaining multiple calls
4285 * into a single statement.
4286 *
4287 * @see #putExtras
4288 * @see #removeExtra
4289 * @see #getIntegerArrayListExtra(String)
4290 */
4291 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4292 if (mExtras == null) {
4293 mExtras = new Bundle();
4294 }
4295 mExtras.putIntegerArrayList(name, value);
4296 return this;
4297 }
4298
4299 /**
4300 * Add extended data to the intent. The name must include a package
4301 * prefix, for example the app com.android.contacts would use names
4302 * like "com.android.contacts.ShowAll".
4303 *
4304 * @param name The name of the extra data, with package prefix.
4305 * @param value The ArrayList<String> data value.
4306 *
4307 * @return Returns the same Intent object, for chaining multiple calls
4308 * into a single statement.
4309 *
4310 * @see #putExtras
4311 * @see #removeExtra
4312 * @see #getStringArrayListExtra(String)
4313 */
4314 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4315 if (mExtras == null) {
4316 mExtras = new Bundle();
4317 }
4318 mExtras.putStringArrayList(name, value);
4319 return this;
4320 }
4321
4322 /**
4323 * Add extended data to the intent. The name must include a package
4324 * prefix, for example the app com.android.contacts would use names
4325 * like "com.android.contacts.ShowAll".
4326 *
4327 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004328 * @param value The ArrayList<CharSequence> data value.
4329 *
4330 * @return Returns the same Intent object, for chaining multiple calls
4331 * into a single statement.
4332 *
4333 * @see #putExtras
4334 * @see #removeExtra
4335 * @see #getCharSequenceArrayListExtra(String)
4336 */
4337 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
4338 if (mExtras == null) {
4339 mExtras = new Bundle();
4340 }
4341 mExtras.putCharSequenceArrayList(name, value);
4342 return this;
4343 }
4344
4345 /**
4346 * Add extended data to the intent. The name must include a package
4347 * prefix, for example the app com.android.contacts would use names
4348 * like "com.android.contacts.ShowAll".
4349 *
4350 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004351 * @param value The Serializable data value.
4352 *
4353 * @return Returns the same Intent object, for chaining multiple calls
4354 * into a single statement.
4355 *
4356 * @see #putExtras
4357 * @see #removeExtra
4358 * @see #getSerializableExtra(String)
4359 */
4360 public Intent putExtra(String name, Serializable value) {
4361 if (mExtras == null) {
4362 mExtras = new Bundle();
4363 }
4364 mExtras.putSerializable(name, value);
4365 return this;
4366 }
4367
4368 /**
4369 * Add extended data to the intent. The name must include a package
4370 * prefix, for example the app com.android.contacts would use names
4371 * like "com.android.contacts.ShowAll".
4372 *
4373 * @param name The name of the extra data, with package prefix.
4374 * @param value The boolean array data value.
4375 *
4376 * @return Returns the same Intent object, for chaining multiple calls
4377 * into a single statement.
4378 *
4379 * @see #putExtras
4380 * @see #removeExtra
4381 * @see #getBooleanArrayExtra(String)
4382 */
4383 public Intent putExtra(String name, boolean[] value) {
4384 if (mExtras == null) {
4385 mExtras = new Bundle();
4386 }
4387 mExtras.putBooleanArray(name, value);
4388 return this;
4389 }
4390
4391 /**
4392 * Add extended data to the intent. The name must include a package
4393 * prefix, for example the app com.android.contacts would use names
4394 * like "com.android.contacts.ShowAll".
4395 *
4396 * @param name The name of the extra data, with package prefix.
4397 * @param value The byte array data value.
4398 *
4399 * @return Returns the same Intent object, for chaining multiple calls
4400 * into a single statement.
4401 *
4402 * @see #putExtras
4403 * @see #removeExtra
4404 * @see #getByteArrayExtra(String)
4405 */
4406 public Intent putExtra(String name, byte[] value) {
4407 if (mExtras == null) {
4408 mExtras = new Bundle();
4409 }
4410 mExtras.putByteArray(name, value);
4411 return this;
4412 }
4413
4414 /**
4415 * Add extended data to the intent. The name must include a package
4416 * prefix, for example the app com.android.contacts would use names
4417 * like "com.android.contacts.ShowAll".
4418 *
4419 * @param name The name of the extra data, with package prefix.
4420 * @param value The short array data value.
4421 *
4422 * @return Returns the same Intent object, for chaining multiple calls
4423 * into a single statement.
4424 *
4425 * @see #putExtras
4426 * @see #removeExtra
4427 * @see #getShortArrayExtra(String)
4428 */
4429 public Intent putExtra(String name, short[] value) {
4430 if (mExtras == null) {
4431 mExtras = new Bundle();
4432 }
4433 mExtras.putShortArray(name, value);
4434 return this;
4435 }
4436
4437 /**
4438 * Add extended data to the intent. The name must include a package
4439 * prefix, for example the app com.android.contacts would use names
4440 * like "com.android.contacts.ShowAll".
4441 *
4442 * @param name The name of the extra data, with package prefix.
4443 * @param value The char array data value.
4444 *
4445 * @return Returns the same Intent object, for chaining multiple calls
4446 * into a single statement.
4447 *
4448 * @see #putExtras
4449 * @see #removeExtra
4450 * @see #getCharArrayExtra(String)
4451 */
4452 public Intent putExtra(String name, char[] value) {
4453 if (mExtras == null) {
4454 mExtras = new Bundle();
4455 }
4456 mExtras.putCharArray(name, value);
4457 return this;
4458 }
4459
4460 /**
4461 * Add extended data to the intent. The name must include a package
4462 * prefix, for example the app com.android.contacts would use names
4463 * like "com.android.contacts.ShowAll".
4464 *
4465 * @param name The name of the extra data, with package prefix.
4466 * @param value The int array data value.
4467 *
4468 * @return Returns the same Intent object, for chaining multiple calls
4469 * into a single statement.
4470 *
4471 * @see #putExtras
4472 * @see #removeExtra
4473 * @see #getIntArrayExtra(String)
4474 */
4475 public Intent putExtra(String name, int[] value) {
4476 if (mExtras == null) {
4477 mExtras = new Bundle();
4478 }
4479 mExtras.putIntArray(name, value);
4480 return this;
4481 }
4482
4483 /**
4484 * Add extended data to the intent. The name must include a package
4485 * prefix, for example the app com.android.contacts would use names
4486 * like "com.android.contacts.ShowAll".
4487 *
4488 * @param name The name of the extra data, with package prefix.
4489 * @param value The byte array data value.
4490 *
4491 * @return Returns the same Intent object, for chaining multiple calls
4492 * into a single statement.
4493 *
4494 * @see #putExtras
4495 * @see #removeExtra
4496 * @see #getLongArrayExtra(String)
4497 */
4498 public Intent putExtra(String name, long[] value) {
4499 if (mExtras == null) {
4500 mExtras = new Bundle();
4501 }
4502 mExtras.putLongArray(name, value);
4503 return this;
4504 }
4505
4506 /**
4507 * Add extended data to the intent. The name must include a package
4508 * prefix, for example the app com.android.contacts would use names
4509 * like "com.android.contacts.ShowAll".
4510 *
4511 * @param name The name of the extra data, with package prefix.
4512 * @param value The float array data value.
4513 *
4514 * @return Returns the same Intent object, for chaining multiple calls
4515 * into a single statement.
4516 *
4517 * @see #putExtras
4518 * @see #removeExtra
4519 * @see #getFloatArrayExtra(String)
4520 */
4521 public Intent putExtra(String name, float[] value) {
4522 if (mExtras == null) {
4523 mExtras = new Bundle();
4524 }
4525 mExtras.putFloatArray(name, value);
4526 return this;
4527 }
4528
4529 /**
4530 * Add extended data to the intent. The name must include a package
4531 * prefix, for example the app com.android.contacts would use names
4532 * like "com.android.contacts.ShowAll".
4533 *
4534 * @param name The name of the extra data, with package prefix.
4535 * @param value The double array data value.
4536 *
4537 * @return Returns the same Intent object, for chaining multiple calls
4538 * into a single statement.
4539 *
4540 * @see #putExtras
4541 * @see #removeExtra
4542 * @see #getDoubleArrayExtra(String)
4543 */
4544 public Intent putExtra(String name, double[] value) {
4545 if (mExtras == null) {
4546 mExtras = new Bundle();
4547 }
4548 mExtras.putDoubleArray(name, value);
4549 return this;
4550 }
4551
4552 /**
4553 * Add extended data to the intent. The name must include a package
4554 * prefix, for example the app com.android.contacts would use names
4555 * like "com.android.contacts.ShowAll".
4556 *
4557 * @param name The name of the extra data, with package prefix.
4558 * @param value The String array data value.
4559 *
4560 * @return Returns the same Intent object, for chaining multiple calls
4561 * into a single statement.
4562 *
4563 * @see #putExtras
4564 * @see #removeExtra
4565 * @see #getStringArrayExtra(String)
4566 */
4567 public Intent putExtra(String name, String[] value) {
4568 if (mExtras == null) {
4569 mExtras = new Bundle();
4570 }
4571 mExtras.putStringArray(name, value);
4572 return this;
4573 }
4574
4575 /**
4576 * Add extended data to the intent. The name must include a package
4577 * prefix, for example the app com.android.contacts would use names
4578 * like "com.android.contacts.ShowAll".
4579 *
4580 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004581 * @param value The CharSequence array data value.
4582 *
4583 * @return Returns the same Intent object, for chaining multiple calls
4584 * into a single statement.
4585 *
4586 * @see #putExtras
4587 * @see #removeExtra
4588 * @see #getCharSequenceArrayExtra(String)
4589 */
4590 public Intent putExtra(String name, CharSequence[] value) {
4591 if (mExtras == null) {
4592 mExtras = new Bundle();
4593 }
4594 mExtras.putCharSequenceArray(name, value);
4595 return this;
4596 }
4597
4598 /**
4599 * Add extended data to the intent. The name must include a package
4600 * prefix, for example the app com.android.contacts would use names
4601 * like "com.android.contacts.ShowAll".
4602 *
4603 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004604 * @param value The Bundle data value.
4605 *
4606 * @return Returns the same Intent object, for chaining multiple calls
4607 * into a single statement.
4608 *
4609 * @see #putExtras
4610 * @see #removeExtra
4611 * @see #getBundleExtra(String)
4612 */
4613 public Intent putExtra(String name, Bundle value) {
4614 if (mExtras == null) {
4615 mExtras = new Bundle();
4616 }
4617 mExtras.putBundle(name, value);
4618 return this;
4619 }
4620
4621 /**
4622 * Add extended data to the intent. The name must include a package
4623 * prefix, for example the app com.android.contacts would use names
4624 * like "com.android.contacts.ShowAll".
4625 *
4626 * @param name The name of the extra data, with package prefix.
4627 * @param value The IBinder data value.
4628 *
4629 * @return Returns the same Intent object, for chaining multiple calls
4630 * into a single statement.
4631 *
4632 * @see #putExtras
4633 * @see #removeExtra
4634 * @see #getIBinderExtra(String)
4635 *
4636 * @deprecated
4637 * @hide
4638 */
4639 @Deprecated
4640 public Intent putExtra(String name, IBinder value) {
4641 if (mExtras == null) {
4642 mExtras = new Bundle();
4643 }
4644 mExtras.putIBinder(name, value);
4645 return this;
4646 }
4647
4648 /**
4649 * Copy all extras in 'src' in to this intent.
4650 *
4651 * @param src Contains the extras to copy.
4652 *
4653 * @see #putExtra
4654 */
4655 public Intent putExtras(Intent src) {
4656 if (src.mExtras != null) {
4657 if (mExtras == null) {
4658 mExtras = new Bundle(src.mExtras);
4659 } else {
4660 mExtras.putAll(src.mExtras);
4661 }
4662 }
4663 return this;
4664 }
4665
4666 /**
4667 * Add a set of extended data to the intent. The keys must include a package
4668 * prefix, for example the app com.android.contacts would use names
4669 * like "com.android.contacts.ShowAll".
4670 *
4671 * @param extras The Bundle of extras to add to this intent.
4672 *
4673 * @see #putExtra
4674 * @see #removeExtra
4675 */
4676 public Intent putExtras(Bundle extras) {
4677 if (mExtras == null) {
4678 mExtras = new Bundle();
4679 }
4680 mExtras.putAll(extras);
4681 return this;
4682 }
4683
4684 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004685 * Completely replace the extras in the Intent with the extras in the
4686 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07004687 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004688 * @param src The exact extras contained in this Intent are copied
4689 * into the target intent, replacing any that were previously there.
4690 */
4691 public Intent replaceExtras(Intent src) {
4692 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
4693 return this;
4694 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004695
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004696 /**
4697 * Completely replace the extras in the Intent with the given Bundle of
4698 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07004699 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004700 * @param extras The new set of extras in the Intent, or null to erase
4701 * all extras.
4702 */
4703 public Intent replaceExtras(Bundle extras) {
4704 mExtras = extras != null ? new Bundle(extras) : 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 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004709 * Remove extended data from the intent.
4710 *
4711 * @see #putExtra
4712 */
4713 public void removeExtra(String name) {
4714 if (mExtras != null) {
4715 mExtras.remove(name);
4716 if (mExtras.size() == 0) {
4717 mExtras = null;
4718 }
4719 }
4720 }
4721
4722 /**
4723 * Set special flags controlling how this intent is handled. Most values
4724 * here depend on the type of component being executed by the Intent,
4725 * specifically the FLAG_ACTIVITY_* flags are all for use with
4726 * {@link Context#startActivity Context.startActivity()} and the
4727 * FLAG_RECEIVER_* flags are all for use with
4728 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
4729 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08004730 * <p>See the <a href="{@docRoot}guide/topics/fundamentals.html#acttask">Application Fundamentals:
4731 * 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 -07004732 * the behavior of your application.
4733 *
4734 * @param flags The desired flags.
4735 *
4736 * @return Returns the same Intent object, for chaining multiple calls
4737 * into a single statement.
4738 *
4739 * @see #getFlags
4740 * @see #addFlags
4741 *
4742 * @see #FLAG_GRANT_READ_URI_PERMISSION
4743 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
4744 * @see #FLAG_DEBUG_LOG_RESOLUTION
4745 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004746 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004747 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004748 * @see #FLAG_ACTIVITY_CLEAR_TOP
4749 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
4750 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004751 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004752 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
4753 * @see #FLAG_ACTIVITY_NEW_TASK
4754 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08004755 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08004756 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
4757 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004758 * @see #FLAG_ACTIVITY_SINGLE_TOP
4759 * @see #FLAG_RECEIVER_REGISTERED_ONLY
4760 */
4761 public Intent setFlags(int flags) {
4762 mFlags = flags;
4763 return this;
4764 }
4765
4766 /**
4767 * Add additional flags to the intent (or with existing flags
4768 * value).
4769 *
4770 * @param flags The new flags to set.
4771 *
4772 * @return Returns the same Intent object, for chaining multiple calls
4773 * into a single statement.
4774 *
4775 * @see #setFlags
4776 */
4777 public Intent addFlags(int flags) {
4778 mFlags |= flags;
4779 return this;
4780 }
4781
4782 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004783 * (Usually optional) Set an explicit application package name that limits
4784 * the components this Intent will resolve to. If left to the default
4785 * value of null, all components in all applications will considered.
4786 * If non-null, the Intent can only match the components in the given
4787 * application package.
4788 *
4789 * @param packageName The name of the application package to handle the
4790 * intent, or null to allow any application package.
4791 *
4792 * @return Returns the same Intent object, for chaining multiple calls
4793 * into a single statement.
4794 *
4795 * @see #getPackage
4796 * @see #resolveActivity
4797 */
4798 public Intent setPackage(String packageName) {
4799 mPackage = packageName;
4800 return this;
4801 }
4802
4803 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004804 * (Usually optional) Explicitly set the component to handle the intent.
4805 * If left with the default value of null, the system will determine the
4806 * appropriate class to use based on the other fields (action, data,
4807 * type, categories) in the Intent. If this class is defined, the
4808 * specified class will always be used regardless of the other fields. You
4809 * should only set this value when you know you absolutely want a specific
4810 * class to be used; otherwise it is better to let the system find the
4811 * appropriate class so that you will respect the installed applications
4812 * and user preferences.
4813 *
4814 * @param component The name of the application component to handle the
4815 * intent, or null to let the system find one for you.
4816 *
4817 * @return Returns the same Intent object, for chaining multiple calls
4818 * into a single statement.
4819 *
4820 * @see #setClass
4821 * @see #setClassName(Context, String)
4822 * @see #setClassName(String, String)
4823 * @see #getComponent
4824 * @see #resolveActivity
4825 */
4826 public Intent setComponent(ComponentName component) {
4827 mComponent = component;
4828 return this;
4829 }
4830
4831 /**
4832 * Convenience for calling {@link #setComponent} with an
4833 * explicit class name.
4834 *
4835 * @param packageContext A Context of the application package implementing
4836 * this class.
4837 * @param className The name of a class inside of the application package
4838 * that will be used as the component for this Intent.
4839 *
4840 * @return Returns the same Intent object, for chaining multiple calls
4841 * into a single statement.
4842 *
4843 * @see #setComponent
4844 * @see #setClass
4845 */
4846 public Intent setClassName(Context packageContext, String className) {
4847 mComponent = new ComponentName(packageContext, className);
4848 return this;
4849 }
4850
4851 /**
4852 * Convenience for calling {@link #setComponent} with an
4853 * explicit application package name and class name.
4854 *
4855 * @param packageName The name of the package implementing the desired
4856 * component.
4857 * @param className The name of a class inside of the application package
4858 * that will be used as the component for this Intent.
4859 *
4860 * @return Returns the same Intent object, for chaining multiple calls
4861 * into a single statement.
4862 *
4863 * @see #setComponent
4864 * @see #setClass
4865 */
4866 public Intent setClassName(String packageName, String className) {
4867 mComponent = new ComponentName(packageName, className);
4868 return this;
4869 }
4870
4871 /**
4872 * Convenience for calling {@link #setComponent(ComponentName)} with the
4873 * name returned by a {@link Class} object.
4874 *
4875 * @param packageContext A Context of the application package implementing
4876 * this class.
4877 * @param cls The class name to set, equivalent to
4878 * <code>setClassName(context, cls.getName())</code>.
4879 *
4880 * @return Returns the same Intent object, for chaining multiple calls
4881 * into a single statement.
4882 *
4883 * @see #setComponent
4884 */
4885 public Intent setClass(Context packageContext, Class<?> cls) {
4886 mComponent = new ComponentName(packageContext, cls);
4887 return this;
4888 }
4889
4890 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004891 * Set the bounds of the sender of this intent, in screen coordinates. This can be
4892 * used as a hint to the receiver for animations and the like. Null means that there
4893 * is no source bounds.
4894 */
4895 public void setSourceBounds(Rect r) {
4896 if (r != null) {
4897 mSourceBounds = new Rect(r);
4898 } else {
4899 r = null;
4900 }
4901 }
4902
4903 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004904 * Use with {@link #fillIn} to allow the current action value to be
4905 * overwritten, even if it is already set.
4906 */
4907 public static final int FILL_IN_ACTION = 1<<0;
4908
4909 /**
4910 * Use with {@link #fillIn} to allow the current data or type value
4911 * overwritten, even if it is already set.
4912 */
4913 public static final int FILL_IN_DATA = 1<<1;
4914
4915 /**
4916 * Use with {@link #fillIn} to allow the current categories to be
4917 * overwritten, even if they are already set.
4918 */
4919 public static final int FILL_IN_CATEGORIES = 1<<2;
4920
4921 /**
4922 * Use with {@link #fillIn} to allow the current component value to be
4923 * overwritten, even if it is already set.
4924 */
4925 public static final int FILL_IN_COMPONENT = 1<<3;
4926
4927 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004928 * Use with {@link #fillIn} to allow the current package value to be
4929 * overwritten, even if it is already set.
4930 */
4931 public static final int FILL_IN_PACKAGE = 1<<4;
4932
4933 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004934 * Use with {@link #fillIn} to allow the current package value to be
4935 * overwritten, even if it is already set.
4936 */
4937 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
4938
4939 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004940 * Copy the contents of <var>other</var> in to this object, but only
4941 * where fields are not defined by this object. For purposes of a field
4942 * being defined, the following pieces of data in the Intent are
4943 * considered to be separate fields:
4944 *
4945 * <ul>
4946 * <li> action, as set by {@link #setAction}.
4947 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
4948 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
4949 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004950 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004951 * <li> component, as set by {@link #setComponent(ComponentName)} or
4952 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004953 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004954 * <li> each top-level name in the associated extras.
4955 * </ul>
4956 *
4957 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004958 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4959 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004960 * corresponding field will not be replaced if it is already set.
4961 *
Brett Chabot3e391752009-07-21 16:07:23 -07004962 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
4963 * specified.
4964 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004965 * <p>For example, consider Intent A with {data="foo", categories="bar"}
4966 * and Intent B with {action="gotit", data-type="some/thing",
4967 * categories="one","two"}.
4968 *
4969 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
4970 * containing: {action="gotit", data-type="some/thing",
4971 * categories="bar"}.
4972 *
4973 * @param other Another Intent whose values are to be used to fill in
4974 * the current one.
4975 * @param flags Options to control which fields can be filled in.
4976 *
4977 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004978 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
4979 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004980 */
4981 public int fillIn(Intent other, int flags) {
4982 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004983 if (other.mAction != null
4984 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004985 mAction = other.mAction;
4986 changes |= FILL_IN_ACTION;
4987 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004988 if ((other.mData != null || other.mType != null)
4989 && ((mData == null && mType == null)
4990 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004991 mData = other.mData;
4992 mType = other.mType;
4993 changes |= FILL_IN_DATA;
4994 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004995 if (other.mCategories != null
4996 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004997 if (other.mCategories != null) {
4998 mCategories = new HashSet<String>(other.mCategories);
4999 }
5000 changes |= FILL_IN_CATEGORIES;
5001 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005002 if (other.mPackage != null
5003 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
5004 mPackage = other.mPackage;
5005 changes |= FILL_IN_PACKAGE;
5006 }
5007 // Component is special: it can -only- be set if explicitly allowed,
5008 // since otherwise the sender could force the intent somewhere the
5009 // originator didn't intend.
5010 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005011 mComponent = other.mComponent;
5012 changes |= FILL_IN_COMPONENT;
5013 }
5014 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005015 if (other.mSourceBounds != null
5016 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5017 mSourceBounds = new Rect(other.mSourceBounds);
5018 changes |= FILL_IN_SOURCE_BOUNDS;
5019 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005020 if (mExtras == null) {
5021 if (other.mExtras != null) {
5022 mExtras = new Bundle(other.mExtras);
5023 }
5024 } else if (other.mExtras != null) {
5025 try {
5026 Bundle newb = new Bundle(other.mExtras);
5027 newb.putAll(mExtras);
5028 mExtras = newb;
5029 } catch (RuntimeException e) {
5030 // Modifying the extras can cause us to unparcel the contents
5031 // of the bundle, and if we do this in the system process that
5032 // may fail. We really should handle this (i.e., the Bundle
5033 // impl shouldn't be on top of a plain map), but for now just
5034 // ignore it and keep the original contents. :(
5035 Log.w("Intent", "Failure filling in extras", e);
5036 }
5037 }
5038 return changes;
5039 }
5040
5041 /**
5042 * Wrapper class holding an Intent and implementing comparisons on it for
5043 * the purpose of filtering. The class implements its
5044 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5045 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5046 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5047 * on the wrapped Intent.
5048 */
5049 public static final class FilterComparison {
5050 private final Intent mIntent;
5051 private final int mHashCode;
5052
5053 public FilterComparison(Intent intent) {
5054 mIntent = intent;
5055 mHashCode = intent.filterHashCode();
5056 }
5057
5058 /**
5059 * Return the Intent that this FilterComparison represents.
5060 * @return Returns the Intent held by the FilterComparison. Do
5061 * not modify!
5062 */
5063 public Intent getIntent() {
5064 return mIntent;
5065 }
5066
5067 @Override
5068 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005069 if (obj instanceof FilterComparison) {
5070 Intent other = ((FilterComparison)obj).mIntent;
5071 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005072 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005073 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 }
5075
5076 @Override
5077 public int hashCode() {
5078 return mHashCode;
5079 }
5080 }
5081
5082 /**
5083 * Determine if two intents are the same for the purposes of intent
5084 * resolution (filtering). That is, if their action, data, type,
5085 * class, and categories are the same. This does <em>not</em> compare
5086 * any extra data included in the intents.
5087 *
5088 * @param other The other Intent to compare against.
5089 *
5090 * @return Returns true if action, data, type, class, and categories
5091 * are the same.
5092 */
5093 public boolean filterEquals(Intent other) {
5094 if (other == null) {
5095 return false;
5096 }
5097 if (mAction != other.mAction) {
5098 if (mAction != null) {
5099 if (!mAction.equals(other.mAction)) {
5100 return false;
5101 }
5102 } else {
5103 if (!other.mAction.equals(mAction)) {
5104 return false;
5105 }
5106 }
5107 }
5108 if (mData != other.mData) {
5109 if (mData != null) {
5110 if (!mData.equals(other.mData)) {
5111 return false;
5112 }
5113 } else {
5114 if (!other.mData.equals(mData)) {
5115 return false;
5116 }
5117 }
5118 }
5119 if (mType != other.mType) {
5120 if (mType != null) {
5121 if (!mType.equals(other.mType)) {
5122 return false;
5123 }
5124 } else {
5125 if (!other.mType.equals(mType)) {
5126 return false;
5127 }
5128 }
5129 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005130 if (mPackage != other.mPackage) {
5131 if (mPackage != null) {
5132 if (!mPackage.equals(other.mPackage)) {
5133 return false;
5134 }
5135 } else {
5136 if (!other.mPackage.equals(mPackage)) {
5137 return false;
5138 }
5139 }
5140 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005141 if (mComponent != other.mComponent) {
5142 if (mComponent != null) {
5143 if (!mComponent.equals(other.mComponent)) {
5144 return false;
5145 }
5146 } else {
5147 if (!other.mComponent.equals(mComponent)) {
5148 return false;
5149 }
5150 }
5151 }
5152 if (mCategories != other.mCategories) {
5153 if (mCategories != null) {
5154 if (!mCategories.equals(other.mCategories)) {
5155 return false;
5156 }
5157 } else {
5158 if (!other.mCategories.equals(mCategories)) {
5159 return false;
5160 }
5161 }
5162 }
5163
5164 return true;
5165 }
5166
5167 /**
5168 * Generate hash code that matches semantics of filterEquals().
5169 *
5170 * @return Returns the hash value of the action, data, type, class, and
5171 * categories.
5172 *
5173 * @see #filterEquals
5174 */
5175 public int filterHashCode() {
5176 int code = 0;
5177 if (mAction != null) {
5178 code += mAction.hashCode();
5179 }
5180 if (mData != null) {
5181 code += mData.hashCode();
5182 }
5183 if (mType != null) {
5184 code += mType.hashCode();
5185 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005186 if (mPackage != null) {
5187 code += mPackage.hashCode();
5188 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005189 if (mComponent != null) {
5190 code += mComponent.hashCode();
5191 }
5192 if (mCategories != null) {
5193 code += mCategories.hashCode();
5194 }
5195 return code;
5196 }
5197
5198 @Override
5199 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005200 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005201
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005202 b.append("Intent { ");
5203 toShortString(b, true, true);
5204 b.append(" }");
5205
5206 return b.toString();
5207 }
5208
5209 /** @hide */
5210 public String toShortString(boolean comp, boolean extras) {
5211 StringBuilder b = new StringBuilder(128);
5212 toShortString(b, comp, extras);
5213 return b.toString();
5214 }
Romain Guy4969af72009-06-17 10:53:19 -07005215
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005216 /** @hide */
5217 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
5218 boolean first = true;
5219 if (mAction != null) {
5220 b.append("act=").append(mAction);
5221 first = false;
5222 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005223 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005224 if (!first) {
5225 b.append(' ');
5226 }
5227 first = false;
5228 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005229 Iterator<String> i = mCategories.iterator();
5230 boolean didone = false;
5231 while (i.hasNext()) {
5232 if (didone) b.append(",");
5233 didone = true;
5234 b.append(i.next());
5235 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005236 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005237 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005238 if (mData != null) {
5239 if (!first) {
5240 b.append(' ');
5241 }
5242 first = false;
5243 b.append("dat=").append(mData);
5244 }
5245 if (mType != null) {
5246 if (!first) {
5247 b.append(' ');
5248 }
5249 first = false;
5250 b.append("typ=").append(mType);
5251 }
5252 if (mFlags != 0) {
5253 if (!first) {
5254 b.append(' ');
5255 }
5256 first = false;
5257 b.append("flg=0x").append(Integer.toHexString(mFlags));
5258 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005259 if (mPackage != null) {
5260 if (!first) {
5261 b.append(' ');
5262 }
5263 first = false;
5264 b.append("pkg=").append(mPackage);
5265 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005266 if (comp && mComponent != null) {
5267 if (!first) {
5268 b.append(' ');
5269 }
5270 first = false;
5271 b.append("cmp=").append(mComponent.flattenToShortString());
5272 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005273 if (mSourceBounds != null) {
5274 if (!first) {
5275 b.append(' ');
5276 }
5277 first = false;
5278 b.append("bnds=").append(mSourceBounds.toShortString());
5279 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005280 if (extras && mExtras != null) {
5281 if (!first) {
5282 b.append(' ');
5283 }
5284 first = false;
5285 b.append("(has extras)");
5286 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005287 }
5288
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005289 /**
5290 * Call {@link #toUri} with 0 flags.
5291 * @deprecated Use {@link #toUri} instead.
5292 */
5293 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005294 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005295 return toUri(0);
5296 }
5297
5298 /**
5299 * Convert this Intent into a String holding a URI representation of it.
5300 * The returned URI string has been properly URI encoded, so it can be
5301 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5302 * Intent's data as the base URI, with an additional fragment describing
5303 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08005304 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005305 * <p>You can convert the returned string back to an Intent with
5306 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08005307 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005308 * @param flags Additional operating flags. Either 0 or
5309 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08005310 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005311 * @return Returns a URI encoding URI string describing the entire contents
5312 * of the Intent.
5313 */
5314 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005315 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005316 String scheme = null;
5317 if (mData != null) {
5318 String data = mData.toString();
5319 if ((flags&URI_INTENT_SCHEME) != 0) {
5320 final int N = data.length();
5321 for (int i=0; i<N; i++) {
5322 char c = data.charAt(i);
5323 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5324 || c == '.' || c == '-') {
5325 continue;
5326 }
5327 if (c == ':' && i > 0) {
5328 // Valid scheme.
5329 scheme = data.substring(0, i);
5330 uri.append("intent:");
5331 data = data.substring(i+1);
5332 break;
5333 }
Tom Taylord4a47292009-12-21 13:59:18 -08005334
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005335 // No scheme.
5336 break;
5337 }
5338 }
5339 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08005340
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005341 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5342 uri.append("intent:");
5343 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005344
5345 uri.append("#Intent;");
5346
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005347 if (scheme != null) {
5348 uri.append("scheme=").append(scheme).append(';');
5349 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005350 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005351 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005352 }
5353 if (mCategories != null) {
5354 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005355 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005356 }
5357 }
5358 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005359 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005360 }
5361 if (mFlags != 0) {
5362 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5363 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005364 if (mPackage != null) {
5365 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5366 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005367 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005368 uri.append("component=").append(Uri.encode(
5369 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005370 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005371 if (mSourceBounds != null) {
5372 uri.append("sourceBounds=")
5373 .append(Uri.encode(mSourceBounds.flattenToString()))
5374 .append(';');
5375 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005376 if (mExtras != null) {
5377 for (String key : mExtras.keySet()) {
5378 final Object value = mExtras.get(key);
5379 char entryType =
5380 value instanceof String ? 'S' :
5381 value instanceof Boolean ? 'B' :
5382 value instanceof Byte ? 'b' :
5383 value instanceof Character ? 'c' :
5384 value instanceof Double ? 'd' :
5385 value instanceof Float ? 'f' :
5386 value instanceof Integer ? 'i' :
5387 value instanceof Long ? 'l' :
5388 value instanceof Short ? 's' :
5389 '\0';
5390
5391 if (entryType != '\0') {
5392 uri.append(entryType);
5393 uri.append('.');
5394 uri.append(Uri.encode(key));
5395 uri.append('=');
5396 uri.append(Uri.encode(value.toString()));
5397 uri.append(';');
5398 }
5399 }
5400 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005401
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005402 uri.append("end");
5403
5404 return uri.toString();
5405 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005406
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005407 public int describeContents() {
5408 return (mExtras != null) ? mExtras.describeContents() : 0;
5409 }
5410
5411 public void writeToParcel(Parcel out, int flags) {
5412 out.writeString(mAction);
5413 Uri.writeToParcel(out, mData);
5414 out.writeString(mType);
5415 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005416 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005417 ComponentName.writeToParcel(mComponent, out);
5418
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005419 if (mSourceBounds != null) {
5420 out.writeInt(1);
5421 mSourceBounds.writeToParcel(out, flags);
5422 } else {
5423 out.writeInt(0);
5424 }
5425
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005426 if (mCategories != null) {
5427 out.writeInt(mCategories.size());
5428 for (String category : mCategories) {
5429 out.writeString(category);
5430 }
5431 } else {
5432 out.writeInt(0);
5433 }
5434
5435 out.writeBundle(mExtras);
5436 }
5437
5438 public static final Parcelable.Creator<Intent> CREATOR
5439 = new Parcelable.Creator<Intent>() {
5440 public Intent createFromParcel(Parcel in) {
5441 return new Intent(in);
5442 }
5443 public Intent[] newArray(int size) {
5444 return new Intent[size];
5445 }
5446 };
5447
Dianne Hackborneb034652009-09-07 00:49:58 -07005448 /** @hide */
5449 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005450 readFromParcel(in);
5451 }
5452
5453 public void readFromParcel(Parcel in) {
5454 mAction = in.readString();
5455 mData = Uri.CREATOR.createFromParcel(in);
5456 mType = in.readString();
5457 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005458 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005459 mComponent = ComponentName.readFromParcel(in);
5460
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005461 if (in.readInt() != 0) {
5462 mSourceBounds = Rect.CREATOR.createFromParcel(in);
5463 }
5464
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005465 int N = in.readInt();
5466 if (N > 0) {
5467 mCategories = new HashSet<String>();
5468 int i;
5469 for (i=0; i<N; i++) {
5470 mCategories.add(in.readString());
5471 }
5472 } else {
5473 mCategories = null;
5474 }
5475
5476 mExtras = in.readBundle();
5477 }
5478
5479 /**
5480 * Parses the "intent" element (and its children) from XML and instantiates
5481 * an Intent object. The given XML parser should be located at the tag
5482 * where parsing should start (often named "intent"), from which the
5483 * basic action, data, type, and package and class name will be
5484 * retrieved. The function will then parse in to any child elements,
5485 * looking for <category android:name="xxx"> tags to add categories and
5486 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5487 * to the intent.
5488 *
5489 * @param resources The Resources to use when inflating resources.
5490 * @param parser The XML parser pointing at an "intent" tag.
5491 * @param attrs The AttributeSet interface for retrieving extended
5492 * attribute data at the current <var>parser</var> location.
5493 * @return An Intent object matching the XML data.
5494 * @throws XmlPullParserException If there was an XML parsing error.
5495 * @throws IOException If there was an I/O error.
5496 */
5497 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5498 throws XmlPullParserException, IOException {
5499 Intent intent = new Intent();
5500
5501 TypedArray sa = resources.obtainAttributes(attrs,
5502 com.android.internal.R.styleable.Intent);
5503
5504 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5505
5506 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5507 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5508 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5509
5510 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5511 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5512 if (packageName != null && className != null) {
5513 intent.setComponent(new ComponentName(packageName, className));
5514 }
5515
5516 sa.recycle();
5517
5518 int outerDepth = parser.getDepth();
5519 int type;
5520 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5521 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5522 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5523 continue;
5524 }
5525
5526 String nodeName = parser.getName();
5527 if (nodeName.equals("category")) {
5528 sa = resources.obtainAttributes(attrs,
5529 com.android.internal.R.styleable.IntentCategory);
5530 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5531 sa.recycle();
5532
5533 if (cat != null) {
5534 intent.addCategory(cat);
5535 }
5536 XmlUtils.skipCurrentTag(parser);
5537
5538 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005539 if (intent.mExtras == null) {
5540 intent.mExtras = new Bundle();
5541 }
5542 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5543 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005544
5545 } else {
5546 XmlUtils.skipCurrentTag(parser);
5547 }
5548 }
5549
5550 return intent;
5551 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005552}