blob: 2579cedac83c87139042024376dc7efbd002c4c1 [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 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001533 * Broadcast Action: Resources for a set of packages (which were
1534 * previously unavailable) are currently
1535 * available since the media on which they exist is available.
1536 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1537 * list of packages whose availability changed.
1538 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1539 * list of uids of packages whose availability changed.
1540 * Note that the
1541 * packages in this list do <em>not</em> receive this broadcast.
1542 * The specified set of packages are now available on the system.
1543 * <p>Includes the following extras:
1544 * <ul>
1545 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1546 * whose resources(were previously unavailable) are currently available.
1547 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1548 * packages whose resources(were previously unavailable)
1549 * are currently available.
1550 * </ul>
1551 *
1552 * <p class="note">This is a protected intent that can only be sent
1553 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001554 */
1555 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001556 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1557 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001558
1559 /**
1560 * Broadcast Action: Resources for a set of packages are currently
1561 * unavailable since the media on which they exist is unavailable.
1562 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1563 * list of packages whose availability changed.
1564 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1565 * list of uids of packages whose availability changed.
1566 * The specified set of packages can no longer be
1567 * launched and are practically unavailable on the system.
1568 * <p>Inclues the following extras:
1569 * <ul>
1570 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1571 * whose resources are no longer available.
1572 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1573 * whose resources are no longer available.
1574 * </ul>
1575 *
1576 * <p class="note">This is a protected intent that can only be sent
1577 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001578 */
1579 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001580 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001581 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001582
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001583 /**
1584 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001585 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001586 */
1587 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1588 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1589 /**
1590 * Broadcast Action: The current device {@link android.content.res.Configuration}
1591 * (orientation, locale, etc) has changed. When such a change happens, the
1592 * UIs (view hierarchy) will need to be rebuilt based on this new
1593 * information; for the most part, applications don't need to worry about
1594 * this, because the system will take care of stopping and restarting the
1595 * application to make sure it sees the new changes. Some system code that
1596 * can not be restarted will need to watch for this action and handle it
1597 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001598 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001599 * <p class="note">
1600 * You can <em>not</em> receive this through components declared
1601 * in manifests, only by explicitly registering for it with
1602 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1603 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001604 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001605 * <p class="note">This is a protected intent that can only be sent
1606 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001607 *
1608 * @see android.content.res.Configuration
1609 */
1610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1611 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1612 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001613 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001614 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001615 * <p class="note">This is a protected intent that can only be sent
1616 * by the system.
1617 */
1618 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1619 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1620 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001621 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1622 * charging state, level, and other information about the battery.
1623 * See {@link android.os.BatteryManager} for documentation on the
1624 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001625 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001626 * <p class="note">
1627 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001628 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001629 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001630 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1631 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1632 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1633 * broadcasts that are sent and can be received through manifest
1634 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001635 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001636 * <p class="note">This is a protected intent that can only be sent
1637 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001638 */
1639 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1640 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1641 /**
1642 * Broadcast Action: Indicates low battery condition on the device.
1643 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001644 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001645 * <p class="note">This is a protected intent that can only be sent
1646 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001647 */
1648 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1649 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1650 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001651 * Broadcast Action: Indicates the battery is now okay after being low.
1652 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1653 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001654 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001655 * <p class="note">This is a protected intent that can only be sent
1656 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1660 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001661 * Broadcast Action: External power has been connected to the device.
1662 * This is intended for applications that wish to register specifically to this notification.
1663 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1664 * stay active to receive this notification. This action can be used to implement actions
1665 * that wait until power is available to trigger.
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.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001669 */
1670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001671 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001672 /**
1673 * Broadcast Action: External power has been removed from 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
Romain Guy4969af72009-06-17 10:53:19 -07001677 * 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)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001683 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001684 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001685 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001686 * Broadcast Action: Device is shutting down.
1687 * This is broadcast when the device is being shut down (completely turned
1688 * off, not sleeping). Once the broadcast is complete, the final shutdown
1689 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001690 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001691 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001692 * <p class="note">This is a protected intent that can only be sent
1693 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001694 */
1695 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001696 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001697 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001698 * Activity Action: Start this activity to request system shutdown.
1699 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1700 * to request confirmation from the user before shutting down.
1701 *
1702 * <p class="note">This is a protected intent that can only be sent
1703 * by the system.
1704 *
1705 * {@hide}
1706 */
1707 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1708 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001709 * Broadcast Action: A sticky broadcast that indicates low memory
1710 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001711 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001712 * <p class="note">This is a protected intent that can only be sent
1713 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001714 */
1715 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1716 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1717 /**
1718 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001719 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001720 * <p class="note">This is a protected intent that can only be sent
1721 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001722 */
1723 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1724 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1725 /**
Jake Hambybb371632010-08-23 18:16:48 -07001726 * Broadcast Action: A sticky broadcast that indicates a memory full
1727 * condition on the device. This is intended for activities that want
1728 * to be able to fill the data partition completely, leaving only
1729 * enough free space to prevent system-wide SQLite failures.
1730 *
1731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
1733 *
1734 * {@hide}
1735 */
1736 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1737 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1738 /**
1739 * Broadcast Action: Indicates memory full condition on the device
1740 * no longer exists.
1741 *
1742 * <p class="note">This is a protected intent that can only be sent
1743 * by the system.
1744 *
1745 * {@hide}
1746 */
1747 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1748 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1749 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001750 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1751 * and package management should be started.
1752 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1753 * notification.
1754 */
1755 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1756 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1757 /**
1758 * Broadcast Action: The device has entered USB Mass Storage mode.
1759 * This is used mainly for the USB Settings panel.
1760 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1761 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001762 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001763 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001764 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001765 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1766
1767 /**
1768 * Broadcast Action: The device has exited USB Mass Storage mode.
1769 * This is used mainly for the USB Settings panel.
1770 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1771 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001772 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001773 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001774 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001775 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1776
1777 /**
1778 * Broadcast Action: External media has been removed.
1779 * The path to the mount point for the removed media is contained in the Intent.mData field.
1780 */
1781 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1782 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1783
1784 /**
1785 * Broadcast Action: External media is present, but not mounted at its mount point.
1786 * The path to the mount point for the removed media is contained in the Intent.mData field.
1787 */
1788 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1789 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1790
1791 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001792 * Broadcast Action: External media is present, and being disk-checked
1793 * 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 -08001794 */
1795 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1796 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1797
1798 /**
1799 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1800 * 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 -08001801 */
1802 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1803 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1804
1805 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001806 * Broadcast Action: External media is present and mounted at its mount point.
1807 * The path to the mount point for the removed media is contained in the Intent.mData field.
1808 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1809 * media was mounted read only.
1810 */
1811 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1812 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1813
1814 /**
1815 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001816 * 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 -07001817 */
1818 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1819 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1820
1821 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001822 * Broadcast Action: External media is no longer being shared via USB mass storage.
1823 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1824 *
1825 * @hide
1826 */
1827 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1828
1829 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001830 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1831 * The path to the mount point for the removed media is contained in the Intent.mData field.
1832 */
1833 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1834 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1835
1836 /**
1837 * Broadcast Action: External media is present but cannot be mounted.
1838 * The path to the mount point for the removed media is contained in the Intent.mData field.
1839 */
1840 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1841 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1842
1843 /**
1844 * Broadcast Action: User has expressed the desire to remove the external storage media.
1845 * Applications should close all files they have open within the mount point when they receive this intent.
1846 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1847 */
1848 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1849 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1850
1851 /**
1852 * Broadcast Action: The media scanner has started scanning a directory.
1853 * The path to the directory being scanned is contained in the Intent.mData field.
1854 */
1855 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1856 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1857
1858 /**
1859 * Broadcast Action: The media scanner has finished scanning a directory.
1860 * The path to the scanned directory is contained in the Intent.mData field.
1861 */
1862 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1863 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1864
1865 /**
1866 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1867 * The path to the file is contained in the Intent.mData field.
1868 */
1869 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1870 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1871
1872 /**
1873 * Broadcast Action: The "Media Button" was pressed. Includes a single
1874 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1875 * caused the broadcast.
1876 */
1877 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1878 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
1879
1880 /**
1881 * Broadcast Action: The "Camera Button" was pressed. Includes a single
1882 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1883 * caused the broadcast.
1884 */
1885 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1886 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
1887
1888 // *** NOTE: @todo(*) The following really should go into a more domain-specific
1889 // location; they are not general-purpose actions.
1890
1891 /**
1892 * Broadcast Action: An GTalk connection has been established.
1893 */
1894 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1895 public static final String ACTION_GTALK_SERVICE_CONNECTED =
1896 "android.intent.action.GTALK_CONNECTED";
1897
1898 /**
1899 * Broadcast Action: An GTalk connection has been disconnected.
1900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1902 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
1903 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07001904
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001905 /**
1906 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001907 */
1908 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1909 public static final String ACTION_INPUT_METHOD_CHANGED =
1910 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001911
1912 /**
1913 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
1914 * more radios have been turned off or on. The intent will have the following extra value:</p>
1915 * <ul>
1916 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
1917 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
1918 * turned off</li>
1919 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001920 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001921 * <p class="note">This is a protected intent that can only be sent
1922 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001923 */
1924 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1925 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
1926
1927 /**
1928 * Broadcast Action: Some content providers have parts of their namespace
1929 * where they publish new events or items that the user may be especially
1930 * interested in. For these things, they may broadcast this action when the
1931 * set of interesting items change.
1932 *
1933 * For example, GmailProvider sends this notification when the set of unread
1934 * mail in the inbox changes.
1935 *
1936 * <p>The data of the intent identifies which part of which provider
1937 * changed. When queried through the content resolver, the data URI will
1938 * return the data set in question.
1939 *
1940 * <p>The intent will have the following extra values:
1941 * <ul>
1942 * <li><em>count</em> - The number of items in the data set. This is the
1943 * same as the number of items in the cursor returned by querying the
1944 * data URI. </li>
1945 * </ul>
1946 *
1947 * This intent will be sent at boot (if the count is non-zero) and when the
1948 * data set changes. It is possible for the data set to change without the
1949 * count changing (for example, if a new unread message arrives in the same
1950 * sync operation in which a message is archived). The phone should still
1951 * ring/vibrate/etc as normal in this case.
1952 */
1953 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1954 public static final String ACTION_PROVIDER_CHANGED =
1955 "android.intent.action.PROVIDER_CHANGED";
1956
1957 /**
1958 * Broadcast Action: Wired Headset plugged in or unplugged.
1959 *
1960 * <p>The intent will have the following extra values:
1961 * <ul>
1962 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1963 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08001964 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001965 * </ul>
1966 * </ul>
1967 */
1968 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1969 public static final String ACTION_HEADSET_PLUG =
1970 "android.intent.action.HEADSET_PLUG";
1971
1972 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001973 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
1974 *
1975 * <p>The intent will have the following extra values:
1976 * <ul>
1977 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1978 * <li><em>name</em> - Headset type, human readable string </li>
1979 * </ul>
1980 * </ul>
1981 * @hide
1982 */
1983 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1984 public static final String ACTION_USB_ANLG_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08001985 "android.intent.action.USB_ANLG_HEADSET_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001986
1987 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07001988 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05001989 *
1990 * <p>The intent will have the following extra values:
1991 * <ul>
1992 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
1993 * <li><em>name</em> - Headset type, human readable string </li>
1994 * </ul>
1995 * </ul>
1996 * @hide
1997 */
1998 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1999 public static final String ACTION_USB_DGTL_HEADSET_PLUG =
Eric Laurent4d29b2f2010-12-16 09:18:24 -08002000 "android.intent.action.USB_DGTL_HEADSET_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002001
2002 /**
2003 * Broadcast Action: A HMDI cable was plugged or unplugged
2004 *
2005 * <p>The intent will have the following extra values:
2006 * <ul>
2007 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2008 * <li><em>name</em> - HDMI cable, human readable string </li>
2009 * </ul>
2010 * </ul>
2011 * @hide
2012 */
2013 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2014 public static final String ACTION_HDMI_AUDIO_PLUG =
2015 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002016
2017 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002018 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2019 * <ul>
2020 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2021 * </ul>
2022 *
2023 * <p class="note">This is a protected intent that can only be sent
2024 * by the system.
2025 *
2026 * @hide
2027 */
2028 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2029 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2030 = "android.intent.action.ADVANCED_SETTINGS";
2031
2032 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002033 * Broadcast Action: An outgoing call is about to be placed.
2034 *
2035 * <p>The Intent will have the following extra value:
2036 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002037 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002038 * the phone number originally intended to be dialed.</li>
2039 * </ul>
2040 * <p>Once the broadcast is finished, the resultData is used as the actual
2041 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002042 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002043 * outgoing call in turn: for example, a parental control application
2044 * might verify that the user is authorized to place the call at that
2045 * time, then a number-rewriting application might add an area code if
2046 * one was not specified.</p>
2047 * <p>For consistency, any receiver whose purpose is to prohibit phone
2048 * calls should have a priority of 0, to ensure it will see the final
2049 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002050 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002051 * should have a positive priority.
2052 * Negative priorities are reserved for the system for this broadcast;
2053 * using them may cause problems.</p>
2054 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2055 * abort the broadcast.</p>
2056 * <p>Emergency calls cannot be intercepted using this mechanism, and
2057 * other calls cannot be modified to call emergency numbers using this
2058 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002059 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002060 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2061 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002062 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002063 * <p class="note">This is a protected intent that can only be sent
2064 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002065 */
2066 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2067 public static final String ACTION_NEW_OUTGOING_CALL =
2068 "android.intent.action.NEW_OUTGOING_CALL";
2069
2070 /**
2071 * Broadcast Action: Have the device reboot. This is only for use by
2072 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002073 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002074 * <p class="note">This is a protected intent that can only be sent
2075 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002076 */
2077 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2078 public static final String ACTION_REBOOT =
2079 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002080
Wei Huang97ecc9c2009-05-11 17:44:20 -07002081 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002082 * Broadcast Action: A sticky broadcast for changes in the physical
2083 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002084 *
2085 * <p>The intent will have the following extra values:
2086 * <ul>
2087 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002088 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002089 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002090 * <p>This is intended for monitoring the current physical dock state.
2091 * See {@link android.app.UiModeManager} for the normal API dealing with
2092 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002093 */
2094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2095 public static final String ACTION_DOCK_EVENT =
2096 "android.intent.action.DOCK_EVENT";
2097
2098 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002099 * Broadcast Action: a remote intent is to be broadcasted.
2100 *
2101 * A remote intent is used for remote RPC between devices. The remote intent
2102 * is serialized and sent from one device to another device. The receiving
2103 * device parses the remote intent and broadcasts it. Note that anyone can
2104 * broadcast a remote intent. However, if the intent receiver of the remote intent
2105 * does not trust intent broadcasts from arbitrary intent senders, it should require
2106 * the sender to hold certain permissions so only trusted sender's broadcast will be
2107 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002108 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002109 */
2110 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002111 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002112
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002113 /**
2114 * Broadcast Action: hook for permforming cleanup after a system update.
2115 *
2116 * The broadcast is sent when the system is booting, before the
2117 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2118 * image. A receiver for this should do its work and then disable itself
2119 * so that it does not get run again at the next boot.
2120 * @hide
2121 */
2122 public static final String ACTION_PRE_BOOT_COMPLETED =
2123 "android.intent.action.PRE_BOOT_COMPLETED";
2124
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002125 // ---------------------------------------------------------------------
2126 // ---------------------------------------------------------------------
2127 // Standard intent categories (see addCategory()).
2128
2129 /**
2130 * Set if the activity should be an option for the default action
2131 * (center press) to perform on a piece of data. Setting this will
2132 * hide from the user any activities without it set when performing an
2133 * action on some data. Note that this is normal -not- set in the
2134 * Intent when initiating an action -- it is for use in intent filters
2135 * specified in packages.
2136 */
2137 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2138 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2139 /**
2140 * Activities that can be safely invoked from a browser must support this
2141 * category. For example, if the user is viewing a web page or an e-mail
2142 * and clicks on a link in the text, the Intent generated execute that
2143 * link will require the BROWSABLE category, so that only activities
2144 * supporting this category will be considered as possible actions. By
2145 * supporting this category, you are promising that there is nothing
2146 * damaging (without user intervention) that can happen by invoking any
2147 * matching Intent.
2148 */
2149 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2150 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2151 /**
2152 * Set if the activity should be considered as an alternative action to
2153 * the data the user is currently viewing. See also
2154 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2155 * applies to the selection in a list of items.
2156 *
2157 * <p>Supporting this category means that you would like your activity to be
2158 * displayed in the set of alternative things the user can do, usually as
2159 * part of the current activity's options menu. You will usually want to
2160 * include a specific label in the &lt;intent-filter&gt; of this action
2161 * describing to the user what it does.
2162 *
2163 * <p>The action of IntentFilter with this category is important in that it
2164 * describes the specific action the target will perform. This generally
2165 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2166 * a specific name such as "com.android.camera.action.CROP. Only one
2167 * alternative of any particular action will be shown to the user, so using
2168 * a specific action like this makes sure that your alternative will be
2169 * displayed while also allowing other applications to provide their own
2170 * overrides of that particular action.
2171 */
2172 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2173 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2174 /**
2175 * Set if the activity should be considered as an alternative selection
2176 * action to the data the user has currently selected. This is like
2177 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2178 * of items from which the user can select, giving them alternatives to the
2179 * default action that will be performed on it.
2180 */
2181 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2182 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2183 /**
2184 * Intended to be used as a tab inside of an containing TabActivity.
2185 */
2186 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2187 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2188 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002189 * Should be displayed in the top-level launcher.
2190 */
2191 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2192 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2193 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002194 * Provides information about the package it is in; typically used if
2195 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2196 * a front-door to the user without having to be shown in the all apps list.
2197 */
2198 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2199 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2200 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002201 * This is the home activity, that is the first activity that is displayed
2202 * when the device boots.
2203 */
2204 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2205 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2206 /**
2207 * This activity is a preference panel.
2208 */
2209 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2210 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2211 /**
2212 * This activity is a development preference panel.
2213 */
2214 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2215 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2216 /**
2217 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002218 */
2219 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2220 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2221 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002222 * This activity allows the user to browse and download new applications.
2223 */
2224 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2225 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2226 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002227 * This activity may be exercised by the monkey or other automated test tools.
2228 */
2229 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2230 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2231 /**
2232 * To be used as a test (not part of the normal user experience).
2233 */
2234 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2235 /**
2236 * To be used as a unit test (run through the Test Harness).
2237 */
2238 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2239 /**
2240 * To be used as an sample code example (not part of the normal user
2241 * experience).
2242 */
2243 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2244 /**
2245 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2246 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2247 * when queried, though it is allowable for those columns to be blank.
2248 */
2249 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2250 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2251
2252 /**
2253 * To be used as code under test for framework instrumentation tests.
2254 */
2255 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2256 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002257 /**
2258 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002259 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2260 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002261 */
2262 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2263 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2264 /**
2265 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002266 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2267 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002268 */
2269 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2270 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002271 /**
2272 * An activity to run when device is inserted into a analog (low end) dock.
2273 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2274 * information, see {@link android.app.UiModeManager}.
2275 */
2276 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2277 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2278
2279 /**
2280 * An activity to run when device is inserted into a digital (high end) dock.
2281 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2282 * information, see {@link android.app.UiModeManager}.
2283 */
2284 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2285 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002286
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002287 /**
2288 * Used to indicate that the activity can be used in a car environment.
2289 */
2290 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2291 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2292
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002293 // ---------------------------------------------------------------------
2294 // ---------------------------------------------------------------------
2295 // Standard extra data keys.
2296
2297 /**
2298 * The initial data to place in a newly created record. Use with
2299 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2300 * fields as would be given to the underlying ContentProvider.insert()
2301 * call.
2302 */
2303 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2304
2305 /**
2306 * A constant CharSequence that is associated with the Intent, used with
2307 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2308 * this may be a styled CharSequence, so you must use
2309 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2310 * retrieve it.
2311 */
2312 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2313
2314 /**
2315 * A content: URI holding a stream of data associated with the Intent,
2316 * used with {@link #ACTION_SEND} to supply the data being sent.
2317 */
2318 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2319
2320 /**
2321 * A String[] holding e-mail addresses that should be delivered to.
2322 */
2323 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2324
2325 /**
2326 * A String[] holding e-mail addresses that should be carbon copied.
2327 */
2328 public static final String EXTRA_CC = "android.intent.extra.CC";
2329
2330 /**
2331 * A String[] holding e-mail addresses that should be blind carbon copied.
2332 */
2333 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2334
2335 /**
2336 * A constant string holding the desired subject line of a message.
2337 */
2338 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2339
2340 /**
2341 * An Intent describing the choices you would like shown with
2342 * {@link #ACTION_PICK_ACTIVITY}.
2343 */
2344 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2345
2346 /**
2347 * A CharSequence dialog title to provide to the user when used with a
2348 * {@link #ACTION_CHOOSER}.
2349 */
2350 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2351
2352 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002353 * A Parcelable[] of {@link Intent} or
2354 * {@link android.content.pm.LabeledIntent} objects as set with
2355 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2356 * a the front of the list of choices, when shown to the user with a
2357 * {@link #ACTION_CHOOSER}.
2358 */
2359 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2360
2361 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002362 * A {@link android.view.KeyEvent} object containing the event that
2363 * triggered the creation of the Intent it is in.
2364 */
2365 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2366
2367 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002368 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2369 * before shutting down.
2370 *
2371 * {@hide}
2372 */
2373 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2374
2375 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002376 * Used as an boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2377 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2378 * of restarting the application.
2379 */
2380 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2381
2382 /**
2383 * A String holding the phone number originally entered in
2384 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2385 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2386 */
2387 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002388
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002389 /**
2390 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2391 * intents to supply the uid the package had been assigned. Also an optional
2392 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2393 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2394 * purpose.
2395 */
2396 public static final String EXTRA_UID = "android.intent.extra.UID";
2397
2398 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002399 * @hide String array of package names.
2400 */
2401 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2402
2403 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002404 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2405 * intents to indicate whether this represents a full uninstall (removing
2406 * both the code and its data) or a partial uninstall (leaving its data,
2407 * implying that this is an update).
2408 */
2409 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002410
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002411 /**
2412 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2413 * intents to indicate that this is a replacement of the package, so this
2414 * broadcast will immediately be followed by an add broadcast for a
2415 * different version of the same package.
2416 */
2417 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002418
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002419 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002420 * Used as an int extra field in {@link android.app.AlarmManager} intents
2421 * to tell the application being invoked how many pending alarms are being
2422 * delievered with the intent. For one-shot alarms this will always be 1.
2423 * For recurring alarms, this might be greater than 1 if the device was
2424 * asleep or powered off at the time an earlier alarm would have been
2425 * delivered.
2426 */
2427 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002428
Jacek Surazski86b6c532009-05-13 14:38:28 +02002429 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002430 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2431 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002432 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2433 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002434 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2435 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2436 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002437 */
2438 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2439
2440 /**
2441 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2442 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002443 */
2444 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2445
2446 /**
2447 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2448 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002449 */
2450 public static final int EXTRA_DOCK_STATE_DESK = 1;
2451
2452 /**
2453 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2454 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002455 */
2456 public static final int EXTRA_DOCK_STATE_CAR = 2;
2457
2458 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002459 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2460 * to represent that the phone is in a analog (low end) dock.
2461 */
2462 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
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 digital (high end) dock.
2467 */
2468 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2469
2470 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002471 * Boolean that can be supplied as meta-data with a dock activity, to
2472 * indicate that the dock should take over the home key when it is active.
2473 */
2474 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002475
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002476 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002477 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2478 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002479 */
2480 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2481
2482 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002483 * Used in the extra field in the remote intent. It's astring token passed with the
2484 * remote intent.
2485 */
2486 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2487 "android.intent.extra.remote_intent_token";
2488
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002489 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002490 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002491 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002492 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002493 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002494 "android.intent.extra.changed_component_name";
2495
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002496 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002497 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002498 * and contains a string array of all of the components that have changed.
2499 */
2500 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2501 "android.intent.extra.changed_component_name_list";
2502
2503 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002504 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002505 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2506 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002507 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002508 */
2509 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2510 "android.intent.extra.changed_package_list";
2511
2512 /**
2513 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002514 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2515 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002516 * and contains an integer array of uids of all of the components
2517 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002518 */
2519 public static final String EXTRA_CHANGED_UID_LIST =
2520 "android.intent.extra.changed_uid_list";
2521
2522 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002523 * @hide
2524 * Magic extra system code can use when binding, to give a label for
2525 * who it is that has bound to a service. This is an integer giving
2526 * a framework string resource that can be displayed to the user.
2527 */
2528 public static final String EXTRA_CLIENT_LABEL =
2529 "android.intent.extra.client_label";
2530
2531 /**
2532 * @hide
2533 * Magic extra system code can use when binding, to give a PendingIntent object
2534 * that can be launched for the user to disable the system's use of this
2535 * service.
2536 */
2537 public static final String EXTRA_CLIENT_INTENT =
2538 "android.intent.extra.client_intent";
2539
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002540 /**
2541 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2542 * data that is on the local device. This is a boolean extra; the default
2543 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2544 * the user to select media that is already on the device, not requiring it
2545 * be downloaded from a remote service when opened. Another way to look
2546 * at it is that such content should generally have a "_data" column to the
2547 * path of the content on local external storage.
2548 */
2549 public static final String EXTRA_LOCAL_ONLY =
2550 "android.intent.extra.LOCAL_ONLY";
2551
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002552 // ---------------------------------------------------------------------
2553 // ---------------------------------------------------------------------
2554 // Intent flags (see mFlags variable).
2555
2556 /**
2557 * If set, the recipient of this Intent will be granted permission to
2558 * perform read operations on the Uri in the Intent's data.
2559 */
2560 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2561 /**
2562 * If set, the recipient of this Intent will be granted permission to
2563 * perform write operations on the Uri in the Intent's data.
2564 */
2565 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2566 /**
2567 * Can be set by the caller to indicate that this Intent is coming from
2568 * a background operation, not from direct user interaction.
2569 */
2570 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2571 /**
2572 * A flag you can enable for debugging: when set, log messages will be
2573 * printed during the resolution of this intent to show you what has
2574 * been found to create the final resolved list.
2575 */
2576 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002577 /**
2578 * If set, this intent will not match any components in packages that
2579 * are currently stopped. If this is not set, then the default behavior
2580 * is to include such applications in the result.
2581 */
2582 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2583 /**
2584 * If set, this intent will always match any components in packages that
2585 * are currently stopped. This is the default behavior when
2586 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2587 * flags are set, this one wins (it allows overriding of exclude for
2588 * places where the framework may automatically set the exclude flag).
2589 */
2590 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002591
2592 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002593 * If set, the new activity is not kept in the history stack. As soon as
2594 * the user navigates away from it, the activity is finished. This may also
2595 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2596 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002597 */
2598 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2599 /**
2600 * If set, the activity will not be launched if it is already running
2601 * at the top of the history stack.
2602 */
2603 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2604 /**
2605 * If set, this activity will become the start of a new task on this
2606 * history stack. A task (from the activity that started it to the
2607 * next task activity) defines an atomic group of activities that the
2608 * user can move to. Tasks can be moved to the foreground and background;
2609 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002610 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002611 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2612 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002613 *
2614 * <p>This flag is generally used by activities that want
2615 * to present a "launcher" style behavior: they give the user a list of
2616 * separate things that can be done, which otherwise run completely
2617 * independently of the activity launching them.
2618 *
2619 * <p>When using this flag, if a task is already running for the activity
2620 * you are now starting, then a new activity will not be started; instead,
2621 * the current task will simply be brought to the front of the screen with
2622 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2623 * to disable this behavior.
2624 *
2625 * <p>This flag can not be used when the caller is requesting a result from
2626 * the activity being launched.
2627 */
2628 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2629 /**
2630 * <strong>Do not use this flag unless you are implementing your own
2631 * top-level application launcher.</strong> Used in conjunction with
2632 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2633 * behavior of bringing an existing task to the foreground. When set,
2634 * a new task is <em>always</em> started to host the Activity for the
2635 * Intent, regardless of whether there is already an existing task running
2636 * the same thing.
2637 *
2638 * <p><strong>Because the default system does not include graphical task management,
2639 * you should not use this flag unless you provide some way for a user to
2640 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002641 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002642 * <p>This flag is ignored if
2643 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2644 *
Scott Main7aee61f2011-02-08 11:25:01 -08002645 * <p>See
2646 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2647 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002648 */
2649 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2650 /**
2651 * If set, and the activity being launched is already running in the
2652 * current task, then instead of launching a new instance of that activity,
2653 * all of the other activities on top of it will be closed and this Intent
2654 * will be delivered to the (now on top) old activity as a new Intent.
2655 *
2656 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2657 * If D calls startActivity() with an Intent that resolves to the component
2658 * of activity B, then C and D will be finished and B receive the given
2659 * Intent, resulting in the stack now being: A, B.
2660 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002661 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002662 * either receive the new intent you are starting here in its
2663 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002664 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002665 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2666 * the same intent, then it will be finished and re-created; for all other
2667 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2668 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002669 *
2670 * <p>This launch mode can also be used to good effect in conjunction with
2671 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2672 * of a task, it will bring any currently running instance of that task
2673 * to the foreground, and then clear it to its root state. This is
2674 * especially useful, for example, when launching an activity from the
2675 * notification manager.
2676 *
Scott Main7aee61f2011-02-08 11:25:01 -08002677 * <p>See
2678 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2679 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002680 */
2681 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2682 /**
2683 * If set and this intent is being used to launch a new activity from an
2684 * existing one, then the reply target of the existing activity will be
2685 * transfered to the new activity. This way the new activity can call
2686 * {@link android.app.Activity#setResult} and have that result sent back to
2687 * the reply target of the original activity.
2688 */
2689 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
2690 /**
2691 * If set and this intent is being used to launch a new activity from an
2692 * existing one, the current activity will not be counted as the top
2693 * activity for deciding whether the new intent should be delivered to
2694 * the top instead of starting a new one. The previous activity will
2695 * be used as the top, with the assumption being that the current activity
2696 * will finish itself immediately.
2697 */
2698 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
2699 /**
2700 * If set, the new activity is not kept in the list of recently launched
2701 * activities.
2702 */
2703 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
2704 /**
2705 * This flag is not normally set by application code, but set for you by
2706 * the system as described in the
2707 * {@link android.R.styleable#AndroidManifestActivity_launchMode
2708 * launchMode} documentation for the singleTask mode.
2709 */
2710 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
2711 /**
2712 * If set, and this activity is either being started in a new task or
2713 * bringing to the top an existing task, then it will be launched as
2714 * the front door of the task. This will result in the application of
2715 * any affinities needed to have that task in the proper state (either
2716 * moving activities to or from it), or simply resetting that task to
2717 * its initial state if needed.
2718 */
2719 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
2720 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002721 * This flag is not normally set by application code, but set for you by
2722 * the system if this activity is being launched from history
2723 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002724 */
2725 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002726 /**
2727 * If set, this marks a point in the task's activity stack that should
2728 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07002729 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002730 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
2731 * the user re-launching it from home), this activity and all on top of
2732 * it will be finished so that the user does not return to them, but
2733 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07002734 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002735 * <p>This is useful for cases where you have a logical break in your
2736 * application. For example, an e-mail application may have a command
2737 * to view an attachment, which launches an image view activity to
2738 * display it. This activity should be part of the e-mail application's
2739 * task, since it is a part of the task the user is involved in. However,
2740 * if the user leaves that task, and later selects the e-mail app from
2741 * home, we may like them to return to the conversation they were
2742 * viewing, not the picture attachment, since that is confusing. By
2743 * setting this flag when launching the image viewer, that viewer and
2744 * any activities it starts will be removed the next time the user returns
2745 * to mail.
2746 */
2747 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002748 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002749 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002750 * callback from occurring on the current frontmost activity before it is
2751 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07002752 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002753 * <p>Typically, an activity can rely on that callback to indicate that an
2754 * explicit user action has caused their activity to be moved out of the
2755 * foreground. The callback marks an appropriate point in the activity's
2756 * lifecycle for it to dismiss any notifications that it intends to display
2757 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07002758 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002759 * <p>If an activity is ever started via any non-user-driven events such as
2760 * phone-call receipt or an alarm handler, this flag should be passed to {@link
2761 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07002762 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002763 */
2764 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002765 /**
2766 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2767 * this flag will cause the launched activity to be brought to the front of its
2768 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07002769 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002770 * <p>For example, consider a task consisting of four activities: A, B, C, D.
2771 * If D calls startActivity() with an Intent that resolves to the component
2772 * of activity B, then B will be brought to the front of the history stack,
2773 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07002774 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002775 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07002776 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002777 */
2778 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002779 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002780 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2781 * this flag will prevent the system from applying an activity transition
2782 * animation to go to the next activity state. This doesn't mean an
2783 * animation will never run -- if another activity change happens that doesn't
2784 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002785 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07002786 * when you are going to do a series of activity operations but the
2787 * animation seen by the user shouldn't be driven by the first activity
2788 * change but rather a later one.
2789 */
2790 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
2791 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08002792 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2793 * this flag will cause any existing task that would be associated with the
2794 * activity to be cleared before the activity is started. That is, the activity
2795 * becomes the new root of an otherwise empty task, and any old activities
2796 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2797 */
2798 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
2799 /**
2800 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
2801 * this flag will cause a newly launching task to be placed on top of the current
2802 * home activity task (if there is one). That is, pressing back from the task
2803 * will always return the user to home even if that was not the last activity they
2804 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
2805 */
2806 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
2807 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002808 * If set, when sending a broadcast only registered receivers will be
2809 * called -- no BroadcastReceiver components will be launched.
2810 */
2811 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002812 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002813 * If set, when sending a broadcast the new broadcast will replace
2814 * any existing pending broadcast that matches it. Matching is defined
2815 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
2816 * true for the intents of the two broadcasts. When a match is found,
2817 * the new broadcast (and receivers associated with it) will replace the
2818 * existing one in the pending broadcast list, remaining at the same
2819 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08002820 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002821 * <p>This flag is most typically used with sticky broadcasts, which
2822 * only care about delivering the most recent values of the broadcast
2823 * to their receivers.
2824 */
2825 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
2826 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002827 * If set, when sending a broadcast <i>before boot has completed</i> only
2828 * registered receivers will be called -- no BroadcastReceiver components
2829 * will be launched. Sticky intent state will be recorded properly even
2830 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
2831 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07002832 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002833 * <p>This flag is only for use by system sevices as a convenience to
2834 * avoid having to implement a more complex mechanism around detection
2835 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07002836 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002837 * @hide
2838 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002839 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x10000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002840 /**
2841 * Set when this broadcast is for a boot upgrade, a special mode that
2842 * allows the broadcast to be sent before the system is ready and launches
2843 * the app process with no providers running in it.
2844 * @hide
2845 */
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08002846 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x08000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002847
Dianne Hackbornfa82f222009-09-17 15:14:12 -07002848 /**
2849 * @hide Flags that can't be changed with PendingIntent.
2850 */
2851 public static final int IMMUTABLE_FLAGS =
2852 FLAG_GRANT_READ_URI_PERMISSION
2853 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08002854
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002855 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002856 // ---------------------------------------------------------------------
2857 // toUri() and parseUri() options.
2858
2859 /**
2860 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
2861 * always has the "intent:" scheme. This syntax can be used when you want
2862 * to later disambiguate between URIs that are intended to describe an
2863 * Intent vs. all others that should be treated as raw URIs. When used
2864 * with {@link #parseUri}, any other scheme will result in a generic
2865 * VIEW action for that raw URI.
2866 */
2867 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08002868
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002869 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870
2871 private String mAction;
2872 private Uri mData;
2873 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002874 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002875 private ComponentName mComponent;
2876 private int mFlags;
2877 private HashSet<String> mCategories;
2878 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002879 private Rect mSourceBounds;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002880
2881 // ---------------------------------------------------------------------
2882
2883 /**
2884 * Create an empty intent.
2885 */
2886 public Intent() {
2887 }
2888
2889 /**
2890 * Copy constructor.
2891 */
2892 public Intent(Intent o) {
2893 this.mAction = o.mAction;
2894 this.mData = o.mData;
2895 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002896 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002897 this.mComponent = o.mComponent;
2898 this.mFlags = o.mFlags;
2899 if (o.mCategories != null) {
2900 this.mCategories = new HashSet<String>(o.mCategories);
2901 }
2902 if (o.mExtras != null) {
2903 this.mExtras = new Bundle(o.mExtras);
2904 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08002905 if (o.mSourceBounds != null) {
2906 this.mSourceBounds = new Rect(o.mSourceBounds);
2907 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002908 }
2909
2910 @Override
2911 public Object clone() {
2912 return new Intent(this);
2913 }
2914
2915 private Intent(Intent o, boolean all) {
2916 this.mAction = o.mAction;
2917 this.mData = o.mData;
2918 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07002919 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002920 this.mComponent = o.mComponent;
2921 if (o.mCategories != null) {
2922 this.mCategories = new HashSet<String>(o.mCategories);
2923 }
2924 }
2925
2926 /**
2927 * Make a clone of only the parts of the Intent that are relevant for
2928 * filter matching: the action, data, type, component, and categories.
2929 */
2930 public Intent cloneFilter() {
2931 return new Intent(this, false);
2932 }
2933
2934 /**
2935 * Create an intent with a given action. All other fields (data, type,
2936 * class) are null. Note that the action <em>must</em> be in a
2937 * namespace because Intents are used globally in the system -- for
2938 * example the system VIEW action is android.intent.action.VIEW; an
2939 * application's custom action would be something like
2940 * com.google.app.myapp.CUSTOM_ACTION.
2941 *
2942 * @param action The Intent action, such as ACTION_VIEW.
2943 */
2944 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002945 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002946 }
2947
2948 /**
2949 * Create an intent with a given action and for a given data url. Note
2950 * that the action <em>must</em> be in a namespace because Intents are
2951 * used globally in the system -- for example the system VIEW action is
2952 * android.intent.action.VIEW; an application's custom action would be
2953 * something like com.google.app.myapp.CUSTOM_ACTION.
2954 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002955 * <p><em>Note: scheme and host name matching in the Android framework is
2956 * case-sensitive, unlike the formal RFC. As a result,
2957 * you should always ensure that you write your Uri with these elements
2958 * using lower case letters, and normalize any Uris you receive from
2959 * outside of Android to ensure the scheme and host is lower case.</em></p>
2960 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002961 * @param action The Intent action, such as ACTION_VIEW.
2962 * @param uri The Intent data URI.
2963 */
2964 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08002965 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002966 mData = uri;
2967 }
2968
2969 /**
2970 * Create an intent for a specific component. All other fields (action, data,
2971 * type, class) are null, though they can be modified later with explicit
2972 * calls. This provides a convenient way to create an intent that is
2973 * intended to execute a hard-coded class name, rather than relying on the
2974 * system to find an appropriate class for you; see {@link #setComponent}
2975 * for more information on the repercussions of this.
2976 *
2977 * @param packageContext A Context of the application package implementing
2978 * this class.
2979 * @param cls The component class that is to be used for the intent.
2980 *
2981 * @see #setClass
2982 * @see #setComponent
2983 * @see #Intent(String, android.net.Uri , Context, Class)
2984 */
2985 public Intent(Context packageContext, Class<?> cls) {
2986 mComponent = new ComponentName(packageContext, cls);
2987 }
2988
2989 /**
2990 * Create an intent for a specific component with a specified action and data.
2991 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
2992 * construct the Intent and then calling {@link #setClass} to set its
2993 * class.
2994 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07002995 * <p><em>Note: scheme and host name matching in the Android framework is
2996 * case-sensitive, unlike the formal RFC. As a result,
2997 * you should always ensure that you write your Uri with these elements
2998 * using lower case letters, and normalize any Uris you receive from
2999 * outside of Android to ensure the scheme and host is lower case.</em></p>
3000 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003001 * @param action The Intent action, such as ACTION_VIEW.
3002 * @param uri The Intent data URI.
3003 * @param packageContext A Context of the application package implementing
3004 * this class.
3005 * @param cls The component class that is to be used for the intent.
3006 *
3007 * @see #Intent(String, android.net.Uri)
3008 * @see #Intent(Context, Class)
3009 * @see #setClass
3010 * @see #setComponent
3011 */
3012 public Intent(String action, Uri uri,
3013 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003014 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003015 mData = uri;
3016 mComponent = new ComponentName(packageContext, cls);
3017 }
3018
3019 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003020 * Create an intent to launch the main (root) activity of a task. This
3021 * is the Intent that is started when the application's is launched from
3022 * Home. For anything else that wants to launch an application in the
3023 * same way, it is important that they use an Intent structured the same
3024 * way, and can use this function to ensure this is the case.
3025 *
3026 * <p>The returned Intent has the given Activity component as its explicit
3027 * component, {@link #ACTION_MAIN} as its action, and includes the
3028 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3029 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3030 * to do that through {@link #addFlags(int)} on the returned Intent.
3031 *
3032 * @param mainActivity The main activity component that this Intent will
3033 * launch.
3034 * @return Returns a newly created Intent that can be used to launch the
3035 * activity as a main application entry.
3036 *
3037 * @see #setClass
3038 * @see #setComponent
3039 */
3040 public static Intent makeMainActivity(ComponentName mainActivity) {
3041 Intent intent = new Intent(ACTION_MAIN);
3042 intent.setComponent(mainActivity);
3043 intent.addCategory(CATEGORY_LAUNCHER);
3044 return intent;
3045 }
3046
3047 /**
3048 * Make an Intent that can be used to re-launch an application's task
3049 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3050 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3051 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3052 *
3053 * @param mainActivity The activity component that is the root of the
3054 * task; this is the activity that has been published in the application's
3055 * manifest as the main launcher icon.
3056 *
3057 * @return Returns a newly created Intent that can be used to relaunch the
3058 * activity's task in its root state.
3059 */
3060 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3061 Intent intent = makeMainActivity(mainActivity);
3062 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3063 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3064 return intent;
3065 }
3066
3067 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003068 * Call {@link #parseUri} with 0 flags.
3069 * @deprecated Use {@link #parseUri} instead.
3070 */
3071 @Deprecated
3072 public static Intent getIntent(String uri) throws URISyntaxException {
3073 return parseUri(uri, 0);
3074 }
Tom Taylord4a47292009-12-21 13:59:18 -08003075
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003076 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003077 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003078 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003079 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003080 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003081 *
3082 * <p>The URI given here must not be relative -- that is, it must include
3083 * the scheme and full path.
3084 *
3085 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003086 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003087 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003088 *
3089 * @return Intent The newly created Intent object.
3090 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003091 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3092 * it bad (as parsed by the Uri class) or the Intent data within the
3093 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003094 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003095 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003096 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003097 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003098 int i = 0;
3099 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003100 // Validate intent scheme for if requested.
3101 if ((flags&URI_INTENT_SCHEME) != 0) {
3102 if (!uri.startsWith("intent:")) {
3103 Intent intent = new Intent(ACTION_VIEW);
3104 try {
3105 intent.setData(Uri.parse(uri));
3106 } catch (IllegalArgumentException e) {
3107 throw new URISyntaxException(uri, e.getMessage());
3108 }
3109 return intent;
3110 }
3111 }
Tom Taylord4a47292009-12-21 13:59:18 -08003112
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003113 // simple case
3114 i = uri.lastIndexOf("#");
3115 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3116
3117 // old format Intent URI
3118 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003119
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003120 // new format
3121 Intent intent = new Intent(ACTION_VIEW);
3122
3123 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003124 String data = i >= 0 ? uri.substring(0, i) : null;
3125 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003126 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003127
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003128 // loop over contents of Intent, all name=value;
3129 while (!uri.startsWith("end", i)) {
3130 int eq = uri.indexOf('=', i);
3131 int semi = uri.indexOf(';', eq);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003132 String value = Uri.decode(uri.substring(eq + 1, semi));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003133
3134 // action
3135 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003136 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003137 }
3138
3139 // categories
3140 else if (uri.startsWith("category=", i)) {
3141 intent.addCategory(value);
3142 }
3143
3144 // type
3145 else if (uri.startsWith("type=", i)) {
3146 intent.mType = value;
3147 }
3148
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003149 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003150 else if (uri.startsWith("launchFlags=", i)) {
3151 intent.mFlags = Integer.decode(value).intValue();
3152 }
3153
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003154 // package
3155 else if (uri.startsWith("package=", i)) {
3156 intent.mPackage = value;
3157 }
3158
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003159 // component
3160 else if (uri.startsWith("component=", i)) {
3161 intent.mComponent = ComponentName.unflattenFromString(value);
3162 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003163
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003164 // scheme
3165 else if (uri.startsWith("scheme=", i)) {
3166 scheme = value;
3167 }
3168
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003169 // source bounds
3170 else if (uri.startsWith("sourceBounds=", i)) {
3171 intent.mSourceBounds = Rect.unflattenFromString(value);
3172 }
3173
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003174 // extra
3175 else {
3176 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003177 // create Bundle if it doesn't already exist
3178 if (intent.mExtras == null) intent.mExtras = new Bundle();
3179 Bundle b = intent.mExtras;
3180 // add EXTRA
3181 if (uri.startsWith("S.", i)) b.putString(key, value);
3182 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3183 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3184 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3185 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3186 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3187 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3188 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3189 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3190 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3191 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003192
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003193 // move to the next item
3194 i = semi + 1;
3195 }
3196
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003197 if (data != null) {
3198 if (data.startsWith("intent:")) {
3199 data = data.substring(7);
3200 if (scheme != null) {
3201 data = scheme + ':' + data;
3202 }
3203 }
Tom Taylord4a47292009-12-21 13:59:18 -08003204
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003205 if (data.length() > 0) {
3206 try {
3207 intent.mData = Uri.parse(data);
3208 } catch (IllegalArgumentException e) {
3209 throw new URISyntaxException(uri, e.getMessage());
3210 }
3211 }
3212 }
Tom Taylord4a47292009-12-21 13:59:18 -08003213
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003214 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003215
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003216 } catch (IndexOutOfBoundsException e) {
3217 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3218 }
3219 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003220
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003221 public static Intent getIntentOld(String uri) throws URISyntaxException {
3222 Intent intent;
3223
3224 int i = uri.lastIndexOf('#');
3225 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003226 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003227 final int intentFragmentStart = i;
3228 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003229
3230 i++;
3231
3232 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003233 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003234 i += 7;
3235 int j = uri.indexOf(')', i);
3236 action = uri.substring(i, j);
3237 i = j + 1;
3238 }
3239
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003240 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003241
3242 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003243 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003244 i += 11;
3245 int j = uri.indexOf(')', i);
3246 while (i < j) {
3247 int sep = uri.indexOf('!', i);
3248 if (sep < 0) sep = j;
3249 if (i < sep) {
3250 intent.addCategory(uri.substring(i, sep));
3251 }
3252 i = sep + 1;
3253 }
3254 i = j + 1;
3255 }
3256
3257 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003258 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003259 i += 5;
3260 int j = uri.indexOf(')', i);
3261 intent.mType = uri.substring(i, j);
3262 i = j + 1;
3263 }
3264
3265 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003266 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003267 i += 12;
3268 int j = uri.indexOf(')', i);
3269 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3270 i = j + 1;
3271 }
3272
3273 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003274 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003275 i += 10;
3276 int j = uri.indexOf(')', i);
3277 int sep = uri.indexOf('!', i);
3278 if (sep >= 0 && sep < j) {
3279 String pkg = uri.substring(i, sep);
3280 String cls = uri.substring(sep + 1, j);
3281 intent.mComponent = new ComponentName(pkg, cls);
3282 }
3283 i = j + 1;
3284 }
3285
3286 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003287 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003288 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003289
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003290 final int closeParen = uri.indexOf(')', i);
3291 if (closeParen == -1) throw new URISyntaxException(uri,
3292 "EXTRA missing trailing ')'", i);
3293
3294 while (i < closeParen) {
3295 // fetch the key value
3296 int j = uri.indexOf('=', i);
3297 if (j <= i + 1 || i >= closeParen) {
3298 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3299 }
3300 char type = uri.charAt(i);
3301 i++;
3302 String key = uri.substring(i, j);
3303 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003304
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003305 // get type-value
3306 j = uri.indexOf('!', i);
3307 if (j == -1 || j >= closeParen) j = closeParen;
3308 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3309 String value = uri.substring(i, j);
3310 i = j;
3311
3312 // create Bundle if it doesn't already exist
3313 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003314
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003315 // add item to bundle
3316 try {
3317 switch (type) {
3318 case 'S':
3319 intent.mExtras.putString(key, Uri.decode(value));
3320 break;
3321 case 'B':
3322 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3323 break;
3324 case 'b':
3325 intent.mExtras.putByte(key, Byte.parseByte(value));
3326 break;
3327 case 'c':
3328 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3329 break;
3330 case 'd':
3331 intent.mExtras.putDouble(key, Double.parseDouble(value));
3332 break;
3333 case 'f':
3334 intent.mExtras.putFloat(key, Float.parseFloat(value));
3335 break;
3336 case 'i':
3337 intent.mExtras.putInt(key, Integer.parseInt(value));
3338 break;
3339 case 'l':
3340 intent.mExtras.putLong(key, Long.parseLong(value));
3341 break;
3342 case 's':
3343 intent.mExtras.putShort(key, Short.parseShort(value));
3344 break;
3345 default:
3346 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3347 }
3348 } catch (NumberFormatException e) {
3349 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3350 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003351
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003352 char ch = uri.charAt(i);
3353 if (ch == ')') break;
3354 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3355 i++;
3356 }
3357 }
3358
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003359 if (isIntentFragment) {
3360 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3361 } else {
3362 intent.mData = Uri.parse(uri);
3363 }
Tom Taylord4a47292009-12-21 13:59:18 -08003364
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003365 if (intent.mAction == null) {
3366 // By default, if no action is specified, then use VIEW.
3367 intent.mAction = ACTION_VIEW;
3368 }
3369
3370 } else {
3371 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3372 }
3373
3374 return intent;
3375 }
3376
3377 /**
3378 * Retrieve the general action to be performed, such as
3379 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3380 * the information in the intent should be interpreted -- most importantly,
3381 * what to do with the data returned by {@link #getData}.
3382 *
3383 * @return The action of this intent or null if none is specified.
3384 *
3385 * @see #setAction
3386 */
3387 public String getAction() {
3388 return mAction;
3389 }
3390
3391 /**
3392 * Retrieve data this intent is operating on. This URI specifies the name
3393 * of the data; often it uses the content: scheme, specifying data in a
3394 * content provider. Other schemes may be handled by specific activities,
3395 * such as http: by the web browser.
3396 *
3397 * @return The URI of the data this intent is targeting or null.
3398 *
3399 * @see #getScheme
3400 * @see #setData
3401 */
3402 public Uri getData() {
3403 return mData;
3404 }
3405
3406 /**
3407 * The same as {@link #getData()}, but returns the URI as an encoded
3408 * String.
3409 */
3410 public String getDataString() {
3411 return mData != null ? mData.toString() : null;
3412 }
3413
3414 /**
3415 * Return the scheme portion of the intent's data. If the data is null or
3416 * does not include a scheme, null is returned. Otherwise, the scheme
3417 * prefix without the final ':' is returned, i.e. "http".
3418 *
3419 * <p>This is the same as calling getData().getScheme() (and checking for
3420 * null data).
3421 *
3422 * @return The scheme of this intent.
3423 *
3424 * @see #getData
3425 */
3426 public String getScheme() {
3427 return mData != null ? mData.getScheme() : null;
3428 }
3429
3430 /**
3431 * Retrieve any explicit MIME type included in the intent. This is usually
3432 * null, as the type is determined by the intent data.
3433 *
3434 * @return If a type was manually set, it is returned; else null is
3435 * returned.
3436 *
3437 * @see #resolveType(ContentResolver)
3438 * @see #setType
3439 */
3440 public String getType() {
3441 return mType;
3442 }
3443
3444 /**
3445 * Return the MIME data type of this intent. If the type field is
3446 * explicitly set, that is simply returned. Otherwise, if the data is set,
3447 * the type of that data is returned. If neither fields are set, a null is
3448 * returned.
3449 *
3450 * @return The MIME type of this intent.
3451 *
3452 * @see #getType
3453 * @see #resolveType(ContentResolver)
3454 */
3455 public String resolveType(Context context) {
3456 return resolveType(context.getContentResolver());
3457 }
3458
3459 /**
3460 * Return the MIME data type of this intent. If the type field is
3461 * explicitly set, that is simply returned. Otherwise, if the data is set,
3462 * the type of that data is returned. If neither fields are set, a null is
3463 * returned.
3464 *
3465 * @param resolver A ContentResolver that can be used to determine the MIME
3466 * type of the intent's data.
3467 *
3468 * @return The MIME type of this intent.
3469 *
3470 * @see #getType
3471 * @see #resolveType(Context)
3472 */
3473 public String resolveType(ContentResolver resolver) {
3474 if (mType != null) {
3475 return mType;
3476 }
3477 if (mData != null) {
3478 if ("content".equals(mData.getScheme())) {
3479 return resolver.getType(mData);
3480 }
3481 }
3482 return null;
3483 }
3484
3485 /**
3486 * Return the MIME data type of this intent, only if it will be needed for
3487 * intent resolution. This is not generally useful for application code;
3488 * it is used by the frameworks for communicating with back-end system
3489 * services.
3490 *
3491 * @param resolver A ContentResolver that can be used to determine the MIME
3492 * type of the intent's data.
3493 *
3494 * @return The MIME type of this intent, or null if it is unknown or not
3495 * needed.
3496 */
3497 public String resolveTypeIfNeeded(ContentResolver resolver) {
3498 if (mComponent != null) {
3499 return mType;
3500 }
3501 return resolveType(resolver);
3502 }
3503
3504 /**
3505 * Check if an category exists in the intent.
3506 *
3507 * @param category The category to check.
3508 *
3509 * @return boolean True if the intent contains the category, else false.
3510 *
3511 * @see #getCategories
3512 * @see #addCategory
3513 */
3514 public boolean hasCategory(String category) {
3515 return mCategories != null && mCategories.contains(category);
3516 }
3517
3518 /**
3519 * Return the set of all categories in the intent. If there are no categories,
3520 * returns NULL.
3521 *
3522 * @return Set The set of categories you can examine. Do not modify!
3523 *
3524 * @see #hasCategory
3525 * @see #addCategory
3526 */
3527 public Set<String> getCategories() {
3528 return mCategories;
3529 }
3530
3531 /**
3532 * Sets the ClassLoader that will be used when unmarshalling
3533 * any Parcelable values from the extras of this Intent.
3534 *
3535 * @param loader a ClassLoader, or null to use the default loader
3536 * at the time of unmarshalling.
3537 */
3538 public void setExtrasClassLoader(ClassLoader loader) {
3539 if (mExtras != null) {
3540 mExtras.setClassLoader(loader);
3541 }
3542 }
3543
3544 /**
3545 * Returns true if an extra value is associated with the given name.
3546 * @param name the extra's name
3547 * @return true if the given extra is present.
3548 */
3549 public boolean hasExtra(String name) {
3550 return mExtras != null && mExtras.containsKey(name);
3551 }
3552
3553 /**
3554 * Returns true if the Intent's extras contain a parcelled file descriptor.
3555 * @return true if the Intent contains a parcelled file descriptor.
3556 */
3557 public boolean hasFileDescriptors() {
3558 return mExtras != null && mExtras.hasFileDescriptors();
3559 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003560
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003561 /**
3562 * Retrieve extended data from the intent.
3563 *
3564 * @param name The name of the desired item.
3565 *
3566 * @return the value of an item that previously added with putExtra()
3567 * or null if none was found.
3568 *
3569 * @deprecated
3570 * @hide
3571 */
3572 @Deprecated
3573 public Object getExtra(String name) {
3574 return getExtra(name, null);
3575 }
3576
3577 /**
3578 * Retrieve extended data from the intent.
3579 *
3580 * @param name The name of the desired item.
3581 * @param defaultValue the value to be returned if no value of the desired
3582 * type is stored with the given name.
3583 *
3584 * @return the value of an item that previously added with putExtra()
3585 * or the default value if none was found.
3586 *
3587 * @see #putExtra(String, boolean)
3588 */
3589 public boolean getBooleanExtra(String name, boolean defaultValue) {
3590 return mExtras == null ? defaultValue :
3591 mExtras.getBoolean(name, defaultValue);
3592 }
3593
3594 /**
3595 * Retrieve extended data from the intent.
3596 *
3597 * @param name The name of the desired item.
3598 * @param defaultValue the value to be returned if no value of the desired
3599 * type is stored with the given name.
3600 *
3601 * @return the value of an item that previously added with putExtra()
3602 * or the default value if none was found.
3603 *
3604 * @see #putExtra(String, byte)
3605 */
3606 public byte getByteExtra(String name, byte defaultValue) {
3607 return mExtras == null ? defaultValue :
3608 mExtras.getByte(name, defaultValue);
3609 }
3610
3611 /**
3612 * Retrieve extended data from the intent.
3613 *
3614 * @param name The name of the desired item.
3615 * @param defaultValue the value to be returned if no value of the desired
3616 * type is stored with the given name.
3617 *
3618 * @return the value of an item that previously added with putExtra()
3619 * or the default value if none was found.
3620 *
3621 * @see #putExtra(String, short)
3622 */
3623 public short getShortExtra(String name, short defaultValue) {
3624 return mExtras == null ? defaultValue :
3625 mExtras.getShort(name, defaultValue);
3626 }
3627
3628 /**
3629 * Retrieve extended data from the intent.
3630 *
3631 * @param name The name of the desired item.
3632 * @param defaultValue the value to be returned if no value of the desired
3633 * type is stored with the given name.
3634 *
3635 * @return the value of an item that previously added with putExtra()
3636 * or the default value if none was found.
3637 *
3638 * @see #putExtra(String, char)
3639 */
3640 public char getCharExtra(String name, char defaultValue) {
3641 return mExtras == null ? defaultValue :
3642 mExtras.getChar(name, defaultValue);
3643 }
3644
3645 /**
3646 * Retrieve extended data from the intent.
3647 *
3648 * @param name The name of the desired item.
3649 * @param defaultValue the value to be returned if no value of the desired
3650 * type is stored with the given name.
3651 *
3652 * @return the value of an item that previously added with putExtra()
3653 * or the default value if none was found.
3654 *
3655 * @see #putExtra(String, int)
3656 */
3657 public int getIntExtra(String name, int defaultValue) {
3658 return mExtras == null ? defaultValue :
3659 mExtras.getInt(name, defaultValue);
3660 }
3661
3662 /**
3663 * Retrieve extended data from the intent.
3664 *
3665 * @param name The name of the desired item.
3666 * @param defaultValue the value to be returned if no value of the desired
3667 * type is stored with the given name.
3668 *
3669 * @return the value of an item that previously added with putExtra()
3670 * or the default value if none was found.
3671 *
3672 * @see #putExtra(String, long)
3673 */
3674 public long getLongExtra(String name, long defaultValue) {
3675 return mExtras == null ? defaultValue :
3676 mExtras.getLong(name, defaultValue);
3677 }
3678
3679 /**
3680 * Retrieve extended data from the intent.
3681 *
3682 * @param name The name of the desired item.
3683 * @param defaultValue the value to be returned if no value of the desired
3684 * type is stored with the given name.
3685 *
3686 * @return the value of an item that previously added with putExtra(),
3687 * or the default value if no such item is present
3688 *
3689 * @see #putExtra(String, float)
3690 */
3691 public float getFloatExtra(String name, float defaultValue) {
3692 return mExtras == null ? defaultValue :
3693 mExtras.getFloat(name, defaultValue);
3694 }
3695
3696 /**
3697 * Retrieve extended data from the intent.
3698 *
3699 * @param name The name of the desired item.
3700 * @param defaultValue the value to be returned if no value of the desired
3701 * type is stored with the given name.
3702 *
3703 * @return the value of an item that previously added with putExtra()
3704 * or the default value if none was found.
3705 *
3706 * @see #putExtra(String, double)
3707 */
3708 public double getDoubleExtra(String name, double defaultValue) {
3709 return mExtras == null ? defaultValue :
3710 mExtras.getDouble(name, defaultValue);
3711 }
3712
3713 /**
3714 * Retrieve extended data from the intent.
3715 *
3716 * @param name The name of the desired item.
3717 *
3718 * @return the value of an item that previously added with putExtra()
3719 * or null if no String value was found.
3720 *
3721 * @see #putExtra(String, String)
3722 */
3723 public String getStringExtra(String name) {
3724 return mExtras == null ? null : mExtras.getString(name);
3725 }
3726
3727 /**
3728 * Retrieve extended data from the intent.
3729 *
3730 * @param name The name of the desired item.
3731 *
3732 * @return the value of an item that previously added with putExtra()
3733 * or null if no CharSequence value was found.
3734 *
3735 * @see #putExtra(String, CharSequence)
3736 */
3737 public CharSequence getCharSequenceExtra(String name) {
3738 return mExtras == null ? null : mExtras.getCharSequence(name);
3739 }
3740
3741 /**
3742 * Retrieve extended data from the intent.
3743 *
3744 * @param name The name of the desired item.
3745 *
3746 * @return the value of an item that previously added with putExtra()
3747 * or null if no Parcelable value was found.
3748 *
3749 * @see #putExtra(String, Parcelable)
3750 */
3751 public <T extends Parcelable> T getParcelableExtra(String name) {
3752 return mExtras == null ? null : mExtras.<T>getParcelable(name);
3753 }
3754
3755 /**
3756 * Retrieve extended data from the intent.
3757 *
3758 * @param name The name of the desired item.
3759 *
3760 * @return the value of an item that previously added with putExtra()
3761 * or null if no Parcelable[] value was found.
3762 *
3763 * @see #putExtra(String, Parcelable[])
3764 */
3765 public Parcelable[] getParcelableArrayExtra(String name) {
3766 return mExtras == null ? null : mExtras.getParcelableArray(name);
3767 }
3768
3769 /**
3770 * Retrieve extended data from the intent.
3771 *
3772 * @param name The name of the desired item.
3773 *
3774 * @return the value of an item that previously added with putExtra()
3775 * or null if no ArrayList<Parcelable> value was found.
3776 *
3777 * @see #putParcelableArrayListExtra(String, ArrayList)
3778 */
3779 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
3780 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
3781 }
3782
3783 /**
3784 * Retrieve extended data from the intent.
3785 *
3786 * @param name The name of the desired item.
3787 *
3788 * @return the value of an item that previously added with putExtra()
3789 * or null if no Serializable value was found.
3790 *
3791 * @see #putExtra(String, Serializable)
3792 */
3793 public Serializable getSerializableExtra(String name) {
3794 return mExtras == null ? null : mExtras.getSerializable(name);
3795 }
3796
3797 /**
3798 * Retrieve extended data from the intent.
3799 *
3800 * @param name The name of the desired item.
3801 *
3802 * @return the value of an item that previously added with putExtra()
3803 * or null if no ArrayList<Integer> value was found.
3804 *
3805 * @see #putIntegerArrayListExtra(String, ArrayList)
3806 */
3807 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
3808 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
3809 }
3810
3811 /**
3812 * Retrieve extended data from the intent.
3813 *
3814 * @param name The name of the desired item.
3815 *
3816 * @return the value of an item that previously added with putExtra()
3817 * or null if no ArrayList<String> value was found.
3818 *
3819 * @see #putStringArrayListExtra(String, ArrayList)
3820 */
3821 public ArrayList<String> getStringArrayListExtra(String name) {
3822 return mExtras == null ? null : mExtras.getStringArrayList(name);
3823 }
3824
3825 /**
3826 * Retrieve extended data from the intent.
3827 *
3828 * @param name The name of the desired item.
3829 *
3830 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003831 * or null if no ArrayList<CharSequence> value was found.
3832 *
3833 * @see #putCharSequenceArrayListExtra(String, ArrayList)
3834 */
3835 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
3836 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
3837 }
3838
3839 /**
3840 * Retrieve extended data from the intent.
3841 *
3842 * @param name The name of the desired item.
3843 *
3844 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003845 * or null if no boolean array value was found.
3846 *
3847 * @see #putExtra(String, boolean[])
3848 */
3849 public boolean[] getBooleanArrayExtra(String name) {
3850 return mExtras == null ? null : mExtras.getBooleanArray(name);
3851 }
3852
3853 /**
3854 * Retrieve extended data from the intent.
3855 *
3856 * @param name The name of the desired item.
3857 *
3858 * @return the value of an item that previously added with putExtra()
3859 * or null if no byte array value was found.
3860 *
3861 * @see #putExtra(String, byte[])
3862 */
3863 public byte[] getByteArrayExtra(String name) {
3864 return mExtras == null ? null : mExtras.getByteArray(name);
3865 }
3866
3867 /**
3868 * Retrieve extended data from the intent.
3869 *
3870 * @param name The name of the desired item.
3871 *
3872 * @return the value of an item that previously added with putExtra()
3873 * or null if no short array value was found.
3874 *
3875 * @see #putExtra(String, short[])
3876 */
3877 public short[] getShortArrayExtra(String name) {
3878 return mExtras == null ? null : mExtras.getShortArray(name);
3879 }
3880
3881 /**
3882 * Retrieve extended data from the intent.
3883 *
3884 * @param name The name of the desired item.
3885 *
3886 * @return the value of an item that previously added with putExtra()
3887 * or null if no char array value was found.
3888 *
3889 * @see #putExtra(String, char[])
3890 */
3891 public char[] getCharArrayExtra(String name) {
3892 return mExtras == null ? null : mExtras.getCharArray(name);
3893 }
3894
3895 /**
3896 * Retrieve extended data from the intent.
3897 *
3898 * @param name The name of the desired item.
3899 *
3900 * @return the value of an item that previously added with putExtra()
3901 * or null if no int array value was found.
3902 *
3903 * @see #putExtra(String, int[])
3904 */
3905 public int[] getIntArrayExtra(String name) {
3906 return mExtras == null ? null : mExtras.getIntArray(name);
3907 }
3908
3909 /**
3910 * Retrieve extended data from the intent.
3911 *
3912 * @param name The name of the desired item.
3913 *
3914 * @return the value of an item that previously added with putExtra()
3915 * or null if no long array value was found.
3916 *
3917 * @see #putExtra(String, long[])
3918 */
3919 public long[] getLongArrayExtra(String name) {
3920 return mExtras == null ? null : mExtras.getLongArray(name);
3921 }
3922
3923 /**
3924 * Retrieve extended data from the intent.
3925 *
3926 * @param name The name of the desired item.
3927 *
3928 * @return the value of an item that previously added with putExtra()
3929 * or null if no float array value was found.
3930 *
3931 * @see #putExtra(String, float[])
3932 */
3933 public float[] getFloatArrayExtra(String name) {
3934 return mExtras == null ? null : mExtras.getFloatArray(name);
3935 }
3936
3937 /**
3938 * Retrieve extended data from the intent.
3939 *
3940 * @param name The name of the desired item.
3941 *
3942 * @return the value of an item that previously added with putExtra()
3943 * or null if no double array value was found.
3944 *
3945 * @see #putExtra(String, double[])
3946 */
3947 public double[] getDoubleArrayExtra(String name) {
3948 return mExtras == null ? null : mExtras.getDoubleArray(name);
3949 }
3950
3951 /**
3952 * Retrieve extended data from the intent.
3953 *
3954 * @param name The name of the desired item.
3955 *
3956 * @return the value of an item that previously added with putExtra()
3957 * or null if no String array value was found.
3958 *
3959 * @see #putExtra(String, String[])
3960 */
3961 public String[] getStringArrayExtra(String name) {
3962 return mExtras == null ? null : mExtras.getStringArray(name);
3963 }
3964
3965 /**
3966 * Retrieve extended data from the intent.
3967 *
3968 * @param name The name of the desired item.
3969 *
3970 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00003971 * or null if no CharSequence array value was found.
3972 *
3973 * @see #putExtra(String, CharSequence[])
3974 */
3975 public CharSequence[] getCharSequenceArrayExtra(String name) {
3976 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
3977 }
3978
3979 /**
3980 * Retrieve extended data from the intent.
3981 *
3982 * @param name The name of the desired item.
3983 *
3984 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003985 * or null if no Bundle value was found.
3986 *
3987 * @see #putExtra(String, Bundle)
3988 */
3989 public Bundle getBundleExtra(String name) {
3990 return mExtras == null ? null : mExtras.getBundle(name);
3991 }
3992
3993 /**
3994 * Retrieve extended data from the intent.
3995 *
3996 * @param name The name of the desired item.
3997 *
3998 * @return the value of an item that previously added with putExtra()
3999 * or null if no IBinder value was found.
4000 *
4001 * @see #putExtra(String, IBinder)
4002 *
4003 * @deprecated
4004 * @hide
4005 */
4006 @Deprecated
4007 public IBinder getIBinderExtra(String name) {
4008 return mExtras == null ? null : mExtras.getIBinder(name);
4009 }
4010
4011 /**
4012 * Retrieve extended data from the intent.
4013 *
4014 * @param name The name of the desired item.
4015 * @param defaultValue The default value to return in case no item is
4016 * associated with the key 'name'
4017 *
4018 * @return the value of an item that previously added with putExtra()
4019 * or defaultValue if none was found.
4020 *
4021 * @see #putExtra
4022 *
4023 * @deprecated
4024 * @hide
4025 */
4026 @Deprecated
4027 public Object getExtra(String name, Object defaultValue) {
4028 Object result = defaultValue;
4029 if (mExtras != null) {
4030 Object result2 = mExtras.get(name);
4031 if (result2 != null) {
4032 result = result2;
4033 }
4034 }
4035
4036 return result;
4037 }
4038
4039 /**
4040 * Retrieves a map of extended data from the intent.
4041 *
4042 * @return the map of all extras previously added with putExtra(),
4043 * or null if none have been added.
4044 */
4045 public Bundle getExtras() {
4046 return (mExtras != null)
4047 ? new Bundle(mExtras)
4048 : null;
4049 }
4050
4051 /**
4052 * Retrieve any special flags associated with this intent. You will
4053 * normally just set them with {@link #setFlags} and let the system
4054 * take the appropriate action with them.
4055 *
4056 * @return int The currently set flags.
4057 *
4058 * @see #setFlags
4059 */
4060 public int getFlags() {
4061 return mFlags;
4062 }
4063
Dianne Hackborne7f97212011-02-24 14:40:20 -08004064 /** @hide */
4065 public boolean isExcludingStopped() {
4066 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4067 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4068 }
4069
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004070 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004071 * Retrieve the application package name this Intent is limited to. When
4072 * resolving an Intent, if non-null this limits the resolution to only
4073 * components in the given application package.
4074 *
4075 * @return The name of the application package for the Intent.
4076 *
4077 * @see #resolveActivity
4078 * @see #setPackage
4079 */
4080 public String getPackage() {
4081 return mPackage;
4082 }
4083
4084 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004085 * Retrieve the concrete component associated with the intent. When receiving
4086 * an intent, this is the component that was found to best handle it (that is,
4087 * yourself) and will always be non-null; in all other cases it will be
4088 * null unless explicitly set.
4089 *
4090 * @return The name of the application component to handle the intent.
4091 *
4092 * @see #resolveActivity
4093 * @see #setComponent
4094 */
4095 public ComponentName getComponent() {
4096 return mComponent;
4097 }
4098
4099 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004100 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4101 * used as a hint to the receiver for animations and the like. Null means that there
4102 * is no source bounds.
4103 */
4104 public Rect getSourceBounds() {
4105 return mSourceBounds;
4106 }
4107
4108 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004109 * Return the Activity component that should be used to handle this intent.
4110 * The appropriate component is determined based on the information in the
4111 * intent, evaluated as follows:
4112 *
4113 * <p>If {@link #getComponent} returns an explicit class, that is returned
4114 * without any further consideration.
4115 *
4116 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4117 * category to be considered.
4118 *
4119 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4120 * action.
4121 *
4122 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4123 * this type.
4124 *
4125 * <p>If {@link #addCategory} has added any categories, the activity must
4126 * handle ALL of the categories specified.
4127 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004128 * <p>If {@link #getPackage} is non-NULL, only activity components in
4129 * that application package will be considered.
4130 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004131 * <p>If there are no activities that satisfy all of these conditions, a
4132 * null string is returned.
4133 *
4134 * <p>If multiple activities are found to satisfy the intent, the one with
4135 * the highest priority will be used. If there are multiple activities
4136 * with the same priority, the system will either pick the best activity
4137 * based on user preference, or resolve to a system class that will allow
4138 * the user to pick an activity and forward from there.
4139 *
4140 * <p>This method is implemented simply by calling
4141 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4142 * true.</p>
4143 * <p> This API is called for you as part of starting an activity from an
4144 * intent. You do not normally need to call it yourself.</p>
4145 *
4146 * @param pm The package manager with which to resolve the Intent.
4147 *
4148 * @return Name of the component implementing an activity that can
4149 * display the intent.
4150 *
4151 * @see #setComponent
4152 * @see #getComponent
4153 * @see #resolveActivityInfo
4154 */
4155 public ComponentName resolveActivity(PackageManager pm) {
4156 if (mComponent != null) {
4157 return mComponent;
4158 }
4159
4160 ResolveInfo info = pm.resolveActivity(
4161 this, PackageManager.MATCH_DEFAULT_ONLY);
4162 if (info != null) {
4163 return new ComponentName(
4164 info.activityInfo.applicationInfo.packageName,
4165 info.activityInfo.name);
4166 }
4167
4168 return null;
4169 }
4170
4171 /**
4172 * Resolve the Intent into an {@link ActivityInfo}
4173 * describing the activity that should execute the intent. Resolution
4174 * follows the same rules as described for {@link #resolveActivity}, but
4175 * you get back the completely information about the resolved activity
4176 * instead of just its class name.
4177 *
4178 * @param pm The package manager with which to resolve the Intent.
4179 * @param flags Addition information to retrieve as per
4180 * {@link PackageManager#getActivityInfo(ComponentName, int)
4181 * PackageManager.getActivityInfo()}.
4182 *
4183 * @return PackageManager.ActivityInfo
4184 *
4185 * @see #resolveActivity
4186 */
4187 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4188 ActivityInfo ai = null;
4189 if (mComponent != null) {
4190 try {
4191 ai = pm.getActivityInfo(mComponent, flags);
4192 } catch (PackageManager.NameNotFoundException e) {
4193 // ignore
4194 }
4195 } else {
4196 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004197 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004198 if (info != null) {
4199 ai = info.activityInfo;
4200 }
4201 }
4202
4203 return ai;
4204 }
4205
4206 /**
4207 * Set the general action to be performed.
4208 *
4209 * @param action An action name, such as ACTION_VIEW. Application-specific
4210 * actions should be prefixed with the vendor's package name.
4211 *
4212 * @return Returns the same Intent object, for chaining multiple calls
4213 * into a single statement.
4214 *
4215 * @see #getAction
4216 */
4217 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004218 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004219 return this;
4220 }
4221
4222 /**
4223 * Set the data this intent is operating on. This method automatically
4224 * clears any type that was previously set by {@link #setType}.
4225 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004226 * <p><em>Note: scheme and host name matching in the Android framework is
4227 * case-sensitive, unlike the formal RFC. As a result,
4228 * you should always ensure that you write your Uri with these elements
4229 * using lower case letters, and normalize any Uris you receive from
4230 * outside of Android to ensure the scheme and host is lower case.</em></p>
4231 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004232 * @param data The URI of the data this intent is now targeting.
4233 *
4234 * @return Returns the same Intent object, for chaining multiple calls
4235 * into a single statement.
4236 *
4237 * @see #getData
4238 * @see #setType
4239 * @see #setDataAndType
4240 */
4241 public Intent setData(Uri data) {
4242 mData = data;
4243 mType = null;
4244 return this;
4245 }
4246
4247 /**
4248 * Set an explicit MIME data type. This is used to create intents that
4249 * only specify a type and not data, for example to indicate the type of
4250 * data to return. This method automatically clears any data that was
4251 * previously set by {@link #setData}.
Romain Guy4969af72009-06-17 10:53:19 -07004252 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004253 * <p><em>Note: MIME type matching in the Android framework is
4254 * case-sensitive, unlike formal RFC MIME types. As a result,
4255 * you should always write your MIME types with lower case letters,
4256 * and any MIME types you receive from outside of Android should be
4257 * converted to lower case before supplying them here.</em></p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004258 *
4259 * @param type The MIME type of the data being handled by this intent.
4260 *
4261 * @return Returns the same Intent object, for chaining multiple calls
4262 * into a single statement.
4263 *
4264 * @see #getType
4265 * @see #setData
4266 * @see #setDataAndType
4267 */
4268 public Intent setType(String type) {
4269 mData = null;
4270 mType = type;
4271 return this;
4272 }
4273
4274 /**
4275 * (Usually optional) Set the data for the intent along with an explicit
4276 * MIME data type. This method should very rarely be used -- it allows you
4277 * to override the MIME type that would ordinarily be inferred from the
4278 * data with your own type given here.
4279 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004280 * <p><em>Note: MIME type, Uri scheme, and host name matching in the
4281 * Android framework is case-sensitive, unlike the formal RFC definitions.
4282 * As a result, you should always write these elements with lower case letters,
4283 * and normalize any MIME types or Uris you receive from
4284 * outside of Android to ensure these elements are lower case before
4285 * supplying them here.</em></p>
4286 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004287 * @param data The URI of the data this intent is now targeting.
4288 * @param type The MIME type of the data being handled by this intent.
4289 *
4290 * @return Returns the same Intent object, for chaining multiple calls
4291 * into a single statement.
4292 *
4293 * @see #setData
4294 * @see #setType
4295 */
4296 public Intent setDataAndType(Uri data, String type) {
4297 mData = data;
4298 mType = type;
4299 return this;
4300 }
4301
4302 /**
4303 * Add a new category to the intent. Categories provide additional detail
4304 * about the action the intent is perform. When resolving an intent, only
4305 * activities that provide <em>all</em> of the requested categories will be
4306 * used.
4307 *
4308 * @param category The desired category. This can be either one of the
4309 * predefined Intent categories, or a custom category in your own
4310 * namespace.
4311 *
4312 * @return Returns the same Intent object, for chaining multiple calls
4313 * into a single statement.
4314 *
4315 * @see #hasCategory
4316 * @see #removeCategory
4317 */
4318 public Intent addCategory(String category) {
4319 if (mCategories == null) {
4320 mCategories = new HashSet<String>();
4321 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004322 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004323 return this;
4324 }
4325
4326 /**
4327 * Remove an category from an intent.
4328 *
4329 * @param category The category to remove.
4330 *
4331 * @see #addCategory
4332 */
4333 public void removeCategory(String category) {
4334 if (mCategories != null) {
4335 mCategories.remove(category);
4336 if (mCategories.size() == 0) {
4337 mCategories = null;
4338 }
4339 }
4340 }
4341
4342 /**
4343 * Add extended data to the intent. The name must include a package
4344 * prefix, for example the app com.android.contacts would use names
4345 * like "com.android.contacts.ShowAll".
4346 *
4347 * @param name The name of the extra data, with package prefix.
4348 * @param value The boolean data value.
4349 *
4350 * @return Returns the same Intent object, for chaining multiple calls
4351 * into a single statement.
4352 *
4353 * @see #putExtras
4354 * @see #removeExtra
4355 * @see #getBooleanExtra(String, boolean)
4356 */
4357 public Intent putExtra(String name, boolean value) {
4358 if (mExtras == null) {
4359 mExtras = new Bundle();
4360 }
4361 mExtras.putBoolean(name, value);
4362 return this;
4363 }
4364
4365 /**
4366 * Add extended data to the intent. The name must include a package
4367 * prefix, for example the app com.android.contacts would use names
4368 * like "com.android.contacts.ShowAll".
4369 *
4370 * @param name The name of the extra data, with package prefix.
4371 * @param value The byte data value.
4372 *
4373 * @return Returns the same Intent object, for chaining multiple calls
4374 * into a single statement.
4375 *
4376 * @see #putExtras
4377 * @see #removeExtra
4378 * @see #getByteExtra(String, byte)
4379 */
4380 public Intent putExtra(String name, byte value) {
4381 if (mExtras == null) {
4382 mExtras = new Bundle();
4383 }
4384 mExtras.putByte(name, value);
4385 return this;
4386 }
4387
4388 /**
4389 * Add extended data to the intent. The name must include a package
4390 * prefix, for example the app com.android.contacts would use names
4391 * like "com.android.contacts.ShowAll".
4392 *
4393 * @param name The name of the extra data, with package prefix.
4394 * @param value The char data value.
4395 *
4396 * @return Returns the same Intent object, for chaining multiple calls
4397 * into a single statement.
4398 *
4399 * @see #putExtras
4400 * @see #removeExtra
4401 * @see #getCharExtra(String, char)
4402 */
4403 public Intent putExtra(String name, char value) {
4404 if (mExtras == null) {
4405 mExtras = new Bundle();
4406 }
4407 mExtras.putChar(name, value);
4408 return this;
4409 }
4410
4411 /**
4412 * Add extended data to the intent. The name must include a package
4413 * prefix, for example the app com.android.contacts would use names
4414 * like "com.android.contacts.ShowAll".
4415 *
4416 * @param name The name of the extra data, with package prefix.
4417 * @param value The short data value.
4418 *
4419 * @return Returns the same Intent object, for chaining multiple calls
4420 * into a single statement.
4421 *
4422 * @see #putExtras
4423 * @see #removeExtra
4424 * @see #getShortExtra(String, short)
4425 */
4426 public Intent putExtra(String name, short value) {
4427 if (mExtras == null) {
4428 mExtras = new Bundle();
4429 }
4430 mExtras.putShort(name, value);
4431 return this;
4432 }
4433
4434 /**
4435 * Add extended data to the intent. The name must include a package
4436 * prefix, for example the app com.android.contacts would use names
4437 * like "com.android.contacts.ShowAll".
4438 *
4439 * @param name The name of the extra data, with package prefix.
4440 * @param value The integer data value.
4441 *
4442 * @return Returns the same Intent object, for chaining multiple calls
4443 * into a single statement.
4444 *
4445 * @see #putExtras
4446 * @see #removeExtra
4447 * @see #getIntExtra(String, int)
4448 */
4449 public Intent putExtra(String name, int value) {
4450 if (mExtras == null) {
4451 mExtras = new Bundle();
4452 }
4453 mExtras.putInt(name, value);
4454 return this;
4455 }
4456
4457 /**
4458 * Add extended data to the intent. The name must include a package
4459 * prefix, for example the app com.android.contacts would use names
4460 * like "com.android.contacts.ShowAll".
4461 *
4462 * @param name The name of the extra data, with package prefix.
4463 * @param value The long data value.
4464 *
4465 * @return Returns the same Intent object, for chaining multiple calls
4466 * into a single statement.
4467 *
4468 * @see #putExtras
4469 * @see #removeExtra
4470 * @see #getLongExtra(String, long)
4471 */
4472 public Intent putExtra(String name, long value) {
4473 if (mExtras == null) {
4474 mExtras = new Bundle();
4475 }
4476 mExtras.putLong(name, value);
4477 return this;
4478 }
4479
4480 /**
4481 * Add extended data to the intent. The name must include a package
4482 * prefix, for example the app com.android.contacts would use names
4483 * like "com.android.contacts.ShowAll".
4484 *
4485 * @param name The name of the extra data, with package prefix.
4486 * @param value The float data value.
4487 *
4488 * @return Returns the same Intent object, for chaining multiple calls
4489 * into a single statement.
4490 *
4491 * @see #putExtras
4492 * @see #removeExtra
4493 * @see #getFloatExtra(String, float)
4494 */
4495 public Intent putExtra(String name, float value) {
4496 if (mExtras == null) {
4497 mExtras = new Bundle();
4498 }
4499 mExtras.putFloat(name, value);
4500 return this;
4501 }
4502
4503 /**
4504 * Add extended data to the intent. The name must include a package
4505 * prefix, for example the app com.android.contacts would use names
4506 * like "com.android.contacts.ShowAll".
4507 *
4508 * @param name The name of the extra data, with package prefix.
4509 * @param value The double data value.
4510 *
4511 * @return Returns the same Intent object, for chaining multiple calls
4512 * into a single statement.
4513 *
4514 * @see #putExtras
4515 * @see #removeExtra
4516 * @see #getDoubleExtra(String, double)
4517 */
4518 public Intent putExtra(String name, double value) {
4519 if (mExtras == null) {
4520 mExtras = new Bundle();
4521 }
4522 mExtras.putDouble(name, value);
4523 return this;
4524 }
4525
4526 /**
4527 * Add extended data to the intent. The name must include a package
4528 * prefix, for example the app com.android.contacts would use names
4529 * like "com.android.contacts.ShowAll".
4530 *
4531 * @param name The name of the extra data, with package prefix.
4532 * @param value The String data value.
4533 *
4534 * @return Returns the same Intent object, for chaining multiple calls
4535 * into a single statement.
4536 *
4537 * @see #putExtras
4538 * @see #removeExtra
4539 * @see #getStringExtra(String)
4540 */
4541 public Intent putExtra(String name, String value) {
4542 if (mExtras == null) {
4543 mExtras = new Bundle();
4544 }
4545 mExtras.putString(name, value);
4546 return this;
4547 }
4548
4549 /**
4550 * Add extended data to the intent. The name must include a package
4551 * prefix, for example the app com.android.contacts would use names
4552 * like "com.android.contacts.ShowAll".
4553 *
4554 * @param name The name of the extra data, with package prefix.
4555 * @param value The CharSequence data value.
4556 *
4557 * @return Returns the same Intent object, for chaining multiple calls
4558 * into a single statement.
4559 *
4560 * @see #putExtras
4561 * @see #removeExtra
4562 * @see #getCharSequenceExtra(String)
4563 */
4564 public Intent putExtra(String name, CharSequence value) {
4565 if (mExtras == null) {
4566 mExtras = new Bundle();
4567 }
4568 mExtras.putCharSequence(name, value);
4569 return this;
4570 }
4571
4572 /**
4573 * Add extended data to the intent. The name must include a package
4574 * prefix, for example the app com.android.contacts would use names
4575 * like "com.android.contacts.ShowAll".
4576 *
4577 * @param name The name of the extra data, with package prefix.
4578 * @param value The Parcelable data value.
4579 *
4580 * @return Returns the same Intent object, for chaining multiple calls
4581 * into a single statement.
4582 *
4583 * @see #putExtras
4584 * @see #removeExtra
4585 * @see #getParcelableExtra(String)
4586 */
4587 public Intent putExtra(String name, Parcelable value) {
4588 if (mExtras == null) {
4589 mExtras = new Bundle();
4590 }
4591 mExtras.putParcelable(name, value);
4592 return this;
4593 }
4594
4595 /**
4596 * Add extended data to the intent. The name must include a package
4597 * prefix, for example the app com.android.contacts would use names
4598 * like "com.android.contacts.ShowAll".
4599 *
4600 * @param name The name of the extra data, with package prefix.
4601 * @param value The Parcelable[] data value.
4602 *
4603 * @return Returns the same Intent object, for chaining multiple calls
4604 * into a single statement.
4605 *
4606 * @see #putExtras
4607 * @see #removeExtra
4608 * @see #getParcelableArrayExtra(String)
4609 */
4610 public Intent putExtra(String name, Parcelable[] value) {
4611 if (mExtras == null) {
4612 mExtras = new Bundle();
4613 }
4614 mExtras.putParcelableArray(name, value);
4615 return this;
4616 }
4617
4618 /**
4619 * Add extended data to the intent. The name must include a package
4620 * prefix, for example the app com.android.contacts would use names
4621 * like "com.android.contacts.ShowAll".
4622 *
4623 * @param name The name of the extra data, with package prefix.
4624 * @param value The ArrayList<Parcelable> data value.
4625 *
4626 * @return Returns the same Intent object, for chaining multiple calls
4627 * into a single statement.
4628 *
4629 * @see #putExtras
4630 * @see #removeExtra
4631 * @see #getParcelableArrayListExtra(String)
4632 */
4633 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
4634 if (mExtras == null) {
4635 mExtras = new Bundle();
4636 }
4637 mExtras.putParcelableArrayList(name, value);
4638 return this;
4639 }
4640
4641 /**
4642 * Add extended data to the intent. The name must include a package
4643 * prefix, for example the app com.android.contacts would use names
4644 * like "com.android.contacts.ShowAll".
4645 *
4646 * @param name The name of the extra data, with package prefix.
4647 * @param value The ArrayList<Integer> data value.
4648 *
4649 * @return Returns the same Intent object, for chaining multiple calls
4650 * into a single statement.
4651 *
4652 * @see #putExtras
4653 * @see #removeExtra
4654 * @see #getIntegerArrayListExtra(String)
4655 */
4656 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
4657 if (mExtras == null) {
4658 mExtras = new Bundle();
4659 }
4660 mExtras.putIntegerArrayList(name, value);
4661 return this;
4662 }
4663
4664 /**
4665 * Add extended data to the intent. The name must include a package
4666 * prefix, for example the app com.android.contacts would use names
4667 * like "com.android.contacts.ShowAll".
4668 *
4669 * @param name The name of the extra data, with package prefix.
4670 * @param value The ArrayList<String> data value.
4671 *
4672 * @return Returns the same Intent object, for chaining multiple calls
4673 * into a single statement.
4674 *
4675 * @see #putExtras
4676 * @see #removeExtra
4677 * @see #getStringArrayListExtra(String)
4678 */
4679 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
4680 if (mExtras == null) {
4681 mExtras = new Bundle();
4682 }
4683 mExtras.putStringArrayList(name, value);
4684 return this;
4685 }
4686
4687 /**
4688 * Add extended data to the intent. The name must include a package
4689 * prefix, for example the app com.android.contacts would use names
4690 * like "com.android.contacts.ShowAll".
4691 *
4692 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004693 * @param value The ArrayList<CharSequence> data value.
4694 *
4695 * @return Returns the same Intent object, for chaining multiple calls
4696 * into a single statement.
4697 *
4698 * @see #putExtras
4699 * @see #removeExtra
4700 * @see #getCharSequenceArrayListExtra(String)
4701 */
4702 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
4703 if (mExtras == null) {
4704 mExtras = new Bundle();
4705 }
4706 mExtras.putCharSequenceArrayList(name, value);
4707 return this;
4708 }
4709
4710 /**
4711 * Add extended data to the intent. The name must include a package
4712 * prefix, for example the app com.android.contacts would use names
4713 * like "com.android.contacts.ShowAll".
4714 *
4715 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004716 * @param value The Serializable data value.
4717 *
4718 * @return Returns the same Intent object, for chaining multiple calls
4719 * into a single statement.
4720 *
4721 * @see #putExtras
4722 * @see #removeExtra
4723 * @see #getSerializableExtra(String)
4724 */
4725 public Intent putExtra(String name, Serializable value) {
4726 if (mExtras == null) {
4727 mExtras = new Bundle();
4728 }
4729 mExtras.putSerializable(name, value);
4730 return this;
4731 }
4732
4733 /**
4734 * Add extended data to the intent. The name must include a package
4735 * prefix, for example the app com.android.contacts would use names
4736 * like "com.android.contacts.ShowAll".
4737 *
4738 * @param name The name of the extra data, with package prefix.
4739 * @param value The boolean array data value.
4740 *
4741 * @return Returns the same Intent object, for chaining multiple calls
4742 * into a single statement.
4743 *
4744 * @see #putExtras
4745 * @see #removeExtra
4746 * @see #getBooleanArrayExtra(String)
4747 */
4748 public Intent putExtra(String name, boolean[] value) {
4749 if (mExtras == null) {
4750 mExtras = new Bundle();
4751 }
4752 mExtras.putBooleanArray(name, value);
4753 return this;
4754 }
4755
4756 /**
4757 * Add extended data to the intent. The name must include a package
4758 * prefix, for example the app com.android.contacts would use names
4759 * like "com.android.contacts.ShowAll".
4760 *
4761 * @param name The name of the extra data, with package prefix.
4762 * @param value The byte array data value.
4763 *
4764 * @return Returns the same Intent object, for chaining multiple calls
4765 * into a single statement.
4766 *
4767 * @see #putExtras
4768 * @see #removeExtra
4769 * @see #getByteArrayExtra(String)
4770 */
4771 public Intent putExtra(String name, byte[] value) {
4772 if (mExtras == null) {
4773 mExtras = new Bundle();
4774 }
4775 mExtras.putByteArray(name, value);
4776 return this;
4777 }
4778
4779 /**
4780 * Add extended data to the intent. The name must include a package
4781 * prefix, for example the app com.android.contacts would use names
4782 * like "com.android.contacts.ShowAll".
4783 *
4784 * @param name The name of the extra data, with package prefix.
4785 * @param value The short array data value.
4786 *
4787 * @return Returns the same Intent object, for chaining multiple calls
4788 * into a single statement.
4789 *
4790 * @see #putExtras
4791 * @see #removeExtra
4792 * @see #getShortArrayExtra(String)
4793 */
4794 public Intent putExtra(String name, short[] value) {
4795 if (mExtras == null) {
4796 mExtras = new Bundle();
4797 }
4798 mExtras.putShortArray(name, value);
4799 return this;
4800 }
4801
4802 /**
4803 * Add extended data to the intent. The name must include a package
4804 * prefix, for example the app com.android.contacts would use names
4805 * like "com.android.contacts.ShowAll".
4806 *
4807 * @param name The name of the extra data, with package prefix.
4808 * @param value The char array data value.
4809 *
4810 * @return Returns the same Intent object, for chaining multiple calls
4811 * into a single statement.
4812 *
4813 * @see #putExtras
4814 * @see #removeExtra
4815 * @see #getCharArrayExtra(String)
4816 */
4817 public Intent putExtra(String name, char[] value) {
4818 if (mExtras == null) {
4819 mExtras = new Bundle();
4820 }
4821 mExtras.putCharArray(name, value);
4822 return this;
4823 }
4824
4825 /**
4826 * Add extended data to the intent. The name must include a package
4827 * prefix, for example the app com.android.contacts would use names
4828 * like "com.android.contacts.ShowAll".
4829 *
4830 * @param name The name of the extra data, with package prefix.
4831 * @param value The int array data value.
4832 *
4833 * @return Returns the same Intent object, for chaining multiple calls
4834 * into a single statement.
4835 *
4836 * @see #putExtras
4837 * @see #removeExtra
4838 * @see #getIntArrayExtra(String)
4839 */
4840 public Intent putExtra(String name, int[] value) {
4841 if (mExtras == null) {
4842 mExtras = new Bundle();
4843 }
4844 mExtras.putIntArray(name, value);
4845 return this;
4846 }
4847
4848 /**
4849 * Add extended data to the intent. The name must include a package
4850 * prefix, for example the app com.android.contacts would use names
4851 * like "com.android.contacts.ShowAll".
4852 *
4853 * @param name The name of the extra data, with package prefix.
4854 * @param value The byte array data value.
4855 *
4856 * @return Returns the same Intent object, for chaining multiple calls
4857 * into a single statement.
4858 *
4859 * @see #putExtras
4860 * @see #removeExtra
4861 * @see #getLongArrayExtra(String)
4862 */
4863 public Intent putExtra(String name, long[] value) {
4864 if (mExtras == null) {
4865 mExtras = new Bundle();
4866 }
4867 mExtras.putLongArray(name, value);
4868 return this;
4869 }
4870
4871 /**
4872 * Add extended data to the intent. The name must include a package
4873 * prefix, for example the app com.android.contacts would use names
4874 * like "com.android.contacts.ShowAll".
4875 *
4876 * @param name The name of the extra data, with package prefix.
4877 * @param value The float array data value.
4878 *
4879 * @return Returns the same Intent object, for chaining multiple calls
4880 * into a single statement.
4881 *
4882 * @see #putExtras
4883 * @see #removeExtra
4884 * @see #getFloatArrayExtra(String)
4885 */
4886 public Intent putExtra(String name, float[] value) {
4887 if (mExtras == null) {
4888 mExtras = new Bundle();
4889 }
4890 mExtras.putFloatArray(name, value);
4891 return this;
4892 }
4893
4894 /**
4895 * Add extended data to the intent. The name must include a package
4896 * prefix, for example the app com.android.contacts would use names
4897 * like "com.android.contacts.ShowAll".
4898 *
4899 * @param name The name of the extra data, with package prefix.
4900 * @param value The double array data value.
4901 *
4902 * @return Returns the same Intent object, for chaining multiple calls
4903 * into a single statement.
4904 *
4905 * @see #putExtras
4906 * @see #removeExtra
4907 * @see #getDoubleArrayExtra(String)
4908 */
4909 public Intent putExtra(String name, double[] value) {
4910 if (mExtras == null) {
4911 mExtras = new Bundle();
4912 }
4913 mExtras.putDoubleArray(name, value);
4914 return this;
4915 }
4916
4917 /**
4918 * Add extended data to the intent. The name must include a package
4919 * prefix, for example the app com.android.contacts would use names
4920 * like "com.android.contacts.ShowAll".
4921 *
4922 * @param name The name of the extra data, with package prefix.
4923 * @param value The String array data value.
4924 *
4925 * @return Returns the same Intent object, for chaining multiple calls
4926 * into a single statement.
4927 *
4928 * @see #putExtras
4929 * @see #removeExtra
4930 * @see #getStringArrayExtra(String)
4931 */
4932 public Intent putExtra(String name, String[] value) {
4933 if (mExtras == null) {
4934 mExtras = new Bundle();
4935 }
4936 mExtras.putStringArray(name, value);
4937 return this;
4938 }
4939
4940 /**
4941 * Add extended data to the intent. The name must include a package
4942 * prefix, for example the app com.android.contacts would use names
4943 * like "com.android.contacts.ShowAll".
4944 *
4945 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004946 * @param value The CharSequence array data value.
4947 *
4948 * @return Returns the same Intent object, for chaining multiple calls
4949 * into a single statement.
4950 *
4951 * @see #putExtras
4952 * @see #removeExtra
4953 * @see #getCharSequenceArrayExtra(String)
4954 */
4955 public Intent putExtra(String name, CharSequence[] value) {
4956 if (mExtras == null) {
4957 mExtras = new Bundle();
4958 }
4959 mExtras.putCharSequenceArray(name, value);
4960 return this;
4961 }
4962
4963 /**
4964 * Add extended data to the intent. The name must include a package
4965 * prefix, for example the app com.android.contacts would use names
4966 * like "com.android.contacts.ShowAll".
4967 *
4968 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004969 * @param value The Bundle data value.
4970 *
4971 * @return Returns the same Intent object, for chaining multiple calls
4972 * into a single statement.
4973 *
4974 * @see #putExtras
4975 * @see #removeExtra
4976 * @see #getBundleExtra(String)
4977 */
4978 public Intent putExtra(String name, Bundle value) {
4979 if (mExtras == null) {
4980 mExtras = new Bundle();
4981 }
4982 mExtras.putBundle(name, value);
4983 return this;
4984 }
4985
4986 /**
4987 * Add extended data to the intent. The name must include a package
4988 * prefix, for example the app com.android.contacts would use names
4989 * like "com.android.contacts.ShowAll".
4990 *
4991 * @param name The name of the extra data, with package prefix.
4992 * @param value The IBinder data value.
4993 *
4994 * @return Returns the same Intent object, for chaining multiple calls
4995 * into a single statement.
4996 *
4997 * @see #putExtras
4998 * @see #removeExtra
4999 * @see #getIBinderExtra(String)
5000 *
5001 * @deprecated
5002 * @hide
5003 */
5004 @Deprecated
5005 public Intent putExtra(String name, IBinder value) {
5006 if (mExtras == null) {
5007 mExtras = new Bundle();
5008 }
5009 mExtras.putIBinder(name, value);
5010 return this;
5011 }
5012
5013 /**
5014 * Copy all extras in 'src' in to this intent.
5015 *
5016 * @param src Contains the extras to copy.
5017 *
5018 * @see #putExtra
5019 */
5020 public Intent putExtras(Intent src) {
5021 if (src.mExtras != null) {
5022 if (mExtras == null) {
5023 mExtras = new Bundle(src.mExtras);
5024 } else {
5025 mExtras.putAll(src.mExtras);
5026 }
5027 }
5028 return this;
5029 }
5030
5031 /**
5032 * Add a set of extended data to the intent. The keys must include a package
5033 * prefix, for example the app com.android.contacts would use names
5034 * like "com.android.contacts.ShowAll".
5035 *
5036 * @param extras The Bundle of extras to add to this intent.
5037 *
5038 * @see #putExtra
5039 * @see #removeExtra
5040 */
5041 public Intent putExtras(Bundle extras) {
5042 if (mExtras == null) {
5043 mExtras = new Bundle();
5044 }
5045 mExtras.putAll(extras);
5046 return this;
5047 }
5048
5049 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005050 * Completely replace the extras in the Intent with the extras in the
5051 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005052 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005053 * @param src The exact extras contained in this Intent are copied
5054 * into the target intent, replacing any that were previously there.
5055 */
5056 public Intent replaceExtras(Intent src) {
5057 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5058 return this;
5059 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005060
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005061 /**
5062 * Completely replace the extras in the Intent with the given Bundle of
5063 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005064 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005065 * @param extras The new set of extras in the Intent, or null to erase
5066 * all extras.
5067 */
5068 public Intent replaceExtras(Bundle extras) {
5069 mExtras = extras != null ? new Bundle(extras) : 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 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 * Remove extended data from the intent.
5075 *
5076 * @see #putExtra
5077 */
5078 public void removeExtra(String name) {
5079 if (mExtras != null) {
5080 mExtras.remove(name);
5081 if (mExtras.size() == 0) {
5082 mExtras = null;
5083 }
5084 }
5085 }
5086
5087 /**
5088 * Set special flags controlling how this intent is handled. Most values
5089 * here depend on the type of component being executed by the Intent,
5090 * specifically the FLAG_ACTIVITY_* flags are all for use with
5091 * {@link Context#startActivity Context.startActivity()} and the
5092 * FLAG_RECEIVER_* flags are all for use with
5093 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5094 *
Scott Main7aee61f2011-02-08 11:25:01 -08005095 * <p>See the
5096 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5097 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005098 * the behavior of your application.
5099 *
5100 * @param flags The desired flags.
5101 *
5102 * @return Returns the same Intent object, for chaining multiple calls
5103 * into a single statement.
5104 *
5105 * @see #getFlags
5106 * @see #addFlags
5107 *
5108 * @see #FLAG_GRANT_READ_URI_PERMISSION
5109 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5110 * @see #FLAG_DEBUG_LOG_RESOLUTION
5111 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005112 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005113 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005114 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005115 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005116 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5117 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005118 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005119 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5120 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005121 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005122 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005123 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005124 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5125 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005126 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005127 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005128 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005129 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5130 */
5131 public Intent setFlags(int flags) {
5132 mFlags = flags;
5133 return this;
5134 }
5135
5136 /**
5137 * Add additional flags to the intent (or with existing flags
5138 * value).
5139 *
5140 * @param flags The new flags to set.
5141 *
5142 * @return Returns the same Intent object, for chaining multiple calls
5143 * into a single statement.
5144 *
5145 * @see #setFlags
5146 */
5147 public Intent addFlags(int flags) {
5148 mFlags |= flags;
5149 return this;
5150 }
5151
5152 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005153 * (Usually optional) Set an explicit application package name that limits
5154 * the components this Intent will resolve to. If left to the default
5155 * value of null, all components in all applications will considered.
5156 * If non-null, the Intent can only match the components in the given
5157 * application package.
5158 *
5159 * @param packageName The name of the application package to handle the
5160 * intent, or null to allow any application package.
5161 *
5162 * @return Returns the same Intent object, for chaining multiple calls
5163 * into a single statement.
5164 *
5165 * @see #getPackage
5166 * @see #resolveActivity
5167 */
5168 public Intent setPackage(String packageName) {
5169 mPackage = packageName;
5170 return this;
5171 }
5172
5173 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005174 * (Usually optional) Explicitly set the component to handle the intent.
5175 * If left with the default value of null, the system will determine the
5176 * appropriate class to use based on the other fields (action, data,
5177 * type, categories) in the Intent. If this class is defined, the
5178 * specified class will always be used regardless of the other fields. You
5179 * should only set this value when you know you absolutely want a specific
5180 * class to be used; otherwise it is better to let the system find the
5181 * appropriate class so that you will respect the installed applications
5182 * and user preferences.
5183 *
5184 * @param component The name of the application component to handle the
5185 * intent, or null to let the system find one for you.
5186 *
5187 * @return Returns the same Intent object, for chaining multiple calls
5188 * into a single statement.
5189 *
5190 * @see #setClass
5191 * @see #setClassName(Context, String)
5192 * @see #setClassName(String, String)
5193 * @see #getComponent
5194 * @see #resolveActivity
5195 */
5196 public Intent setComponent(ComponentName component) {
5197 mComponent = component;
5198 return this;
5199 }
5200
5201 /**
5202 * Convenience for calling {@link #setComponent} with an
5203 * explicit class name.
5204 *
5205 * @param packageContext A Context of the application package implementing
5206 * this class.
5207 * @param className The name of a class inside of the application package
5208 * that will be used as the component for this Intent.
5209 *
5210 * @return Returns the same Intent object, for chaining multiple calls
5211 * into a single statement.
5212 *
5213 * @see #setComponent
5214 * @see #setClass
5215 */
5216 public Intent setClassName(Context packageContext, String className) {
5217 mComponent = new ComponentName(packageContext, className);
5218 return this;
5219 }
5220
5221 /**
5222 * Convenience for calling {@link #setComponent} with an
5223 * explicit application package name and class name.
5224 *
5225 * @param packageName The name of the package implementing the desired
5226 * component.
5227 * @param className The name of a class inside of the application package
5228 * that will be used as the component for this Intent.
5229 *
5230 * @return Returns the same Intent object, for chaining multiple calls
5231 * into a single statement.
5232 *
5233 * @see #setComponent
5234 * @see #setClass
5235 */
5236 public Intent setClassName(String packageName, String className) {
5237 mComponent = new ComponentName(packageName, className);
5238 return this;
5239 }
5240
5241 /**
5242 * Convenience for calling {@link #setComponent(ComponentName)} with the
5243 * name returned by a {@link Class} object.
5244 *
5245 * @param packageContext A Context of the application package implementing
5246 * this class.
5247 * @param cls The class name to set, equivalent to
5248 * <code>setClassName(context, cls.getName())</code>.
5249 *
5250 * @return Returns the same Intent object, for chaining multiple calls
5251 * into a single statement.
5252 *
5253 * @see #setComponent
5254 */
5255 public Intent setClass(Context packageContext, Class<?> cls) {
5256 mComponent = new ComponentName(packageContext, cls);
5257 return this;
5258 }
5259
5260 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005261 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5262 * used as a hint to the receiver for animations and the like. Null means that there
5263 * is no source bounds.
5264 */
5265 public void setSourceBounds(Rect r) {
5266 if (r != null) {
5267 mSourceBounds = new Rect(r);
5268 } else {
5269 r = null;
5270 }
5271 }
5272
5273 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005274 * Use with {@link #fillIn} to allow the current action value to be
5275 * overwritten, even if it is already set.
5276 */
5277 public static final int FILL_IN_ACTION = 1<<0;
5278
5279 /**
5280 * Use with {@link #fillIn} to allow the current data or type value
5281 * overwritten, even if it is already set.
5282 */
5283 public static final int FILL_IN_DATA = 1<<1;
5284
5285 /**
5286 * Use with {@link #fillIn} to allow the current categories to be
5287 * overwritten, even if they are already set.
5288 */
5289 public static final int FILL_IN_CATEGORIES = 1<<2;
5290
5291 /**
5292 * Use with {@link #fillIn} to allow the current component value to be
5293 * overwritten, even if it is already set.
5294 */
5295 public static final int FILL_IN_COMPONENT = 1<<3;
5296
5297 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005298 * Use with {@link #fillIn} to allow the current package value to be
5299 * overwritten, even if it is already set.
5300 */
5301 public static final int FILL_IN_PACKAGE = 1<<4;
5302
5303 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005304 * Use with {@link #fillIn} to allow the current package value to be
5305 * overwritten, even if it is already set.
5306 */
5307 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5308
5309 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005310 * Copy the contents of <var>other</var> in to this object, but only
5311 * where fields are not defined by this object. For purposes of a field
5312 * being defined, the following pieces of data in the Intent are
5313 * considered to be separate fields:
5314 *
5315 * <ul>
5316 * <li> action, as set by {@link #setAction}.
5317 * <li> data URI and MIME type, as set by {@link #setData(Uri)},
5318 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5319 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005320 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005321 * <li> component, as set by {@link #setComponent(ComponentName)} or
5322 * related methods.
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005323 * <li> source bounds, as set by {@link #setSourceBounds}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005324 * <li> each top-level name in the associated extras.
5325 * </ul>
5326 *
5327 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005328 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5329 * and {@link #FILL_IN_COMPONENT} to override the restriction where the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005330 * corresponding field will not be replaced if it is already set.
5331 *
Brett Chabot3e391752009-07-21 16:07:23 -07005332 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT} is explicitly
5333 * specified.
5334 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005335 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5336 * and Intent B with {action="gotit", data-type="some/thing",
5337 * categories="one","two"}.
5338 *
5339 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5340 * containing: {action="gotit", data-type="some/thing",
5341 * categories="bar"}.
5342 *
5343 * @param other Another Intent whose values are to be used to fill in
5344 * the current one.
5345 * @param flags Options to control which fields can be filled in.
5346 *
5347 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005348 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
5349 * and {@link #FILL_IN_COMPONENT} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005350 */
5351 public int fillIn(Intent other, int flags) {
5352 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005353 if (other.mAction != null
5354 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005355 mAction = other.mAction;
5356 changes |= FILL_IN_ACTION;
5357 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005358 if ((other.mData != null || other.mType != null)
5359 && ((mData == null && mType == null)
5360 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005361 mData = other.mData;
5362 mType = other.mType;
5363 changes |= FILL_IN_DATA;
5364 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005365 if (other.mCategories != null
5366 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005367 if (other.mCategories != null) {
5368 mCategories = new HashSet<String>(other.mCategories);
5369 }
5370 changes |= FILL_IN_CATEGORIES;
5371 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005372 if (other.mPackage != null
5373 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
5374 mPackage = other.mPackage;
5375 changes |= FILL_IN_PACKAGE;
5376 }
5377 // Component is special: it can -only- be set if explicitly allowed,
5378 // since otherwise the sender could force the intent somewhere the
5379 // originator didn't intend.
5380 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005381 mComponent = other.mComponent;
5382 changes |= FILL_IN_COMPONENT;
5383 }
5384 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005385 if (other.mSourceBounds != null
5386 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
5387 mSourceBounds = new Rect(other.mSourceBounds);
5388 changes |= FILL_IN_SOURCE_BOUNDS;
5389 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005390 if (mExtras == null) {
5391 if (other.mExtras != null) {
5392 mExtras = new Bundle(other.mExtras);
5393 }
5394 } else if (other.mExtras != null) {
5395 try {
5396 Bundle newb = new Bundle(other.mExtras);
5397 newb.putAll(mExtras);
5398 mExtras = newb;
5399 } catch (RuntimeException e) {
5400 // Modifying the extras can cause us to unparcel the contents
5401 // of the bundle, and if we do this in the system process that
5402 // may fail. We really should handle this (i.e., the Bundle
5403 // impl shouldn't be on top of a plain map), but for now just
5404 // ignore it and keep the original contents. :(
5405 Log.w("Intent", "Failure filling in extras", e);
5406 }
5407 }
5408 return changes;
5409 }
5410
5411 /**
5412 * Wrapper class holding an Intent and implementing comparisons on it for
5413 * the purpose of filtering. The class implements its
5414 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
5415 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
5416 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
5417 * on the wrapped Intent.
5418 */
5419 public static final class FilterComparison {
5420 private final Intent mIntent;
5421 private final int mHashCode;
5422
5423 public FilterComparison(Intent intent) {
5424 mIntent = intent;
5425 mHashCode = intent.filterHashCode();
5426 }
5427
5428 /**
5429 * Return the Intent that this FilterComparison represents.
5430 * @return Returns the Intent held by the FilterComparison. Do
5431 * not modify!
5432 */
5433 public Intent getIntent() {
5434 return mIntent;
5435 }
5436
5437 @Override
5438 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005439 if (obj instanceof FilterComparison) {
5440 Intent other = ((FilterComparison)obj).mIntent;
5441 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005442 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08005443 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005444 }
5445
5446 @Override
5447 public int hashCode() {
5448 return mHashCode;
5449 }
5450 }
5451
5452 /**
5453 * Determine if two intents are the same for the purposes of intent
5454 * resolution (filtering). That is, if their action, data, type,
5455 * class, and categories are the same. This does <em>not</em> compare
5456 * any extra data included in the intents.
5457 *
5458 * @param other The other Intent to compare against.
5459 *
5460 * @return Returns true if action, data, type, class, and categories
5461 * are the same.
5462 */
5463 public boolean filterEquals(Intent other) {
5464 if (other == null) {
5465 return false;
5466 }
5467 if (mAction != other.mAction) {
5468 if (mAction != null) {
5469 if (!mAction.equals(other.mAction)) {
5470 return false;
5471 }
5472 } else {
5473 if (!other.mAction.equals(mAction)) {
5474 return false;
5475 }
5476 }
5477 }
5478 if (mData != other.mData) {
5479 if (mData != null) {
5480 if (!mData.equals(other.mData)) {
5481 return false;
5482 }
5483 } else {
5484 if (!other.mData.equals(mData)) {
5485 return false;
5486 }
5487 }
5488 }
5489 if (mType != other.mType) {
5490 if (mType != null) {
5491 if (!mType.equals(other.mType)) {
5492 return false;
5493 }
5494 } else {
5495 if (!other.mType.equals(mType)) {
5496 return false;
5497 }
5498 }
5499 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005500 if (mPackage != other.mPackage) {
5501 if (mPackage != null) {
5502 if (!mPackage.equals(other.mPackage)) {
5503 return false;
5504 }
5505 } else {
5506 if (!other.mPackage.equals(mPackage)) {
5507 return false;
5508 }
5509 }
5510 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005511 if (mComponent != other.mComponent) {
5512 if (mComponent != null) {
5513 if (!mComponent.equals(other.mComponent)) {
5514 return false;
5515 }
5516 } else {
5517 if (!other.mComponent.equals(mComponent)) {
5518 return false;
5519 }
5520 }
5521 }
5522 if (mCategories != other.mCategories) {
5523 if (mCategories != null) {
5524 if (!mCategories.equals(other.mCategories)) {
5525 return false;
5526 }
5527 } else {
5528 if (!other.mCategories.equals(mCategories)) {
5529 return false;
5530 }
5531 }
5532 }
5533
5534 return true;
5535 }
5536
5537 /**
5538 * Generate hash code that matches semantics of filterEquals().
5539 *
5540 * @return Returns the hash value of the action, data, type, class, and
5541 * categories.
5542 *
5543 * @see #filterEquals
5544 */
5545 public int filterHashCode() {
5546 int code = 0;
5547 if (mAction != null) {
5548 code += mAction.hashCode();
5549 }
5550 if (mData != null) {
5551 code += mData.hashCode();
5552 }
5553 if (mType != null) {
5554 code += mType.hashCode();
5555 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005556 if (mPackage != null) {
5557 code += mPackage.hashCode();
5558 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005559 if (mComponent != null) {
5560 code += mComponent.hashCode();
5561 }
5562 if (mCategories != null) {
5563 code += mCategories.hashCode();
5564 }
5565 return code;
5566 }
5567
5568 @Override
5569 public String toString() {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005570 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005571
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005572 b.append("Intent { ");
5573 toShortString(b, true, true);
5574 b.append(" }");
5575
5576 return b.toString();
5577 }
5578
5579 /** @hide */
5580 public String toShortString(boolean comp, boolean extras) {
5581 StringBuilder b = new StringBuilder(128);
5582 toShortString(b, comp, extras);
5583 return b.toString();
5584 }
Romain Guy4969af72009-06-17 10:53:19 -07005585
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005586 /** @hide */
5587 public void toShortString(StringBuilder b, boolean comp, boolean extras) {
5588 boolean first = true;
5589 if (mAction != null) {
5590 b.append("act=").append(mAction);
5591 first = false;
5592 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005593 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005594 if (!first) {
5595 b.append(' ');
5596 }
5597 first = false;
5598 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005599 Iterator<String> i = mCategories.iterator();
5600 boolean didone = false;
5601 while (i.hasNext()) {
5602 if (didone) b.append(",");
5603 didone = true;
5604 b.append(i.next());
5605 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005606 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005607 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005608 if (mData != null) {
5609 if (!first) {
5610 b.append(' ');
5611 }
5612 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07005613 b.append("dat=");
Wink Savillec491ee02010-10-13 11:40:10 -07005614 String scheme = mData.getScheme();
5615 if (scheme != null) {
5616 if (scheme.equalsIgnoreCase("tel")) {
5617 b.append("tel:xxx-xxx-xxxx");
5618 } else if (scheme.equalsIgnoreCase("smsto")) {
5619 b.append("smsto:xxx-xxx-xxxx");
5620 } else {
5621 b.append(mData);
5622 }
Wink Savillea4288072010-10-12 12:36:38 -07005623 } else {
5624 b.append(mData);
5625 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005626 }
5627 if (mType != null) {
5628 if (!first) {
5629 b.append(' ');
5630 }
5631 first = false;
5632 b.append("typ=").append(mType);
5633 }
5634 if (mFlags != 0) {
5635 if (!first) {
5636 b.append(' ');
5637 }
5638 first = false;
5639 b.append("flg=0x").append(Integer.toHexString(mFlags));
5640 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005641 if (mPackage != null) {
5642 if (!first) {
5643 b.append(' ');
5644 }
5645 first = false;
5646 b.append("pkg=").append(mPackage);
5647 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005648 if (comp && mComponent != null) {
5649 if (!first) {
5650 b.append(' ');
5651 }
5652 first = false;
5653 b.append("cmp=").append(mComponent.flattenToShortString());
5654 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005655 if (mSourceBounds != null) {
5656 if (!first) {
5657 b.append(' ');
5658 }
5659 first = false;
5660 b.append("bnds=").append(mSourceBounds.toShortString());
5661 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005662 if (extras && mExtras != null) {
5663 if (!first) {
5664 b.append(' ');
5665 }
5666 first = false;
5667 b.append("(has extras)");
5668 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005669 }
5670
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005671 /**
5672 * Call {@link #toUri} with 0 flags.
5673 * @deprecated Use {@link #toUri} instead.
5674 */
5675 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005676 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005677 return toUri(0);
5678 }
5679
5680 /**
5681 * Convert this Intent into a String holding a URI representation of it.
5682 * The returned URI string has been properly URI encoded, so it can be
5683 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
5684 * Intent's data as the base URI, with an additional fragment describing
5685 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08005686 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005687 * <p>You can convert the returned string back to an Intent with
5688 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08005689 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005690 * @param flags Additional operating flags. Either 0 or
5691 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08005692 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005693 * @return Returns a URI encoding URI string describing the entire contents
5694 * of the Intent.
5695 */
5696 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07005697 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005698 String scheme = null;
5699 if (mData != null) {
5700 String data = mData.toString();
5701 if ((flags&URI_INTENT_SCHEME) != 0) {
5702 final int N = data.length();
5703 for (int i=0; i<N; i++) {
5704 char c = data.charAt(i);
5705 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
5706 || c == '.' || c == '-') {
5707 continue;
5708 }
5709 if (c == ':' && i > 0) {
5710 // Valid scheme.
5711 scheme = data.substring(0, i);
5712 uri.append("intent:");
5713 data = data.substring(i+1);
5714 break;
5715 }
Tom Taylord4a47292009-12-21 13:59:18 -08005716
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005717 // No scheme.
5718 break;
5719 }
5720 }
5721 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08005722
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005723 } else if ((flags&URI_INTENT_SCHEME) != 0) {
5724 uri.append("intent:");
5725 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005726
5727 uri.append("#Intent;");
5728
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005729 if (scheme != null) {
5730 uri.append("scheme=").append(scheme).append(';');
5731 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005732 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005733 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005734 }
5735 if (mCategories != null) {
5736 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005737 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005738 }
5739 }
5740 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005741 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005742 }
5743 if (mFlags != 0) {
5744 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
5745 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005746 if (mPackage != null) {
5747 uri.append("package=").append(Uri.encode(mPackage)).append(';');
5748 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005749 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005750 uri.append("component=").append(Uri.encode(
5751 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005752 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005753 if (mSourceBounds != null) {
5754 uri.append("sourceBounds=")
5755 .append(Uri.encode(mSourceBounds.flattenToString()))
5756 .append(';');
5757 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005758 if (mExtras != null) {
5759 for (String key : mExtras.keySet()) {
5760 final Object value = mExtras.get(key);
5761 char entryType =
5762 value instanceof String ? 'S' :
5763 value instanceof Boolean ? 'B' :
5764 value instanceof Byte ? 'b' :
5765 value instanceof Character ? 'c' :
5766 value instanceof Double ? 'd' :
5767 value instanceof Float ? 'f' :
5768 value instanceof Integer ? 'i' :
5769 value instanceof Long ? 'l' :
5770 value instanceof Short ? 's' :
5771 '\0';
5772
5773 if (entryType != '\0') {
5774 uri.append(entryType);
5775 uri.append('.');
5776 uri.append(Uri.encode(key));
5777 uri.append('=');
5778 uri.append(Uri.encode(value.toString()));
5779 uri.append(';');
5780 }
5781 }
5782 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005783
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005784 uri.append("end");
5785
5786 return uri.toString();
5787 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005788
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005789 public int describeContents() {
5790 return (mExtras != null) ? mExtras.describeContents() : 0;
5791 }
5792
5793 public void writeToParcel(Parcel out, int flags) {
5794 out.writeString(mAction);
5795 Uri.writeToParcel(out, mData);
5796 out.writeString(mType);
5797 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005798 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005799 ComponentName.writeToParcel(mComponent, out);
5800
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005801 if (mSourceBounds != null) {
5802 out.writeInt(1);
5803 mSourceBounds.writeToParcel(out, flags);
5804 } else {
5805 out.writeInt(0);
5806 }
5807
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005808 if (mCategories != null) {
5809 out.writeInt(mCategories.size());
5810 for (String category : mCategories) {
5811 out.writeString(category);
5812 }
5813 } else {
5814 out.writeInt(0);
5815 }
5816
5817 out.writeBundle(mExtras);
5818 }
5819
5820 public static final Parcelable.Creator<Intent> CREATOR
5821 = new Parcelable.Creator<Intent>() {
5822 public Intent createFromParcel(Parcel in) {
5823 return new Intent(in);
5824 }
5825 public Intent[] newArray(int size) {
5826 return new Intent[size];
5827 }
5828 };
5829
Dianne Hackborneb034652009-09-07 00:49:58 -07005830 /** @hide */
5831 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005832 readFromParcel(in);
5833 }
5834
5835 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005836 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005837 mData = Uri.CREATOR.createFromParcel(in);
5838 mType = in.readString();
5839 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005840 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005841 mComponent = ComponentName.readFromParcel(in);
5842
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005843 if (in.readInt() != 0) {
5844 mSourceBounds = Rect.CREATOR.createFromParcel(in);
5845 }
5846
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005847 int N = in.readInt();
5848 if (N > 0) {
5849 mCategories = new HashSet<String>();
5850 int i;
5851 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005852 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005853 }
5854 } else {
5855 mCategories = null;
5856 }
5857
5858 mExtras = in.readBundle();
5859 }
5860
5861 /**
5862 * Parses the "intent" element (and its children) from XML and instantiates
5863 * an Intent object. The given XML parser should be located at the tag
5864 * where parsing should start (often named "intent"), from which the
5865 * basic action, data, type, and package and class name will be
5866 * retrieved. The function will then parse in to any child elements,
5867 * looking for <category android:name="xxx"> tags to add categories and
5868 * <extra android:name="xxx" android:value="yyy"> to attach extra data
5869 * to the intent.
5870 *
5871 * @param resources The Resources to use when inflating resources.
5872 * @param parser The XML parser pointing at an "intent" tag.
5873 * @param attrs The AttributeSet interface for retrieving extended
5874 * attribute data at the current <var>parser</var> location.
5875 * @return An Intent object matching the XML data.
5876 * @throws XmlPullParserException If there was an XML parsing error.
5877 * @throws IOException If there was an I/O error.
5878 */
5879 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
5880 throws XmlPullParserException, IOException {
5881 Intent intent = new Intent();
5882
5883 TypedArray sa = resources.obtainAttributes(attrs,
5884 com.android.internal.R.styleable.Intent);
5885
5886 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
5887
5888 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
5889 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
5890 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
5891
5892 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
5893 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
5894 if (packageName != null && className != null) {
5895 intent.setComponent(new ComponentName(packageName, className));
5896 }
5897
5898 sa.recycle();
5899
5900 int outerDepth = parser.getDepth();
5901 int type;
5902 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
5903 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
5904 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
5905 continue;
5906 }
5907
5908 String nodeName = parser.getName();
5909 if (nodeName.equals("category")) {
5910 sa = resources.obtainAttributes(attrs,
5911 com.android.internal.R.styleable.IntentCategory);
5912 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
5913 sa.recycle();
5914
5915 if (cat != null) {
5916 intent.addCategory(cat);
5917 }
5918 XmlUtils.skipCurrentTag(parser);
5919
5920 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005921 if (intent.mExtras == null) {
5922 intent.mExtras = new Bundle();
5923 }
5924 resources.parseBundleExtra("extra", attrs, intent.mExtras);
5925 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005926
5927 } else {
5928 XmlUtils.skipCurrentTag(parser);
5929 }
5930 }
5931
5932 return intent;
5933 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005934}