blob: 8d6cee1598c501283dcab35f472fb5aba3c6f31b [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}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500536 * <li> {@link #CATEGORY_LE_DESK_DOCK}
537 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200538 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700539 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * </ul>
541 *
542 * <h3>Standard Extra Data</h3>
543 *
544 * <p>These are the current standard fields that can be used as extra data via
545 * {@link #putExtra}.
546 *
547 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800548 * <li> {@link #EXTRA_ALARM_COUNT}
549 * <li> {@link #EXTRA_BCC}
550 * <li> {@link #EXTRA_CC}
551 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
552 * <li> {@link #EXTRA_DATA_REMOVED}
553 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500554 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
555 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800556 * <li> {@link #EXTRA_DOCK_STATE_CAR}
557 * <li> {@link #EXTRA_DOCK_STATE_DESK}
558 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
559 * <li> {@link #EXTRA_DONT_KILL_APP}
560 * <li> {@link #EXTRA_EMAIL}
561 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700562 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800563 * <li> {@link #EXTRA_KEY_EVENT}
564 * <li> {@link #EXTRA_PHONE_NUMBER}
565 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
566 * <li> {@link #EXTRA_REPLACING}
567 * <li> {@link #EXTRA_SHORTCUT_ICON}
568 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
569 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700570 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800571 * <li> {@link #EXTRA_SHORTCUT_NAME}
572 * <li> {@link #EXTRA_SUBJECT}
573 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700574 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_TITLE}
576 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700577 * </ul>
578 *
579 * <h3>Flags</h3>
580 *
581 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800582 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
583 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700584 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800585public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 // ---------------------------------------------------------------------
587 // ---------------------------------------------------------------------
588 // Standard intent activity actions (see action variable).
589
590 /**
591 * Activity Action: Start as a main entry point, does not expect to
592 * receive data.
593 * <p>Input: nothing
594 * <p>Output: nothing
595 */
596 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
597 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800598
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700599 /**
600 * Activity Action: Display the data to the user. This is the most common
601 * action performed on data -- it is the generic action you can use on
602 * a piece of data to get the most reasonable thing to occur. For example,
603 * when used on a contacts entry it will view the entry; when used on a
604 * mailto: URI it will bring up a compose window filled with the information
605 * supplied by the URI; when used with a tel: URI it will invoke the
606 * dialer.
607 * <p>Input: {@link #getData} is URI from which to retrieve data.
608 * <p>Output: nothing.
609 */
610 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
611 public static final String ACTION_VIEW = "android.intent.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 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
615 * performed on a piece of data.
616 */
617 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800618
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700619 /**
620 * Used to indicate that some piece of data should be attached to some other
621 * place. For example, image data could be attached to a contact. It is up
622 * to the recipient to decide where the data should be attached; the intent
623 * does not specify the ultimate destination.
624 * <p>Input: {@link #getData} is URI of data to be attached.
625 * <p>Output: nothing.
626 */
627 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
628 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Activity Action: Provide explicit editable access to the given data.
632 * <p>Input: {@link #getData} is URI of data to be edited.
633 * <p>Output: nothing.
634 */
635 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
636 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800637
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700638 /**
639 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
640 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
641 * The extras can contain type specific data to pass through to the editing/creating
642 * activity.
643 * <p>Output: The URI of the item that was picked. This must be a content:
644 * URI so that any receiver can access it.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Pick an item from the data, returning what was selected.
651 * <p>Input: {@link #getData} is URI containing a directory of data
652 * (vnd.android.cursor.dir/*) from which to pick an item.
653 * <p>Output: The URI of the item that was picked.
654 */
655 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
656 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700658 /**
659 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800660 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700661 * <p>Output: An Intent representing the shortcut. The intent must contain three
662 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
663 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800664 * (value: ShortcutIconResource).</p>
665 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700666 * @see #EXTRA_SHORTCUT_INTENT
667 * @see #EXTRA_SHORTCUT_NAME
668 * @see #EXTRA_SHORTCUT_ICON
669 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
670 * @see android.content.Intent.ShortcutIconResource
671 */
672 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
673 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
674
675 /**
676 * The name of the extra used to define the Intent of a shortcut.
677 *
678 * @see #ACTION_CREATE_SHORTCUT
679 */
680 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
681 /**
682 * The name of the extra used to define the name of a shortcut.
683 *
684 * @see #ACTION_CREATE_SHORTCUT
685 */
686 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
687 /**
688 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
689 *
690 * @see #ACTION_CREATE_SHORTCUT
691 */
692 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
693 /**
694 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
695 *
696 * @see #ACTION_CREATE_SHORTCUT
697 * @see android.content.Intent.ShortcutIconResource
698 */
699 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
700 "android.intent.extra.shortcut.ICON_RESOURCE";
701
702 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800703 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700704 *
705 * @see Intent#ACTION_CREATE_SHORTCUT
706 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800707 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
708 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700709 */
710 public static class ShortcutIconResource implements Parcelable {
711 /**
712 * The package name of the application containing the icon.
713 */
714 public String packageName;
715
716 /**
717 * The resource name of the icon, including package, name and type.
718 */
719 public String resourceName;
720
721 /**
722 * Creates a new ShortcutIconResource for the specified context and resource
723 * identifier.
724 *
725 * @param context The context of the application.
726 * @param resourceId The resource idenfitier for the icon.
727 * @return A new ShortcutIconResource with the specified's context package name
728 * and icon resource idenfitier.
729 */
730 public static ShortcutIconResource fromContext(Context context, int resourceId) {
731 ShortcutIconResource icon = new ShortcutIconResource();
732 icon.packageName = context.getPackageName();
733 icon.resourceName = context.getResources().getResourceName(resourceId);
734 return icon;
735 }
736
737 /**
738 * Used to read a ShortcutIconResource from a Parcel.
739 */
740 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
741 new Parcelable.Creator<ShortcutIconResource>() {
742
743 public ShortcutIconResource createFromParcel(Parcel source) {
744 ShortcutIconResource icon = new ShortcutIconResource();
745 icon.packageName = source.readString();
746 icon.resourceName = source.readString();
747 return icon;
748 }
749
750 public ShortcutIconResource[] newArray(int size) {
751 return new ShortcutIconResource[size];
752 }
753 };
754
755 /**
756 * No special parcel contents.
757 */
758 public int describeContents() {
759 return 0;
760 }
761
762 public void writeToParcel(Parcel dest, int flags) {
763 dest.writeString(packageName);
764 dest.writeString(resourceName);
765 }
766
767 @Override
768 public String toString() {
769 return resourceName;
770 }
771 }
772
773 /**
774 * Activity Action: Display an activity chooser, allowing the user to pick
775 * what they want to before proceeding. This can be used as an alternative
776 * to the standard activity picker that is displayed by the system when
777 * you try to start an activity with multiple possible matches, with these
778 * differences in behavior:
779 * <ul>
780 * <li>You can specify the title that will appear in the activity chooser.
781 * <li>The user does not have the option to make one of the matching
782 * activities a preferred activity, and all possible activities will
783 * always be shown even if one of them is currently marked as the
784 * preferred activity.
785 * </ul>
786 * <p>
787 * This action should be used when the user will naturally expect to
788 * select an activity in order to proceed. An example if when not to use
789 * it is when the user clicks on a "mailto:" link. They would naturally
790 * expect to go directly to their mail app, so startActivity() should be
791 * called directly: it will
792 * either launch the current preferred app, or put up a dialog allowing the
793 * user to pick an app to use and optionally marking that as preferred.
794 * <p>
795 * In contrast, if the user is selecting a menu item to send a picture
796 * they are viewing to someone else, there are many different things they
797 * may want to do at this point: send it through e-mail, upload it to a
798 * web service, etc. In this case the CHOOSER action should be used, to
799 * always present to the user a list of the things they can do, with a
800 * nice title given by the caller such as "Send this photo with:".
801 * <p>
802 * As a convenience, an Intent of this form can be created with the
803 * {@link #createChooser} function.
804 * <p>Input: No data should be specified. get*Extra must have
805 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
806 * and can optionally have a {@link #EXTRA_TITLE} field containing the
807 * title text to display in the chooser.
808 * <p>Output: Depends on the protocol of {@link #EXTRA_INTENT}.
809 */
810 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
811 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
812
813 /**
814 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
815 *
816 * @param target The Intent that the user will be selecting an activity
817 * to perform.
818 * @param title Optional title that will be displayed in the chooser.
819 * @return Return a new Intent object that you can hand to
820 * {@link Context#startActivity(Intent) Context.startActivity()} and
821 * related methods.
822 */
823 public static Intent createChooser(Intent target, CharSequence title) {
824 Intent intent = new Intent(ACTION_CHOOSER);
825 intent.putExtra(EXTRA_INTENT, target);
826 if (title != null) {
827 intent.putExtra(EXTRA_TITLE, title);
828 }
829 return intent;
830 }
831 /**
832 * Activity Action: Allow the user to select a particular kind of data and
833 * return it. This is different than {@link #ACTION_PICK} in that here we
834 * just say what kind of data is desired, not a URI of existing data from
835 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
836 * create the data as it runs (for example taking a picture or recording a
837 * sound), let them browser over the web and download the desired data,
838 * etc.
839 * <p>
840 * There are two main ways to use this action: if you want an specific kind
841 * of data, such as a person contact, you set the MIME type to the kind of
842 * data you want and launch it with {@link Context#startActivity(Intent)}.
843 * The system will then launch the best application to select that kind
844 * of data for you.
845 * <p>
846 * You may also be interested in any of a set of types of content the user
847 * can pick. For example, an e-mail application that wants to allow the
848 * user to add an attachment to an e-mail message can use this action to
849 * bring up a list of all of the types of content the user can attach.
850 * <p>
851 * In this case, you should wrap the GET_CONTENT intent with a chooser
852 * (through {@link #createChooser}), which will give the proper interface
853 * for the user to pick how to send your data and allow you to specify
854 * a prompt indicating what they are doing. You will usually specify a
855 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
856 * broad range of content types the user can select from.
857 * <p>
858 * When using such a broad GET_CONTENT action, it is often desireable to
859 * only pick from data that can be represented as a stream. This is
860 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
861 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800862 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
863 * the launched content chooser only return results representing data that
864 * is locally available on the device. For example, if this extra is set
865 * to true then an image picker should not show any pictures that are available
866 * from a remote server but not already on the local device (thus requiring
867 * they be downloaded when opened).
868 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700869 * Input: {@link #getType} is the desired MIME type to retrieve. Note
870 * that no URI is supplied in the intent, as there are no constraints on
871 * where the returned data originally comes from. You may also include the
872 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800873 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
874 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700875 * <p>
876 * Output: The URI of the item that was picked. This must be a content:
877 * URI so that any receiver can access it.
878 */
879 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
880 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
881 /**
882 * Activity Action: Dial a number as specified by the data. This shows a
883 * UI with the number being dialed, allowing the user to explicitly
884 * initiate the call.
885 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
886 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
887 * number.
888 * <p>Output: nothing.
889 */
890 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
891 public static final String ACTION_DIAL = "android.intent.action.DIAL";
892 /**
893 * Activity Action: Perform a call to someone specified by the data.
894 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
895 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
896 * number.
897 * <p>Output: nothing.
898 *
899 * <p>Note: there will be restrictions on which applications can initiate a
900 * call; most applications should use the {@link #ACTION_DIAL}.
901 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
902 * numbers. Applications can <strong>dial</strong> emergency numbers using
903 * {@link #ACTION_DIAL}, however.
904 */
905 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
906 public static final String ACTION_CALL = "android.intent.action.CALL";
907 /**
908 * Activity Action: Perform a call to an emergency number specified by the
909 * data.
910 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
911 * tel: URI of an explicit phone number.
912 * <p>Output: nothing.
913 * @hide
914 */
915 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
916 /**
917 * Activity action: Perform a call to any number (emergency or not)
918 * specified by the data.
919 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
920 * tel: URI of an explicit phone number.
921 * <p>Output: nothing.
922 * @hide
923 */
924 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
925 /**
926 * Activity Action: Send a message to someone specified by the data.
927 * <p>Input: {@link #getData} is URI describing the target.
928 * <p>Output: nothing.
929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
932 /**
933 * Activity Action: Deliver some data to someone else. Who the data is
934 * being delivered to is not specified; it is up to the receiver of this
935 * action to ask the user where the data should be sent.
936 * <p>
937 * When launching a SEND intent, you should usually wrap it in a chooser
938 * (through {@link #createChooser}), which will give the proper interface
939 * for the user to pick how to send your data and allow you to specify
940 * a prompt indicating what they are doing.
941 * <p>
942 * Input: {@link #getType} is the MIME type of the data being sent.
943 * get*Extra can have either a {@link #EXTRA_TEXT}
944 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
945 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
946 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
947 * if the MIME type is unknown (this will only allow senders that can
948 * handle generic data streams).
949 * <p>
950 * Optional standard extras, which may be interpreted by some recipients as
951 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
952 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
953 * <p>
954 * Output: nothing.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_SEND = "android.intent.action.SEND";
958 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800959 * Activity Action: Deliver multiple data to someone else.
960 * <p>
961 * Like ACTION_SEND, except the data is multiple.
962 * <p>
963 * Input: {@link #getType} is the MIME type of the data being sent.
964 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
965 * #EXTRA_STREAM} field, containing the data to be sent.
966 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +0800967 * Multiple types are supported, and receivers should handle mixed types
968 * whenever possible. The right way for the receiver to check them is to
969 * use the content resolver on each URI. The intent sender should try to
970 * put the most concrete mime type in the intent type, but it can fall
971 * back to {@literal <type>/*} or {@literal *}/* as needed.
972 * <p>
973 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
974 * be image/jpg, but if you are sending image/jpg and image/png, then the
975 * intent's type should be image/*.
976 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +0800977 * Optional standard extras, which may be interpreted by some recipients as
978 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
979 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
980 * <p>
981 * Output: nothing.
982 */
983 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
984 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
985 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700986 * Activity Action: Handle an incoming phone call.
987 * <p>Input: nothing.
988 * <p>Output: nothing.
989 */
990 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
991 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
992 /**
993 * Activity Action: Insert an empty item into the given container.
994 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
995 * in which to place the data.
996 * <p>Output: URI of the new data that was created.
997 */
998 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
999 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1000 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001001 * Activity Action: Create a new item in the given container, initializing it
1002 * from the current contents of the clipboard.
1003 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1004 * in which to place the data.
1005 * <p>Output: URI of the new data that was created.
1006 */
1007 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1008 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1009 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001010 * Activity Action: Delete the given data from its container.
1011 * <p>Input: {@link #getData} is URI of data to be deleted.
1012 * <p>Output: nothing.
1013 */
1014 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1015 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1016 /**
1017 * Activity Action: Run the data, whatever that means.
1018 * <p>Input: ? (Note: this is currently specific to the test harness.)
1019 * <p>Output: nothing.
1020 */
1021 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1022 public static final String ACTION_RUN = "android.intent.action.RUN";
1023 /**
1024 * Activity Action: Perform a data synchronization.
1025 * <p>Input: ?
1026 * <p>Output: ?
1027 */
1028 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1029 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1030 /**
1031 * Activity Action: Pick an activity given an intent, returning the class
1032 * selected.
1033 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1034 * used with {@link PackageManager#queryIntentActivities} to determine the
1035 * set of activities from which to pick.
1036 * <p>Output: Class name of the activity that was selected.
1037 */
1038 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1039 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1040 /**
1041 * Activity Action: Perform a search.
1042 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1043 * is the text to search for. If empty, simply
1044 * enter your search results Activity with the search UI activated.
1045 * <p>Output: nothing.
1046 */
1047 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1048 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1049 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001050 * Activity Action: Start the platform-defined tutorial
1051 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1052 * is the text to search for. If empty, simply
1053 * enter your search results Activity with the search UI activated.
1054 * <p>Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001060 * <p>
1061 * Input: {@link android.app.SearchManager#QUERY
1062 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1063 * a url starts with http or https, the site will be opened. If it is plain
1064 * text, Google search will be applied.
1065 * <p>
1066 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001067 */
1068 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1069 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1070 /**
1071 * Activity Action: List all available applications
1072 * <p>Input: Nothing.
1073 * <p>Output: nothing.
1074 */
1075 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1076 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1077 /**
1078 * Activity Action: Show settings for choosing wallpaper
1079 * <p>Input: Nothing.
1080 * <p>Output: Nothing.
1081 */
1082 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1083 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1084
1085 /**
1086 * Activity Action: Show activity for reporting a bug.
1087 * <p>Input: Nothing.
1088 * <p>Output: Nothing.
1089 */
1090 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1091 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1092
1093 /**
1094 * Activity Action: Main entry point for factory tests. Only used when
1095 * the device is booting in factory test node. The implementing package
1096 * must be installed in the system image.
1097 * <p>Input: nothing
1098 * <p>Output: nothing
1099 */
1100 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1101
1102 /**
1103 * Activity Action: The user pressed the "call" button to go to the dialer
1104 * or other appropriate UI for placing a call.
1105 * <p>Input: Nothing.
1106 * <p>Output: Nothing.
1107 */
1108 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1109 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1110
1111 /**
1112 * Activity Action: Start Voice Command.
1113 * <p>Input: Nothing.
1114 * <p>Output: Nothing.
1115 */
1116 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1117 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001118
1119 /**
1120 * Activity Action: Start action associated with long pressing on the
1121 * search key.
1122 * <p>Input: Nothing.
1123 * <p>Output: Nothing.
1124 */
1125 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1126 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001127
Jacek Surazski86b6c532009-05-13 14:38:28 +02001128 /**
1129 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1130 * This intent is delivered to the package which installed the application, usually
1131 * the Market.
1132 * <p>Input: No data is specified. The bug report is passed in using
1133 * an {@link #EXTRA_BUG_REPORT} field.
1134 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001135 *
1136 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001137 */
1138 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1139 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001140
1141 /**
1142 * Activity Action: Show power usage information to the user.
1143 * <p>Input: Nothing.
1144 * <p>Output: Nothing.
1145 */
1146 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1147 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001148
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001149 /**
1150 * Activity Action: Setup wizard to launch after a platform update. This
1151 * activity should have a string meta-data field associated with it,
1152 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1153 * the platform for setup. The activity will be launched only if
1154 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1155 * same value.
1156 * <p>Input: Nothing.
1157 * <p>Output: Nothing.
1158 * @hide
1159 */
1160 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1161 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001162
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001163 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001164 * Activity Action: Show settings for managing network data usage of a
1165 * specific application. Applications should define an activity that offers
1166 * options to control data usage.
1167 */
1168 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1169 public static final String ACTION_MANAGE_NETWORK_USAGE =
1170 "android.intent.action.MANAGE_NETWORK_USAGE";
1171
1172 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001173 * Activity Action: Launch application installer.
1174 * <p>
1175 * Input: The data must be a content: or file: URI at which the application
1176 * can be retrieved. You can optionally supply
1177 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1178 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1179 * <p>
1180 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1181 * succeeded.
1182 *
1183 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1184 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1185 * @see #EXTRA_RETURN_RESULT
1186 */
1187 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1188 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1189
1190 /**
1191 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1192 * package. Specifies the installer package name; this package will receive the
1193 * {@link #ACTION_APP_ERROR} intent.
1194 */
1195 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1196 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1197
1198 /**
1199 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1200 * package. Specifies that the application being installed should not be
1201 * treated as coming from an unknown source, but as coming from the app
1202 * invoking the Intent. For this to work you must start the installer with
1203 * startActivityForResult().
1204 */
1205 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1206 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1207
1208 /**
1209 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1210 * package. Tells the installer UI to skip the confirmation with the user
1211 * if the .apk is replacing an existing one.
1212 */
1213 public static final String EXTRA_ALLOW_REPLACE
1214 = "android.intent.extra.ALLOW_REPLACE";
1215
1216 /**
1217 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1218 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1219 * return to the application the result code of the install/uninstall. The returned result
1220 * code will be {@link android.app.Activity#RESULT_OK} on success or
1221 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1222 */
1223 public static final String EXTRA_RETURN_RESULT
1224 = "android.intent.extra.RETURN_RESULT";
1225
1226 /**
1227 * Package manager install result code. @hide because result codes are not
1228 * yet ready to be exposed.
1229 */
1230 public static final String EXTRA_INSTALL_RESULT
1231 = "android.intent.extra.INSTALL_RESULT";
1232
1233 /**
1234 * Activity Action: Launch application uninstaller.
1235 * <p>
1236 * Input: The data must be a package: URI whose scheme specific part is
1237 * the package name of the current installed package to be uninstalled.
1238 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1239 * <p>
1240 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1241 * succeeded.
1242 */
1243 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1244 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1245
1246 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001247 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1248 * describing the last run version of the platform that was setup.
1249 * @hide
1250 */
1251 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1252
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001253 // ---------------------------------------------------------------------
1254 // ---------------------------------------------------------------------
1255 // Standard intent broadcast actions (see action variable).
1256
1257 /**
1258 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001259 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001260 * <p class="note">This is a protected intent that can only be sent
1261 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001262 */
1263 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1264 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1265 /**
1266 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001267 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001268 * <p class="note">This is a protected intent that can only be sent
1269 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001270 */
1271 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1272 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001273
1274 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001275 * 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 -07001276 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001277 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001278 * <p class="note">This is a protected intent that can only be sent
1279 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001280 */
1281 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001282 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001283
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001284 /**
1285 * Broadcast Action: The current time has changed. Sent every
1286 * minute. You can <em>not</em> receive this through components declared
1287 * in manifests, only by exlicitly registering for it with
1288 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1289 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001290 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001291 * <p class="note">This is a protected intent that can only be sent
1292 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001293 */
1294 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1295 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1296 /**
1297 * Broadcast Action: The time was set.
1298 */
1299 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1300 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1301 /**
1302 * Broadcast Action: The date has changed.
1303 */
1304 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1305 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1306 /**
1307 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1308 * <ul>
1309 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1310 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001311 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001312 * <p class="note">This is a protected intent that can only be sent
1313 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001314 */
1315 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1316 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1317 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001318 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1319 * DNS entries should be tossed.
1320 * @hide
1321 */
1322 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1323 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1324 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001325 * Alarm Changed Action: This is broadcast when the AlarmClock
1326 * application's alarm is set or unset. It is used by the
1327 * AlarmClock application and the StatusBar service.
1328 * @hide
1329 */
1330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1331 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1332 /**
1333 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1334 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1335 * @hide
1336 */
1337 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1338 public static final String ACTION_SYNC_STATE_CHANGED
1339 = "android.intent.action.SYNC_STATE_CHANGED";
1340 /**
1341 * Broadcast Action: This is broadcast once, after the system has finished
1342 * booting. It can be used to perform application-specific initialization,
1343 * such as installing alarms. You must hold the
1344 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1345 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001346 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001347 * <p class="note">This is a protected intent that can only be sent
1348 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001349 */
1350 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1351 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1352 /**
1353 * Broadcast Action: This is broadcast when a user action should request a
1354 * temporary system dialog to dismiss. Some examples of temporary system
1355 * dialogs are the notification window-shade and the recent tasks dialog.
1356 */
1357 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1358 /**
1359 * Broadcast Action: Trigger the download and eventual installation
1360 * of a package.
1361 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001362 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001363 * <p class="note">This is a protected intent that can only be sent
1364 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001365 *
1366 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001367 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001368 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001369 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1370 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1371 /**
1372 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001373 * device. The data contains the name of the package. Note that the
1374 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001375 * <p>My include the following extras:
1376 * <ul>
1377 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1378 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1379 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1380 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001381 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001382 * <p class="note">This is a protected intent that can only be sent
1383 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001384 */
1385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1386 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1387 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001388 * Broadcast Action: A new version of an application package has been
1389 * installed, replacing an existing version that was previously installed.
1390 * The data contains the name of the package.
1391 * <p>My include the following extras:
1392 * <ul>
1393 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1394 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001395 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001396 * <p class="note">This is a protected intent that can only be sent
1397 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001398 */
1399 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1400 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1401 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001402 * Broadcast Action: A new version of your application has been installed
1403 * over an existing one. This is only sent to the application that was
1404 * replaced. It does not contain any additional data; to receive it, just
1405 * use an intent filter for this action.
1406 *
1407 * <p class="note">This is a protected intent that can only be sent
1408 * by the system.
1409 */
1410 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1411 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1412 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001413 * Broadcast Action: An existing application package has been removed from
1414 * the device. The data contains the name of the package. The package
1415 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001416 * <ul>
1417 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1418 * to the package.
1419 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1420 * application -- data and code -- is being removed.
1421 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1422 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1423 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001424 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001425 * <p class="note">This is a protected intent that can only be sent
1426 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001427 */
1428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1429 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1430 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001431 * Broadcast Action: An existing application package has been completely
1432 * removed from the device. The data contains the name of the package.
1433 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1434 * {@link #EXTRA_DATA_REMOVED} is true and
1435 * {@link #EXTRA_REPLACING} is false of that broadcast.
1436 *
1437 * <ul>
1438 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1439 * to the package.
1440 * </ul>
1441 *
1442 * <p class="note">This is a protected intent that can only be sent
1443 * by the system.
1444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1446 public static final String ACTION_PACKAGE_FULLY_REMOVED
1447 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1448 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001449 * Broadcast Action: An existing application package has been changed (e.g.
1450 * a component has been enabled or disabled). The data contains the name of
1451 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001452 * <ul>
1453 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001454 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1455 * of the changed components.
1456 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1457 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001458 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001459 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001460 * <p class="note">This is a protected intent that can only be sent
1461 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001462 */
1463 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1464 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1465 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001466 * @hide
1467 * Broadcast Action: Ask system services if there is any reason to
1468 * restart the given package. The data contains the name of the
1469 * package.
1470 * <ul>
1471 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1472 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1473 * </ul>
1474 *
1475 * <p class="note">This is a protected intent that can only be sent
1476 * by the system.
1477 */
1478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1479 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1480 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001481 * Broadcast Action: The user has restarted a package, and all of its
1482 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001483 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001484 * be removed. Note that the restarted package does <em>not</em>
1485 * receive this broadcast.
1486 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001487 * <ul>
1488 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1489 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001490 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001491 * <p class="note">This is a protected intent that can only be sent
1492 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001493 */
1494 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1495 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1496 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001497 * Broadcast Action: The user has cleared the data of a package. This should
1498 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001499 * its persistent data is erased and this broadcast sent.
1500 * Note that the cleared package does <em>not</em>
1501 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001502 * <ul>
1503 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1504 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001505 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001506 * <p class="note">This is a protected intent that can only be sent
1507 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001508 */
1509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1510 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1511 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001512 * Broadcast Action: A user ID has been removed from the system. The user
1513 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001514 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001515 * <p class="note">This is a protected intent that can only be sent
1516 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001517 */
1518 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1519 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001520
1521 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001522 * Broadcast Action: Sent to the installer package of an application
1523 * when that application is first launched (that is the first time it
1524 * is moved out of the stopped state). The data contains the name of the package.
1525 *
1526 * <p class="note">This is a protected intent that can only be sent
1527 * by the system.
1528 */
1529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1530 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1531
1532 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001533 * Broadcast Action: Sent to the system package verifier when a package
1534 * needs to be verified. The data contains the package URI.
1535 * <p class="note">
1536 * This is a protected intent that can only be sent by the system.
1537 * </p>
1538 *
1539 * @hide
1540 */
1541 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1542 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1543
1544 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001545 * Broadcast Action: Resources for a set of packages (which were
1546 * previously unavailable) are currently
1547 * available since the media on which they exist is available.
1548 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1549 * list of packages whose availability changed.
1550 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1551 * list of uids of packages whose availability changed.
1552 * Note that the
1553 * packages in this list do <em>not</em> receive this broadcast.
1554 * The specified set of packages are now available on the system.
1555 * <p>Includes the following extras:
1556 * <ul>
1557 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1558 * whose resources(were previously unavailable) are currently available.
1559 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1560 * packages whose resources(were previously unavailable)
1561 * are currently available.
1562 * </ul>
1563 *
1564 * <p class="note">This is a protected intent that can only be sent
1565 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001566 */
1567 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001568 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1569 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001570
1571 /**
1572 * Broadcast Action: Resources for a set of packages are currently
1573 * unavailable since the media on which they exist is unavailable.
1574 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1575 * list of packages whose availability changed.
1576 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1577 * list of uids of packages whose availability changed.
1578 * The specified set of packages can no longer be
1579 * launched and are practically unavailable on the system.
1580 * <p>Inclues the following extras:
1581 * <ul>
1582 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1583 * whose resources are no longer available.
1584 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1585 * whose resources are no longer available.
1586 * </ul>
1587 *
1588 * <p class="note">This is a protected intent that can only be sent
1589 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001590 */
1591 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001592 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001593 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001594
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001595 /**
1596 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001597 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001598 */
1599 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1600 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1601 /**
1602 * Broadcast Action: The current device {@link android.content.res.Configuration}
1603 * (orientation, locale, etc) has changed. When such a change happens, the
1604 * UIs (view hierarchy) will need to be rebuilt based on this new
1605 * information; for the most part, applications don't need to worry about
1606 * this, because the system will take care of stopping and restarting the
1607 * application to make sure it sees the new changes. Some system code that
1608 * can not be restarted will need to watch for this action and handle it
1609 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001610 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001611 * <p class="note">
1612 * You can <em>not</em> receive this through components declared
1613 * in manifests, only by explicitly registering for it with
1614 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1615 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001616 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001617 * <p class="note">This is a protected intent that can only be sent
1618 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001619 *
1620 * @see android.content.res.Configuration
1621 */
1622 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1623 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1624 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001625 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001626 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001627 * <p class="note">This is a protected intent that can only be sent
1628 * by the system.
1629 */
1630 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1631 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1632 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001633 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1634 * charging state, level, and other information about the battery.
1635 * See {@link android.os.BatteryManager} for documentation on the
1636 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001637 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001638 * <p class="note">
1639 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001640 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001641 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001642 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1643 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1644 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1645 * broadcasts that are sent and can be received through manifest
1646 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001647 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001648 * <p class="note">This is a protected intent that can only be sent
1649 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001650 */
1651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1652 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1653 /**
1654 * Broadcast Action: Indicates low battery condition on the device.
1655 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001656 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001657 * <p class="note">This is a protected intent that can only be sent
1658 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001659 */
1660 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1661 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1662 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001663 * Broadcast Action: Indicates the battery is now okay after being low.
1664 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1665 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001666 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001667 * <p class="note">This is a protected intent that can only be sent
1668 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001669 */
1670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1671 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1672 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001673 * Broadcast Action: External power has been connected to the device.
1674 * This is intended for applications that wish to register specifically to this notification.
1675 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1676 * stay active to receive this notification. This action can be used to implement actions
1677 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001678 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001679 * <p class="note">This is a protected intent that can only be sent
1680 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001681 */
1682 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001683 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001684 /**
1685 * Broadcast Action: External power has been removed from the device.
1686 * This is intended for applications that wish to register specifically to this notification.
1687 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1688 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001689 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001690 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001691 * <p class="note">This is a protected intent that can only be sent
1692 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001693 */
1694 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001695 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001696 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001697 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001698 * Broadcast Action: Device is shutting down.
1699 * This is broadcast when the device is being shut down (completely turned
1700 * off, not sleeping). Once the broadcast is complete, the final shutdown
1701 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001702 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001703 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001704 * <p class="note">This is a protected intent that can only be sent
1705 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001706 */
1707 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001708 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001709 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001710 * Activity Action: Start this activity to request system shutdown.
1711 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1712 * to request confirmation from the user before shutting down.
1713 *
1714 * <p class="note">This is a protected intent that can only be sent
1715 * by the system.
1716 *
1717 * {@hide}
1718 */
1719 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1720 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001721 * Broadcast Action: A sticky broadcast that indicates low memory
1722 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001723 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001724 * <p class="note">This is a protected intent that can only be sent
1725 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001726 */
1727 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1728 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1729 /**
1730 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001731 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001732 * <p class="note">This is a protected intent that can only be sent
1733 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001734 */
1735 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1736 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1737 /**
Jake Hambybb371632010-08-23 18:16:48 -07001738 * Broadcast Action: A sticky broadcast that indicates a memory full
1739 * condition on the device. This is intended for activities that want
1740 * to be able to fill the data partition completely, leaving only
1741 * enough free space to prevent system-wide SQLite failures.
1742 *
1743 * <p class="note">This is a protected intent that can only be sent
1744 * by the system.
1745 *
1746 * {@hide}
1747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1749 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1750 /**
1751 * Broadcast Action: Indicates memory full condition on the device
1752 * no longer exists.
1753 *
1754 * <p class="note">This is a protected intent that can only be sent
1755 * by the system.
1756 *
1757 * {@hide}
1758 */
1759 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1760 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1761 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001762 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1763 * and package management should be started.
1764 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1765 * notification.
1766 */
1767 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1768 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1769 /**
1770 * Broadcast Action: The device has entered USB Mass Storage mode.
1771 * This is used mainly for the USB Settings panel.
1772 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1773 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001774 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001775 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001776 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001777 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1778
1779 /**
1780 * Broadcast Action: The device has exited USB Mass Storage mode.
1781 * This is used mainly for the USB Settings panel.
1782 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1783 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001784 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001785 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001786 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001787 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1788
1789 /**
1790 * Broadcast Action: External media has been removed.
1791 * The path to the mount point for the removed media is contained in the Intent.mData field.
1792 */
1793 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1794 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1795
1796 /**
1797 * Broadcast Action: External media is present, but not mounted at its mount point.
1798 * The path to the mount point for the removed media is contained in the Intent.mData field.
1799 */
1800 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1801 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1802
1803 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001804 * Broadcast Action: External media is present, and being disk-checked
1805 * 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 -08001806 */
1807 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1808 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1809
1810 /**
1811 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1812 * 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 -08001813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1815 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1816
1817 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001818 * Broadcast Action: External media is present and mounted at its mount point.
1819 * The path to the mount point for the removed media is contained in the Intent.mData field.
1820 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1821 * media was mounted read only.
1822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1824 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1825
1826 /**
1827 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001828 * 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 -07001829 */
1830 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1831 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1832
1833 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001834 * Broadcast Action: External media is no longer being shared via USB mass storage.
1835 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1836 *
1837 * @hide
1838 */
1839 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1840
1841 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001842 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1843 * The path to the mount point for the removed media is contained in the Intent.mData field.
1844 */
1845 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1846 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1847
1848 /**
1849 * Broadcast Action: External media is present but cannot be mounted.
1850 * The path to the mount point for the removed media is contained in the Intent.mData field.
1851 */
1852 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1853 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1854
1855 /**
1856 * Broadcast Action: User has expressed the desire to remove the external storage media.
1857 * Applications should close all files they have open within the mount point when they receive this intent.
1858 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1859 */
1860 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1861 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1862
1863 /**
1864 * Broadcast Action: The media scanner has started scanning a directory.
1865 * The path to the directory being scanned is contained in the Intent.mData field.
1866 */
1867 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1868 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1869
1870 /**
1871 * Broadcast Action: The media scanner has finished scanning a directory.
1872 * The path to the scanned directory is contained in the Intent.mData field.
1873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1875 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1876
1877 /**
1878 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1879 * The path to the file is contained in the Intent.mData field.
1880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1882 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1883
1884 /**
1885 * Broadcast Action: The "Media Button" was pressed. Includes a single
1886 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1887 * caused the broadcast.
1888 */
1889 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1890 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1891
1892 /**
1893 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1894 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1895 * caused the broadcast.
1896 */
1897 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1898 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1899
1900 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1901 // location; they are not general-purpose actions.
1902
1903 /**
1904 * Broadcast Action: An GTalk connection has been established.
1905 */
1906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1907 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1908 "android.intent.action.GTALK_CONNECTED";
1909
1910 /**
1911 * Broadcast Action: An GTalk connection has been disconnected.
1912 */
1913 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1914 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1915 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001916
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001917 /**
1918 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_INPUT_METHOD_CHANGED =
1922 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001923
1924 /**
1925 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1926 * more radios have been turned off or on. The intent will have the following extra value:</p>
1927 * <ul>
1928 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1929 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1930 * turned off</li>
1931 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001932 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001933 * <p class="note">This is a protected intent that can only be sent
1934 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001935 */
1936 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1937 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1938
1939 /**
1940 * Broadcast Action: Some content providers have parts of their namespace
1941 * where they publish new events or items that the user may be especially
1942 * interested in. For these things, they may broadcast this action when the
1943 * set of interesting items change.
1944 *
1945 * For example, GmailProvider sends this notification when the set of unread
1946 * mail in the inbox changes.
1947 *
1948 * <p>The data of the intent identifies which part of which provider
1949 * changed. When queried through the content resolver, the data URI will
1950 * return the data set in question.
1951 *
1952 * <p>The intent will have the following extra values:
1953 * <ul>
1954 * <li><em>count</em> - The number of items in the data set. This is the
1955 * same as the number of items in the cursor returned by querying the
1956 * data URI. </li>
1957 * </ul>
1958 *
1959 * This intent will be sent at boot (if the count is non-zero) and when the
1960 * data set changes. It is possible for the data set to change without the
1961 * count changing (for example, if a new unread message arrives in the same
1962 * sync operation in which a message is archived). The phone should still
1963 * ring/vibrate/etc as normal in this case.
1964 */
1965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1966 public static final String ACTION_PROVIDER_CHANGED =
1967 "android.intent.action.PROVIDER_CHANGED";
1968
1969 /**
1970 * Broadcast Action: Wired Headset plugged in or unplugged.
1971 *
1972 * <p>The intent will have the following extra values:
1973 * <ul>
1974 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1975 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001976 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001977 * </ul>
1978 * </ul>
1979 */
1980 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1981 public static final String ACTION_HEADSET_PLUG =
1982 "android.intent.action.HEADSET_PLUG";
1983
1984 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001985 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
1986 *
1987 * <p>The intent will have the following extra values:
1988 * <ul>
1989 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1990 * <li><em>name</em> - Headset type, human readable string </li>
1991 * </ul>
1992 * </ul>
1993 * @hide
1994 */
1995 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1996 public static final String ACTION_USB_ANLG_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08001997 "android.intent.action.USB_ANLG_HEADSET_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001998
1999 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002000 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002001 *
2002 * <p>The intent will have the following extra values:
2003 * <ul>
2004 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2005 * <li><em>name</em> - Headset type, human readable string </li>
2006 * </ul>
2007 * </ul>
2008 * @hide
2009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_USB_DGTL_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08002012 "android.intent.action.USB_DGTL_HEADSET_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002013
2014 /**
2015 * Broadcast Action: A HMDI cable was plugged or unplugged
2016 *
2017 * <p>The intent will have the following extra values:
2018 * <ul>
2019 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2020 * <li><em>name</em> - HDMI cable, human readable string </li>
2021 * </ul>
2022 * </ul>
2023 * @hide
2024 */
2025 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2026 public static final String ACTION_HDMI_AUDIO_PLUG =
2027 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002028
2029 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002030 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2031 * <ul>
2032 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2033 * </ul>
2034 *
2035 * <p class="note">This is a protected intent that can only be sent
2036 * by the system.
2037 *
2038 * @hide
2039 */
2040 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2041 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2042 = "android.intent.action.ADVANCED_SETTINGS";
2043
2044 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002045 * Broadcast Action: An outgoing call is about to be placed.
2046 *
2047 * <p>The Intent will have the following extra value:
2048 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002049 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002050 * the phone number originally intended to be dialed.</li>
2051 * </ul>
2052 * <p>Once the broadcast is finished, the resultData is used as the actual
2053 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002054 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002055 * outgoing call in turn: for example, a parental control application
2056 * might verify that the user is authorized to place the call at that
2057 * time, then a number-rewriting application might add an area code if
2058 * one was not specified.</p>
2059 * <p>For consistency, any receiver whose purpose is to prohibit phone
2060 * calls should have a priority of 0, to ensure it will see the final
2061 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002062 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002063 * should have a positive priority.
2064 * Negative priorities are reserved for the system for this broadcast;
2065 * using them may cause problems.</p>
2066 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2067 * abort the broadcast.</p>
2068 * <p>Emergency calls cannot be intercepted using this mechanism, and
2069 * other calls cannot be modified to call emergency numbers using this
2070 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002071 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002072 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2073 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002074 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002075 * <p class="note">This is a protected intent that can only be sent
2076 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002077 */
2078 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2079 public static final String ACTION_NEW_OUTGOING_CALL =
2080 "android.intent.action.NEW_OUTGOING_CALL";
2081
2082 /**
2083 * Broadcast Action: Have the device reboot. This is only for use by
2084 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002085 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002086 * <p class="note">This is a protected intent that can only be sent
2087 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002088 */
2089 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2090 public static final String ACTION_REBOOT =
2091 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002092
Wei Huang97ecc9c2009-05-11 17:44:20 -07002093 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002094 * Broadcast Action: A sticky broadcast for changes in the physical
2095 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002096 *
2097 * <p>The intent will have the following extra values:
2098 * <ul>
2099 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002100 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002101 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002102 * <p>This is intended for monitoring the current physical dock state.
2103 * See {@link android.app.UiModeManager} for the normal API dealing with
2104 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_DOCK_EVENT =
2108 "android.intent.action.DOCK_EVENT";
2109
2110 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002111 * Broadcast Action: a remote intent is to be broadcasted.
2112 *
2113 * A remote intent is used for remote RPC between devices. The remote intent
2114 * is serialized and sent from one device to another device. The receiving
2115 * device parses the remote intent and broadcasts it. Note that anyone can
2116 * broadcast a remote intent. However, if the intent receiver of the remote intent
2117 * does not trust intent broadcasts from arbitrary intent senders, it should require
2118 * the sender to hold certain permissions so only trusted sender's broadcast will be
2119 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002120 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002121 */
2122 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002123 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002124
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002125 /**
2126 * Broadcast Action: hook for permforming cleanup after a system update.
2127 *
2128 * The broadcast is sent when the system is booting, before the
2129 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2130 * image. A receiver for this should do its work and then disable itself
2131 * so that it does not get run again at the next boot.
2132 * @hide
2133 */
2134 public static final String ACTION_PRE_BOOT_COMPLETED =
2135 "android.intent.action.PRE_BOOT_COMPLETED";
2136
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002137 // ---------------------------------------------------------------------
2138 // ---------------------------------------------------------------------
2139 // Standard intent categories (see addCategory()).
2140
2141 /**
2142 * Set if the activity should be an option for the default action
2143 * (center press) to perform on a piece of data. Setting this will
2144 * hide from the user any activities without it set when performing an
2145 * action on some data. Note that this is normal -not- set in the
2146 * Intent when initiating an action -- it is for use in intent filters
2147 * specified in packages.
2148 */
2149 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2150 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2151 /**
2152 * Activities that can be safely invoked from a browser must support this
2153 * category. For example, if the user is viewing a web page or an e-mail
2154 * and clicks on a link in the text, the Intent generated execute that
2155 * link will require the BROWSABLE category, so that only activities
2156 * supporting this category will be considered as possible actions. By
2157 * supporting this category, you are promising that there is nothing
2158 * damaging (without user intervention) that can happen by invoking any
2159 * matching Intent.
2160 */
2161 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2162 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2163 /**
2164 * Set if the activity should be considered as an alternative action to
2165 * the data the user is currently viewing. See also
2166 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2167 * applies to the selection in a list of items.
2168 *
2169 * <p>Supporting this category means that you would like your activity to be
2170 * displayed in the set of alternative things the user can do, usually as
2171 * part of the current activity's options menu. You will usually want to
2172 * include a specific label in the &lt;intent-filter&gt; of this action
2173 * describing to the user what it does.
2174 *
2175 * <p>The action of IntentFilter with this category is important in that it
2176 * describes the specific action the target will perform. This generally
2177 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2178 * a specific name such as "com.android.camera.action.CROP. Only one
2179 * alternative of any particular action will be shown to the user, so using
2180 * a specific action like this makes sure that your alternative will be
2181 * displayed while also allowing other applications to provide their own
2182 * overrides of that particular action.
2183 */
2184 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2185 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2186 /**
2187 * Set if the activity should be considered as an alternative selection
2188 * action to the data the user has currently selected. This is like
2189 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2190 * of items from which the user can select, giving them alternatives to the
2191 * default action that will be performed on it.
2192 */
2193 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2194 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2195 /**
2196 * Intended to be used as a tab inside of an containing TabActivity.
2197 */
2198 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2199 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2200 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002201 * Should be displayed in the top-level launcher.
2202 */
2203 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2204 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2205 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002206 * Provides information about the package it is in; typically used if
2207 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2208 * a front-door to the user without having to be shown in the all apps list.
2209 */
2210 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2211 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2212 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002213 * This is the home activity, that is the first activity that is displayed
2214 * when the device boots.
2215 */
2216 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2217 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2218 /**
2219 * This activity is a preference panel.
2220 */
2221 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2222 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2223 /**
2224 * This activity is a development preference panel.
2225 */
2226 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2227 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2228 /**
2229 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002230 */
2231 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2232 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2233 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002234 * This activity allows the user to browse and download new applications.
2235 */
2236 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2237 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2238 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002239 * This activity may be exercised by the monkey or other automated test tools.
2240 */
2241 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2242 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2243 /**
2244 * To be used as a test (not part of the normal user experience).
2245 */
2246 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2247 /**
2248 * To be used as a unit test (run through the Test Harness).
2249 */
2250 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2251 /**
2252 * To be used as an sample code example (not part of the normal user
2253 * experience).
2254 */
2255 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2256 /**
2257 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2258 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2259 * when queried, though it is allowable for those columns to be blank.
2260 */
2261 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2262 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2263
2264 /**
2265 * To be used as code under test for framework instrumentation tests.
2266 */
2267 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2268 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002269 /**
2270 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002271 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2272 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002273 */
2274 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2275 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2276 /**
2277 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002278 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2279 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002280 */
2281 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2282 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002283 /**
2284 * An activity to run when device is inserted into a analog (low end) dock.
2285 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2286 * information, see {@link android.app.UiModeManager}.
2287 */
2288 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2289 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2290
2291 /**
2292 * An activity to run when device is inserted into a digital (high end) dock.
2293 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2294 * information, see {@link android.app.UiModeManager}.
2295 */
2296 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2297 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002298
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002299 /**
2300 * Used to indicate that the activity can be used in a car environment.
2301 */
2302 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2303 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2304
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002305 // ---------------------------------------------------------------------
2306 // ---------------------------------------------------------------------
2307 // Standard extra data keys.
2308
2309 /**
2310 * The initial data to place in a newly created record. Use with
2311 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2312 * fields as would be given to the underlying ContentProvider.insert()
2313 * call.
2314 */
2315 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2316
2317 /**
2318 * A constant CharSequence that is associated with the Intent, used with
2319 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2320 * this may be a styled CharSequence, so you must use
2321 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2322 * retrieve it.
2323 */
2324 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2325
2326 /**
2327 * A content: URI holding a stream of data associated with the Intent,
2328 * used with {@link #ACTION_SEND} to supply the data being sent.
2329 */
2330 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2331
2332 /**
2333 * A String[] holding e-mail addresses that should be delivered to.
2334 */
2335 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2336
2337 /**
2338 * A String[] holding e-mail addresses that should be carbon copied.
2339 */
2340 public static final String EXTRA_CC = "android.intent.extra.CC";
2341
2342 /**
2343 * A String[] holding e-mail addresses that should be blind carbon copied.
2344 */
2345 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2346
2347 /**
2348 * A constant string holding the desired subject line of a message.
2349 */
2350 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2351
2352 /**
2353 * An Intent describing the choices you would like shown with
2354 * {@link #ACTION_PICK_ACTIVITY}.
2355 */
2356 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2357
2358 /**
2359 * A CharSequence dialog title to provide to the user when used with a
2360 * {@link #ACTION_CHOOSER}.
2361 */
2362 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2363
2364 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002365 * A Parcelable[] of {@link Intent} or
2366 * {@link android.content.pm.LabeledIntent} objects as set with
2367 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2368 * a the front of the list of choices, when shown to the user with a
2369 * {@link #ACTION_CHOOSER}.
2370 */
2371 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2372
2373 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002374 * A {@link android.view.KeyEvent} object containing the event that
2375 * triggered the creation of the Intent it is in.
2376 */
2377 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2378
2379 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002380 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2381 * before shutting down.
2382 *
2383 * {@hide}
2384 */
2385 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2386
2387 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002388 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2389 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2390 * of restarting the application.
2391 */
2392 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2393
2394 /**
2395 * A String holding the phone number originally entered in
2396 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2397 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2398 */
2399 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002400
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002401 /**
2402 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2403 * intents to supply the uid the package had been assigned. Also an optional
2404 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2405 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2406 * purpose.
2407 */
2408 public static final String EXTRA_UID = "android.intent.extra.UID";
2409
2410 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002411 * @hide String array of package names.
2412 */
2413 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2414
2415 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002416 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2417 * intents to indicate whether this represents a full uninstall (removing
2418 * both the code and its data) or a partial uninstall (leaving its data,
2419 * implying that this is an update).
2420 */
2421 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002422
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002423 /**
2424 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2425 * intents to indicate that this is a replacement of the package, so this
2426 * broadcast will immediately be followed by an add broadcast for a
2427 * different version of the same package.
2428 */
2429 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002430
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002431 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002432 * Used as an int extra field in {@link android.app.AlarmManager} intents
2433 * to tell the application being invoked how many pending alarms are being
2434 * delievered with the intent. For one-shot alarms this will always be 1.
2435 * For recurring alarms, this might be greater than 1 if the device was
2436 * asleep or powered off at the time an earlier alarm would have been
2437 * delivered.
2438 */
2439 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002440
Jacek Surazski86b6c532009-05-13 14:38:28 +02002441 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002442 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2443 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002444 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2445 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002446 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2447 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2448 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002449 */
2450 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2451
2452 /**
2453 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2454 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002455 */
2456 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2457
2458 /**
2459 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2460 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002461 */
2462 public static final int EXTRA_DOCK_STATE_DESK = 1;
2463
2464 /**
2465 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2466 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002467 */
2468 public static final int EXTRA_DOCK_STATE_CAR = 2;
2469
2470 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002471 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2472 * to represent that the phone is in a analog (low end) dock.
2473 */
2474 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2475
2476 /**
2477 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2478 * to represent that the phone is in a digital (high end) dock.
2479 */
2480 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2481
2482 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002483 * Boolean that can be supplied as meta-data with a dock activity, to
2484 * indicate that the dock should take over the home key when it is active.
2485 */
2486 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002487
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002488 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002489 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2490 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002491 */
2492 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2493
2494 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002495 * Used in the extra field in the remote intent. It's astring token passed with the
2496 * remote intent.
2497 */
2498 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2499 "android.intent.extra.remote_intent_token";
2500
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002501 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002502 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002503 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002504 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002505 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002506 "android.intent.extra.changed_component_name";
2507
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002508 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002509 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002510 * and contains a string array of all of the components that have changed.
2511 */
2512 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2513 "android.intent.extra.changed_component_name_list";
2514
2515 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002516 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002517 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2518 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002519 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002520 */
2521 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2522 "android.intent.extra.changed_package_list";
2523
2524 /**
2525 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002526 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2527 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002528 * and contains an integer array of uids of all of the components
2529 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002530 */
2531 public static final String EXTRA_CHANGED_UID_LIST =
2532 "android.intent.extra.changed_uid_list";
2533
2534 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002535 * @hide
2536 * Magic extra system code can use when binding, to give a label for
2537 * who it is that has bound to a service. This is an integer giving
2538 * a framework string resource that can be displayed to the user.
2539 */
2540 public static final String EXTRA_CLIENT_LABEL =
2541 "android.intent.extra.client_label";
2542
2543 /**
2544 * @hide
2545 * Magic extra system code can use when binding, to give a PendingIntent object
2546 * that can be launched for the user to disable the system's use of this
2547 * service.
2548 */
2549 public static final String EXTRA_CLIENT_INTENT =
2550 "android.intent.extra.client_intent";
2551
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002552 /**
2553 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2554 * data that is on the local device. This is a boolean extra; the default
2555 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2556 * the user to select media that is already on the device, not requiring it
2557 * be downloaded from a remote service when opened. Another way to look
2558 * at it is that such content should generally have a "_data" column to the
2559 * path of the content on local external storage.
2560 */
2561 public static final String EXTRA_LOCAL_ONLY =
2562 "android.intent.extra.LOCAL_ONLY";
2563
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002564 // ---------------------------------------------------------------------
2565 // ---------------------------------------------------------------------
2566 // Intent flags (see mFlags variable).
2567
2568 /**
2569 * If set, the recipient of this Intent will be granted permission to
2570 * perform read operations on the Uri in the Intent's data.
2571 */
2572 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2573 /**
2574 * If set, the recipient of this Intent will be granted permission to
2575 * perform write operations on the Uri in the Intent's data.
2576 */
2577 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2578 /**
2579 * Can be set by the caller to indicate that this Intent is coming from
2580 * a background operation, not from direct user interaction.
2581 */
2582 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2583 /**
2584 * A flag you can enable for debugging: when set, log messages will be
2585 * printed during the resolution of this intent to show you what has
2586 * been found to create the final resolved list.
2587 */
2588 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002589 /**
2590 * If set, this intent will not match any components in packages that
2591 * are currently stopped. If this is not set, then the default behavior
2592 * is to include such applications in the result.
2593 */
2594 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2595 /**
2596 * If set, this intent will always match any components in packages that
2597 * are currently stopped. This is the default behavior when
2598 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2599 * flags are set, this one wins (it allows overriding of exclude for
2600 * places where the framework may automatically set the exclude flag).
2601 */
2602 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002603
2604 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002605 * If set, the new activity is not kept in the history stack. As soon as
2606 * the user navigates away from it, the activity is finished. This may also
2607 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2608 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002609 */
2610 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2611 /**
2612 * If set, the activity will not be launched if it is already running
2613 * at the top of the history stack.
2614 */
2615 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2616 /**
2617 * If set, this activity will become the start of a new task on this
2618 * history stack. A task (from the activity that started it to the
2619 * next task activity) defines an atomic group of activities that the
2620 * user can move to. Tasks can be moved to the foreground and background;
2621 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002622 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002623 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2624 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002625 *
2626 * <p>This flag is generally used by activities that want
2627 * to present a "launcher" style behavior: they give the user a list of
2628 * separate things that can be done, which otherwise run completely
2629 * independently of the activity launching them.
2630 *
2631 * <p>When using this flag, if a task is already running for the activity
2632 * you are now starting, then a new activity will not be started; instead,
2633 * the current task will simply be brought to the front of the screen with
2634 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2635 * to disable this behavior.
2636 *
2637 * <p>This flag can not be used when the caller is requesting a result from
2638 * the activity being launched.
2639 */
2640 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2641 /**
2642 * <strong>Do not use this flag unless you are implementing your own
2643 * top-level application launcher.</strong> Used in conjunction with
2644 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2645 * behavior of bringing an existing task to the foreground. When set,
2646 * a new task is <em>always</em> started to host the Activity for the
2647 * Intent, regardless of whether there is already an existing task running
2648 * the same thing.
2649 *
2650 * <p><strong>Because the default system does not include graphical task management,
2651 * you should not use this flag unless you provide some way for a user to
2652 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002653 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002654 * <p>This flag is ignored if
2655 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2656 *
Scott Main7aee61f2011-02-08 11:25:01 -08002657 * <p>See
2658 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2659 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002660 */
2661 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2662 /**
2663 * If set, and the activity being launched is already running in the
2664 * current task, then instead of launching a new instance of that activity,
2665 * all of the other activities on top of it will be closed and this Intent
2666 * will be delivered to the (now on top) old activity as a new Intent.
2667 *
2668 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2669 * If D calls startActivity() with an Intent that resolves to the component
2670 * of activity B, then C and D will be finished and B receive the given
2671 * Intent, resulting in the stack now being: A, B.
2672 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002673 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002674 * either receive the new intent you are starting here in its
2675 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002676 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002677 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2678 * the same intent, then it will be finished and re-created; for all other
2679 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2680 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002681 *
2682 * <p>This launch mode can also be used to good effect in conjunction with
2683 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2684 * of a task, it will bring any currently running instance of that task
2685 * to the foreground, and then clear it to its root state. This is
2686 * especially useful, for example, when launching an activity from the
2687 * notification manager.
2688 *
Scott Main7aee61f2011-02-08 11:25:01 -08002689 * <p>See
2690 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2691 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002692 */
2693 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2694 /**
2695 * If set and this intent is being used to launch a new activity from an
2696 * existing one, then the reply target of the existing activity will be
2697 * transfered to the new activity. This way the new activity can call
2698 * {@link android.app.Activity#setResult} and have that result sent back to
2699 * the reply target of the original activity.
2700 */
2701 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2702 /**
2703 * If set and this intent is being used to launch a new activity from an
2704 * existing one, the current activity will not be counted as the top
2705 * activity for deciding whether the new intent should be delivered to
2706 * the top instead of starting a new one. The previous activity will
2707 * be used as the top, with the assumption being that the current activity
2708 * will finish itself immediately.
2709 */
2710 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2711 /**
2712 * If set, the new activity is not kept in the list of recently launched
2713 * activities.
2714 */
2715 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2716 /**
2717 * This flag is not normally set by application code, but set for you by
2718 * the system as described in the
2719 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2720 * launchMode} documentation for the singleTask mode.
2721 */
2722 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2723 /**
2724 * If set, and this activity is either being started in a new task or
2725 * bringing to the top an existing task, then it will be launched as
2726 * the front door of the task. This will result in the application of
2727 * any affinities needed to have that task in the proper state (either
2728 * moving activities to or from it), or simply resetting that task to
2729 * its initial state if needed.
2730 */
2731 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2732 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002733 * This flag is not normally set by application code, but set for you by
2734 * the system if this activity is being launched from history
2735 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002736 */
2737 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002738 /**
2739 * If set, this marks a point in the task's activity stack that should
2740 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002741 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002742 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2743 * the user re-launching it from home), this activity and all on top of
2744 * it will be finished so that the user does not return to them, but
2745 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002746 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002747 * <p>This is useful for cases where you have a logical break in your
2748 * application. For example, an e-mail application may have a command
2749 * to view an attachment, which launches an image view activity to
2750 * display it. This activity should be part of the e-mail application's
2751 * task, since it is a part of the task the user is involved in. However,
2752 * if the user leaves that task, and later selects the e-mail app from
2753 * home, we may like them to return to the conversation they were
2754 * viewing, not the picture attachment, since that is confusing. By
2755 * setting this flag when launching the image viewer, that viewer and
2756 * any activities it starts will be removed the next time the user returns
2757 * to mail.
2758 */
2759 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002760 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002761 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002762 * callback from occurring on the current frontmost activity before it is
2763 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002764 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002765 * <p>Typically, an activity can rely on that callback to indicate that an
2766 * explicit user action has caused their activity to be moved out of the
2767 * foreground. The callback marks an appropriate point in the activity's
2768 * lifecycle for it to dismiss any notifications that it intends to display
2769 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002770 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002771 * <p>If an activity is ever started via any non-user-driven events such as
2772 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2773 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002774 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002775 */
2776 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002777 /**
2778 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2779 * this flag will cause the launched activity to be brought to the front of its
2780 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002781 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002782 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2783 * If D calls startActivity() with an Intent that resolves to the component
2784 * of activity B, then B will be brought to the front of the history stack,
2785 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002786 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002787 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002788 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002789 */
2790 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002791 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002792 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2793 * this flag will prevent the system from applying an activity transition
2794 * animation to go to the next activity state. This doesn't mean an
2795 * animation will never run -- if another activity change happens that doesn't
2796 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002797 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002798 * when you are going to do a series of activity operations but the
2799 * animation seen by the user shouldn't be driven by the first activity
2800 * change but rather a later one.
2801 */
2802 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2803 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002804 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2805 * this flag will cause any existing task that would be associated with the
2806 * activity to be cleared before the activity is started. That is, the activity
2807 * becomes the new root of an otherwise empty task, and any old activities
2808 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2809 */
2810 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
2811 /**
2812 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2813 * this flag will cause a newly launching task to be placed on top of the current
2814 * home activity task (if there is one). That is, pressing back from the task
2815 * will always return the user to home even if that was not the last activity they
2816 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2817 */
2818 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
2819 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002820 * If set, when sending a broadcast only registered receivers will be
2821 * called -- no BroadcastReceiver components will be launched.
2822 */
2823 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002824 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002825 * If set, when sending a broadcast the new broadcast will replace
2826 * any existing pending broadcast that matches it. Matching is defined
2827 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
2828 * true for the intents of the two broadcasts. When a match is found,
2829 * the new broadcast (and receivers associated with it) will replace the
2830 * existing one in the pending broadcast list, remaining at the same
2831 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08002832 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002833 * <p>This flag is most typically used with sticky broadcasts, which
2834 * only care about delivering the most recent values of the broadcast
2835 * to their receivers.
2836 */
2837 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
2838 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002839 * If set, when sending a broadcast <i>before boot has completed</i> only
2840 * registered receivers will be called -- no BroadcastReceiver components
2841 * will be launched. Sticky intent state will be recorded properly even
2842 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2843 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002844 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002845 * <p>This flag is only for use by system sevices as a convenience to
2846 * avoid having to implement a more complex mechanism around detection
2847 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002848 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002849 * @hide
2850 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002851 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x10000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002852 /**
2853 * Set when this broadcast is for a boot upgrade, a special mode that
2854 * allows the broadcast to be sent before the system is ready and launches
2855 * the app process with no providers running in it.
2856 * @hide
2857 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002858 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x08000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002860 /**
2861 * @hide Flags that can't be changed with PendingIntent.
2862 */
2863 public static final int IMMUTABLE_FLAGS =
2864 FLAG_GRANT_READ_URI_PERMISSION
2865 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08002866
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002867 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002868 // ---------------------------------------------------------------------
2869 // toUri() and parseUri() options.
2870
2871 /**
2872 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2873 * always has the "intent:" scheme. This syntax can be used when you want
2874 * to later disambiguate between URIs that are intended to describe an
2875 * Intent vs. all others that should be treated as raw URIs. When used
2876 * with {@link #parseUri}, any other scheme will result in a generic
2877 * VIEW action for that raw URI.
2878 */
2879 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08002880
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002881 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002882
2883 private String mAction;
2884 private Uri mData;
2885 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002886 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002887 private ComponentName mComponent;
2888 private int mFlags;
2889 private HashSet<String> mCategories;
2890 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002891 private Rect mSourceBounds;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002892
2893 // ---------------------------------------------------------------------
2894
2895 /**
2896 * Create an empty intent.
2897 */
2898 public Intent() {
2899 }
2900
2901 /**
2902 * Copy constructor.
2903 */
2904 public Intent(Intent o) {
2905 this.mAction = o.mAction;
2906 this.mData = o.mData;
2907 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002908 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002909 this.mComponent = o.mComponent;
2910 this.mFlags = o.mFlags;
2911 if (o.mCategories != null) {
2912 this.mCategories = new HashSet<String>(o.mCategories);
2913 }
2914 if (o.mExtras != null) {
2915 this.mExtras = new Bundle(o.mExtras);
2916 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002917 if (o.mSourceBounds != null) {
2918 this.mSourceBounds = new Rect(o.mSourceBounds);
2919 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002920 }
2921
2922 @Override
2923 public Object clone() {
2924 return new Intent(this);
2925 }
2926
2927 private Intent(Intent o, boolean all) {
2928 this.mAction = o.mAction;
2929 this.mData = o.mData;
2930 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002931 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002932 this.mComponent = o.mComponent;
2933 if (o.mCategories != null) {
2934 this.mCategories = new HashSet<String>(o.mCategories);
2935 }
2936 }
2937
2938 /**
2939 * Make a clone of only the parts of the Intent that are relevant for
2940 * filter matching: the action, data, type, component, and categories.
2941 */
2942 public Intent cloneFilter() {
2943 return new Intent(this, false);
2944 }
2945
2946 /**
2947 * Create an intent with a given action. All other fields (data, type,
2948 * class) are null. Note that the action <em>must</em> be in a
2949 * namespace because Intents are used globally in the system -- for
2950 * example the system VIEW action is android.intent.action.VIEW; an
2951 * application's custom action would be something like
2952 * com.google.app.myapp.CUSTOM_ACTION.
2953 *
2954 * @param action The Intent action, such as ACTION_VIEW.
2955 */
2956 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002957 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002958 }
2959
2960 /**
2961 * Create an intent with a given action and for a given data url. Note
2962 * that the action <em>must</em> be in a namespace because Intents are
2963 * used globally in the system -- for example the system VIEW action is
2964 * android.intent.action.VIEW; an application's custom action would be
2965 * something like com.google.app.myapp.CUSTOM_ACTION.
2966 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002967 * <p><em>Note: scheme and host name matching in the Android framework is
2968 * case-sensitive, unlike the formal RFC. As a result,
2969 * you should always ensure that you write your Uri with these elements
2970 * using lower case letters, and normalize any Uris you receive from
2971 * outside of Android to ensure the scheme and host is lower case.</em></p>
2972 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002973 * @param action The Intent action, such as ACTION_VIEW.
2974 * @param uri The Intent data URI.
2975 */
2976 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002977 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002978 mData = uri;
2979 }
2980
2981 /**
2982 * Create an intent for a specific component. All other fields (action, data,
2983 * type, class) are null, though they can be modified later with explicit
2984 * calls. This provides a convenient way to create an intent that is
2985 * intended to execute a hard-coded class name, rather than relying on the
2986 * system to find an appropriate class for you; see {@link #setComponent}
2987 * for more information on the repercussions of this.
2988 *
2989 * @param packageContext A Context of the application package implementing
2990 * this class.
2991 * @param cls The component class that is to be used for the intent.
2992 *
2993 * @see #setClass
2994 * @see #setComponent
2995 * @see #Intent(String, android.net.Uri , Context, Class)
2996 */
2997 public Intent(Context packageContext, Class<?> cls) {
2998 mComponent = new ComponentName(packageContext, cls);
2999 }
3000
3001 /**
3002 * Create an intent for a specific component with a specified action and data.
3003 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3004 * construct the Intent and then calling {@link #setClass} to set its
3005 * class.
3006 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003007 * <p><em>Note: scheme and host name matching in the Android framework is
3008 * case-sensitive, unlike the formal RFC. As a result,
3009 * you should always ensure that you write your Uri with these elements
3010 * using lower case letters, and normalize any Uris you receive from
3011 * outside of Android to ensure the scheme and host is lower case.</em></p>
3012 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003013 * @param action The Intent action, such as ACTION_VIEW.
3014 * @param uri The Intent data URI.
3015 * @param packageContext A Context of the application package implementing
3016 * this class.
3017 * @param cls The component class that is to be used for the intent.
3018 *
3019 * @see #Intent(String, android.net.Uri)
3020 * @see #Intent(Context, Class)
3021 * @see #setClass
3022 * @see #setComponent
3023 */
3024 public Intent(String action, Uri uri,
3025 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003026 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003027 mData = uri;
3028 mComponent = new ComponentName(packageContext, cls);
3029 }
3030
3031 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003032 * Create an intent to launch the main (root) activity of a task. This
3033 * is the Intent that is started when the application's is launched from
3034 * Home. For anything else that wants to launch an application in the
3035 * same way, it is important that they use an Intent structured the same
3036 * way, and can use this function to ensure this is the case.
3037 *
3038 * <p>The returned Intent has the given Activity component as its explicit
3039 * component, {@link #ACTION_MAIN} as its action, and includes the
3040 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3041 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3042 * to do that through {@link #addFlags(int)} on the returned Intent.
3043 *
3044 * @param mainActivity The main activity component that this Intent will
3045 * launch.
3046 * @return Returns a newly created Intent that can be used to launch the
3047 * activity as a main application entry.
3048 *
3049 * @see #setClass
3050 * @see #setComponent
3051 */
3052 public static Intent makeMainActivity(ComponentName mainActivity) {
3053 Intent intent = new Intent(ACTION_MAIN);
3054 intent.setComponent(mainActivity);
3055 intent.addCategory(CATEGORY_LAUNCHER);
3056 return intent;
3057 }
3058
3059 /**
3060 * Make an Intent that can be used to re-launch an application's task
3061 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3062 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3063 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3064 *
3065 * @param mainActivity The activity component that is the root of the
3066 * task; this is the activity that has been published in the application's
3067 * manifest as the main launcher icon.
3068 *
3069 * @return Returns a newly created Intent that can be used to relaunch the
3070 * activity's task in its root state.
3071 */
3072 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3073 Intent intent = makeMainActivity(mainActivity);
3074 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3075 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3076 return intent;
3077 }
3078
3079 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003080 * Call {@link #parseUri} with 0 flags.
3081 * @deprecated Use {@link #parseUri} instead.
3082 */
3083 @Deprecated
3084 public static Intent getIntent(String uri) throws URISyntaxException {
3085 return parseUri(uri, 0);
3086 }
Tom Taylord4a47292009-12-21 13:59:18 -08003087
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003088 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003089 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003090 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003091 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003092 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003093 *
3094 * <p>The URI given here must not be relative -- that is, it must include
3095 * the scheme and full path.
3096 *
3097 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003098 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003099 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003100 *
3101 * @return Intent The newly created Intent object.
3102 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003103 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3104 * it bad (as parsed by the Uri class) or the Intent data within the
3105 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003106 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003107 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003108 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003109 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003110 int i = 0;
3111 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003112 // Validate intent scheme for if requested.
3113 if ((flags&URI_INTENT_SCHEME) != 0) {
3114 if (!uri.startsWith("intent:")) {
3115 Intent intent = new Intent(ACTION_VIEW);
3116 try {
3117 intent.setData(Uri.parse(uri));
3118 } catch (IllegalArgumentException e) {
3119 throw new URISyntaxException(uri, e.getMessage());
3120 }
3121 return intent;
3122 }
3123 }
Tom Taylord4a47292009-12-21 13:59:18 -08003124
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003125 // simple case
3126 i = uri.lastIndexOf("#");
3127 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3128
3129 // old format Intent URI
3130 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003131
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003132 // new format
3133 Intent intent = new Intent(ACTION_VIEW);
3134
3135 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003136 String data = i >= 0 ? uri.substring(0, i) : null;
3137 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003138 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003139
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003140 // loop over contents of Intent, all name=value;
3141 while (!uri.startsWith("end", i)) {
3142 int eq = uri.indexOf('=', i);
3143 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003144 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003145
3146 // action
3147 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003148 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003149 }
3150
3151 // categories
3152 else if (uri.startsWith("category=", i)) {
3153 intent.addCategory(value);
3154 }
3155
3156 // type
3157 else if (uri.startsWith("type=", i)) {
3158 intent.mType = value;
3159 }
3160
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003161 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003162 else if (uri.startsWith("launchFlags=", i)) {
3163 intent.mFlags = Integer.decode(value).intValue();
3164 }
3165
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003166 // package
3167 else if (uri.startsWith("package=", i)) {
3168 intent.mPackage = value;
3169 }
3170
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003171 // component
3172 else if (uri.startsWith("component=", i)) {
3173 intent.mComponent = ComponentName.unflattenFromString(value);
3174 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003175
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003176 // scheme
3177 else if (uri.startsWith("scheme=", i)) {
3178 scheme = value;
3179 }
3180
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003181 // source bounds
3182 else if (uri.startsWith("sourceBounds=", i)) {
3183 intent.mSourceBounds = Rect.unflattenFromString(value);
3184 }
3185
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003186 // extra
3187 else {
3188 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003189 // create Bundle if it doesn't already exist
3190 if (intent.mExtras == null) intent.mExtras = new Bundle();
3191 Bundle b = intent.mExtras;
3192 // add EXTRA
3193 if (uri.startsWith("S.", i)) b.putString(key, value);
3194 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3195 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3196 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3197 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3198 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3199 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3200 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3201 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3202 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3203 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003204
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003205 // move to the next item
3206 i = semi + 1;
3207 }
3208
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003209 if (data != null) {
3210 if (data.startsWith("intent:")) {
3211 data = data.substring(7);
3212 if (scheme != null) {
3213 data = scheme + ':' + data;
3214 }
3215 }
Tom Taylord4a47292009-12-21 13:59:18 -08003216
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003217 if (data.length() > 0) {
3218 try {
3219 intent.mData = Uri.parse(data);
3220 } catch (IllegalArgumentException e) {
3221 throw new URISyntaxException(uri, e.getMessage());
3222 }
3223 }
3224 }
Tom Taylord4a47292009-12-21 13:59:18 -08003225
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003226 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003227
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003228 } catch (IndexOutOfBoundsException e) {
3229 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3230 }
3231 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003232
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003233 public static Intent getIntentOld(String uri) throws URISyntaxException {
3234 Intent intent;
3235
3236 int i = uri.lastIndexOf('#');
3237 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003238 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003239 final int intentFragmentStart = i;
3240 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003241
3242 i++;
3243
3244 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003245 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003246 i += 7;
3247 int j = uri.indexOf(')', i);
3248 action = uri.substring(i, j);
3249 i = j + 1;
3250 }
3251
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003252 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003253
3254 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003255 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003256 i += 11;
3257 int j = uri.indexOf(')', i);
3258 while (i < j) {
3259 int sep = uri.indexOf('!', i);
3260 if (sep < 0) sep = j;
3261 if (i < sep) {
3262 intent.addCategory(uri.substring(i, sep));
3263 }
3264 i = sep + 1;
3265 }
3266 i = j + 1;
3267 }
3268
3269 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003270 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003271 i += 5;
3272 int j = uri.indexOf(')', i);
3273 intent.mType = uri.substring(i, j);
3274 i = j + 1;
3275 }
3276
3277 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003278 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003279 i += 12;
3280 int j = uri.indexOf(')', i);
3281 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3282 i = j + 1;
3283 }
3284
3285 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003286 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003287 i += 10;
3288 int j = uri.indexOf(')', i);
3289 int sep = uri.indexOf('!', i);
3290 if (sep >= 0 && sep < j) {
3291 String pkg = uri.substring(i, sep);
3292 String cls = uri.substring(sep + 1, j);
3293 intent.mComponent = new ComponentName(pkg, cls);
3294 }
3295 i = j + 1;
3296 }
3297
3298 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003299 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003300 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003301
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003302 final int closeParen = uri.indexOf(')', i);
3303 if (closeParen == -1) throw new URISyntaxException(uri,
3304 "EXTRA missing trailing ')'", i);
3305
3306 while (i < closeParen) {
3307 // fetch the key value
3308 int j = uri.indexOf('=', i);
3309 if (j <= i + 1 || i >= closeParen) {
3310 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3311 }
3312 char type = uri.charAt(i);
3313 i++;
3314 String key = uri.substring(i, j);
3315 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003316
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003317 // get type-value
3318 j = uri.indexOf('!', i);
3319 if (j == -1 || j >= closeParen) j = closeParen;
3320 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3321 String value = uri.substring(i, j);
3322 i = j;
3323
3324 // create Bundle if it doesn't already exist
3325 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003326
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003327 // add item to bundle
3328 try {
3329 switch (type) {
3330 case 'S':
3331 intent.mExtras.putString(key, Uri.decode(value));
3332 break;
3333 case 'B':
3334 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3335 break;
3336 case 'b':
3337 intent.mExtras.putByte(key, Byte.parseByte(value));
3338 break;
3339 case 'c':
3340 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3341 break;
3342 case 'd':
3343 intent.mExtras.putDouble(key, Double.parseDouble(value));
3344 break;
3345 case 'f':
3346 intent.mExtras.putFloat(key, Float.parseFloat(value));
3347 break;
3348 case 'i':
3349 intent.mExtras.putInt(key, Integer.parseInt(value));
3350 break;
3351 case 'l':
3352 intent.mExtras.putLong(key, Long.parseLong(value));
3353 break;
3354 case 's':
3355 intent.mExtras.putShort(key, Short.parseShort(value));
3356 break;
3357 default:
3358 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3359 }
3360 } catch (NumberFormatException e) {
3361 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3362 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003363
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003364 char ch = uri.charAt(i);
3365 if (ch == ')') break;
3366 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3367 i++;
3368 }
3369 }
3370
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003371 if (isIntentFragment) {
3372 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3373 } else {
3374 intent.mData = Uri.parse(uri);
3375 }
Tom Taylord4a47292009-12-21 13:59:18 -08003376
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003377 if (intent.mAction == null) {
3378 // By default, if no action is specified, then use VIEW.
3379 intent.mAction = ACTION_VIEW;
3380 }
3381
3382 } else {
3383 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3384 }
3385
3386 return intent;
3387 }
3388
3389 /**
3390 * Retrieve the general action to be performed, such as
3391 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3392 * the information in the intent should be interpreted -- most importantly,
3393 * what to do with the data returned by {@link #getData}.
3394 *
3395 * @return The action of this intent or null if none is specified.
3396 *
3397 * @see #setAction
3398 */
3399 public String getAction() {
3400 return mAction;
3401 }
3402
3403 /**
3404 * Retrieve data this intent is operating on. This URI specifies the name
3405 * of the data; often it uses the content: scheme, specifying data in a
3406 * content provider. Other schemes may be handled by specific activities,
3407 * such as http: by the web browser.
3408 *
3409 * @return The URI of the data this intent is targeting or null.
3410 *
3411 * @see #getScheme
3412 * @see #setData
3413 */
3414 public Uri getData() {
3415 return mData;
3416 }
3417
3418 /**
3419 * The same as {@link #getData()}, but returns the URI as an encoded
3420 * String.
3421 */
3422 public String getDataString() {
3423 return mData != null ? mData.toString() : null;
3424 }
3425
3426 /**
3427 * Return the scheme portion of the intent's data. If the data is null or
3428 * does not include a scheme, null is returned. Otherwise, the scheme
3429 * prefix without the final ':' is returned, i.e. "http".
3430 *
3431 * <p>This is the same as calling getData().getScheme() (and checking for
3432 * null data).
3433 *
3434 * @return The scheme of this intent.
3435 *
3436 * @see #getData
3437 */
3438 public String getScheme() {
3439 return mData != null ? mData.getScheme() : null;
3440 }
3441
3442 /**
3443 * Retrieve any explicit MIME type included in the intent. This is usually
3444 * null, as the type is determined by the intent data.
3445 *
3446 * @return If a type was manually set, it is returned; else null is
3447 * returned.
3448 *
3449 * @see #resolveType(ContentResolver)
3450 * @see #setType
3451 */
3452 public String getType() {
3453 return mType;
3454 }
3455
3456 /**
3457 * Return the MIME data type of this intent. If the type field is
3458 * explicitly set, that is simply returned. Otherwise, if the data is set,
3459 * the type of that data is returned. If neither fields are set, a null is
3460 * returned.
3461 *
3462 * @return The MIME type of this intent.
3463 *
3464 * @see #getType
3465 * @see #resolveType(ContentResolver)
3466 */
3467 public String resolveType(Context context) {
3468 return resolveType(context.getContentResolver());
3469 }
3470
3471 /**
3472 * Return the MIME data type of this intent. If the type field is
3473 * explicitly set, that is simply returned. Otherwise, if the data is set,
3474 * the type of that data is returned. If neither fields are set, a null is
3475 * returned.
3476 *
3477 * @param resolver A ContentResolver that can be used to determine the MIME
3478 * type of the intent's data.
3479 *
3480 * @return The MIME type of this intent.
3481 *
3482 * @see #getType
3483 * @see #resolveType(Context)
3484 */
3485 public String resolveType(ContentResolver resolver) {
3486 if (mType != null) {
3487 return mType;
3488 }
3489 if (mData != null) {
3490 if ("content".equals(mData.getScheme())) {
3491 return resolver.getType(mData);
3492 }
3493 }
3494 return null;
3495 }
3496
3497 /**
3498 * Return the MIME data type of this intent, only if it will be needed for
3499 * intent resolution. This is not generally useful for application code;
3500 * it is used by the frameworks for communicating with back-end system
3501 * services.
3502 *
3503 * @param resolver A ContentResolver that can be used to determine the MIME
3504 * type of the intent's data.
3505 *
3506 * @return The MIME type of this intent, or null if it is unknown or not
3507 * needed.
3508 */
3509 public String resolveTypeIfNeeded(ContentResolver resolver) {
3510 if (mComponent != null) {
3511 return mType;
3512 }
3513 return resolveType(resolver);
3514 }
3515
3516 /**
3517 * Check if an category exists in the intent.
3518 *
3519 * @param category The category to check.
3520 *
3521 * @return boolean True if the intent contains the category, else false.
3522 *
3523 * @see #getCategories
3524 * @see #addCategory
3525 */
3526 public boolean hasCategory(String category) {
3527 return mCategories != null && mCategories.contains(category);
3528 }
3529
3530 /**
3531 * Return the set of all categories in the intent. If there are no categories,
3532 * returns NULL.
3533 *
3534 * @return Set The set of categories you can examine. Do not modify!
3535 *
3536 * @see #hasCategory
3537 * @see #addCategory
3538 */
3539 public Set<String> getCategories() {
3540 return mCategories;
3541 }
3542
3543 /**
3544 * Sets the ClassLoader that will be used when unmarshalling
3545 * any Parcelable values from the extras of this Intent.
3546 *
3547 * @param loader a ClassLoader, or null to use the default loader
3548 * at the time of unmarshalling.
3549 */
3550 public void setExtrasClassLoader(ClassLoader loader) {
3551 if (mExtras != null) {
3552 mExtras.setClassLoader(loader);
3553 }
3554 }
3555
3556 /**
3557 * Returns true if an extra value is associated with the given name.
3558 * @param name the extra's name
3559 * @return true if the given extra is present.
3560 */
3561 public boolean hasExtra(String name) {
3562 return mExtras != null && mExtras.containsKey(name);
3563 }
3564
3565 /**
3566 * Returns true if the Intent's extras contain a parcelled file descriptor.
3567 * @return true if the Intent contains a parcelled file descriptor.
3568 */
3569 public boolean hasFileDescriptors() {
3570 return mExtras != null && mExtras.hasFileDescriptors();
3571 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003572
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003573 /**
3574 * Retrieve extended data from the intent.
3575 *
3576 * @param name The name of the desired item.
3577 *
3578 * @return the value of an item that previously added with putExtra()
3579 * or null if none was found.
3580 *
3581 * @deprecated
3582 * @hide
3583 */
3584 @Deprecated
3585 public Object getExtra(String name) {
3586 return getExtra(name, null);
3587 }
3588
3589 /**
3590 * Retrieve extended data from the intent.
3591 *
3592 * @param name The name of the desired item.
3593 * @param defaultValue the value to be returned if no value of the desired
3594 * type is stored with the given name.
3595 *
3596 * @return the value of an item that previously added with putExtra()
3597 * or the default value if none was found.
3598 *
3599 * @see #putExtra(String, boolean)
3600 */
3601 public boolean getBooleanExtra(String name, boolean defaultValue) {
3602 return mExtras == null ? defaultValue :
3603 mExtras.getBoolean(name, defaultValue);
3604 }
3605
3606 /**
3607 * Retrieve extended data from the intent.
3608 *
3609 * @param name The name of the desired item.
3610 * @param defaultValue the value to be returned if no value of the desired
3611 * type is stored with the given name.
3612 *
3613 * @return the value of an item that previously added with putExtra()
3614 * or the default value if none was found.
3615 *
3616 * @see #putExtra(String, byte)
3617 */
3618 public byte getByteExtra(String name, byte defaultValue) {
3619 return mExtras == null ? defaultValue :
3620 mExtras.getByte(name, defaultValue);
3621 }
3622
3623 /**
3624 * Retrieve extended data from the intent.
3625 *
3626 * @param name The name of the desired item.
3627 * @param defaultValue the value to be returned if no value of the desired
3628 * type is stored with the given name.
3629 *
3630 * @return the value of an item that previously added with putExtra()
3631 * or the default value if none was found.
3632 *
3633 * @see #putExtra(String, short)
3634 */
3635 public short getShortExtra(String name, short defaultValue) {
3636 return mExtras == null ? defaultValue :
3637 mExtras.getShort(name, defaultValue);
3638 }
3639
3640 /**
3641 * Retrieve extended data from the intent.
3642 *
3643 * @param name The name of the desired item.
3644 * @param defaultValue the value to be returned if no value of the desired
3645 * type is stored with the given name.
3646 *
3647 * @return the value of an item that previously added with putExtra()
3648 * or the default value if none was found.
3649 *
3650 * @see #putExtra(String, char)
3651 */
3652 public char getCharExtra(String name, char defaultValue) {
3653 return mExtras == null ? defaultValue :
3654 mExtras.getChar(name, defaultValue);
3655 }
3656
3657 /**
3658 * Retrieve extended data from the intent.
3659 *
3660 * @param name The name of the desired item.
3661 * @param defaultValue the value to be returned if no value of the desired
3662 * type is stored with the given name.
3663 *
3664 * @return the value of an item that previously added with putExtra()
3665 * or the default value if none was found.
3666 *
3667 * @see #putExtra(String, int)
3668 */
3669 public int getIntExtra(String name, int defaultValue) {
3670 return mExtras == null ? defaultValue :
3671 mExtras.getInt(name, defaultValue);
3672 }
3673
3674 /**
3675 * Retrieve extended data from the intent.
3676 *
3677 * @param name The name of the desired item.
3678 * @param defaultValue the value to be returned if no value of the desired
3679 * type is stored with the given name.
3680 *
3681 * @return the value of an item that previously added with putExtra()
3682 * or the default value if none was found.
3683 *
3684 * @see #putExtra(String, long)
3685 */
3686 public long getLongExtra(String name, long defaultValue) {
3687 return mExtras == null ? defaultValue :
3688 mExtras.getLong(name, defaultValue);
3689 }
3690
3691 /**
3692 * Retrieve extended data from the intent.
3693 *
3694 * @param name The name of the desired item.
3695 * @param defaultValue the value to be returned if no value of the desired
3696 * type is stored with the given name.
3697 *
3698 * @return the value of an item that previously added with putExtra(),
3699 * or the default value if no such item is present
3700 *
3701 * @see #putExtra(String, float)
3702 */
3703 public float getFloatExtra(String name, float defaultValue) {
3704 return mExtras == null ? defaultValue :
3705 mExtras.getFloat(name, defaultValue);
3706 }
3707
3708 /**
3709 * Retrieve extended data from the intent.
3710 *
3711 * @param name The name of the desired item.
3712 * @param defaultValue the value to be returned if no value of the desired
3713 * type is stored with the given name.
3714 *
3715 * @return the value of an item that previously added with putExtra()
3716 * or the default value if none was found.
3717 *
3718 * @see #putExtra(String, double)
3719 */
3720 public double getDoubleExtra(String name, double defaultValue) {
3721 return mExtras == null ? defaultValue :
3722 mExtras.getDouble(name, defaultValue);
3723 }
3724
3725 /**
3726 * Retrieve extended data from the intent.
3727 *
3728 * @param name The name of the desired item.
3729 *
3730 * @return the value of an item that previously added with putExtra()
3731 * or null if no String value was found.
3732 *
3733 * @see #putExtra(String, String)
3734 */
3735 public String getStringExtra(String name) {
3736 return mExtras == null ? null : mExtras.getString(name);
3737 }
3738
3739 /**
3740 * Retrieve extended data from the intent.
3741 *
3742 * @param name The name of the desired item.
3743 *
3744 * @return the value of an item that previously added with putExtra()
3745 * or null if no CharSequence value was found.
3746 *
3747 * @see #putExtra(String, CharSequence)
3748 */
3749 public CharSequence getCharSequenceExtra(String name) {
3750 return mExtras == null ? null : mExtras.getCharSequence(name);
3751 }
3752
3753 /**
3754 * Retrieve extended data from the intent.
3755 *
3756 * @param name The name of the desired item.
3757 *
3758 * @return the value of an item that previously added with putExtra()
3759 * or null if no Parcelable value was found.
3760 *
3761 * @see #putExtra(String, Parcelable)
3762 */
3763 public <T extends Parcelable> T getParcelableExtra(String name) {
3764 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3765 }
3766
3767 /**
3768 * Retrieve extended data from the intent.
3769 *
3770 * @param name The name of the desired item.
3771 *
3772 * @return the value of an item that previously added with putExtra()
3773 * or null if no Parcelable[] value was found.
3774 *
3775 * @see #putExtra(String, Parcelable[])
3776 */
3777 public Parcelable[] getParcelableArrayExtra(String name) {
3778 return mExtras == null ? null : mExtras.getParcelableArray(name);
3779 }
3780
3781 /**
3782 * Retrieve extended data from the intent.
3783 *
3784 * @param name The name of the desired item.
3785 *
3786 * @return the value of an item that previously added with putExtra()
3787 * or null if no ArrayList<Parcelable> value was found.
3788 *
3789 * @see #putParcelableArrayListExtra(String, ArrayList)
3790 */
3791 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3792 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3793 }
3794
3795 /**
3796 * Retrieve extended data from the intent.
3797 *
3798 * @param name The name of the desired item.
3799 *
3800 * @return the value of an item that previously added with putExtra()
3801 * or null if no Serializable value was found.
3802 *
3803 * @see #putExtra(String, Serializable)
3804 */
3805 public Serializable getSerializableExtra(String name) {
3806 return mExtras == null ? null : mExtras.getSerializable(name);
3807 }
3808
3809 /**
3810 * Retrieve extended data from the intent.
3811 *
3812 * @param name The name of the desired item.
3813 *
3814 * @return the value of an item that previously added with putExtra()
3815 * or null if no ArrayList<Integer> value was found.
3816 *
3817 * @see #putIntegerArrayListExtra(String, ArrayList)
3818 */
3819 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3820 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3821 }
3822
3823 /**
3824 * Retrieve extended data from the intent.
3825 *
3826 * @param name The name of the desired item.
3827 *
3828 * @return the value of an item that previously added with putExtra()
3829 * or null if no ArrayList<String> value was found.
3830 *
3831 * @see #putStringArrayListExtra(String, ArrayList)
3832 */
3833 public ArrayList<String> getStringArrayListExtra(String name) {
3834 return mExtras == null ? null : mExtras.getStringArrayList(name);
3835 }
3836
3837 /**
3838 * Retrieve extended data from the intent.
3839 *
3840 * @param name The name of the desired item.
3841 *
3842 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003843 * or null if no ArrayList<CharSequence> value was found.
3844 *
3845 * @see #putCharSequenceArrayListExtra(String, ArrayList)
3846 */
3847 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
3848 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
3849 }
3850
3851 /**
3852 * Retrieve extended data from the intent.
3853 *
3854 * @param name The name of the desired item.
3855 *
3856 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003857 * or null if no boolean array value was found.
3858 *
3859 * @see #putExtra(String, boolean[])
3860 */
3861 public boolean[] getBooleanArrayExtra(String name) {
3862 return mExtras == null ? null : mExtras.getBooleanArray(name);
3863 }
3864
3865 /**
3866 * Retrieve extended data from the intent.
3867 *
3868 * @param name The name of the desired item.
3869 *
3870 * @return the value of an item that previously added with putExtra()
3871 * or null if no byte array value was found.
3872 *
3873 * @see #putExtra(String, byte[])
3874 */
3875 public byte[] getByteArrayExtra(String name) {
3876 return mExtras == null ? null : mExtras.getByteArray(name);
3877 }
3878
3879 /**
3880 * Retrieve extended data from the intent.
3881 *
3882 * @param name The name of the desired item.
3883 *
3884 * @return the value of an item that previously added with putExtra()
3885 * or null if no short array value was found.
3886 *
3887 * @see #putExtra(String, short[])
3888 */
3889 public short[] getShortArrayExtra(String name) {
3890 return mExtras == null ? null : mExtras.getShortArray(name);
3891 }
3892
3893 /**
3894 * Retrieve extended data from the intent.
3895 *
3896 * @param name The name of the desired item.
3897 *
3898 * @return the value of an item that previously added with putExtra()
3899 * or null if no char array value was found.
3900 *
3901 * @see #putExtra(String, char[])
3902 */
3903 public char[] getCharArrayExtra(String name) {
3904 return mExtras == null ? null : mExtras.getCharArray(name);
3905 }
3906
3907 /**
3908 * Retrieve extended data from the intent.
3909 *
3910 * @param name The name of the desired item.
3911 *
3912 * @return the value of an item that previously added with putExtra()
3913 * or null if no int array value was found.
3914 *
3915 * @see #putExtra(String, int[])
3916 */
3917 public int[] getIntArrayExtra(String name) {
3918 return mExtras == null ? null : mExtras.getIntArray(name);
3919 }
3920
3921 /**
3922 * Retrieve extended data from the intent.
3923 *
3924 * @param name The name of the desired item.
3925 *
3926 * @return the value of an item that previously added with putExtra()
3927 * or null if no long array value was found.
3928 *
3929 * @see #putExtra(String, long[])
3930 */
3931 public long[] getLongArrayExtra(String name) {
3932 return mExtras == null ? null : mExtras.getLongArray(name);
3933 }
3934
3935 /**
3936 * Retrieve extended data from the intent.
3937 *
3938 * @param name The name of the desired item.
3939 *
3940 * @return the value of an item that previously added with putExtra()
3941 * or null if no float array value was found.
3942 *
3943 * @see #putExtra(String, float[])
3944 */
3945 public float[] getFloatArrayExtra(String name) {
3946 return mExtras == null ? null : mExtras.getFloatArray(name);
3947 }
3948
3949 /**
3950 * Retrieve extended data from the intent.
3951 *
3952 * @param name The name of the desired item.
3953 *
3954 * @return the value of an item that previously added with putExtra()
3955 * or null if no double array value was found.
3956 *
3957 * @see #putExtra(String, double[])
3958 */
3959 public double[] getDoubleArrayExtra(String name) {
3960 return mExtras == null ? null : mExtras.getDoubleArray(name);
3961 }
3962
3963 /**
3964 * Retrieve extended data from the intent.
3965 *
3966 * @param name The name of the desired item.
3967 *
3968 * @return the value of an item that previously added with putExtra()
3969 * or null if no String array value was found.
3970 *
3971 * @see #putExtra(String, String[])
3972 */
3973 public String[] getStringArrayExtra(String name) {
3974 return mExtras == null ? null : mExtras.getStringArray(name);
3975 }
3976
3977 /**
3978 * Retrieve extended data from the intent.
3979 *
3980 * @param name The name of the desired item.
3981 *
3982 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003983 * or null if no CharSequence array value was found.
3984 *
3985 * @see #putExtra(String, CharSequence[])
3986 */
3987 public CharSequence[] getCharSequenceArrayExtra(String name) {
3988 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
3989 }
3990
3991 /**
3992 * Retrieve extended data from the intent.
3993 *
3994 * @param name The name of the desired item.
3995 *
3996 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003997 * or null if no Bundle value was found.
3998 *
3999 * @see #putExtra(String, Bundle)
4000 */
4001 public Bundle getBundleExtra(String name) {
4002 return mExtras == null ? null : mExtras.getBundle(name);
4003 }
4004
4005 /**
4006 * Retrieve extended data from the intent.
4007 *
4008 * @param name The name of the desired item.
4009 *
4010 * @return the value of an item that previously added with putExtra()
4011 * or null if no IBinder value was found.
4012 *
4013 * @see #putExtra(String, IBinder)
4014 *
4015 * @deprecated
4016 * @hide
4017 */
4018 @Deprecated
4019 public IBinder getIBinderExtra(String name) {
4020 return mExtras == null ? null : mExtras.getIBinder(name);
4021 }
4022
4023 /**
4024 * Retrieve extended data from the intent.
4025 *
4026 * @param name The name of the desired item.
4027 * @param defaultValue The default value to return in case no item is
4028 * associated with the key 'name'
4029 *
4030 * @return the value of an item that previously added with putExtra()
4031 * or defaultValue if none was found.
4032 *
4033 * @see #putExtra
4034 *
4035 * @deprecated
4036 * @hide
4037 */
4038 @Deprecated
4039 public Object getExtra(String name, Object defaultValue) {
4040 Object result = defaultValue;
4041 if (mExtras != null) {
4042 Object result2 = mExtras.get(name);
4043 if (result2 != null) {
4044 result = result2;
4045 }
4046 }
4047
4048 return result;
4049 }
4050
4051 /**
4052 * Retrieves a map of extended data from the intent.
4053 *
4054 * @return the map of all extras previously added with putExtra(),
4055 * or null if none have been added.
4056 */
4057 public Bundle getExtras() {
4058 return (mExtras != null)
4059 ? new Bundle(mExtras)
4060 : null;
4061 }
4062
4063 /**
4064 * Retrieve any special flags associated with this intent. You will
4065 * normally just set them with {@link #setFlags} and let the system
4066 * take the appropriate action with them.
4067 *
4068 * @return int The currently set flags.
4069 *
4070 * @see #setFlags
4071 */
4072 public int getFlags() {
4073 return mFlags;
4074 }
4075
Dianne Hackborne7f97212011-02-24 14:40:20 -08004076 /** @hide */
4077 public boolean isExcludingStopped() {
4078 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4079 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4080 }
4081
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004082 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004083 * Retrieve the application package name this Intent is limited to. When
4084 * resolving an Intent, if non-null this limits the resolution to only
4085 * components in the given application package.
4086 *
4087 * @return The name of the application package for the Intent.
4088 *
4089 * @see #resolveActivity
4090 * @see #setPackage
4091 */
4092 public String getPackage() {
4093 return mPackage;
4094 }
4095
4096 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004097 * Retrieve the concrete component associated with the intent. When receiving
4098 * an intent, this is the component that was found to best handle it (that is,
4099 * yourself) and will always be non-null; in all other cases it will be
4100 * null unless explicitly set.
4101 *
4102 * @return The name of the application component to handle the intent.
4103 *
4104 * @see #resolveActivity
4105 * @see #setComponent
4106 */
4107 public ComponentName getComponent() {
4108 return mComponent;
4109 }
4110
4111 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004112 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4113 * used as a hint to the receiver for animations and the like. Null means that there
4114 * is no source bounds.
4115 */
4116 public Rect getSourceBounds() {
4117 return mSourceBounds;
4118 }
4119
4120 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004121 * Return the Activity component that should be used to handle this intent.
4122 * The appropriate component is determined based on the information in the
4123 * intent, evaluated as follows:
4124 *
4125 * <p>If {@link #getComponent} returns an explicit class, that is returned
4126 * without any further consideration.
4127 *
4128 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4129 * category to be considered.
4130 *
4131 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4132 * action.
4133 *
4134 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4135 * this type.
4136 *
4137 * <p>If {@link #addCategory} has added any categories, the activity must
4138 * handle ALL of the categories specified.
4139 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004140 * <p>If {@link #getPackage} is non-NULL, only activity components in
4141 * that application package will be considered.
4142 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004143 * <p>If there are no activities that satisfy all of these conditions, a
4144 * null string is returned.
4145 *
4146 * <p>If multiple activities are found to satisfy the intent, the one with
4147 * the highest priority will be used. If there are multiple activities
4148 * with the same priority, the system will either pick the best activity
4149 * based on user preference, or resolve to a system class that will allow
4150 * the user to pick an activity and forward from there.
4151 *
4152 * <p>This method is implemented simply by calling
4153 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4154 * true.</p>
4155 * <p> This API is called for you as part of starting an activity from an
4156 * intent. You do not normally need to call it yourself.</p>
4157 *
4158 * @param pm The package manager with which to resolve the Intent.
4159 *
4160 * @return Name of the component implementing an activity that can
4161 * display the intent.
4162 *
4163 * @see #setComponent
4164 * @see #getComponent
4165 * @see #resolveActivityInfo
4166 */
4167 public ComponentName resolveActivity(PackageManager pm) {
4168 if (mComponent != null) {
4169 return mComponent;
4170 }
4171
4172 ResolveInfo info = pm.resolveActivity(
4173 this, PackageManager.MATCH_DEFAULT_ONLY);
4174 if (info != null) {
4175 return new ComponentName(
4176 info.activityInfo.applicationInfo.packageName,
4177 info.activityInfo.name);
4178 }
4179
4180 return null;
4181 }
4182
4183 /**
4184 * Resolve the Intent into an {@link ActivityInfo}
4185 * describing the activity that should execute the intent. Resolution
4186 * follows the same rules as described for {@link #resolveActivity}, but
4187 * you get back the completely information about the resolved activity
4188 * instead of just its class name.
4189 *
4190 * @param pm The package manager with which to resolve the Intent.
4191 * @param flags Addition information to retrieve as per
4192 * {@link PackageManager#getActivityInfo(ComponentName, int)
4193 * PackageManager.getActivityInfo()}.
4194 *
4195 * @return PackageManager.ActivityInfo
4196 *
4197 * @see #resolveActivity
4198 */
4199 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4200 ActivityInfo ai = null;
4201 if (mComponent != null) {
4202 try {
4203 ai = pm.getActivityInfo(mComponent, flags);
4204 } catch (PackageManager.NameNotFoundException e) {
4205 // ignore
4206 }
4207 } else {
4208 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004209 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004210 if (info != null) {
4211 ai = info.activityInfo;
4212 }
4213 }
4214
4215 return ai;
4216 }
4217
4218 /**
4219 * Set the general action to be performed.
4220 *
4221 * @param action An action name, such as ACTION_VIEW. Application-specific
4222 * actions should be prefixed with the vendor's package name.
4223 *
4224 * @return Returns the same Intent object, for chaining multiple calls
4225 * into a single statement.
4226 *
4227 * @see #getAction
4228 */
4229 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004230 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004231 return this;
4232 }
4233
4234 /**
4235 * Set the data this intent is operating on. This method automatically
4236 * clears any type that was previously set by {@link #setType}.
4237 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004238 * <p><em>Note: scheme and host name matching in the Android framework is
4239 * case-sensitive, unlike the formal RFC. As a result,
4240 * you should always ensure that you write your Uri with these elements
4241 * using lower case letters, and normalize any Uris you receive from
4242 * outside of Android to ensure the scheme and host is lower case.</em></p>
4243 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004244 * @param data The URI of the data this intent is now targeting.
4245 *
4246 * @return Returns the same Intent object, for chaining multiple calls
4247 * into a single statement.
4248 *
4249 * @see #getData
4250 * @see #setType
4251 * @see #setDataAndType
4252 */
4253 public Intent setData(Uri data) {
4254 mData = data;
4255 mType = null;
4256 return this;
4257 }
4258
4259 /**
4260 * Set an explicit MIME data type. This is used to create intents that
4261 * only specify a type and not data, for example to indicate the type of
4262 * data to return. This method automatically clears any data that was
4263 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07004264 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004265 * <p><em>Note: MIME type matching in the Android framework is
4266 * case-sensitive, unlike formal RFC MIME types. As a result,
4267 * you should always write your MIME types with lower case letters,
4268 * and any MIME types you receive from outside of Android should be
4269 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004270 *
4271 * @param type The MIME type of the data being handled by this intent.
4272 *
4273 * @return Returns the same Intent object, for chaining multiple calls
4274 * into a single statement.
4275 *
4276 * @see #getType
4277 * @see #setData
4278 * @see #setDataAndType
4279 */
4280 public Intent setType(String type) {
4281 mData = null;
4282 mType = type;
4283 return this;
4284 }
4285
4286 /**
4287 * (Usually optional) Set the data for the intent along with an explicit
4288 * MIME data type. This method should very rarely be used -- it allows you
4289 * to override the MIME type that would ordinarily be inferred from the
4290 * data with your own type given here.
4291 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004292 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
4293 * Android framework is case-sensitive, unlike the formal RFC definitions.
4294 * As a result, you should always write these elements with lower case letters,
4295 * and normalize any MIME types or Uris you receive from
4296 * outside of Android to ensure these elements are lower case before
4297 * supplying them here.</em></p>
4298 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004299 * @param data The URI of the data this intent is now targeting.
4300 * @param type The MIME type of the data being handled by this intent.
4301 *
4302 * @return Returns the same Intent object, for chaining multiple calls
4303 * into a single statement.
4304 *
4305 * @see #setData
4306 * @see #setType
4307 */
4308 public Intent setDataAndType(Uri data, String type) {
4309 mData = data;
4310 mType = type;
4311 return this;
4312 }
4313
4314 /**
4315 * Add a new category to the intent. Categories provide additional detail
4316 * about the action the intent is perform. When resolving an intent, only
4317 * activities that provide <em>all</em> of the requested categories will be
4318 * used.
4319 *
4320 * @param category The desired category. This can be either one of the
4321 * predefined Intent categories, or a custom category in your own
4322 * namespace.
4323 *
4324 * @return Returns the same Intent object, for chaining multiple calls
4325 * into a single statement.
4326 *
4327 * @see #hasCategory
4328 * @see #removeCategory
4329 */
4330 public Intent addCategory(String category) {
4331 if (mCategories == null) {
4332 mCategories = new HashSet<String>();
4333 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004334 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004335 return this;
4336 }
4337
4338 /**
4339 * Remove an category from an intent.
4340 *
4341 * @param category The category to remove.
4342 *
4343 * @see #addCategory
4344 */
4345 public void removeCategory(String category) {
4346 if (mCategories != null) {
4347 mCategories.remove(category);
4348 if (mCategories.size() == 0) {
4349 mCategories = null;
4350 }
4351 }
4352 }
4353
4354 /**
4355 * Add extended data to the intent. The name must include a package
4356 * prefix, for example the app com.android.contacts would use names
4357 * like "com.android.contacts.ShowAll".
4358 *
4359 * @param name The name of the extra data, with package prefix.
4360 * @param value The boolean data value.
4361 *
4362 * @return Returns the same Intent object, for chaining multiple calls
4363 * into a single statement.
4364 *
4365 * @see #putExtras
4366 * @see #removeExtra
4367 * @see #getBooleanExtra(String, boolean)
4368 */
4369 public Intent putExtra(String name, boolean value) {
4370 if (mExtras == null) {
4371 mExtras = new Bundle();
4372 }
4373 mExtras.putBoolean(name, value);
4374 return this;
4375 }
4376
4377 /**
4378 * Add extended data to the intent. The name must include a package
4379 * prefix, for example the app com.android.contacts would use names
4380 * like "com.android.contacts.ShowAll".
4381 *
4382 * @param name The name of the extra data, with package prefix.
4383 * @param value The byte data value.
4384 *
4385 * @return Returns the same Intent object, for chaining multiple calls
4386 * into a single statement.
4387 *
4388 * @see #putExtras
4389 * @see #removeExtra
4390 * @see #getByteExtra(String, byte)
4391 */
4392 public Intent putExtra(String name, byte value) {
4393 if (mExtras == null) {
4394 mExtras = new Bundle();
4395 }
4396 mExtras.putByte(name, value);
4397 return this;
4398 }
4399
4400 /**
4401 * Add extended data to the intent. The name must include a package
4402 * prefix, for example the app com.android.contacts would use names
4403 * like "com.android.contacts.ShowAll".
4404 *
4405 * @param name The name of the extra data, with package prefix.
4406 * @param value The char data value.
4407 *
4408 * @return Returns the same Intent object, for chaining multiple calls
4409 * into a single statement.
4410 *
4411 * @see #putExtras
4412 * @see #removeExtra
4413 * @see #getCharExtra(String, char)
4414 */
4415 public Intent putExtra(String name, char value) {
4416 if (mExtras == null) {
4417 mExtras = new Bundle();
4418 }
4419 mExtras.putChar(name, value);
4420 return this;
4421 }
4422
4423 /**
4424 * Add extended data to the intent. The name must include a package
4425 * prefix, for example the app com.android.contacts would use names
4426 * like "com.android.contacts.ShowAll".
4427 *
4428 * @param name The name of the extra data, with package prefix.
4429 * @param value The short data value.
4430 *
4431 * @return Returns the same Intent object, for chaining multiple calls
4432 * into a single statement.
4433 *
4434 * @see #putExtras
4435 * @see #removeExtra
4436 * @see #getShortExtra(String, short)
4437 */
4438 public Intent putExtra(String name, short value) {
4439 if (mExtras == null) {
4440 mExtras = new Bundle();
4441 }
4442 mExtras.putShort(name, value);
4443 return this;
4444 }
4445
4446 /**
4447 * Add extended data to the intent. The name must include a package
4448 * prefix, for example the app com.android.contacts would use names
4449 * like "com.android.contacts.ShowAll".
4450 *
4451 * @param name The name of the extra data, with package prefix.
4452 * @param value The integer data value.
4453 *
4454 * @return Returns the same Intent object, for chaining multiple calls
4455 * into a single statement.
4456 *
4457 * @see #putExtras
4458 * @see #removeExtra
4459 * @see #getIntExtra(String, int)
4460 */
4461 public Intent putExtra(String name, int value) {
4462 if (mExtras == null) {
4463 mExtras = new Bundle();
4464 }
4465 mExtras.putInt(name, value);
4466 return this;
4467 }
4468
4469 /**
4470 * Add extended data to the intent. The name must include a package
4471 * prefix, for example the app com.android.contacts would use names
4472 * like "com.android.contacts.ShowAll".
4473 *
4474 * @param name The name of the extra data, with package prefix.
4475 * @param value The long data value.
4476 *
4477 * @return Returns the same Intent object, for chaining multiple calls
4478 * into a single statement.
4479 *
4480 * @see #putExtras
4481 * @see #removeExtra
4482 * @see #getLongExtra(String, long)
4483 */
4484 public Intent putExtra(String name, long value) {
4485 if (mExtras == null) {
4486 mExtras = new Bundle();
4487 }
4488 mExtras.putLong(name, value);
4489 return this;
4490 }
4491
4492 /**
4493 * Add extended data to the intent. The name must include a package
4494 * prefix, for example the app com.android.contacts would use names
4495 * like "com.android.contacts.ShowAll".
4496 *
4497 * @param name The name of the extra data, with package prefix.
4498 * @param value The float data value.
4499 *
4500 * @return Returns the same Intent object, for chaining multiple calls
4501 * into a single statement.
4502 *
4503 * @see #putExtras
4504 * @see #removeExtra
4505 * @see #getFloatExtra(String, float)
4506 */
4507 public Intent putExtra(String name, float value) {
4508 if (mExtras == null) {
4509 mExtras = new Bundle();
4510 }
4511 mExtras.putFloat(name, value);
4512 return this;
4513 }
4514
4515 /**
4516 * Add extended data to the intent. The name must include a package
4517 * prefix, for example the app com.android.contacts would use names
4518 * like "com.android.contacts.ShowAll".
4519 *
4520 * @param name The name of the extra data, with package prefix.
4521 * @param value The double data value.
4522 *
4523 * @return Returns the same Intent object, for chaining multiple calls
4524 * into a single statement.
4525 *
4526 * @see #putExtras
4527 * @see #removeExtra
4528 * @see #getDoubleExtra(String, double)
4529 */
4530 public Intent putExtra(String name, double value) {
4531 if (mExtras == null) {
4532 mExtras = new Bundle();
4533 }
4534 mExtras.putDouble(name, value);
4535 return this;
4536 }
4537
4538 /**
4539 * Add extended data to the intent. The name must include a package
4540 * prefix, for example the app com.android.contacts would use names
4541 * like "com.android.contacts.ShowAll".
4542 *
4543 * @param name The name of the extra data, with package prefix.
4544 * @param value The String data value.
4545 *
4546 * @return Returns the same Intent object, for chaining multiple calls
4547 * into a single statement.
4548 *
4549 * @see #putExtras
4550 * @see #removeExtra
4551 * @see #getStringExtra(String)
4552 */
4553 public Intent putExtra(String name, String value) {
4554 if (mExtras == null) {
4555 mExtras = new Bundle();
4556 }
4557 mExtras.putString(name, value);
4558 return this;
4559 }
4560
4561 /**
4562 * Add extended data to the intent. The name must include a package
4563 * prefix, for example the app com.android.contacts would use names
4564 * like "com.android.contacts.ShowAll".
4565 *
4566 * @param name The name of the extra data, with package prefix.
4567 * @param value The CharSequence data value.
4568 *
4569 * @return Returns the same Intent object, for chaining multiple calls
4570 * into a single statement.
4571 *
4572 * @see #putExtras
4573 * @see #removeExtra
4574 * @see #getCharSequenceExtra(String)
4575 */
4576 public Intent putExtra(String name, CharSequence value) {
4577 if (mExtras == null) {
4578 mExtras = new Bundle();
4579 }
4580 mExtras.putCharSequence(name, value);
4581 return this;
4582 }
4583
4584 /**
4585 * Add extended data to the intent. The name must include a package
4586 * prefix, for example the app com.android.contacts would use names
4587 * like "com.android.contacts.ShowAll".
4588 *
4589 * @param name The name of the extra data, with package prefix.
4590 * @param value The Parcelable data value.
4591 *
4592 * @return Returns the same Intent object, for chaining multiple calls
4593 * into a single statement.
4594 *
4595 * @see #putExtras
4596 * @see #removeExtra
4597 * @see #getParcelableExtra(String)
4598 */
4599 public Intent putExtra(String name, Parcelable value) {
4600 if (mExtras == null) {
4601 mExtras = new Bundle();
4602 }
4603 mExtras.putParcelable(name, value);
4604 return this;
4605 }
4606
4607 /**
4608 * Add extended data to the intent. The name must include a package
4609 * prefix, for example the app com.android.contacts would use names
4610 * like "com.android.contacts.ShowAll".
4611 *
4612 * @param name The name of the extra data, with package prefix.
4613 * @param value The Parcelable[] data value.
4614 *
4615 * @return Returns the same Intent object, for chaining multiple calls
4616 * into a single statement.
4617 *
4618 * @see #putExtras
4619 * @see #removeExtra
4620 * @see #getParcelableArrayExtra(String)
4621 */
4622 public Intent putExtra(String name, Parcelable[] value) {
4623 if (mExtras == null) {
4624 mExtras = new Bundle();
4625 }
4626 mExtras.putParcelableArray(name, value);
4627 return this;
4628 }
4629
4630 /**
4631 * Add extended data to the intent. The name must include a package
4632 * prefix, for example the app com.android.contacts would use names
4633 * like "com.android.contacts.ShowAll".
4634 *
4635 * @param name The name of the extra data, with package prefix.
4636 * @param value The ArrayList<Parcelable> data value.
4637 *
4638 * @return Returns the same Intent object, for chaining multiple calls
4639 * into a single statement.
4640 *
4641 * @see #putExtras
4642 * @see #removeExtra
4643 * @see #getParcelableArrayListExtra(String)
4644 */
4645 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4646 if (mExtras == null) {
4647 mExtras = new Bundle();
4648 }
4649 mExtras.putParcelableArrayList(name, value);
4650 return this;
4651 }
4652
4653 /**
4654 * Add extended data to the intent. The name must include a package
4655 * prefix, for example the app com.android.contacts would use names
4656 * like "com.android.contacts.ShowAll".
4657 *
4658 * @param name The name of the extra data, with package prefix.
4659 * @param value The ArrayList<Integer> data value.
4660 *
4661 * @return Returns the same Intent object, for chaining multiple calls
4662 * into a single statement.
4663 *
4664 * @see #putExtras
4665 * @see #removeExtra
4666 * @see #getIntegerArrayListExtra(String)
4667 */
4668 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4669 if (mExtras == null) {
4670 mExtras = new Bundle();
4671 }
4672 mExtras.putIntegerArrayList(name, value);
4673 return this;
4674 }
4675
4676 /**
4677 * Add extended data to the intent. The name must include a package
4678 * prefix, for example the app com.android.contacts would use names
4679 * like "com.android.contacts.ShowAll".
4680 *
4681 * @param name The name of the extra data, with package prefix.
4682 * @param value The ArrayList<String> data value.
4683 *
4684 * @return Returns the same Intent object, for chaining multiple calls
4685 * into a single statement.
4686 *
4687 * @see #putExtras
4688 * @see #removeExtra
4689 * @see #getStringArrayListExtra(String)
4690 */
4691 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4692 if (mExtras == null) {
4693 mExtras = new Bundle();
4694 }
4695 mExtras.putStringArrayList(name, value);
4696 return this;
4697 }
4698
4699 /**
4700 * Add extended data to the intent. The name must include a package
4701 * prefix, for example the app com.android.contacts would use names
4702 * like "com.android.contacts.ShowAll".
4703 *
4704 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004705 * @param value The ArrayList<CharSequence> data value.
4706 *
4707 * @return Returns the same Intent object, for chaining multiple calls
4708 * into a single statement.
4709 *
4710 * @see #putExtras
4711 * @see #removeExtra
4712 * @see #getCharSequenceArrayListExtra(String)
4713 */
4714 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
4715 if (mExtras == null) {
4716 mExtras = new Bundle();
4717 }
4718 mExtras.putCharSequenceArrayList(name, value);
4719 return this;
4720 }
4721
4722 /**
4723 * Add extended data to the intent. The name must include a package
4724 * prefix, for example the app com.android.contacts would use names
4725 * like "com.android.contacts.ShowAll".
4726 *
4727 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004728 * @param value The Serializable data value.
4729 *
4730 * @return Returns the same Intent object, for chaining multiple calls
4731 * into a single statement.
4732 *
4733 * @see #putExtras
4734 * @see #removeExtra
4735 * @see #getSerializableExtra(String)
4736 */
4737 public Intent putExtra(String name, Serializable value) {
4738 if (mExtras == null) {
4739 mExtras = new Bundle();
4740 }
4741 mExtras.putSerializable(name, value);
4742 return this;
4743 }
4744
4745 /**
4746 * Add extended data to the intent. The name must include a package
4747 * prefix, for example the app com.android.contacts would use names
4748 * like "com.android.contacts.ShowAll".
4749 *
4750 * @param name The name of the extra data, with package prefix.
4751 * @param value The boolean array data value.
4752 *
4753 * @return Returns the same Intent object, for chaining multiple calls
4754 * into a single statement.
4755 *
4756 * @see #putExtras
4757 * @see #removeExtra
4758 * @see #getBooleanArrayExtra(String)
4759 */
4760 public Intent putExtra(String name, boolean[] value) {
4761 if (mExtras == null) {
4762 mExtras = new Bundle();
4763 }
4764 mExtras.putBooleanArray(name, value);
4765 return this;
4766 }
4767
4768 /**
4769 * Add extended data to the intent. The name must include a package
4770 * prefix, for example the app com.android.contacts would use names
4771 * like "com.android.contacts.ShowAll".
4772 *
4773 * @param name The name of the extra data, with package prefix.
4774 * @param value The byte array data value.
4775 *
4776 * @return Returns the same Intent object, for chaining multiple calls
4777 * into a single statement.
4778 *
4779 * @see #putExtras
4780 * @see #removeExtra
4781 * @see #getByteArrayExtra(String)
4782 */
4783 public Intent putExtra(String name, byte[] value) {
4784 if (mExtras == null) {
4785 mExtras = new Bundle();
4786 }
4787 mExtras.putByteArray(name, value);
4788 return this;
4789 }
4790
4791 /**
4792 * Add extended data to the intent. The name must include a package
4793 * prefix, for example the app com.android.contacts would use names
4794 * like "com.android.contacts.ShowAll".
4795 *
4796 * @param name The name of the extra data, with package prefix.
4797 * @param value The short array data value.
4798 *
4799 * @return Returns the same Intent object, for chaining multiple calls
4800 * into a single statement.
4801 *
4802 * @see #putExtras
4803 * @see #removeExtra
4804 * @see #getShortArrayExtra(String)
4805 */
4806 public Intent putExtra(String name, short[] value) {
4807 if (mExtras == null) {
4808 mExtras = new Bundle();
4809 }
4810 mExtras.putShortArray(name, value);
4811 return this;
4812 }
4813
4814 /**
4815 * Add extended data to the intent. The name must include a package
4816 * prefix, for example the app com.android.contacts would use names
4817 * like "com.android.contacts.ShowAll".
4818 *
4819 * @param name The name of the extra data, with package prefix.
4820 * @param value The char array data value.
4821 *
4822 * @return Returns the same Intent object, for chaining multiple calls
4823 * into a single statement.
4824 *
4825 * @see #putExtras
4826 * @see #removeExtra
4827 * @see #getCharArrayExtra(String)
4828 */
4829 public Intent putExtra(String name, char[] value) {
4830 if (mExtras == null) {
4831 mExtras = new Bundle();
4832 }
4833 mExtras.putCharArray(name, value);
4834 return this;
4835 }
4836
4837 /**
4838 * Add extended data to the intent. The name must include a package
4839 * prefix, for example the app com.android.contacts would use names
4840 * like "com.android.contacts.ShowAll".
4841 *
4842 * @param name The name of the extra data, with package prefix.
4843 * @param value The int array data value.
4844 *
4845 * @return Returns the same Intent object, for chaining multiple calls
4846 * into a single statement.
4847 *
4848 * @see #putExtras
4849 * @see #removeExtra
4850 * @see #getIntArrayExtra(String)
4851 */
4852 public Intent putExtra(String name, int[] value) {
4853 if (mExtras == null) {
4854 mExtras = new Bundle();
4855 }
4856 mExtras.putIntArray(name, value);
4857 return this;
4858 }
4859
4860 /**
4861 * Add extended data to the intent. The name must include a package
4862 * prefix, for example the app com.android.contacts would use names
4863 * like "com.android.contacts.ShowAll".
4864 *
4865 * @param name The name of the extra data, with package prefix.
4866 * @param value The byte array data value.
4867 *
4868 * @return Returns the same Intent object, for chaining multiple calls
4869 * into a single statement.
4870 *
4871 * @see #putExtras
4872 * @see #removeExtra
4873 * @see #getLongArrayExtra(String)
4874 */
4875 public Intent putExtra(String name, long[] value) {
4876 if (mExtras == null) {
4877 mExtras = new Bundle();
4878 }
4879 mExtras.putLongArray(name, value);
4880 return this;
4881 }
4882
4883 /**
4884 * Add extended data to the intent. The name must include a package
4885 * prefix, for example the app com.android.contacts would use names
4886 * like "com.android.contacts.ShowAll".
4887 *
4888 * @param name The name of the extra data, with package prefix.
4889 * @param value The float array data value.
4890 *
4891 * @return Returns the same Intent object, for chaining multiple calls
4892 * into a single statement.
4893 *
4894 * @see #putExtras
4895 * @see #removeExtra
4896 * @see #getFloatArrayExtra(String)
4897 */
4898 public Intent putExtra(String name, float[] value) {
4899 if (mExtras == null) {
4900 mExtras = new Bundle();
4901 }
4902 mExtras.putFloatArray(name, value);
4903 return this;
4904 }
4905
4906 /**
4907 * Add extended data to the intent. The name must include a package
4908 * prefix, for example the app com.android.contacts would use names
4909 * like "com.android.contacts.ShowAll".
4910 *
4911 * @param name The name of the extra data, with package prefix.
4912 * @param value The double array data value.
4913 *
4914 * @return Returns the same Intent object, for chaining multiple calls
4915 * into a single statement.
4916 *
4917 * @see #putExtras
4918 * @see #removeExtra
4919 * @see #getDoubleArrayExtra(String)
4920 */
4921 public Intent putExtra(String name, double[] value) {
4922 if (mExtras == null) {
4923 mExtras = new Bundle();
4924 }
4925 mExtras.putDoubleArray(name, value);
4926 return this;
4927 }
4928
4929 /**
4930 * Add extended data to the intent. The name must include a package
4931 * prefix, for example the app com.android.contacts would use names
4932 * like "com.android.contacts.ShowAll".
4933 *
4934 * @param name The name of the extra data, with package prefix.
4935 * @param value The String array data value.
4936 *
4937 * @return Returns the same Intent object, for chaining multiple calls
4938 * into a single statement.
4939 *
4940 * @see #putExtras
4941 * @see #removeExtra
4942 * @see #getStringArrayExtra(String)
4943 */
4944 public Intent putExtra(String name, String[] value) {
4945 if (mExtras == null) {
4946 mExtras = new Bundle();
4947 }
4948 mExtras.putStringArray(name, value);
4949 return this;
4950 }
4951
4952 /**
4953 * Add extended data to the intent. The name must include a package
4954 * prefix, for example the app com.android.contacts would use names
4955 * like "com.android.contacts.ShowAll".
4956 *
4957 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004958 * @param value The CharSequence array data value.
4959 *
4960 * @return Returns the same Intent object, for chaining multiple calls
4961 * into a single statement.
4962 *
4963 * @see #putExtras
4964 * @see #removeExtra
4965 * @see #getCharSequenceArrayExtra(String)
4966 */
4967 public Intent putExtra(String name, CharSequence[] value) {
4968 if (mExtras == null) {
4969 mExtras = new Bundle();
4970 }
4971 mExtras.putCharSequenceArray(name, value);
4972 return this;
4973 }
4974
4975 /**
4976 * Add extended data to the intent. The name must include a package
4977 * prefix, for example the app com.android.contacts would use names
4978 * like "com.android.contacts.ShowAll".
4979 *
4980 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004981 * @param value The Bundle data value.
4982 *
4983 * @return Returns the same Intent object, for chaining multiple calls
4984 * into a single statement.
4985 *
4986 * @see #putExtras
4987 * @see #removeExtra
4988 * @see #getBundleExtra(String)
4989 */
4990 public Intent putExtra(String name, Bundle value) {
4991 if (mExtras == null) {
4992 mExtras = new Bundle();
4993 }
4994 mExtras.putBundle(name, value);
4995 return this;
4996 }
4997
4998 /**
4999 * Add extended data to the intent. The name must include a package
5000 * prefix, for example the app com.android.contacts would use names
5001 * like "com.android.contacts.ShowAll".
5002 *
5003 * @param name The name of the extra data, with package prefix.
5004 * @param value The IBinder data value.
5005 *
5006 * @return Returns the same Intent object, for chaining multiple calls
5007 * into a single statement.
5008 *
5009 * @see #putExtras
5010 * @see #removeExtra
5011 * @see #getIBinderExtra(String)
5012 *
5013 * @deprecated
5014 * @hide
5015 */
5016 @Deprecated
5017 public Intent putExtra(String name, IBinder value) {
5018 if (mExtras == null) {
5019 mExtras = new Bundle();
5020 }
5021 mExtras.putIBinder(name, value);
5022 return this;
5023 }
5024
5025 /**
5026 * Copy all extras in 'src' in to this intent.
5027 *
5028 * @param src Contains the extras to copy.
5029 *
5030 * @see #putExtra
5031 */
5032 public Intent putExtras(Intent src) {
5033 if (src.mExtras != null) {
5034 if (mExtras == null) {
5035 mExtras = new Bundle(src.mExtras);
5036 } else {
5037 mExtras.putAll(src.mExtras);
5038 }
5039 }
5040 return this;
5041 }
5042
5043 /**
5044 * Add a set of extended data to the intent. The keys must include a package
5045 * prefix, for example the app com.android.contacts would use names
5046 * like "com.android.contacts.ShowAll".
5047 *
5048 * @param extras The Bundle of extras to add to this intent.
5049 *
5050 * @see #putExtra
5051 * @see #removeExtra
5052 */
5053 public Intent putExtras(Bundle extras) {
5054 if (mExtras == null) {
5055 mExtras = new Bundle();
5056 }
5057 mExtras.putAll(extras);
5058 return this;
5059 }
5060
5061 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005062 * Completely replace the extras in the Intent with the extras in the
5063 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005064 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005065 * @param src The exact extras contained in this Intent are copied
5066 * into the target intent, replacing any that were previously there.
5067 */
5068 public Intent replaceExtras(Intent src) {
5069 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5070 return this;
5071 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005072
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005073 /**
5074 * Completely replace the extras in the Intent with the given Bundle of
5075 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005076 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005077 * @param extras The new set of extras in the Intent, or null to erase
5078 * all extras.
5079 */
5080 public Intent replaceExtras(Bundle extras) {
5081 mExtras = extras != null ? new Bundle(extras) : null;
5082 return this;
5083 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005084
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005085 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005086 * Remove extended data from the intent.
5087 *
5088 * @see #putExtra
5089 */
5090 public void removeExtra(String name) {
5091 if (mExtras != null) {
5092 mExtras.remove(name);
5093 if (mExtras.size() == 0) {
5094 mExtras = null;
5095 }
5096 }
5097 }
5098
5099 /**
5100 * Set special flags controlling how this intent is handled. Most values
5101 * here depend on the type of component being executed by the Intent,
5102 * specifically the FLAG_ACTIVITY_* flags are all for use with
5103 * {@link Context#startActivity Context.startActivity()} and the
5104 * FLAG_RECEIVER_* flags are all for use with
5105 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5106 *
Scott Main7aee61f2011-02-08 11:25:01 -08005107 * <p>See the
5108 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5109 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005110 * the behavior of your application.
5111 *
5112 * @param flags The desired flags.
5113 *
5114 * @return Returns the same Intent object, for chaining multiple calls
5115 * into a single statement.
5116 *
5117 * @see #getFlags
5118 * @see #addFlags
5119 *
5120 * @see #FLAG_GRANT_READ_URI_PERMISSION
5121 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5122 * @see #FLAG_DEBUG_LOG_RESOLUTION
5123 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005124 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005125 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005126 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005127 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005128 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5129 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005130 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005131 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5132 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005133 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005134 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005135 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005136 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5137 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005138 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005139 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005140 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005141 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5142 */
5143 public Intent setFlags(int flags) {
5144 mFlags = flags;
5145 return this;
5146 }
5147
5148 /**
5149 * Add additional flags to the intent (or with existing flags
5150 * value).
5151 *
5152 * @param flags The new flags to set.
5153 *
5154 * @return Returns the same Intent object, for chaining multiple calls
5155 * into a single statement.
5156 *
5157 * @see #setFlags
5158 */
5159 public Intent addFlags(int flags) {
5160 mFlags |= flags;
5161 return this;
5162 }
5163
5164 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005165 * (Usually optional) Set an explicit application package name that limits
5166 * the components this Intent will resolve to. If left to the default
5167 * value of null, all components in all applications will considered.
5168 * If non-null, the Intent can only match the components in the given
5169 * application package.
5170 *
5171 * @param packageName The name of the application package to handle the
5172 * intent, or null to allow any application package.
5173 *
5174 * @return Returns the same Intent object, for chaining multiple calls
5175 * into a single statement.
5176 *
5177 * @see #getPackage
5178 * @see #resolveActivity
5179 */
5180 public Intent setPackage(String packageName) {
5181 mPackage = packageName;
5182 return this;
5183 }
5184
5185 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005186 * (Usually optional) Explicitly set the component to handle the intent.
5187 * If left with the default value of null, the system will determine the
5188 * appropriate class to use based on the other fields (action, data,
5189 * type, categories) in the Intent. If this class is defined, the
5190 * specified class will always be used regardless of the other fields. You
5191 * should only set this value when you know you absolutely want a specific
5192 * class to be used; otherwise it is better to let the system find the
5193 * appropriate class so that you will respect the installed applications
5194 * and user preferences.
5195 *
5196 * @param component The name of the application component to handle the
5197 * intent, or null to let the system find one for you.
5198 *
5199 * @return Returns the same Intent object, for chaining multiple calls
5200 * into a single statement.
5201 *
5202 * @see #setClass
5203 * @see #setClassName(Context, String)
5204 * @see #setClassName(String, String)
5205 * @see #getComponent
5206 * @see #resolveActivity
5207 */
5208 public Intent setComponent(ComponentName component) {
5209 mComponent = component;
5210 return this;
5211 }
5212
5213 /**
5214 * Convenience for calling {@link #setComponent} with an
5215 * explicit class name.
5216 *
5217 * @param packageContext A Context of the application package implementing
5218 * this class.
5219 * @param className The name of a class inside of the application package
5220 * that will be used as the component for this Intent.
5221 *
5222 * @return Returns the same Intent object, for chaining multiple calls
5223 * into a single statement.
5224 *
5225 * @see #setComponent
5226 * @see #setClass
5227 */
5228 public Intent setClassName(Context packageContext, String className) {
5229 mComponent = new ComponentName(packageContext, className);
5230 return this;
5231 }
5232
5233 /**
5234 * Convenience for calling {@link #setComponent} with an
5235 * explicit application package name and class name.
5236 *
5237 * @param packageName The name of the package implementing the desired
5238 * component.
5239 * @param className The name of a class inside of the application package
5240 * that will be used as the component for this Intent.
5241 *
5242 * @return Returns the same Intent object, for chaining multiple calls
5243 * into a single statement.
5244 *
5245 * @see #setComponent
5246 * @see #setClass
5247 */
5248 public Intent setClassName(String packageName, String className) {
5249 mComponent = new ComponentName(packageName, className);
5250 return this;
5251 }
5252
5253 /**
5254 * Convenience for calling {@link #setComponent(ComponentName)} with the
5255 * name returned by a {@link Class} object.
5256 *
5257 * @param packageContext A Context of the application package implementing
5258 * this class.
5259 * @param cls The class name to set, equivalent to
5260 * <code>setClassName(context, cls.getName())</code>.
5261 *
5262 * @return Returns the same Intent object, for chaining multiple calls
5263 * into a single statement.
5264 *
5265 * @see #setComponent
5266 */
5267 public Intent setClass(Context packageContext, Class<?> cls) {
5268 mComponent = new ComponentName(packageContext, cls);
5269 return this;
5270 }
5271
5272 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005273 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5274 * used as a hint to the receiver for animations and the like. Null means that there
5275 * is no source bounds.
5276 */
5277 public void setSourceBounds(Rect r) {
5278 if (r != null) {
5279 mSourceBounds = new Rect(r);
5280 } else {
5281 r = null;
5282 }
5283 }
5284
5285 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005286 * Use with {@link #fillIn} to allow the current action value to be
5287 * overwritten, even if it is already set.
5288 */
5289 public static final int FILL_IN_ACTION = 1<<0;
5290
5291 /**
5292 * Use with {@link #fillIn} to allow the current data or type value
5293 * overwritten, even if it is already set.
5294 */
5295 public static final int FILL_IN_DATA = 1<<1;
5296
5297 /**
5298 * Use with {@link #fillIn} to allow the current categories to be
5299 * overwritten, even if they are already set.
5300 */
5301 public static final int FILL_IN_CATEGORIES = 1<<2;
5302
5303 /**
5304 * Use with {@link #fillIn} to allow the current component value to be
5305 * overwritten, even if it is already set.
5306 */
5307 public static final int FILL_IN_COMPONENT = 1<<3;
5308
5309 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005310 * Use with {@link #fillIn} to allow the current package value to be
5311 * overwritten, even if it is already set.
5312 */
5313 public static final int FILL_IN_PACKAGE = 1<<4;
5314
5315 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005316 * Use with {@link #fillIn} to allow the current package value to be
5317 * overwritten, even if it is already set.
5318 */
5319 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5320
5321 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005322 * Copy the contents of <var>other</var> in to this object, but only
5323 * where fields are not defined by this object. For purposes of a field
5324 * being defined, the following pieces of data in the Intent are
5325 * considered to be separate fields:
5326 *
5327 * <ul>
5328 * <li> action, as set by {@link #setAction}.
5329 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
5330 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5331 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005332 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005333 * <li> component, as set by {@link #setComponent(ComponentName)} or
5334 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005335 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005336 * <li> each top-level name in the associated extras.
5337 * </ul>
5338 *
5339 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005340 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5341 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005342 * corresponding field will not be replaced if it is already set.
5343 *
Brett Chabot3e391752009-07-21 16:07:23 -07005344 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
5345 * specified.
5346 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005347 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5348 * and Intent B with {action="gotit", data-type="some/thing",
5349 * categories="one","two"}.
5350 *
5351 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5352 * containing: {action="gotit", data-type="some/thing",
5353 * categories="bar"}.
5354 *
5355 * @param other Another Intent whose values are to be used to fill in
5356 * the current one.
5357 * @param flags Options to control which fields can be filled in.
5358 *
5359 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005360 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5361 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005362 */
5363 public int fillIn(Intent other, int flags) {
5364 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005365 if (other.mAction != null
5366 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005367 mAction = other.mAction;
5368 changes |= FILL_IN_ACTION;
5369 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005370 if ((other.mData != null || other.mType != null)
5371 && ((mData == null && mType == null)
5372 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005373 mData = other.mData;
5374 mType = other.mType;
5375 changes |= FILL_IN_DATA;
5376 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005377 if (other.mCategories != null
5378 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005379 if (other.mCategories != null) {
5380 mCategories = new HashSet<String>(other.mCategories);
5381 }
5382 changes |= FILL_IN_CATEGORIES;
5383 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005384 if (other.mPackage != null
5385 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
5386 mPackage = other.mPackage;
5387 changes |= FILL_IN_PACKAGE;
5388 }
5389 // Component is special: it can -only- be set if explicitly allowed,
5390 // since otherwise the sender could force the intent somewhere the
5391 // originator didn't intend.
5392 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005393 mComponent = other.mComponent;
5394 changes |= FILL_IN_COMPONENT;
5395 }
5396 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005397 if (other.mSourceBounds != null
5398 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5399 mSourceBounds = new Rect(other.mSourceBounds);
5400 changes |= FILL_IN_SOURCE_BOUNDS;
5401 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005402 if (mExtras == null) {
5403 if (other.mExtras != null) {
5404 mExtras = new Bundle(other.mExtras);
5405 }
5406 } else if (other.mExtras != null) {
5407 try {
5408 Bundle newb = new Bundle(other.mExtras);
5409 newb.putAll(mExtras);
5410 mExtras = newb;
5411 } catch (RuntimeException e) {
5412 // Modifying the extras can cause us to unparcel the contents
5413 // of the bundle, and if we do this in the system process that
5414 // may fail. We really should handle this (i.e., the Bundle
5415 // impl shouldn't be on top of a plain map), but for now just
5416 // ignore it and keep the original contents. :(
5417 Log.w("Intent", "Failure filling in extras", e);
5418 }
5419 }
5420 return changes;
5421 }
5422
5423 /**
5424 * Wrapper class holding an Intent and implementing comparisons on it for
5425 * the purpose of filtering. The class implements its
5426 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5427 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5428 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5429 * on the wrapped Intent.
5430 */
5431 public static final class FilterComparison {
5432 private final Intent mIntent;
5433 private final int mHashCode;
5434
5435 public FilterComparison(Intent intent) {
5436 mIntent = intent;
5437 mHashCode = intent.filterHashCode();
5438 }
5439
5440 /**
5441 * Return the Intent that this FilterComparison represents.
5442 * @return Returns the Intent held by the FilterComparison. Do
5443 * not modify!
5444 */
5445 public Intent getIntent() {
5446 return mIntent;
5447 }
5448
5449 @Override
5450 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005451 if (obj instanceof FilterComparison) {
5452 Intent other = ((FilterComparison)obj).mIntent;
5453 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005454 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005455 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005456 }
5457
5458 @Override
5459 public int hashCode() {
5460 return mHashCode;
5461 }
5462 }
5463
5464 /**
5465 * Determine if two intents are the same for the purposes of intent
5466 * resolution (filtering). That is, if their action, data, type,
5467 * class, and categories are the same. This does <em>not</em> compare
5468 * any extra data included in the intents.
5469 *
5470 * @param other The other Intent to compare against.
5471 *
5472 * @return Returns true if action, data, type, class, and categories
5473 * are the same.
5474 */
5475 public boolean filterEquals(Intent other) {
5476 if (other == null) {
5477 return false;
5478 }
5479 if (mAction != other.mAction) {
5480 if (mAction != null) {
5481 if (!mAction.equals(other.mAction)) {
5482 return false;
5483 }
5484 } else {
5485 if (!other.mAction.equals(mAction)) {
5486 return false;
5487 }
5488 }
5489 }
5490 if (mData != other.mData) {
5491 if (mData != null) {
5492 if (!mData.equals(other.mData)) {
5493 return false;
5494 }
5495 } else {
5496 if (!other.mData.equals(mData)) {
5497 return false;
5498 }
5499 }
5500 }
5501 if (mType != other.mType) {
5502 if (mType != null) {
5503 if (!mType.equals(other.mType)) {
5504 return false;
5505 }
5506 } else {
5507 if (!other.mType.equals(mType)) {
5508 return false;
5509 }
5510 }
5511 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005512 if (mPackage != other.mPackage) {
5513 if (mPackage != null) {
5514 if (!mPackage.equals(other.mPackage)) {
5515 return false;
5516 }
5517 } else {
5518 if (!other.mPackage.equals(mPackage)) {
5519 return false;
5520 }
5521 }
5522 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005523 if (mComponent != other.mComponent) {
5524 if (mComponent != null) {
5525 if (!mComponent.equals(other.mComponent)) {
5526 return false;
5527 }
5528 } else {
5529 if (!other.mComponent.equals(mComponent)) {
5530 return false;
5531 }
5532 }
5533 }
5534 if (mCategories != other.mCategories) {
5535 if (mCategories != null) {
5536 if (!mCategories.equals(other.mCategories)) {
5537 return false;
5538 }
5539 } else {
5540 if (!other.mCategories.equals(mCategories)) {
5541 return false;
5542 }
5543 }
5544 }
5545
5546 return true;
5547 }
5548
5549 /**
5550 * Generate hash code that matches semantics of filterEquals().
5551 *
5552 * @return Returns the hash value of the action, data, type, class, and
5553 * categories.
5554 *
5555 * @see #filterEquals
5556 */
5557 public int filterHashCode() {
5558 int code = 0;
5559 if (mAction != null) {
5560 code += mAction.hashCode();
5561 }
5562 if (mData != null) {
5563 code += mData.hashCode();
5564 }
5565 if (mType != null) {
5566 code += mType.hashCode();
5567 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005568 if (mPackage != null) {
5569 code += mPackage.hashCode();
5570 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005571 if (mComponent != null) {
5572 code += mComponent.hashCode();
5573 }
5574 if (mCategories != null) {
5575 code += mCategories.hashCode();
5576 }
5577 return code;
5578 }
5579
5580 @Override
5581 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005582 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005583
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005584 b.append("Intent { ");
5585 toShortString(b, true, true);
5586 b.append(" }");
5587
5588 return b.toString();
5589 }
5590
5591 /** @hide */
5592 public String toShortString(boolean comp, boolean extras) {
5593 StringBuilder b = new StringBuilder(128);
5594 toShortString(b, comp, extras);
5595 return b.toString();
5596 }
Romain Guy4969af72009-06-17 10:53:19 -07005597
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005598 /** @hide */
5599 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
5600 boolean first = true;
5601 if (mAction != null) {
5602 b.append("act=").append(mAction);
5603 first = false;
5604 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005605 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005606 if (!first) {
5607 b.append(' ');
5608 }
5609 first = false;
5610 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005611 Iterator<String> i = mCategories.iterator();
5612 boolean didone = false;
5613 while (i.hasNext()) {
5614 if (didone) b.append(",");
5615 didone = true;
5616 b.append(i.next());
5617 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005618 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005619 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005620 if (mData != null) {
5621 if (!first) {
5622 b.append(' ');
5623 }
5624 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07005625 b.append("dat=");
Wink Savillec491ee02010-10-13 11:40:10 -07005626 String scheme = mData.getScheme();
5627 if (scheme != null) {
5628 if (scheme.equalsIgnoreCase("tel")) {
5629 b.append("tel:xxx-xxx-xxxx");
5630 } else if (scheme.equalsIgnoreCase("smsto")) {
5631 b.append("smsto:xxx-xxx-xxxx");
5632 } else {
5633 b.append(mData);
5634 }
Wink Savillea4288072010-10-12 12:36:38 -07005635 } else {
5636 b.append(mData);
5637 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005638 }
5639 if (mType != null) {
5640 if (!first) {
5641 b.append(' ');
5642 }
5643 first = false;
5644 b.append("typ=").append(mType);
5645 }
5646 if (mFlags != 0) {
5647 if (!first) {
5648 b.append(' ');
5649 }
5650 first = false;
5651 b.append("flg=0x").append(Integer.toHexString(mFlags));
5652 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005653 if (mPackage != null) {
5654 if (!first) {
5655 b.append(' ');
5656 }
5657 first = false;
5658 b.append("pkg=").append(mPackage);
5659 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005660 if (comp && mComponent != null) {
5661 if (!first) {
5662 b.append(' ');
5663 }
5664 first = false;
5665 b.append("cmp=").append(mComponent.flattenToShortString());
5666 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005667 if (mSourceBounds != null) {
5668 if (!first) {
5669 b.append(' ');
5670 }
5671 first = false;
5672 b.append("bnds=").append(mSourceBounds.toShortString());
5673 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005674 if (extras && mExtras != null) {
5675 if (!first) {
5676 b.append(' ');
5677 }
5678 first = false;
5679 b.append("(has extras)");
5680 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005681 }
5682
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005683 /**
5684 * Call {@link #toUri} with 0 flags.
5685 * @deprecated Use {@link #toUri} instead.
5686 */
5687 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005688 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005689 return toUri(0);
5690 }
5691
5692 /**
5693 * Convert this Intent into a String holding a URI representation of it.
5694 * The returned URI string has been properly URI encoded, so it can be
5695 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5696 * Intent's data as the base URI, with an additional fragment describing
5697 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08005698 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005699 * <p>You can convert the returned string back to an Intent with
5700 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08005701 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005702 * @param flags Additional operating flags. Either 0 or
5703 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08005704 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005705 * @return Returns a URI encoding URI string describing the entire contents
5706 * of the Intent.
5707 */
5708 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005709 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005710 String scheme = null;
5711 if (mData != null) {
5712 String data = mData.toString();
5713 if ((flags&URI_INTENT_SCHEME) != 0) {
5714 final int N = data.length();
5715 for (int i=0; i<N; i++) {
5716 char c = data.charAt(i);
5717 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5718 || c == '.' || c == '-') {
5719 continue;
5720 }
5721 if (c == ':' && i > 0) {
5722 // Valid scheme.
5723 scheme = data.substring(0, i);
5724 uri.append("intent:");
5725 data = data.substring(i+1);
5726 break;
5727 }
Tom Taylord4a47292009-12-21 13:59:18 -08005728
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005729 // No scheme.
5730 break;
5731 }
5732 }
5733 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08005734
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005735 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5736 uri.append("intent:");
5737 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005738
5739 uri.append("#Intent;");
5740
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005741 if (scheme != null) {
5742 uri.append("scheme=").append(scheme).append(';');
5743 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005744 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005745 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005746 }
5747 if (mCategories != null) {
5748 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005749 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005750 }
5751 }
5752 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005753 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005754 }
5755 if (mFlags != 0) {
5756 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5757 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005758 if (mPackage != null) {
5759 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5760 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005761 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005762 uri.append("component=").append(Uri.encode(
5763 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005764 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005765 if (mSourceBounds != null) {
5766 uri.append("sourceBounds=")
5767 .append(Uri.encode(mSourceBounds.flattenToString()))
5768 .append(';');
5769 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005770 if (mExtras != null) {
5771 for (String key : mExtras.keySet()) {
5772 final Object value = mExtras.get(key);
5773 char entryType =
5774 value instanceof String ? 'S' :
5775 value instanceof Boolean ? 'B' :
5776 value instanceof Byte ? 'b' :
5777 value instanceof Character ? 'c' :
5778 value instanceof Double ? 'd' :
5779 value instanceof Float ? 'f' :
5780 value instanceof Integer ? 'i' :
5781 value instanceof Long ? 'l' :
5782 value instanceof Short ? 's' :
5783 '\0';
5784
5785 if (entryType != '\0') {
5786 uri.append(entryType);
5787 uri.append('.');
5788 uri.append(Uri.encode(key));
5789 uri.append('=');
5790 uri.append(Uri.encode(value.toString()));
5791 uri.append(';');
5792 }
5793 }
5794 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005795
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005796 uri.append("end");
5797
5798 return uri.toString();
5799 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005800
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005801 public int describeContents() {
5802 return (mExtras != null) ? mExtras.describeContents() : 0;
5803 }
5804
5805 public void writeToParcel(Parcel out, int flags) {
5806 out.writeString(mAction);
5807 Uri.writeToParcel(out, mData);
5808 out.writeString(mType);
5809 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005810 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005811 ComponentName.writeToParcel(mComponent, out);
5812
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005813 if (mSourceBounds != null) {
5814 out.writeInt(1);
5815 mSourceBounds.writeToParcel(out, flags);
5816 } else {
5817 out.writeInt(0);
5818 }
5819
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005820 if (mCategories != null) {
5821 out.writeInt(mCategories.size());
5822 for (String category : mCategories) {
5823 out.writeString(category);
5824 }
5825 } else {
5826 out.writeInt(0);
5827 }
5828
5829 out.writeBundle(mExtras);
5830 }
5831
5832 public static final Parcelable.Creator<Intent> CREATOR
5833 = new Parcelable.Creator<Intent>() {
5834 public Intent createFromParcel(Parcel in) {
5835 return new Intent(in);
5836 }
5837 public Intent[] newArray(int size) {
5838 return new Intent[size];
5839 }
5840 };
5841
Dianne Hackborneb034652009-09-07 00:49:58 -07005842 /** @hide */
5843 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005844 readFromParcel(in);
5845 }
5846
5847 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005848 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005849 mData = Uri.CREATOR.createFromParcel(in);
5850 mType = in.readString();
5851 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005852 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005853 mComponent = ComponentName.readFromParcel(in);
5854
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005855 if (in.readInt() != 0) {
5856 mSourceBounds = Rect.CREATOR.createFromParcel(in);
5857 }
5858
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005859 int N = in.readInt();
5860 if (N > 0) {
5861 mCategories = new HashSet<String>();
5862 int i;
5863 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005864 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005865 }
5866 } else {
5867 mCategories = null;
5868 }
5869
5870 mExtras = in.readBundle();
5871 }
5872
5873 /**
5874 * Parses the "intent" element (and its children) from XML and instantiates
5875 * an Intent object. The given XML parser should be located at the tag
5876 * where parsing should start (often named "intent"), from which the
5877 * basic action, data, type, and package and class name will be
5878 * retrieved. The function will then parse in to any child elements,
5879 * looking for <category android:name="xxx"> tags to add categories and
5880 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5881 * to the intent.
5882 *
5883 * @param resources The Resources to use when inflating resources.
5884 * @param parser The XML parser pointing at an "intent" tag.
5885 * @param attrs The AttributeSet interface for retrieving extended
5886 * attribute data at the current <var>parser</var> location.
5887 * @return An Intent object matching the XML data.
5888 * @throws XmlPullParserException If there was an XML parsing error.
5889 * @throws IOException If there was an I/O error.
5890 */
5891 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5892 throws XmlPullParserException, IOException {
5893 Intent intent = new Intent();
5894
5895 TypedArray sa = resources.obtainAttributes(attrs,
5896 com.android.internal.R.styleable.Intent);
5897
5898 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5899
5900 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5901 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5902 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5903
5904 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5905 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5906 if (packageName != null && className != null) {
5907 intent.setComponent(new ComponentName(packageName, className));
5908 }
5909
5910 sa.recycle();
5911
5912 int outerDepth = parser.getDepth();
5913 int type;
5914 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5915 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5916 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5917 continue;
5918 }
5919
5920 String nodeName = parser.getName();
5921 if (nodeName.equals("category")) {
5922 sa = resources.obtainAttributes(attrs,
5923 com.android.internal.R.styleable.IntentCategory);
5924 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5925 sa.recycle();
5926
5927 if (cat != null) {
5928 intent.addCategory(cat);
5929 }
5930 XmlUtils.skipCurrentTag(parser);
5931
5932 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005933 if (intent.mExtras == null) {
5934 intent.mExtras = new Bundle();
5935 }
5936 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5937 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005938
5939 } else {
5940 XmlUtils.skipCurrentTag(parser);
5941 }
5942 }
5943
5944 return intent;
5945 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005946}