blob: 97d299a8a582112509391e0fd20dc22ed00d93d0 [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
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001257 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1258 * you can also use "package:<package-name>" to install an application for the
1259 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001260 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1261 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1262 * <p>
1263 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1264 * succeeded.
1265 *
1266 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1267 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1268 * @see #EXTRA_RETURN_RESULT
1269 */
1270 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1271 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1272
1273 /**
1274 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1275 * package. Specifies the installer package name; this package will receive the
1276 * {@link #ACTION_APP_ERROR} intent.
1277 */
1278 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1279 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1280
1281 /**
1282 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1283 * package. Specifies that the application being installed should not be
1284 * treated as coming from an unknown source, but as coming from the app
1285 * invoking the Intent. For this to work you must start the installer with
1286 * startActivityForResult().
1287 */
1288 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1289 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1290
1291 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001292 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1293 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001294 * data field originated from.
1295 */
rich cannings706e8ba2012-08-20 13:20:14 -07001296 public static final String EXTRA_ORIGINATING_URI
1297 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001298
1299 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001300 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1301 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1302 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001303 */
1304 public static final String EXTRA_REFERRER
1305 = "android.intent.extra.REFERRER";
1306
1307 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001308 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1309 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1310 * @hide
1311 */
1312 public static final String EXTRA_ORIGINATING_UID
1313 = "android.intent.extra.ORIGINATING_UID";
1314
1315 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001316 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1317 * package. Tells the installer UI to skip the confirmation with the user
1318 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001319 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1320 * will no longer show an interstitial message about updating existing
1321 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001322 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001323 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001324 public static final String EXTRA_ALLOW_REPLACE
1325 = "android.intent.extra.ALLOW_REPLACE";
1326
1327 /**
1328 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1329 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1330 * return to the application the result code of the install/uninstall. The returned result
1331 * code will be {@link android.app.Activity#RESULT_OK} on success or
1332 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1333 */
1334 public static final String EXTRA_RETURN_RESULT
1335 = "android.intent.extra.RETURN_RESULT";
1336
1337 /**
1338 * Package manager install result code. @hide because result codes are not
1339 * yet ready to be exposed.
1340 */
1341 public static final String EXTRA_INSTALL_RESULT
1342 = "android.intent.extra.INSTALL_RESULT";
1343
1344 /**
1345 * Activity Action: Launch application uninstaller.
1346 * <p>
1347 * Input: The data must be a package: URI whose scheme specific part is
1348 * the package name of the current installed package to be uninstalled.
1349 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1350 * <p>
1351 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1352 * succeeded.
1353 */
1354 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1355 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1356
1357 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001358 * Specify whether the package should be uninstalled for all users.
1359 * @hide because these should not be part of normal application flow.
1360 */
1361 public static final String EXTRA_UNINSTALL_ALL_USERS
1362 = "android.intent.extra.UNINSTALL_ALL_USERS";
1363
1364 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001365 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1366 * describing the last run version of the platform that was setup.
1367 * @hide
1368 */
1369 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1370
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001371 // ---------------------------------------------------------------------
1372 // ---------------------------------------------------------------------
1373 // Standard intent broadcast actions (see action variable).
1374
1375 /**
1376 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001377 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001378 * <p class="note">This is a protected intent that can only be sent
1379 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001380 */
1381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1382 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1383 /**
1384 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001385 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001386 * <p class="note">This is a protected intent that can only be sent
1387 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001388 */
1389 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1390 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001391
1392 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001393 * Broadcast Action: Sent after the system stops dreaming.
1394 *
1395 * <p class="note">This is a protected intent that can only be sent by the system.
1396 * It is only sent to registered receivers.</p>
1397 */
1398 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1399 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1400
1401 /**
1402 * Broadcast Action: Sent after the system starts dreaming.
1403 *
1404 * <p class="note">This is a protected intent that can only be sent by the system.
1405 * It is only sent to registered receivers.</p>
1406 */
1407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1408 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1409
1410 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001411 * 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 -07001412 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001413 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001414 * <p class="note">This is a protected intent that can only be sent
1415 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001416 */
1417 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001418 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001419
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001420 /**
1421 * Broadcast Action: The current time has changed. Sent every
1422 * minute. You can <em>not</em> receive this through components declared
1423 * in manifests, only by exlicitly registering for it with
1424 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1425 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001426 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001427 * <p class="note">This is a protected intent that can only be sent
1428 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001429 */
1430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1431 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1432 /**
1433 * Broadcast Action: The time was set.
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1437 /**
1438 * Broadcast Action: The date has changed.
1439 */
1440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1441 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1442 /**
1443 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1444 * <ul>
1445 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1446 * </ul>
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_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1453 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001454 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1455 * DNS entries should be tossed.
1456 * @hide
1457 */
1458 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1459 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1460 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001461 * Alarm Changed Action: This is broadcast when the AlarmClock
1462 * application's alarm is set or unset. It is used by the
1463 * AlarmClock application and the StatusBar service.
1464 * @hide
1465 */
1466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1467 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1468 /**
1469 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1470 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1471 * @hide
1472 */
1473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1474 public static final String ACTION_SYNC_STATE_CHANGED
1475 = "android.intent.action.SYNC_STATE_CHANGED";
1476 /**
1477 * Broadcast Action: This is broadcast once, after the system has finished
1478 * booting. It can be used to perform application-specific initialization,
1479 * such as installing alarms. You must hold the
1480 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1481 * in order to receive this broadcast.
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_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1488 /**
1489 * Broadcast Action: This is broadcast when a user action should request a
1490 * temporary system dialog to dismiss. Some examples of temporary system
1491 * dialogs are the notification window-shade and the recent tasks dialog.
1492 */
1493 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1494 /**
1495 * Broadcast Action: Trigger the download and eventual installation
1496 * of a package.
1497 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001498 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001499 * <p class="note">This is a protected intent that can only be sent
1500 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001501 *
1502 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001503 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001504 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1506 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1507 /**
1508 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001509 * device. The data contains the name of the package. Note that the
1510 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001511 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001512 * <ul>
1513 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1514 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1515 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1516 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001517 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001518 * <p class="note">This is a protected intent that can only be sent
1519 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001520 */
1521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1522 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1523 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001524 * Broadcast Action: A new version of an application package has been
1525 * installed, replacing an existing version that was previously installed.
1526 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001527 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001528 * <ul>
1529 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1530 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001531 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001532 * <p class="note">This is a protected intent that can only be sent
1533 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001534 */
1535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1536 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1537 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001538 * Broadcast Action: A new version of your application has been installed
1539 * over an existing one. This is only sent to the application that was
1540 * replaced. It does not contain any additional data; to receive it, just
1541 * use an intent filter for this action.
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_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1548 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001549 * Broadcast Action: An existing application package has been removed from
1550 * the device. The data contains the name of the package. The package
1551 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001552 * <ul>
1553 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1554 * to the package.
1555 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1556 * application -- data and code -- is being removed.
1557 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1558 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1559 * </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_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1566 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001567 * Broadcast Action: An existing application package has been completely
1568 * removed from the device. The data contains the name of the package.
1569 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1570 * {@link #EXTRA_DATA_REMOVED} is true and
1571 * {@link #EXTRA_REPLACING} is false of that broadcast.
1572 *
1573 * <ul>
1574 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1575 * to the package.
1576 * </ul>
1577 *
1578 * <p class="note">This is a protected intent that can only be sent
1579 * by the system.
1580 */
1581 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1582 public static final String ACTION_PACKAGE_FULLY_REMOVED
1583 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1584 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001585 * Broadcast Action: An existing application package has been changed (e.g.
1586 * a component has been enabled or disabled). The data contains the name of
1587 * 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.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001590 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1591 * of the changed components.
1592 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1593 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001594 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001595 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001596 * <p class="note">This is a protected intent that can only be sent
1597 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001598 */
1599 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1600 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1601 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001602 * @hide
1603 * Broadcast Action: Ask system services if there is any reason to
1604 * restart the given package. The data contains the name of the
1605 * package.
1606 * <ul>
1607 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1608 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1609 * </ul>
1610 *
1611 * <p class="note">This is a protected intent that can only be sent
1612 * by the system.
1613 */
1614 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1615 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1616 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001617 * Broadcast Action: The user has restarted a package, and all of its
1618 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001619 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001620 * be removed. Note that the restarted package does <em>not</em>
1621 * receive this broadcast.
1622 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001623 * <ul>
1624 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1625 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001626 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001627 * <p class="note">This is a protected intent that can only be sent
1628 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001629 */
1630 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1631 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1632 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001633 * Broadcast Action: The user has cleared the data of a package. This should
1634 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001635 * its persistent data is erased and this broadcast sent.
1636 * Note that the cleared package does <em>not</em>
1637 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001638 * <ul>
1639 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1640 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001641 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001642 * <p class="note">This is a protected intent that can only be sent
1643 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001644 */
1645 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1646 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1647 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001648 * Broadcast Action: A user ID has been removed from the system. The user
1649 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001650 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001651 * <p class="note">This is a protected intent that can only be sent
1652 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001653 */
1654 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1655 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001656
1657 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001658 * Broadcast Action: Sent to the installer package of an application
1659 * when that application is first launched (that is the first time it
1660 * is moved out of the stopped state). The data contains the name of the package.
1661 *
1662 * <p class="note">This is a protected intent that can only be sent
1663 * by the system.
1664 */
1665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1666 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1667
1668 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001669 * Broadcast Action: Sent to the system package verifier when a package
1670 * needs to be verified. The data contains the package URI.
1671 * <p class="note">
1672 * This is a protected intent that can only be sent by the system.
1673 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001674 */
1675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1676 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1677
1678 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001679 * Broadcast Action: Sent to the system package verifier when a package is
1680 * verified. The data contains the package URI.
1681 * <p class="note">
1682 * This is a protected intent that can only be sent by the system.
1683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1685 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1686
1687 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001688 * Broadcast Action: Resources for a set of packages (which were
1689 * previously unavailable) are currently
1690 * available since the media on which they exist is available.
1691 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1692 * list of packages whose availability changed.
1693 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1694 * list of uids of packages whose availability changed.
1695 * Note that the
1696 * packages in this list do <em>not</em> receive this broadcast.
1697 * The specified set of packages are now available on the system.
1698 * <p>Includes the following extras:
1699 * <ul>
1700 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1701 * whose resources(were previously unavailable) are currently available.
1702 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1703 * packages whose resources(were previously unavailable)
1704 * are currently available.
1705 * </ul>
1706 *
1707 * <p class="note">This is a protected intent that can only be sent
1708 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001709 */
1710 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001711 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1712 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001713
1714 /**
1715 * Broadcast Action: Resources for a set of packages are currently
1716 * unavailable since the media on which they exist is unavailable.
1717 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1718 * list of packages whose availability changed.
1719 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1720 * list of uids of packages whose availability changed.
1721 * The specified set of packages can no longer be
1722 * launched and are practically unavailable on the system.
1723 * <p>Inclues the following extras:
1724 * <ul>
1725 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1726 * whose resources are no longer available.
1727 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1728 * whose resources are no longer available.
1729 * </ul>
1730 *
1731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001733 */
1734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001735 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001736 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001737
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001738 /**
1739 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001740 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001741 * This should <em>only</em> be used to determine when the wallpaper
1742 * has changed to show the new wallpaper to the user. You should certainly
1743 * never, in response to this, change the wallpaper or other attributes of
1744 * it such as the suggested size. That would be crazy, right? You'd cause
1745 * all kinds of loops, especially if other apps are doing similar things,
1746 * right? Of course. So please don't do this.
1747 *
1748 * @deprecated Modern applications should use
1749 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1750 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1751 * shown behind their UI, rather than watching for this broadcast and
1752 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001753 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001754 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001755 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1756 /**
1757 * Broadcast Action: The current device {@link android.content.res.Configuration}
1758 * (orientation, locale, etc) has changed. When such a change happens, the
1759 * UIs (view hierarchy) will need to be rebuilt based on this new
1760 * information; for the most part, applications don't need to worry about
1761 * this, because the system will take care of stopping and restarting the
1762 * application to make sure it sees the new changes. Some system code that
1763 * can not be restarted will need to watch for this action and handle it
1764 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001765 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001766 * <p class="note">
1767 * You can <em>not</em> receive this through components declared
1768 * in manifests, only by explicitly registering for it with
1769 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1770 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001771 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001772 * <p class="note">This is a protected intent that can only be sent
1773 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001774 *
1775 * @see android.content.res.Configuration
1776 */
1777 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1778 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1779 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001780 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001781 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001782 * <p class="note">This is a protected intent that can only be sent
1783 * by the system.
1784 */
1785 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1786 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1787 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001788 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1789 * charging state, level, and other information about the battery.
1790 * See {@link android.os.BatteryManager} for documentation on the
1791 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001792 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 * <p class="note">
1794 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001795 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001796 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001797 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1798 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1799 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1800 * broadcasts that are sent and can be received through manifest
1801 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001802 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001803 * <p class="note">This is a protected intent that can only be sent
1804 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001805 */
1806 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1807 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1808 /**
1809 * Broadcast Action: Indicates low battery condition on the device.
1810 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001811 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001812 * <p class="note">This is a protected intent that can only be sent
1813 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1817 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001818 * Broadcast Action: Indicates the battery is now okay after being low.
1819 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1820 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001821 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001822 * <p class="note">This is a protected intent that can only be sent
1823 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001824 */
1825 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1826 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1827 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001828 * Broadcast Action: External power has been connected to the device.
1829 * This is intended for applications that wish to register specifically to this notification.
1830 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1831 * stay active to receive this notification. This action can be used to implement actions
1832 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001833 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001834 * <p class="note">This is a protected intent that can only be sent
1835 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001836 */
1837 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001838 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001839 /**
1840 * Broadcast Action: External power has been removed from the device.
1841 * This is intended for applications that wish to register specifically to this notification.
1842 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1843 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001844 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001845 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001846 * <p class="note">This is a protected intent that can only be sent
1847 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001848 */
1849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001850 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001851 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001852 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001853 * Broadcast Action: Device is shutting down.
1854 * This is broadcast when the device is being shut down (completely turned
1855 * off, not sleeping). Once the broadcast is complete, the final shutdown
1856 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001857 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001858 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001859 * <p class="note">This is a protected intent that can only be sent
1860 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001861 */
1862 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001863 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001864 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001865 * Activity Action: Start this activity to request system shutdown.
1866 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1867 * to request confirmation from the user before shutting down.
1868 *
1869 * <p class="note">This is a protected intent that can only be sent
1870 * by the system.
1871 *
1872 * {@hide}
1873 */
1874 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1875 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001876 * Broadcast Action: A sticky broadcast that indicates low memory
1877 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001878 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001879 * <p class="note">This is a protected intent that can only be sent
1880 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1884 /**
1885 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001886 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001887 * <p class="note">This is a protected intent that can only be sent
1888 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001889 */
1890 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1891 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1892 /**
Jake Hambybb371632010-08-23 18:16:48 -07001893 * Broadcast Action: A sticky broadcast that indicates a memory full
1894 * condition on the device. This is intended for activities that want
1895 * to be able to fill the data partition completely, leaving only
1896 * enough free space to prevent system-wide SQLite failures.
1897 *
1898 * <p class="note">This is a protected intent that can only be sent
1899 * by the system.
1900 *
1901 * {@hide}
1902 */
1903 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1904 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1905 /**
1906 * Broadcast Action: Indicates memory full condition on the device
1907 * no longer exists.
1908 *
1909 * <p class="note">This is a protected intent that can only be sent
1910 * by the system.
1911 *
1912 * {@hide}
1913 */
1914 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1915 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1916 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001917 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1918 * and package management should be started.
1919 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1920 * notification.
1921 */
1922 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1923 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1924 /**
1925 * Broadcast Action: The device has entered USB Mass Storage mode.
1926 * This is used mainly for the USB Settings panel.
1927 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1928 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001929 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001931 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001932 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1933
1934 /**
1935 * Broadcast Action: The device has exited USB Mass Storage mode.
1936 * This is used mainly for the USB Settings panel.
1937 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1938 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001939 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001940 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001941 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1943
1944 /**
1945 * Broadcast Action: External media has been removed.
1946 * The path to the mount point for the removed media is contained in the Intent.mData field.
1947 */
1948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1949 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1950
1951 /**
1952 * Broadcast Action: External media is present, but not mounted at its mount point.
1953 * The path to the mount point for the removed media is contained in the Intent.mData field.
1954 */
1955 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1956 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1957
1958 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001959 * Broadcast Action: External media is present, and being disk-checked
1960 * 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 -08001961 */
1962 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1963 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1964
1965 /**
1966 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1967 * 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 -08001968 */
1969 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1970 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1971
1972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 * Broadcast Action: External media is present and mounted at its mount point.
1974 * The path to the mount point for the removed media is contained in the Intent.mData field.
1975 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1976 * media was mounted read only.
1977 */
1978 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1979 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1980
1981 /**
1982 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001983 * 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 -07001984 */
1985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1986 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1987
1988 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001989 * Broadcast Action: External media is no longer being shared via USB mass storage.
1990 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1991 *
1992 * @hide
1993 */
1994 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1995
1996 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001997 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1998 * The path to the mount point for the removed media is contained in the Intent.mData field.
1999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2002
2003 /**
2004 * Broadcast Action: External media is present but cannot be mounted.
2005 * The path to the mount point for the removed media is contained in the Intent.mData field.
2006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2009
2010 /**
2011 * Broadcast Action: User has expressed the desire to remove the external storage media.
2012 * Applications should close all files they have open within the mount point when they receive this intent.
2013 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2014 */
2015 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2016 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2017
2018 /**
2019 * Broadcast Action: The media scanner has started scanning a directory.
2020 * The path to the directory being scanned is contained in the Intent.mData field.
2021 */
2022 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2023 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2024
2025 /**
2026 * Broadcast Action: The media scanner has finished scanning a directory.
2027 * The path to the scanned directory is contained in the Intent.mData field.
2028 */
2029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2030 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2031
2032 /**
2033 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2034 * The path to the file is contained in the Intent.mData field.
2035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2038
2039 /**
2040 * Broadcast Action: The "Media Button" was pressed. Includes a single
2041 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2042 * caused the broadcast.
2043 */
2044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2045 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2046
2047 /**
2048 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2049 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2050 * caused the broadcast.
2051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2054
2055 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2056 // location; they are not general-purpose actions.
2057
2058 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002059 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002060 */
2061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2063 "android.intent.action.GTALK_CONNECTED";
2064
2065 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002066 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002067 */
2068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2070 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002071
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002072 /**
2073 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_INPUT_METHOD_CHANGED =
2077 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002078
2079 /**
2080 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2081 * more radios have been turned off or on. The intent will have the following extra value:</p>
2082 * <ul>
2083 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2084 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2085 * turned off</li>
2086 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002087 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002088 * <p class="note">This is a protected intent that can only be sent
2089 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002090 */
2091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2092 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2093
2094 /**
2095 * Broadcast Action: Some content providers have parts of their namespace
2096 * where they publish new events or items that the user may be especially
2097 * interested in. For these things, they may broadcast this action when the
2098 * set of interesting items change.
2099 *
2100 * For example, GmailProvider sends this notification when the set of unread
2101 * mail in the inbox changes.
2102 *
2103 * <p>The data of the intent identifies which part of which provider
2104 * changed. When queried through the content resolver, the data URI will
2105 * return the data set in question.
2106 *
2107 * <p>The intent will have the following extra values:
2108 * <ul>
2109 * <li><em>count</em> - The number of items in the data set. This is the
2110 * same as the number of items in the cursor returned by querying the
2111 * data URI. </li>
2112 * </ul>
2113 *
2114 * This intent will be sent at boot (if the count is non-zero) and when the
2115 * data set changes. It is possible for the data set to change without the
2116 * count changing (for example, if a new unread message arrives in the same
2117 * sync operation in which a message is archived). The phone should still
2118 * ring/vibrate/etc as normal in this case.
2119 */
2120 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2121 public static final String ACTION_PROVIDER_CHANGED =
2122 "android.intent.action.PROVIDER_CHANGED";
2123
2124 /**
2125 * Broadcast Action: Wired Headset plugged in or unplugged.
2126 *
2127 * <p>The intent will have the following extra values:
2128 * <ul>
2129 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2130 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002131 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 * </ul>
2133 * </ul>
2134 */
2135 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2136 public static final String ACTION_HEADSET_PLUG =
2137 "android.intent.action.HEADSET_PLUG";
2138
2139 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002140 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2141 *
2142 * <p>The intent will have the following extra values:
2143 * <ul>
2144 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2145 * <li><em>name</em> - Headset type, human readable string </li>
2146 * </ul>
2147 * </ul>
2148 * @hide
2149 */
2150 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002151 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2152 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002153
2154 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002155 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002156 *
2157 * <p>The intent will have the following extra values:
2158 * <ul>
2159 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2160 * <li><em>name</em> - Headset type, human readable string </li>
2161 * </ul>
2162 * </ul>
2163 * @hide
2164 */
2165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002166 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2167 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002168
2169 /**
2170 * Broadcast Action: A HMDI cable was plugged or unplugged
2171 *
2172 * <p>The intent will have the following extra values:
2173 * <ul>
2174 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2175 * <li><em>name</em> - HDMI cable, human readable string </li>
2176 * </ul>
2177 * </ul>
2178 * @hide
2179 */
2180 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2181 public static final String ACTION_HDMI_AUDIO_PLUG =
2182 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002183
2184 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002185 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2186 *
2187 * <p>The intent will have the following extra values:
2188 * <ul>
2189 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2190 * <li><em>card</em> - ALSA card number (integer) </li>
2191 * <li><em>device</em> - ALSA device number (integer) </li>
2192 * </ul>
2193 * </ul>
2194 * @hide
2195 */
2196 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2197 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2198 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2199
2200 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002201 * Broadcast Action: A USB audio device was plugged in or unplugged.
2202 *
2203 * <p>The intent will have the following extra values:
2204 * <ul>
2205 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2206 * <li><em>card</em> - ALSA card number (integer) </li>
2207 * <li><em>device</em> - ALSA device number (integer) </li>
2208 * </ul>
2209 * </ul>
2210 * @hide
2211 */
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2214 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2215
2216 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002217 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2218 * <ul>
2219 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2220 * </ul>
2221 *
2222 * <p class="note">This is a protected intent that can only be sent
2223 * by the system.
2224 *
2225 * @hide
2226 */
2227 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2228 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2229 = "android.intent.action.ADVANCED_SETTINGS";
2230
2231 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002232 * Broadcast Action: An outgoing call is about to be placed.
2233 *
2234 * <p>The Intent will have the following extra value:
2235 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002236 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002237 * the phone number originally intended to be dialed.</li>
2238 * </ul>
2239 * <p>Once the broadcast is finished, the resultData is used as the actual
2240 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002241 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002242 * outgoing call in turn: for example, a parental control application
2243 * might verify that the user is authorized to place the call at that
2244 * time, then a number-rewriting application might add an area code if
2245 * one was not specified.</p>
2246 * <p>For consistency, any receiver whose purpose is to prohibit phone
2247 * calls should have a priority of 0, to ensure it will see the final
2248 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002249 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002250 * should have a positive priority.
2251 * Negative priorities are reserved for the system for this broadcast;
2252 * using them may cause problems.</p>
2253 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2254 * abort the broadcast.</p>
2255 * <p>Emergency calls cannot be intercepted using this mechanism, and
2256 * other calls cannot be modified to call emergency numbers using this
2257 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002258 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002259 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2260 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002261 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002262 * <p class="note">This is a protected intent that can only be sent
2263 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 */
2265 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_NEW_OUTGOING_CALL =
2267 "android.intent.action.NEW_OUTGOING_CALL";
2268
2269 /**
2270 * Broadcast Action: Have the device reboot. This is only for use by
2271 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002272 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002273 * <p class="note">This is a protected intent that can only be sent
2274 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 */
2276 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2277 public static final String ACTION_REBOOT =
2278 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002279
Wei Huang97ecc9c2009-05-11 17:44:20 -07002280 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002281 * Broadcast Action: A sticky broadcast for changes in the physical
2282 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002283 *
2284 * <p>The intent will have the following extra values:
2285 * <ul>
2286 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002287 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002288 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002289 * <p>This is intended for monitoring the current physical dock state.
2290 * See {@link android.app.UiModeManager} for the normal API dealing with
2291 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002292 */
2293 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2294 public static final String ACTION_DOCK_EVENT =
2295 "android.intent.action.DOCK_EVENT";
2296
2297 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002298 * Broadcast Action: a remote intent is to be broadcasted.
2299 *
2300 * A remote intent is used for remote RPC between devices. The remote intent
2301 * is serialized and sent from one device to another device. The receiving
2302 * device parses the remote intent and broadcasts it. Note that anyone can
2303 * broadcast a remote intent. However, if the intent receiver of the remote intent
2304 * does not trust intent broadcasts from arbitrary intent senders, it should require
2305 * the sender to hold certain permissions so only trusted sender's broadcast will be
2306 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002307 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002308 */
2309 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002310 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002311
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002312 /**
2313 * Broadcast Action: hook for permforming cleanup after a system update.
2314 *
2315 * The broadcast is sent when the system is booting, before the
2316 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2317 * image. A receiver for this should do its work and then disable itself
2318 * so that it does not get run again at the next boot.
2319 * @hide
2320 */
2321 public static final String ACTION_PRE_BOOT_COMPLETED =
2322 "android.intent.action.PRE_BOOT_COMPLETED";
2323
Amith Yamasani13593602012-03-22 16:16:17 -07002324 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002325 * Sent the first time a user is starting, to allow system apps to
2326 * perform one time initialization. (This will not be seen by third
2327 * party applications because a newly initialized user does not have any
2328 * third party applications installed for it.) This is sent early in
2329 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002330 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2331 * broadcast, since it is part of a visible user interaction; be as quick
2332 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002333 */
2334 public static final String ACTION_USER_INITIALIZE =
2335 "android.intent.action.USER_INITIALIZE";
2336
2337 /**
2338 * Sent when a user switch is happening, causing the process's user to be
2339 * brought to the foreground. This is only sent to receivers registered
2340 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2341 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002342 * foreground. This is sent as a foreground
2343 * broadcast, since it is part of a visible user interaction; be as quick
2344 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002345 */
2346 public static final String ACTION_USER_FOREGROUND =
2347 "android.intent.action.USER_FOREGROUND";
2348
2349 /**
2350 * Sent when a user switch is happening, causing the process's user to be
2351 * sent to the background. This is only sent to receivers registered
2352 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2353 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002354 * background. This is sent as a foreground
2355 * broadcast, since it is part of a visible user interaction; be as quick
2356 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002357 */
2358 public static final String ACTION_USER_BACKGROUND =
2359 "android.intent.action.USER_BACKGROUND";
2360
2361 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002362 * Broadcast sent to the system when a user is added. Carries an extra
2363 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2364 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002365 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002366 * @hide
2367 */
2368 public static final String ACTION_USER_ADDED =
2369 "android.intent.action.USER_ADDED";
2370
2371 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002372 * Broadcast sent by the system when a user is started. Carries an extra
2373 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002374 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002375 * that has been started. This is sent as a foreground
2376 * broadcast, since it is part of a visible user interaction; be as quick
2377 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002378 * @hide
2379 */
2380 public static final String ACTION_USER_STARTED =
2381 "android.intent.action.USER_STARTED";
2382
2383 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002384 * Broadcast sent when a user is in the process of starting. Carries an extra
2385 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2386 * sent to registered receivers, not manifest receivers. It is sent to all
2387 * users (including the one that is being started). You must hold
2388 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2389 * this broadcast. This is sent as a background broadcast, since
2390 * its result is not part of the primary UX flow; to safely keep track of
2391 * started/stopped state of a user you can use this in conjunction with
2392 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2393 * other user state broadcasts since those are foreground broadcasts so can
2394 * execute in a different order.
2395 * @hide
2396 */
2397 public static final String ACTION_USER_STARTING =
2398 "android.intent.action.USER_STARTING";
2399
2400 /**
2401 * Broadcast sent when a user is going to be stopped. Carries an extra
2402 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2403 * sent to registered receivers, not manifest receivers. It is sent to all
2404 * users (including the one that is being stopped). You must hold
2405 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2406 * this broadcast. The user will not stop until all receivers have
2407 * handled the broadcast. This is sent as a background broadcast, since
2408 * its result is not part of the primary UX flow; to safely keep track of
2409 * started/stopped state of a user you can use this in conjunction with
2410 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2411 * other user state broadcasts since those are foreground broadcasts so can
2412 * execute in a different order.
2413 * @hide
2414 */
2415 public static final String ACTION_USER_STOPPING =
2416 "android.intent.action.USER_STOPPING";
2417
2418 /**
2419 * Broadcast sent to the system when a user is stopped. Carries an extra
2420 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2421 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2422 * specific package. This is only sent to registered receivers, not manifest
2423 * receivers. It is sent to all running users <em>except</em> the one that
2424 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002425 * @hide
2426 */
2427 public static final String ACTION_USER_STOPPED =
2428 "android.intent.action.USER_STOPPED";
2429
2430 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002431 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002432 * the userHandle of the user. It is sent to all running users except the
2433 * one that has been removed. You must hold
2434 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002435 * @hide
2436 */
2437 public static final String ACTION_USER_REMOVED =
2438 "android.intent.action.USER_REMOVED";
2439
2440 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002441 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002442 * the userHandle of the user to become the current one. This is only sent to
2443 * registered receivers, not manifest receivers. It is sent to all running users.
2444 * You must hold
2445 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002446 * @hide
2447 */
2448 public static final String ACTION_USER_SWITCHED =
2449 "android.intent.action.USER_SWITCHED";
2450
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002451 /**
2452 * Broadcast sent to the system when a user's information changes. Carries an extra
2453 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2454 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2455 * whose information has changed.
2456 * @hide
2457 */
2458 public static final String ACTION_USER_INFO_CHANGED =
2459 "android.intent.action.USER_INFO_CHANGED";
2460
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002461 /**
2462 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2463 */
2464 public static final String ACTION_QUICK_CLOCK =
2465 "android.intent.action.QUICK_CLOCK";
2466
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002467 // ---------------------------------------------------------------------
2468 // ---------------------------------------------------------------------
2469 // Standard intent categories (see addCategory()).
2470
2471 /**
2472 * Set if the activity should be an option for the default action
2473 * (center press) to perform on a piece of data. Setting this will
2474 * hide from the user any activities without it set when performing an
2475 * action on some data. Note that this is normal -not- set in the
2476 * Intent when initiating an action -- it is for use in intent filters
2477 * specified in packages.
2478 */
2479 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2480 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2481 /**
2482 * Activities that can be safely invoked from a browser must support this
2483 * category. For example, if the user is viewing a web page or an e-mail
2484 * and clicks on a link in the text, the Intent generated execute that
2485 * link will require the BROWSABLE category, so that only activities
2486 * supporting this category will be considered as possible actions. By
2487 * supporting this category, you are promising that there is nothing
2488 * damaging (without user intervention) that can happen by invoking any
2489 * matching Intent.
2490 */
2491 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2492 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2493 /**
2494 * Set if the activity should be considered as an alternative action to
2495 * the data the user is currently viewing. See also
2496 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2497 * applies to the selection in a list of items.
2498 *
2499 * <p>Supporting this category means that you would like your activity to be
2500 * displayed in the set of alternative things the user can do, usually as
2501 * part of the current activity's options menu. You will usually want to
2502 * include a specific label in the &lt;intent-filter&gt; of this action
2503 * describing to the user what it does.
2504 *
2505 * <p>The action of IntentFilter with this category is important in that it
2506 * describes the specific action the target will perform. This generally
2507 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2508 * a specific name such as "com.android.camera.action.CROP. Only one
2509 * alternative of any particular action will be shown to the user, so using
2510 * a specific action like this makes sure that your alternative will be
2511 * displayed while also allowing other applications to provide their own
2512 * overrides of that particular action.
2513 */
2514 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2515 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2516 /**
2517 * Set if the activity should be considered as an alternative selection
2518 * action to the data the user has currently selected. This is like
2519 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2520 * of items from which the user can select, giving them alternatives to the
2521 * default action that will be performed on it.
2522 */
2523 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2524 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2525 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002526 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002527 */
2528 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2529 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2530 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002531 * Should be displayed in the top-level launcher.
2532 */
2533 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2534 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2535 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002536 * Provides information about the package it is in; typically used if
2537 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2538 * a front-door to the user without having to be shown in the all apps list.
2539 */
2540 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2541 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2542 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002543 * This is the home activity, that is the first activity that is displayed
2544 * when the device boots.
2545 */
2546 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2547 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2548 /**
2549 * This activity is a preference panel.
2550 */
2551 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2552 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2553 /**
2554 * This activity is a development preference panel.
2555 */
2556 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2557 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2558 /**
2559 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002560 */
2561 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2562 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2563 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002564 * This activity allows the user to browse and download new applications.
2565 */
2566 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2567 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2568 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002569 * This activity may be exercised by the monkey or other automated test tools.
2570 */
2571 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2572 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2573 /**
2574 * To be used as a test (not part of the normal user experience).
2575 */
2576 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2577 /**
2578 * To be used as a unit test (run through the Test Harness).
2579 */
2580 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2581 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002582 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002583 * experience).
2584 */
2585 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2586 /**
2587 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2588 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2589 * when queried, though it is allowable for those columns to be blank.
2590 */
2591 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2592 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2593
2594 /**
2595 * To be used as code under test for framework instrumentation tests.
2596 */
2597 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2598 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002599 /**
2600 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002601 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2602 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002603 */
2604 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2605 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2606 /**
2607 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002608 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2609 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002610 */
2611 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2612 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002613 /**
2614 * An activity to run when device is inserted into a analog (low end) dock.
2615 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2616 * information, see {@link android.app.UiModeManager}.
2617 */
2618 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2619 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2620
2621 /**
2622 * An activity to run when device is inserted into a digital (high end) dock.
2623 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2624 * information, see {@link android.app.UiModeManager}.
2625 */
2626 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2627 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002628
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002629 /**
2630 * Used to indicate that the activity can be used in a car environment.
2631 */
2632 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2633 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2634
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002635 // ---------------------------------------------------------------------
2636 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002637 // Application launch intent categories (see addCategory()).
2638
2639 /**
2640 * Used with {@link #ACTION_MAIN} to launch the browser application.
2641 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002642 * <p>NOTE: This should not be used as the primary key of an Intent,
2643 * since it will not result in the app launching with the correct
2644 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002645 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002646 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002647 */
2648 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2649 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2650
2651 /**
2652 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2653 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002654 * <p>NOTE: This should not be used as the primary key of an Intent,
2655 * since it will not result in the app launching with the correct
2656 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002657 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002658 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002659 */
2660 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2661 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2662
2663 /**
2664 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2665 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002666 * <p>NOTE: This should not be used as the primary key of an Intent,
2667 * since it will not result in the app launching with the correct
2668 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002669 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002670 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002671 */
2672 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2673 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2674
2675 /**
2676 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2677 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002678 * <p>NOTE: This should not be used as the primary key of an Intent,
2679 * since it will not result in the app launching with the correct
2680 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002681 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002682 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002683 */
2684 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2685 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2686
2687 /**
2688 * Used with {@link #ACTION_MAIN} to launch the email application.
2689 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002690 * <p>NOTE: This should not be used as the primary key of an Intent,
2691 * since it will not result in the app launching with the correct
2692 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002693 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002694 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002695 */
2696 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2697 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2698
2699 /**
2700 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2701 * The activity should be able to view and manipulate image and video files
2702 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002703 * <p>NOTE: This should not be used as the primary key of an Intent,
2704 * since it will not result in the app launching with the correct
2705 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002706 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002707 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002708 */
2709 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2710 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2711
2712 /**
2713 * Used with {@link #ACTION_MAIN} to launch the maps application.
2714 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002715 * <p>NOTE: This should not be used as the primary key of an Intent,
2716 * since it will not result in the app launching with the correct
2717 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002718 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002719 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002720 */
2721 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2722 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2723
2724 /**
2725 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2726 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002727 * <p>NOTE: This should not be used as the primary key of an Intent,
2728 * since it will not result in the app launching with the correct
2729 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002730 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002731 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002732 */
2733 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2734 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2735
2736 /**
2737 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002738 * The activity should be able to play, browse, or manipulate music files
2739 * stored on the device.
2740 * <p>NOTE: This should not be used as the primary key of an Intent,
2741 * since it will not result in the app launching with the correct
2742 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002743 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002744 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002745 */
2746 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2747 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2748
2749 // ---------------------------------------------------------------------
2750 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002751 // Standard extra data keys.
2752
2753 /**
2754 * The initial data to place in a newly created record. Use with
2755 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2756 * fields as would be given to the underlying ContentProvider.insert()
2757 * call.
2758 */
2759 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2760
2761 /**
2762 * A constant CharSequence that is associated with the Intent, used with
2763 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2764 * this may be a styled CharSequence, so you must use
2765 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2766 * retrieve it.
2767 */
2768 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2769
2770 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002771 * A constant String that is associated with the Intent, used with
2772 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2773 * as HTML formatted text. Note that you <em>must</em> also supply
2774 * {@link #EXTRA_TEXT}.
2775 */
2776 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2777
2778 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002779 * A content: URI holding a stream of data associated with the Intent,
2780 * used with {@link #ACTION_SEND} to supply the data being sent.
2781 */
2782 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2783
2784 /**
2785 * A String[] holding e-mail addresses that should be delivered to.
2786 */
2787 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2788
2789 /**
2790 * A String[] holding e-mail addresses that should be carbon copied.
2791 */
2792 public static final String EXTRA_CC = "android.intent.extra.CC";
2793
2794 /**
2795 * A String[] holding e-mail addresses that should be blind carbon copied.
2796 */
2797 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2798
2799 /**
2800 * A constant string holding the desired subject line of a message.
2801 */
2802 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2803
2804 /**
2805 * An Intent describing the choices you would like shown with
2806 * {@link #ACTION_PICK_ACTIVITY}.
2807 */
2808 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2809
2810 /**
2811 * A CharSequence dialog title to provide to the user when used with a
2812 * {@link #ACTION_CHOOSER}.
2813 */
2814 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2815
2816 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002817 * A Parcelable[] of {@link Intent} or
2818 * {@link android.content.pm.LabeledIntent} objects as set with
2819 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2820 * a the front of the list of choices, when shown to the user with a
2821 * {@link #ACTION_CHOOSER}.
2822 */
2823 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2824
2825 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002826 * A {@link android.view.KeyEvent} object containing the event that
2827 * triggered the creation of the Intent it is in.
2828 */
2829 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2830
2831 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002832 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2833 * before shutting down.
2834 *
2835 * {@hide}
2836 */
2837 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2838
2839 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002840 * 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 -07002841 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2842 * of restarting the application.
2843 */
2844 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2845
2846 /**
2847 * A String holding the phone number originally entered in
2848 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2849 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2850 */
2851 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002852
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002853 /**
2854 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2855 * intents to supply the uid the package had been assigned. Also an optional
2856 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2857 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2858 * purpose.
2859 */
2860 public static final String EXTRA_UID = "android.intent.extra.UID";
2861
2862 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002863 * @hide String array of package names.
2864 */
2865 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2866
2867 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002868 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2869 * intents to indicate whether this represents a full uninstall (removing
2870 * both the code and its data) or a partial uninstall (leaving its data,
2871 * implying that this is an update).
2872 */
2873 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002874
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002875 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002876 * @hide
2877 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2878 * intents to indicate that at this point the package has been removed for
2879 * all users on the device.
2880 */
2881 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2882 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2883
2884 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002885 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2886 * intents to indicate that this is a replacement of the package, so this
2887 * broadcast will immediately be followed by an add broadcast for a
2888 * different version of the same package.
2889 */
2890 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002891
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002892 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002893 * Used as an int extra field in {@link android.app.AlarmManager} intents
2894 * to tell the application being invoked how many pending alarms are being
2895 * delievered with the intent. For one-shot alarms this will always be 1.
2896 * For recurring alarms, this might be greater than 1 if the device was
2897 * asleep or powered off at the time an earlier alarm would have been
2898 * delivered.
2899 */
2900 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002901
Jacek Surazski86b6c532009-05-13 14:38:28 +02002902 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002903 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2904 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002905 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2906 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002907 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2908 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2909 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002910 */
2911 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2912
2913 /**
2914 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2915 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002916 */
2917 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2918
2919 /**
2920 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2921 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002922 */
2923 public static final int EXTRA_DOCK_STATE_DESK = 1;
2924
2925 /**
2926 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2927 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002928 */
2929 public static final int EXTRA_DOCK_STATE_CAR = 2;
2930
2931 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002932 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2933 * to represent that the phone is in a analog (low end) dock.
2934 */
2935 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2936
2937 /**
2938 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2939 * to represent that the phone is in a digital (high end) dock.
2940 */
2941 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2942
2943 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002944 * Boolean that can be supplied as meta-data with a dock activity, to
2945 * indicate that the dock should take over the home key when it is active.
2946 */
2947 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002948
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002949 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002950 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2951 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002952 */
2953 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2954
2955 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002956 * Used in the extra field in the remote intent. It's astring token passed with the
2957 * remote intent.
2958 */
2959 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2960 "android.intent.extra.remote_intent_token";
2961
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002962 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002963 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002964 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002965 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002966 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002967 "android.intent.extra.changed_component_name";
2968
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002969 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002970 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002971 * and contains a string array of all of the components that have changed.
2972 */
2973 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2974 "android.intent.extra.changed_component_name_list";
2975
2976 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002977 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002978 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2979 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002980 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002981 */
2982 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2983 "android.intent.extra.changed_package_list";
2984
2985 /**
2986 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002987 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2988 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002989 * and contains an integer array of uids of all of the components
2990 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002991 */
2992 public static final String EXTRA_CHANGED_UID_LIST =
2993 "android.intent.extra.changed_uid_list";
2994
2995 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002996 * @hide
2997 * Magic extra system code can use when binding, to give a label for
2998 * who it is that has bound to a service. This is an integer giving
2999 * a framework string resource that can be displayed to the user.
3000 */
3001 public static final String EXTRA_CLIENT_LABEL =
3002 "android.intent.extra.client_label";
3003
3004 /**
3005 * @hide
3006 * Magic extra system code can use when binding, to give a PendingIntent object
3007 * that can be launched for the user to disable the system's use of this
3008 * service.
3009 */
3010 public static final String EXTRA_CLIENT_INTENT =
3011 "android.intent.extra.client_intent";
3012
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003013 /**
3014 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3015 * data that is on the local device. This is a boolean extra; the default
3016 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3017 * the user to select media that is already on the device, not requiring it
3018 * be downloaded from a remote service when opened. Another way to look
3019 * at it is that such content should generally have a "_data" column to the
3020 * path of the content on local external storage.
3021 */
3022 public static final String EXTRA_LOCAL_ONLY =
3023 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003024
Amith Yamasani13593602012-03-22 16:16:17 -07003025 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003026 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003027 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3028 * @hide
3029 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003030 public static final String EXTRA_USER_HANDLE =
3031 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003032
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003033 // ---------------------------------------------------------------------
3034 // ---------------------------------------------------------------------
3035 // Intent flags (see mFlags variable).
3036
3037 /**
3038 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003039 * perform read operations on the Uri in the Intent's data and any URIs
3040 * specified in its ClipData. When applying to an Intent's ClipData,
3041 * all URIs as well as recursive traversals through data or other ClipData
3042 * in Intent items will be granted; only the grant flags of the top-level
3043 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003044 */
3045 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3046 /**
3047 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003048 * perform write operations on the Uri in the Intent's data and any URIs
3049 * specified in its ClipData. When applying to an Intent's ClipData,
3050 * all URIs as well as recursive traversals through data or other ClipData
3051 * in Intent items will be granted; only the grant flags of the top-level
3052 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003053 */
3054 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3055 /**
3056 * Can be set by the caller to indicate that this Intent is coming from
3057 * a background operation, not from direct user interaction.
3058 */
3059 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3060 /**
3061 * A flag you can enable for debugging: when set, log messages will be
3062 * printed during the resolution of this intent to show you what has
3063 * been found to create the final resolved list.
3064 */
3065 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003066 /**
3067 * If set, this intent will not match any components in packages that
3068 * are currently stopped. If this is not set, then the default behavior
3069 * is to include such applications in the result.
3070 */
3071 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3072 /**
3073 * If set, this intent will always match any components in packages that
3074 * are currently stopped. This is the default behavior when
3075 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3076 * flags are set, this one wins (it allows overriding of exclude for
3077 * places where the framework may automatically set the exclude flag).
3078 */
3079 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003080
3081 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003082 * If set, the new activity is not kept in the history stack. As soon as
3083 * the user navigates away from it, the activity is finished. This may also
3084 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3085 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003086 */
3087 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3088 /**
3089 * If set, the activity will not be launched if it is already running
3090 * at the top of the history stack.
3091 */
3092 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3093 /**
3094 * If set, this activity will become the start of a new task on this
3095 * history stack. A task (from the activity that started it to the
3096 * next task activity) defines an atomic group of activities that the
3097 * user can move to. Tasks can be moved to the foreground and background;
3098 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003099 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003100 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3101 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003102 *
3103 * <p>This flag is generally used by activities that want
3104 * to present a "launcher" style behavior: they give the user a list of
3105 * separate things that can be done, which otherwise run completely
3106 * independently of the activity launching them.
3107 *
3108 * <p>When using this flag, if a task is already running for the activity
3109 * you are now starting, then a new activity will not be started; instead,
3110 * the current task will simply be brought to the front of the screen with
3111 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3112 * to disable this behavior.
3113 *
3114 * <p>This flag can not be used when the caller is requesting a result from
3115 * the activity being launched.
3116 */
3117 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3118 /**
3119 * <strong>Do not use this flag unless you are implementing your own
3120 * top-level application launcher.</strong> Used in conjunction with
3121 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3122 * behavior of bringing an existing task to the foreground. When set,
3123 * a new task is <em>always</em> started to host the Activity for the
3124 * Intent, regardless of whether there is already an existing task running
3125 * the same thing.
3126 *
3127 * <p><strong>Because the default system does not include graphical task management,
3128 * you should not use this flag unless you provide some way for a user to
3129 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003130 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003131 * <p>This flag is ignored if
3132 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3133 *
Scott Main7aee61f2011-02-08 11:25:01 -08003134 * <p>See
3135 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3136 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003137 */
3138 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3139 /**
3140 * If set, and the activity being launched is already running in the
3141 * current task, then instead of launching a new instance of that activity,
3142 * all of the other activities on top of it will be closed and this Intent
3143 * will be delivered to the (now on top) old activity as a new Intent.
3144 *
3145 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3146 * If D calls startActivity() with an Intent that resolves to the component
3147 * of activity B, then C and D will be finished and B receive the given
3148 * Intent, resulting in the stack now being: A, B.
3149 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003150 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003151 * either receive the new intent you are starting here in its
3152 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003153 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003154 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3155 * the same intent, then it will be finished and re-created; for all other
3156 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3157 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003158 *
3159 * <p>This launch mode can also be used to good effect in conjunction with
3160 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3161 * of a task, it will bring any currently running instance of that task
3162 * to the foreground, and then clear it to its root state. This is
3163 * especially useful, for example, when launching an activity from the
3164 * notification manager.
3165 *
Scott Main7aee61f2011-02-08 11:25:01 -08003166 * <p>See
3167 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3168 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003169 */
3170 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3171 /**
3172 * If set and this intent is being used to launch a new activity from an
3173 * existing one, then the reply target of the existing activity will be
3174 * transfered to the new activity. This way the new activity can call
3175 * {@link android.app.Activity#setResult} and have that result sent back to
3176 * the reply target of the original activity.
3177 */
3178 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3179 /**
3180 * If set and this intent is being used to launch a new activity from an
3181 * existing one, the current activity will not be counted as the top
3182 * activity for deciding whether the new intent should be delivered to
3183 * the top instead of starting a new one. The previous activity will
3184 * be used as the top, with the assumption being that the current activity
3185 * will finish itself immediately.
3186 */
3187 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3188 /**
3189 * If set, the new activity is not kept in the list of recently launched
3190 * activities.
3191 */
3192 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3193 /**
3194 * This flag is not normally set by application code, but set for you by
3195 * the system as described in the
3196 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3197 * launchMode} documentation for the singleTask mode.
3198 */
3199 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3200 /**
3201 * If set, and this activity is either being started in a new task or
3202 * bringing to the top an existing task, then it will be launched as
3203 * the front door of the task. This will result in the application of
3204 * any affinities needed to have that task in the proper state (either
3205 * moving activities to or from it), or simply resetting that task to
3206 * its initial state if needed.
3207 */
3208 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3209 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003210 * This flag is not normally set by application code, but set for you by
3211 * the system if this activity is being launched from history
3212 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003213 */
3214 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003215 /**
3216 * If set, this marks a point in the task's activity stack that should
3217 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003218 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003219 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3220 * the user re-launching it from home), this activity and all on top of
3221 * it will be finished so that the user does not return to them, but
3222 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003223 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003224 * <p>This is useful for cases where you have a logical break in your
3225 * application. For example, an e-mail application may have a command
3226 * to view an attachment, which launches an image view activity to
3227 * display it. This activity should be part of the e-mail application's
3228 * task, since it is a part of the task the user is involved in. However,
3229 * if the user leaves that task, and later selects the e-mail app from
3230 * home, we may like them to return to the conversation they were
3231 * viewing, not the picture attachment, since that is confusing. By
3232 * setting this flag when launching the image viewer, that viewer and
3233 * any activities it starts will be removed the next time the user returns
3234 * to mail.
3235 */
3236 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003237 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003238 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003239 * callback from occurring on the current frontmost activity before it is
3240 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003241 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003242 * <p>Typically, an activity can rely on that callback to indicate that an
3243 * explicit user action has caused their activity to be moved out of the
3244 * foreground. The callback marks an appropriate point in the activity's
3245 * lifecycle for it to dismiss any notifications that it intends to display
3246 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003247 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003248 * <p>If an activity is ever started via any non-user-driven events such as
3249 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3250 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003251 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003252 */
3253 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003254 /**
3255 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3256 * this flag will cause the launched activity to be brought to the front of its
3257 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003258 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003259 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3260 * If D calls startActivity() with an Intent that resolves to the component
3261 * of activity B, then B will be brought to the front of the history stack,
3262 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003263 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003264 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003265 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003266 */
3267 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003268 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003269 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3270 * this flag will prevent the system from applying an activity transition
3271 * animation to go to the next activity state. This doesn't mean an
3272 * animation will never run -- if another activity change happens that doesn't
3273 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003274 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003275 * when you are going to do a series of activity operations but the
3276 * animation seen by the user shouldn't be driven by the first activity
3277 * change but rather a later one.
3278 */
3279 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3280 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003281 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3282 * this flag will cause any existing task that would be associated with the
3283 * activity to be cleared before the activity is started. That is, the activity
3284 * becomes the new root of an otherwise empty task, and any old activities
3285 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3286 */
3287 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3288 /**
3289 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3290 * this flag will cause a newly launching task to be placed on top of the current
3291 * home activity task (if there is one). That is, pressing back from the task
3292 * will always return the user to home even if that was not the last activity they
3293 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3294 */
3295 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3296 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003297 * If set, when sending a broadcast only registered receivers will be
3298 * called -- no BroadcastReceiver components will be launched.
3299 */
3300 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003301 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003302 * If set, when sending a broadcast the new broadcast will replace
3303 * any existing pending broadcast that matches it. Matching is defined
3304 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3305 * true for the intents of the two broadcasts. When a match is found,
3306 * the new broadcast (and receivers associated with it) will replace the
3307 * existing one in the pending broadcast list, remaining at the same
3308 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003309 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003310 * <p>This flag is most typically used with sticky broadcasts, which
3311 * only care about delivering the most recent values of the broadcast
3312 * to their receivers.
3313 */
3314 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3315 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003316 * If set, when sending a broadcast the recipient is allowed to run at
3317 * foreground priority, with a shorter timeout interval. During normal
3318 * broadcasts the receivers are not automatically hoisted out of the
3319 * background priority class.
3320 */
3321 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3322 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003323 * If set, when sending a broadcast <i>before boot has completed</i> only
3324 * registered receivers will be called -- no BroadcastReceiver components
3325 * will be launched. Sticky intent state will be recorded properly even
3326 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3327 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003328 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003329 * <p>This flag is only for use by system sevices as a convenience to
3330 * avoid having to implement a more complex mechanism around detection
3331 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003332 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003333 * @hide
3334 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003335 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003336 /**
3337 * Set when this broadcast is for a boot upgrade, a special mode that
3338 * allows the broadcast to be sent before the system is ready and launches
3339 * the app process with no providers running in it.
3340 * @hide
3341 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003342 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003343
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003344 /**
3345 * @hide Flags that can't be changed with PendingIntent.
3346 */
3347 public static final int IMMUTABLE_FLAGS =
3348 FLAG_GRANT_READ_URI_PERMISSION
3349 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003350
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003351 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003352 // ---------------------------------------------------------------------
3353 // toUri() and parseUri() options.
3354
3355 /**
3356 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3357 * always has the "intent:" scheme. This syntax can be used when you want
3358 * to later disambiguate between URIs that are intended to describe an
3359 * Intent vs. all others that should be treated as raw URIs. When used
3360 * with {@link #parseUri}, any other scheme will result in a generic
3361 * VIEW action for that raw URI.
3362 */
3363 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003364
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003365 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003366
3367 private String mAction;
3368 private Uri mData;
3369 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003370 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003371 private ComponentName mComponent;
3372 private int mFlags;
3373 private HashSet<String> mCategories;
3374 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003375 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003376 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003377 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003378
3379 // ---------------------------------------------------------------------
3380
3381 /**
3382 * Create an empty intent.
3383 */
3384 public Intent() {
3385 }
3386
3387 /**
3388 * Copy constructor.
3389 */
3390 public Intent(Intent o) {
3391 this.mAction = o.mAction;
3392 this.mData = o.mData;
3393 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003394 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003395 this.mComponent = o.mComponent;
3396 this.mFlags = o.mFlags;
3397 if (o.mCategories != null) {
3398 this.mCategories = new HashSet<String>(o.mCategories);
3399 }
3400 if (o.mExtras != null) {
3401 this.mExtras = new Bundle(o.mExtras);
3402 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003403 if (o.mSourceBounds != null) {
3404 this.mSourceBounds = new Rect(o.mSourceBounds);
3405 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003406 if (o.mSelector != null) {
3407 this.mSelector = new Intent(o.mSelector);
3408 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003409 if (o.mClipData != null) {
3410 this.mClipData = new ClipData(o.mClipData);
3411 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003412 }
3413
3414 @Override
3415 public Object clone() {
3416 return new Intent(this);
3417 }
3418
3419 private Intent(Intent o, boolean all) {
3420 this.mAction = o.mAction;
3421 this.mData = o.mData;
3422 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003423 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003424 this.mComponent = o.mComponent;
3425 if (o.mCategories != null) {
3426 this.mCategories = new HashSet<String>(o.mCategories);
3427 }
3428 }
3429
3430 /**
3431 * Make a clone of only the parts of the Intent that are relevant for
3432 * filter matching: the action, data, type, component, and categories.
3433 */
3434 public Intent cloneFilter() {
3435 return new Intent(this, false);
3436 }
3437
3438 /**
3439 * Create an intent with a given action. All other fields (data, type,
3440 * class) are null. Note that the action <em>must</em> be in a
3441 * namespace because Intents are used globally in the system -- for
3442 * example the system VIEW action is android.intent.action.VIEW; an
3443 * application's custom action would be something like
3444 * com.google.app.myapp.CUSTOM_ACTION.
3445 *
3446 * @param action The Intent action, such as ACTION_VIEW.
3447 */
3448 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003449 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003450 }
3451
3452 /**
3453 * Create an intent with a given action and for a given data url. Note
3454 * that the action <em>must</em> be in a namespace because Intents are
3455 * used globally in the system -- for example the system VIEW action is
3456 * android.intent.action.VIEW; an application's custom action would be
3457 * something like com.google.app.myapp.CUSTOM_ACTION.
3458 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003459 * <p><em>Note: scheme and host name matching in the Android framework is
3460 * case-sensitive, unlike the formal RFC. As a result,
3461 * you should always ensure that you write your Uri with these elements
3462 * using lower case letters, and normalize any Uris you receive from
3463 * outside of Android to ensure the scheme and host is lower case.</em></p>
3464 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003465 * @param action The Intent action, such as ACTION_VIEW.
3466 * @param uri The Intent data URI.
3467 */
3468 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003469 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003470 mData = uri;
3471 }
3472
3473 /**
3474 * Create an intent for a specific component. All other fields (action, data,
3475 * type, class) are null, though they can be modified later with explicit
3476 * calls. This provides a convenient way to create an intent that is
3477 * intended to execute a hard-coded class name, rather than relying on the
3478 * system to find an appropriate class for you; see {@link #setComponent}
3479 * for more information on the repercussions of this.
3480 *
3481 * @param packageContext A Context of the application package implementing
3482 * this class.
3483 * @param cls The component class that is to be used for the intent.
3484 *
3485 * @see #setClass
3486 * @see #setComponent
3487 * @see #Intent(String, android.net.Uri , Context, Class)
3488 */
3489 public Intent(Context packageContext, Class<?> cls) {
3490 mComponent = new ComponentName(packageContext, cls);
3491 }
3492
3493 /**
3494 * Create an intent for a specific component with a specified action and data.
3495 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3496 * construct the Intent and then calling {@link #setClass} to set its
3497 * class.
3498 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003499 * <p><em>Note: scheme and host name matching in the Android framework is
3500 * case-sensitive, unlike the formal RFC. As a result,
3501 * you should always ensure that you write your Uri with these elements
3502 * using lower case letters, and normalize any Uris you receive from
3503 * outside of Android to ensure the scheme and host is lower case.</em></p>
3504 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003505 * @param action The Intent action, such as ACTION_VIEW.
3506 * @param uri The Intent data URI.
3507 * @param packageContext A Context of the application package implementing
3508 * this class.
3509 * @param cls The component class that is to be used for the intent.
3510 *
3511 * @see #Intent(String, android.net.Uri)
3512 * @see #Intent(Context, Class)
3513 * @see #setClass
3514 * @see #setComponent
3515 */
3516 public Intent(String action, Uri uri,
3517 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003518 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003519 mData = uri;
3520 mComponent = new ComponentName(packageContext, cls);
3521 }
3522
3523 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003524 * Create an intent to launch the main (root) activity of a task. This
3525 * is the Intent that is started when the application's is launched from
3526 * Home. For anything else that wants to launch an application in the
3527 * same way, it is important that they use an Intent structured the same
3528 * way, and can use this function to ensure this is the case.
3529 *
3530 * <p>The returned Intent has the given Activity component as its explicit
3531 * component, {@link #ACTION_MAIN} as its action, and includes the
3532 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3533 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3534 * to do that through {@link #addFlags(int)} on the returned Intent.
3535 *
3536 * @param mainActivity The main activity component that this Intent will
3537 * launch.
3538 * @return Returns a newly created Intent that can be used to launch the
3539 * activity as a main application entry.
3540 *
3541 * @see #setClass
3542 * @see #setComponent
3543 */
3544 public static Intent makeMainActivity(ComponentName mainActivity) {
3545 Intent intent = new Intent(ACTION_MAIN);
3546 intent.setComponent(mainActivity);
3547 intent.addCategory(CATEGORY_LAUNCHER);
3548 return intent;
3549 }
3550
3551 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003552 * Make an Intent for the main activity of an application, without
3553 * specifying a specific activity to run but giving a selector to find
3554 * the activity. This results in a final Intent that is structured
3555 * the same as when the application is launched from
3556 * Home. For anything else that wants to launch an application in the
3557 * same way, it is important that they use an Intent structured the same
3558 * way, and can use this function to ensure this is the case.
3559 *
3560 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3561 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3562 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3563 * to do that through {@link #addFlags(int)} on the returned Intent.
3564 *
3565 * @param selectorAction The action name of the Intent's selector.
3566 * @param selectorCategory The name of a category to add to the Intent's
3567 * selector.
3568 * @return Returns a newly created Intent that can be used to launch the
3569 * activity as a main application entry.
3570 *
3571 * @see #setSelector(Intent)
3572 */
3573 public static Intent makeMainSelectorActivity(String selectorAction,
3574 String selectorCategory) {
3575 Intent intent = new Intent(ACTION_MAIN);
3576 intent.addCategory(CATEGORY_LAUNCHER);
3577 Intent selector = new Intent();
3578 selector.setAction(selectorAction);
3579 selector.addCategory(selectorCategory);
3580 intent.setSelector(selector);
3581 return intent;
3582 }
3583
3584 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003585 * Make an Intent that can be used to re-launch an application's task
3586 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3587 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3588 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3589 *
3590 * @param mainActivity The activity component that is the root of the
3591 * task; this is the activity that has been published in the application's
3592 * manifest as the main launcher icon.
3593 *
3594 * @return Returns a newly created Intent that can be used to relaunch the
3595 * activity's task in its root state.
3596 */
3597 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3598 Intent intent = makeMainActivity(mainActivity);
3599 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3600 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3601 return intent;
3602 }
3603
3604 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003605 * Call {@link #parseUri} with 0 flags.
3606 * @deprecated Use {@link #parseUri} instead.
3607 */
3608 @Deprecated
3609 public static Intent getIntent(String uri) throws URISyntaxException {
3610 return parseUri(uri, 0);
3611 }
Tom Taylord4a47292009-12-21 13:59:18 -08003612
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003613 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003614 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003615 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003616 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003617 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003618 *
3619 * <p>The URI given here must not be relative -- that is, it must include
3620 * the scheme and full path.
3621 *
3622 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003623 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003624 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003625 *
3626 * @return Intent The newly created Intent object.
3627 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003628 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3629 * it bad (as parsed by the Uri class) or the Intent data within the
3630 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003631 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003632 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003633 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003634 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003635 int i = 0;
3636 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003637 // Validate intent scheme for if requested.
3638 if ((flags&URI_INTENT_SCHEME) != 0) {
3639 if (!uri.startsWith("intent:")) {
3640 Intent intent = new Intent(ACTION_VIEW);
3641 try {
3642 intent.setData(Uri.parse(uri));
3643 } catch (IllegalArgumentException e) {
3644 throw new URISyntaxException(uri, e.getMessage());
3645 }
3646 return intent;
3647 }
3648 }
Tom Taylord4a47292009-12-21 13:59:18 -08003649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003650 // simple case
3651 i = uri.lastIndexOf("#");
3652 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3653
3654 // old format Intent URI
3655 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003656
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003657 // new format
3658 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003659 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003660
3661 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003662 String data = i >= 0 ? uri.substring(0, i) : null;
3663 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003664 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003665
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003666 // loop over contents of Intent, all name=value;
3667 while (!uri.startsWith("end", i)) {
3668 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003669 if (eq < 0) eq = i-1;
3670 int semi = uri.indexOf(';', i);
3671 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003672
3673 // action
3674 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003675 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003676 }
3677
3678 // categories
3679 else if (uri.startsWith("category=", i)) {
3680 intent.addCategory(value);
3681 }
3682
3683 // type
3684 else if (uri.startsWith("type=", i)) {
3685 intent.mType = value;
3686 }
3687
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003688 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003689 else if (uri.startsWith("launchFlags=", i)) {
3690 intent.mFlags = Integer.decode(value).intValue();
3691 }
3692
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003693 // package
3694 else if (uri.startsWith("package=", i)) {
3695 intent.mPackage = value;
3696 }
3697
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003698 // component
3699 else if (uri.startsWith("component=", i)) {
3700 intent.mComponent = ComponentName.unflattenFromString(value);
3701 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003702
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003703 // scheme
3704 else if (uri.startsWith("scheme=", i)) {
3705 scheme = value;
3706 }
3707
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003708 // source bounds
3709 else if (uri.startsWith("sourceBounds=", i)) {
3710 intent.mSourceBounds = Rect.unflattenFromString(value);
3711 }
3712
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003713 // selector
3714 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3715 intent = new Intent();
3716 }
3717
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003718 // extra
3719 else {
3720 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003721 // create Bundle if it doesn't already exist
3722 if (intent.mExtras == null) intent.mExtras = new Bundle();
3723 Bundle b = intent.mExtras;
3724 // add EXTRA
3725 if (uri.startsWith("S.", i)) b.putString(key, value);
3726 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3727 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3728 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3729 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3730 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3731 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3732 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3733 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3734 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3735 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003736
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003737 // move to the next item
3738 i = semi + 1;
3739 }
3740
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003741 if (intent != baseIntent) {
3742 // The Intent had a selector; fix it up.
3743 baseIntent.setSelector(intent);
3744 intent = baseIntent;
3745 }
3746
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003747 if (data != null) {
3748 if (data.startsWith("intent:")) {
3749 data = data.substring(7);
3750 if (scheme != null) {
3751 data = scheme + ':' + data;
3752 }
3753 }
Tom Taylord4a47292009-12-21 13:59:18 -08003754
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003755 if (data.length() > 0) {
3756 try {
3757 intent.mData = Uri.parse(data);
3758 } catch (IllegalArgumentException e) {
3759 throw new URISyntaxException(uri, e.getMessage());
3760 }
3761 }
3762 }
Tom Taylord4a47292009-12-21 13:59:18 -08003763
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003764 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003765
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003766 } catch (IndexOutOfBoundsException e) {
3767 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3768 }
3769 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003770
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003771 public static Intent getIntentOld(String uri) throws URISyntaxException {
3772 Intent intent;
3773
3774 int i = uri.lastIndexOf('#');
3775 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003776 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003777 final int intentFragmentStart = i;
3778 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003779
3780 i++;
3781
3782 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003783 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003784 i += 7;
3785 int j = uri.indexOf(')', i);
3786 action = uri.substring(i, j);
3787 i = j + 1;
3788 }
3789
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003790 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003791
3792 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003793 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003794 i += 11;
3795 int j = uri.indexOf(')', i);
3796 while (i < j) {
3797 int sep = uri.indexOf('!', i);
3798 if (sep < 0) sep = j;
3799 if (i < sep) {
3800 intent.addCategory(uri.substring(i, sep));
3801 }
3802 i = sep + 1;
3803 }
3804 i = j + 1;
3805 }
3806
3807 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003808 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003809 i += 5;
3810 int j = uri.indexOf(')', i);
3811 intent.mType = uri.substring(i, j);
3812 i = j + 1;
3813 }
3814
3815 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003816 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003817 i += 12;
3818 int j = uri.indexOf(')', i);
3819 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3820 i = j + 1;
3821 }
3822
3823 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003824 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825 i += 10;
3826 int j = uri.indexOf(')', i);
3827 int sep = uri.indexOf('!', i);
3828 if (sep >= 0 && sep < j) {
3829 String pkg = uri.substring(i, sep);
3830 String cls = uri.substring(sep + 1, j);
3831 intent.mComponent = new ComponentName(pkg, cls);
3832 }
3833 i = j + 1;
3834 }
3835
3836 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003837 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003838 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003839
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003840 final int closeParen = uri.indexOf(')', i);
3841 if (closeParen == -1) throw new URISyntaxException(uri,
3842 "EXTRA missing trailing ')'", i);
3843
3844 while (i < closeParen) {
3845 // fetch the key value
3846 int j = uri.indexOf('=', i);
3847 if (j <= i + 1 || i >= closeParen) {
3848 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3849 }
3850 char type = uri.charAt(i);
3851 i++;
3852 String key = uri.substring(i, j);
3853 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003854
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003855 // get type-value
3856 j = uri.indexOf('!', i);
3857 if (j == -1 || j >= closeParen) j = closeParen;
3858 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3859 String value = uri.substring(i, j);
3860 i = j;
3861
3862 // create Bundle if it doesn't already exist
3863 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003864
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003865 // add item to bundle
3866 try {
3867 switch (type) {
3868 case 'S':
3869 intent.mExtras.putString(key, Uri.decode(value));
3870 break;
3871 case 'B':
3872 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3873 break;
3874 case 'b':
3875 intent.mExtras.putByte(key, Byte.parseByte(value));
3876 break;
3877 case 'c':
3878 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3879 break;
3880 case 'd':
3881 intent.mExtras.putDouble(key, Double.parseDouble(value));
3882 break;
3883 case 'f':
3884 intent.mExtras.putFloat(key, Float.parseFloat(value));
3885 break;
3886 case 'i':
3887 intent.mExtras.putInt(key, Integer.parseInt(value));
3888 break;
3889 case 'l':
3890 intent.mExtras.putLong(key, Long.parseLong(value));
3891 break;
3892 case 's':
3893 intent.mExtras.putShort(key, Short.parseShort(value));
3894 break;
3895 default:
3896 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3897 }
3898 } catch (NumberFormatException e) {
3899 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3900 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003901
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003902 char ch = uri.charAt(i);
3903 if (ch == ')') break;
3904 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3905 i++;
3906 }
3907 }
3908
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003909 if (isIntentFragment) {
3910 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3911 } else {
3912 intent.mData = Uri.parse(uri);
3913 }
Tom Taylord4a47292009-12-21 13:59:18 -08003914
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003915 if (intent.mAction == null) {
3916 // By default, if no action is specified, then use VIEW.
3917 intent.mAction = ACTION_VIEW;
3918 }
3919
3920 } else {
3921 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3922 }
3923
3924 return intent;
3925 }
3926
3927 /**
3928 * Retrieve the general action to be performed, such as
3929 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3930 * the information in the intent should be interpreted -- most importantly,
3931 * what to do with the data returned by {@link #getData}.
3932 *
3933 * @return The action of this intent or null if none is specified.
3934 *
3935 * @see #setAction
3936 */
3937 public String getAction() {
3938 return mAction;
3939 }
3940
3941 /**
3942 * Retrieve data this intent is operating on. This URI specifies the name
3943 * of the data; often it uses the content: scheme, specifying data in a
3944 * content provider. Other schemes may be handled by specific activities,
3945 * such as http: by the web browser.
3946 *
3947 * @return The URI of the data this intent is targeting or null.
3948 *
3949 * @see #getScheme
3950 * @see #setData
3951 */
3952 public Uri getData() {
3953 return mData;
3954 }
3955
3956 /**
3957 * The same as {@link #getData()}, but returns the URI as an encoded
3958 * String.
3959 */
3960 public String getDataString() {
3961 return mData != null ? mData.toString() : null;
3962 }
3963
3964 /**
3965 * Return the scheme portion of the intent's data. If the data is null or
3966 * does not include a scheme, null is returned. Otherwise, the scheme
3967 * prefix without the final ':' is returned, i.e. "http".
3968 *
3969 * <p>This is the same as calling getData().getScheme() (and checking for
3970 * null data).
3971 *
3972 * @return The scheme of this intent.
3973 *
3974 * @see #getData
3975 */
3976 public String getScheme() {
3977 return mData != null ? mData.getScheme() : null;
3978 }
3979
3980 /**
3981 * Retrieve any explicit MIME type included in the intent. This is usually
3982 * null, as the type is determined by the intent data.
3983 *
3984 * @return If a type was manually set, it is returned; else null is
3985 * returned.
3986 *
3987 * @see #resolveType(ContentResolver)
3988 * @see #setType
3989 */
3990 public String getType() {
3991 return mType;
3992 }
3993
3994 /**
3995 * Return the MIME data type of this intent. If the type field is
3996 * explicitly set, that is simply returned. Otherwise, if the data is set,
3997 * the type of that data is returned. If neither fields are set, a null is
3998 * returned.
3999 *
4000 * @return The MIME type of this intent.
4001 *
4002 * @see #getType
4003 * @see #resolveType(ContentResolver)
4004 */
4005 public String resolveType(Context context) {
4006 return resolveType(context.getContentResolver());
4007 }
4008
4009 /**
4010 * Return the MIME data type of this intent. If the type field is
4011 * explicitly set, that is simply returned. Otherwise, if the data is set,
4012 * the type of that data is returned. If neither fields are set, a null is
4013 * returned.
4014 *
4015 * @param resolver A ContentResolver that can be used to determine the MIME
4016 * type of the intent's data.
4017 *
4018 * @return The MIME type of this intent.
4019 *
4020 * @see #getType
4021 * @see #resolveType(Context)
4022 */
4023 public String resolveType(ContentResolver resolver) {
4024 if (mType != null) {
4025 return mType;
4026 }
4027 if (mData != null) {
4028 if ("content".equals(mData.getScheme())) {
4029 return resolver.getType(mData);
4030 }
4031 }
4032 return null;
4033 }
4034
4035 /**
4036 * Return the MIME data type of this intent, only if it will be needed for
4037 * intent resolution. This is not generally useful for application code;
4038 * it is used by the frameworks for communicating with back-end system
4039 * services.
4040 *
4041 * @param resolver A ContentResolver that can be used to determine the MIME
4042 * type of the intent's data.
4043 *
4044 * @return The MIME type of this intent, or null if it is unknown or not
4045 * needed.
4046 */
4047 public String resolveTypeIfNeeded(ContentResolver resolver) {
4048 if (mComponent != null) {
4049 return mType;
4050 }
4051 return resolveType(resolver);
4052 }
4053
4054 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004055 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004056 *
4057 * @param category The category to check.
4058 *
4059 * @return boolean True if the intent contains the category, else false.
4060 *
4061 * @see #getCategories
4062 * @see #addCategory
4063 */
4064 public boolean hasCategory(String category) {
4065 return mCategories != null && mCategories.contains(category);
4066 }
4067
4068 /**
4069 * Return the set of all categories in the intent. If there are no categories,
4070 * returns NULL.
4071 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004072 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004073 *
4074 * @see #hasCategory
4075 * @see #addCategory
4076 */
4077 public Set<String> getCategories() {
4078 return mCategories;
4079 }
4080
4081 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004082 * Return the specific selector associated with this Intent. If there is
4083 * none, returns null. See {@link #setSelector} for more information.
4084 *
4085 * @see #setSelector
4086 */
4087 public Intent getSelector() {
4088 return mSelector;
4089 }
4090
4091 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004092 * Return the {@link ClipData} associated with this Intent. If there is
4093 * none, returns null. See {@link #setClipData} for more information.
4094 *
4095 * @see #setClipData;
4096 */
4097 public ClipData getClipData() {
4098 return mClipData;
4099 }
4100
4101 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004102 * Sets the ClassLoader that will be used when unmarshalling
4103 * any Parcelable values from the extras of this Intent.
4104 *
4105 * @param loader a ClassLoader, or null to use the default loader
4106 * at the time of unmarshalling.
4107 */
4108 public void setExtrasClassLoader(ClassLoader loader) {
4109 if (mExtras != null) {
4110 mExtras.setClassLoader(loader);
4111 }
4112 }
4113
4114 /**
4115 * Returns true if an extra value is associated with the given name.
4116 * @param name the extra's name
4117 * @return true if the given extra is present.
4118 */
4119 public boolean hasExtra(String name) {
4120 return mExtras != null && mExtras.containsKey(name);
4121 }
4122
4123 /**
4124 * Returns true if the Intent's extras contain a parcelled file descriptor.
4125 * @return true if the Intent contains a parcelled file descriptor.
4126 */
4127 public boolean hasFileDescriptors() {
4128 return mExtras != null && mExtras.hasFileDescriptors();
4129 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004130
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004131 /** @hide */
4132 public void setAllowFds(boolean allowFds) {
4133 if (mExtras != null) {
4134 mExtras.setAllowFds(allowFds);
4135 }
4136 }
4137
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004138 /**
4139 * Retrieve extended data from the intent.
4140 *
4141 * @param name The name of the desired item.
4142 *
4143 * @return the value of an item that previously added with putExtra()
4144 * or null if none was found.
4145 *
4146 * @deprecated
4147 * @hide
4148 */
4149 @Deprecated
4150 public Object getExtra(String name) {
4151 return getExtra(name, null);
4152 }
4153
4154 /**
4155 * Retrieve extended data from the intent.
4156 *
4157 * @param name The name of the desired item.
4158 * @param defaultValue the value to be returned if no value of the desired
4159 * type is stored with the given name.
4160 *
4161 * @return the value of an item that previously added with putExtra()
4162 * or the default value if none was found.
4163 *
4164 * @see #putExtra(String, boolean)
4165 */
4166 public boolean getBooleanExtra(String name, boolean defaultValue) {
4167 return mExtras == null ? defaultValue :
4168 mExtras.getBoolean(name, defaultValue);
4169 }
4170
4171 /**
4172 * Retrieve extended data from the intent.
4173 *
4174 * @param name The name of the desired item.
4175 * @param defaultValue the value to be returned if no value of the desired
4176 * type is stored with the given name.
4177 *
4178 * @return the value of an item that previously added with putExtra()
4179 * or the default value if none was found.
4180 *
4181 * @see #putExtra(String, byte)
4182 */
4183 public byte getByteExtra(String name, byte defaultValue) {
4184 return mExtras == null ? defaultValue :
4185 mExtras.getByte(name, defaultValue);
4186 }
4187
4188 /**
4189 * Retrieve extended data from the intent.
4190 *
4191 * @param name The name of the desired item.
4192 * @param defaultValue the value to be returned if no value of the desired
4193 * type is stored with the given name.
4194 *
4195 * @return the value of an item that previously added with putExtra()
4196 * or the default value if none was found.
4197 *
4198 * @see #putExtra(String, short)
4199 */
4200 public short getShortExtra(String name, short defaultValue) {
4201 return mExtras == null ? defaultValue :
4202 mExtras.getShort(name, defaultValue);
4203 }
4204
4205 /**
4206 * Retrieve extended data from the intent.
4207 *
4208 * @param name The name of the desired item.
4209 * @param defaultValue the value to be returned if no value of the desired
4210 * type is stored with the given name.
4211 *
4212 * @return the value of an item that previously added with putExtra()
4213 * or the default value if none was found.
4214 *
4215 * @see #putExtra(String, char)
4216 */
4217 public char getCharExtra(String name, char defaultValue) {
4218 return mExtras == null ? defaultValue :
4219 mExtras.getChar(name, defaultValue);
4220 }
4221
4222 /**
4223 * Retrieve extended data from the intent.
4224 *
4225 * @param name The name of the desired item.
4226 * @param defaultValue the value to be returned if no value of the desired
4227 * type is stored with the given name.
4228 *
4229 * @return the value of an item that previously added with putExtra()
4230 * or the default value if none was found.
4231 *
4232 * @see #putExtra(String, int)
4233 */
4234 public int getIntExtra(String name, int defaultValue) {
4235 return mExtras == null ? defaultValue :
4236 mExtras.getInt(name, defaultValue);
4237 }
4238
4239 /**
4240 * Retrieve extended data from the intent.
4241 *
4242 * @param name The name of the desired item.
4243 * @param defaultValue the value to be returned if no value of the desired
4244 * type is stored with the given name.
4245 *
4246 * @return the value of an item that previously added with putExtra()
4247 * or the default value if none was found.
4248 *
4249 * @see #putExtra(String, long)
4250 */
4251 public long getLongExtra(String name, long defaultValue) {
4252 return mExtras == null ? defaultValue :
4253 mExtras.getLong(name, defaultValue);
4254 }
4255
4256 /**
4257 * Retrieve extended data from the intent.
4258 *
4259 * @param name The name of the desired item.
4260 * @param defaultValue the value to be returned if no value of the desired
4261 * type is stored with the given name.
4262 *
4263 * @return the value of an item that previously added with putExtra(),
4264 * or the default value if no such item is present
4265 *
4266 * @see #putExtra(String, float)
4267 */
4268 public float getFloatExtra(String name, float defaultValue) {
4269 return mExtras == null ? defaultValue :
4270 mExtras.getFloat(name, defaultValue);
4271 }
4272
4273 /**
4274 * Retrieve extended data from the intent.
4275 *
4276 * @param name The name of the desired item.
4277 * @param defaultValue the value to be returned if no value of the desired
4278 * type is stored with the given name.
4279 *
4280 * @return the value of an item that previously added with putExtra()
4281 * or the default value if none was found.
4282 *
4283 * @see #putExtra(String, double)
4284 */
4285 public double getDoubleExtra(String name, double defaultValue) {
4286 return mExtras == null ? defaultValue :
4287 mExtras.getDouble(name, defaultValue);
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 String value was found.
4297 *
4298 * @see #putExtra(String, String)
4299 */
4300 public String getStringExtra(String name) {
4301 return mExtras == null ? null : mExtras.getString(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 CharSequence value was found.
4311 *
4312 * @see #putExtra(String, CharSequence)
4313 */
4314 public CharSequence getCharSequenceExtra(String name) {
4315 return mExtras == null ? null : mExtras.getCharSequence(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 Parcelable value was found.
4325 *
4326 * @see #putExtra(String, Parcelable)
4327 */
4328 public <T extends Parcelable> T getParcelableExtra(String name) {
4329 return mExtras == null ? null : mExtras.<T>getParcelable(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 Parcelable[] value was found.
4339 *
4340 * @see #putExtra(String, Parcelable[])
4341 */
4342 public Parcelable[] getParcelableArrayExtra(String name) {
4343 return mExtras == null ? null : mExtras.getParcelableArray(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 ArrayList<Parcelable> value was found.
4353 *
4354 * @see #putParcelableArrayListExtra(String, ArrayList)
4355 */
4356 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4357 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(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 Serializable value was found.
4367 *
4368 * @see #putExtra(String, Serializable)
4369 */
4370 public Serializable getSerializableExtra(String name) {
4371 return mExtras == null ? null : mExtras.getSerializable(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 ArrayList<Integer> value was found.
4381 *
4382 * @see #putIntegerArrayListExtra(String, ArrayList)
4383 */
4384 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4385 return mExtras == null ? null : mExtras.getIntegerArrayList(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()
4394 * or null if no ArrayList<String> value was found.
4395 *
4396 * @see #putStringArrayListExtra(String, ArrayList)
4397 */
4398 public ArrayList<String> getStringArrayListExtra(String name) {
4399 return mExtras == null ? null : mExtras.getStringArrayList(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()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004408 * or null if no ArrayList<CharSequence> value was found.
4409 *
4410 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4411 */
4412 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4413 return mExtras == null ? null : mExtras.getCharSequenceArrayList(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()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004422 * or null if no boolean array value was found.
4423 *
4424 * @see #putExtra(String, boolean[])
4425 */
4426 public boolean[] getBooleanArrayExtra(String name) {
4427 return mExtras == null ? null : mExtras.getBooleanArray(name);
4428 }
4429
4430 /**
4431 * Retrieve extended data from the intent.
4432 *
4433 * @param name The name of the desired item.
4434 *
4435 * @return the value of an item that previously added with putExtra()
4436 * or null if no byte array value was found.
4437 *
4438 * @see #putExtra(String, byte[])
4439 */
4440 public byte[] getByteArrayExtra(String name) {
4441 return mExtras == null ? null : mExtras.getByteArray(name);
4442 }
4443
4444 /**
4445 * Retrieve extended data from the intent.
4446 *
4447 * @param name The name of the desired item.
4448 *
4449 * @return the value of an item that previously added with putExtra()
4450 * or null if no short array value was found.
4451 *
4452 * @see #putExtra(String, short[])
4453 */
4454 public short[] getShortArrayExtra(String name) {
4455 return mExtras == null ? null : mExtras.getShortArray(name);
4456 }
4457
4458 /**
4459 * Retrieve extended data from the intent.
4460 *
4461 * @param name The name of the desired item.
4462 *
4463 * @return the value of an item that previously added with putExtra()
4464 * or null if no char array value was found.
4465 *
4466 * @see #putExtra(String, char[])
4467 */
4468 public char[] getCharArrayExtra(String name) {
4469 return mExtras == null ? null : mExtras.getCharArray(name);
4470 }
4471
4472 /**
4473 * Retrieve extended data from the intent.
4474 *
4475 * @param name The name of the desired item.
4476 *
4477 * @return the value of an item that previously added with putExtra()
4478 * or null if no int array value was found.
4479 *
4480 * @see #putExtra(String, int[])
4481 */
4482 public int[] getIntArrayExtra(String name) {
4483 return mExtras == null ? null : mExtras.getIntArray(name);
4484 }
4485
4486 /**
4487 * Retrieve extended data from the intent.
4488 *
4489 * @param name The name of the desired item.
4490 *
4491 * @return the value of an item that previously added with putExtra()
4492 * or null if no long array value was found.
4493 *
4494 * @see #putExtra(String, long[])
4495 */
4496 public long[] getLongArrayExtra(String name) {
4497 return mExtras == null ? null : mExtras.getLongArray(name);
4498 }
4499
4500 /**
4501 * Retrieve extended data from the intent.
4502 *
4503 * @param name The name of the desired item.
4504 *
4505 * @return the value of an item that previously added with putExtra()
4506 * or null if no float array value was found.
4507 *
4508 * @see #putExtra(String, float[])
4509 */
4510 public float[] getFloatArrayExtra(String name) {
4511 return mExtras == null ? null : mExtras.getFloatArray(name);
4512 }
4513
4514 /**
4515 * Retrieve extended data from the intent.
4516 *
4517 * @param name The name of the desired item.
4518 *
4519 * @return the value of an item that previously added with putExtra()
4520 * or null if no double array value was found.
4521 *
4522 * @see #putExtra(String, double[])
4523 */
4524 public double[] getDoubleArrayExtra(String name) {
4525 return mExtras == null ? null : mExtras.getDoubleArray(name);
4526 }
4527
4528 /**
4529 * Retrieve extended data from the intent.
4530 *
4531 * @param name The name of the desired item.
4532 *
4533 * @return the value of an item that previously added with putExtra()
4534 * or null if no String array value was found.
4535 *
4536 * @see #putExtra(String, String[])
4537 */
4538 public String[] getStringArrayExtra(String name) {
4539 return mExtras == null ? null : mExtras.getStringArray(name);
4540 }
4541
4542 /**
4543 * Retrieve extended data from the intent.
4544 *
4545 * @param name The name of the desired item.
4546 *
4547 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004548 * or null if no CharSequence array value was found.
4549 *
4550 * @see #putExtra(String, CharSequence[])
4551 */
4552 public CharSequence[] getCharSequenceArrayExtra(String name) {
4553 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4554 }
4555
4556 /**
4557 * Retrieve extended data from the intent.
4558 *
4559 * @param name The name of the desired item.
4560 *
4561 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004562 * or null if no Bundle value was found.
4563 *
4564 * @see #putExtra(String, Bundle)
4565 */
4566 public Bundle getBundleExtra(String name) {
4567 return mExtras == null ? null : mExtras.getBundle(name);
4568 }
4569
4570 /**
4571 * Retrieve extended data from the intent.
4572 *
4573 * @param name The name of the desired item.
4574 *
4575 * @return the value of an item that previously added with putExtra()
4576 * or null if no IBinder value was found.
4577 *
4578 * @see #putExtra(String, IBinder)
4579 *
4580 * @deprecated
4581 * @hide
4582 */
4583 @Deprecated
4584 public IBinder getIBinderExtra(String name) {
4585 return mExtras == null ? null : mExtras.getIBinder(name);
4586 }
4587
4588 /**
4589 * Retrieve extended data from the intent.
4590 *
4591 * @param name The name of the desired item.
4592 * @param defaultValue The default value to return in case no item is
4593 * associated with the key 'name'
4594 *
4595 * @return the value of an item that previously added with putExtra()
4596 * or defaultValue if none was found.
4597 *
4598 * @see #putExtra
4599 *
4600 * @deprecated
4601 * @hide
4602 */
4603 @Deprecated
4604 public Object getExtra(String name, Object defaultValue) {
4605 Object result = defaultValue;
4606 if (mExtras != null) {
4607 Object result2 = mExtras.get(name);
4608 if (result2 != null) {
4609 result = result2;
4610 }
4611 }
4612
4613 return result;
4614 }
4615
4616 /**
4617 * Retrieves a map of extended data from the intent.
4618 *
4619 * @return the map of all extras previously added with putExtra(),
4620 * or null if none have been added.
4621 */
4622 public Bundle getExtras() {
4623 return (mExtras != null)
4624 ? new Bundle(mExtras)
4625 : null;
4626 }
4627
4628 /**
4629 * Retrieve any special flags associated with this intent. You will
4630 * normally just set them with {@link #setFlags} and let the system
4631 * take the appropriate action with them.
4632 *
4633 * @return int The currently set flags.
4634 *
4635 * @see #setFlags
4636 */
4637 public int getFlags() {
4638 return mFlags;
4639 }
4640
Dianne Hackborne7f97212011-02-24 14:40:20 -08004641 /** @hide */
4642 public boolean isExcludingStopped() {
4643 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4644 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4645 }
4646
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004647 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004648 * Retrieve the application package name this Intent is limited to. When
4649 * resolving an Intent, if non-null this limits the resolution to only
4650 * components in the given application package.
4651 *
4652 * @return The name of the application package for the Intent.
4653 *
4654 * @see #resolveActivity
4655 * @see #setPackage
4656 */
4657 public String getPackage() {
4658 return mPackage;
4659 }
4660
4661 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004662 * Retrieve the concrete component associated with the intent. When receiving
4663 * an intent, this is the component that was found to best handle it (that is,
4664 * yourself) and will always be non-null; in all other cases it will be
4665 * null unless explicitly set.
4666 *
4667 * @return The name of the application component to handle the intent.
4668 *
4669 * @see #resolveActivity
4670 * @see #setComponent
4671 */
4672 public ComponentName getComponent() {
4673 return mComponent;
4674 }
4675
4676 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004677 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4678 * used as a hint to the receiver for animations and the like. Null means that there
4679 * is no source bounds.
4680 */
4681 public Rect getSourceBounds() {
4682 return mSourceBounds;
4683 }
4684
4685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004686 * Return the Activity component that should be used to handle this intent.
4687 * The appropriate component is determined based on the information in the
4688 * intent, evaluated as follows:
4689 *
4690 * <p>If {@link #getComponent} returns an explicit class, that is returned
4691 * without any further consideration.
4692 *
4693 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4694 * category to be considered.
4695 *
4696 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4697 * action.
4698 *
4699 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4700 * this type.
4701 *
4702 * <p>If {@link #addCategory} has added any categories, the activity must
4703 * handle ALL of the categories specified.
4704 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004705 * <p>If {@link #getPackage} is non-NULL, only activity components in
4706 * that application package will be considered.
4707 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004708 * <p>If there are no activities that satisfy all of these conditions, a
4709 * null string is returned.
4710 *
4711 * <p>If multiple activities are found to satisfy the intent, the one with
4712 * the highest priority will be used. If there are multiple activities
4713 * with the same priority, the system will either pick the best activity
4714 * based on user preference, or resolve to a system class that will allow
4715 * the user to pick an activity and forward from there.
4716 *
4717 * <p>This method is implemented simply by calling
4718 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4719 * true.</p>
4720 * <p> This API is called for you as part of starting an activity from an
4721 * intent. You do not normally need to call it yourself.</p>
4722 *
4723 * @param pm The package manager with which to resolve the Intent.
4724 *
4725 * @return Name of the component implementing an activity that can
4726 * display the intent.
4727 *
4728 * @see #setComponent
4729 * @see #getComponent
4730 * @see #resolveActivityInfo
4731 */
4732 public ComponentName resolveActivity(PackageManager pm) {
4733 if (mComponent != null) {
4734 return mComponent;
4735 }
4736
4737 ResolveInfo info = pm.resolveActivity(
4738 this, PackageManager.MATCH_DEFAULT_ONLY);
4739 if (info != null) {
4740 return new ComponentName(
4741 info.activityInfo.applicationInfo.packageName,
4742 info.activityInfo.name);
4743 }
4744
4745 return null;
4746 }
4747
4748 /**
4749 * Resolve the Intent into an {@link ActivityInfo}
4750 * describing the activity that should execute the intent. Resolution
4751 * follows the same rules as described for {@link #resolveActivity}, but
4752 * you get back the completely information about the resolved activity
4753 * instead of just its class name.
4754 *
4755 * @param pm The package manager with which to resolve the Intent.
4756 * @param flags Addition information to retrieve as per
4757 * {@link PackageManager#getActivityInfo(ComponentName, int)
4758 * PackageManager.getActivityInfo()}.
4759 *
4760 * @return PackageManager.ActivityInfo
4761 *
4762 * @see #resolveActivity
4763 */
4764 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4765 ActivityInfo ai = null;
4766 if (mComponent != null) {
4767 try {
4768 ai = pm.getActivityInfo(mComponent, flags);
4769 } catch (PackageManager.NameNotFoundException e) {
4770 // ignore
4771 }
4772 } else {
4773 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004774 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004775 if (info != null) {
4776 ai = info.activityInfo;
4777 }
4778 }
4779
4780 return ai;
4781 }
4782
4783 /**
4784 * Set the general action to be performed.
4785 *
4786 * @param action An action name, such as ACTION_VIEW. Application-specific
4787 * actions should be prefixed with the vendor's package name.
4788 *
4789 * @return Returns the same Intent object, for chaining multiple calls
4790 * into a single statement.
4791 *
4792 * @see #getAction
4793 */
4794 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004795 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004796 return this;
4797 }
4798
4799 /**
4800 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004801 * clears any type that was previously set by {@link #setType} or
4802 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004803 *
Nick Pellyccae4122012-01-09 14:12:58 -08004804 * <p><em>Note: scheme matching in the Android framework is
4805 * case-sensitive, unlike the formal RFC. As a result,
4806 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004807 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004808 * {@link #setDataAndNormalize}
4809 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004810 *
Nick Pellyccae4122012-01-09 14:12:58 -08004811 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004812 *
4813 * @return Returns the same Intent object, for chaining multiple calls
4814 * into a single statement.
4815 *
4816 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004817 * @see #setDataAndNormalize
4818 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004819 */
4820 public Intent setData(Uri data) {
4821 mData = data;
4822 mType = null;
4823 return this;
4824 }
4825
4826 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004827 * Normalize and set the data this intent is operating on.
4828 *
4829 * <p>This method automatically clears any type that was
4830 * previously set (for example, by {@link #setType}).
4831 *
4832 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004833 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004834 * so really this is just a convenience method for
4835 * <pre>
4836 * setData(data.normalize())
4837 * </pre>
4838 *
4839 * @param data The Uri of the data this intent is now targeting.
4840 *
4841 * @return Returns the same Intent object, for chaining multiple calls
4842 * into a single statement.
4843 *
4844 * @see #getData
4845 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004846 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004847 */
4848 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004849 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004850 }
4851
4852 /**
4853 * Set an explicit MIME data type.
4854 *
4855 * <p>This is used to create intents that only specify a type and not data,
4856 * for example to indicate the type of data to return.
4857 *
4858 * <p>This method automatically clears any data that was
4859 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004860 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004861 * <p><em>Note: MIME type matching in the Android framework is
4862 * case-sensitive, unlike formal RFC MIME types. As a result,
4863 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004864 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4865 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004866 *
4867 * @param type The MIME type of the data being handled by this intent.
4868 *
4869 * @return Returns the same Intent object, for chaining multiple calls
4870 * into a single statement.
4871 *
4872 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004873 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004874 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004875 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004876 */
4877 public Intent setType(String type) {
4878 mData = null;
4879 mType = type;
4880 return this;
4881 }
4882
4883 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004884 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004885 *
Nick Pellyccae4122012-01-09 14:12:58 -08004886 * <p>This is used to create intents that only specify a type and not data,
4887 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004888 *
Nick Pellyccae4122012-01-09 14:12:58 -08004889 * <p>This method automatically clears any data that was
4890 * previously set (for example by {@link #setData}).
4891 *
4892 * <p>The MIME type is normalized using
4893 * {@link #normalizeMimeType} before it is set,
4894 * so really this is just a convenience method for
4895 * <pre>
4896 * setType(Intent.normalizeMimeType(type))
4897 * </pre>
4898 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004899 * @param type The MIME type of the data being handled by this intent.
4900 *
4901 * @return Returns the same Intent object, for chaining multiple calls
4902 * into a single statement.
4903 *
Nick Pellyccae4122012-01-09 14:12:58 -08004904 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004905 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004906 * @see #normalizeMimeType
4907 */
4908 public Intent setTypeAndNormalize(String type) {
4909 return setType(normalizeMimeType(type));
4910 }
4911
4912 /**
4913 * (Usually optional) Set the data for the intent along with an explicit
4914 * MIME data type. This method should very rarely be used -- it allows you
4915 * to override the MIME type that would ordinarily be inferred from the
4916 * data with your own type given here.
4917 *
4918 * <p><em>Note: MIME type and Uri scheme matching in the
4919 * Android framework is case-sensitive, unlike the formal RFC definitions.
4920 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004921 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004922 * {@link #setDataAndTypeAndNormalize}
4923 * to ensure that they are converted to lower case.</em>
4924 *
4925 * @param data The Uri of the data this intent is now targeting.
4926 * @param type The MIME type of the data being handled by this intent.
4927 *
4928 * @return Returns the same Intent object, for chaining multiple calls
4929 * into a single statement.
4930 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004931 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004932 * @see #setData
4933 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004934 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004935 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004936 */
4937 public Intent setDataAndType(Uri data, String type) {
4938 mData = data;
4939 mType = type;
4940 return this;
4941 }
4942
4943 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004944 * (Usually optional) Normalize and set both the data Uri and an explicit
4945 * MIME data type. This method should very rarely be used -- it allows you
4946 * to override the MIME type that would ordinarily be inferred from the
4947 * data with your own type given here.
4948 *
4949 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004950 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004951 * before they are set, so really this is just a convenience method for
4952 * <pre>
4953 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4954 * </pre>
4955 *
4956 * @param data The Uri of the data this intent is now targeting.
4957 * @param type The MIME type of the data being handled by this intent.
4958 *
4959 * @return Returns the same Intent object, for chaining multiple calls
4960 * into a single statement.
4961 *
4962 * @see #setType
4963 * @see #setData
4964 * @see #setDataAndType
4965 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004966 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004967 */
4968 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004969 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004970 }
4971
4972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004973 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004974 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004975 * activities that provide <em>all</em> of the requested categories will be
4976 * used.
4977 *
4978 * @param category The desired category. This can be either one of the
4979 * predefined Intent categories, or a custom category in your own
4980 * namespace.
4981 *
4982 * @return Returns the same Intent object, for chaining multiple calls
4983 * into a single statement.
4984 *
4985 * @see #hasCategory
4986 * @see #removeCategory
4987 */
4988 public Intent addCategory(String category) {
4989 if (mCategories == null) {
4990 mCategories = new HashSet<String>();
4991 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004992 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004993 return this;
4994 }
4995
4996 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004997 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004998 *
4999 * @param category The category to remove.
5000 *
5001 * @see #addCategory
5002 */
5003 public void removeCategory(String category) {
5004 if (mCategories != null) {
5005 mCategories.remove(category);
5006 if (mCategories.size() == 0) {
5007 mCategories = null;
5008 }
5009 }
5010 }
5011
5012 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005013 * Set a selector for this Intent. This is a modification to the kinds of
5014 * things the Intent will match. If the selector is set, it will be used
5015 * when trying to find entities that can handle the Intent, instead of the
5016 * main contents of the Intent. This allows you build an Intent containing
5017 * a generic protocol while targeting it more specifically.
5018 *
5019 * <p>An example of where this may be used is with things like
5020 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5021 * Intent that will launch the Browser application. However, the correct
5022 * main entry point of an application is actually {@link #ACTION_MAIN}
5023 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5024 * used to specify the actual Activity to launch. If you launch the browser
5025 * with something different, undesired behavior may happen if the user has
5026 * previously or later launches it the normal way, since they do not match.
5027 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5028 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5029 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5030 *
5031 * <p>Setting a selector does not impact the behavior of
5032 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5033 * desired behavior of a selector -- it does not impact the base meaning
5034 * of the Intent, just what kinds of things will be matched against it
5035 * when determining who can handle it.</p>
5036 *
5037 * <p>You can not use both a selector and {@link #setPackage(String)} on
5038 * the same base Intent.</p>
5039 *
5040 * @param selector The desired selector Intent; set to null to not use
5041 * a special selector.
5042 */
5043 public void setSelector(Intent selector) {
5044 if (selector == this) {
5045 throw new IllegalArgumentException(
5046 "Intent being set as a selector of itself");
5047 }
5048 if (selector != null && mPackage != null) {
5049 throw new IllegalArgumentException(
5050 "Can't set selector when package name is already set");
5051 }
5052 mSelector = selector;
5053 }
5054
5055 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005056 * Set a {@link ClipData} associated with this Intent. This replaces any
5057 * previously set ClipData.
5058 *
5059 * <p>The ClipData in an intent is not used for Intent matching or other
5060 * such operations. Semantically it is like extras, used to transmit
5061 * additional data with the Intent. The main feature of using this over
5062 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5063 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5064 * items included in the clip data. This is useful, in particular, if
5065 * you want to transmit an Intent containing multiple <code>content:</code>
5066 * URIs for which the recipient may not have global permission to access the
5067 * content provider.
5068 *
5069 * <p>If the ClipData contains items that are themselves Intents, any
5070 * grant flags in those Intents will be ignored. Only the top-level flags
5071 * of the main Intent are respected, and will be applied to all Uri or
5072 * Intent items in the clip (or sub-items of the clip).
5073 *
5074 * <p>The MIME type, label, and icon in the ClipData object are not
5075 * directly used by Intent. Applications should generally rely on the
5076 * MIME type of the Intent itself, not what it may find in the ClipData.
5077 * A common practice is to construct a ClipData for use with an Intent
5078 * with a MIME type of "*\/*".
5079 *
5080 * @param clip The new clip to set. May be null to clear the current clip.
5081 */
5082 public void setClipData(ClipData clip) {
5083 mClipData = clip;
5084 }
5085
5086 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005087 * Add extended data to the intent. The name must include a package
5088 * prefix, for example the app com.android.contacts would use names
5089 * like "com.android.contacts.ShowAll".
5090 *
5091 * @param name The name of the extra data, with package prefix.
5092 * @param value The boolean data value.
5093 *
5094 * @return Returns the same Intent object, for chaining multiple calls
5095 * into a single statement.
5096 *
5097 * @see #putExtras
5098 * @see #removeExtra
5099 * @see #getBooleanExtra(String, boolean)
5100 */
5101 public Intent putExtra(String name, boolean value) {
5102 if (mExtras == null) {
5103 mExtras = new Bundle();
5104 }
5105 mExtras.putBoolean(name, value);
5106 return this;
5107 }
5108
5109 /**
5110 * Add extended data to the intent. The name must include a package
5111 * prefix, for example the app com.android.contacts would use names
5112 * like "com.android.contacts.ShowAll".
5113 *
5114 * @param name The name of the extra data, with package prefix.
5115 * @param value The byte data value.
5116 *
5117 * @return Returns the same Intent object, for chaining multiple calls
5118 * into a single statement.
5119 *
5120 * @see #putExtras
5121 * @see #removeExtra
5122 * @see #getByteExtra(String, byte)
5123 */
5124 public Intent putExtra(String name, byte value) {
5125 if (mExtras == null) {
5126 mExtras = new Bundle();
5127 }
5128 mExtras.putByte(name, value);
5129 return this;
5130 }
5131
5132 /**
5133 * Add extended data to the intent. The name must include a package
5134 * prefix, for example the app com.android.contacts would use names
5135 * like "com.android.contacts.ShowAll".
5136 *
5137 * @param name The name of the extra data, with package prefix.
5138 * @param value The char data value.
5139 *
5140 * @return Returns the same Intent object, for chaining multiple calls
5141 * into a single statement.
5142 *
5143 * @see #putExtras
5144 * @see #removeExtra
5145 * @see #getCharExtra(String, char)
5146 */
5147 public Intent putExtra(String name, char value) {
5148 if (mExtras == null) {
5149 mExtras = new Bundle();
5150 }
5151 mExtras.putChar(name, value);
5152 return this;
5153 }
5154
5155 /**
5156 * Add extended data to the intent. The name must include a package
5157 * prefix, for example the app com.android.contacts would use names
5158 * like "com.android.contacts.ShowAll".
5159 *
5160 * @param name The name of the extra data, with package prefix.
5161 * @param value The short data value.
5162 *
5163 * @return Returns the same Intent object, for chaining multiple calls
5164 * into a single statement.
5165 *
5166 * @see #putExtras
5167 * @see #removeExtra
5168 * @see #getShortExtra(String, short)
5169 */
5170 public Intent putExtra(String name, short value) {
5171 if (mExtras == null) {
5172 mExtras = new Bundle();
5173 }
5174 mExtras.putShort(name, value);
5175 return this;
5176 }
5177
5178 /**
5179 * Add extended data to the intent. The name must include a package
5180 * prefix, for example the app com.android.contacts would use names
5181 * like "com.android.contacts.ShowAll".
5182 *
5183 * @param name The name of the extra data, with package prefix.
5184 * @param value The integer data value.
5185 *
5186 * @return Returns the same Intent object, for chaining multiple calls
5187 * into a single statement.
5188 *
5189 * @see #putExtras
5190 * @see #removeExtra
5191 * @see #getIntExtra(String, int)
5192 */
5193 public Intent putExtra(String name, int value) {
5194 if (mExtras == null) {
5195 mExtras = new Bundle();
5196 }
5197 mExtras.putInt(name, value);
5198 return this;
5199 }
5200
5201 /**
5202 * Add extended data to the intent. The name must include a package
5203 * prefix, for example the app com.android.contacts would use names
5204 * like "com.android.contacts.ShowAll".
5205 *
5206 * @param name The name of the extra data, with package prefix.
5207 * @param value The long data value.
5208 *
5209 * @return Returns the same Intent object, for chaining multiple calls
5210 * into a single statement.
5211 *
5212 * @see #putExtras
5213 * @see #removeExtra
5214 * @see #getLongExtra(String, long)
5215 */
5216 public Intent putExtra(String name, long value) {
5217 if (mExtras == null) {
5218 mExtras = new Bundle();
5219 }
5220 mExtras.putLong(name, value);
5221 return this;
5222 }
5223
5224 /**
5225 * Add extended data to the intent. The name must include a package
5226 * prefix, for example the app com.android.contacts would use names
5227 * like "com.android.contacts.ShowAll".
5228 *
5229 * @param name The name of the extra data, with package prefix.
5230 * @param value The float data value.
5231 *
5232 * @return Returns the same Intent object, for chaining multiple calls
5233 * into a single statement.
5234 *
5235 * @see #putExtras
5236 * @see #removeExtra
5237 * @see #getFloatExtra(String, float)
5238 */
5239 public Intent putExtra(String name, float value) {
5240 if (mExtras == null) {
5241 mExtras = new Bundle();
5242 }
5243 mExtras.putFloat(name, value);
5244 return this;
5245 }
5246
5247 /**
5248 * Add extended data to the intent. The name must include a package
5249 * prefix, for example the app com.android.contacts would use names
5250 * like "com.android.contacts.ShowAll".
5251 *
5252 * @param name The name of the extra data, with package prefix.
5253 * @param value The double data value.
5254 *
5255 * @return Returns the same Intent object, for chaining multiple calls
5256 * into a single statement.
5257 *
5258 * @see #putExtras
5259 * @see #removeExtra
5260 * @see #getDoubleExtra(String, double)
5261 */
5262 public Intent putExtra(String name, double value) {
5263 if (mExtras == null) {
5264 mExtras = new Bundle();
5265 }
5266 mExtras.putDouble(name, value);
5267 return this;
5268 }
5269
5270 /**
5271 * Add extended data to the intent. The name must include a package
5272 * prefix, for example the app com.android.contacts would use names
5273 * like "com.android.contacts.ShowAll".
5274 *
5275 * @param name The name of the extra data, with package prefix.
5276 * @param value The String data value.
5277 *
5278 * @return Returns the same Intent object, for chaining multiple calls
5279 * into a single statement.
5280 *
5281 * @see #putExtras
5282 * @see #removeExtra
5283 * @see #getStringExtra(String)
5284 */
5285 public Intent putExtra(String name, String value) {
5286 if (mExtras == null) {
5287 mExtras = new Bundle();
5288 }
5289 mExtras.putString(name, value);
5290 return this;
5291 }
5292
5293 /**
5294 * Add extended data to the intent. The name must include a package
5295 * prefix, for example the app com.android.contacts would use names
5296 * like "com.android.contacts.ShowAll".
5297 *
5298 * @param name The name of the extra data, with package prefix.
5299 * @param value The CharSequence data value.
5300 *
5301 * @return Returns the same Intent object, for chaining multiple calls
5302 * into a single statement.
5303 *
5304 * @see #putExtras
5305 * @see #removeExtra
5306 * @see #getCharSequenceExtra(String)
5307 */
5308 public Intent putExtra(String name, CharSequence value) {
5309 if (mExtras == null) {
5310 mExtras = new Bundle();
5311 }
5312 mExtras.putCharSequence(name, value);
5313 return this;
5314 }
5315
5316 /**
5317 * Add extended data to the intent. The name must include a package
5318 * prefix, for example the app com.android.contacts would use names
5319 * like "com.android.contacts.ShowAll".
5320 *
5321 * @param name The name of the extra data, with package prefix.
5322 * @param value The Parcelable data value.
5323 *
5324 * @return Returns the same Intent object, for chaining multiple calls
5325 * into a single statement.
5326 *
5327 * @see #putExtras
5328 * @see #removeExtra
5329 * @see #getParcelableExtra(String)
5330 */
5331 public Intent putExtra(String name, Parcelable value) {
5332 if (mExtras == null) {
5333 mExtras = new Bundle();
5334 }
5335 mExtras.putParcelable(name, value);
5336 return this;
5337 }
5338
5339 /**
5340 * Add extended data to the intent. The name must include a package
5341 * prefix, for example the app com.android.contacts would use names
5342 * like "com.android.contacts.ShowAll".
5343 *
5344 * @param name The name of the extra data, with package prefix.
5345 * @param value The Parcelable[] data value.
5346 *
5347 * @return Returns the same Intent object, for chaining multiple calls
5348 * into a single statement.
5349 *
5350 * @see #putExtras
5351 * @see #removeExtra
5352 * @see #getParcelableArrayExtra(String)
5353 */
5354 public Intent putExtra(String name, Parcelable[] value) {
5355 if (mExtras == null) {
5356 mExtras = new Bundle();
5357 }
5358 mExtras.putParcelableArray(name, value);
5359 return this;
5360 }
5361
5362 /**
5363 * Add extended data to the intent. The name must include a package
5364 * prefix, for example the app com.android.contacts would use names
5365 * like "com.android.contacts.ShowAll".
5366 *
5367 * @param name The name of the extra data, with package prefix.
5368 * @param value The ArrayList<Parcelable> data value.
5369 *
5370 * @return Returns the same Intent object, for chaining multiple calls
5371 * into a single statement.
5372 *
5373 * @see #putExtras
5374 * @see #removeExtra
5375 * @see #getParcelableArrayListExtra(String)
5376 */
5377 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5378 if (mExtras == null) {
5379 mExtras = new Bundle();
5380 }
5381 mExtras.putParcelableArrayList(name, value);
5382 return this;
5383 }
5384
5385 /**
5386 * Add extended data to the intent. The name must include a package
5387 * prefix, for example the app com.android.contacts would use names
5388 * like "com.android.contacts.ShowAll".
5389 *
5390 * @param name The name of the extra data, with package prefix.
5391 * @param value The ArrayList<Integer> data value.
5392 *
5393 * @return Returns the same Intent object, for chaining multiple calls
5394 * into a single statement.
5395 *
5396 * @see #putExtras
5397 * @see #removeExtra
5398 * @see #getIntegerArrayListExtra(String)
5399 */
5400 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5401 if (mExtras == null) {
5402 mExtras = new Bundle();
5403 }
5404 mExtras.putIntegerArrayList(name, value);
5405 return this;
5406 }
5407
5408 /**
5409 * Add extended data to the intent. The name must include a package
5410 * prefix, for example the app com.android.contacts would use names
5411 * like "com.android.contacts.ShowAll".
5412 *
5413 * @param name The name of the extra data, with package prefix.
5414 * @param value The ArrayList<String> data value.
5415 *
5416 * @return Returns the same Intent object, for chaining multiple calls
5417 * into a single statement.
5418 *
5419 * @see #putExtras
5420 * @see #removeExtra
5421 * @see #getStringArrayListExtra(String)
5422 */
5423 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5424 if (mExtras == null) {
5425 mExtras = new Bundle();
5426 }
5427 mExtras.putStringArrayList(name, value);
5428 return this;
5429 }
5430
5431 /**
5432 * Add extended data to the intent. The name must include a package
5433 * prefix, for example the app com.android.contacts would use names
5434 * like "com.android.contacts.ShowAll".
5435 *
5436 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005437 * @param value The ArrayList<CharSequence> data value.
5438 *
5439 * @return Returns the same Intent object, for chaining multiple calls
5440 * into a single statement.
5441 *
5442 * @see #putExtras
5443 * @see #removeExtra
5444 * @see #getCharSequenceArrayListExtra(String)
5445 */
5446 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5447 if (mExtras == null) {
5448 mExtras = new Bundle();
5449 }
5450 mExtras.putCharSequenceArrayList(name, value);
5451 return this;
5452 }
5453
5454 /**
5455 * Add extended data to the intent. The name must include a package
5456 * prefix, for example the app com.android.contacts would use names
5457 * like "com.android.contacts.ShowAll".
5458 *
5459 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005460 * @param value The Serializable data value.
5461 *
5462 * @return Returns the same Intent object, for chaining multiple calls
5463 * into a single statement.
5464 *
5465 * @see #putExtras
5466 * @see #removeExtra
5467 * @see #getSerializableExtra(String)
5468 */
5469 public Intent putExtra(String name, Serializable value) {
5470 if (mExtras == null) {
5471 mExtras = new Bundle();
5472 }
5473 mExtras.putSerializable(name, value);
5474 return this;
5475 }
5476
5477 /**
5478 * Add extended data to the intent. The name must include a package
5479 * prefix, for example the app com.android.contacts would use names
5480 * like "com.android.contacts.ShowAll".
5481 *
5482 * @param name The name of the extra data, with package prefix.
5483 * @param value The boolean array data value.
5484 *
5485 * @return Returns the same Intent object, for chaining multiple calls
5486 * into a single statement.
5487 *
5488 * @see #putExtras
5489 * @see #removeExtra
5490 * @see #getBooleanArrayExtra(String)
5491 */
5492 public Intent putExtra(String name, boolean[] value) {
5493 if (mExtras == null) {
5494 mExtras = new Bundle();
5495 }
5496 mExtras.putBooleanArray(name, value);
5497 return this;
5498 }
5499
5500 /**
5501 * Add extended data to the intent. The name must include a package
5502 * prefix, for example the app com.android.contacts would use names
5503 * like "com.android.contacts.ShowAll".
5504 *
5505 * @param name The name of the extra data, with package prefix.
5506 * @param value The byte array data value.
5507 *
5508 * @return Returns the same Intent object, for chaining multiple calls
5509 * into a single statement.
5510 *
5511 * @see #putExtras
5512 * @see #removeExtra
5513 * @see #getByteArrayExtra(String)
5514 */
5515 public Intent putExtra(String name, byte[] value) {
5516 if (mExtras == null) {
5517 mExtras = new Bundle();
5518 }
5519 mExtras.putByteArray(name, value);
5520 return this;
5521 }
5522
5523 /**
5524 * Add extended data to the intent. The name must include a package
5525 * prefix, for example the app com.android.contacts would use names
5526 * like "com.android.contacts.ShowAll".
5527 *
5528 * @param name The name of the extra data, with package prefix.
5529 * @param value The short array data value.
5530 *
5531 * @return Returns the same Intent object, for chaining multiple calls
5532 * into a single statement.
5533 *
5534 * @see #putExtras
5535 * @see #removeExtra
5536 * @see #getShortArrayExtra(String)
5537 */
5538 public Intent putExtra(String name, short[] value) {
5539 if (mExtras == null) {
5540 mExtras = new Bundle();
5541 }
5542 mExtras.putShortArray(name, value);
5543 return this;
5544 }
5545
5546 /**
5547 * Add extended data to the intent. The name must include a package
5548 * prefix, for example the app com.android.contacts would use names
5549 * like "com.android.contacts.ShowAll".
5550 *
5551 * @param name The name of the extra data, with package prefix.
5552 * @param value The char array data value.
5553 *
5554 * @return Returns the same Intent object, for chaining multiple calls
5555 * into a single statement.
5556 *
5557 * @see #putExtras
5558 * @see #removeExtra
5559 * @see #getCharArrayExtra(String)
5560 */
5561 public Intent putExtra(String name, char[] value) {
5562 if (mExtras == null) {
5563 mExtras = new Bundle();
5564 }
5565 mExtras.putCharArray(name, value);
5566 return this;
5567 }
5568
5569 /**
5570 * Add extended data to the intent. The name must include a package
5571 * prefix, for example the app com.android.contacts would use names
5572 * like "com.android.contacts.ShowAll".
5573 *
5574 * @param name The name of the extra data, with package prefix.
5575 * @param value The int array data value.
5576 *
5577 * @return Returns the same Intent object, for chaining multiple calls
5578 * into a single statement.
5579 *
5580 * @see #putExtras
5581 * @see #removeExtra
5582 * @see #getIntArrayExtra(String)
5583 */
5584 public Intent putExtra(String name, int[] value) {
5585 if (mExtras == null) {
5586 mExtras = new Bundle();
5587 }
5588 mExtras.putIntArray(name, value);
5589 return this;
5590 }
5591
5592 /**
5593 * Add extended data to the intent. The name must include a package
5594 * prefix, for example the app com.android.contacts would use names
5595 * like "com.android.contacts.ShowAll".
5596 *
5597 * @param name The name of the extra data, with package prefix.
5598 * @param value The byte array data value.
5599 *
5600 * @return Returns the same Intent object, for chaining multiple calls
5601 * into a single statement.
5602 *
5603 * @see #putExtras
5604 * @see #removeExtra
5605 * @see #getLongArrayExtra(String)
5606 */
5607 public Intent putExtra(String name, long[] value) {
5608 if (mExtras == null) {
5609 mExtras = new Bundle();
5610 }
5611 mExtras.putLongArray(name, value);
5612 return this;
5613 }
5614
5615 /**
5616 * Add extended data to the intent. The name must include a package
5617 * prefix, for example the app com.android.contacts would use names
5618 * like "com.android.contacts.ShowAll".
5619 *
5620 * @param name The name of the extra data, with package prefix.
5621 * @param value The float array data value.
5622 *
5623 * @return Returns the same Intent object, for chaining multiple calls
5624 * into a single statement.
5625 *
5626 * @see #putExtras
5627 * @see #removeExtra
5628 * @see #getFloatArrayExtra(String)
5629 */
5630 public Intent putExtra(String name, float[] value) {
5631 if (mExtras == null) {
5632 mExtras = new Bundle();
5633 }
5634 mExtras.putFloatArray(name, value);
5635 return this;
5636 }
5637
5638 /**
5639 * Add extended data to the intent. The name must include a package
5640 * prefix, for example the app com.android.contacts would use names
5641 * like "com.android.contacts.ShowAll".
5642 *
5643 * @param name The name of the extra data, with package prefix.
5644 * @param value The double array data value.
5645 *
5646 * @return Returns the same Intent object, for chaining multiple calls
5647 * into a single statement.
5648 *
5649 * @see #putExtras
5650 * @see #removeExtra
5651 * @see #getDoubleArrayExtra(String)
5652 */
5653 public Intent putExtra(String name, double[] value) {
5654 if (mExtras == null) {
5655 mExtras = new Bundle();
5656 }
5657 mExtras.putDoubleArray(name, value);
5658 return this;
5659 }
5660
5661 /**
5662 * Add extended data to the intent. The name must include a package
5663 * prefix, for example the app com.android.contacts would use names
5664 * like "com.android.contacts.ShowAll".
5665 *
5666 * @param name The name of the extra data, with package prefix.
5667 * @param value The String array data value.
5668 *
5669 * @return Returns the same Intent object, for chaining multiple calls
5670 * into a single statement.
5671 *
5672 * @see #putExtras
5673 * @see #removeExtra
5674 * @see #getStringArrayExtra(String)
5675 */
5676 public Intent putExtra(String name, String[] value) {
5677 if (mExtras == null) {
5678 mExtras = new Bundle();
5679 }
5680 mExtras.putStringArray(name, value);
5681 return this;
5682 }
5683
5684 /**
5685 * Add extended data to the intent. The name must include a package
5686 * prefix, for example the app com.android.contacts would use names
5687 * like "com.android.contacts.ShowAll".
5688 *
5689 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005690 * @param value The CharSequence array data value.
5691 *
5692 * @return Returns the same Intent object, for chaining multiple calls
5693 * into a single statement.
5694 *
5695 * @see #putExtras
5696 * @see #removeExtra
5697 * @see #getCharSequenceArrayExtra(String)
5698 */
5699 public Intent putExtra(String name, CharSequence[] value) {
5700 if (mExtras == null) {
5701 mExtras = new Bundle();
5702 }
5703 mExtras.putCharSequenceArray(name, value);
5704 return this;
5705 }
5706
5707 /**
5708 * Add extended data to the intent. The name must include a package
5709 * prefix, for example the app com.android.contacts would use names
5710 * like "com.android.contacts.ShowAll".
5711 *
5712 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005713 * @param value The Bundle data value.
5714 *
5715 * @return Returns the same Intent object, for chaining multiple calls
5716 * into a single statement.
5717 *
5718 * @see #putExtras
5719 * @see #removeExtra
5720 * @see #getBundleExtra(String)
5721 */
5722 public Intent putExtra(String name, Bundle value) {
5723 if (mExtras == null) {
5724 mExtras = new Bundle();
5725 }
5726 mExtras.putBundle(name, value);
5727 return this;
5728 }
5729
5730 /**
5731 * Add extended data to the intent. The name must include a package
5732 * prefix, for example the app com.android.contacts would use names
5733 * like "com.android.contacts.ShowAll".
5734 *
5735 * @param name The name of the extra data, with package prefix.
5736 * @param value The IBinder data value.
5737 *
5738 * @return Returns the same Intent object, for chaining multiple calls
5739 * into a single statement.
5740 *
5741 * @see #putExtras
5742 * @see #removeExtra
5743 * @see #getIBinderExtra(String)
5744 *
5745 * @deprecated
5746 * @hide
5747 */
5748 @Deprecated
5749 public Intent putExtra(String name, IBinder value) {
5750 if (mExtras == null) {
5751 mExtras = new Bundle();
5752 }
5753 mExtras.putIBinder(name, value);
5754 return this;
5755 }
5756
5757 /**
5758 * Copy all extras in 'src' in to this intent.
5759 *
5760 * @param src Contains the extras to copy.
5761 *
5762 * @see #putExtra
5763 */
5764 public Intent putExtras(Intent src) {
5765 if (src.mExtras != null) {
5766 if (mExtras == null) {
5767 mExtras = new Bundle(src.mExtras);
5768 } else {
5769 mExtras.putAll(src.mExtras);
5770 }
5771 }
5772 return this;
5773 }
5774
5775 /**
5776 * Add a set of extended data to the intent. The keys must include a package
5777 * prefix, for example the app com.android.contacts would use names
5778 * like "com.android.contacts.ShowAll".
5779 *
5780 * @param extras The Bundle of extras to add to this intent.
5781 *
5782 * @see #putExtra
5783 * @see #removeExtra
5784 */
5785 public Intent putExtras(Bundle extras) {
5786 if (mExtras == null) {
5787 mExtras = new Bundle();
5788 }
5789 mExtras.putAll(extras);
5790 return this;
5791 }
5792
5793 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005794 * Completely replace the extras in the Intent with the extras in the
5795 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005796 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005797 * @param src The exact extras contained in this Intent are copied
5798 * into the target intent, replacing any that were previously there.
5799 */
5800 public Intent replaceExtras(Intent src) {
5801 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5802 return this;
5803 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005804
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005805 /**
5806 * Completely replace the extras in the Intent with the given Bundle of
5807 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005808 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005809 * @param extras The new set of extras in the Intent, or null to erase
5810 * all extras.
5811 */
5812 public Intent replaceExtras(Bundle extras) {
5813 mExtras = extras != null ? new Bundle(extras) : null;
5814 return this;
5815 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005816
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005817 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005818 * Remove extended data from the intent.
5819 *
5820 * @see #putExtra
5821 */
5822 public void removeExtra(String name) {
5823 if (mExtras != null) {
5824 mExtras.remove(name);
5825 if (mExtras.size() == 0) {
5826 mExtras = null;
5827 }
5828 }
5829 }
5830
5831 /**
5832 * Set special flags controlling how this intent is handled. Most values
5833 * here depend on the type of component being executed by the Intent,
5834 * specifically the FLAG_ACTIVITY_* flags are all for use with
5835 * {@link Context#startActivity Context.startActivity()} and the
5836 * FLAG_RECEIVER_* flags are all for use with
5837 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5838 *
Scott Main7aee61f2011-02-08 11:25:01 -08005839 * <p>See the
5840 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5841 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005842 * the behavior of your application.
5843 *
5844 * @param flags The desired flags.
5845 *
5846 * @return Returns the same Intent object, for chaining multiple calls
5847 * into a single statement.
5848 *
5849 * @see #getFlags
5850 * @see #addFlags
5851 *
5852 * @see #FLAG_GRANT_READ_URI_PERMISSION
5853 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5854 * @see #FLAG_DEBUG_LOG_RESOLUTION
5855 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005856 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005857 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005858 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005859 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005860 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5861 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005862 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005863 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5864 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005865 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005866 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005867 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005868 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5869 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005870 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005871 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005872 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005873 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5874 */
5875 public Intent setFlags(int flags) {
5876 mFlags = flags;
5877 return this;
5878 }
5879
5880 /**
5881 * Add additional flags to the intent (or with existing flags
5882 * value).
5883 *
5884 * @param flags The new flags to set.
5885 *
5886 * @return Returns the same Intent object, for chaining multiple calls
5887 * into a single statement.
5888 *
5889 * @see #setFlags
5890 */
5891 public Intent addFlags(int flags) {
5892 mFlags |= flags;
5893 return this;
5894 }
5895
5896 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005897 * (Usually optional) Set an explicit application package name that limits
5898 * the components this Intent will resolve to. If left to the default
5899 * value of null, all components in all applications will considered.
5900 * If non-null, the Intent can only match the components in the given
5901 * application package.
5902 *
5903 * @param packageName The name of the application package to handle the
5904 * intent, or null to allow any application package.
5905 *
5906 * @return Returns the same Intent object, for chaining multiple calls
5907 * into a single statement.
5908 *
5909 * @see #getPackage
5910 * @see #resolveActivity
5911 */
5912 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005913 if (packageName != null && mSelector != null) {
5914 throw new IllegalArgumentException(
5915 "Can't set package name when selector is already set");
5916 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005917 mPackage = packageName;
5918 return this;
5919 }
5920
5921 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005922 * (Usually optional) Explicitly set the component to handle the intent.
5923 * If left with the default value of null, the system will determine the
5924 * appropriate class to use based on the other fields (action, data,
5925 * type, categories) in the Intent. If this class is defined, the
5926 * specified class will always be used regardless of the other fields. You
5927 * should only set this value when you know you absolutely want a specific
5928 * class to be used; otherwise it is better to let the system find the
5929 * appropriate class so that you will respect the installed applications
5930 * and user preferences.
5931 *
5932 * @param component The name of the application component to handle the
5933 * intent, or null to let the system find one for you.
5934 *
5935 * @return Returns the same Intent object, for chaining multiple calls
5936 * into a single statement.
5937 *
5938 * @see #setClass
5939 * @see #setClassName(Context, String)
5940 * @see #setClassName(String, String)
5941 * @see #getComponent
5942 * @see #resolveActivity
5943 */
5944 public Intent setComponent(ComponentName component) {
5945 mComponent = component;
5946 return this;
5947 }
5948
5949 /**
5950 * Convenience for calling {@link #setComponent} with an
5951 * explicit class name.
5952 *
5953 * @param packageContext A Context of the application package implementing
5954 * this class.
5955 * @param className The name of a class inside of the application package
5956 * that will be used as the component for this Intent.
5957 *
5958 * @return Returns the same Intent object, for chaining multiple calls
5959 * into a single statement.
5960 *
5961 * @see #setComponent
5962 * @see #setClass
5963 */
5964 public Intent setClassName(Context packageContext, String className) {
5965 mComponent = new ComponentName(packageContext, className);
5966 return this;
5967 }
5968
5969 /**
5970 * Convenience for calling {@link #setComponent} with an
5971 * explicit application package name and class name.
5972 *
5973 * @param packageName The name of the package implementing the desired
5974 * component.
5975 * @param className The name of a class inside of the application package
5976 * that will be used as the component for this Intent.
5977 *
5978 * @return Returns the same Intent object, for chaining multiple calls
5979 * into a single statement.
5980 *
5981 * @see #setComponent
5982 * @see #setClass
5983 */
5984 public Intent setClassName(String packageName, String className) {
5985 mComponent = new ComponentName(packageName, className);
5986 return this;
5987 }
5988
5989 /**
5990 * Convenience for calling {@link #setComponent(ComponentName)} with the
5991 * name returned by a {@link Class} object.
5992 *
5993 * @param packageContext A Context of the application package implementing
5994 * this class.
5995 * @param cls The class name to set, equivalent to
5996 * <code>setClassName(context, cls.getName())</code>.
5997 *
5998 * @return Returns the same Intent object, for chaining multiple calls
5999 * into a single statement.
6000 *
6001 * @see #setComponent
6002 */
6003 public Intent setClass(Context packageContext, Class<?> cls) {
6004 mComponent = new ComponentName(packageContext, cls);
6005 return this;
6006 }
6007
6008 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006009 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6010 * used as a hint to the receiver for animations and the like. Null means that there
6011 * is no source bounds.
6012 */
6013 public void setSourceBounds(Rect r) {
6014 if (r != null) {
6015 mSourceBounds = new Rect(r);
6016 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006017 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006018 }
6019 }
6020
6021 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006022 * Use with {@link #fillIn} to allow the current action value to be
6023 * overwritten, even if it is already set.
6024 */
6025 public static final int FILL_IN_ACTION = 1<<0;
6026
6027 /**
6028 * Use with {@link #fillIn} to allow the current data or type value
6029 * overwritten, even if it is already set.
6030 */
6031 public static final int FILL_IN_DATA = 1<<1;
6032
6033 /**
6034 * Use with {@link #fillIn} to allow the current categories to be
6035 * overwritten, even if they are already set.
6036 */
6037 public static final int FILL_IN_CATEGORIES = 1<<2;
6038
6039 /**
6040 * Use with {@link #fillIn} to allow the current component value to be
6041 * overwritten, even if it is already set.
6042 */
6043 public static final int FILL_IN_COMPONENT = 1<<3;
6044
6045 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006046 * Use with {@link #fillIn} to allow the current package value to be
6047 * overwritten, even if it is already set.
6048 */
6049 public static final int FILL_IN_PACKAGE = 1<<4;
6050
6051 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006052 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006053 * overwritten, even if it is already set.
6054 */
6055 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6056
6057 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006058 * Use with {@link #fillIn} to allow the current selector to be
6059 * overwritten, even if it is already set.
6060 */
6061 public static final int FILL_IN_SELECTOR = 1<<6;
6062
6063 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006064 * Use with {@link #fillIn} to allow the current ClipData to be
6065 * overwritten, even if it is already set.
6066 */
6067 public static final int FILL_IN_CLIP_DATA = 1<<7;
6068
6069 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006070 * Copy the contents of <var>other</var> in to this object, but only
6071 * where fields are not defined by this object. For purposes of a field
6072 * being defined, the following pieces of data in the Intent are
6073 * considered to be separate fields:
6074 *
6075 * <ul>
6076 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006077 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006078 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6079 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006080 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006081 * <li> component, as set by {@link #setComponent(ComponentName)} or
6082 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006083 * <li> source bounds, as set by {@link #setSourceBounds}.
6084 * <li> selector, as set by {@link #setSelector(Intent)}.
6085 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006086 * <li> each top-level name in the associated extras.
6087 * </ul>
6088 *
6089 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006090 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006091 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6092 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6093 * the restriction where the corresponding field will not be replaced if
6094 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006095 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006096 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6097 * is explicitly specified. The selector will only be copied if
6098 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006099 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006100 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6101 * and Intent B with {action="gotit", data-type="some/thing",
6102 * categories="one","two"}.
6103 *
6104 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6105 * containing: {action="gotit", data-type="some/thing",
6106 * categories="bar"}.
6107 *
6108 * @param other Another Intent whose values are to be used to fill in
6109 * the current one.
6110 * @param flags Options to control which fields can be filled in.
6111 *
6112 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006113 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006114 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6115 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006116 */
6117 public int fillIn(Intent other, int flags) {
6118 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006119 if (other.mAction != null
6120 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006121 mAction = other.mAction;
6122 changes |= FILL_IN_ACTION;
6123 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006124 if ((other.mData != null || other.mType != null)
6125 && ((mData == null && mType == null)
6126 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006127 mData = other.mData;
6128 mType = other.mType;
6129 changes |= FILL_IN_DATA;
6130 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006131 if (other.mCategories != null
6132 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006133 if (other.mCategories != null) {
6134 mCategories = new HashSet<String>(other.mCategories);
6135 }
6136 changes |= FILL_IN_CATEGORIES;
6137 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006138 if (other.mPackage != null
6139 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006140 // Only do this if mSelector is not set.
6141 if (mSelector == null) {
6142 mPackage = other.mPackage;
6143 changes |= FILL_IN_PACKAGE;
6144 }
6145 }
6146 // Selector is special: it can only be set if explicitly allowed,
6147 // for the same reason as the component name.
6148 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6149 if (mPackage == null) {
6150 mSelector = new Intent(other.mSelector);
6151 mPackage = null;
6152 changes |= FILL_IN_SELECTOR;
6153 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006154 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006155 if (other.mClipData != null
6156 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6157 mClipData = other.mClipData;
6158 changes |= FILL_IN_CLIP_DATA;
6159 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006160 // Component is special: it can -only- be set if explicitly allowed,
6161 // since otherwise the sender could force the intent somewhere the
6162 // originator didn't intend.
6163 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006164 mComponent = other.mComponent;
6165 changes |= FILL_IN_COMPONENT;
6166 }
6167 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006168 if (other.mSourceBounds != null
6169 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6170 mSourceBounds = new Rect(other.mSourceBounds);
6171 changes |= FILL_IN_SOURCE_BOUNDS;
6172 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006173 if (mExtras == null) {
6174 if (other.mExtras != null) {
6175 mExtras = new Bundle(other.mExtras);
6176 }
6177 } else if (other.mExtras != null) {
6178 try {
6179 Bundle newb = new Bundle(other.mExtras);
6180 newb.putAll(mExtras);
6181 mExtras = newb;
6182 } catch (RuntimeException e) {
6183 // Modifying the extras can cause us to unparcel the contents
6184 // of the bundle, and if we do this in the system process that
6185 // may fail. We really should handle this (i.e., the Bundle
6186 // impl shouldn't be on top of a plain map), but for now just
6187 // ignore it and keep the original contents. :(
6188 Log.w("Intent", "Failure filling in extras", e);
6189 }
6190 }
6191 return changes;
6192 }
6193
6194 /**
6195 * Wrapper class holding an Intent and implementing comparisons on it for
6196 * the purpose of filtering. The class implements its
6197 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6198 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6199 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6200 * on the wrapped Intent.
6201 */
6202 public static final class FilterComparison {
6203 private final Intent mIntent;
6204 private final int mHashCode;
6205
6206 public FilterComparison(Intent intent) {
6207 mIntent = intent;
6208 mHashCode = intent.filterHashCode();
6209 }
6210
6211 /**
6212 * Return the Intent that this FilterComparison represents.
6213 * @return Returns the Intent held by the FilterComparison. Do
6214 * not modify!
6215 */
6216 public Intent getIntent() {
6217 return mIntent;
6218 }
6219
6220 @Override
6221 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006222 if (obj instanceof FilterComparison) {
6223 Intent other = ((FilterComparison)obj).mIntent;
6224 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006225 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006226 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006227 }
6228
6229 @Override
6230 public int hashCode() {
6231 return mHashCode;
6232 }
6233 }
6234
6235 /**
6236 * Determine if two intents are the same for the purposes of intent
6237 * resolution (filtering). That is, if their action, data, type,
6238 * class, and categories are the same. This does <em>not</em> compare
6239 * any extra data included in the intents.
6240 *
6241 * @param other The other Intent to compare against.
6242 *
6243 * @return Returns true if action, data, type, class, and categories
6244 * are the same.
6245 */
6246 public boolean filterEquals(Intent other) {
6247 if (other == null) {
6248 return false;
6249 }
6250 if (mAction != other.mAction) {
6251 if (mAction != null) {
6252 if (!mAction.equals(other.mAction)) {
6253 return false;
6254 }
6255 } else {
6256 if (!other.mAction.equals(mAction)) {
6257 return false;
6258 }
6259 }
6260 }
6261 if (mData != other.mData) {
6262 if (mData != null) {
6263 if (!mData.equals(other.mData)) {
6264 return false;
6265 }
6266 } else {
6267 if (!other.mData.equals(mData)) {
6268 return false;
6269 }
6270 }
6271 }
6272 if (mType != other.mType) {
6273 if (mType != null) {
6274 if (!mType.equals(other.mType)) {
6275 return false;
6276 }
6277 } else {
6278 if (!other.mType.equals(mType)) {
6279 return false;
6280 }
6281 }
6282 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006283 if (mPackage != other.mPackage) {
6284 if (mPackage != null) {
6285 if (!mPackage.equals(other.mPackage)) {
6286 return false;
6287 }
6288 } else {
6289 if (!other.mPackage.equals(mPackage)) {
6290 return false;
6291 }
6292 }
6293 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006294 if (mComponent != other.mComponent) {
6295 if (mComponent != null) {
6296 if (!mComponent.equals(other.mComponent)) {
6297 return false;
6298 }
6299 } else {
6300 if (!other.mComponent.equals(mComponent)) {
6301 return false;
6302 }
6303 }
6304 }
6305 if (mCategories != other.mCategories) {
6306 if (mCategories != null) {
6307 if (!mCategories.equals(other.mCategories)) {
6308 return false;
6309 }
6310 } else {
6311 if (!other.mCategories.equals(mCategories)) {
6312 return false;
6313 }
6314 }
6315 }
6316
6317 return true;
6318 }
6319
6320 /**
6321 * Generate hash code that matches semantics of filterEquals().
6322 *
6323 * @return Returns the hash value of the action, data, type, class, and
6324 * categories.
6325 *
6326 * @see #filterEquals
6327 */
6328 public int filterHashCode() {
6329 int code = 0;
6330 if (mAction != null) {
6331 code += mAction.hashCode();
6332 }
6333 if (mData != null) {
6334 code += mData.hashCode();
6335 }
6336 if (mType != null) {
6337 code += mType.hashCode();
6338 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006339 if (mPackage != null) {
6340 code += mPackage.hashCode();
6341 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006342 if (mComponent != null) {
6343 code += mComponent.hashCode();
6344 }
6345 if (mCategories != null) {
6346 code += mCategories.hashCode();
6347 }
6348 return code;
6349 }
6350
6351 @Override
6352 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006353 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006354
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006355 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006356 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006357 b.append(" }");
6358
6359 return b.toString();
6360 }
6361
6362 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006363 public String toInsecureString() {
6364 StringBuilder b = new StringBuilder(128);
6365
6366 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006367 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006368 b.append(" }");
6369
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006370 return b.toString();
6371 }
Romain Guy4969af72009-06-17 10:53:19 -07006372
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006373 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006374 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006375 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006376
6377 b.append("Intent { ");
6378 toShortString(b, false, true, true, true);
6379 b.append(" }");
6380
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006381 return b.toString();
6382 }
6383
6384 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006385 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6386 StringBuilder b = new StringBuilder(128);
6387 toShortString(b, secure, comp, extras, clip);
6388 return b.toString();
6389 }
6390
6391 /** @hide */
6392 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6393 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006394 boolean first = true;
6395 if (mAction != null) {
6396 b.append("act=").append(mAction);
6397 first = false;
6398 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006399 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006400 if (!first) {
6401 b.append(' ');
6402 }
6403 first = false;
6404 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006405 Iterator<String> i = mCategories.iterator();
6406 boolean didone = false;
6407 while (i.hasNext()) {
6408 if (didone) b.append(",");
6409 didone = true;
6410 b.append(i.next());
6411 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006412 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006413 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006414 if (mData != null) {
6415 if (!first) {
6416 b.append(' ');
6417 }
6418 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006419 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006420 if (secure) {
6421 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006422 } else {
6423 b.append(mData);
6424 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006425 }
6426 if (mType != null) {
6427 if (!first) {
6428 b.append(' ');
6429 }
6430 first = false;
6431 b.append("typ=").append(mType);
6432 }
6433 if (mFlags != 0) {
6434 if (!first) {
6435 b.append(' ');
6436 }
6437 first = false;
6438 b.append("flg=0x").append(Integer.toHexString(mFlags));
6439 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006440 if (mPackage != null) {
6441 if (!first) {
6442 b.append(' ');
6443 }
6444 first = false;
6445 b.append("pkg=").append(mPackage);
6446 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006447 if (comp && mComponent != null) {
6448 if (!first) {
6449 b.append(' ');
6450 }
6451 first = false;
6452 b.append("cmp=").append(mComponent.flattenToShortString());
6453 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006454 if (mSourceBounds != null) {
6455 if (!first) {
6456 b.append(' ');
6457 }
6458 first = false;
6459 b.append("bnds=").append(mSourceBounds.toShortString());
6460 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006461 if (mClipData != null) {
6462 if (!first) {
6463 b.append(' ');
6464 }
6465 first = false;
6466 if (clip) {
6467 b.append("clip={");
6468 mClipData.toShortString(b);
6469 b.append('}');
6470 } else {
6471 b.append("(has clip)");
6472 }
6473 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006474 if (extras && mExtras != null) {
6475 if (!first) {
6476 b.append(' ');
6477 }
6478 first = false;
6479 b.append("(has extras)");
6480 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006481 if (mSelector != null) {
6482 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006483 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006484 b.append("}");
6485 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006486 }
6487
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006488 /**
6489 * Call {@link #toUri} with 0 flags.
6490 * @deprecated Use {@link #toUri} instead.
6491 */
6492 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006493 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006494 return toUri(0);
6495 }
6496
6497 /**
6498 * Convert this Intent into a String holding a URI representation of it.
6499 * The returned URI string has been properly URI encoded, so it can be
6500 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6501 * Intent's data as the base URI, with an additional fragment describing
6502 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006503 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006504 * <p>You can convert the returned string back to an Intent with
6505 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006506 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006507 * @param flags Additional operating flags. Either 0 or
6508 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006509 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006510 * @return Returns a URI encoding URI string describing the entire contents
6511 * of the Intent.
6512 */
6513 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006514 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006515 String scheme = null;
6516 if (mData != null) {
6517 String data = mData.toString();
6518 if ((flags&URI_INTENT_SCHEME) != 0) {
6519 final int N = data.length();
6520 for (int i=0; i<N; i++) {
6521 char c = data.charAt(i);
6522 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6523 || c == '.' || c == '-') {
6524 continue;
6525 }
6526 if (c == ':' && i > 0) {
6527 // Valid scheme.
6528 scheme = data.substring(0, i);
6529 uri.append("intent:");
6530 data = data.substring(i+1);
6531 break;
6532 }
Tom Taylord4a47292009-12-21 13:59:18 -08006533
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006534 // No scheme.
6535 break;
6536 }
6537 }
6538 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006539
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006540 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6541 uri.append("intent:");
6542 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006543
6544 uri.append("#Intent;");
6545
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006546 toUriInner(uri, scheme, flags);
6547 if (mSelector != null) {
6548 uri.append("SEL;");
6549 // Note that for now we are not going to try to handle the
6550 // data part; not clear how to represent this as a URI, and
6551 // not much utility in it.
6552 mSelector.toUriInner(uri, null, flags);
6553 }
6554
6555 uri.append("end");
6556
6557 return uri.toString();
6558 }
6559
6560 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006561 if (scheme != null) {
6562 uri.append("scheme=").append(scheme).append(';');
6563 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006564 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006565 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006566 }
6567 if (mCategories != null) {
6568 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006569 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006570 }
6571 }
6572 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006573 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006574 }
6575 if (mFlags != 0) {
6576 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6577 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006578 if (mPackage != null) {
6579 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6580 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006581 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006582 uri.append("component=").append(Uri.encode(
6583 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006584 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006585 if (mSourceBounds != null) {
6586 uri.append("sourceBounds=")
6587 .append(Uri.encode(mSourceBounds.flattenToString()))
6588 .append(';');
6589 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006590 if (mExtras != null) {
6591 for (String key : mExtras.keySet()) {
6592 final Object value = mExtras.get(key);
6593 char entryType =
6594 value instanceof String ? 'S' :
6595 value instanceof Boolean ? 'B' :
6596 value instanceof Byte ? 'b' :
6597 value instanceof Character ? 'c' :
6598 value instanceof Double ? 'd' :
6599 value instanceof Float ? 'f' :
6600 value instanceof Integer ? 'i' :
6601 value instanceof Long ? 'l' :
6602 value instanceof Short ? 's' :
6603 '\0';
6604
6605 if (entryType != '\0') {
6606 uri.append(entryType);
6607 uri.append('.');
6608 uri.append(Uri.encode(key));
6609 uri.append('=');
6610 uri.append(Uri.encode(value.toString()));
6611 uri.append(';');
6612 }
6613 }
6614 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006615 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006616
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006617 public int describeContents() {
6618 return (mExtras != null) ? mExtras.describeContents() : 0;
6619 }
6620
6621 public void writeToParcel(Parcel out, int flags) {
6622 out.writeString(mAction);
6623 Uri.writeToParcel(out, mData);
6624 out.writeString(mType);
6625 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006626 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006627 ComponentName.writeToParcel(mComponent, out);
6628
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006629 if (mSourceBounds != null) {
6630 out.writeInt(1);
6631 mSourceBounds.writeToParcel(out, flags);
6632 } else {
6633 out.writeInt(0);
6634 }
6635
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006636 if (mCategories != null) {
6637 out.writeInt(mCategories.size());
6638 for (String category : mCategories) {
6639 out.writeString(category);
6640 }
6641 } else {
6642 out.writeInt(0);
6643 }
6644
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006645 if (mSelector != null) {
6646 out.writeInt(1);
6647 mSelector.writeToParcel(out, flags);
6648 } else {
6649 out.writeInt(0);
6650 }
6651
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006652 if (mClipData != null) {
6653 out.writeInt(1);
6654 mClipData.writeToParcel(out, flags);
6655 } else {
6656 out.writeInt(0);
6657 }
6658
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006659 out.writeBundle(mExtras);
6660 }
6661
6662 public static final Parcelable.Creator<Intent> CREATOR
6663 = new Parcelable.Creator<Intent>() {
6664 public Intent createFromParcel(Parcel in) {
6665 return new Intent(in);
6666 }
6667 public Intent[] newArray(int size) {
6668 return new Intent[size];
6669 }
6670 };
6671
Dianne Hackborneb034652009-09-07 00:49:58 -07006672 /** @hide */
6673 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006674 readFromParcel(in);
6675 }
6676
6677 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006678 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006679 mData = Uri.CREATOR.createFromParcel(in);
6680 mType = in.readString();
6681 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006682 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006683 mComponent = ComponentName.readFromParcel(in);
6684
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006685 if (in.readInt() != 0) {
6686 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6687 }
6688
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006689 int N = in.readInt();
6690 if (N > 0) {
6691 mCategories = new HashSet<String>();
6692 int i;
6693 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006694 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006695 }
6696 } else {
6697 mCategories = null;
6698 }
6699
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006700 if (in.readInt() != 0) {
6701 mSelector = new Intent(in);
6702 }
6703
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006704 if (in.readInt() != 0) {
6705 mClipData = new ClipData(in);
6706 }
6707
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006708 mExtras = in.readBundle();
6709 }
6710
6711 /**
6712 * Parses the "intent" element (and its children) from XML and instantiates
6713 * an Intent object. The given XML parser should be located at the tag
6714 * where parsing should start (often named "intent"), from which the
6715 * basic action, data, type, and package and class name will be
6716 * retrieved. The function will then parse in to any child elements,
6717 * looking for <category android:name="xxx"> tags to add categories and
6718 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6719 * to the intent.
6720 *
6721 * @param resources The Resources to use when inflating resources.
6722 * @param parser The XML parser pointing at an "intent" tag.
6723 * @param attrs The AttributeSet interface for retrieving extended
6724 * attribute data at the current <var>parser</var> location.
6725 * @return An Intent object matching the XML data.
6726 * @throws XmlPullParserException If there was an XML parsing error.
6727 * @throws IOException If there was an I/O error.
6728 */
6729 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6730 throws XmlPullParserException, IOException {
6731 Intent intent = new Intent();
6732
6733 TypedArray sa = resources.obtainAttributes(attrs,
6734 com.android.internal.R.styleable.Intent);
6735
6736 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6737
6738 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6739 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6740 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6741
6742 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6743 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6744 if (packageName != null && className != null) {
6745 intent.setComponent(new ComponentName(packageName, className));
6746 }
6747
6748 sa.recycle();
6749
6750 int outerDepth = parser.getDepth();
6751 int type;
6752 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6753 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6754 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6755 continue;
6756 }
6757
6758 String nodeName = parser.getName();
6759 if (nodeName.equals("category")) {
6760 sa = resources.obtainAttributes(attrs,
6761 com.android.internal.R.styleable.IntentCategory);
6762 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6763 sa.recycle();
6764
6765 if (cat != null) {
6766 intent.addCategory(cat);
6767 }
6768 XmlUtils.skipCurrentTag(parser);
6769
6770 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006771 if (intent.mExtras == null) {
6772 intent.mExtras = new Bundle();
6773 }
6774 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6775 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006776
6777 } else {
6778 XmlUtils.skipCurrentTag(parser);
6779 }
6780 }
6781
6782 return intent;
6783 }
Nick Pellyccae4122012-01-09 14:12:58 -08006784
6785 /**
6786 * Normalize a MIME data type.
6787 *
6788 * <p>A normalized MIME type has white-space trimmed,
6789 * content-type parameters removed, and is lower-case.
6790 * This aligns the type with Android best practices for
6791 * intent filtering.
6792 *
6793 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6794 * "text/x-vCard" becomes "text/x-vcard".
6795 *
6796 * <p>All MIME types received from outside Android (such as user input,
6797 * or external sources like Bluetooth, NFC, or the Internet) should
6798 * be normalized before they are used to create an Intent.
6799 *
6800 * @param type MIME data type to normalize
6801 * @return normalized MIME data type, or null if the input was null
6802 * @see {@link #setType}
6803 * @see {@link #setTypeAndNormalize}
6804 */
6805 public static String normalizeMimeType(String type) {
6806 if (type == null) {
6807 return null;
6808 }
6809
6810 type = type.trim().toLowerCase(Locale.US);
6811
6812 final int semicolonIndex = type.indexOf(';');
6813 if (semicolonIndex != -1) {
6814 type = type.substring(0, semicolonIndex);
6815 }
6816 return type;
6817 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006818
6819 /**
6820 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006821 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6822 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006823 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006824 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006825 * @hide
6826 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006827 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006828 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006829 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006830
6831 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006832 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006833
6834 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006835 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006836 try {
6837 // Inspect target intent to see if we need to migrate
6838 final Intent target = getParcelableExtra(EXTRA_INTENT);
6839 if (target != null && target.migrateExtraStreamToClipData()) {
6840 // Since we migrated in child, we need to promote ClipData
6841 // and flags to ourselves to grant.
6842 setClipData(target.getClipData());
6843 addFlags(target.getFlags()
6844 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6845 return true;
6846 } else {
6847 return false;
6848 }
6849 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006850 }
6851
6852 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006853 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006854 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6855 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6856 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6857 if (stream != null || text != null || htmlText != null) {
6858 final ClipData clipData = new ClipData(
6859 null, new String[] { getType() },
6860 new ClipData.Item(text, htmlText, null, stream));
6861 setClipData(clipData);
6862 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006863 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006864 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006865 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006866 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006867
6868 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006869 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006870 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6871 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6872 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6873 int num = -1;
6874 if (streams != null) {
6875 num = streams.size();
6876 }
6877 if (texts != null) {
6878 if (num >= 0 && num != texts.size()) {
6879 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006880 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006881 }
6882 num = texts.size();
6883 }
6884 if (htmlTexts != null) {
6885 if (num >= 0 && num != htmlTexts.size()) {
6886 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006887 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006888 }
6889 num = htmlTexts.size();
6890 }
6891 if (num > 0) {
6892 final ClipData clipData = new ClipData(
6893 null, new String[] { getType() },
6894 makeClipItem(streams, texts, htmlTexts, 0));
6895
6896 for (int i = 1; i < num; i++) {
6897 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6898 }
6899
6900 setClipData(clipData);
6901 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006902 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006903 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006904 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006905 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006906 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006907
6908 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006909 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006910
6911 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6912 ArrayList<String> htmlTexts, int which) {
6913 Uri uri = streams != null ? streams.get(which) : null;
6914 CharSequence text = texts != null ? texts.get(which) : null;
6915 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6916 return new ClipData.Item(text, htmlText, null, uri);
6917 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006918}