blob: bca5ade50655f8711a7ba1cc2c33f1734319280a [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;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&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 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700573 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800574 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700575 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
577 * <li> {@link #EXTRA_REPLACING}
578 * <li> {@link #EXTRA_SHORTCUT_ICON}
579 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
580 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700581 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800582 * <li> {@link #EXTRA_SHORTCUT_NAME}
583 * <li> {@link #EXTRA_SUBJECT}
584 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700585 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_TITLE}
587 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * </ul>
589 *
590 * <h3>Flags</h3>
591 *
592 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800593 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
594 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800596public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 // ---------------------------------------------------------------------
598 // ---------------------------------------------------------------------
599 // Standard intent activity actions (see action variable).
600
601 /**
602 * Activity Action: Start as a main entry point, does not expect to
603 * receive data.
604 * <p>Input: nothing
605 * <p>Output: nothing
606 */
607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
608 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700610 /**
611 * Activity Action: Display the data to the user. This is the most common
612 * action performed on data -- it is the generic action you can use on
613 * a piece of data to get the most reasonable thing to occur. For example,
614 * when used on a contacts entry it will view the entry; when used on a
615 * mailto: URI it will bring up a compose window filled with the information
616 * supplied by the URI; when used with a tel: URI it will invoke the
617 * dialer.
618 * <p>Input: {@link #getData} is URI from which to retrieve data.
619 * <p>Output: nothing.
620 */
621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
622 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 /**
625 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
626 * performed on a piece of data.
627 */
628 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Used to indicate that some piece of data should be attached to some other
632 * place. For example, image data could be attached to a contact. It is up
633 * to the recipient to decide where the data should be attached; the intent
634 * does not specify the ultimate destination.
635 * <p>Input: {@link #getData} is URI of data to be attached.
636 * <p>Output: nothing.
637 */
638 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
639 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700641 /**
642 * Activity Action: Provide explicit editable access to the given data.
643 * <p>Input: {@link #getData} is URI of data to be edited.
644 * <p>Output: nothing.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_EDIT = "android.intent.action.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 existing item, or insert a new item, and then edit it.
651 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
652 * The extras can contain type specific data to pass through to the editing/creating
653 * activity.
654 * <p>Output: The URI of the item that was picked. This must be a content:
655 * URI so that any receiver can access it.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * Activity Action: Pick an item from the data, returning what was selected.
662 * <p>Input: {@link #getData} is URI containing a directory of data
663 * (vnd.android.cursor.dir/*) from which to pick an item.
664 * <p>Output: The URI of the item that was picked.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800671 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 * <p>Output: An Intent representing the shortcut. The intent must contain three
673 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
674 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675 * (value: ShortcutIconResource).</p>
676 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * @see #EXTRA_SHORTCUT_INTENT
678 * @see #EXTRA_SHORTCUT_NAME
679 * @see #EXTRA_SHORTCUT_ICON
680 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
681 * @see android.content.Intent.ShortcutIconResource
682 */
683 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
684 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
685
686 /**
687 * The name of the extra used to define the Intent of a shortcut.
688 *
689 * @see #ACTION_CREATE_SHORTCUT
690 */
691 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
692 /**
693 * The name of the extra used to define the name of a shortcut.
694 *
695 * @see #ACTION_CREATE_SHORTCUT
696 */
697 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
698 /**
699 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
700 *
701 * @see #ACTION_CREATE_SHORTCUT
702 */
703 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
704 /**
705 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
706 *
707 * @see #ACTION_CREATE_SHORTCUT
708 * @see android.content.Intent.ShortcutIconResource
709 */
710 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
711 "android.intent.extra.shortcut.ICON_RESOURCE";
712
713 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 *
716 * @see Intent#ACTION_CREATE_SHORTCUT
717 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
719 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 */
721 public static class ShortcutIconResource implements Parcelable {
722 /**
723 * The package name of the application containing the icon.
724 */
725 public String packageName;
726
727 /**
728 * The resource name of the icon, including package, name and type.
729 */
730 public String resourceName;
731
732 /**
733 * Creates a new ShortcutIconResource for the specified context and resource
734 * identifier.
735 *
736 * @param context The context of the application.
737 * @param resourceId The resource idenfitier for the icon.
738 * @return A new ShortcutIconResource with the specified's context package name
739 * and icon resource idenfitier.
740 */
741 public static ShortcutIconResource fromContext(Context context, int resourceId) {
742 ShortcutIconResource icon = new ShortcutIconResource();
743 icon.packageName = context.getPackageName();
744 icon.resourceName = context.getResources().getResourceName(resourceId);
745 return icon;
746 }
747
748 /**
749 * Used to read a ShortcutIconResource from a Parcel.
750 */
751 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
752 new Parcelable.Creator<ShortcutIconResource>() {
753
754 public ShortcutIconResource createFromParcel(Parcel source) {
755 ShortcutIconResource icon = new ShortcutIconResource();
756 icon.packageName = source.readString();
757 icon.resourceName = source.readString();
758 return icon;
759 }
760
761 public ShortcutIconResource[] newArray(int size) {
762 return new ShortcutIconResource[size];
763 }
764 };
765
766 /**
767 * No special parcel contents.
768 */
769 public int describeContents() {
770 return 0;
771 }
772
773 public void writeToParcel(Parcel dest, int flags) {
774 dest.writeString(packageName);
775 dest.writeString(resourceName);
776 }
777
778 @Override
779 public String toString() {
780 return resourceName;
781 }
782 }
783
784 /**
785 * Activity Action: Display an activity chooser, allowing the user to pick
786 * what they want to before proceeding. This can be used as an alternative
787 * to the standard activity picker that is displayed by the system when
788 * you try to start an activity with multiple possible matches, with these
789 * differences in behavior:
790 * <ul>
791 * <li>You can specify the title that will appear in the activity chooser.
792 * <li>The user does not have the option to make one of the matching
793 * activities a preferred activity, and all possible activities will
794 * always be shown even if one of them is currently marked as the
795 * preferred activity.
796 * </ul>
797 * <p>
798 * This action should be used when the user will naturally expect to
799 * select an activity in order to proceed. An example if when not to use
800 * it is when the user clicks on a "mailto:" link. They would naturally
801 * expect to go directly to their mail app, so startActivity() should be
802 * called directly: it will
803 * either launch the current preferred app, or put up a dialog allowing the
804 * user to pick an app to use and optionally marking that as preferred.
805 * <p>
806 * In contrast, if the user is selecting a menu item to send a picture
807 * they are viewing to someone else, there are many different things they
808 * may want to do at this point: send it through e-mail, upload it to a
809 * web service, etc. In this case the CHOOSER action should be used, to
810 * always present to the user a list of the things they can do, with a
811 * nice title given by the caller such as "Send this photo with:".
812 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700813 * If you need to grant URI permissions through a chooser, you must specify
814 * the permissions to be granted on the ACTION_CHOOSER Intent
815 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
816 * {@link #setClipData} to specify the URIs to be granted as well as
817 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
818 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
819 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 * As a convenience, an Intent of this form can be created with the
821 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700822 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
825 * and can optionally have a {@link #EXTRA_TITLE} field containing the
826 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700827 * <p>
828 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700829 */
830 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
831 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
832
833 /**
834 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
835 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700836 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
837 * target intent, also optionally supplying a title. If the target
838 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
839 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
840 * set in the returned chooser intent, with its ClipData set appropriately:
841 * either a direct reflection of {@link #getClipData()} if that is non-null,
842 * or a new ClipData build from {@link #getData()}.
843 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 * @param target The Intent that the user will be selecting an activity
845 * to perform.
846 * @param title Optional title that will be displayed in the chooser.
847 * @return Return a new Intent object that you can hand to
848 * {@link Context#startActivity(Intent) Context.startActivity()} and
849 * related methods.
850 */
851 public static Intent createChooser(Intent target, CharSequence title) {
852 Intent intent = new Intent(ACTION_CHOOSER);
853 intent.putExtra(EXTRA_INTENT, target);
854 if (title != null) {
855 intent.putExtra(EXTRA_TITLE, title);
856 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700857
858 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700859 int permFlags = target.getFlags()
860 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
861 if (permFlags != 0) {
862 ClipData targetClipData = target.getClipData();
863 if (targetClipData == null && target.getData() != null) {
864 ClipData.Item item = new ClipData.Item(target.getData());
865 String[] mimeTypes;
866 if (target.getType() != null) {
867 mimeTypes = new String[] { target.getType() };
868 } else {
869 mimeTypes = new String[] { };
870 }
871 targetClipData = new ClipData(null, mimeTypes, item);
872 }
873 if (targetClipData != null) {
874 intent.setClipData(targetClipData);
875 intent.addFlags(permFlags);
876 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700879 return intent;
880 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700882 /**
883 * Activity Action: Allow the user to select a particular kind of data and
884 * return it. This is different than {@link #ACTION_PICK} in that here we
885 * just say what kind of data is desired, not a URI of existing data from
886 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
887 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900888 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700889 * etc.
890 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900891 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * of data, such as a person contact, you set the MIME type to the kind of
893 * data you want and launch it with {@link Context#startActivity(Intent)}.
894 * The system will then launch the best application to select that kind
895 * of data for you.
896 * <p>
897 * You may also be interested in any of a set of types of content the user
898 * can pick. For example, an e-mail application that wants to allow the
899 * user to add an attachment to an e-mail message can use this action to
900 * bring up a list of all of the types of content the user can attach.
901 * <p>
902 * In this case, you should wrap the GET_CONTENT intent with a chooser
903 * (through {@link #createChooser}), which will give the proper interface
904 * for the user to pick how to send your data and allow you to specify
905 * a prompt indicating what they are doing. You will usually specify a
906 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
907 * broad range of content types the user can select from.
908 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900909 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * only pick from data that can be represented as a stream. This is
911 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
912 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800913 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900914 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800915 * is locally available on the device. For example, if this extra is set
916 * to true then an image picker should not show any pictures that are available
917 * from a remote server but not already on the local device (thus requiring
918 * they be downloaded when opened).
919 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700920 * Input: {@link #getType} is the desired MIME type to retrieve. Note
921 * that no URI is supplied in the intent, as there are no constraints on
922 * where the returned data originally comes from. You may also include the
923 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800924 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
925 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700926 * <p>
927 * Output: The URI of the item that was picked. This must be a content:
928 * URI so that any receiver can access it.
929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
932 /**
933 * Activity Action: Dial a number as specified by the data. This shows a
934 * UI with the number being dialed, allowing the user to explicitly
935 * initiate the call.
936 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
937 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
938 * number.
939 * <p>Output: nothing.
940 */
941 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
942 public static final String ACTION_DIAL = "android.intent.action.DIAL";
943 /**
944 * Activity Action: Perform a call to someone specified by the data.
945 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
946 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
947 * number.
948 * <p>Output: nothing.
949 *
950 * <p>Note: there will be restrictions on which applications can initiate a
951 * call; most applications should use the {@link #ACTION_DIAL}.
952 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
953 * numbers. Applications can <strong>dial</strong> emergency numbers using
954 * {@link #ACTION_DIAL}, however.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_CALL = "android.intent.action.CALL";
958 /**
959 * Activity Action: Perform a call to an emergency number specified by the
960 * data.
961 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
962 * tel: URI of an explicit phone number.
963 * <p>Output: nothing.
964 * @hide
965 */
966 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
967 /**
968 * Activity action: Perform a call to any number (emergency or not)
969 * specified by the data.
970 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
971 * tel: URI of an explicit phone number.
972 * <p>Output: nothing.
973 * @hide
974 */
975 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
976 /**
977 * Activity Action: Send a message to someone specified by the data.
978 * <p>Input: {@link #getData} is URI describing the target.
979 * <p>Output: nothing.
980 */
981 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
982 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
983 /**
984 * Activity Action: Deliver some data to someone else. Who the data is
985 * being delivered to is not specified; it is up to the receiver of this
986 * action to ask the user where the data should be sent.
987 * <p>
988 * When launching a SEND intent, you should usually wrap it in a chooser
989 * (through {@link #createChooser}), which will give the proper interface
990 * for the user to pick how to send your data and allow you to specify
991 * a prompt indicating what they are doing.
992 * <p>
993 * Input: {@link #getType} is the MIME type of the data being sent.
994 * get*Extra can have either a {@link #EXTRA_TEXT}
995 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
996 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
997 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
998 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700999 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1000 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1001 * your text with HTML formatting.
1002 * <p>
1003 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1004 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1005 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1006 * content: URIs and other advanced features of {@link ClipData}. If
1007 * using this approach, you still must supply the same data through the
1008 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1009 * for compatibility with old applications. If you don't set a ClipData,
1010 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * <p>
1012 * Optional standard extras, which may be interpreted by some recipients as
1013 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1014 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1015 * <p>
1016 * Output: nothing.
1017 */
1018 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1019 public static final String ACTION_SEND = "android.intent.action.SEND";
1020 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001021 * Activity Action: Deliver multiple data to someone else.
1022 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001023 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001024 * <p>
1025 * Input: {@link #getType} is the MIME type of the data being sent.
1026 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001027 * #EXTRA_STREAM} field, containing the data to be sent. If using
1028 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1029 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001031 * Multiple types are supported, and receivers should handle mixed types
1032 * whenever possible. The right way for the receiver to check them is to
1033 * use the content resolver on each URI. The intent sender should try to
1034 * put the most concrete mime type in the intent type, but it can fall
1035 * back to {@literal <type>/*} or {@literal *}/* as needed.
1036 * <p>
1037 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1038 * be image/jpg, but if you are sending image/jpg and image/png, then the
1039 * intent's type should be image/*.
1040 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001041 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1042 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1043 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1044 * content: URIs and other advanced features of {@link ClipData}. If
1045 * using this approach, you still must supply the same data through the
1046 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1047 * for compatibility with old applications. If you don't set a ClipData,
1048 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1049 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001050 * Optional standard extras, which may be interpreted by some recipients as
1051 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1052 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1053 * <p>
1054 * Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Activity Action: Handle an incoming phone call.
1060 * <p>Input: nothing.
1061 * <p>Output: nothing.
1062 */
1063 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1064 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1065 /**
1066 * Activity Action: Insert an empty item into the given container.
1067 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1068 * in which to place the data.
1069 * <p>Output: URI of the new data that was created.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1073 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001074 * Activity Action: Create a new item in the given container, initializing it
1075 * from the current contents of the clipboard.
1076 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1077 * in which to place the data.
1078 * <p>Output: URI of the new data that was created.
1079 */
1080 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1081 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1082 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001083 * Activity Action: Delete the given data from its container.
1084 * <p>Input: {@link #getData} is URI of data to be deleted.
1085 * <p>Output: nothing.
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1089 /**
1090 * Activity Action: Run the data, whatever that means.
1091 * <p>Input: ? (Note: this is currently specific to the test harness.)
1092 * <p>Output: nothing.
1093 */
1094 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1095 public static final String ACTION_RUN = "android.intent.action.RUN";
1096 /**
1097 * Activity Action: Perform a data synchronization.
1098 * <p>Input: ?
1099 * <p>Output: ?
1100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1103 /**
1104 * Activity Action: Pick an activity given an intent, returning the class
1105 * selected.
1106 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1107 * used with {@link PackageManager#queryIntentActivities} to determine the
1108 * set of activities from which to pick.
1109 * <p>Output: Class name of the activity that was selected.
1110 */
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1112 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1113 /**
1114 * Activity Action: Perform a search.
1115 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1116 * is the text to search for. If empty, simply
1117 * enter your search results Activity with the search UI activated.
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1122 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001123 * Activity Action: Start the platform-defined tutorial
1124 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1125 * is the text to search for. If empty, simply
1126 * enter your search results Activity with the search UI activated.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1131 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001132 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001133 * <p>
1134 * Input: {@link android.app.SearchManager#QUERY
1135 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1136 * a url starts with http or https, the site will be opened. If it is plain
1137 * text, Google search will be applied.
1138 * <p>
1139 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001140 */
1141 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1142 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1143 /**
Jim Miller07994402012-05-02 14:22:27 -07001144 * Activity Action: Perform assist action.
1145 * <p>
1146 * Input: nothing
1147 * Output: nothing.
1148 */
1149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1150 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
1151 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 * Activity Action: List all available applications
1153 * <p>Input: Nothing.
1154 * <p>Output: nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1158 /**
1159 * Activity Action: Show settings for choosing wallpaper
1160 * <p>Input: Nothing.
1161 * <p>Output: Nothing.
1162 */
1163 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1164 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1165
1166 /**
1167 * Activity Action: Show activity for reporting a bug.
1168 * <p>Input: Nothing.
1169 * <p>Output: Nothing.
1170 */
1171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1172 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1173
1174 /**
1175 * Activity Action: Main entry point for factory tests. Only used when
1176 * the device is booting in factory test node. The implementing package
1177 * must be installed in the system image.
1178 * <p>Input: nothing
1179 * <p>Output: nothing
1180 */
1181 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1182
1183 /**
1184 * Activity Action: The user pressed the "call" button to go to the dialer
1185 * or other appropriate UI for placing a call.
1186 * <p>Input: Nothing.
1187 * <p>Output: Nothing.
1188 */
1189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1190 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1191
1192 /**
1193 * Activity Action: Start Voice Command.
1194 * <p>Input: Nothing.
1195 * <p>Output: Nothing.
1196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001199
1200 /**
1201 * Activity Action: Start action associated with long pressing on the
1202 * search key.
1203 * <p>Input: Nothing.
1204 * <p>Output: Nothing.
1205 */
1206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1207 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001208
Jacek Surazski86b6c532009-05-13 14:38:28 +02001209 /**
1210 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1211 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001212 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001213 * <p>Input: No data is specified. The bug report is passed in using
1214 * an {@link #EXTRA_BUG_REPORT} field.
1215 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001216 *
1217 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001218 */
1219 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1220 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001221
1222 /**
1223 * Activity Action: Show power usage information to the user.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001229
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001230 /**
1231 * Activity Action: Setup wizard to launch after a platform update. This
1232 * activity should have a string meta-data field associated with it,
1233 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1234 * the platform for setup. The activity will be launched only if
1235 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1236 * same value.
1237 * <p>Input: Nothing.
1238 * <p>Output: Nothing.
1239 * @hide
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001243
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001244 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001245 * Activity Action: Show settings for managing network data usage of a
1246 * specific application. Applications should define an activity that offers
1247 * options to control data usage.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_MANAGE_NETWORK_USAGE =
1251 "android.intent.action.MANAGE_NETWORK_USAGE";
1252
1253 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 * Activity Action: Launch application installer.
1255 * <p>
1256 * Input: The data must be a content: or file: URI at which the application
1257 * can be retrieved. You can optionally supply
1258 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1259 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1260 * <p>
1261 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1262 * succeeded.
1263 *
1264 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1265 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1266 * @see #EXTRA_RETURN_RESULT
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1270
1271 /**
1272 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1273 * package. Specifies the installer package name; this package will receive the
1274 * {@link #ACTION_APP_ERROR} intent.
1275 */
1276 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1277 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1278
1279 /**
1280 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1281 * package. Specifies that the application being installed should not be
1282 * treated as coming from an unknown source, but as coming from the app
1283 * invoking the Intent. For this to work you must start the installer with
1284 * startActivityForResult().
1285 */
1286 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1287 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1288
1289 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001290 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1291 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001292 * data field originated from.
1293 */
rich cannings706e8ba2012-08-20 13:20:14 -07001294 public static final String EXTRA_ORIGINATING_URI
1295 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001296
1297 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001298 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1299 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1300 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001301 */
1302 public static final String EXTRA_REFERRER
1303 = "android.intent.extra.REFERRER";
1304
1305 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001306 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1307 * package. Tells the installer UI to skip the confirmation with the user
1308 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001309 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1310 * will no longer show an interstitial message about updating existing
1311 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001312 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001313 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001314 public static final String EXTRA_ALLOW_REPLACE
1315 = "android.intent.extra.ALLOW_REPLACE";
1316
1317 /**
1318 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1319 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1320 * return to the application the result code of the install/uninstall. The returned result
1321 * code will be {@link android.app.Activity#RESULT_OK} on success or
1322 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1323 */
1324 public static final String EXTRA_RETURN_RESULT
1325 = "android.intent.extra.RETURN_RESULT";
1326
1327 /**
1328 * Package manager install result code. @hide because result codes are not
1329 * yet ready to be exposed.
1330 */
1331 public static final String EXTRA_INSTALL_RESULT
1332 = "android.intent.extra.INSTALL_RESULT";
1333
1334 /**
1335 * Activity Action: Launch application uninstaller.
1336 * <p>
1337 * Input: The data must be a package: URI whose scheme specific part is
1338 * the package name of the current installed package to be uninstalled.
1339 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1340 * <p>
1341 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1342 * succeeded.
1343 */
1344 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1345 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1346
1347 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001348 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1349 * describing the last run version of the platform that was setup.
1350 * @hide
1351 */
1352 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1353
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001354 // ---------------------------------------------------------------------
1355 // ---------------------------------------------------------------------
1356 // Standard intent broadcast actions (see action variable).
1357
1358 /**
1359 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001360 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001361 * <p class="note">This is a protected intent that can only be sent
1362 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001363 */
1364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1365 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1366 /**
1367 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001368 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001369 * <p class="note">This is a protected intent that can only be sent
1370 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001371 */
1372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1373 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001374
1375 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001376 * 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 -07001377 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001378 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001379 * <p class="note">This is a protected intent that can only be sent
1380 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001381 */
1382 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001383 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001384
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001385 /**
1386 * Broadcast Action: The current time has changed. Sent every
1387 * minute. You can <em>not</em> receive this through components declared
1388 * in manifests, only by exlicitly registering for it with
1389 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1390 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001391 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001392 * <p class="note">This is a protected intent that can only be sent
1393 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001394 */
1395 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1396 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1397 /**
1398 * Broadcast Action: The time was set.
1399 */
1400 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1401 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1402 /**
1403 * Broadcast Action: The date has changed.
1404 */
1405 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1406 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1407 /**
1408 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1409 * <ul>
1410 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1411 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001412 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001413 * <p class="note">This is a protected intent that can only be sent
1414 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001415 */
1416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1417 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1418 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001419 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1420 * DNS entries should be tossed.
1421 * @hide
1422 */
1423 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1424 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1425 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001426 * Alarm Changed Action: This is broadcast when the AlarmClock
1427 * application's alarm is set or unset. It is used by the
1428 * AlarmClock application and the StatusBar service.
1429 * @hide
1430 */
1431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1432 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1433 /**
1434 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1435 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1436 * @hide
1437 */
1438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1439 public static final String ACTION_SYNC_STATE_CHANGED
1440 = "android.intent.action.SYNC_STATE_CHANGED";
1441 /**
1442 * Broadcast Action: This is broadcast once, after the system has finished
1443 * booting. It can be used to perform application-specific initialization,
1444 * such as installing alarms. You must hold the
1445 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1446 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001447 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001448 * <p class="note">This is a protected intent that can only be sent
1449 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001450 */
1451 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1452 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1453 /**
1454 * Broadcast Action: This is broadcast when a user action should request a
1455 * temporary system dialog to dismiss. Some examples of temporary system
1456 * dialogs are the notification window-shade and the recent tasks dialog.
1457 */
1458 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1459 /**
1460 * Broadcast Action: Trigger the download and eventual installation
1461 * of a package.
1462 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001463 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001464 * <p class="note">This is a protected intent that can only be sent
1465 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001466 *
1467 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001468 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001469 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001470 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1471 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1472 /**
1473 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001474 * device. The data contains the name of the package. Note that the
1475 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001476 * <p>My include the following extras:
1477 * <ul>
1478 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1479 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1480 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1481 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001482 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001483 * <p class="note">This is a protected intent that can only be sent
1484 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001485 */
1486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1487 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1488 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001489 * Broadcast Action: A new version of an application package has been
1490 * installed, replacing an existing version that was previously installed.
1491 * The data contains the name of the package.
1492 * <p>My include the following extras:
1493 * <ul>
1494 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1495 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001496 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001497 * <p class="note">This is a protected intent that can only be sent
1498 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001499 */
1500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1501 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1502 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001503 * Broadcast Action: A new version of your application has been installed
1504 * over an existing one. This is only sent to the application that was
1505 * replaced. It does not contain any additional data; to receive it, just
1506 * use an intent filter for this action.
1507 *
1508 * <p class="note">This is a protected intent that can only be sent
1509 * by the system.
1510 */
1511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1512 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1513 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001514 * Broadcast Action: An existing application package has been removed from
1515 * the device. The data contains the name of the package. The package
1516 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001517 * <ul>
1518 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1519 * to the package.
1520 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1521 * application -- data and code -- is being removed.
1522 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1523 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1524 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001525 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001526 * <p class="note">This is a protected intent that can only be sent
1527 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001528 */
1529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1530 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1531 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001532 * Broadcast Action: An existing application package has been completely
1533 * removed from the device. The data contains the name of the package.
1534 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1535 * {@link #EXTRA_DATA_REMOVED} is true and
1536 * {@link #EXTRA_REPLACING} is false of that broadcast.
1537 *
1538 * <ul>
1539 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1540 * to the package.
1541 * </ul>
1542 *
1543 * <p class="note">This is a protected intent that can only be sent
1544 * by the system.
1545 */
1546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1547 public static final String ACTION_PACKAGE_FULLY_REMOVED
1548 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1549 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001550 * Broadcast Action: An existing application package has been changed (e.g.
1551 * a component has been enabled or disabled). The data contains the name of
1552 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001553 * <ul>
1554 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001555 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1556 * of the changed components.
1557 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1558 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001559 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001560 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001561 * <p class="note">This is a protected intent that can only be sent
1562 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001563 */
1564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1565 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1566 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001567 * @hide
1568 * Broadcast Action: Ask system services if there is any reason to
1569 * restart the given package. The data contains the name of the
1570 * package.
1571 * <ul>
1572 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1573 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1574 * </ul>
1575 *
1576 * <p class="note">This is a protected intent that can only be sent
1577 * by the system.
1578 */
1579 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1580 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1581 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001582 * Broadcast Action: The user has restarted a package, and all of its
1583 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001584 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001585 * be removed. Note that the restarted package does <em>not</em>
1586 * receive this broadcast.
1587 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001588 * <ul>
1589 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1590 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001591 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001592 * <p class="note">This is a protected intent that can only be sent
1593 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001594 */
1595 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1596 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1597 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001598 * Broadcast Action: The user has cleared the data of a package. This should
1599 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001600 * its persistent data is erased and this broadcast sent.
1601 * Note that the cleared package does <em>not</em>
1602 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001603 * <ul>
1604 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1605 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001606 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001607 * <p class="note">This is a protected intent that can only be sent
1608 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001609 */
1610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1611 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1612 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001613 * Broadcast Action: A user ID has been removed from the system. The user
1614 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001615 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001616 * <p class="note">This is a protected intent that can only be sent
1617 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001618 */
1619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1620 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001621
1622 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001623 * Broadcast Action: Sent to the installer package of an application
1624 * when that application is first launched (that is the first time it
1625 * is moved out of the stopped state). The data contains the name of the package.
1626 *
1627 * <p class="note">This is a protected intent that can only be sent
1628 * by the system.
1629 */
1630 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1631 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1632
1633 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001634 * Broadcast Action: Sent to the system package verifier when a package
1635 * needs to be verified. The data contains the package URI.
1636 * <p class="note">
1637 * This is a protected intent that can only be sent by the system.
1638 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001639 */
1640 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1641 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1642
1643 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001644 * Broadcast Action: Sent to the system package verifier when a package is
1645 * verified. The data contains the package URI.
1646 * <p class="note">
1647 * This is a protected intent that can only be sent by the system.
1648 */
1649 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1650 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1651
1652 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001653 * Broadcast Action: Resources for a set of packages (which were
1654 * previously unavailable) are currently
1655 * available since the media on which they exist is available.
1656 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1657 * list of packages whose availability changed.
1658 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1659 * list of uids of packages whose availability changed.
1660 * Note that the
1661 * packages in this list do <em>not</em> receive this broadcast.
1662 * The specified set of packages are now available on the system.
1663 * <p>Includes the following extras:
1664 * <ul>
1665 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1666 * whose resources(were previously unavailable) are currently available.
1667 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1668 * packages whose resources(were previously unavailable)
1669 * are currently available.
1670 * </ul>
1671 *
1672 * <p class="note">This is a protected intent that can only be sent
1673 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001674 */
1675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001676 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1677 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001678
1679 /**
1680 * Broadcast Action: Resources for a set of packages are currently
1681 * unavailable since the media on which they exist is unavailable.
1682 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1683 * list of packages whose availability changed.
1684 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1685 * list of uids of packages whose availability changed.
1686 * The specified set of packages can no longer be
1687 * launched and are practically unavailable on the system.
1688 * <p>Inclues the following extras:
1689 * <ul>
1690 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1691 * whose resources are no longer available.
1692 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1693 * whose resources are no longer available.
1694 * </ul>
1695 *
1696 * <p class="note">This is a protected intent that can only be sent
1697 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001698 */
1699 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001700 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001701 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001702
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001703 /**
1704 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001705 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001706 * This should <em>only</em> be used to determine when the wallpaper
1707 * has changed to show the new wallpaper to the user. You should certainly
1708 * never, in response to this, change the wallpaper or other attributes of
1709 * it such as the suggested size. That would be crazy, right? You'd cause
1710 * all kinds of loops, especially if other apps are doing similar things,
1711 * right? Of course. So please don't do this.
1712 *
1713 * @deprecated Modern applications should use
1714 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1715 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1716 * shown behind their UI, rather than watching for this broadcast and
1717 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001718 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001719 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001720 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1721 /**
1722 * Broadcast Action: The current device {@link android.content.res.Configuration}
1723 * (orientation, locale, etc) has changed. When such a change happens, the
1724 * UIs (view hierarchy) will need to be rebuilt based on this new
1725 * information; for the most part, applications don't need to worry about
1726 * this, because the system will take care of stopping and restarting the
1727 * application to make sure it sees the new changes. Some system code that
1728 * can not be restarted will need to watch for this action and handle it
1729 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001730 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001731 * <p class="note">
1732 * You can <em>not</em> receive this through components declared
1733 * in manifests, only by explicitly registering for it with
1734 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1735 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001736 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001737 * <p class="note">This is a protected intent that can only be sent
1738 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001739 *
1740 * @see android.content.res.Configuration
1741 */
1742 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1743 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1744 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001745 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001746 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001747 * <p class="note">This is a protected intent that can only be sent
1748 * by the system.
1749 */
1750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1751 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1752 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001753 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1754 * charging state, level, and other information about the battery.
1755 * See {@link android.os.BatteryManager} for documentation on the
1756 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001757 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001758 * <p class="note">
1759 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001760 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001761 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001762 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1763 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1764 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1765 * broadcasts that are sent and can be received through manifest
1766 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001767 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001768 * <p class="note">This is a protected intent that can only be sent
1769 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001770 */
1771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1772 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1773 /**
1774 * Broadcast Action: Indicates low battery condition on the device.
1775 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001776 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001777 * <p class="note">This is a protected intent that can only be sent
1778 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001779 */
1780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1781 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1782 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001783 * Broadcast Action: Indicates the battery is now okay after being low.
1784 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1785 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001786 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001787 * <p class="note">This is a protected intent that can only be sent
1788 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001789 */
1790 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1791 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1792 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001793 * Broadcast Action: External power has been connected to the device.
1794 * This is intended for applications that wish to register specifically to this notification.
1795 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1796 * stay active to receive this notification. This action can be used to implement actions
1797 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001798 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001799 * <p class="note">This is a protected intent that can only be sent
1800 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001801 */
1802 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001803 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001804 /**
1805 * Broadcast Action: External power has been removed from the device.
1806 * This is intended for applications that wish to register specifically to this notification.
1807 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1808 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001809 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001810 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001811 * <p class="note">This is a protected intent that can only be sent
1812 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001815 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001816 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001817 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001818 * Broadcast Action: Device is shutting down.
1819 * This is broadcast when the device is being shut down (completely turned
1820 * off, not sleeping). Once the broadcast is complete, the final shutdown
1821 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001822 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001823 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001824 * <p class="note">This is a protected intent that can only be sent
1825 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001826 */
1827 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001828 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001829 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001830 * Activity Action: Start this activity to request system shutdown.
1831 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1832 * to request confirmation from the user before shutting down.
1833 *
1834 * <p class="note">This is a protected intent that can only be sent
1835 * by the system.
1836 *
1837 * {@hide}
1838 */
1839 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1840 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001841 * Broadcast Action: A sticky broadcast that indicates low memory
1842 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001843 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001844 * <p class="note">This is a protected intent that can only be sent
1845 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001846 */
1847 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1848 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1849 /**
1850 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001851 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001852 * <p class="note">This is a protected intent that can only be sent
1853 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001854 */
1855 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1856 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1857 /**
Jake Hambybb371632010-08-23 18:16:48 -07001858 * Broadcast Action: A sticky broadcast that indicates a memory full
1859 * condition on the device. This is intended for activities that want
1860 * to be able to fill the data partition completely, leaving only
1861 * enough free space to prevent system-wide SQLite failures.
1862 *
1863 * <p class="note">This is a protected intent that can only be sent
1864 * by the system.
1865 *
1866 * {@hide}
1867 */
1868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1869 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1870 /**
1871 * Broadcast Action: Indicates memory full condition on the device
1872 * no longer exists.
1873 *
1874 * <p class="note">This is a protected intent that can only be sent
1875 * by the system.
1876 *
1877 * {@hide}
1878 */
1879 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1880 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1881 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001882 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1883 * and package management should be started.
1884 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1885 * notification.
1886 */
1887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1888 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1889 /**
1890 * Broadcast Action: The device has entered USB Mass Storage mode.
1891 * This is used mainly for the USB Settings panel.
1892 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1893 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001894 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001895 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001896 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001897 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1898
1899 /**
1900 * Broadcast Action: The device has exited USB Mass Storage mode.
1901 * This is used mainly for the USB Settings panel.
1902 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1903 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001904 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001905 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001906 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001907 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1908
1909 /**
1910 * Broadcast Action: External media has been removed.
1911 * The path to the mount point for the removed media is contained in the Intent.mData field.
1912 */
1913 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1914 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1915
1916 /**
1917 * Broadcast Action: External media is present, but not mounted at its mount point.
1918 * The path to the mount point for the removed media is contained in the Intent.mData field.
1919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1922
1923 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001924 * Broadcast Action: External media is present, and being disk-checked
1925 * 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 -08001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1929
1930 /**
1931 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1932 * 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 -08001933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1935 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1936
1937 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001938 * Broadcast Action: External media is present and mounted at its mount point.
1939 * The path to the mount point for the removed media is contained in the Intent.mData field.
1940 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1941 * media was mounted read only.
1942 */
1943 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1944 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1945
1946 /**
1947 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001948 * 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 -07001949 */
1950 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1951 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1952
1953 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001954 * Broadcast Action: External media is no longer being shared via USB mass storage.
1955 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1956 *
1957 * @hide
1958 */
1959 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1960
1961 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001962 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1963 * The path to the mount point for the removed media is contained in the Intent.mData field.
1964 */
1965 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1966 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1967
1968 /**
1969 * Broadcast Action: External media is present but cannot be mounted.
1970 * The path to the mount point for the removed media is contained in the Intent.mData field.
1971 */
1972 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1973 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1974
1975 /**
1976 * Broadcast Action: User has expressed the desire to remove the external storage media.
1977 * Applications should close all files they have open within the mount point when they receive this intent.
1978 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1979 */
1980 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1981 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1982
1983 /**
1984 * Broadcast Action: The media scanner has started scanning a directory.
1985 * The path to the directory being scanned is contained in the Intent.mData field.
1986 */
1987 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1988 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1989
1990 /**
1991 * Broadcast Action: The media scanner has finished scanning a directory.
1992 * The path to the scanned directory is contained in the Intent.mData field.
1993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1996
1997 /**
1998 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1999 * The path to the file is contained in the Intent.mData field.
2000 */
2001 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2002 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2003
2004 /**
2005 * Broadcast Action: The "Media Button" was pressed. Includes a single
2006 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2007 * caused the broadcast.
2008 */
2009 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2010 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2011
2012 /**
2013 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2014 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2015 * caused the broadcast.
2016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2019
2020 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2021 // location; they are not general-purpose actions.
2022
2023 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002024 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002025 */
2026 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2027 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2028 "android.intent.action.GTALK_CONNECTED";
2029
2030 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002031 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002032 */
2033 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2034 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2035 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002036
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002037 /**
2038 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002039 */
2040 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2041 public static final String ACTION_INPUT_METHOD_CHANGED =
2042 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002043
2044 /**
2045 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2046 * more radios have been turned off or on. The intent will have the following extra value:</p>
2047 * <ul>
2048 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2049 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2050 * turned off</li>
2051 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002052 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002053 * <p class="note">This is a protected intent that can only be sent
2054 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002055 */
2056 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2057 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2058
2059 /**
2060 * Broadcast Action: Some content providers have parts of their namespace
2061 * where they publish new events or items that the user may be especially
2062 * interested in. For these things, they may broadcast this action when the
2063 * set of interesting items change.
2064 *
2065 * For example, GmailProvider sends this notification when the set of unread
2066 * mail in the inbox changes.
2067 *
2068 * <p>The data of the intent identifies which part of which provider
2069 * changed. When queried through the content resolver, the data URI will
2070 * return the data set in question.
2071 *
2072 * <p>The intent will have the following extra values:
2073 * <ul>
2074 * <li><em>count</em> - The number of items in the data set. This is the
2075 * same as the number of items in the cursor returned by querying the
2076 * data URI. </li>
2077 * </ul>
2078 *
2079 * This intent will be sent at boot (if the count is non-zero) and when the
2080 * data set changes. It is possible for the data set to change without the
2081 * count changing (for example, if a new unread message arrives in the same
2082 * sync operation in which a message is archived). The phone should still
2083 * ring/vibrate/etc as normal in this case.
2084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_PROVIDER_CHANGED =
2087 "android.intent.action.PROVIDER_CHANGED";
2088
2089 /**
2090 * Broadcast Action: Wired Headset plugged in or unplugged.
2091 *
2092 * <p>The intent will have the following extra values:
2093 * <ul>
2094 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2095 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002096 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002097 * </ul>
2098 * </ul>
2099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_HEADSET_PLUG =
2102 "android.intent.action.HEADSET_PLUG";
2103
2104 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002105 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2106 *
2107 * <p>The intent will have the following extra values:
2108 * <ul>
2109 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2110 * <li><em>name</em> - Headset type, human readable string </li>
2111 * </ul>
2112 * </ul>
2113 * @hide
2114 */
2115 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002116 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2117 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002118
2119 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002120 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002121 *
2122 * <p>The intent will have the following extra values:
2123 * <ul>
2124 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2125 * <li><em>name</em> - Headset type, human readable string </li>
2126 * </ul>
2127 * </ul>
2128 * @hide
2129 */
2130 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002131 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2132 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002133
2134 /**
2135 * Broadcast Action: A HMDI cable was plugged or unplugged
2136 *
2137 * <p>The intent will have the following extra values:
2138 * <ul>
2139 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2140 * <li><em>name</em> - HDMI cable, human readable string </li>
2141 * </ul>
2142 * </ul>
2143 * @hide
2144 */
2145 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2146 public static final String ACTION_HDMI_AUDIO_PLUG =
2147 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002148
2149 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002150 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2151 *
2152 * <p>The intent will have the following extra values:
2153 * <ul>
2154 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2155 * <li><em>card</em> - ALSA card number (integer) </li>
2156 * <li><em>device</em> - ALSA device number (integer) </li>
2157 * </ul>
2158 * </ul>
2159 * @hide
2160 */
2161 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2162 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2163 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2164
2165 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002166 * Broadcast Action: A USB audio device was plugged in or unplugged.
2167 *
2168 * <p>The intent will have the following extra values:
2169 * <ul>
2170 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2171 * <li><em>card</em> - ALSA card number (integer) </li>
2172 * <li><em>device</em> - ALSA device number (integer) </li>
2173 * </ul>
2174 * </ul>
2175 * @hide
2176 */
2177 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2178 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2179 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2180
2181 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002182 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2183 * <ul>
2184 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2185 * </ul>
2186 *
2187 * <p class="note">This is a protected intent that can only be sent
2188 * by the system.
2189 *
2190 * @hide
2191 */
2192 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2193 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2194 = "android.intent.action.ADVANCED_SETTINGS";
2195
2196 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002197 * Broadcast Action: An outgoing call is about to be placed.
2198 *
2199 * <p>The Intent will have the following extra value:
2200 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002201 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002202 * the phone number originally intended to be dialed.</li>
2203 * </ul>
2204 * <p>Once the broadcast is finished, the resultData is used as the actual
2205 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002206 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002207 * outgoing call in turn: for example, a parental control application
2208 * might verify that the user is authorized to place the call at that
2209 * time, then a number-rewriting application might add an area code if
2210 * one was not specified.</p>
2211 * <p>For consistency, any receiver whose purpose is to prohibit phone
2212 * calls should have a priority of 0, to ensure it will see the final
2213 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002214 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002215 * should have a positive priority.
2216 * Negative priorities are reserved for the system for this broadcast;
2217 * using them may cause problems.</p>
2218 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2219 * abort the broadcast.</p>
2220 * <p>Emergency calls cannot be intercepted using this mechanism, and
2221 * other calls cannot be modified to call emergency numbers using this
2222 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002223 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002224 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2225 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002226 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002227 * <p class="note">This is a protected intent that can only be sent
2228 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002229 */
2230 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2231 public static final String ACTION_NEW_OUTGOING_CALL =
2232 "android.intent.action.NEW_OUTGOING_CALL";
2233
2234 /**
2235 * Broadcast Action: Have the device reboot. This is only for use by
2236 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002237 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002238 * <p class="note">This is a protected intent that can only be sent
2239 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002240 */
2241 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2242 public static final String ACTION_REBOOT =
2243 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002244
Wei Huang97ecc9c2009-05-11 17:44:20 -07002245 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002246 * Broadcast Action: A sticky broadcast for changes in the physical
2247 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002248 *
2249 * <p>The intent will have the following extra values:
2250 * <ul>
2251 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002252 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002253 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002254 * <p>This is intended for monitoring the current physical dock state.
2255 * See {@link android.app.UiModeManager} for the normal API dealing with
2256 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002257 */
2258 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2259 public static final String ACTION_DOCK_EVENT =
2260 "android.intent.action.DOCK_EVENT";
2261
2262 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002263 * Broadcast Action: a remote intent is to be broadcasted.
2264 *
2265 * A remote intent is used for remote RPC between devices. The remote intent
2266 * is serialized and sent from one device to another device. The receiving
2267 * device parses the remote intent and broadcasts it. Note that anyone can
2268 * broadcast a remote intent. However, if the intent receiver of the remote intent
2269 * does not trust intent broadcasts from arbitrary intent senders, it should require
2270 * the sender to hold certain permissions so only trusted sender's broadcast will be
2271 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002272 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002273 */
2274 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002275 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002276
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002277 /**
2278 * Broadcast Action: hook for permforming cleanup after a system update.
2279 *
2280 * The broadcast is sent when the system is booting, before the
2281 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2282 * image. A receiver for this should do its work and then disable itself
2283 * so that it does not get run again at the next boot.
2284 * @hide
2285 */
2286 public static final String ACTION_PRE_BOOT_COMPLETED =
2287 "android.intent.action.PRE_BOOT_COMPLETED";
2288
Amith Yamasani13593602012-03-22 16:16:17 -07002289 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002290 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USER_HANDLE that has the
2291 * userHandle of the new user.
Amith Yamasani13593602012-03-22 16:16:17 -07002292 * @hide
2293 */
2294 public static final String ACTION_USER_ADDED =
2295 "android.intent.action.USER_ADDED";
2296
2297 /**
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002298 * Broadcast sent to the system when a user is stopped. Carries an extra EXTRA_USER_HANDLE that has
2299 * the userHandle of the user. This is similar to {@link #ACTION_PACKAGE_RESTARTED},
2300 * but for an entire user instead of a specific package.
2301 * @hide
2302 */
2303 public static final String ACTION_USER_STOPPED =
2304 "android.intent.action.USER_STOPPED";
2305
2306 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002307 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
2308 * the userHandle of the user.
Amith Yamasani13593602012-03-22 16:16:17 -07002309 * @hide
2310 */
2311 public static final String ACTION_USER_REMOVED =
2312 "android.intent.action.USER_REMOVED";
2313
2314 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002315 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
2316 * the userHandle of the user to become the current one.
Amith Yamasani13593602012-03-22 16:16:17 -07002317 * @hide
2318 */
2319 public static final String ACTION_USER_SWITCHED =
2320 "android.intent.action.USER_SWITCHED";
2321
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002322 // ---------------------------------------------------------------------
2323 // ---------------------------------------------------------------------
2324 // Standard intent categories (see addCategory()).
2325
2326 /**
2327 * Set if the activity should be an option for the default action
2328 * (center press) to perform on a piece of data. Setting this will
2329 * hide from the user any activities without it set when performing an
2330 * action on some data. Note that this is normal -not- set in the
2331 * Intent when initiating an action -- it is for use in intent filters
2332 * specified in packages.
2333 */
2334 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2335 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2336 /**
2337 * Activities that can be safely invoked from a browser must support this
2338 * category. For example, if the user is viewing a web page or an e-mail
2339 * and clicks on a link in the text, the Intent generated execute that
2340 * link will require the BROWSABLE category, so that only activities
2341 * supporting this category will be considered as possible actions. By
2342 * supporting this category, you are promising that there is nothing
2343 * damaging (without user intervention) that can happen by invoking any
2344 * matching Intent.
2345 */
2346 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2347 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2348 /**
2349 * Set if the activity should be considered as an alternative action to
2350 * the data the user is currently viewing. See also
2351 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2352 * applies to the selection in a list of items.
2353 *
2354 * <p>Supporting this category means that you would like your activity to be
2355 * displayed in the set of alternative things the user can do, usually as
2356 * part of the current activity's options menu. You will usually want to
2357 * include a specific label in the &lt;intent-filter&gt; of this action
2358 * describing to the user what it does.
2359 *
2360 * <p>The action of IntentFilter with this category is important in that it
2361 * describes the specific action the target will perform. This generally
2362 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2363 * a specific name such as "com.android.camera.action.CROP. Only one
2364 * alternative of any particular action will be shown to the user, so using
2365 * a specific action like this makes sure that your alternative will be
2366 * displayed while also allowing other applications to provide their own
2367 * overrides of that particular action.
2368 */
2369 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2370 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2371 /**
2372 * Set if the activity should be considered as an alternative selection
2373 * action to the data the user has currently selected. This is like
2374 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2375 * of items from which the user can select, giving them alternatives to the
2376 * default action that will be performed on it.
2377 */
2378 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2379 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2380 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002381 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002382 */
2383 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2384 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2385 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002386 * Should be displayed in the top-level launcher.
2387 */
2388 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2389 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2390 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002391 * Provides information about the package it is in; typically used if
2392 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2393 * a front-door to the user without having to be shown in the all apps list.
2394 */
2395 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2396 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2397 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002398 * This is the home activity, that is the first activity that is displayed
2399 * when the device boots.
2400 */
2401 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2402 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2403 /**
2404 * This activity is a preference panel.
2405 */
2406 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2407 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2408 /**
2409 * This activity is a development preference panel.
2410 */
2411 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2412 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2413 /**
2414 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002415 */
2416 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2417 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2418 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002419 * This activity allows the user to browse and download new applications.
2420 */
2421 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2422 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2423 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002424 * This activity may be exercised by the monkey or other automated test tools.
2425 */
2426 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2427 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2428 /**
2429 * To be used as a test (not part of the normal user experience).
2430 */
2431 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2432 /**
2433 * To be used as a unit test (run through the Test Harness).
2434 */
2435 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2436 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002437 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002438 * experience).
2439 */
2440 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2441 /**
2442 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2443 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2444 * when queried, though it is allowable for those columns to be blank.
2445 */
2446 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2447 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2448
2449 /**
2450 * To be used as code under test for framework instrumentation tests.
2451 */
2452 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2453 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002454 /**
2455 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002456 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2457 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002458 */
2459 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2460 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2461 /**
2462 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002463 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2464 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002465 */
2466 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2467 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002468 /**
2469 * An activity to run when device is inserted into a analog (low end) dock.
2470 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2471 * information, see {@link android.app.UiModeManager}.
2472 */
2473 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2474 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2475
2476 /**
2477 * An activity to run when device is inserted into a digital (high end) dock.
2478 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2479 * information, see {@link android.app.UiModeManager}.
2480 */
2481 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2482 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002483
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002484 /**
2485 * Used to indicate that the activity can be used in a car environment.
2486 */
2487 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2488 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2489
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002490 // ---------------------------------------------------------------------
2491 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002492 // Application launch intent categories (see addCategory()).
2493
2494 /**
2495 * Used with {@link #ACTION_MAIN} to launch the browser application.
2496 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002497 * <p>NOTE: This should not be used as the primary key of an Intent,
2498 * since it will not result in the app launching with the correct
2499 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002500 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002501 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002502 */
2503 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2504 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2505
2506 /**
2507 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2508 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002509 * <p>NOTE: This should not be used as the primary key of an Intent,
2510 * since it will not result in the app launching with the correct
2511 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002512 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002513 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002514 */
2515 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2516 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2517
2518 /**
2519 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2520 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002521 * <p>NOTE: This should not be used as the primary key of an Intent,
2522 * since it will not result in the app launching with the correct
2523 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002524 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002525 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002526 */
2527 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2528 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2529
2530 /**
2531 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2532 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002533 * <p>NOTE: This should not be used as the primary key of an Intent,
2534 * since it will not result in the app launching with the correct
2535 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002536 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002537 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002538 */
2539 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2540 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2541
2542 /**
2543 * Used with {@link #ACTION_MAIN} to launch the email application.
2544 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002545 * <p>NOTE: This should not be used as the primary key of an Intent,
2546 * since it will not result in the app launching with the correct
2547 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002548 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002549 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002550 */
2551 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2552 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2553
2554 /**
2555 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2556 * The activity should be able to view and manipulate image and video files
2557 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002558 * <p>NOTE: This should not be used as the primary key of an Intent,
2559 * since it will not result in the app launching with the correct
2560 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002561 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002562 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002563 */
2564 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2565 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2566
2567 /**
2568 * Used with {@link #ACTION_MAIN} to launch the maps application.
2569 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002570 * <p>NOTE: This should not be used as the primary key of an Intent,
2571 * since it will not result in the app launching with the correct
2572 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002573 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002574 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002575 */
2576 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2577 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2578
2579 /**
2580 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2581 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002582 * <p>NOTE: This should not be used as the primary key of an Intent,
2583 * since it will not result in the app launching with the correct
2584 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002585 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002586 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002587 */
2588 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2589 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2590
2591 /**
2592 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002593 * The activity should be able to play, browse, or manipulate music files
2594 * stored on the device.
2595 * <p>NOTE: This should not be used as the primary key of an Intent,
2596 * since it will not result in the app launching with the correct
2597 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002598 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002599 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002600 */
2601 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2602 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2603
2604 // ---------------------------------------------------------------------
2605 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002606 // Standard extra data keys.
2607
2608 /**
2609 * The initial data to place in a newly created record. Use with
2610 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2611 * fields as would be given to the underlying ContentProvider.insert()
2612 * call.
2613 */
2614 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2615
2616 /**
2617 * A constant CharSequence that is associated with the Intent, used with
2618 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2619 * this may be a styled CharSequence, so you must use
2620 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2621 * retrieve it.
2622 */
2623 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2624
2625 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002626 * A constant String that is associated with the Intent, used with
2627 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2628 * as HTML formatted text. Note that you <em>must</em> also supply
2629 * {@link #EXTRA_TEXT}.
2630 */
2631 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2632
2633 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002634 * A content: URI holding a stream of data associated with the Intent,
2635 * used with {@link #ACTION_SEND} to supply the data being sent.
2636 */
2637 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2638
2639 /**
2640 * A String[] holding e-mail addresses that should be delivered to.
2641 */
2642 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2643
2644 /**
2645 * A String[] holding e-mail addresses that should be carbon copied.
2646 */
2647 public static final String EXTRA_CC = "android.intent.extra.CC";
2648
2649 /**
2650 * A String[] holding e-mail addresses that should be blind carbon copied.
2651 */
2652 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2653
2654 /**
2655 * A constant string holding the desired subject line of a message.
2656 */
2657 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2658
2659 /**
2660 * An Intent describing the choices you would like shown with
2661 * {@link #ACTION_PICK_ACTIVITY}.
2662 */
2663 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2664
2665 /**
2666 * A CharSequence dialog title to provide to the user when used with a
2667 * {@link #ACTION_CHOOSER}.
2668 */
2669 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2670
2671 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002672 * A Parcelable[] of {@link Intent} or
2673 * {@link android.content.pm.LabeledIntent} objects as set with
2674 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2675 * a the front of the list of choices, when shown to the user with a
2676 * {@link #ACTION_CHOOSER}.
2677 */
2678 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2679
2680 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002681 * A {@link android.view.KeyEvent} object containing the event that
2682 * triggered the creation of the Intent it is in.
2683 */
2684 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2685
2686 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002687 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2688 * before shutting down.
2689 *
2690 * {@hide}
2691 */
2692 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2693
2694 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002695 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002696 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2697 * of restarting the application.
2698 */
2699 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2700
2701 /**
2702 * A String holding the phone number originally entered in
2703 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2704 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2705 */
2706 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002707
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002708 /**
2709 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2710 * intents to supply the uid the package had been assigned. Also an optional
2711 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2712 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2713 * purpose.
2714 */
2715 public static final String EXTRA_UID = "android.intent.extra.UID";
2716
2717 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002718 * @hide String array of package names.
2719 */
2720 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2721
2722 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002723 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2724 * intents to indicate whether this represents a full uninstall (removing
2725 * both the code and its data) or a partial uninstall (leaving its data,
2726 * implying that this is an update).
2727 */
2728 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002729
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002730 /**
2731 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2732 * intents to indicate that this is a replacement of the package, so this
2733 * broadcast will immediately be followed by an add broadcast for a
2734 * different version of the same package.
2735 */
2736 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002737
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002738 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002739 * Used as an int extra field in {@link android.app.AlarmManager} intents
2740 * to tell the application being invoked how many pending alarms are being
2741 * delievered with the intent. For one-shot alarms this will always be 1.
2742 * For recurring alarms, this might be greater than 1 if the device was
2743 * asleep or powered off at the time an earlier alarm would have been
2744 * delivered.
2745 */
2746 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002747
Jacek Surazski86b6c532009-05-13 14:38:28 +02002748 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002749 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2750 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002751 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2752 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002753 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2754 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2755 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002756 */
2757 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2758
2759 /**
2760 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2761 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002762 */
2763 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2764
2765 /**
2766 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2767 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002768 */
2769 public static final int EXTRA_DOCK_STATE_DESK = 1;
2770
2771 /**
2772 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2773 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002774 */
2775 public static final int EXTRA_DOCK_STATE_CAR = 2;
2776
2777 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002778 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2779 * to represent that the phone is in a analog (low end) dock.
2780 */
2781 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2782
2783 /**
2784 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2785 * to represent that the phone is in a digital (high end) dock.
2786 */
2787 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2788
2789 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002790 * Boolean that can be supplied as meta-data with a dock activity, to
2791 * indicate that the dock should take over the home key when it is active.
2792 */
2793 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002794
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002795 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002796 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2797 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002798 */
2799 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2800
2801 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002802 * Used in the extra field in the remote intent. It's astring token passed with the
2803 * remote intent.
2804 */
2805 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2806 "android.intent.extra.remote_intent_token";
2807
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002808 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002809 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002810 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002811 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002812 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002813 "android.intent.extra.changed_component_name";
2814
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002815 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002816 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002817 * and contains a string array of all of the components that have changed.
2818 */
2819 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2820 "android.intent.extra.changed_component_name_list";
2821
2822 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002823 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002824 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2825 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002826 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002827 */
2828 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2829 "android.intent.extra.changed_package_list";
2830
2831 /**
2832 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002833 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2834 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002835 * and contains an integer array of uids of all of the components
2836 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002837 */
2838 public static final String EXTRA_CHANGED_UID_LIST =
2839 "android.intent.extra.changed_uid_list";
2840
2841 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002842 * @hide
2843 * Magic extra system code can use when binding, to give a label for
2844 * who it is that has bound to a service. This is an integer giving
2845 * a framework string resource that can be displayed to the user.
2846 */
2847 public static final String EXTRA_CLIENT_LABEL =
2848 "android.intent.extra.client_label";
2849
2850 /**
2851 * @hide
2852 * Magic extra system code can use when binding, to give a PendingIntent object
2853 * that can be launched for the user to disable the system's use of this
2854 * service.
2855 */
2856 public static final String EXTRA_CLIENT_INTENT =
2857 "android.intent.extra.client_intent";
2858
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002859 /**
2860 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2861 * data that is on the local device. This is a boolean extra; the default
2862 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2863 * the user to select media that is already on the device, not requiring it
2864 * be downloaded from a remote service when opened. Another way to look
2865 * at it is that such content should generally have a "_data" column to the
2866 * path of the content on local external storage.
2867 */
2868 public static final String EXTRA_LOCAL_ONLY =
2869 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002870
Amith Yamasani13593602012-03-22 16:16:17 -07002871 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002872 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07002873 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2874 * @hide
2875 */
Amith Yamasani2a003292012-08-14 18:25:45 -07002876 public static final String EXTRA_USER_HANDLE =
2877 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07002878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002879 // ---------------------------------------------------------------------
2880 // ---------------------------------------------------------------------
2881 // Intent flags (see mFlags variable).
2882
2883 /**
2884 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002885 * perform read operations on the Uri in the Intent's data and any URIs
2886 * specified in its ClipData. When applying to an Intent's ClipData,
2887 * all URIs as well as recursive traversals through data or other ClipData
2888 * in Intent items will be granted; only the grant flags of the top-level
2889 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002890 */
2891 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2892 /**
2893 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002894 * perform write operations on the Uri in the Intent's data and any URIs
2895 * specified in its ClipData. When applying to an Intent's ClipData,
2896 * all URIs as well as recursive traversals through data or other ClipData
2897 * in Intent items will be granted; only the grant flags of the top-level
2898 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002899 */
2900 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2901 /**
2902 * Can be set by the caller to indicate that this Intent is coming from
2903 * a background operation, not from direct user interaction.
2904 */
2905 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2906 /**
2907 * A flag you can enable for debugging: when set, log messages will be
2908 * printed during the resolution of this intent to show you what has
2909 * been found to create the final resolved list.
2910 */
2911 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002912 /**
2913 * If set, this intent will not match any components in packages that
2914 * are currently stopped. If this is not set, then the default behavior
2915 * is to include such applications in the result.
2916 */
2917 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2918 /**
2919 * If set, this intent will always match any components in packages that
2920 * are currently stopped. This is the default behavior when
2921 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2922 * flags are set, this one wins (it allows overriding of exclude for
2923 * places where the framework may automatically set the exclude flag).
2924 */
2925 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002926
2927 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002928 * If set, the new activity is not kept in the history stack. As soon as
2929 * the user navigates away from it, the activity is finished. This may also
2930 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2931 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002932 */
2933 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2934 /**
2935 * If set, the activity will not be launched if it is already running
2936 * at the top of the history stack.
2937 */
2938 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2939 /**
2940 * If set, this activity will become the start of a new task on this
2941 * history stack. A task (from the activity that started it to the
2942 * next task activity) defines an atomic group of activities that the
2943 * user can move to. Tasks can be moved to the foreground and background;
2944 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002945 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002946 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2947 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002948 *
2949 * <p>This flag is generally used by activities that want
2950 * to present a "launcher" style behavior: they give the user a list of
2951 * separate things that can be done, which otherwise run completely
2952 * independently of the activity launching them.
2953 *
2954 * <p>When using this flag, if a task is already running for the activity
2955 * you are now starting, then a new activity will not be started; instead,
2956 * the current task will simply be brought to the front of the screen with
2957 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2958 * to disable this behavior.
2959 *
2960 * <p>This flag can not be used when the caller is requesting a result from
2961 * the activity being launched.
2962 */
2963 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2964 /**
2965 * <strong>Do not use this flag unless you are implementing your own
2966 * top-level application launcher.</strong> Used in conjunction with
2967 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2968 * behavior of bringing an existing task to the foreground. When set,
2969 * a new task is <em>always</em> started to host the Activity for the
2970 * Intent, regardless of whether there is already an existing task running
2971 * the same thing.
2972 *
2973 * <p><strong>Because the default system does not include graphical task management,
2974 * you should not use this flag unless you provide some way for a user to
2975 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002976 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002977 * <p>This flag is ignored if
2978 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2979 *
Scott Main7aee61f2011-02-08 11:25:01 -08002980 * <p>See
2981 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2982 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002983 */
2984 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2985 /**
2986 * If set, and the activity being launched is already running in the
2987 * current task, then instead of launching a new instance of that activity,
2988 * all of the other activities on top of it will be closed and this Intent
2989 * will be delivered to the (now on top) old activity as a new Intent.
2990 *
2991 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2992 * If D calls startActivity() with an Intent that resolves to the component
2993 * of activity B, then C and D will be finished and B receive the given
2994 * Intent, resulting in the stack now being: A, B.
2995 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002996 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002997 * either receive the new intent you are starting here in its
2998 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002999 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003000 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3001 * the same intent, then it will be finished and re-created; for all other
3002 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3003 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003004 *
3005 * <p>This launch mode can also be used to good effect in conjunction with
3006 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3007 * of a task, it will bring any currently running instance of that task
3008 * to the foreground, and then clear it to its root state. This is
3009 * especially useful, for example, when launching an activity from the
3010 * notification manager.
3011 *
Scott Main7aee61f2011-02-08 11:25:01 -08003012 * <p>See
3013 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3014 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003015 */
3016 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3017 /**
3018 * If set and this intent is being used to launch a new activity from an
3019 * existing one, then the reply target of the existing activity will be
3020 * transfered to the new activity. This way the new activity can call
3021 * {@link android.app.Activity#setResult} and have that result sent back to
3022 * the reply target of the original activity.
3023 */
3024 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3025 /**
3026 * If set and this intent is being used to launch a new activity from an
3027 * existing one, the current activity will not be counted as the top
3028 * activity for deciding whether the new intent should be delivered to
3029 * the top instead of starting a new one. The previous activity will
3030 * be used as the top, with the assumption being that the current activity
3031 * will finish itself immediately.
3032 */
3033 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3034 /**
3035 * If set, the new activity is not kept in the list of recently launched
3036 * activities.
3037 */
3038 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3039 /**
3040 * This flag is not normally set by application code, but set for you by
3041 * the system as described in the
3042 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3043 * launchMode} documentation for the singleTask mode.
3044 */
3045 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3046 /**
3047 * If set, and this activity is either being started in a new task or
3048 * bringing to the top an existing task, then it will be launched as
3049 * the front door of the task. This will result in the application of
3050 * any affinities needed to have that task in the proper state (either
3051 * moving activities to or from it), or simply resetting that task to
3052 * its initial state if needed.
3053 */
3054 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3055 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003056 * This flag is not normally set by application code, but set for you by
3057 * the system if this activity is being launched from history
3058 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003059 */
3060 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003061 /**
3062 * If set, this marks a point in the task's activity stack that should
3063 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003064 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003065 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3066 * the user re-launching it from home), this activity and all on top of
3067 * it will be finished so that the user does not return to them, but
3068 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003069 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003070 * <p>This is useful for cases where you have a logical break in your
3071 * application. For example, an e-mail application may have a command
3072 * to view an attachment, which launches an image view activity to
3073 * display it. This activity should be part of the e-mail application's
3074 * task, since it is a part of the task the user is involved in. However,
3075 * if the user leaves that task, and later selects the e-mail app from
3076 * home, we may like them to return to the conversation they were
3077 * viewing, not the picture attachment, since that is confusing. By
3078 * setting this flag when launching the image viewer, that viewer and
3079 * any activities it starts will be removed the next time the user returns
3080 * to mail.
3081 */
3082 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003083 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003084 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003085 * callback from occurring on the current frontmost activity before it is
3086 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003087 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003088 * <p>Typically, an activity can rely on that callback to indicate that an
3089 * explicit user action has caused their activity to be moved out of the
3090 * foreground. The callback marks an appropriate point in the activity's
3091 * lifecycle for it to dismiss any notifications that it intends to display
3092 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003093 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003094 * <p>If an activity is ever started via any non-user-driven events such as
3095 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3096 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003097 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003098 */
3099 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003100 /**
3101 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3102 * this flag will cause the launched activity to be brought to the front of its
3103 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003104 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003105 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3106 * If D calls startActivity() with an Intent that resolves to the component
3107 * of activity B, then B will be brought to the front of the history stack,
3108 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003109 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003110 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003111 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003112 */
3113 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003114 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003115 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3116 * this flag will prevent the system from applying an activity transition
3117 * animation to go to the next activity state. This doesn't mean an
3118 * animation will never run -- if another activity change happens that doesn't
3119 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003120 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003121 * when you are going to do a series of activity operations but the
3122 * animation seen by the user shouldn't be driven by the first activity
3123 * change but rather a later one.
3124 */
3125 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3126 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003127 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3128 * this flag will cause any existing task that would be associated with the
3129 * activity to be cleared before the activity is started. That is, the activity
3130 * becomes the new root of an otherwise empty task, and any old activities
3131 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3132 */
3133 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3134 /**
3135 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3136 * this flag will cause a newly launching task to be placed on top of the current
3137 * home activity task (if there is one). That is, pressing back from the task
3138 * will always return the user to home even if that was not the last activity they
3139 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3140 */
3141 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3142 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003143 * If set, when sending a broadcast only registered receivers will be
3144 * called -- no BroadcastReceiver components will be launched.
3145 */
3146 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003147 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003148 * If set, when sending a broadcast the new broadcast will replace
3149 * any existing pending broadcast that matches it. Matching is defined
3150 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3151 * true for the intents of the two broadcasts. When a match is found,
3152 * the new broadcast (and receivers associated with it) will replace the
3153 * existing one in the pending broadcast list, remaining at the same
3154 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003155 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003156 * <p>This flag is most typically used with sticky broadcasts, which
3157 * only care about delivering the most recent values of the broadcast
3158 * to their receivers.
3159 */
3160 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3161 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003162 * If set, when sending a broadcast the recipient is allowed to run at
3163 * foreground priority, with a shorter timeout interval. During normal
3164 * broadcasts the receivers are not automatically hoisted out of the
3165 * background priority class.
3166 */
3167 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3168 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003169 * If set, when sending a broadcast <i>before boot has completed</i> only
3170 * registered receivers will be called -- no BroadcastReceiver components
3171 * will be launched. Sticky intent state will be recorded properly even
3172 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3173 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003174 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003175 * <p>This flag is only for use by system sevices as a convenience to
3176 * avoid having to implement a more complex mechanism around detection
3177 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003178 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003179 * @hide
3180 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003181 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003182 /**
3183 * Set when this broadcast is for a boot upgrade, a special mode that
3184 * allows the broadcast to be sent before the system is ready and launches
3185 * the app process with no providers running in it.
3186 * @hide
3187 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003188 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003189
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003190 /**
3191 * @hide Flags that can't be changed with PendingIntent.
3192 */
3193 public static final int IMMUTABLE_FLAGS =
3194 FLAG_GRANT_READ_URI_PERMISSION
3195 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003196
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003197 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003198 // ---------------------------------------------------------------------
3199 // toUri() and parseUri() options.
3200
3201 /**
3202 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3203 * always has the "intent:" scheme. This syntax can be used when you want
3204 * to later disambiguate between URIs that are intended to describe an
3205 * Intent vs. all others that should be treated as raw URIs. When used
3206 * with {@link #parseUri}, any other scheme will result in a generic
3207 * VIEW action for that raw URI.
3208 */
3209 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003210
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003211 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003212
3213 private String mAction;
3214 private Uri mData;
3215 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003216 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003217 private ComponentName mComponent;
3218 private int mFlags;
3219 private HashSet<String> mCategories;
3220 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003221 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003222 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003223 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003224
3225 // ---------------------------------------------------------------------
3226
3227 /**
3228 * Create an empty intent.
3229 */
3230 public Intent() {
3231 }
3232
3233 /**
3234 * Copy constructor.
3235 */
3236 public Intent(Intent o) {
3237 this.mAction = o.mAction;
3238 this.mData = o.mData;
3239 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003240 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003241 this.mComponent = o.mComponent;
3242 this.mFlags = o.mFlags;
3243 if (o.mCategories != null) {
3244 this.mCategories = new HashSet<String>(o.mCategories);
3245 }
3246 if (o.mExtras != null) {
3247 this.mExtras = new Bundle(o.mExtras);
3248 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003249 if (o.mSourceBounds != null) {
3250 this.mSourceBounds = new Rect(o.mSourceBounds);
3251 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003252 if (o.mSelector != null) {
3253 this.mSelector = new Intent(o.mSelector);
3254 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003255 if (o.mClipData != null) {
3256 this.mClipData = new ClipData(o.mClipData);
3257 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003258 }
3259
3260 @Override
3261 public Object clone() {
3262 return new Intent(this);
3263 }
3264
3265 private Intent(Intent o, boolean all) {
3266 this.mAction = o.mAction;
3267 this.mData = o.mData;
3268 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003269 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003270 this.mComponent = o.mComponent;
3271 if (o.mCategories != null) {
3272 this.mCategories = new HashSet<String>(o.mCategories);
3273 }
3274 }
3275
3276 /**
3277 * Make a clone of only the parts of the Intent that are relevant for
3278 * filter matching: the action, data, type, component, and categories.
3279 */
3280 public Intent cloneFilter() {
3281 return new Intent(this, false);
3282 }
3283
3284 /**
3285 * Create an intent with a given action. All other fields (data, type,
3286 * class) are null. Note that the action <em>must</em> be in a
3287 * namespace because Intents are used globally in the system -- for
3288 * example the system VIEW action is android.intent.action.VIEW; an
3289 * application's custom action would be something like
3290 * com.google.app.myapp.CUSTOM_ACTION.
3291 *
3292 * @param action The Intent action, such as ACTION_VIEW.
3293 */
3294 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003295 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003296 }
3297
3298 /**
3299 * Create an intent with a given action and for a given data url. Note
3300 * that the action <em>must</em> be in a namespace because Intents are
3301 * used globally in the system -- for example the system VIEW action is
3302 * android.intent.action.VIEW; an application's custom action would be
3303 * something like com.google.app.myapp.CUSTOM_ACTION.
3304 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003305 * <p><em>Note: scheme and host name matching in the Android framework is
3306 * case-sensitive, unlike the formal RFC. As a result,
3307 * you should always ensure that you write your Uri with these elements
3308 * using lower case letters, and normalize any Uris you receive from
3309 * outside of Android to ensure the scheme and host is lower case.</em></p>
3310 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003311 * @param action The Intent action, such as ACTION_VIEW.
3312 * @param uri The Intent data URI.
3313 */
3314 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003315 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003316 mData = uri;
3317 }
3318
3319 /**
3320 * Create an intent for a specific component. All other fields (action, data,
3321 * type, class) are null, though they can be modified later with explicit
3322 * calls. This provides a convenient way to create an intent that is
3323 * intended to execute a hard-coded class name, rather than relying on the
3324 * system to find an appropriate class for you; see {@link #setComponent}
3325 * for more information on the repercussions of this.
3326 *
3327 * @param packageContext A Context of the application package implementing
3328 * this class.
3329 * @param cls The component class that is to be used for the intent.
3330 *
3331 * @see #setClass
3332 * @see #setComponent
3333 * @see #Intent(String, android.net.Uri , Context, Class)
3334 */
3335 public Intent(Context packageContext, Class<?> cls) {
3336 mComponent = new ComponentName(packageContext, cls);
3337 }
3338
3339 /**
3340 * Create an intent for a specific component with a specified action and data.
3341 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3342 * construct the Intent and then calling {@link #setClass} to set its
3343 * class.
3344 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003345 * <p><em>Note: scheme and host name matching in the Android framework is
3346 * case-sensitive, unlike the formal RFC. As a result,
3347 * you should always ensure that you write your Uri with these elements
3348 * using lower case letters, and normalize any Uris you receive from
3349 * outside of Android to ensure the scheme and host is lower case.</em></p>
3350 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003351 * @param action The Intent action, such as ACTION_VIEW.
3352 * @param uri The Intent data URI.
3353 * @param packageContext A Context of the application package implementing
3354 * this class.
3355 * @param cls The component class that is to be used for the intent.
3356 *
3357 * @see #Intent(String, android.net.Uri)
3358 * @see #Intent(Context, Class)
3359 * @see #setClass
3360 * @see #setComponent
3361 */
3362 public Intent(String action, Uri uri,
3363 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003364 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003365 mData = uri;
3366 mComponent = new ComponentName(packageContext, cls);
3367 }
3368
3369 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003370 * Create an intent to launch the main (root) activity of a task. This
3371 * is the Intent that is started when the application's is launched from
3372 * Home. For anything else that wants to launch an application in the
3373 * same way, it is important that they use an Intent structured the same
3374 * way, and can use this function to ensure this is the case.
3375 *
3376 * <p>The returned Intent has the given Activity component as its explicit
3377 * component, {@link #ACTION_MAIN} as its action, and includes the
3378 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3379 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3380 * to do that through {@link #addFlags(int)} on the returned Intent.
3381 *
3382 * @param mainActivity The main activity component that this Intent will
3383 * launch.
3384 * @return Returns a newly created Intent that can be used to launch the
3385 * activity as a main application entry.
3386 *
3387 * @see #setClass
3388 * @see #setComponent
3389 */
3390 public static Intent makeMainActivity(ComponentName mainActivity) {
3391 Intent intent = new Intent(ACTION_MAIN);
3392 intent.setComponent(mainActivity);
3393 intent.addCategory(CATEGORY_LAUNCHER);
3394 return intent;
3395 }
3396
3397 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003398 * Make an Intent for the main activity of an application, without
3399 * specifying a specific activity to run but giving a selector to find
3400 * the activity. This results in a final Intent that is structured
3401 * the same as when the application is launched from
3402 * Home. For anything else that wants to launch an application in the
3403 * same way, it is important that they use an Intent structured the same
3404 * way, and can use this function to ensure this is the case.
3405 *
3406 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3407 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3408 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3409 * to do that through {@link #addFlags(int)} on the returned Intent.
3410 *
3411 * @param selectorAction The action name of the Intent's selector.
3412 * @param selectorCategory The name of a category to add to the Intent's
3413 * selector.
3414 * @return Returns a newly created Intent that can be used to launch the
3415 * activity as a main application entry.
3416 *
3417 * @see #setSelector(Intent)
3418 */
3419 public static Intent makeMainSelectorActivity(String selectorAction,
3420 String selectorCategory) {
3421 Intent intent = new Intent(ACTION_MAIN);
3422 intent.addCategory(CATEGORY_LAUNCHER);
3423 Intent selector = new Intent();
3424 selector.setAction(selectorAction);
3425 selector.addCategory(selectorCategory);
3426 intent.setSelector(selector);
3427 return intent;
3428 }
3429
3430 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003431 * Make an Intent that can be used to re-launch an application's task
3432 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3433 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3434 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3435 *
3436 * @param mainActivity The activity component that is the root of the
3437 * task; this is the activity that has been published in the application's
3438 * manifest as the main launcher icon.
3439 *
3440 * @return Returns a newly created Intent that can be used to relaunch the
3441 * activity's task in its root state.
3442 */
3443 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3444 Intent intent = makeMainActivity(mainActivity);
3445 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3446 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3447 return intent;
3448 }
3449
3450 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003451 * Call {@link #parseUri} with 0 flags.
3452 * @deprecated Use {@link #parseUri} instead.
3453 */
3454 @Deprecated
3455 public static Intent getIntent(String uri) throws URISyntaxException {
3456 return parseUri(uri, 0);
3457 }
Tom Taylord4a47292009-12-21 13:59:18 -08003458
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003459 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003460 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003461 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003462 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003463 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003464 *
3465 * <p>The URI given here must not be relative -- that is, it must include
3466 * the scheme and full path.
3467 *
3468 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003469 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003470 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003471 *
3472 * @return Intent The newly created Intent object.
3473 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003474 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3475 * it bad (as parsed by the Uri class) or the Intent data within the
3476 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003477 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003478 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003479 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003480 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003481 int i = 0;
3482 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003483 // Validate intent scheme for if requested.
3484 if ((flags&URI_INTENT_SCHEME) != 0) {
3485 if (!uri.startsWith("intent:")) {
3486 Intent intent = new Intent(ACTION_VIEW);
3487 try {
3488 intent.setData(Uri.parse(uri));
3489 } catch (IllegalArgumentException e) {
3490 throw new URISyntaxException(uri, e.getMessage());
3491 }
3492 return intent;
3493 }
3494 }
Tom Taylord4a47292009-12-21 13:59:18 -08003495
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003496 // simple case
3497 i = uri.lastIndexOf("#");
3498 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3499
3500 // old format Intent URI
3501 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003502
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003503 // new format
3504 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003505 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003506
3507 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003508 String data = i >= 0 ? uri.substring(0, i) : null;
3509 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003510 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003511
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003512 // loop over contents of Intent, all name=value;
3513 while (!uri.startsWith("end", i)) {
3514 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003515 if (eq < 0) eq = i-1;
3516 int semi = uri.indexOf(';', i);
3517 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003518
3519 // action
3520 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003521 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003522 }
3523
3524 // categories
3525 else if (uri.startsWith("category=", i)) {
3526 intent.addCategory(value);
3527 }
3528
3529 // type
3530 else if (uri.startsWith("type=", i)) {
3531 intent.mType = value;
3532 }
3533
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003534 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003535 else if (uri.startsWith("launchFlags=", i)) {
3536 intent.mFlags = Integer.decode(value).intValue();
3537 }
3538
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003539 // package
3540 else if (uri.startsWith("package=", i)) {
3541 intent.mPackage = value;
3542 }
3543
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003544 // component
3545 else if (uri.startsWith("component=", i)) {
3546 intent.mComponent = ComponentName.unflattenFromString(value);
3547 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003548
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003549 // scheme
3550 else if (uri.startsWith("scheme=", i)) {
3551 scheme = value;
3552 }
3553
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003554 // source bounds
3555 else if (uri.startsWith("sourceBounds=", i)) {
3556 intent.mSourceBounds = Rect.unflattenFromString(value);
3557 }
3558
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003559 // selector
3560 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3561 intent = new Intent();
3562 }
3563
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003564 // extra
3565 else {
3566 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003567 // create Bundle if it doesn't already exist
3568 if (intent.mExtras == null) intent.mExtras = new Bundle();
3569 Bundle b = intent.mExtras;
3570 // add EXTRA
3571 if (uri.startsWith("S.", i)) b.putString(key, value);
3572 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3573 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3574 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3575 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3576 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3577 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3578 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3579 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3580 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3581 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003582
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003583 // move to the next item
3584 i = semi + 1;
3585 }
3586
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003587 if (intent != baseIntent) {
3588 // The Intent had a selector; fix it up.
3589 baseIntent.setSelector(intent);
3590 intent = baseIntent;
3591 }
3592
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003593 if (data != null) {
3594 if (data.startsWith("intent:")) {
3595 data = data.substring(7);
3596 if (scheme != null) {
3597 data = scheme + ':' + data;
3598 }
3599 }
Tom Taylord4a47292009-12-21 13:59:18 -08003600
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003601 if (data.length() > 0) {
3602 try {
3603 intent.mData = Uri.parse(data);
3604 } catch (IllegalArgumentException e) {
3605 throw new URISyntaxException(uri, e.getMessage());
3606 }
3607 }
3608 }
Tom Taylord4a47292009-12-21 13:59:18 -08003609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003610 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003611
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003612 } catch (IndexOutOfBoundsException e) {
3613 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3614 }
3615 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003616
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003617 public static Intent getIntentOld(String uri) throws URISyntaxException {
3618 Intent intent;
3619
3620 int i = uri.lastIndexOf('#');
3621 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003622 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003623 final int intentFragmentStart = i;
3624 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003625
3626 i++;
3627
3628 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003629 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003630 i += 7;
3631 int j = uri.indexOf(')', i);
3632 action = uri.substring(i, j);
3633 i = j + 1;
3634 }
3635
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003636 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003637
3638 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003639 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003640 i += 11;
3641 int j = uri.indexOf(')', i);
3642 while (i < j) {
3643 int sep = uri.indexOf('!', i);
3644 if (sep < 0) sep = j;
3645 if (i < sep) {
3646 intent.addCategory(uri.substring(i, sep));
3647 }
3648 i = sep + 1;
3649 }
3650 i = j + 1;
3651 }
3652
3653 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003654 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003655 i += 5;
3656 int j = uri.indexOf(')', i);
3657 intent.mType = uri.substring(i, j);
3658 i = j + 1;
3659 }
3660
3661 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003662 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663 i += 12;
3664 int j = uri.indexOf(')', i);
3665 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3666 i = j + 1;
3667 }
3668
3669 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003670 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003671 i += 10;
3672 int j = uri.indexOf(')', i);
3673 int sep = uri.indexOf('!', i);
3674 if (sep >= 0 && sep < j) {
3675 String pkg = uri.substring(i, sep);
3676 String cls = uri.substring(sep + 1, j);
3677 intent.mComponent = new ComponentName(pkg, cls);
3678 }
3679 i = j + 1;
3680 }
3681
3682 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003683 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003684 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003685
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003686 final int closeParen = uri.indexOf(')', i);
3687 if (closeParen == -1) throw new URISyntaxException(uri,
3688 "EXTRA missing trailing ')'", i);
3689
3690 while (i < closeParen) {
3691 // fetch the key value
3692 int j = uri.indexOf('=', i);
3693 if (j <= i + 1 || i >= closeParen) {
3694 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3695 }
3696 char type = uri.charAt(i);
3697 i++;
3698 String key = uri.substring(i, j);
3699 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003700
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003701 // get type-value
3702 j = uri.indexOf('!', i);
3703 if (j == -1 || j >= closeParen) j = closeParen;
3704 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3705 String value = uri.substring(i, j);
3706 i = j;
3707
3708 // create Bundle if it doesn't already exist
3709 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003710
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003711 // add item to bundle
3712 try {
3713 switch (type) {
3714 case 'S':
3715 intent.mExtras.putString(key, Uri.decode(value));
3716 break;
3717 case 'B':
3718 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3719 break;
3720 case 'b':
3721 intent.mExtras.putByte(key, Byte.parseByte(value));
3722 break;
3723 case 'c':
3724 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3725 break;
3726 case 'd':
3727 intent.mExtras.putDouble(key, Double.parseDouble(value));
3728 break;
3729 case 'f':
3730 intent.mExtras.putFloat(key, Float.parseFloat(value));
3731 break;
3732 case 'i':
3733 intent.mExtras.putInt(key, Integer.parseInt(value));
3734 break;
3735 case 'l':
3736 intent.mExtras.putLong(key, Long.parseLong(value));
3737 break;
3738 case 's':
3739 intent.mExtras.putShort(key, Short.parseShort(value));
3740 break;
3741 default:
3742 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3743 }
3744 } catch (NumberFormatException e) {
3745 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3746 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003747
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003748 char ch = uri.charAt(i);
3749 if (ch == ')') break;
3750 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3751 i++;
3752 }
3753 }
3754
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003755 if (isIntentFragment) {
3756 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3757 } else {
3758 intent.mData = Uri.parse(uri);
3759 }
Tom Taylord4a47292009-12-21 13:59:18 -08003760
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003761 if (intent.mAction == null) {
3762 // By default, if no action is specified, then use VIEW.
3763 intent.mAction = ACTION_VIEW;
3764 }
3765
3766 } else {
3767 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3768 }
3769
3770 return intent;
3771 }
3772
3773 /**
3774 * Retrieve the general action to be performed, such as
3775 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3776 * the information in the intent should be interpreted -- most importantly,
3777 * what to do with the data returned by {@link #getData}.
3778 *
3779 * @return The action of this intent or null if none is specified.
3780 *
3781 * @see #setAction
3782 */
3783 public String getAction() {
3784 return mAction;
3785 }
3786
3787 /**
3788 * Retrieve data this intent is operating on. This URI specifies the name
3789 * of the data; often it uses the content: scheme, specifying data in a
3790 * content provider. Other schemes may be handled by specific activities,
3791 * such as http: by the web browser.
3792 *
3793 * @return The URI of the data this intent is targeting or null.
3794 *
3795 * @see #getScheme
3796 * @see #setData
3797 */
3798 public Uri getData() {
3799 return mData;
3800 }
3801
3802 /**
3803 * The same as {@link #getData()}, but returns the URI as an encoded
3804 * String.
3805 */
3806 public String getDataString() {
3807 return mData != null ? mData.toString() : null;
3808 }
3809
3810 /**
3811 * Return the scheme portion of the intent's data. If the data is null or
3812 * does not include a scheme, null is returned. Otherwise, the scheme
3813 * prefix without the final ':' is returned, i.e. "http".
3814 *
3815 * <p>This is the same as calling getData().getScheme() (and checking for
3816 * null data).
3817 *
3818 * @return The scheme of this intent.
3819 *
3820 * @see #getData
3821 */
3822 public String getScheme() {
3823 return mData != null ? mData.getScheme() : null;
3824 }
3825
3826 /**
3827 * Retrieve any explicit MIME type included in the intent. This is usually
3828 * null, as the type is determined by the intent data.
3829 *
3830 * @return If a type was manually set, it is returned; else null is
3831 * returned.
3832 *
3833 * @see #resolveType(ContentResolver)
3834 * @see #setType
3835 */
3836 public String getType() {
3837 return mType;
3838 }
3839
3840 /**
3841 * Return the MIME data type of this intent. If the type field is
3842 * explicitly set, that is simply returned. Otherwise, if the data is set,
3843 * the type of that data is returned. If neither fields are set, a null is
3844 * returned.
3845 *
3846 * @return The MIME type of this intent.
3847 *
3848 * @see #getType
3849 * @see #resolveType(ContentResolver)
3850 */
3851 public String resolveType(Context context) {
3852 return resolveType(context.getContentResolver());
3853 }
3854
3855 /**
3856 * Return the MIME data type of this intent. If the type field is
3857 * explicitly set, that is simply returned. Otherwise, if the data is set,
3858 * the type of that data is returned. If neither fields are set, a null is
3859 * returned.
3860 *
3861 * @param resolver A ContentResolver that can be used to determine the MIME
3862 * type of the intent's data.
3863 *
3864 * @return The MIME type of this intent.
3865 *
3866 * @see #getType
3867 * @see #resolveType(Context)
3868 */
3869 public String resolveType(ContentResolver resolver) {
3870 if (mType != null) {
3871 return mType;
3872 }
3873 if (mData != null) {
3874 if ("content".equals(mData.getScheme())) {
3875 return resolver.getType(mData);
3876 }
3877 }
3878 return null;
3879 }
3880
3881 /**
3882 * Return the MIME data type of this intent, only if it will be needed for
3883 * intent resolution. This is not generally useful for application code;
3884 * it is used by the frameworks for communicating with back-end system
3885 * services.
3886 *
3887 * @param resolver A ContentResolver that can be used to determine the MIME
3888 * type of the intent's data.
3889 *
3890 * @return The MIME type of this intent, or null if it is unknown or not
3891 * needed.
3892 */
3893 public String resolveTypeIfNeeded(ContentResolver resolver) {
3894 if (mComponent != null) {
3895 return mType;
3896 }
3897 return resolveType(resolver);
3898 }
3899
3900 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003901 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003902 *
3903 * @param category The category to check.
3904 *
3905 * @return boolean True if the intent contains the category, else false.
3906 *
3907 * @see #getCategories
3908 * @see #addCategory
3909 */
3910 public boolean hasCategory(String category) {
3911 return mCategories != null && mCategories.contains(category);
3912 }
3913
3914 /**
3915 * Return the set of all categories in the intent. If there are no categories,
3916 * returns NULL.
3917 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003918 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003919 *
3920 * @see #hasCategory
3921 * @see #addCategory
3922 */
3923 public Set<String> getCategories() {
3924 return mCategories;
3925 }
3926
3927 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003928 * Return the specific selector associated with this Intent. If there is
3929 * none, returns null. See {@link #setSelector} for more information.
3930 *
3931 * @see #setSelector
3932 */
3933 public Intent getSelector() {
3934 return mSelector;
3935 }
3936
3937 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003938 * Return the {@link ClipData} associated with this Intent. If there is
3939 * none, returns null. See {@link #setClipData} for more information.
3940 *
3941 * @see #setClipData;
3942 */
3943 public ClipData getClipData() {
3944 return mClipData;
3945 }
3946
3947 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003948 * Sets the ClassLoader that will be used when unmarshalling
3949 * any Parcelable values from the extras of this Intent.
3950 *
3951 * @param loader a ClassLoader, or null to use the default loader
3952 * at the time of unmarshalling.
3953 */
3954 public void setExtrasClassLoader(ClassLoader loader) {
3955 if (mExtras != null) {
3956 mExtras.setClassLoader(loader);
3957 }
3958 }
3959
3960 /**
3961 * Returns true if an extra value is associated with the given name.
3962 * @param name the extra's name
3963 * @return true if the given extra is present.
3964 */
3965 public boolean hasExtra(String name) {
3966 return mExtras != null && mExtras.containsKey(name);
3967 }
3968
3969 /**
3970 * Returns true if the Intent's extras contain a parcelled file descriptor.
3971 * @return true if the Intent contains a parcelled file descriptor.
3972 */
3973 public boolean hasFileDescriptors() {
3974 return mExtras != null && mExtras.hasFileDescriptors();
3975 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003976
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003977 /** @hide */
3978 public void setAllowFds(boolean allowFds) {
3979 if (mExtras != null) {
3980 mExtras.setAllowFds(allowFds);
3981 }
3982 }
3983
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003984 /**
3985 * Retrieve extended data from the intent.
3986 *
3987 * @param name The name of the desired item.
3988 *
3989 * @return the value of an item that previously added with putExtra()
3990 * or null if none was found.
3991 *
3992 * @deprecated
3993 * @hide
3994 */
3995 @Deprecated
3996 public Object getExtra(String name) {
3997 return getExtra(name, null);
3998 }
3999
4000 /**
4001 * Retrieve extended data from the intent.
4002 *
4003 * @param name The name of the desired item.
4004 * @param defaultValue the value to be returned if no value of the desired
4005 * type is stored with the given name.
4006 *
4007 * @return the value of an item that previously added with putExtra()
4008 * or the default value if none was found.
4009 *
4010 * @see #putExtra(String, boolean)
4011 */
4012 public boolean getBooleanExtra(String name, boolean defaultValue) {
4013 return mExtras == null ? defaultValue :
4014 mExtras.getBoolean(name, defaultValue);
4015 }
4016
4017 /**
4018 * Retrieve extended data from the intent.
4019 *
4020 * @param name The name of the desired item.
4021 * @param defaultValue the value to be returned if no value of the desired
4022 * type is stored with the given name.
4023 *
4024 * @return the value of an item that previously added with putExtra()
4025 * or the default value if none was found.
4026 *
4027 * @see #putExtra(String, byte)
4028 */
4029 public byte getByteExtra(String name, byte defaultValue) {
4030 return mExtras == null ? defaultValue :
4031 mExtras.getByte(name, defaultValue);
4032 }
4033
4034 /**
4035 * Retrieve extended data from the intent.
4036 *
4037 * @param name The name of the desired item.
4038 * @param defaultValue the value to be returned if no value of the desired
4039 * type is stored with the given name.
4040 *
4041 * @return the value of an item that previously added with putExtra()
4042 * or the default value if none was found.
4043 *
4044 * @see #putExtra(String, short)
4045 */
4046 public short getShortExtra(String name, short defaultValue) {
4047 return mExtras == null ? defaultValue :
4048 mExtras.getShort(name, defaultValue);
4049 }
4050
4051 /**
4052 * Retrieve extended data from the intent.
4053 *
4054 * @param name The name of the desired item.
4055 * @param defaultValue the value to be returned if no value of the desired
4056 * type is stored with the given name.
4057 *
4058 * @return the value of an item that previously added with putExtra()
4059 * or the default value if none was found.
4060 *
4061 * @see #putExtra(String, char)
4062 */
4063 public char getCharExtra(String name, char defaultValue) {
4064 return mExtras == null ? defaultValue :
4065 mExtras.getChar(name, defaultValue);
4066 }
4067
4068 /**
4069 * Retrieve extended data from the intent.
4070 *
4071 * @param name The name of the desired item.
4072 * @param defaultValue the value to be returned if no value of the desired
4073 * type is stored with the given name.
4074 *
4075 * @return the value of an item that previously added with putExtra()
4076 * or the default value if none was found.
4077 *
4078 * @see #putExtra(String, int)
4079 */
4080 public int getIntExtra(String name, int defaultValue) {
4081 return mExtras == null ? defaultValue :
4082 mExtras.getInt(name, defaultValue);
4083 }
4084
4085 /**
4086 * Retrieve extended data from the intent.
4087 *
4088 * @param name The name of the desired item.
4089 * @param defaultValue the value to be returned if no value of the desired
4090 * type is stored with the given name.
4091 *
4092 * @return the value of an item that previously added with putExtra()
4093 * or the default value if none was found.
4094 *
4095 * @see #putExtra(String, long)
4096 */
4097 public long getLongExtra(String name, long defaultValue) {
4098 return mExtras == null ? defaultValue :
4099 mExtras.getLong(name, defaultValue);
4100 }
4101
4102 /**
4103 * Retrieve extended data from the intent.
4104 *
4105 * @param name The name of the desired item.
4106 * @param defaultValue the value to be returned if no value of the desired
4107 * type is stored with the given name.
4108 *
4109 * @return the value of an item that previously added with putExtra(),
4110 * or the default value if no such item is present
4111 *
4112 * @see #putExtra(String, float)
4113 */
4114 public float getFloatExtra(String name, float defaultValue) {
4115 return mExtras == null ? defaultValue :
4116 mExtras.getFloat(name, defaultValue);
4117 }
4118
4119 /**
4120 * Retrieve extended data from the intent.
4121 *
4122 * @param name The name of the desired item.
4123 * @param defaultValue the value to be returned if no value of the desired
4124 * type is stored with the given name.
4125 *
4126 * @return the value of an item that previously added with putExtra()
4127 * or the default value if none was found.
4128 *
4129 * @see #putExtra(String, double)
4130 */
4131 public double getDoubleExtra(String name, double defaultValue) {
4132 return mExtras == null ? defaultValue :
4133 mExtras.getDouble(name, defaultValue);
4134 }
4135
4136 /**
4137 * Retrieve extended data from the intent.
4138 *
4139 * @param name The name of the desired item.
4140 *
4141 * @return the value of an item that previously added with putExtra()
4142 * or null if no String value was found.
4143 *
4144 * @see #putExtra(String, String)
4145 */
4146 public String getStringExtra(String name) {
4147 return mExtras == null ? null : mExtras.getString(name);
4148 }
4149
4150 /**
4151 * Retrieve extended data from the intent.
4152 *
4153 * @param name The name of the desired item.
4154 *
4155 * @return the value of an item that previously added with putExtra()
4156 * or null if no CharSequence value was found.
4157 *
4158 * @see #putExtra(String, CharSequence)
4159 */
4160 public CharSequence getCharSequenceExtra(String name) {
4161 return mExtras == null ? null : mExtras.getCharSequence(name);
4162 }
4163
4164 /**
4165 * Retrieve extended data from the intent.
4166 *
4167 * @param name The name of the desired item.
4168 *
4169 * @return the value of an item that previously added with putExtra()
4170 * or null if no Parcelable value was found.
4171 *
4172 * @see #putExtra(String, Parcelable)
4173 */
4174 public <T extends Parcelable> T getParcelableExtra(String name) {
4175 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4176 }
4177
4178 /**
4179 * Retrieve extended data from the intent.
4180 *
4181 * @param name The name of the desired item.
4182 *
4183 * @return the value of an item that previously added with putExtra()
4184 * or null if no Parcelable[] value was found.
4185 *
4186 * @see #putExtra(String, Parcelable[])
4187 */
4188 public Parcelable[] getParcelableArrayExtra(String name) {
4189 return mExtras == null ? null : mExtras.getParcelableArray(name);
4190 }
4191
4192 /**
4193 * Retrieve extended data from the intent.
4194 *
4195 * @param name The name of the desired item.
4196 *
4197 * @return the value of an item that previously added with putExtra()
4198 * or null if no ArrayList<Parcelable> value was found.
4199 *
4200 * @see #putParcelableArrayListExtra(String, ArrayList)
4201 */
4202 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4203 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4204 }
4205
4206 /**
4207 * Retrieve extended data from the intent.
4208 *
4209 * @param name The name of the desired item.
4210 *
4211 * @return the value of an item that previously added with putExtra()
4212 * or null if no Serializable value was found.
4213 *
4214 * @see #putExtra(String, Serializable)
4215 */
4216 public Serializable getSerializableExtra(String name) {
4217 return mExtras == null ? null : mExtras.getSerializable(name);
4218 }
4219
4220 /**
4221 * Retrieve extended data from the intent.
4222 *
4223 * @param name The name of the desired item.
4224 *
4225 * @return the value of an item that previously added with putExtra()
4226 * or null if no ArrayList<Integer> value was found.
4227 *
4228 * @see #putIntegerArrayListExtra(String, ArrayList)
4229 */
4230 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4231 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4232 }
4233
4234 /**
4235 * Retrieve extended data from the intent.
4236 *
4237 * @param name The name of the desired item.
4238 *
4239 * @return the value of an item that previously added with putExtra()
4240 * or null if no ArrayList<String> value was found.
4241 *
4242 * @see #putStringArrayListExtra(String, ArrayList)
4243 */
4244 public ArrayList<String> getStringArrayListExtra(String name) {
4245 return mExtras == null ? null : mExtras.getStringArrayList(name);
4246 }
4247
4248 /**
4249 * Retrieve extended data from the intent.
4250 *
4251 * @param name The name of the desired item.
4252 *
4253 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004254 * or null if no ArrayList<CharSequence> value was found.
4255 *
4256 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4257 */
4258 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4259 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4260 }
4261
4262 /**
4263 * Retrieve extended data from the intent.
4264 *
4265 * @param name The name of the desired item.
4266 *
4267 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004268 * or null if no boolean array value was found.
4269 *
4270 * @see #putExtra(String, boolean[])
4271 */
4272 public boolean[] getBooleanArrayExtra(String name) {
4273 return mExtras == null ? null : mExtras.getBooleanArray(name);
4274 }
4275
4276 /**
4277 * Retrieve extended data from the intent.
4278 *
4279 * @param name The name of the desired item.
4280 *
4281 * @return the value of an item that previously added with putExtra()
4282 * or null if no byte array value was found.
4283 *
4284 * @see #putExtra(String, byte[])
4285 */
4286 public byte[] getByteArrayExtra(String name) {
4287 return mExtras == null ? null : mExtras.getByteArray(name);
4288 }
4289
4290 /**
4291 * Retrieve extended data from the intent.
4292 *
4293 * @param name The name of the desired item.
4294 *
4295 * @return the value of an item that previously added with putExtra()
4296 * or null if no short array value was found.
4297 *
4298 * @see #putExtra(String, short[])
4299 */
4300 public short[] getShortArrayExtra(String name) {
4301 return mExtras == null ? null : mExtras.getShortArray(name);
4302 }
4303
4304 /**
4305 * Retrieve extended data from the intent.
4306 *
4307 * @param name The name of the desired item.
4308 *
4309 * @return the value of an item that previously added with putExtra()
4310 * or null if no char array value was found.
4311 *
4312 * @see #putExtra(String, char[])
4313 */
4314 public char[] getCharArrayExtra(String name) {
4315 return mExtras == null ? null : mExtras.getCharArray(name);
4316 }
4317
4318 /**
4319 * Retrieve extended data from the intent.
4320 *
4321 * @param name The name of the desired item.
4322 *
4323 * @return the value of an item that previously added with putExtra()
4324 * or null if no int array value was found.
4325 *
4326 * @see #putExtra(String, int[])
4327 */
4328 public int[] getIntArrayExtra(String name) {
4329 return mExtras == null ? null : mExtras.getIntArray(name);
4330 }
4331
4332 /**
4333 * Retrieve extended data from the intent.
4334 *
4335 * @param name The name of the desired item.
4336 *
4337 * @return the value of an item that previously added with putExtra()
4338 * or null if no long array value was found.
4339 *
4340 * @see #putExtra(String, long[])
4341 */
4342 public long[] getLongArrayExtra(String name) {
4343 return mExtras == null ? null : mExtras.getLongArray(name);
4344 }
4345
4346 /**
4347 * Retrieve extended data from the intent.
4348 *
4349 * @param name The name of the desired item.
4350 *
4351 * @return the value of an item that previously added with putExtra()
4352 * or null if no float array value was found.
4353 *
4354 * @see #putExtra(String, float[])
4355 */
4356 public float[] getFloatArrayExtra(String name) {
4357 return mExtras == null ? null : mExtras.getFloatArray(name);
4358 }
4359
4360 /**
4361 * Retrieve extended data from the intent.
4362 *
4363 * @param name The name of the desired item.
4364 *
4365 * @return the value of an item that previously added with putExtra()
4366 * or null if no double array value was found.
4367 *
4368 * @see #putExtra(String, double[])
4369 */
4370 public double[] getDoubleArrayExtra(String name) {
4371 return mExtras == null ? null : mExtras.getDoubleArray(name);
4372 }
4373
4374 /**
4375 * Retrieve extended data from the intent.
4376 *
4377 * @param name The name of the desired item.
4378 *
4379 * @return the value of an item that previously added with putExtra()
4380 * or null if no String array value was found.
4381 *
4382 * @see #putExtra(String, String[])
4383 */
4384 public String[] getStringArrayExtra(String name) {
4385 return mExtras == null ? null : mExtras.getStringArray(name);
4386 }
4387
4388 /**
4389 * Retrieve extended data from the intent.
4390 *
4391 * @param name The name of the desired item.
4392 *
4393 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004394 * or null if no CharSequence array value was found.
4395 *
4396 * @see #putExtra(String, CharSequence[])
4397 */
4398 public CharSequence[] getCharSequenceArrayExtra(String name) {
4399 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4400 }
4401
4402 /**
4403 * Retrieve extended data from the intent.
4404 *
4405 * @param name The name of the desired item.
4406 *
4407 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004408 * or null if no Bundle value was found.
4409 *
4410 * @see #putExtra(String, Bundle)
4411 */
4412 public Bundle getBundleExtra(String name) {
4413 return mExtras == null ? null : mExtras.getBundle(name);
4414 }
4415
4416 /**
4417 * Retrieve extended data from the intent.
4418 *
4419 * @param name The name of the desired item.
4420 *
4421 * @return the value of an item that previously added with putExtra()
4422 * or null if no IBinder value was found.
4423 *
4424 * @see #putExtra(String, IBinder)
4425 *
4426 * @deprecated
4427 * @hide
4428 */
4429 @Deprecated
4430 public IBinder getIBinderExtra(String name) {
4431 return mExtras == null ? null : mExtras.getIBinder(name);
4432 }
4433
4434 /**
4435 * Retrieve extended data from the intent.
4436 *
4437 * @param name The name of the desired item.
4438 * @param defaultValue The default value to return in case no item is
4439 * associated with the key 'name'
4440 *
4441 * @return the value of an item that previously added with putExtra()
4442 * or defaultValue if none was found.
4443 *
4444 * @see #putExtra
4445 *
4446 * @deprecated
4447 * @hide
4448 */
4449 @Deprecated
4450 public Object getExtra(String name, Object defaultValue) {
4451 Object result = defaultValue;
4452 if (mExtras != null) {
4453 Object result2 = mExtras.get(name);
4454 if (result2 != null) {
4455 result = result2;
4456 }
4457 }
4458
4459 return result;
4460 }
4461
4462 /**
4463 * Retrieves a map of extended data from the intent.
4464 *
4465 * @return the map of all extras previously added with putExtra(),
4466 * or null if none have been added.
4467 */
4468 public Bundle getExtras() {
4469 return (mExtras != null)
4470 ? new Bundle(mExtras)
4471 : null;
4472 }
4473
4474 /**
4475 * Retrieve any special flags associated with this intent. You will
4476 * normally just set them with {@link #setFlags} and let the system
4477 * take the appropriate action with them.
4478 *
4479 * @return int The currently set flags.
4480 *
4481 * @see #setFlags
4482 */
4483 public int getFlags() {
4484 return mFlags;
4485 }
4486
Dianne Hackborne7f97212011-02-24 14:40:20 -08004487 /** @hide */
4488 public boolean isExcludingStopped() {
4489 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4490 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4491 }
4492
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004493 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004494 * Retrieve the application package name this Intent is limited to. When
4495 * resolving an Intent, if non-null this limits the resolution to only
4496 * components in the given application package.
4497 *
4498 * @return The name of the application package for the Intent.
4499 *
4500 * @see #resolveActivity
4501 * @see #setPackage
4502 */
4503 public String getPackage() {
4504 return mPackage;
4505 }
4506
4507 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004508 * Retrieve the concrete component associated with the intent. When receiving
4509 * an intent, this is the component that was found to best handle it (that is,
4510 * yourself) and will always be non-null; in all other cases it will be
4511 * null unless explicitly set.
4512 *
4513 * @return The name of the application component to handle the intent.
4514 *
4515 * @see #resolveActivity
4516 * @see #setComponent
4517 */
4518 public ComponentName getComponent() {
4519 return mComponent;
4520 }
4521
4522 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004523 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4524 * used as a hint to the receiver for animations and the like. Null means that there
4525 * is no source bounds.
4526 */
4527 public Rect getSourceBounds() {
4528 return mSourceBounds;
4529 }
4530
4531 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004532 * Return the Activity component that should be used to handle this intent.
4533 * The appropriate component is determined based on the information in the
4534 * intent, evaluated as follows:
4535 *
4536 * <p>If {@link #getComponent} returns an explicit class, that is returned
4537 * without any further consideration.
4538 *
4539 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4540 * category to be considered.
4541 *
4542 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4543 * action.
4544 *
4545 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4546 * this type.
4547 *
4548 * <p>If {@link #addCategory} has added any categories, the activity must
4549 * handle ALL of the categories specified.
4550 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004551 * <p>If {@link #getPackage} is non-NULL, only activity components in
4552 * that application package will be considered.
4553 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004554 * <p>If there are no activities that satisfy all of these conditions, a
4555 * null string is returned.
4556 *
4557 * <p>If multiple activities are found to satisfy the intent, the one with
4558 * the highest priority will be used. If there are multiple activities
4559 * with the same priority, the system will either pick the best activity
4560 * based on user preference, or resolve to a system class that will allow
4561 * the user to pick an activity and forward from there.
4562 *
4563 * <p>This method is implemented simply by calling
4564 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4565 * true.</p>
4566 * <p> This API is called for you as part of starting an activity from an
4567 * intent. You do not normally need to call it yourself.</p>
4568 *
4569 * @param pm The package manager with which to resolve the Intent.
4570 *
4571 * @return Name of the component implementing an activity that can
4572 * display the intent.
4573 *
4574 * @see #setComponent
4575 * @see #getComponent
4576 * @see #resolveActivityInfo
4577 */
4578 public ComponentName resolveActivity(PackageManager pm) {
4579 if (mComponent != null) {
4580 return mComponent;
4581 }
4582
4583 ResolveInfo info = pm.resolveActivity(
4584 this, PackageManager.MATCH_DEFAULT_ONLY);
4585 if (info != null) {
4586 return new ComponentName(
4587 info.activityInfo.applicationInfo.packageName,
4588 info.activityInfo.name);
4589 }
4590
4591 return null;
4592 }
4593
4594 /**
4595 * Resolve the Intent into an {@link ActivityInfo}
4596 * describing the activity that should execute the intent. Resolution
4597 * follows the same rules as described for {@link #resolveActivity}, but
4598 * you get back the completely information about the resolved activity
4599 * instead of just its class name.
4600 *
4601 * @param pm The package manager with which to resolve the Intent.
4602 * @param flags Addition information to retrieve as per
4603 * {@link PackageManager#getActivityInfo(ComponentName, int)
4604 * PackageManager.getActivityInfo()}.
4605 *
4606 * @return PackageManager.ActivityInfo
4607 *
4608 * @see #resolveActivity
4609 */
4610 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4611 ActivityInfo ai = null;
4612 if (mComponent != null) {
4613 try {
4614 ai = pm.getActivityInfo(mComponent, flags);
4615 } catch (PackageManager.NameNotFoundException e) {
4616 // ignore
4617 }
4618 } else {
4619 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004620 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004621 if (info != null) {
4622 ai = info.activityInfo;
4623 }
4624 }
4625
4626 return ai;
4627 }
4628
4629 /**
4630 * Set the general action to be performed.
4631 *
4632 * @param action An action name, such as ACTION_VIEW. Application-specific
4633 * actions should be prefixed with the vendor's package name.
4634 *
4635 * @return Returns the same Intent object, for chaining multiple calls
4636 * into a single statement.
4637 *
4638 * @see #getAction
4639 */
4640 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004641 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004642 return this;
4643 }
4644
4645 /**
4646 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004647 * clears any type that was previously set by {@link #setType} or
4648 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004649 *
Nick Pellyccae4122012-01-09 14:12:58 -08004650 * <p><em>Note: scheme matching in the Android framework is
4651 * case-sensitive, unlike the formal RFC. As a result,
4652 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004653 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004654 * {@link #setDataAndNormalize}
4655 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004656 *
Nick Pellyccae4122012-01-09 14:12:58 -08004657 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004658 *
4659 * @return Returns the same Intent object, for chaining multiple calls
4660 * into a single statement.
4661 *
4662 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004663 * @see #setDataAndNormalize
4664 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004665 */
4666 public Intent setData(Uri data) {
4667 mData = data;
4668 mType = null;
4669 return this;
4670 }
4671
4672 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004673 * Normalize and set the data this intent is operating on.
4674 *
4675 * <p>This method automatically clears any type that was
4676 * previously set (for example, by {@link #setType}).
4677 *
4678 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004679 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004680 * so really this is just a convenience method for
4681 * <pre>
4682 * setData(data.normalize())
4683 * </pre>
4684 *
4685 * @param data The Uri of the data this intent is now targeting.
4686 *
4687 * @return Returns the same Intent object, for chaining multiple calls
4688 * into a single statement.
4689 *
4690 * @see #getData
4691 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004692 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004693 */
4694 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004695 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004696 }
4697
4698 /**
4699 * Set an explicit MIME data type.
4700 *
4701 * <p>This is used to create intents that only specify a type and not data,
4702 * for example to indicate the type of data to return.
4703 *
4704 * <p>This method automatically clears any data that was
4705 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004706 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004707 * <p><em>Note: MIME type matching in the Android framework is
4708 * case-sensitive, unlike formal RFC MIME types. As a result,
4709 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004710 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4711 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004712 *
4713 * @param type The MIME type of the data being handled by this intent.
4714 *
4715 * @return Returns the same Intent object, for chaining multiple calls
4716 * into a single statement.
4717 *
4718 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004719 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004720 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004721 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004722 */
4723 public Intent setType(String type) {
4724 mData = null;
4725 mType = type;
4726 return this;
4727 }
4728
4729 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004730 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004731 *
Nick Pellyccae4122012-01-09 14:12:58 -08004732 * <p>This is used to create intents that only specify a type and not data,
4733 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004734 *
Nick Pellyccae4122012-01-09 14:12:58 -08004735 * <p>This method automatically clears any data that was
4736 * previously set (for example by {@link #setData}).
4737 *
4738 * <p>The MIME type is normalized using
4739 * {@link #normalizeMimeType} before it is set,
4740 * so really this is just a convenience method for
4741 * <pre>
4742 * setType(Intent.normalizeMimeType(type))
4743 * </pre>
4744 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004745 * @param type The MIME type of the data being handled by this intent.
4746 *
4747 * @return Returns the same Intent object, for chaining multiple calls
4748 * into a single statement.
4749 *
Nick Pellyccae4122012-01-09 14:12:58 -08004750 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004751 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004752 * @see #normalizeMimeType
4753 */
4754 public Intent setTypeAndNormalize(String type) {
4755 return setType(normalizeMimeType(type));
4756 }
4757
4758 /**
4759 * (Usually optional) Set the data for the intent along with an explicit
4760 * MIME data type. This method should very rarely be used -- it allows you
4761 * to override the MIME type that would ordinarily be inferred from the
4762 * data with your own type given here.
4763 *
4764 * <p><em>Note: MIME type and Uri scheme matching in the
4765 * Android framework is case-sensitive, unlike the formal RFC definitions.
4766 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004767 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004768 * {@link #setDataAndTypeAndNormalize}
4769 * to ensure that they are converted to lower case.</em>
4770 *
4771 * @param data The Uri of the data this intent is now targeting.
4772 * @param type The MIME type of the data being handled by this intent.
4773 *
4774 * @return Returns the same Intent object, for chaining multiple calls
4775 * into a single statement.
4776 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004777 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004778 * @see #setData
4779 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004780 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004781 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004782 */
4783 public Intent setDataAndType(Uri data, String type) {
4784 mData = data;
4785 mType = type;
4786 return this;
4787 }
4788
4789 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004790 * (Usually optional) Normalize and set both the data Uri and an explicit
4791 * MIME data type. This method should very rarely be used -- it allows you
4792 * to override the MIME type that would ordinarily be inferred from the
4793 * data with your own type given here.
4794 *
4795 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004796 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004797 * before they are set, so really this is just a convenience method for
4798 * <pre>
4799 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4800 * </pre>
4801 *
4802 * @param data The Uri of the data this intent is now targeting.
4803 * @param type The MIME type of the data being handled by this intent.
4804 *
4805 * @return Returns the same Intent object, for chaining multiple calls
4806 * into a single statement.
4807 *
4808 * @see #setType
4809 * @see #setData
4810 * @see #setDataAndType
4811 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004812 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004813 */
4814 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004815 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004816 }
4817
4818 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004819 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004820 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004821 * activities that provide <em>all</em> of the requested categories will be
4822 * used.
4823 *
4824 * @param category The desired category. This can be either one of the
4825 * predefined Intent categories, or a custom category in your own
4826 * namespace.
4827 *
4828 * @return Returns the same Intent object, for chaining multiple calls
4829 * into a single statement.
4830 *
4831 * @see #hasCategory
4832 * @see #removeCategory
4833 */
4834 public Intent addCategory(String category) {
4835 if (mCategories == null) {
4836 mCategories = new HashSet<String>();
4837 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004838 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004839 return this;
4840 }
4841
4842 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004843 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004844 *
4845 * @param category The category to remove.
4846 *
4847 * @see #addCategory
4848 */
4849 public void removeCategory(String category) {
4850 if (mCategories != null) {
4851 mCategories.remove(category);
4852 if (mCategories.size() == 0) {
4853 mCategories = null;
4854 }
4855 }
4856 }
4857
4858 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004859 * Set a selector for this Intent. This is a modification to the kinds of
4860 * things the Intent will match. If the selector is set, it will be used
4861 * when trying to find entities that can handle the Intent, instead of the
4862 * main contents of the Intent. This allows you build an Intent containing
4863 * a generic protocol while targeting it more specifically.
4864 *
4865 * <p>An example of where this may be used is with things like
4866 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4867 * Intent that will launch the Browser application. However, the correct
4868 * main entry point of an application is actually {@link #ACTION_MAIN}
4869 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4870 * used to specify the actual Activity to launch. If you launch the browser
4871 * with something different, undesired behavior may happen if the user has
4872 * previously or later launches it the normal way, since they do not match.
4873 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4874 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4875 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4876 *
4877 * <p>Setting a selector does not impact the behavior of
4878 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4879 * desired behavior of a selector -- it does not impact the base meaning
4880 * of the Intent, just what kinds of things will be matched against it
4881 * when determining who can handle it.</p>
4882 *
4883 * <p>You can not use both a selector and {@link #setPackage(String)} on
4884 * the same base Intent.</p>
4885 *
4886 * @param selector The desired selector Intent; set to null to not use
4887 * a special selector.
4888 */
4889 public void setSelector(Intent selector) {
4890 if (selector == this) {
4891 throw new IllegalArgumentException(
4892 "Intent being set as a selector of itself");
4893 }
4894 if (selector != null && mPackage != null) {
4895 throw new IllegalArgumentException(
4896 "Can't set selector when package name is already set");
4897 }
4898 mSelector = selector;
4899 }
4900
4901 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004902 * Set a {@link ClipData} associated with this Intent. This replaces any
4903 * previously set ClipData.
4904 *
4905 * <p>The ClipData in an intent is not used for Intent matching or other
4906 * such operations. Semantically it is like extras, used to transmit
4907 * additional data with the Intent. The main feature of using this over
4908 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4909 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4910 * items included in the clip data. This is useful, in particular, if
4911 * you want to transmit an Intent containing multiple <code>content:</code>
4912 * URIs for which the recipient may not have global permission to access the
4913 * content provider.
4914 *
4915 * <p>If the ClipData contains items that are themselves Intents, any
4916 * grant flags in those Intents will be ignored. Only the top-level flags
4917 * of the main Intent are respected, and will be applied to all Uri or
4918 * Intent items in the clip (or sub-items of the clip).
4919 *
4920 * <p>The MIME type, label, and icon in the ClipData object are not
4921 * directly used by Intent. Applications should generally rely on the
4922 * MIME type of the Intent itself, not what it may find in the ClipData.
4923 * A common practice is to construct a ClipData for use with an Intent
4924 * with a MIME type of "*\/*".
4925 *
4926 * @param clip The new clip to set. May be null to clear the current clip.
4927 */
4928 public void setClipData(ClipData clip) {
4929 mClipData = clip;
4930 }
4931
4932 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004933 * Add extended data to the intent. The name must include a package
4934 * prefix, for example the app com.android.contacts would use names
4935 * like "com.android.contacts.ShowAll".
4936 *
4937 * @param name The name of the extra data, with package prefix.
4938 * @param value The boolean data value.
4939 *
4940 * @return Returns the same Intent object, for chaining multiple calls
4941 * into a single statement.
4942 *
4943 * @see #putExtras
4944 * @see #removeExtra
4945 * @see #getBooleanExtra(String, boolean)
4946 */
4947 public Intent putExtra(String name, boolean value) {
4948 if (mExtras == null) {
4949 mExtras = new Bundle();
4950 }
4951 mExtras.putBoolean(name, value);
4952 return this;
4953 }
4954
4955 /**
4956 * Add extended data to the intent. The name must include a package
4957 * prefix, for example the app com.android.contacts would use names
4958 * like "com.android.contacts.ShowAll".
4959 *
4960 * @param name The name of the extra data, with package prefix.
4961 * @param value The byte data value.
4962 *
4963 * @return Returns the same Intent object, for chaining multiple calls
4964 * into a single statement.
4965 *
4966 * @see #putExtras
4967 * @see #removeExtra
4968 * @see #getByteExtra(String, byte)
4969 */
4970 public Intent putExtra(String name, byte value) {
4971 if (mExtras == null) {
4972 mExtras = new Bundle();
4973 }
4974 mExtras.putByte(name, value);
4975 return this;
4976 }
4977
4978 /**
4979 * Add extended data to the intent. The name must include a package
4980 * prefix, for example the app com.android.contacts would use names
4981 * like "com.android.contacts.ShowAll".
4982 *
4983 * @param name The name of the extra data, with package prefix.
4984 * @param value The char data value.
4985 *
4986 * @return Returns the same Intent object, for chaining multiple calls
4987 * into a single statement.
4988 *
4989 * @see #putExtras
4990 * @see #removeExtra
4991 * @see #getCharExtra(String, char)
4992 */
4993 public Intent putExtra(String name, char value) {
4994 if (mExtras == null) {
4995 mExtras = new Bundle();
4996 }
4997 mExtras.putChar(name, value);
4998 return this;
4999 }
5000
5001 /**
5002 * Add extended data to the intent. The name must include a package
5003 * prefix, for example the app com.android.contacts would use names
5004 * like "com.android.contacts.ShowAll".
5005 *
5006 * @param name The name of the extra data, with package prefix.
5007 * @param value The short data value.
5008 *
5009 * @return Returns the same Intent object, for chaining multiple calls
5010 * into a single statement.
5011 *
5012 * @see #putExtras
5013 * @see #removeExtra
5014 * @see #getShortExtra(String, short)
5015 */
5016 public Intent putExtra(String name, short value) {
5017 if (mExtras == null) {
5018 mExtras = new Bundle();
5019 }
5020 mExtras.putShort(name, value);
5021 return this;
5022 }
5023
5024 /**
5025 * Add extended data to the intent. The name must include a package
5026 * prefix, for example the app com.android.contacts would use names
5027 * like "com.android.contacts.ShowAll".
5028 *
5029 * @param name The name of the extra data, with package prefix.
5030 * @param value The integer data value.
5031 *
5032 * @return Returns the same Intent object, for chaining multiple calls
5033 * into a single statement.
5034 *
5035 * @see #putExtras
5036 * @see #removeExtra
5037 * @see #getIntExtra(String, int)
5038 */
5039 public Intent putExtra(String name, int value) {
5040 if (mExtras == null) {
5041 mExtras = new Bundle();
5042 }
5043 mExtras.putInt(name, value);
5044 return this;
5045 }
5046
5047 /**
5048 * Add extended data to the intent. The name must include a package
5049 * prefix, for example the app com.android.contacts would use names
5050 * like "com.android.contacts.ShowAll".
5051 *
5052 * @param name The name of the extra data, with package prefix.
5053 * @param value The long data value.
5054 *
5055 * @return Returns the same Intent object, for chaining multiple calls
5056 * into a single statement.
5057 *
5058 * @see #putExtras
5059 * @see #removeExtra
5060 * @see #getLongExtra(String, long)
5061 */
5062 public Intent putExtra(String name, long value) {
5063 if (mExtras == null) {
5064 mExtras = new Bundle();
5065 }
5066 mExtras.putLong(name, value);
5067 return this;
5068 }
5069
5070 /**
5071 * Add extended data to the intent. The name must include a package
5072 * prefix, for example the app com.android.contacts would use names
5073 * like "com.android.contacts.ShowAll".
5074 *
5075 * @param name The name of the extra data, with package prefix.
5076 * @param value The float data value.
5077 *
5078 * @return Returns the same Intent object, for chaining multiple calls
5079 * into a single statement.
5080 *
5081 * @see #putExtras
5082 * @see #removeExtra
5083 * @see #getFloatExtra(String, float)
5084 */
5085 public Intent putExtra(String name, float value) {
5086 if (mExtras == null) {
5087 mExtras = new Bundle();
5088 }
5089 mExtras.putFloat(name, value);
5090 return this;
5091 }
5092
5093 /**
5094 * Add extended data to the intent. The name must include a package
5095 * prefix, for example the app com.android.contacts would use names
5096 * like "com.android.contacts.ShowAll".
5097 *
5098 * @param name The name of the extra data, with package prefix.
5099 * @param value The double data value.
5100 *
5101 * @return Returns the same Intent object, for chaining multiple calls
5102 * into a single statement.
5103 *
5104 * @see #putExtras
5105 * @see #removeExtra
5106 * @see #getDoubleExtra(String, double)
5107 */
5108 public Intent putExtra(String name, double value) {
5109 if (mExtras == null) {
5110 mExtras = new Bundle();
5111 }
5112 mExtras.putDouble(name, value);
5113 return this;
5114 }
5115
5116 /**
5117 * Add extended data to the intent. The name must include a package
5118 * prefix, for example the app com.android.contacts would use names
5119 * like "com.android.contacts.ShowAll".
5120 *
5121 * @param name The name of the extra data, with package prefix.
5122 * @param value The String data value.
5123 *
5124 * @return Returns the same Intent object, for chaining multiple calls
5125 * into a single statement.
5126 *
5127 * @see #putExtras
5128 * @see #removeExtra
5129 * @see #getStringExtra(String)
5130 */
5131 public Intent putExtra(String name, String value) {
5132 if (mExtras == null) {
5133 mExtras = new Bundle();
5134 }
5135 mExtras.putString(name, value);
5136 return this;
5137 }
5138
5139 /**
5140 * Add extended data to the intent. The name must include a package
5141 * prefix, for example the app com.android.contacts would use names
5142 * like "com.android.contacts.ShowAll".
5143 *
5144 * @param name The name of the extra data, with package prefix.
5145 * @param value The CharSequence data value.
5146 *
5147 * @return Returns the same Intent object, for chaining multiple calls
5148 * into a single statement.
5149 *
5150 * @see #putExtras
5151 * @see #removeExtra
5152 * @see #getCharSequenceExtra(String)
5153 */
5154 public Intent putExtra(String name, CharSequence value) {
5155 if (mExtras == null) {
5156 mExtras = new Bundle();
5157 }
5158 mExtras.putCharSequence(name, value);
5159 return this;
5160 }
5161
5162 /**
5163 * Add extended data to the intent. The name must include a package
5164 * prefix, for example the app com.android.contacts would use names
5165 * like "com.android.contacts.ShowAll".
5166 *
5167 * @param name The name of the extra data, with package prefix.
5168 * @param value The Parcelable data value.
5169 *
5170 * @return Returns the same Intent object, for chaining multiple calls
5171 * into a single statement.
5172 *
5173 * @see #putExtras
5174 * @see #removeExtra
5175 * @see #getParcelableExtra(String)
5176 */
5177 public Intent putExtra(String name, Parcelable value) {
5178 if (mExtras == null) {
5179 mExtras = new Bundle();
5180 }
5181 mExtras.putParcelable(name, value);
5182 return this;
5183 }
5184
5185 /**
5186 * Add extended data to the intent. The name must include a package
5187 * prefix, for example the app com.android.contacts would use names
5188 * like "com.android.contacts.ShowAll".
5189 *
5190 * @param name The name of the extra data, with package prefix.
5191 * @param value The Parcelable[] data value.
5192 *
5193 * @return Returns the same Intent object, for chaining multiple calls
5194 * into a single statement.
5195 *
5196 * @see #putExtras
5197 * @see #removeExtra
5198 * @see #getParcelableArrayExtra(String)
5199 */
5200 public Intent putExtra(String name, Parcelable[] value) {
5201 if (mExtras == null) {
5202 mExtras = new Bundle();
5203 }
5204 mExtras.putParcelableArray(name, value);
5205 return this;
5206 }
5207
5208 /**
5209 * Add extended data to the intent. The name must include a package
5210 * prefix, for example the app com.android.contacts would use names
5211 * like "com.android.contacts.ShowAll".
5212 *
5213 * @param name The name of the extra data, with package prefix.
5214 * @param value The ArrayList<Parcelable> data value.
5215 *
5216 * @return Returns the same Intent object, for chaining multiple calls
5217 * into a single statement.
5218 *
5219 * @see #putExtras
5220 * @see #removeExtra
5221 * @see #getParcelableArrayListExtra(String)
5222 */
5223 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5224 if (mExtras == null) {
5225 mExtras = new Bundle();
5226 }
5227 mExtras.putParcelableArrayList(name, value);
5228 return this;
5229 }
5230
5231 /**
5232 * Add extended data to the intent. The name must include a package
5233 * prefix, for example the app com.android.contacts would use names
5234 * like "com.android.contacts.ShowAll".
5235 *
5236 * @param name The name of the extra data, with package prefix.
5237 * @param value The ArrayList<Integer> data value.
5238 *
5239 * @return Returns the same Intent object, for chaining multiple calls
5240 * into a single statement.
5241 *
5242 * @see #putExtras
5243 * @see #removeExtra
5244 * @see #getIntegerArrayListExtra(String)
5245 */
5246 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5247 if (mExtras == null) {
5248 mExtras = new Bundle();
5249 }
5250 mExtras.putIntegerArrayList(name, value);
5251 return this;
5252 }
5253
5254 /**
5255 * Add extended data to the intent. The name must include a package
5256 * prefix, for example the app com.android.contacts would use names
5257 * like "com.android.contacts.ShowAll".
5258 *
5259 * @param name The name of the extra data, with package prefix.
5260 * @param value The ArrayList<String> data value.
5261 *
5262 * @return Returns the same Intent object, for chaining multiple calls
5263 * into a single statement.
5264 *
5265 * @see #putExtras
5266 * @see #removeExtra
5267 * @see #getStringArrayListExtra(String)
5268 */
5269 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5270 if (mExtras == null) {
5271 mExtras = new Bundle();
5272 }
5273 mExtras.putStringArrayList(name, value);
5274 return this;
5275 }
5276
5277 /**
5278 * Add extended data to the intent. The name must include a package
5279 * prefix, for example the app com.android.contacts would use names
5280 * like "com.android.contacts.ShowAll".
5281 *
5282 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005283 * @param value The ArrayList<CharSequence> data value.
5284 *
5285 * @return Returns the same Intent object, for chaining multiple calls
5286 * into a single statement.
5287 *
5288 * @see #putExtras
5289 * @see #removeExtra
5290 * @see #getCharSequenceArrayListExtra(String)
5291 */
5292 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5293 if (mExtras == null) {
5294 mExtras = new Bundle();
5295 }
5296 mExtras.putCharSequenceArrayList(name, value);
5297 return this;
5298 }
5299
5300 /**
5301 * Add extended data to the intent. The name must include a package
5302 * prefix, for example the app com.android.contacts would use names
5303 * like "com.android.contacts.ShowAll".
5304 *
5305 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005306 * @param value The Serializable data value.
5307 *
5308 * @return Returns the same Intent object, for chaining multiple calls
5309 * into a single statement.
5310 *
5311 * @see #putExtras
5312 * @see #removeExtra
5313 * @see #getSerializableExtra(String)
5314 */
5315 public Intent putExtra(String name, Serializable value) {
5316 if (mExtras == null) {
5317 mExtras = new Bundle();
5318 }
5319 mExtras.putSerializable(name, value);
5320 return this;
5321 }
5322
5323 /**
5324 * Add extended data to the intent. The name must include a package
5325 * prefix, for example the app com.android.contacts would use names
5326 * like "com.android.contacts.ShowAll".
5327 *
5328 * @param name The name of the extra data, with package prefix.
5329 * @param value The boolean array data value.
5330 *
5331 * @return Returns the same Intent object, for chaining multiple calls
5332 * into a single statement.
5333 *
5334 * @see #putExtras
5335 * @see #removeExtra
5336 * @see #getBooleanArrayExtra(String)
5337 */
5338 public Intent putExtra(String name, boolean[] value) {
5339 if (mExtras == null) {
5340 mExtras = new Bundle();
5341 }
5342 mExtras.putBooleanArray(name, value);
5343 return this;
5344 }
5345
5346 /**
5347 * Add extended data to the intent. The name must include a package
5348 * prefix, for example the app com.android.contacts would use names
5349 * like "com.android.contacts.ShowAll".
5350 *
5351 * @param name The name of the extra data, with package prefix.
5352 * @param value The byte array data value.
5353 *
5354 * @return Returns the same Intent object, for chaining multiple calls
5355 * into a single statement.
5356 *
5357 * @see #putExtras
5358 * @see #removeExtra
5359 * @see #getByteArrayExtra(String)
5360 */
5361 public Intent putExtra(String name, byte[] value) {
5362 if (mExtras == null) {
5363 mExtras = new Bundle();
5364 }
5365 mExtras.putByteArray(name, value);
5366 return this;
5367 }
5368
5369 /**
5370 * Add extended data to the intent. The name must include a package
5371 * prefix, for example the app com.android.contacts would use names
5372 * like "com.android.contacts.ShowAll".
5373 *
5374 * @param name The name of the extra data, with package prefix.
5375 * @param value The short array data value.
5376 *
5377 * @return Returns the same Intent object, for chaining multiple calls
5378 * into a single statement.
5379 *
5380 * @see #putExtras
5381 * @see #removeExtra
5382 * @see #getShortArrayExtra(String)
5383 */
5384 public Intent putExtra(String name, short[] value) {
5385 if (mExtras == null) {
5386 mExtras = new Bundle();
5387 }
5388 mExtras.putShortArray(name, value);
5389 return this;
5390 }
5391
5392 /**
5393 * Add extended data to the intent. The name must include a package
5394 * prefix, for example the app com.android.contacts would use names
5395 * like "com.android.contacts.ShowAll".
5396 *
5397 * @param name The name of the extra data, with package prefix.
5398 * @param value The char array data value.
5399 *
5400 * @return Returns the same Intent object, for chaining multiple calls
5401 * into a single statement.
5402 *
5403 * @see #putExtras
5404 * @see #removeExtra
5405 * @see #getCharArrayExtra(String)
5406 */
5407 public Intent putExtra(String name, char[] value) {
5408 if (mExtras == null) {
5409 mExtras = new Bundle();
5410 }
5411 mExtras.putCharArray(name, value);
5412 return this;
5413 }
5414
5415 /**
5416 * Add extended data to the intent. The name must include a package
5417 * prefix, for example the app com.android.contacts would use names
5418 * like "com.android.contacts.ShowAll".
5419 *
5420 * @param name The name of the extra data, with package prefix.
5421 * @param value The int array data value.
5422 *
5423 * @return Returns the same Intent object, for chaining multiple calls
5424 * into a single statement.
5425 *
5426 * @see #putExtras
5427 * @see #removeExtra
5428 * @see #getIntArrayExtra(String)
5429 */
5430 public Intent putExtra(String name, int[] value) {
5431 if (mExtras == null) {
5432 mExtras = new Bundle();
5433 }
5434 mExtras.putIntArray(name, value);
5435 return this;
5436 }
5437
5438 /**
5439 * Add extended data to the intent. The name must include a package
5440 * prefix, for example the app com.android.contacts would use names
5441 * like "com.android.contacts.ShowAll".
5442 *
5443 * @param name The name of the extra data, with package prefix.
5444 * @param value The byte array data value.
5445 *
5446 * @return Returns the same Intent object, for chaining multiple calls
5447 * into a single statement.
5448 *
5449 * @see #putExtras
5450 * @see #removeExtra
5451 * @see #getLongArrayExtra(String)
5452 */
5453 public Intent putExtra(String name, long[] value) {
5454 if (mExtras == null) {
5455 mExtras = new Bundle();
5456 }
5457 mExtras.putLongArray(name, value);
5458 return this;
5459 }
5460
5461 /**
5462 * Add extended data to the intent. The name must include a package
5463 * prefix, for example the app com.android.contacts would use names
5464 * like "com.android.contacts.ShowAll".
5465 *
5466 * @param name The name of the extra data, with package prefix.
5467 * @param value The float array data value.
5468 *
5469 * @return Returns the same Intent object, for chaining multiple calls
5470 * into a single statement.
5471 *
5472 * @see #putExtras
5473 * @see #removeExtra
5474 * @see #getFloatArrayExtra(String)
5475 */
5476 public Intent putExtra(String name, float[] value) {
5477 if (mExtras == null) {
5478 mExtras = new Bundle();
5479 }
5480 mExtras.putFloatArray(name, value);
5481 return this;
5482 }
5483
5484 /**
5485 * Add extended data to the intent. The name must include a package
5486 * prefix, for example the app com.android.contacts would use names
5487 * like "com.android.contacts.ShowAll".
5488 *
5489 * @param name The name of the extra data, with package prefix.
5490 * @param value The double array data value.
5491 *
5492 * @return Returns the same Intent object, for chaining multiple calls
5493 * into a single statement.
5494 *
5495 * @see #putExtras
5496 * @see #removeExtra
5497 * @see #getDoubleArrayExtra(String)
5498 */
5499 public Intent putExtra(String name, double[] value) {
5500 if (mExtras == null) {
5501 mExtras = new Bundle();
5502 }
5503 mExtras.putDoubleArray(name, value);
5504 return this;
5505 }
5506
5507 /**
5508 * Add extended data to the intent. The name must include a package
5509 * prefix, for example the app com.android.contacts would use names
5510 * like "com.android.contacts.ShowAll".
5511 *
5512 * @param name The name of the extra data, with package prefix.
5513 * @param value The String array data value.
5514 *
5515 * @return Returns the same Intent object, for chaining multiple calls
5516 * into a single statement.
5517 *
5518 * @see #putExtras
5519 * @see #removeExtra
5520 * @see #getStringArrayExtra(String)
5521 */
5522 public Intent putExtra(String name, String[] value) {
5523 if (mExtras == null) {
5524 mExtras = new Bundle();
5525 }
5526 mExtras.putStringArray(name, value);
5527 return this;
5528 }
5529
5530 /**
5531 * Add extended data to the intent. The name must include a package
5532 * prefix, for example the app com.android.contacts would use names
5533 * like "com.android.contacts.ShowAll".
5534 *
5535 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005536 * @param value The CharSequence array data value.
5537 *
5538 * @return Returns the same Intent object, for chaining multiple calls
5539 * into a single statement.
5540 *
5541 * @see #putExtras
5542 * @see #removeExtra
5543 * @see #getCharSequenceArrayExtra(String)
5544 */
5545 public Intent putExtra(String name, CharSequence[] value) {
5546 if (mExtras == null) {
5547 mExtras = new Bundle();
5548 }
5549 mExtras.putCharSequenceArray(name, value);
5550 return this;
5551 }
5552
5553 /**
5554 * Add extended data to the intent. The name must include a package
5555 * prefix, for example the app com.android.contacts would use names
5556 * like "com.android.contacts.ShowAll".
5557 *
5558 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005559 * @param value The Bundle data value.
5560 *
5561 * @return Returns the same Intent object, for chaining multiple calls
5562 * into a single statement.
5563 *
5564 * @see #putExtras
5565 * @see #removeExtra
5566 * @see #getBundleExtra(String)
5567 */
5568 public Intent putExtra(String name, Bundle value) {
5569 if (mExtras == null) {
5570 mExtras = new Bundle();
5571 }
5572 mExtras.putBundle(name, value);
5573 return this;
5574 }
5575
5576 /**
5577 * Add extended data to the intent. The name must include a package
5578 * prefix, for example the app com.android.contacts would use names
5579 * like "com.android.contacts.ShowAll".
5580 *
5581 * @param name The name of the extra data, with package prefix.
5582 * @param value The IBinder data value.
5583 *
5584 * @return Returns the same Intent object, for chaining multiple calls
5585 * into a single statement.
5586 *
5587 * @see #putExtras
5588 * @see #removeExtra
5589 * @see #getIBinderExtra(String)
5590 *
5591 * @deprecated
5592 * @hide
5593 */
5594 @Deprecated
5595 public Intent putExtra(String name, IBinder value) {
5596 if (mExtras == null) {
5597 mExtras = new Bundle();
5598 }
5599 mExtras.putIBinder(name, value);
5600 return this;
5601 }
5602
5603 /**
5604 * Copy all extras in 'src' in to this intent.
5605 *
5606 * @param src Contains the extras to copy.
5607 *
5608 * @see #putExtra
5609 */
5610 public Intent putExtras(Intent src) {
5611 if (src.mExtras != null) {
5612 if (mExtras == null) {
5613 mExtras = new Bundle(src.mExtras);
5614 } else {
5615 mExtras.putAll(src.mExtras);
5616 }
5617 }
5618 return this;
5619 }
5620
5621 /**
5622 * Add a set of extended data to the intent. The keys must include a package
5623 * prefix, for example the app com.android.contacts would use names
5624 * like "com.android.contacts.ShowAll".
5625 *
5626 * @param extras The Bundle of extras to add to this intent.
5627 *
5628 * @see #putExtra
5629 * @see #removeExtra
5630 */
5631 public Intent putExtras(Bundle extras) {
5632 if (mExtras == null) {
5633 mExtras = new Bundle();
5634 }
5635 mExtras.putAll(extras);
5636 return this;
5637 }
5638
5639 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005640 * Completely replace the extras in the Intent with the extras in the
5641 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005642 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005643 * @param src The exact extras contained in this Intent are copied
5644 * into the target intent, replacing any that were previously there.
5645 */
5646 public Intent replaceExtras(Intent src) {
5647 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5648 return this;
5649 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005650
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005651 /**
5652 * Completely replace the extras in the Intent with the given Bundle of
5653 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005654 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005655 * @param extras The new set of extras in the Intent, or null to erase
5656 * all extras.
5657 */
5658 public Intent replaceExtras(Bundle extras) {
5659 mExtras = extras != null ? new Bundle(extras) : null;
5660 return this;
5661 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005662
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005663 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005664 * Remove extended data from the intent.
5665 *
5666 * @see #putExtra
5667 */
5668 public void removeExtra(String name) {
5669 if (mExtras != null) {
5670 mExtras.remove(name);
5671 if (mExtras.size() == 0) {
5672 mExtras = null;
5673 }
5674 }
5675 }
5676
5677 /**
5678 * Set special flags controlling how this intent is handled. Most values
5679 * here depend on the type of component being executed by the Intent,
5680 * specifically the FLAG_ACTIVITY_* flags are all for use with
5681 * {@link Context#startActivity Context.startActivity()} and the
5682 * FLAG_RECEIVER_* flags are all for use with
5683 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5684 *
Scott Main7aee61f2011-02-08 11:25:01 -08005685 * <p>See the
5686 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5687 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005688 * the behavior of your application.
5689 *
5690 * @param flags The desired flags.
5691 *
5692 * @return Returns the same Intent object, for chaining multiple calls
5693 * into a single statement.
5694 *
5695 * @see #getFlags
5696 * @see #addFlags
5697 *
5698 * @see #FLAG_GRANT_READ_URI_PERMISSION
5699 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5700 * @see #FLAG_DEBUG_LOG_RESOLUTION
5701 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005702 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005703 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005704 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005705 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005706 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5707 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005708 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005709 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5710 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005711 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005712 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005713 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005714 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5715 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005716 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005717 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005718 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005719 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5720 */
5721 public Intent setFlags(int flags) {
5722 mFlags = flags;
5723 return this;
5724 }
5725
5726 /**
5727 * Add additional flags to the intent (or with existing flags
5728 * value).
5729 *
5730 * @param flags The new flags to set.
5731 *
5732 * @return Returns the same Intent object, for chaining multiple calls
5733 * into a single statement.
5734 *
5735 * @see #setFlags
5736 */
5737 public Intent addFlags(int flags) {
5738 mFlags |= flags;
5739 return this;
5740 }
5741
5742 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005743 * (Usually optional) Set an explicit application package name that limits
5744 * the components this Intent will resolve to. If left to the default
5745 * value of null, all components in all applications will considered.
5746 * If non-null, the Intent can only match the components in the given
5747 * application package.
5748 *
5749 * @param packageName The name of the application package to handle the
5750 * intent, or null to allow any application package.
5751 *
5752 * @return Returns the same Intent object, for chaining multiple calls
5753 * into a single statement.
5754 *
5755 * @see #getPackage
5756 * @see #resolveActivity
5757 */
5758 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005759 if (packageName != null && mSelector != null) {
5760 throw new IllegalArgumentException(
5761 "Can't set package name when selector is already set");
5762 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005763 mPackage = packageName;
5764 return this;
5765 }
5766
5767 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005768 * (Usually optional) Explicitly set the component to handle the intent.
5769 * If left with the default value of null, the system will determine the
5770 * appropriate class to use based on the other fields (action, data,
5771 * type, categories) in the Intent. If this class is defined, the
5772 * specified class will always be used regardless of the other fields. You
5773 * should only set this value when you know you absolutely want a specific
5774 * class to be used; otherwise it is better to let the system find the
5775 * appropriate class so that you will respect the installed applications
5776 * and user preferences.
5777 *
5778 * @param component The name of the application component to handle the
5779 * intent, or null to let the system find one for you.
5780 *
5781 * @return Returns the same Intent object, for chaining multiple calls
5782 * into a single statement.
5783 *
5784 * @see #setClass
5785 * @see #setClassName(Context, String)
5786 * @see #setClassName(String, String)
5787 * @see #getComponent
5788 * @see #resolveActivity
5789 */
5790 public Intent setComponent(ComponentName component) {
5791 mComponent = component;
5792 return this;
5793 }
5794
5795 /**
5796 * Convenience for calling {@link #setComponent} with an
5797 * explicit class name.
5798 *
5799 * @param packageContext A Context of the application package implementing
5800 * this class.
5801 * @param className The name of a class inside of the application package
5802 * that will be used as the component for this Intent.
5803 *
5804 * @return Returns the same Intent object, for chaining multiple calls
5805 * into a single statement.
5806 *
5807 * @see #setComponent
5808 * @see #setClass
5809 */
5810 public Intent setClassName(Context packageContext, String className) {
5811 mComponent = new ComponentName(packageContext, className);
5812 return this;
5813 }
5814
5815 /**
5816 * Convenience for calling {@link #setComponent} with an
5817 * explicit application package name and class name.
5818 *
5819 * @param packageName The name of the package implementing the desired
5820 * component.
5821 * @param className The name of a class inside of the application package
5822 * that will be used as the component for this Intent.
5823 *
5824 * @return Returns the same Intent object, for chaining multiple calls
5825 * into a single statement.
5826 *
5827 * @see #setComponent
5828 * @see #setClass
5829 */
5830 public Intent setClassName(String packageName, String className) {
5831 mComponent = new ComponentName(packageName, className);
5832 return this;
5833 }
5834
5835 /**
5836 * Convenience for calling {@link #setComponent(ComponentName)} with the
5837 * name returned by a {@link Class} object.
5838 *
5839 * @param packageContext A Context of the application package implementing
5840 * this class.
5841 * @param cls The class name to set, equivalent to
5842 * <code>setClassName(context, cls.getName())</code>.
5843 *
5844 * @return Returns the same Intent object, for chaining multiple calls
5845 * into a single statement.
5846 *
5847 * @see #setComponent
5848 */
5849 public Intent setClass(Context packageContext, Class<?> cls) {
5850 mComponent = new ComponentName(packageContext, cls);
5851 return this;
5852 }
5853
5854 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005855 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5856 * used as a hint to the receiver for animations and the like. Null means that there
5857 * is no source bounds.
5858 */
5859 public void setSourceBounds(Rect r) {
5860 if (r != null) {
5861 mSourceBounds = new Rect(r);
5862 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005863 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005864 }
5865 }
5866
5867 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005868 * Use with {@link #fillIn} to allow the current action value to be
5869 * overwritten, even if it is already set.
5870 */
5871 public static final int FILL_IN_ACTION = 1<<0;
5872
5873 /**
5874 * Use with {@link #fillIn} to allow the current data or type value
5875 * overwritten, even if it is already set.
5876 */
5877 public static final int FILL_IN_DATA = 1<<1;
5878
5879 /**
5880 * Use with {@link #fillIn} to allow the current categories to be
5881 * overwritten, even if they are already set.
5882 */
5883 public static final int FILL_IN_CATEGORIES = 1<<2;
5884
5885 /**
5886 * Use with {@link #fillIn} to allow the current component value to be
5887 * overwritten, even if it is already set.
5888 */
5889 public static final int FILL_IN_COMPONENT = 1<<3;
5890
5891 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005892 * Use with {@link #fillIn} to allow the current package value to be
5893 * overwritten, even if it is already set.
5894 */
5895 public static final int FILL_IN_PACKAGE = 1<<4;
5896
5897 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005898 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005899 * overwritten, even if it is already set.
5900 */
5901 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5902
5903 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005904 * Use with {@link #fillIn} to allow the current selector to be
5905 * overwritten, even if it is already set.
5906 */
5907 public static final int FILL_IN_SELECTOR = 1<<6;
5908
5909 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005910 * Use with {@link #fillIn} to allow the current ClipData to be
5911 * overwritten, even if it is already set.
5912 */
5913 public static final int FILL_IN_CLIP_DATA = 1<<7;
5914
5915 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005916 * Copy the contents of <var>other</var> in to this object, but only
5917 * where fields are not defined by this object. For purposes of a field
5918 * being defined, the following pieces of data in the Intent are
5919 * considered to be separate fields:
5920 *
5921 * <ul>
5922 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005923 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005924 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5925 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005926 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005927 * <li> component, as set by {@link #setComponent(ComponentName)} or
5928 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005929 * <li> source bounds, as set by {@link #setSourceBounds}.
5930 * <li> selector, as set by {@link #setSelector(Intent)}.
5931 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005932 * <li> each top-level name in the associated extras.
5933 * </ul>
5934 *
5935 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005936 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005937 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5938 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5939 * the restriction where the corresponding field will not be replaced if
5940 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005941 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005942 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
5943 * is explicitly specified. The selector will only be copied if
5944 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005945 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005946 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5947 * and Intent B with {action="gotit", data-type="some/thing",
5948 * categories="one","two"}.
5949 *
5950 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5951 * containing: {action="gotit", data-type="some/thing",
5952 * categories="bar"}.
5953 *
5954 * @param other Another Intent whose values are to be used to fill in
5955 * the current one.
5956 * @param flags Options to control which fields can be filled in.
5957 *
5958 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005959 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005960 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5961 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005962 */
5963 public int fillIn(Intent other, int flags) {
5964 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005965 if (other.mAction != null
5966 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005967 mAction = other.mAction;
5968 changes |= FILL_IN_ACTION;
5969 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005970 if ((other.mData != null || other.mType != null)
5971 && ((mData == null && mType == null)
5972 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005973 mData = other.mData;
5974 mType = other.mType;
5975 changes |= FILL_IN_DATA;
5976 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005977 if (other.mCategories != null
5978 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005979 if (other.mCategories != null) {
5980 mCategories = new HashSet<String>(other.mCategories);
5981 }
5982 changes |= FILL_IN_CATEGORIES;
5983 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005984 if (other.mPackage != null
5985 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005986 // Only do this if mSelector is not set.
5987 if (mSelector == null) {
5988 mPackage = other.mPackage;
5989 changes |= FILL_IN_PACKAGE;
5990 }
5991 }
5992 // Selector is special: it can only be set if explicitly allowed,
5993 // for the same reason as the component name.
5994 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5995 if (mPackage == null) {
5996 mSelector = new Intent(other.mSelector);
5997 mPackage = null;
5998 changes |= FILL_IN_SELECTOR;
5999 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006000 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006001 if (other.mClipData != null
6002 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6003 mClipData = other.mClipData;
6004 changes |= FILL_IN_CLIP_DATA;
6005 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006006 // Component is special: it can -only- be set if explicitly allowed,
6007 // since otherwise the sender could force the intent somewhere the
6008 // originator didn't intend.
6009 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006010 mComponent = other.mComponent;
6011 changes |= FILL_IN_COMPONENT;
6012 }
6013 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006014 if (other.mSourceBounds != null
6015 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6016 mSourceBounds = new Rect(other.mSourceBounds);
6017 changes |= FILL_IN_SOURCE_BOUNDS;
6018 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006019 if (mExtras == null) {
6020 if (other.mExtras != null) {
6021 mExtras = new Bundle(other.mExtras);
6022 }
6023 } else if (other.mExtras != null) {
6024 try {
6025 Bundle newb = new Bundle(other.mExtras);
6026 newb.putAll(mExtras);
6027 mExtras = newb;
6028 } catch (RuntimeException e) {
6029 // Modifying the extras can cause us to unparcel the contents
6030 // of the bundle, and if we do this in the system process that
6031 // may fail. We really should handle this (i.e., the Bundle
6032 // impl shouldn't be on top of a plain map), but for now just
6033 // ignore it and keep the original contents. :(
6034 Log.w("Intent", "Failure filling in extras", e);
6035 }
6036 }
6037 return changes;
6038 }
6039
6040 /**
6041 * Wrapper class holding an Intent and implementing comparisons on it for
6042 * the purpose of filtering. The class implements its
6043 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6044 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6045 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6046 * on the wrapped Intent.
6047 */
6048 public static final class FilterComparison {
6049 private final Intent mIntent;
6050 private final int mHashCode;
6051
6052 public FilterComparison(Intent intent) {
6053 mIntent = intent;
6054 mHashCode = intent.filterHashCode();
6055 }
6056
6057 /**
6058 * Return the Intent that this FilterComparison represents.
6059 * @return Returns the Intent held by the FilterComparison. Do
6060 * not modify!
6061 */
6062 public Intent getIntent() {
6063 return mIntent;
6064 }
6065
6066 @Override
6067 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006068 if (obj instanceof FilterComparison) {
6069 Intent other = ((FilterComparison)obj).mIntent;
6070 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006071 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006072 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006073 }
6074
6075 @Override
6076 public int hashCode() {
6077 return mHashCode;
6078 }
6079 }
6080
6081 /**
6082 * Determine if two intents are the same for the purposes of intent
6083 * resolution (filtering). That is, if their action, data, type,
6084 * class, and categories are the same. This does <em>not</em> compare
6085 * any extra data included in the intents.
6086 *
6087 * @param other The other Intent to compare against.
6088 *
6089 * @return Returns true if action, data, type, class, and categories
6090 * are the same.
6091 */
6092 public boolean filterEquals(Intent other) {
6093 if (other == null) {
6094 return false;
6095 }
6096 if (mAction != other.mAction) {
6097 if (mAction != null) {
6098 if (!mAction.equals(other.mAction)) {
6099 return false;
6100 }
6101 } else {
6102 if (!other.mAction.equals(mAction)) {
6103 return false;
6104 }
6105 }
6106 }
6107 if (mData != other.mData) {
6108 if (mData != null) {
6109 if (!mData.equals(other.mData)) {
6110 return false;
6111 }
6112 } else {
6113 if (!other.mData.equals(mData)) {
6114 return false;
6115 }
6116 }
6117 }
6118 if (mType != other.mType) {
6119 if (mType != null) {
6120 if (!mType.equals(other.mType)) {
6121 return false;
6122 }
6123 } else {
6124 if (!other.mType.equals(mType)) {
6125 return false;
6126 }
6127 }
6128 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006129 if (mPackage != other.mPackage) {
6130 if (mPackage != null) {
6131 if (!mPackage.equals(other.mPackage)) {
6132 return false;
6133 }
6134 } else {
6135 if (!other.mPackage.equals(mPackage)) {
6136 return false;
6137 }
6138 }
6139 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006140 if (mComponent != other.mComponent) {
6141 if (mComponent != null) {
6142 if (!mComponent.equals(other.mComponent)) {
6143 return false;
6144 }
6145 } else {
6146 if (!other.mComponent.equals(mComponent)) {
6147 return false;
6148 }
6149 }
6150 }
6151 if (mCategories != other.mCategories) {
6152 if (mCategories != null) {
6153 if (!mCategories.equals(other.mCategories)) {
6154 return false;
6155 }
6156 } else {
6157 if (!other.mCategories.equals(mCategories)) {
6158 return false;
6159 }
6160 }
6161 }
6162
6163 return true;
6164 }
6165
6166 /**
6167 * Generate hash code that matches semantics of filterEquals().
6168 *
6169 * @return Returns the hash value of the action, data, type, class, and
6170 * categories.
6171 *
6172 * @see #filterEquals
6173 */
6174 public int filterHashCode() {
6175 int code = 0;
6176 if (mAction != null) {
6177 code += mAction.hashCode();
6178 }
6179 if (mData != null) {
6180 code += mData.hashCode();
6181 }
6182 if (mType != null) {
6183 code += mType.hashCode();
6184 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006185 if (mPackage != null) {
6186 code += mPackage.hashCode();
6187 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006188 if (mComponent != null) {
6189 code += mComponent.hashCode();
6190 }
6191 if (mCategories != null) {
6192 code += mCategories.hashCode();
6193 }
6194 return code;
6195 }
6196
6197 @Override
6198 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006199 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006200
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006201 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006202 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006203 b.append(" }");
6204
6205 return b.toString();
6206 }
6207
6208 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006209 public String toInsecureString() {
6210 StringBuilder b = new StringBuilder(128);
6211
6212 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006213 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006214 b.append(" }");
6215
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006216 return b.toString();
6217 }
Romain Guy4969af72009-06-17 10:53:19 -07006218
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006219 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006220 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006221 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006222
6223 b.append("Intent { ");
6224 toShortString(b, false, true, true, true);
6225 b.append(" }");
6226
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006227 return b.toString();
6228 }
6229
6230 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006231 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6232 StringBuilder b = new StringBuilder(128);
6233 toShortString(b, secure, comp, extras, clip);
6234 return b.toString();
6235 }
6236
6237 /** @hide */
6238 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6239 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006240 boolean first = true;
6241 if (mAction != null) {
6242 b.append("act=").append(mAction);
6243 first = false;
6244 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006245 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006246 if (!first) {
6247 b.append(' ');
6248 }
6249 first = false;
6250 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006251 Iterator<String> i = mCategories.iterator();
6252 boolean didone = false;
6253 while (i.hasNext()) {
6254 if (didone) b.append(",");
6255 didone = true;
6256 b.append(i.next());
6257 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006258 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006259 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006260 if (mData != null) {
6261 if (!first) {
6262 b.append(' ');
6263 }
6264 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006265 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006266 if (secure) {
6267 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006268 } else {
6269 b.append(mData);
6270 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006271 }
6272 if (mType != null) {
6273 if (!first) {
6274 b.append(' ');
6275 }
6276 first = false;
6277 b.append("typ=").append(mType);
6278 }
6279 if (mFlags != 0) {
6280 if (!first) {
6281 b.append(' ');
6282 }
6283 first = false;
6284 b.append("flg=0x").append(Integer.toHexString(mFlags));
6285 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006286 if (mPackage != null) {
6287 if (!first) {
6288 b.append(' ');
6289 }
6290 first = false;
6291 b.append("pkg=").append(mPackage);
6292 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006293 if (comp && mComponent != null) {
6294 if (!first) {
6295 b.append(' ');
6296 }
6297 first = false;
6298 b.append("cmp=").append(mComponent.flattenToShortString());
6299 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006300 if (mSourceBounds != null) {
6301 if (!first) {
6302 b.append(' ');
6303 }
6304 first = false;
6305 b.append("bnds=").append(mSourceBounds.toShortString());
6306 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006307 if (mClipData != null) {
6308 if (!first) {
6309 b.append(' ');
6310 }
6311 first = false;
6312 if (clip) {
6313 b.append("clip={");
6314 mClipData.toShortString(b);
6315 b.append('}');
6316 } else {
6317 b.append("(has clip)");
6318 }
6319 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006320 if (extras && mExtras != null) {
6321 if (!first) {
6322 b.append(' ');
6323 }
6324 first = false;
6325 b.append("(has extras)");
6326 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006327 if (mSelector != null) {
6328 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006329 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006330 b.append("}");
6331 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006332 }
6333
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006334 /**
6335 * Call {@link #toUri} with 0 flags.
6336 * @deprecated Use {@link #toUri} instead.
6337 */
6338 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006339 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006340 return toUri(0);
6341 }
6342
6343 /**
6344 * Convert this Intent into a String holding a URI representation of it.
6345 * The returned URI string has been properly URI encoded, so it can be
6346 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6347 * Intent's data as the base URI, with an additional fragment describing
6348 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006349 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006350 * <p>You can convert the returned string back to an Intent with
6351 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006352 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006353 * @param flags Additional operating flags. Either 0 or
6354 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006355 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006356 * @return Returns a URI encoding URI string describing the entire contents
6357 * of the Intent.
6358 */
6359 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006360 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006361 String scheme = null;
6362 if (mData != null) {
6363 String data = mData.toString();
6364 if ((flags&URI_INTENT_SCHEME) != 0) {
6365 final int N = data.length();
6366 for (int i=0; i<N; i++) {
6367 char c = data.charAt(i);
6368 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6369 || c == '.' || c == '-') {
6370 continue;
6371 }
6372 if (c == ':' && i > 0) {
6373 // Valid scheme.
6374 scheme = data.substring(0, i);
6375 uri.append("intent:");
6376 data = data.substring(i+1);
6377 break;
6378 }
Tom Taylord4a47292009-12-21 13:59:18 -08006379
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006380 // No scheme.
6381 break;
6382 }
6383 }
6384 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006385
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006386 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6387 uri.append("intent:");
6388 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006389
6390 uri.append("#Intent;");
6391
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006392 toUriInner(uri, scheme, flags);
6393 if (mSelector != null) {
6394 uri.append("SEL;");
6395 // Note that for now we are not going to try to handle the
6396 // data part; not clear how to represent this as a URI, and
6397 // not much utility in it.
6398 mSelector.toUriInner(uri, null, flags);
6399 }
6400
6401 uri.append("end");
6402
6403 return uri.toString();
6404 }
6405
6406 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006407 if (scheme != null) {
6408 uri.append("scheme=").append(scheme).append(';');
6409 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006410 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006411 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006412 }
6413 if (mCategories != null) {
6414 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006415 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006416 }
6417 }
6418 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006419 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006420 }
6421 if (mFlags != 0) {
6422 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6423 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006424 if (mPackage != null) {
6425 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6426 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006427 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006428 uri.append("component=").append(Uri.encode(
6429 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006430 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006431 if (mSourceBounds != null) {
6432 uri.append("sourceBounds=")
6433 .append(Uri.encode(mSourceBounds.flattenToString()))
6434 .append(';');
6435 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006436 if (mExtras != null) {
6437 for (String key : mExtras.keySet()) {
6438 final Object value = mExtras.get(key);
6439 char entryType =
6440 value instanceof String ? 'S' :
6441 value instanceof Boolean ? 'B' :
6442 value instanceof Byte ? 'b' :
6443 value instanceof Character ? 'c' :
6444 value instanceof Double ? 'd' :
6445 value instanceof Float ? 'f' :
6446 value instanceof Integer ? 'i' :
6447 value instanceof Long ? 'l' :
6448 value instanceof Short ? 's' :
6449 '\0';
6450
6451 if (entryType != '\0') {
6452 uri.append(entryType);
6453 uri.append('.');
6454 uri.append(Uri.encode(key));
6455 uri.append('=');
6456 uri.append(Uri.encode(value.toString()));
6457 uri.append(';');
6458 }
6459 }
6460 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006461 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006462
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006463 public int describeContents() {
6464 return (mExtras != null) ? mExtras.describeContents() : 0;
6465 }
6466
6467 public void writeToParcel(Parcel out, int flags) {
6468 out.writeString(mAction);
6469 Uri.writeToParcel(out, mData);
6470 out.writeString(mType);
6471 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006472 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006473 ComponentName.writeToParcel(mComponent, out);
6474
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006475 if (mSourceBounds != null) {
6476 out.writeInt(1);
6477 mSourceBounds.writeToParcel(out, flags);
6478 } else {
6479 out.writeInt(0);
6480 }
6481
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006482 if (mCategories != null) {
6483 out.writeInt(mCategories.size());
6484 for (String category : mCategories) {
6485 out.writeString(category);
6486 }
6487 } else {
6488 out.writeInt(0);
6489 }
6490
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006491 if (mSelector != null) {
6492 out.writeInt(1);
6493 mSelector.writeToParcel(out, flags);
6494 } else {
6495 out.writeInt(0);
6496 }
6497
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006498 if (mClipData != null) {
6499 out.writeInt(1);
6500 mClipData.writeToParcel(out, flags);
6501 } else {
6502 out.writeInt(0);
6503 }
6504
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006505 out.writeBundle(mExtras);
6506 }
6507
6508 public static final Parcelable.Creator<Intent> CREATOR
6509 = new Parcelable.Creator<Intent>() {
6510 public Intent createFromParcel(Parcel in) {
6511 return new Intent(in);
6512 }
6513 public Intent[] newArray(int size) {
6514 return new Intent[size];
6515 }
6516 };
6517
Dianne Hackborneb034652009-09-07 00:49:58 -07006518 /** @hide */
6519 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006520 readFromParcel(in);
6521 }
6522
6523 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006524 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006525 mData = Uri.CREATOR.createFromParcel(in);
6526 mType = in.readString();
6527 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006528 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006529 mComponent = ComponentName.readFromParcel(in);
6530
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006531 if (in.readInt() != 0) {
6532 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6533 }
6534
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006535 int N = in.readInt();
6536 if (N > 0) {
6537 mCategories = new HashSet<String>();
6538 int i;
6539 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006540 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006541 }
6542 } else {
6543 mCategories = null;
6544 }
6545
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006546 if (in.readInt() != 0) {
6547 mSelector = new Intent(in);
6548 }
6549
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006550 if (in.readInt() != 0) {
6551 mClipData = new ClipData(in);
6552 }
6553
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006554 mExtras = in.readBundle();
6555 }
6556
6557 /**
6558 * Parses the "intent" element (and its children) from XML and instantiates
6559 * an Intent object. The given XML parser should be located at the tag
6560 * where parsing should start (often named "intent"), from which the
6561 * basic action, data, type, and package and class name will be
6562 * retrieved. The function will then parse in to any child elements,
6563 * looking for <category android:name="xxx"> tags to add categories and
6564 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6565 * to the intent.
6566 *
6567 * @param resources The Resources to use when inflating resources.
6568 * @param parser The XML parser pointing at an "intent" tag.
6569 * @param attrs The AttributeSet interface for retrieving extended
6570 * attribute data at the current <var>parser</var> location.
6571 * @return An Intent object matching the XML data.
6572 * @throws XmlPullParserException If there was an XML parsing error.
6573 * @throws IOException If there was an I/O error.
6574 */
6575 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6576 throws XmlPullParserException, IOException {
6577 Intent intent = new Intent();
6578
6579 TypedArray sa = resources.obtainAttributes(attrs,
6580 com.android.internal.R.styleable.Intent);
6581
6582 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6583
6584 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6585 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6586 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6587
6588 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6589 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6590 if (packageName != null && className != null) {
6591 intent.setComponent(new ComponentName(packageName, className));
6592 }
6593
6594 sa.recycle();
6595
6596 int outerDepth = parser.getDepth();
6597 int type;
6598 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6599 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6600 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6601 continue;
6602 }
6603
6604 String nodeName = parser.getName();
6605 if (nodeName.equals("category")) {
6606 sa = resources.obtainAttributes(attrs,
6607 com.android.internal.R.styleable.IntentCategory);
6608 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6609 sa.recycle();
6610
6611 if (cat != null) {
6612 intent.addCategory(cat);
6613 }
6614 XmlUtils.skipCurrentTag(parser);
6615
6616 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006617 if (intent.mExtras == null) {
6618 intent.mExtras = new Bundle();
6619 }
6620 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6621 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006622
6623 } else {
6624 XmlUtils.skipCurrentTag(parser);
6625 }
6626 }
6627
6628 return intent;
6629 }
Nick Pellyccae4122012-01-09 14:12:58 -08006630
6631 /**
6632 * Normalize a MIME data type.
6633 *
6634 * <p>A normalized MIME type has white-space trimmed,
6635 * content-type parameters removed, and is lower-case.
6636 * This aligns the type with Android best practices for
6637 * intent filtering.
6638 *
6639 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6640 * "text/x-vCard" becomes "text/x-vcard".
6641 *
6642 * <p>All MIME types received from outside Android (such as user input,
6643 * or external sources like Bluetooth, NFC, or the Internet) should
6644 * be normalized before they are used to create an Intent.
6645 *
6646 * @param type MIME data type to normalize
6647 * @return normalized MIME data type, or null if the input was null
6648 * @see {@link #setType}
6649 * @see {@link #setTypeAndNormalize}
6650 */
6651 public static String normalizeMimeType(String type) {
6652 if (type == null) {
6653 return null;
6654 }
6655
6656 type = type.trim().toLowerCase(Locale.US);
6657
6658 final int semicolonIndex = type.indexOf(';');
6659 if (semicolonIndex != -1) {
6660 type = type.substring(0, semicolonIndex);
6661 }
6662 return type;
6663 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006664
6665 /**
6666 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006667 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6668 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006669 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006670 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006671 * @hide
6672 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006673 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006674 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006675 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006676
6677 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006678 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006679
6680 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006681 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006682 try {
6683 // Inspect target intent to see if we need to migrate
6684 final Intent target = getParcelableExtra(EXTRA_INTENT);
6685 if (target != null && target.migrateExtraStreamToClipData()) {
6686 // Since we migrated in child, we need to promote ClipData
6687 // and flags to ourselves to grant.
6688 setClipData(target.getClipData());
6689 addFlags(target.getFlags()
6690 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6691 return true;
6692 } else {
6693 return false;
6694 }
6695 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006696 }
6697
6698 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006699 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006700 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6701 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6702 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6703 if (stream != null || text != null || htmlText != null) {
6704 final ClipData clipData = new ClipData(
6705 null, new String[] { getType() },
6706 new ClipData.Item(text, htmlText, null, stream));
6707 setClipData(clipData);
6708 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006709 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006710 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006711 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006712 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006713
6714 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006715 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006716 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6717 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6718 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6719 int num = -1;
6720 if (streams != null) {
6721 num = streams.size();
6722 }
6723 if (texts != null) {
6724 if (num >= 0 && num != texts.size()) {
6725 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006726 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006727 }
6728 num = texts.size();
6729 }
6730 if (htmlTexts != null) {
6731 if (num >= 0 && num != htmlTexts.size()) {
6732 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006733 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006734 }
6735 num = htmlTexts.size();
6736 }
6737 if (num > 0) {
6738 final ClipData clipData = new ClipData(
6739 null, new String[] { getType() },
6740 makeClipItem(streams, texts, htmlTexts, 0));
6741
6742 for (int i = 1; i < num; i++) {
6743 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6744 }
6745
6746 setClipData(clipData);
6747 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006748 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006749 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006750 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006751 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006752 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006753
6754 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006755 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006756
6757 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6758 ArrayList<String> htmlTexts, int which) {
6759 Uri uri = streams != null ? streams.get(which) : null;
6760 CharSequence text = texts != null ? texts.get(which) : null;
6761 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6762 return new ClipData.Item(text, htmlText, null, uri);
6763 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006764}