blob: c88aca80f1db2b4096d3f44ad05f253f3440b619 [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 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002234 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002235 * <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>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002253 * <p>Emergency calls cannot be intercepted using this mechanism, and
2254 * other calls cannot be modified to call emergency numbers using this
2255 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002256 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002257 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2258 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002259 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002260 * <p class="note">This is a protected intent that can only be sent
2261 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002262 */
2263 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2264 public static final String ACTION_NEW_OUTGOING_CALL =
2265 "android.intent.action.NEW_OUTGOING_CALL";
2266
2267 /**
2268 * Broadcast Action: Have the device reboot. This is only for use by
2269 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002270 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002271 * <p class="note">This is a protected intent that can only be sent
2272 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002273 */
2274 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2275 public static final String ACTION_REBOOT =
2276 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002277
Wei Huang97ecc9c2009-05-11 17:44:20 -07002278 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002279 * Broadcast Action: A sticky broadcast for changes in the physical
2280 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002281 *
2282 * <p>The intent will have the following extra values:
2283 * <ul>
2284 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002285 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002286 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002287 * <p>This is intended for monitoring the current physical dock state.
2288 * See {@link android.app.UiModeManager} for the normal API dealing with
2289 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002290 */
2291 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2292 public static final String ACTION_DOCK_EVENT =
2293 "android.intent.action.DOCK_EVENT";
2294
2295 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002296 * Broadcast Action: a remote intent is to be broadcasted.
2297 *
2298 * A remote intent is used for remote RPC between devices. The remote intent
2299 * is serialized and sent from one device to another device. The receiving
2300 * device parses the remote intent and broadcasts it. Note that anyone can
2301 * broadcast a remote intent. However, if the intent receiver of the remote intent
2302 * does not trust intent broadcasts from arbitrary intent senders, it should require
2303 * the sender to hold certain permissions so only trusted sender's broadcast will be
2304 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002305 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002306 */
2307 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002308 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002309
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002310 /**
2311 * Broadcast Action: hook for permforming cleanup after a system update.
2312 *
2313 * The broadcast is sent when the system is booting, before the
2314 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2315 * image. A receiver for this should do its work and then disable itself
2316 * so that it does not get run again at the next boot.
2317 * @hide
2318 */
2319 public static final String ACTION_PRE_BOOT_COMPLETED =
2320 "android.intent.action.PRE_BOOT_COMPLETED";
2321
Amith Yamasani13593602012-03-22 16:16:17 -07002322 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002323 * Sent the first time a user is starting, to allow system apps to
2324 * perform one time initialization. (This will not be seen by third
2325 * party applications because a newly initialized user does not have any
2326 * third party applications installed for it.) This is sent early in
2327 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002328 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2329 * broadcast, since it is part of a visible user interaction; be as quick
2330 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002331 */
2332 public static final String ACTION_USER_INITIALIZE =
2333 "android.intent.action.USER_INITIALIZE";
2334
2335 /**
2336 * Sent when a user switch is happening, causing the process's user to be
2337 * brought to the foreground. This is only sent to receivers registered
2338 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2339 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002340 * foreground. This is sent as a foreground
2341 * broadcast, since it is part of a visible user interaction; be as quick
2342 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002343 */
2344 public static final String ACTION_USER_FOREGROUND =
2345 "android.intent.action.USER_FOREGROUND";
2346
2347 /**
2348 * Sent when a user switch is happening, causing the process's user to be
2349 * sent to the background. This is only sent to receivers registered
2350 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2351 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002352 * background. This is sent as a foreground
2353 * broadcast, since it is part of a visible user interaction; be as quick
2354 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002355 */
2356 public static final String ACTION_USER_BACKGROUND =
2357 "android.intent.action.USER_BACKGROUND";
2358
2359 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002360 * Broadcast sent to the system when a user is added. Carries an extra
2361 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2362 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002363 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002364 * @hide
2365 */
2366 public static final String ACTION_USER_ADDED =
2367 "android.intent.action.USER_ADDED";
2368
2369 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002370 * Broadcast sent by the system when a user is started. Carries an extra
2371 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002372 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002373 * that has been started. This is sent as a foreground
2374 * broadcast, since it is part of a visible user interaction; be as quick
2375 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002376 * @hide
2377 */
2378 public static final String ACTION_USER_STARTED =
2379 "android.intent.action.USER_STARTED";
2380
2381 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002382 * Broadcast sent when a user is in the process of starting. Carries an extra
2383 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2384 * sent to registered receivers, not manifest receivers. It is sent to all
2385 * users (including the one that is being started). You must hold
2386 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2387 * this broadcast. This is sent as a background broadcast, since
2388 * its result is not part of the primary UX flow; to safely keep track of
2389 * started/stopped state of a user you can use this in conjunction with
2390 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2391 * other user state broadcasts since those are foreground broadcasts so can
2392 * execute in a different order.
2393 * @hide
2394 */
2395 public static final String ACTION_USER_STARTING =
2396 "android.intent.action.USER_STARTING";
2397
2398 /**
2399 * Broadcast sent when a user is going to be stopped. Carries an extra
2400 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2401 * sent to registered receivers, not manifest receivers. It is sent to all
2402 * users (including the one that is being stopped). You must hold
2403 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2404 * this broadcast. The user will not stop until all receivers have
2405 * handled the broadcast. This is sent as a background broadcast, since
2406 * its result is not part of the primary UX flow; to safely keep track of
2407 * started/stopped state of a user you can use this in conjunction with
2408 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2409 * other user state broadcasts since those are foreground broadcasts so can
2410 * execute in a different order.
2411 * @hide
2412 */
2413 public static final String ACTION_USER_STOPPING =
2414 "android.intent.action.USER_STOPPING";
2415
2416 /**
2417 * Broadcast sent to the system when a user is stopped. Carries an extra
2418 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2419 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2420 * specific package. This is only sent to registered receivers, not manifest
2421 * receivers. It is sent to all running users <em>except</em> the one that
2422 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002423 * @hide
2424 */
2425 public static final String ACTION_USER_STOPPED =
2426 "android.intent.action.USER_STOPPED";
2427
2428 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002429 * 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 -07002430 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002431 * one that has been removed. The user will not be completely removed until all receivers have
2432 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002433 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002434 * @hide
2435 */
2436 public static final String ACTION_USER_REMOVED =
2437 "android.intent.action.USER_REMOVED";
2438
2439 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002440 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002441 * the userHandle of the user to become the current one. This is only sent to
2442 * registered receivers, not manifest receivers. It is sent to all running users.
2443 * You must hold
2444 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002445 * @hide
2446 */
2447 public static final String ACTION_USER_SWITCHED =
2448 "android.intent.action.USER_SWITCHED";
2449
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002450 /**
2451 * Broadcast sent to the system when a user's information changes. Carries an extra
2452 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2453 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2454 * whose information has changed.
2455 * @hide
2456 */
2457 public static final String ACTION_USER_INFO_CHANGED =
2458 "android.intent.action.USER_INFO_CHANGED";
2459
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002460 /**
2461 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2462 */
2463 public static final String ACTION_QUICK_CLOCK =
2464 "android.intent.action.QUICK_CLOCK";
2465
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002466 // ---------------------------------------------------------------------
2467 // ---------------------------------------------------------------------
2468 // Standard intent categories (see addCategory()).
2469
2470 /**
2471 * Set if the activity should be an option for the default action
2472 * (center press) to perform on a piece of data. Setting this will
2473 * hide from the user any activities without it set when performing an
2474 * action on some data. Note that this is normal -not- set in the
2475 * Intent when initiating an action -- it is for use in intent filters
2476 * specified in packages.
2477 */
2478 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2479 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2480 /**
2481 * Activities that can be safely invoked from a browser must support this
2482 * category. For example, if the user is viewing a web page or an e-mail
2483 * and clicks on a link in the text, the Intent generated execute that
2484 * link will require the BROWSABLE category, so that only activities
2485 * supporting this category will be considered as possible actions. By
2486 * supporting this category, you are promising that there is nothing
2487 * damaging (without user intervention) that can happen by invoking any
2488 * matching Intent.
2489 */
2490 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2491 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2492 /**
2493 * Set if the activity should be considered as an alternative action to
2494 * the data the user is currently viewing. See also
2495 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2496 * applies to the selection in a list of items.
2497 *
2498 * <p>Supporting this category means that you would like your activity to be
2499 * displayed in the set of alternative things the user can do, usually as
2500 * part of the current activity's options menu. You will usually want to
2501 * include a specific label in the &lt;intent-filter&gt; of this action
2502 * describing to the user what it does.
2503 *
2504 * <p>The action of IntentFilter with this category is important in that it
2505 * describes the specific action the target will perform. This generally
2506 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2507 * a specific name such as "com.android.camera.action.CROP. Only one
2508 * alternative of any particular action will be shown to the user, so using
2509 * a specific action like this makes sure that your alternative will be
2510 * displayed while also allowing other applications to provide their own
2511 * overrides of that particular action.
2512 */
2513 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2514 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2515 /**
2516 * Set if the activity should be considered as an alternative selection
2517 * action to the data the user has currently selected. This is like
2518 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2519 * of items from which the user can select, giving them alternatives to the
2520 * default action that will be performed on it.
2521 */
2522 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2523 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2524 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002525 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002526 */
2527 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2528 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2529 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002530 * Should be displayed in the top-level launcher.
2531 */
2532 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2533 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2534 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002535 * Provides information about the package it is in; typically used if
2536 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2537 * a front-door to the user without having to be shown in the all apps list.
2538 */
2539 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2540 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2541 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002542 * This is the home activity, that is the first activity that is displayed
2543 * when the device boots.
2544 */
2545 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2546 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2547 /**
2548 * This activity is a preference panel.
2549 */
2550 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2551 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2552 /**
2553 * This activity is a development preference panel.
2554 */
2555 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2556 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2557 /**
2558 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002559 */
2560 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2561 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2562 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002563 * This activity allows the user to browse and download new applications.
2564 */
2565 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2566 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2567 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002568 * This activity may be exercised by the monkey or other automated test tools.
2569 */
2570 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2571 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2572 /**
2573 * To be used as a test (not part of the normal user experience).
2574 */
2575 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2576 /**
2577 * To be used as a unit test (run through the Test Harness).
2578 */
2579 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2580 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002581 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002582 * experience).
2583 */
2584 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2585 /**
2586 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2587 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2588 * when queried, though it is allowable for those columns to be blank.
2589 */
2590 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2591 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2592
2593 /**
2594 * To be used as code under test for framework instrumentation tests.
2595 */
2596 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2597 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002598 /**
2599 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002600 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2601 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002602 */
2603 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2604 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2605 /**
2606 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002607 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2608 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002609 */
2610 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2611 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002612 /**
2613 * An activity to run when device is inserted into a analog (low end) dock.
2614 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2615 * information, see {@link android.app.UiModeManager}.
2616 */
2617 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2618 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2619
2620 /**
2621 * An activity to run when device is inserted into a digital (high end) dock.
2622 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2623 * information, see {@link android.app.UiModeManager}.
2624 */
2625 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2626 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002627
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002628 /**
2629 * Used to indicate that the activity can be used in a car environment.
2630 */
2631 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2632 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2633
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002634 // ---------------------------------------------------------------------
2635 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002636 // Application launch intent categories (see addCategory()).
2637
2638 /**
2639 * Used with {@link #ACTION_MAIN} to launch the browser application.
2640 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002641 * <p>NOTE: This should not be used as the primary key of an Intent,
2642 * since it will not result in the app launching with the correct
2643 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002644 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002645 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002646 */
2647 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2648 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2649
2650 /**
2651 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2652 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002653 * <p>NOTE: This should not be used as the primary key of an Intent,
2654 * since it will not result in the app launching with the correct
2655 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002656 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002657 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002658 */
2659 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2660 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2661
2662 /**
2663 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2664 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002665 * <p>NOTE: This should not be used as the primary key of an Intent,
2666 * since it will not result in the app launching with the correct
2667 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002668 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002669 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002670 */
2671 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2672 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2673
2674 /**
2675 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2676 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002677 * <p>NOTE: This should not be used as the primary key of an Intent,
2678 * since it will not result in the app launching with the correct
2679 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002680 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002681 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002682 */
2683 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2684 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2685
2686 /**
2687 * Used with {@link #ACTION_MAIN} to launch the email application.
2688 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002689 * <p>NOTE: This should not be used as the primary key of an Intent,
2690 * since it will not result in the app launching with the correct
2691 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002692 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002693 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002694 */
2695 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2696 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2697
2698 /**
2699 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2700 * The activity should be able to view and manipulate image and video files
2701 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002702 * <p>NOTE: This should not be used as the primary key of an Intent,
2703 * since it will not result in the app launching with the correct
2704 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002705 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002706 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002707 */
2708 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2709 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2710
2711 /**
2712 * Used with {@link #ACTION_MAIN} to launch the maps application.
2713 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002714 * <p>NOTE: This should not be used as the primary key of an Intent,
2715 * since it will not result in the app launching with the correct
2716 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002717 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002718 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002719 */
2720 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2721 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2722
2723 /**
2724 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2725 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002726 * <p>NOTE: This should not be used as the primary key of an Intent,
2727 * since it will not result in the app launching with the correct
2728 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002729 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002730 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002731 */
2732 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2733 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2734
2735 /**
2736 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002737 * The activity should be able to play, browse, or manipulate music files
2738 * stored on the device.
2739 * <p>NOTE: This should not be used as the primary key of an Intent,
2740 * since it will not result in the app launching with the correct
2741 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002742 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002743 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002744 */
2745 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2746 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2747
2748 // ---------------------------------------------------------------------
2749 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002750 // Standard extra data keys.
2751
2752 /**
2753 * The initial data to place in a newly created record. Use with
2754 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2755 * fields as would be given to the underlying ContentProvider.insert()
2756 * call.
2757 */
2758 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2759
2760 /**
2761 * A constant CharSequence that is associated with the Intent, used with
2762 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2763 * this may be a styled CharSequence, so you must use
2764 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2765 * retrieve it.
2766 */
2767 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2768
2769 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002770 * A constant String that is associated with the Intent, used with
2771 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2772 * as HTML formatted text. Note that you <em>must</em> also supply
2773 * {@link #EXTRA_TEXT}.
2774 */
2775 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2776
2777 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002778 * A content: URI holding a stream of data associated with the Intent,
2779 * used with {@link #ACTION_SEND} to supply the data being sent.
2780 */
2781 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2782
2783 /**
2784 * A String[] holding e-mail addresses that should be delivered to.
2785 */
2786 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2787
2788 /**
2789 * A String[] holding e-mail addresses that should be carbon copied.
2790 */
2791 public static final String EXTRA_CC = "android.intent.extra.CC";
2792
2793 /**
2794 * A String[] holding e-mail addresses that should be blind carbon copied.
2795 */
2796 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2797
2798 /**
2799 * A constant string holding the desired subject line of a message.
2800 */
2801 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2802
2803 /**
2804 * An Intent describing the choices you would like shown with
2805 * {@link #ACTION_PICK_ACTIVITY}.
2806 */
2807 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2808
2809 /**
2810 * A CharSequence dialog title to provide to the user when used with a
2811 * {@link #ACTION_CHOOSER}.
2812 */
2813 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2814
2815 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002816 * A Parcelable[] of {@link Intent} or
2817 * {@link android.content.pm.LabeledIntent} objects as set with
2818 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2819 * a the front of the list of choices, when shown to the user with a
2820 * {@link #ACTION_CHOOSER}.
2821 */
2822 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2823
2824 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002825 * A {@link android.view.KeyEvent} object containing the event that
2826 * triggered the creation of the Intent it is in.
2827 */
2828 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2829
2830 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002831 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2832 * before shutting down.
2833 *
2834 * {@hide}
2835 */
2836 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2837
2838 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002839 * 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 -07002840 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2841 * of restarting the application.
2842 */
2843 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2844
2845 /**
2846 * A String holding the phone number originally entered in
2847 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2848 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2849 */
2850 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002851
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002852 /**
2853 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2854 * intents to supply the uid the package had been assigned. Also an optional
2855 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2856 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2857 * purpose.
2858 */
2859 public static final String EXTRA_UID = "android.intent.extra.UID";
2860
2861 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002862 * @hide String array of package names.
2863 */
2864 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2865
2866 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002867 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2868 * intents to indicate whether this represents a full uninstall (removing
2869 * both the code and its data) or a partial uninstall (leaving its data,
2870 * implying that this is an update).
2871 */
2872 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002873
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002874 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002875 * @hide
2876 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2877 * intents to indicate that at this point the package has been removed for
2878 * all users on the device.
2879 */
2880 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2881 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2882
2883 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002884 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2885 * intents to indicate that this is a replacement of the package, so this
2886 * broadcast will immediately be followed by an add broadcast for a
2887 * different version of the same package.
2888 */
2889 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002890
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002891 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002892 * Used as an int extra field in {@link android.app.AlarmManager} intents
2893 * to tell the application being invoked how many pending alarms are being
2894 * delievered with the intent. For one-shot alarms this will always be 1.
2895 * For recurring alarms, this might be greater than 1 if the device was
2896 * asleep or powered off at the time an earlier alarm would have been
2897 * delivered.
2898 */
2899 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002900
Jacek Surazski86b6c532009-05-13 14:38:28 +02002901 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002902 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2903 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002904 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2905 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002906 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2907 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2908 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002909 */
2910 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2911
2912 /**
2913 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2914 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002915 */
2916 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2917
2918 /**
2919 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2920 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002921 */
2922 public static final int EXTRA_DOCK_STATE_DESK = 1;
2923
2924 /**
2925 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2926 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002927 */
2928 public static final int EXTRA_DOCK_STATE_CAR = 2;
2929
2930 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002931 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2932 * to represent that the phone is in a analog (low end) dock.
2933 */
2934 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2935
2936 /**
2937 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2938 * to represent that the phone is in a digital (high end) dock.
2939 */
2940 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2941
2942 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002943 * Boolean that can be supplied as meta-data with a dock activity, to
2944 * indicate that the dock should take over the home key when it is active.
2945 */
2946 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002947
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002948 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002949 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2950 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002951 */
2952 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2953
2954 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002955 * Used in the extra field in the remote intent. It's astring token passed with the
2956 * remote intent.
2957 */
2958 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2959 "android.intent.extra.remote_intent_token";
2960
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002961 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002962 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002963 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002964 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002965 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002966 "android.intent.extra.changed_component_name";
2967
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002968 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002969 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002970 * and contains a string array of all of the components that have changed.
2971 */
2972 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2973 "android.intent.extra.changed_component_name_list";
2974
2975 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002976 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002977 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2978 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002979 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002980 */
2981 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2982 "android.intent.extra.changed_package_list";
2983
2984 /**
2985 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002986 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2987 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002988 * and contains an integer array of uids of all of the components
2989 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002990 */
2991 public static final String EXTRA_CHANGED_UID_LIST =
2992 "android.intent.extra.changed_uid_list";
2993
2994 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002995 * @hide
2996 * Magic extra system code can use when binding, to give a label for
2997 * who it is that has bound to a service. This is an integer giving
2998 * a framework string resource that can be displayed to the user.
2999 */
3000 public static final String EXTRA_CLIENT_LABEL =
3001 "android.intent.extra.client_label";
3002
3003 /**
3004 * @hide
3005 * Magic extra system code can use when binding, to give a PendingIntent object
3006 * that can be launched for the user to disable the system's use of this
3007 * service.
3008 */
3009 public static final String EXTRA_CLIENT_INTENT =
3010 "android.intent.extra.client_intent";
3011
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003012 /**
3013 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3014 * data that is on the local device. This is a boolean extra; the default
3015 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3016 * the user to select media that is already on the device, not requiring it
3017 * be downloaded from a remote service when opened. Another way to look
3018 * at it is that such content should generally have a "_data" column to the
3019 * path of the content on local external storage.
3020 */
3021 public static final String EXTRA_LOCAL_ONLY =
3022 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003023
Amith Yamasani13593602012-03-22 16:16:17 -07003024 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003025 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003026 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3027 * @hide
3028 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003029 public static final String EXTRA_USER_HANDLE =
3030 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003031
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003032 // ---------------------------------------------------------------------
3033 // ---------------------------------------------------------------------
3034 // Intent flags (see mFlags variable).
3035
3036 /**
3037 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003038 * perform read operations on the Uri in the Intent's data and any URIs
3039 * specified in its ClipData. When applying to an Intent's ClipData,
3040 * all URIs as well as recursive traversals through data or other ClipData
3041 * in Intent items will be granted; only the grant flags of the top-level
3042 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003043 */
3044 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3045 /**
3046 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003047 * perform write operations on the Uri in the Intent's data and any URIs
3048 * specified in its ClipData. When applying to an Intent's ClipData,
3049 * all URIs as well as recursive traversals through data or other ClipData
3050 * in Intent items will be granted; only the grant flags of the top-level
3051 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003052 */
3053 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3054 /**
3055 * Can be set by the caller to indicate that this Intent is coming from
3056 * a background operation, not from direct user interaction.
3057 */
3058 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3059 /**
3060 * A flag you can enable for debugging: when set, log messages will be
3061 * printed during the resolution of this intent to show you what has
3062 * been found to create the final resolved list.
3063 */
3064 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003065 /**
3066 * If set, this intent will not match any components in packages that
3067 * are currently stopped. If this is not set, then the default behavior
3068 * is to include such applications in the result.
3069 */
3070 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3071 /**
3072 * If set, this intent will always match any components in packages that
3073 * are currently stopped. This is the default behavior when
3074 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3075 * flags are set, this one wins (it allows overriding of exclude for
3076 * places where the framework may automatically set the exclude flag).
3077 */
3078 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003079
3080 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003081 * If set, the new activity is not kept in the history stack. As soon as
3082 * the user navigates away from it, the activity is finished. This may also
3083 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3084 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003085 */
3086 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3087 /**
3088 * If set, the activity will not be launched if it is already running
3089 * at the top of the history stack.
3090 */
3091 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3092 /**
3093 * If set, this activity will become the start of a new task on this
3094 * history stack. A task (from the activity that started it to the
3095 * next task activity) defines an atomic group of activities that the
3096 * user can move to. Tasks can be moved to the foreground and background;
3097 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003098 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003099 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3100 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003101 *
3102 * <p>This flag is generally used by activities that want
3103 * to present a "launcher" style behavior: they give the user a list of
3104 * separate things that can be done, which otherwise run completely
3105 * independently of the activity launching them.
3106 *
3107 * <p>When using this flag, if a task is already running for the activity
3108 * you are now starting, then a new activity will not be started; instead,
3109 * the current task will simply be brought to the front of the screen with
3110 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3111 * to disable this behavior.
3112 *
3113 * <p>This flag can not be used when the caller is requesting a result from
3114 * the activity being launched.
3115 */
3116 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3117 /**
3118 * <strong>Do not use this flag unless you are implementing your own
3119 * top-level application launcher.</strong> Used in conjunction with
3120 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3121 * behavior of bringing an existing task to the foreground. When set,
3122 * a new task is <em>always</em> started to host the Activity for the
3123 * Intent, regardless of whether there is already an existing task running
3124 * the same thing.
3125 *
3126 * <p><strong>Because the default system does not include graphical task management,
3127 * you should not use this flag unless you provide some way for a user to
3128 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003129 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003130 * <p>This flag is ignored if
3131 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3132 *
Scott Main7aee61f2011-02-08 11:25:01 -08003133 * <p>See
3134 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3135 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003136 */
3137 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3138 /**
3139 * If set, and the activity being launched is already running in the
3140 * current task, then instead of launching a new instance of that activity,
3141 * all of the other activities on top of it will be closed and this Intent
3142 * will be delivered to the (now on top) old activity as a new Intent.
3143 *
3144 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3145 * If D calls startActivity() with an Intent that resolves to the component
3146 * of activity B, then C and D will be finished and B receive the given
3147 * Intent, resulting in the stack now being: A, B.
3148 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003149 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003150 * either receive the new intent you are starting here in its
3151 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003152 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003153 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3154 * the same intent, then it will be finished and re-created; for all other
3155 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3156 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003157 *
3158 * <p>This launch mode can also be used to good effect in conjunction with
3159 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3160 * of a task, it will bring any currently running instance of that task
3161 * to the foreground, and then clear it to its root state. This is
3162 * especially useful, for example, when launching an activity from the
3163 * notification manager.
3164 *
Scott Main7aee61f2011-02-08 11:25:01 -08003165 * <p>See
3166 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3167 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003168 */
3169 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3170 /**
3171 * If set and this intent is being used to launch a new activity from an
3172 * existing one, then the reply target of the existing activity will be
3173 * transfered to the new activity. This way the new activity can call
3174 * {@link android.app.Activity#setResult} and have that result sent back to
3175 * the reply target of the original activity.
3176 */
3177 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3178 /**
3179 * If set and this intent is being used to launch a new activity from an
3180 * existing one, the current activity will not be counted as the top
3181 * activity for deciding whether the new intent should be delivered to
3182 * the top instead of starting a new one. The previous activity will
3183 * be used as the top, with the assumption being that the current activity
3184 * will finish itself immediately.
3185 */
3186 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3187 /**
3188 * If set, the new activity is not kept in the list of recently launched
3189 * activities.
3190 */
3191 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3192 /**
3193 * This flag is not normally set by application code, but set for you by
3194 * the system as described in the
3195 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3196 * launchMode} documentation for the singleTask mode.
3197 */
3198 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3199 /**
3200 * If set, and this activity is either being started in a new task or
3201 * bringing to the top an existing task, then it will be launched as
3202 * the front door of the task. This will result in the application of
3203 * any affinities needed to have that task in the proper state (either
3204 * moving activities to or from it), or simply resetting that task to
3205 * its initial state if needed.
3206 */
3207 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3208 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003209 * This flag is not normally set by application code, but set for you by
3210 * the system if this activity is being launched from history
3211 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003212 */
3213 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003214 /**
3215 * If set, this marks a point in the task's activity stack that should
3216 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003217 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003218 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3219 * the user re-launching it from home), this activity and all on top of
3220 * it will be finished so that the user does not return to them, but
3221 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003222 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003223 * <p>This is useful for cases where you have a logical break in your
3224 * application. For example, an e-mail application may have a command
3225 * to view an attachment, which launches an image view activity to
3226 * display it. This activity should be part of the e-mail application's
3227 * task, since it is a part of the task the user is involved in. However,
3228 * if the user leaves that task, and later selects the e-mail app from
3229 * home, we may like them to return to the conversation they were
3230 * viewing, not the picture attachment, since that is confusing. By
3231 * setting this flag when launching the image viewer, that viewer and
3232 * any activities it starts will be removed the next time the user returns
3233 * to mail.
3234 */
3235 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003236 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003237 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003238 * callback from occurring on the current frontmost activity before it is
3239 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003240 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003241 * <p>Typically, an activity can rely on that callback to indicate that an
3242 * explicit user action has caused their activity to be moved out of the
3243 * foreground. The callback marks an appropriate point in the activity's
3244 * lifecycle for it to dismiss any notifications that it intends to display
3245 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003246 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003247 * <p>If an activity is ever started via any non-user-driven events such as
3248 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3249 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003250 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003251 */
3252 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003253 /**
3254 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3255 * this flag will cause the launched activity to be brought to the front of its
3256 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003257 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003258 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3259 * If D calls startActivity() with an Intent that resolves to the component
3260 * of activity B, then B will be brought to the front of the history stack,
3261 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003262 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003263 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003264 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003265 */
3266 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003267 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003268 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3269 * this flag will prevent the system from applying an activity transition
3270 * animation to go to the next activity state. This doesn't mean an
3271 * animation will never run -- if another activity change happens that doesn't
3272 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003273 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003274 * when you are going to do a series of activity operations but the
3275 * animation seen by the user shouldn't be driven by the first activity
3276 * change but rather a later one.
3277 */
3278 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3279 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003280 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3281 * this flag will cause any existing task that would be associated with the
3282 * activity to be cleared before the activity is started. That is, the activity
3283 * becomes the new root of an otherwise empty task, and any old activities
3284 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3285 */
3286 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3287 /**
3288 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3289 * this flag will cause a newly launching task to be placed on top of the current
3290 * home activity task (if there is one). That is, pressing back from the task
3291 * will always return the user to home even if that was not the last activity they
3292 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3293 */
3294 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3295 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003296 * If set, when sending a broadcast only registered receivers will be
3297 * called -- no BroadcastReceiver components will be launched.
3298 */
3299 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003300 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003301 * If set, when sending a broadcast the new broadcast will replace
3302 * any existing pending broadcast that matches it. Matching is defined
3303 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3304 * true for the intents of the two broadcasts. When a match is found,
3305 * the new broadcast (and receivers associated with it) will replace the
3306 * existing one in the pending broadcast list, remaining at the same
3307 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003308 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003309 * <p>This flag is most typically used with sticky broadcasts, which
3310 * only care about delivering the most recent values of the broadcast
3311 * to their receivers.
3312 */
3313 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3314 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003315 * If set, when sending a broadcast the recipient is allowed to run at
3316 * foreground priority, with a shorter timeout interval. During normal
3317 * broadcasts the receivers are not automatically hoisted out of the
3318 * background priority class.
3319 */
3320 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3321 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003322 * If set, when sending a broadcast <i>before boot has completed</i> only
3323 * registered receivers will be called -- no BroadcastReceiver components
3324 * will be launched. Sticky intent state will be recorded properly even
3325 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3326 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003327 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003328 * <p>This flag is only for use by system sevices as a convenience to
3329 * avoid having to implement a more complex mechanism around detection
3330 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003331 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003332 * @hide
3333 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003334 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003335 /**
3336 * Set when this broadcast is for a boot upgrade, a special mode that
3337 * allows the broadcast to be sent before the system is ready and launches
3338 * the app process with no providers running in it.
3339 * @hide
3340 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003341 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003342
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003343 /**
3344 * @hide Flags that can't be changed with PendingIntent.
3345 */
3346 public static final int IMMUTABLE_FLAGS =
3347 FLAG_GRANT_READ_URI_PERMISSION
3348 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003349
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003350 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003351 // ---------------------------------------------------------------------
3352 // toUri() and parseUri() options.
3353
3354 /**
3355 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3356 * always has the "intent:" scheme. This syntax can be used when you want
3357 * to later disambiguate between URIs that are intended to describe an
3358 * Intent vs. all others that should be treated as raw URIs. When used
3359 * with {@link #parseUri}, any other scheme will result in a generic
3360 * VIEW action for that raw URI.
3361 */
3362 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003363
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003364 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003365
3366 private String mAction;
3367 private Uri mData;
3368 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003369 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003370 private ComponentName mComponent;
3371 private int mFlags;
3372 private HashSet<String> mCategories;
3373 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003374 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003375 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003376 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003377
3378 // ---------------------------------------------------------------------
3379
3380 /**
3381 * Create an empty intent.
3382 */
3383 public Intent() {
3384 }
3385
3386 /**
3387 * Copy constructor.
3388 */
3389 public Intent(Intent o) {
3390 this.mAction = o.mAction;
3391 this.mData = o.mData;
3392 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003393 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003394 this.mComponent = o.mComponent;
3395 this.mFlags = o.mFlags;
3396 if (o.mCategories != null) {
3397 this.mCategories = new HashSet<String>(o.mCategories);
3398 }
3399 if (o.mExtras != null) {
3400 this.mExtras = new Bundle(o.mExtras);
3401 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003402 if (o.mSourceBounds != null) {
3403 this.mSourceBounds = new Rect(o.mSourceBounds);
3404 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003405 if (o.mSelector != null) {
3406 this.mSelector = new Intent(o.mSelector);
3407 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003408 if (o.mClipData != null) {
3409 this.mClipData = new ClipData(o.mClipData);
3410 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003411 }
3412
3413 @Override
3414 public Object clone() {
3415 return new Intent(this);
3416 }
3417
3418 private Intent(Intent o, boolean all) {
3419 this.mAction = o.mAction;
3420 this.mData = o.mData;
3421 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003422 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003423 this.mComponent = o.mComponent;
3424 if (o.mCategories != null) {
3425 this.mCategories = new HashSet<String>(o.mCategories);
3426 }
3427 }
3428
3429 /**
3430 * Make a clone of only the parts of the Intent that are relevant for
3431 * filter matching: the action, data, type, component, and categories.
3432 */
3433 public Intent cloneFilter() {
3434 return new Intent(this, false);
3435 }
3436
3437 /**
3438 * Create an intent with a given action. All other fields (data, type,
3439 * class) are null. Note that the action <em>must</em> be in a
3440 * namespace because Intents are used globally in the system -- for
3441 * example the system VIEW action is android.intent.action.VIEW; an
3442 * application's custom action would be something like
3443 * com.google.app.myapp.CUSTOM_ACTION.
3444 *
3445 * @param action The Intent action, such as ACTION_VIEW.
3446 */
3447 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003448 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003449 }
3450
3451 /**
3452 * Create an intent with a given action and for a given data url. Note
3453 * that the action <em>must</em> be in a namespace because Intents are
3454 * used globally in the system -- for example the system VIEW action is
3455 * android.intent.action.VIEW; an application's custom action would be
3456 * something like com.google.app.myapp.CUSTOM_ACTION.
3457 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003458 * <p><em>Note: scheme and host name matching in the Android framework is
3459 * case-sensitive, unlike the formal RFC. As a result,
3460 * you should always ensure that you write your Uri with these elements
3461 * using lower case letters, and normalize any Uris you receive from
3462 * outside of Android to ensure the scheme and host is lower case.</em></p>
3463 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003464 * @param action The Intent action, such as ACTION_VIEW.
3465 * @param uri The Intent data URI.
3466 */
3467 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003468 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003469 mData = uri;
3470 }
3471
3472 /**
3473 * Create an intent for a specific component. All other fields (action, data,
3474 * type, class) are null, though they can be modified later with explicit
3475 * calls. This provides a convenient way to create an intent that is
3476 * intended to execute a hard-coded class name, rather than relying on the
3477 * system to find an appropriate class for you; see {@link #setComponent}
3478 * for more information on the repercussions of this.
3479 *
3480 * @param packageContext A Context of the application package implementing
3481 * this class.
3482 * @param cls The component class that is to be used for the intent.
3483 *
3484 * @see #setClass
3485 * @see #setComponent
3486 * @see #Intent(String, android.net.Uri , Context, Class)
3487 */
3488 public Intent(Context packageContext, Class<?> cls) {
3489 mComponent = new ComponentName(packageContext, cls);
3490 }
3491
3492 /**
3493 * Create an intent for a specific component with a specified action and data.
3494 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3495 * construct the Intent and then calling {@link #setClass} to set its
3496 * class.
3497 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003498 * <p><em>Note: scheme and host name matching in the Android framework is
3499 * case-sensitive, unlike the formal RFC. As a result,
3500 * you should always ensure that you write your Uri with these elements
3501 * using lower case letters, and normalize any Uris you receive from
3502 * outside of Android to ensure the scheme and host is lower case.</em></p>
3503 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003504 * @param action The Intent action, such as ACTION_VIEW.
3505 * @param uri The Intent data URI.
3506 * @param packageContext A Context of the application package implementing
3507 * this class.
3508 * @param cls The component class that is to be used for the intent.
3509 *
3510 * @see #Intent(String, android.net.Uri)
3511 * @see #Intent(Context, Class)
3512 * @see #setClass
3513 * @see #setComponent
3514 */
3515 public Intent(String action, Uri uri,
3516 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003517 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003518 mData = uri;
3519 mComponent = new ComponentName(packageContext, cls);
3520 }
3521
3522 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003523 * Create an intent to launch the main (root) activity of a task. This
3524 * is the Intent that is started when the application's is launched from
3525 * Home. For anything else that wants to launch an application in the
3526 * same way, it is important that they use an Intent structured the same
3527 * way, and can use this function to ensure this is the case.
3528 *
3529 * <p>The returned Intent has the given Activity component as its explicit
3530 * component, {@link #ACTION_MAIN} as its action, and includes the
3531 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3532 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3533 * to do that through {@link #addFlags(int)} on the returned Intent.
3534 *
3535 * @param mainActivity The main activity component that this Intent will
3536 * launch.
3537 * @return Returns a newly created Intent that can be used to launch the
3538 * activity as a main application entry.
3539 *
3540 * @see #setClass
3541 * @see #setComponent
3542 */
3543 public static Intent makeMainActivity(ComponentName mainActivity) {
3544 Intent intent = new Intent(ACTION_MAIN);
3545 intent.setComponent(mainActivity);
3546 intent.addCategory(CATEGORY_LAUNCHER);
3547 return intent;
3548 }
3549
3550 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003551 * Make an Intent for the main activity of an application, without
3552 * specifying a specific activity to run but giving a selector to find
3553 * the activity. This results in a final Intent that is structured
3554 * the same as when the application is launched from
3555 * Home. For anything else that wants to launch an application in the
3556 * same way, it is important that they use an Intent structured the same
3557 * way, and can use this function to ensure this is the case.
3558 *
3559 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3560 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3561 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3562 * to do that through {@link #addFlags(int)} on the returned Intent.
3563 *
3564 * @param selectorAction The action name of the Intent's selector.
3565 * @param selectorCategory The name of a category to add to the Intent's
3566 * selector.
3567 * @return Returns a newly created Intent that can be used to launch the
3568 * activity as a main application entry.
3569 *
3570 * @see #setSelector(Intent)
3571 */
3572 public static Intent makeMainSelectorActivity(String selectorAction,
3573 String selectorCategory) {
3574 Intent intent = new Intent(ACTION_MAIN);
3575 intent.addCategory(CATEGORY_LAUNCHER);
3576 Intent selector = new Intent();
3577 selector.setAction(selectorAction);
3578 selector.addCategory(selectorCategory);
3579 intent.setSelector(selector);
3580 return intent;
3581 }
3582
3583 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003584 * Make an Intent that can be used to re-launch an application's task
3585 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3586 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3587 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3588 *
3589 * @param mainActivity The activity component that is the root of the
3590 * task; this is the activity that has been published in the application's
3591 * manifest as the main launcher icon.
3592 *
3593 * @return Returns a newly created Intent that can be used to relaunch the
3594 * activity's task in its root state.
3595 */
3596 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3597 Intent intent = makeMainActivity(mainActivity);
3598 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3599 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3600 return intent;
3601 }
3602
3603 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003604 * Call {@link #parseUri} with 0 flags.
3605 * @deprecated Use {@link #parseUri} instead.
3606 */
3607 @Deprecated
3608 public static Intent getIntent(String uri) throws URISyntaxException {
3609 return parseUri(uri, 0);
3610 }
Tom Taylord4a47292009-12-21 13:59:18 -08003611
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003612 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003614 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003615 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003616 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003617 *
3618 * <p>The URI given here must not be relative -- that is, it must include
3619 * the scheme and full path.
3620 *
3621 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003622 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003623 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003624 *
3625 * @return Intent The newly created Intent object.
3626 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003627 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3628 * it bad (as parsed by the Uri class) or the Intent data within the
3629 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003630 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003631 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003632 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003633 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 int i = 0;
3635 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003636 // Validate intent scheme for if requested.
3637 if ((flags&URI_INTENT_SCHEME) != 0) {
3638 if (!uri.startsWith("intent:")) {
3639 Intent intent = new Intent(ACTION_VIEW);
3640 try {
3641 intent.setData(Uri.parse(uri));
3642 } catch (IllegalArgumentException e) {
3643 throw new URISyntaxException(uri, e.getMessage());
3644 }
3645 return intent;
3646 }
3647 }
Tom Taylord4a47292009-12-21 13:59:18 -08003648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003649 // simple case
3650 i = uri.lastIndexOf("#");
3651 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3652
3653 // old format Intent URI
3654 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003656 // new format
3657 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003658 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003659
3660 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003661 String data = i >= 0 ? uri.substring(0, i) : null;
3662 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003664
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003665 // loop over contents of Intent, all name=value;
3666 while (!uri.startsWith("end", i)) {
3667 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003668 if (eq < 0) eq = i-1;
3669 int semi = uri.indexOf(';', i);
3670 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003671
3672 // action
3673 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003674 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003675 }
3676
3677 // categories
3678 else if (uri.startsWith("category=", i)) {
3679 intent.addCategory(value);
3680 }
3681
3682 // type
3683 else if (uri.startsWith("type=", i)) {
3684 intent.mType = value;
3685 }
3686
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003687 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003688 else if (uri.startsWith("launchFlags=", i)) {
3689 intent.mFlags = Integer.decode(value).intValue();
3690 }
3691
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003692 // package
3693 else if (uri.startsWith("package=", i)) {
3694 intent.mPackage = value;
3695 }
3696
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003697 // component
3698 else if (uri.startsWith("component=", i)) {
3699 intent.mComponent = ComponentName.unflattenFromString(value);
3700 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003701
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003702 // scheme
3703 else if (uri.startsWith("scheme=", i)) {
3704 scheme = value;
3705 }
3706
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003707 // source bounds
3708 else if (uri.startsWith("sourceBounds=", i)) {
3709 intent.mSourceBounds = Rect.unflattenFromString(value);
3710 }
3711
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003712 // selector
3713 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3714 intent = new Intent();
3715 }
3716
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003717 // extra
3718 else {
3719 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003720 // create Bundle if it doesn't already exist
3721 if (intent.mExtras == null) intent.mExtras = new Bundle();
3722 Bundle b = intent.mExtras;
3723 // add EXTRA
3724 if (uri.startsWith("S.", i)) b.putString(key, value);
3725 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3726 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3727 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3728 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3729 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3730 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3731 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3732 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3733 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3734 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003735
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003736 // move to the next item
3737 i = semi + 1;
3738 }
3739
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003740 if (intent != baseIntent) {
3741 // The Intent had a selector; fix it up.
3742 baseIntent.setSelector(intent);
3743 intent = baseIntent;
3744 }
3745
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003746 if (data != null) {
3747 if (data.startsWith("intent:")) {
3748 data = data.substring(7);
3749 if (scheme != null) {
3750 data = scheme + ':' + data;
3751 }
3752 }
Tom Taylord4a47292009-12-21 13:59:18 -08003753
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003754 if (data.length() > 0) {
3755 try {
3756 intent.mData = Uri.parse(data);
3757 } catch (IllegalArgumentException e) {
3758 throw new URISyntaxException(uri, e.getMessage());
3759 }
3760 }
3761 }
Tom Taylord4a47292009-12-21 13:59:18 -08003762
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003763 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003764
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003765 } catch (IndexOutOfBoundsException e) {
3766 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3767 }
3768 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003769
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003770 public static Intent getIntentOld(String uri) throws URISyntaxException {
3771 Intent intent;
3772
3773 int i = uri.lastIndexOf('#');
3774 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003775 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003776 final int intentFragmentStart = i;
3777 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003778
3779 i++;
3780
3781 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003782 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003783 i += 7;
3784 int j = uri.indexOf(')', i);
3785 action = uri.substring(i, j);
3786 i = j + 1;
3787 }
3788
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003789 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003790
3791 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003792 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003793 i += 11;
3794 int j = uri.indexOf(')', i);
3795 while (i < j) {
3796 int sep = uri.indexOf('!', i);
3797 if (sep < 0) sep = j;
3798 if (i < sep) {
3799 intent.addCategory(uri.substring(i, sep));
3800 }
3801 i = sep + 1;
3802 }
3803 i = j + 1;
3804 }
3805
3806 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003807 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003808 i += 5;
3809 int j = uri.indexOf(')', i);
3810 intent.mType = uri.substring(i, j);
3811 i = j + 1;
3812 }
3813
3814 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003815 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003816 i += 12;
3817 int j = uri.indexOf(')', i);
3818 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3819 i = j + 1;
3820 }
3821
3822 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003823 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003824 i += 10;
3825 int j = uri.indexOf(')', i);
3826 int sep = uri.indexOf('!', i);
3827 if (sep >= 0 && sep < j) {
3828 String pkg = uri.substring(i, sep);
3829 String cls = uri.substring(sep + 1, j);
3830 intent.mComponent = new ComponentName(pkg, cls);
3831 }
3832 i = j + 1;
3833 }
3834
3835 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003836 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003837 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003838
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003839 final int closeParen = uri.indexOf(')', i);
3840 if (closeParen == -1) throw new URISyntaxException(uri,
3841 "EXTRA missing trailing ')'", i);
3842
3843 while (i < closeParen) {
3844 // fetch the key value
3845 int j = uri.indexOf('=', i);
3846 if (j <= i + 1 || i >= closeParen) {
3847 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3848 }
3849 char type = uri.charAt(i);
3850 i++;
3851 String key = uri.substring(i, j);
3852 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003853
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003854 // get type-value
3855 j = uri.indexOf('!', i);
3856 if (j == -1 || j >= closeParen) j = closeParen;
3857 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3858 String value = uri.substring(i, j);
3859 i = j;
3860
3861 // create Bundle if it doesn't already exist
3862 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003863
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003864 // add item to bundle
3865 try {
3866 switch (type) {
3867 case 'S':
3868 intent.mExtras.putString(key, Uri.decode(value));
3869 break;
3870 case 'B':
3871 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3872 break;
3873 case 'b':
3874 intent.mExtras.putByte(key, Byte.parseByte(value));
3875 break;
3876 case 'c':
3877 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3878 break;
3879 case 'd':
3880 intent.mExtras.putDouble(key, Double.parseDouble(value));
3881 break;
3882 case 'f':
3883 intent.mExtras.putFloat(key, Float.parseFloat(value));
3884 break;
3885 case 'i':
3886 intent.mExtras.putInt(key, Integer.parseInt(value));
3887 break;
3888 case 'l':
3889 intent.mExtras.putLong(key, Long.parseLong(value));
3890 break;
3891 case 's':
3892 intent.mExtras.putShort(key, Short.parseShort(value));
3893 break;
3894 default:
3895 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3896 }
3897 } catch (NumberFormatException e) {
3898 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3899 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003900
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003901 char ch = uri.charAt(i);
3902 if (ch == ')') break;
3903 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3904 i++;
3905 }
3906 }
3907
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003908 if (isIntentFragment) {
3909 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3910 } else {
3911 intent.mData = Uri.parse(uri);
3912 }
Tom Taylord4a47292009-12-21 13:59:18 -08003913
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003914 if (intent.mAction == null) {
3915 // By default, if no action is specified, then use VIEW.
3916 intent.mAction = ACTION_VIEW;
3917 }
3918
3919 } else {
3920 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3921 }
3922
3923 return intent;
3924 }
3925
3926 /**
3927 * Retrieve the general action to be performed, such as
3928 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3929 * the information in the intent should be interpreted -- most importantly,
3930 * what to do with the data returned by {@link #getData}.
3931 *
3932 * @return The action of this intent or null if none is specified.
3933 *
3934 * @see #setAction
3935 */
3936 public String getAction() {
3937 return mAction;
3938 }
3939
3940 /**
3941 * Retrieve data this intent is operating on. This URI specifies the name
3942 * of the data; often it uses the content: scheme, specifying data in a
3943 * content provider. Other schemes may be handled by specific activities,
3944 * such as http: by the web browser.
3945 *
3946 * @return The URI of the data this intent is targeting or null.
3947 *
3948 * @see #getScheme
3949 * @see #setData
3950 */
3951 public Uri getData() {
3952 return mData;
3953 }
3954
3955 /**
3956 * The same as {@link #getData()}, but returns the URI as an encoded
3957 * String.
3958 */
3959 public String getDataString() {
3960 return mData != null ? mData.toString() : null;
3961 }
3962
3963 /**
3964 * Return the scheme portion of the intent's data. If the data is null or
3965 * does not include a scheme, null is returned. Otherwise, the scheme
3966 * prefix without the final ':' is returned, i.e. "http".
3967 *
3968 * <p>This is the same as calling getData().getScheme() (and checking for
3969 * null data).
3970 *
3971 * @return The scheme of this intent.
3972 *
3973 * @see #getData
3974 */
3975 public String getScheme() {
3976 return mData != null ? mData.getScheme() : null;
3977 }
3978
3979 /**
3980 * Retrieve any explicit MIME type included in the intent. This is usually
3981 * null, as the type is determined by the intent data.
3982 *
3983 * @return If a type was manually set, it is returned; else null is
3984 * returned.
3985 *
3986 * @see #resolveType(ContentResolver)
3987 * @see #setType
3988 */
3989 public String getType() {
3990 return mType;
3991 }
3992
3993 /**
3994 * Return the MIME data type of this intent. If the type field is
3995 * explicitly set, that is simply returned. Otherwise, if the data is set,
3996 * the type of that data is returned. If neither fields are set, a null is
3997 * returned.
3998 *
3999 * @return The MIME type of this intent.
4000 *
4001 * @see #getType
4002 * @see #resolveType(ContentResolver)
4003 */
4004 public String resolveType(Context context) {
4005 return resolveType(context.getContentResolver());
4006 }
4007
4008 /**
4009 * Return the MIME data type of this intent. If the type field is
4010 * explicitly set, that is simply returned. Otherwise, if the data is set,
4011 * the type of that data is returned. If neither fields are set, a null is
4012 * returned.
4013 *
4014 * @param resolver A ContentResolver that can be used to determine the MIME
4015 * type of the intent's data.
4016 *
4017 * @return The MIME type of this intent.
4018 *
4019 * @see #getType
4020 * @see #resolveType(Context)
4021 */
4022 public String resolveType(ContentResolver resolver) {
4023 if (mType != null) {
4024 return mType;
4025 }
4026 if (mData != null) {
4027 if ("content".equals(mData.getScheme())) {
4028 return resolver.getType(mData);
4029 }
4030 }
4031 return null;
4032 }
4033
4034 /**
4035 * Return the MIME data type of this intent, only if it will be needed for
4036 * intent resolution. This is not generally useful for application code;
4037 * it is used by the frameworks for communicating with back-end system
4038 * services.
4039 *
4040 * @param resolver A ContentResolver that can be used to determine the MIME
4041 * type of the intent's data.
4042 *
4043 * @return The MIME type of this intent, or null if it is unknown or not
4044 * needed.
4045 */
4046 public String resolveTypeIfNeeded(ContentResolver resolver) {
4047 if (mComponent != null) {
4048 return mType;
4049 }
4050 return resolveType(resolver);
4051 }
4052
4053 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004054 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004055 *
4056 * @param category The category to check.
4057 *
4058 * @return boolean True if the intent contains the category, else false.
4059 *
4060 * @see #getCategories
4061 * @see #addCategory
4062 */
4063 public boolean hasCategory(String category) {
4064 return mCategories != null && mCategories.contains(category);
4065 }
4066
4067 /**
4068 * Return the set of all categories in the intent. If there are no categories,
4069 * returns NULL.
4070 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004071 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004072 *
4073 * @see #hasCategory
4074 * @see #addCategory
4075 */
4076 public Set<String> getCategories() {
4077 return mCategories;
4078 }
4079
4080 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004081 * Return the specific selector associated with this Intent. If there is
4082 * none, returns null. See {@link #setSelector} for more information.
4083 *
4084 * @see #setSelector
4085 */
4086 public Intent getSelector() {
4087 return mSelector;
4088 }
4089
4090 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004091 * Return the {@link ClipData} associated with this Intent. If there is
4092 * none, returns null. See {@link #setClipData} for more information.
4093 *
4094 * @see #setClipData;
4095 */
4096 public ClipData getClipData() {
4097 return mClipData;
4098 }
4099
4100 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004101 * Sets the ClassLoader that will be used when unmarshalling
4102 * any Parcelable values from the extras of this Intent.
4103 *
4104 * @param loader a ClassLoader, or null to use the default loader
4105 * at the time of unmarshalling.
4106 */
4107 public void setExtrasClassLoader(ClassLoader loader) {
4108 if (mExtras != null) {
4109 mExtras.setClassLoader(loader);
4110 }
4111 }
4112
4113 /**
4114 * Returns true if an extra value is associated with the given name.
4115 * @param name the extra's name
4116 * @return true if the given extra is present.
4117 */
4118 public boolean hasExtra(String name) {
4119 return mExtras != null && mExtras.containsKey(name);
4120 }
4121
4122 /**
4123 * Returns true if the Intent's extras contain a parcelled file descriptor.
4124 * @return true if the Intent contains a parcelled file descriptor.
4125 */
4126 public boolean hasFileDescriptors() {
4127 return mExtras != null && mExtras.hasFileDescriptors();
4128 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004129
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004130 /** @hide */
4131 public void setAllowFds(boolean allowFds) {
4132 if (mExtras != null) {
4133 mExtras.setAllowFds(allowFds);
4134 }
4135 }
4136
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004137 /**
4138 * Retrieve extended data from the intent.
4139 *
4140 * @param name The name of the desired item.
4141 *
4142 * @return the value of an item that previously added with putExtra()
4143 * or null if none was found.
4144 *
4145 * @deprecated
4146 * @hide
4147 */
4148 @Deprecated
4149 public Object getExtra(String name) {
4150 return getExtra(name, null);
4151 }
4152
4153 /**
4154 * Retrieve extended data from the intent.
4155 *
4156 * @param name The name of the desired item.
4157 * @param defaultValue the value to be returned if no value of the desired
4158 * type is stored with the given name.
4159 *
4160 * @return the value of an item that previously added with putExtra()
4161 * or the default value if none was found.
4162 *
4163 * @see #putExtra(String, boolean)
4164 */
4165 public boolean getBooleanExtra(String name, boolean defaultValue) {
4166 return mExtras == null ? defaultValue :
4167 mExtras.getBoolean(name, defaultValue);
4168 }
4169
4170 /**
4171 * Retrieve extended data from the intent.
4172 *
4173 * @param name The name of the desired item.
4174 * @param defaultValue the value to be returned if no value of the desired
4175 * type is stored with the given name.
4176 *
4177 * @return the value of an item that previously added with putExtra()
4178 * or the default value if none was found.
4179 *
4180 * @see #putExtra(String, byte)
4181 */
4182 public byte getByteExtra(String name, byte defaultValue) {
4183 return mExtras == null ? defaultValue :
4184 mExtras.getByte(name, defaultValue);
4185 }
4186
4187 /**
4188 * Retrieve extended data from the intent.
4189 *
4190 * @param name The name of the desired item.
4191 * @param defaultValue the value to be returned if no value of the desired
4192 * type is stored with the given name.
4193 *
4194 * @return the value of an item that previously added with putExtra()
4195 * or the default value if none was found.
4196 *
4197 * @see #putExtra(String, short)
4198 */
4199 public short getShortExtra(String name, short defaultValue) {
4200 return mExtras == null ? defaultValue :
4201 mExtras.getShort(name, defaultValue);
4202 }
4203
4204 /**
4205 * Retrieve extended data from the intent.
4206 *
4207 * @param name The name of the desired item.
4208 * @param defaultValue the value to be returned if no value of the desired
4209 * type is stored with the given name.
4210 *
4211 * @return the value of an item that previously added with putExtra()
4212 * or the default value if none was found.
4213 *
4214 * @see #putExtra(String, char)
4215 */
4216 public char getCharExtra(String name, char defaultValue) {
4217 return mExtras == null ? defaultValue :
4218 mExtras.getChar(name, defaultValue);
4219 }
4220
4221 /**
4222 * Retrieve extended data from the intent.
4223 *
4224 * @param name The name of the desired item.
4225 * @param defaultValue the value to be returned if no value of the desired
4226 * type is stored with the given name.
4227 *
4228 * @return the value of an item that previously added with putExtra()
4229 * or the default value if none was found.
4230 *
4231 * @see #putExtra(String, int)
4232 */
4233 public int getIntExtra(String name, int defaultValue) {
4234 return mExtras == null ? defaultValue :
4235 mExtras.getInt(name, defaultValue);
4236 }
4237
4238 /**
4239 * Retrieve extended data from the intent.
4240 *
4241 * @param name The name of the desired item.
4242 * @param defaultValue the value to be returned if no value of the desired
4243 * type is stored with the given name.
4244 *
4245 * @return the value of an item that previously added with putExtra()
4246 * or the default value if none was found.
4247 *
4248 * @see #putExtra(String, long)
4249 */
4250 public long getLongExtra(String name, long defaultValue) {
4251 return mExtras == null ? defaultValue :
4252 mExtras.getLong(name, defaultValue);
4253 }
4254
4255 /**
4256 * Retrieve extended data from the intent.
4257 *
4258 * @param name The name of the desired item.
4259 * @param defaultValue the value to be returned if no value of the desired
4260 * type is stored with the given name.
4261 *
4262 * @return the value of an item that previously added with putExtra(),
4263 * or the default value if no such item is present
4264 *
4265 * @see #putExtra(String, float)
4266 */
4267 public float getFloatExtra(String name, float defaultValue) {
4268 return mExtras == null ? defaultValue :
4269 mExtras.getFloat(name, defaultValue);
4270 }
4271
4272 /**
4273 * Retrieve extended data from the intent.
4274 *
4275 * @param name The name of the desired item.
4276 * @param defaultValue the value to be returned if no value of the desired
4277 * type is stored with the given name.
4278 *
4279 * @return the value of an item that previously added with putExtra()
4280 * or the default value if none was found.
4281 *
4282 * @see #putExtra(String, double)
4283 */
4284 public double getDoubleExtra(String name, double defaultValue) {
4285 return mExtras == null ? defaultValue :
4286 mExtras.getDouble(name, defaultValue);
4287 }
4288
4289 /**
4290 * Retrieve extended data from the intent.
4291 *
4292 * @param name The name of the desired item.
4293 *
4294 * @return the value of an item that previously added with putExtra()
4295 * or null if no String value was found.
4296 *
4297 * @see #putExtra(String, String)
4298 */
4299 public String getStringExtra(String name) {
4300 return mExtras == null ? null : mExtras.getString(name);
4301 }
4302
4303 /**
4304 * Retrieve extended data from the intent.
4305 *
4306 * @param name The name of the desired item.
4307 *
4308 * @return the value of an item that previously added with putExtra()
4309 * or null if no CharSequence value was found.
4310 *
4311 * @see #putExtra(String, CharSequence)
4312 */
4313 public CharSequence getCharSequenceExtra(String name) {
4314 return mExtras == null ? null : mExtras.getCharSequence(name);
4315 }
4316
4317 /**
4318 * Retrieve extended data from the intent.
4319 *
4320 * @param name The name of the desired item.
4321 *
4322 * @return the value of an item that previously added with putExtra()
4323 * or null if no Parcelable value was found.
4324 *
4325 * @see #putExtra(String, Parcelable)
4326 */
4327 public <T extends Parcelable> T getParcelableExtra(String name) {
4328 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4329 }
4330
4331 /**
4332 * Retrieve extended data from the intent.
4333 *
4334 * @param name The name of the desired item.
4335 *
4336 * @return the value of an item that previously added with putExtra()
4337 * or null if no Parcelable[] value was found.
4338 *
4339 * @see #putExtra(String, Parcelable[])
4340 */
4341 public Parcelable[] getParcelableArrayExtra(String name) {
4342 return mExtras == null ? null : mExtras.getParcelableArray(name);
4343 }
4344
4345 /**
4346 * Retrieve extended data from the intent.
4347 *
4348 * @param name The name of the desired item.
4349 *
4350 * @return the value of an item that previously added with putExtra()
4351 * or null if no ArrayList<Parcelable> value was found.
4352 *
4353 * @see #putParcelableArrayListExtra(String, ArrayList)
4354 */
4355 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4356 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4357 }
4358
4359 /**
4360 * Retrieve extended data from the intent.
4361 *
4362 * @param name The name of the desired item.
4363 *
4364 * @return the value of an item that previously added with putExtra()
4365 * or null if no Serializable value was found.
4366 *
4367 * @see #putExtra(String, Serializable)
4368 */
4369 public Serializable getSerializableExtra(String name) {
4370 return mExtras == null ? null : mExtras.getSerializable(name);
4371 }
4372
4373 /**
4374 * Retrieve extended data from the intent.
4375 *
4376 * @param name The name of the desired item.
4377 *
4378 * @return the value of an item that previously added with putExtra()
4379 * or null if no ArrayList<Integer> value was found.
4380 *
4381 * @see #putIntegerArrayListExtra(String, ArrayList)
4382 */
4383 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4384 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4385 }
4386
4387 /**
4388 * Retrieve extended data from the intent.
4389 *
4390 * @param name The name of the desired item.
4391 *
4392 * @return the value of an item that previously added with putExtra()
4393 * or null if no ArrayList<String> value was found.
4394 *
4395 * @see #putStringArrayListExtra(String, ArrayList)
4396 */
4397 public ArrayList<String> getStringArrayListExtra(String name) {
4398 return mExtras == null ? null : mExtras.getStringArrayList(name);
4399 }
4400
4401 /**
4402 * Retrieve extended data from the intent.
4403 *
4404 * @param name The name of the desired item.
4405 *
4406 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004407 * or null if no ArrayList<CharSequence> value was found.
4408 *
4409 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4410 */
4411 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4412 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4413 }
4414
4415 /**
4416 * Retrieve extended data from the intent.
4417 *
4418 * @param name The name of the desired item.
4419 *
4420 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004421 * or null if no boolean array value was found.
4422 *
4423 * @see #putExtra(String, boolean[])
4424 */
4425 public boolean[] getBooleanArrayExtra(String name) {
4426 return mExtras == null ? null : mExtras.getBooleanArray(name);
4427 }
4428
4429 /**
4430 * Retrieve extended data from the intent.
4431 *
4432 * @param name The name of the desired item.
4433 *
4434 * @return the value of an item that previously added with putExtra()
4435 * or null if no byte array value was found.
4436 *
4437 * @see #putExtra(String, byte[])
4438 */
4439 public byte[] getByteArrayExtra(String name) {
4440 return mExtras == null ? null : mExtras.getByteArray(name);
4441 }
4442
4443 /**
4444 * Retrieve extended data from the intent.
4445 *
4446 * @param name The name of the desired item.
4447 *
4448 * @return the value of an item that previously added with putExtra()
4449 * or null if no short array value was found.
4450 *
4451 * @see #putExtra(String, short[])
4452 */
4453 public short[] getShortArrayExtra(String name) {
4454 return mExtras == null ? null : mExtras.getShortArray(name);
4455 }
4456
4457 /**
4458 * Retrieve extended data from the intent.
4459 *
4460 * @param name The name of the desired item.
4461 *
4462 * @return the value of an item that previously added with putExtra()
4463 * or null if no char array value was found.
4464 *
4465 * @see #putExtra(String, char[])
4466 */
4467 public char[] getCharArrayExtra(String name) {
4468 return mExtras == null ? null : mExtras.getCharArray(name);
4469 }
4470
4471 /**
4472 * Retrieve extended data from the intent.
4473 *
4474 * @param name The name of the desired item.
4475 *
4476 * @return the value of an item that previously added with putExtra()
4477 * or null if no int array value was found.
4478 *
4479 * @see #putExtra(String, int[])
4480 */
4481 public int[] getIntArrayExtra(String name) {
4482 return mExtras == null ? null : mExtras.getIntArray(name);
4483 }
4484
4485 /**
4486 * Retrieve extended data from the intent.
4487 *
4488 * @param name The name of the desired item.
4489 *
4490 * @return the value of an item that previously added with putExtra()
4491 * or null if no long array value was found.
4492 *
4493 * @see #putExtra(String, long[])
4494 */
4495 public long[] getLongArrayExtra(String name) {
4496 return mExtras == null ? null : mExtras.getLongArray(name);
4497 }
4498
4499 /**
4500 * Retrieve extended data from the intent.
4501 *
4502 * @param name The name of the desired item.
4503 *
4504 * @return the value of an item that previously added with putExtra()
4505 * or null if no float array value was found.
4506 *
4507 * @see #putExtra(String, float[])
4508 */
4509 public float[] getFloatArrayExtra(String name) {
4510 return mExtras == null ? null : mExtras.getFloatArray(name);
4511 }
4512
4513 /**
4514 * Retrieve extended data from the intent.
4515 *
4516 * @param name The name of the desired item.
4517 *
4518 * @return the value of an item that previously added with putExtra()
4519 * or null if no double array value was found.
4520 *
4521 * @see #putExtra(String, double[])
4522 */
4523 public double[] getDoubleArrayExtra(String name) {
4524 return mExtras == null ? null : mExtras.getDoubleArray(name);
4525 }
4526
4527 /**
4528 * Retrieve extended data from the intent.
4529 *
4530 * @param name The name of the desired item.
4531 *
4532 * @return the value of an item that previously added with putExtra()
4533 * or null if no String array value was found.
4534 *
4535 * @see #putExtra(String, String[])
4536 */
4537 public String[] getStringArrayExtra(String name) {
4538 return mExtras == null ? null : mExtras.getStringArray(name);
4539 }
4540
4541 /**
4542 * Retrieve extended data from the intent.
4543 *
4544 * @param name The name of the desired item.
4545 *
4546 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004547 * or null if no CharSequence array value was found.
4548 *
4549 * @see #putExtra(String, CharSequence[])
4550 */
4551 public CharSequence[] getCharSequenceArrayExtra(String name) {
4552 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4553 }
4554
4555 /**
4556 * Retrieve extended data from the intent.
4557 *
4558 * @param name The name of the desired item.
4559 *
4560 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004561 * or null if no Bundle value was found.
4562 *
4563 * @see #putExtra(String, Bundle)
4564 */
4565 public Bundle getBundleExtra(String name) {
4566 return mExtras == null ? null : mExtras.getBundle(name);
4567 }
4568
4569 /**
4570 * Retrieve extended data from the intent.
4571 *
4572 * @param name The name of the desired item.
4573 *
4574 * @return the value of an item that previously added with putExtra()
4575 * or null if no IBinder value was found.
4576 *
4577 * @see #putExtra(String, IBinder)
4578 *
4579 * @deprecated
4580 * @hide
4581 */
4582 @Deprecated
4583 public IBinder getIBinderExtra(String name) {
4584 return mExtras == null ? null : mExtras.getIBinder(name);
4585 }
4586
4587 /**
4588 * Retrieve extended data from the intent.
4589 *
4590 * @param name The name of the desired item.
4591 * @param defaultValue The default value to return in case no item is
4592 * associated with the key 'name'
4593 *
4594 * @return the value of an item that previously added with putExtra()
4595 * or defaultValue if none was found.
4596 *
4597 * @see #putExtra
4598 *
4599 * @deprecated
4600 * @hide
4601 */
4602 @Deprecated
4603 public Object getExtra(String name, Object defaultValue) {
4604 Object result = defaultValue;
4605 if (mExtras != null) {
4606 Object result2 = mExtras.get(name);
4607 if (result2 != null) {
4608 result = result2;
4609 }
4610 }
4611
4612 return result;
4613 }
4614
4615 /**
4616 * Retrieves a map of extended data from the intent.
4617 *
4618 * @return the map of all extras previously added with putExtra(),
4619 * or null if none have been added.
4620 */
4621 public Bundle getExtras() {
4622 return (mExtras != null)
4623 ? new Bundle(mExtras)
4624 : null;
4625 }
4626
4627 /**
4628 * Retrieve any special flags associated with this intent. You will
4629 * normally just set them with {@link #setFlags} and let the system
4630 * take the appropriate action with them.
4631 *
4632 * @return int The currently set flags.
4633 *
4634 * @see #setFlags
4635 */
4636 public int getFlags() {
4637 return mFlags;
4638 }
4639
Dianne Hackborne7f97212011-02-24 14:40:20 -08004640 /** @hide */
4641 public boolean isExcludingStopped() {
4642 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4643 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4644 }
4645
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004646 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004647 * Retrieve the application package name this Intent is limited to. When
4648 * resolving an Intent, if non-null this limits the resolution to only
4649 * components in the given application package.
4650 *
4651 * @return The name of the application package for the Intent.
4652 *
4653 * @see #resolveActivity
4654 * @see #setPackage
4655 */
4656 public String getPackage() {
4657 return mPackage;
4658 }
4659
4660 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004661 * Retrieve the concrete component associated with the intent. When receiving
4662 * an intent, this is the component that was found to best handle it (that is,
4663 * yourself) and will always be non-null; in all other cases it will be
4664 * null unless explicitly set.
4665 *
4666 * @return The name of the application component to handle the intent.
4667 *
4668 * @see #resolveActivity
4669 * @see #setComponent
4670 */
4671 public ComponentName getComponent() {
4672 return mComponent;
4673 }
4674
4675 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004676 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4677 * used as a hint to the receiver for animations and the like. Null means that there
4678 * is no source bounds.
4679 */
4680 public Rect getSourceBounds() {
4681 return mSourceBounds;
4682 }
4683
4684 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004685 * Return the Activity component that should be used to handle this intent.
4686 * The appropriate component is determined based on the information in the
4687 * intent, evaluated as follows:
4688 *
4689 * <p>If {@link #getComponent} returns an explicit class, that is returned
4690 * without any further consideration.
4691 *
4692 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4693 * category to be considered.
4694 *
4695 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4696 * action.
4697 *
4698 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4699 * this type.
4700 *
4701 * <p>If {@link #addCategory} has added any categories, the activity must
4702 * handle ALL of the categories specified.
4703 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004704 * <p>If {@link #getPackage} is non-NULL, only activity components in
4705 * that application package will be considered.
4706 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004707 * <p>If there are no activities that satisfy all of these conditions, a
4708 * null string is returned.
4709 *
4710 * <p>If multiple activities are found to satisfy the intent, the one with
4711 * the highest priority will be used. If there are multiple activities
4712 * with the same priority, the system will either pick the best activity
4713 * based on user preference, or resolve to a system class that will allow
4714 * the user to pick an activity and forward from there.
4715 *
4716 * <p>This method is implemented simply by calling
4717 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4718 * true.</p>
4719 * <p> This API is called for you as part of starting an activity from an
4720 * intent. You do not normally need to call it yourself.</p>
4721 *
4722 * @param pm The package manager with which to resolve the Intent.
4723 *
4724 * @return Name of the component implementing an activity that can
4725 * display the intent.
4726 *
4727 * @see #setComponent
4728 * @see #getComponent
4729 * @see #resolveActivityInfo
4730 */
4731 public ComponentName resolveActivity(PackageManager pm) {
4732 if (mComponent != null) {
4733 return mComponent;
4734 }
4735
4736 ResolveInfo info = pm.resolveActivity(
4737 this, PackageManager.MATCH_DEFAULT_ONLY);
4738 if (info != null) {
4739 return new ComponentName(
4740 info.activityInfo.applicationInfo.packageName,
4741 info.activityInfo.name);
4742 }
4743
4744 return null;
4745 }
4746
4747 /**
4748 * Resolve the Intent into an {@link ActivityInfo}
4749 * describing the activity that should execute the intent. Resolution
4750 * follows the same rules as described for {@link #resolveActivity}, but
4751 * you get back the completely information about the resolved activity
4752 * instead of just its class name.
4753 *
4754 * @param pm The package manager with which to resolve the Intent.
4755 * @param flags Addition information to retrieve as per
4756 * {@link PackageManager#getActivityInfo(ComponentName, int)
4757 * PackageManager.getActivityInfo()}.
4758 *
4759 * @return PackageManager.ActivityInfo
4760 *
4761 * @see #resolveActivity
4762 */
4763 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4764 ActivityInfo ai = null;
4765 if (mComponent != null) {
4766 try {
4767 ai = pm.getActivityInfo(mComponent, flags);
4768 } catch (PackageManager.NameNotFoundException e) {
4769 // ignore
4770 }
4771 } else {
4772 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004773 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004774 if (info != null) {
4775 ai = info.activityInfo;
4776 }
4777 }
4778
4779 return ai;
4780 }
4781
4782 /**
4783 * Set the general action to be performed.
4784 *
4785 * @param action An action name, such as ACTION_VIEW. Application-specific
4786 * actions should be prefixed with the vendor's package name.
4787 *
4788 * @return Returns the same Intent object, for chaining multiple calls
4789 * into a single statement.
4790 *
4791 * @see #getAction
4792 */
4793 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004794 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004795 return this;
4796 }
4797
4798 /**
4799 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004800 * clears any type that was previously set by {@link #setType} or
4801 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004802 *
Nick Pellyccae4122012-01-09 14:12:58 -08004803 * <p><em>Note: scheme matching in the Android framework is
4804 * case-sensitive, unlike the formal RFC. As a result,
4805 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004806 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004807 * {@link #setDataAndNormalize}
4808 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004809 *
Nick Pellyccae4122012-01-09 14:12:58 -08004810 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004811 *
4812 * @return Returns the same Intent object, for chaining multiple calls
4813 * into a single statement.
4814 *
4815 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004816 * @see #setDataAndNormalize
4817 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004818 */
4819 public Intent setData(Uri data) {
4820 mData = data;
4821 mType = null;
4822 return this;
4823 }
4824
4825 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004826 * Normalize and set the data this intent is operating on.
4827 *
4828 * <p>This method automatically clears any type that was
4829 * previously set (for example, by {@link #setType}).
4830 *
4831 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004832 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004833 * so really this is just a convenience method for
4834 * <pre>
4835 * setData(data.normalize())
4836 * </pre>
4837 *
4838 * @param data The Uri of the data this intent is now targeting.
4839 *
4840 * @return Returns the same Intent object, for chaining multiple calls
4841 * into a single statement.
4842 *
4843 * @see #getData
4844 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004845 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004846 */
4847 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004848 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004849 }
4850
4851 /**
4852 * Set an explicit MIME data type.
4853 *
4854 * <p>This is used to create intents that only specify a type and not data,
4855 * for example to indicate the type of data to return.
4856 *
4857 * <p>This method automatically clears any data that was
4858 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004859 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004860 * <p><em>Note: MIME type matching in the Android framework is
4861 * case-sensitive, unlike formal RFC MIME types. As a result,
4862 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004863 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4864 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004865 *
4866 * @param type The MIME type of the data being handled by this intent.
4867 *
4868 * @return Returns the same Intent object, for chaining multiple calls
4869 * into a single statement.
4870 *
4871 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004872 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004873 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004874 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004875 */
4876 public Intent setType(String type) {
4877 mData = null;
4878 mType = type;
4879 return this;
4880 }
4881
4882 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004883 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004884 *
Nick Pellyccae4122012-01-09 14:12:58 -08004885 * <p>This is used to create intents that only specify a type and not data,
4886 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004887 *
Nick Pellyccae4122012-01-09 14:12:58 -08004888 * <p>This method automatically clears any data that was
4889 * previously set (for example by {@link #setData}).
4890 *
4891 * <p>The MIME type is normalized using
4892 * {@link #normalizeMimeType} before it is set,
4893 * so really this is just a convenience method for
4894 * <pre>
4895 * setType(Intent.normalizeMimeType(type))
4896 * </pre>
4897 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004898 * @param type The MIME type of the data being handled by this intent.
4899 *
4900 * @return Returns the same Intent object, for chaining multiple calls
4901 * into a single statement.
4902 *
Nick Pellyccae4122012-01-09 14:12:58 -08004903 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004904 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004905 * @see #normalizeMimeType
4906 */
4907 public Intent setTypeAndNormalize(String type) {
4908 return setType(normalizeMimeType(type));
4909 }
4910
4911 /**
4912 * (Usually optional) Set the data for the intent along with an explicit
4913 * MIME data type. This method should very rarely be used -- it allows you
4914 * to override the MIME type that would ordinarily be inferred from the
4915 * data with your own type given here.
4916 *
4917 * <p><em>Note: MIME type and Uri scheme matching in the
4918 * Android framework is case-sensitive, unlike the formal RFC definitions.
4919 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004920 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004921 * {@link #setDataAndTypeAndNormalize}
4922 * to ensure that they are converted to lower case.</em>
4923 *
4924 * @param data The Uri of the data this intent is now targeting.
4925 * @param type The MIME type of the data being handled by this intent.
4926 *
4927 * @return Returns the same Intent object, for chaining multiple calls
4928 * into a single statement.
4929 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004930 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004931 * @see #setData
4932 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004933 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004934 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004935 */
4936 public Intent setDataAndType(Uri data, String type) {
4937 mData = data;
4938 mType = type;
4939 return this;
4940 }
4941
4942 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004943 * (Usually optional) Normalize and set both the data Uri and an explicit
4944 * MIME data type. This method should very rarely be used -- it allows you
4945 * to override the MIME type that would ordinarily be inferred from the
4946 * data with your own type given here.
4947 *
4948 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004949 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004950 * before they are set, so really this is just a convenience method for
4951 * <pre>
4952 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4953 * </pre>
4954 *
4955 * @param data The Uri of the data this intent is now targeting.
4956 * @param type The MIME type of the data being handled by this intent.
4957 *
4958 * @return Returns the same Intent object, for chaining multiple calls
4959 * into a single statement.
4960 *
4961 * @see #setType
4962 * @see #setData
4963 * @see #setDataAndType
4964 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004965 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004966 */
4967 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004968 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004969 }
4970
4971 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004972 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004973 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004974 * activities that provide <em>all</em> of the requested categories will be
4975 * used.
4976 *
4977 * @param category The desired category. This can be either one of the
4978 * predefined Intent categories, or a custom category in your own
4979 * namespace.
4980 *
4981 * @return Returns the same Intent object, for chaining multiple calls
4982 * into a single statement.
4983 *
4984 * @see #hasCategory
4985 * @see #removeCategory
4986 */
4987 public Intent addCategory(String category) {
4988 if (mCategories == null) {
4989 mCategories = new HashSet<String>();
4990 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004991 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004992 return this;
4993 }
4994
4995 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004996 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004997 *
4998 * @param category The category to remove.
4999 *
5000 * @see #addCategory
5001 */
5002 public void removeCategory(String category) {
5003 if (mCategories != null) {
5004 mCategories.remove(category);
5005 if (mCategories.size() == 0) {
5006 mCategories = null;
5007 }
5008 }
5009 }
5010
5011 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005012 * Set a selector for this Intent. This is a modification to the kinds of
5013 * things the Intent will match. If the selector is set, it will be used
5014 * when trying to find entities that can handle the Intent, instead of the
5015 * main contents of the Intent. This allows you build an Intent containing
5016 * a generic protocol while targeting it more specifically.
5017 *
5018 * <p>An example of where this may be used is with things like
5019 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5020 * Intent that will launch the Browser application. However, the correct
5021 * main entry point of an application is actually {@link #ACTION_MAIN}
5022 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5023 * used to specify the actual Activity to launch. If you launch the browser
5024 * with something different, undesired behavior may happen if the user has
5025 * previously or later launches it the normal way, since they do not match.
5026 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5027 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5028 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5029 *
5030 * <p>Setting a selector does not impact the behavior of
5031 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5032 * desired behavior of a selector -- it does not impact the base meaning
5033 * of the Intent, just what kinds of things will be matched against it
5034 * when determining who can handle it.</p>
5035 *
5036 * <p>You can not use both a selector and {@link #setPackage(String)} on
5037 * the same base Intent.</p>
5038 *
5039 * @param selector The desired selector Intent; set to null to not use
5040 * a special selector.
5041 */
5042 public void setSelector(Intent selector) {
5043 if (selector == this) {
5044 throw new IllegalArgumentException(
5045 "Intent being set as a selector of itself");
5046 }
5047 if (selector != null && mPackage != null) {
5048 throw new IllegalArgumentException(
5049 "Can't set selector when package name is already set");
5050 }
5051 mSelector = selector;
5052 }
5053
5054 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005055 * Set a {@link ClipData} associated with this Intent. This replaces any
5056 * previously set ClipData.
5057 *
5058 * <p>The ClipData in an intent is not used for Intent matching or other
5059 * such operations. Semantically it is like extras, used to transmit
5060 * additional data with the Intent. The main feature of using this over
5061 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5062 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5063 * items included in the clip data. This is useful, in particular, if
5064 * you want to transmit an Intent containing multiple <code>content:</code>
5065 * URIs for which the recipient may not have global permission to access the
5066 * content provider.
5067 *
5068 * <p>If the ClipData contains items that are themselves Intents, any
5069 * grant flags in those Intents will be ignored. Only the top-level flags
5070 * of the main Intent are respected, and will be applied to all Uri or
5071 * Intent items in the clip (or sub-items of the clip).
5072 *
5073 * <p>The MIME type, label, and icon in the ClipData object are not
5074 * directly used by Intent. Applications should generally rely on the
5075 * MIME type of the Intent itself, not what it may find in the ClipData.
5076 * A common practice is to construct a ClipData for use with an Intent
5077 * with a MIME type of "*\/*".
5078 *
5079 * @param clip The new clip to set. May be null to clear the current clip.
5080 */
5081 public void setClipData(ClipData clip) {
5082 mClipData = clip;
5083 }
5084
5085 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005086 * Add extended data to the intent. The name must include a package
5087 * prefix, for example the app com.android.contacts would use names
5088 * like "com.android.contacts.ShowAll".
5089 *
5090 * @param name The name of the extra data, with package prefix.
5091 * @param value The boolean data value.
5092 *
5093 * @return Returns the same Intent object, for chaining multiple calls
5094 * into a single statement.
5095 *
5096 * @see #putExtras
5097 * @see #removeExtra
5098 * @see #getBooleanExtra(String, boolean)
5099 */
5100 public Intent putExtra(String name, boolean value) {
5101 if (mExtras == null) {
5102 mExtras = new Bundle();
5103 }
5104 mExtras.putBoolean(name, value);
5105 return this;
5106 }
5107
5108 /**
5109 * Add extended data to the intent. The name must include a package
5110 * prefix, for example the app com.android.contacts would use names
5111 * like "com.android.contacts.ShowAll".
5112 *
5113 * @param name The name of the extra data, with package prefix.
5114 * @param value The byte data value.
5115 *
5116 * @return Returns the same Intent object, for chaining multiple calls
5117 * into a single statement.
5118 *
5119 * @see #putExtras
5120 * @see #removeExtra
5121 * @see #getByteExtra(String, byte)
5122 */
5123 public Intent putExtra(String name, byte value) {
5124 if (mExtras == null) {
5125 mExtras = new Bundle();
5126 }
5127 mExtras.putByte(name, value);
5128 return this;
5129 }
5130
5131 /**
5132 * Add extended data to the intent. The name must include a package
5133 * prefix, for example the app com.android.contacts would use names
5134 * like "com.android.contacts.ShowAll".
5135 *
5136 * @param name The name of the extra data, with package prefix.
5137 * @param value The char data value.
5138 *
5139 * @return Returns the same Intent object, for chaining multiple calls
5140 * into a single statement.
5141 *
5142 * @see #putExtras
5143 * @see #removeExtra
5144 * @see #getCharExtra(String, char)
5145 */
5146 public Intent putExtra(String name, char value) {
5147 if (mExtras == null) {
5148 mExtras = new Bundle();
5149 }
5150 mExtras.putChar(name, value);
5151 return this;
5152 }
5153
5154 /**
5155 * Add extended data to the intent. The name must include a package
5156 * prefix, for example the app com.android.contacts would use names
5157 * like "com.android.contacts.ShowAll".
5158 *
5159 * @param name The name of the extra data, with package prefix.
5160 * @param value The short data value.
5161 *
5162 * @return Returns the same Intent object, for chaining multiple calls
5163 * into a single statement.
5164 *
5165 * @see #putExtras
5166 * @see #removeExtra
5167 * @see #getShortExtra(String, short)
5168 */
5169 public Intent putExtra(String name, short value) {
5170 if (mExtras == null) {
5171 mExtras = new Bundle();
5172 }
5173 mExtras.putShort(name, value);
5174 return this;
5175 }
5176
5177 /**
5178 * Add extended data to the intent. The name must include a package
5179 * prefix, for example the app com.android.contacts would use names
5180 * like "com.android.contacts.ShowAll".
5181 *
5182 * @param name The name of the extra data, with package prefix.
5183 * @param value The integer data value.
5184 *
5185 * @return Returns the same Intent object, for chaining multiple calls
5186 * into a single statement.
5187 *
5188 * @see #putExtras
5189 * @see #removeExtra
5190 * @see #getIntExtra(String, int)
5191 */
5192 public Intent putExtra(String name, int value) {
5193 if (mExtras == null) {
5194 mExtras = new Bundle();
5195 }
5196 mExtras.putInt(name, value);
5197 return this;
5198 }
5199
5200 /**
5201 * Add extended data to the intent. The name must include a package
5202 * prefix, for example the app com.android.contacts would use names
5203 * like "com.android.contacts.ShowAll".
5204 *
5205 * @param name The name of the extra data, with package prefix.
5206 * @param value The long data value.
5207 *
5208 * @return Returns the same Intent object, for chaining multiple calls
5209 * into a single statement.
5210 *
5211 * @see #putExtras
5212 * @see #removeExtra
5213 * @see #getLongExtra(String, long)
5214 */
5215 public Intent putExtra(String name, long value) {
5216 if (mExtras == null) {
5217 mExtras = new Bundle();
5218 }
5219 mExtras.putLong(name, value);
5220 return this;
5221 }
5222
5223 /**
5224 * Add extended data to the intent. The name must include a package
5225 * prefix, for example the app com.android.contacts would use names
5226 * like "com.android.contacts.ShowAll".
5227 *
5228 * @param name The name of the extra data, with package prefix.
5229 * @param value The float data value.
5230 *
5231 * @return Returns the same Intent object, for chaining multiple calls
5232 * into a single statement.
5233 *
5234 * @see #putExtras
5235 * @see #removeExtra
5236 * @see #getFloatExtra(String, float)
5237 */
5238 public Intent putExtra(String name, float value) {
5239 if (mExtras == null) {
5240 mExtras = new Bundle();
5241 }
5242 mExtras.putFloat(name, value);
5243 return this;
5244 }
5245
5246 /**
5247 * Add extended data to the intent. The name must include a package
5248 * prefix, for example the app com.android.contacts would use names
5249 * like "com.android.contacts.ShowAll".
5250 *
5251 * @param name The name of the extra data, with package prefix.
5252 * @param value The double data value.
5253 *
5254 * @return Returns the same Intent object, for chaining multiple calls
5255 * into a single statement.
5256 *
5257 * @see #putExtras
5258 * @see #removeExtra
5259 * @see #getDoubleExtra(String, double)
5260 */
5261 public Intent putExtra(String name, double value) {
5262 if (mExtras == null) {
5263 mExtras = new Bundle();
5264 }
5265 mExtras.putDouble(name, value);
5266 return this;
5267 }
5268
5269 /**
5270 * Add extended data to the intent. The name must include a package
5271 * prefix, for example the app com.android.contacts would use names
5272 * like "com.android.contacts.ShowAll".
5273 *
5274 * @param name The name of the extra data, with package prefix.
5275 * @param value The String data value.
5276 *
5277 * @return Returns the same Intent object, for chaining multiple calls
5278 * into a single statement.
5279 *
5280 * @see #putExtras
5281 * @see #removeExtra
5282 * @see #getStringExtra(String)
5283 */
5284 public Intent putExtra(String name, String value) {
5285 if (mExtras == null) {
5286 mExtras = new Bundle();
5287 }
5288 mExtras.putString(name, value);
5289 return this;
5290 }
5291
5292 /**
5293 * Add extended data to the intent. The name must include a package
5294 * prefix, for example the app com.android.contacts would use names
5295 * like "com.android.contacts.ShowAll".
5296 *
5297 * @param name The name of the extra data, with package prefix.
5298 * @param value The CharSequence data value.
5299 *
5300 * @return Returns the same Intent object, for chaining multiple calls
5301 * into a single statement.
5302 *
5303 * @see #putExtras
5304 * @see #removeExtra
5305 * @see #getCharSequenceExtra(String)
5306 */
5307 public Intent putExtra(String name, CharSequence value) {
5308 if (mExtras == null) {
5309 mExtras = new Bundle();
5310 }
5311 mExtras.putCharSequence(name, value);
5312 return this;
5313 }
5314
5315 /**
5316 * Add extended data to the intent. The name must include a package
5317 * prefix, for example the app com.android.contacts would use names
5318 * like "com.android.contacts.ShowAll".
5319 *
5320 * @param name The name of the extra data, with package prefix.
5321 * @param value The Parcelable data value.
5322 *
5323 * @return Returns the same Intent object, for chaining multiple calls
5324 * into a single statement.
5325 *
5326 * @see #putExtras
5327 * @see #removeExtra
5328 * @see #getParcelableExtra(String)
5329 */
5330 public Intent putExtra(String name, Parcelable value) {
5331 if (mExtras == null) {
5332 mExtras = new Bundle();
5333 }
5334 mExtras.putParcelable(name, value);
5335 return this;
5336 }
5337
5338 /**
5339 * Add extended data to the intent. The name must include a package
5340 * prefix, for example the app com.android.contacts would use names
5341 * like "com.android.contacts.ShowAll".
5342 *
5343 * @param name The name of the extra data, with package prefix.
5344 * @param value The Parcelable[] data value.
5345 *
5346 * @return Returns the same Intent object, for chaining multiple calls
5347 * into a single statement.
5348 *
5349 * @see #putExtras
5350 * @see #removeExtra
5351 * @see #getParcelableArrayExtra(String)
5352 */
5353 public Intent putExtra(String name, Parcelable[] value) {
5354 if (mExtras == null) {
5355 mExtras = new Bundle();
5356 }
5357 mExtras.putParcelableArray(name, value);
5358 return this;
5359 }
5360
5361 /**
5362 * Add extended data to the intent. The name must include a package
5363 * prefix, for example the app com.android.contacts would use names
5364 * like "com.android.contacts.ShowAll".
5365 *
5366 * @param name The name of the extra data, with package prefix.
5367 * @param value The ArrayList<Parcelable> data value.
5368 *
5369 * @return Returns the same Intent object, for chaining multiple calls
5370 * into a single statement.
5371 *
5372 * @see #putExtras
5373 * @see #removeExtra
5374 * @see #getParcelableArrayListExtra(String)
5375 */
5376 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5377 if (mExtras == null) {
5378 mExtras = new Bundle();
5379 }
5380 mExtras.putParcelableArrayList(name, value);
5381 return this;
5382 }
5383
5384 /**
5385 * Add extended data to the intent. The name must include a package
5386 * prefix, for example the app com.android.contacts would use names
5387 * like "com.android.contacts.ShowAll".
5388 *
5389 * @param name The name of the extra data, with package prefix.
5390 * @param value The ArrayList<Integer> data value.
5391 *
5392 * @return Returns the same Intent object, for chaining multiple calls
5393 * into a single statement.
5394 *
5395 * @see #putExtras
5396 * @see #removeExtra
5397 * @see #getIntegerArrayListExtra(String)
5398 */
5399 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5400 if (mExtras == null) {
5401 mExtras = new Bundle();
5402 }
5403 mExtras.putIntegerArrayList(name, value);
5404 return this;
5405 }
5406
5407 /**
5408 * Add extended data to the intent. The name must include a package
5409 * prefix, for example the app com.android.contacts would use names
5410 * like "com.android.contacts.ShowAll".
5411 *
5412 * @param name The name of the extra data, with package prefix.
5413 * @param value The ArrayList<String> data value.
5414 *
5415 * @return Returns the same Intent object, for chaining multiple calls
5416 * into a single statement.
5417 *
5418 * @see #putExtras
5419 * @see #removeExtra
5420 * @see #getStringArrayListExtra(String)
5421 */
5422 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5423 if (mExtras == null) {
5424 mExtras = new Bundle();
5425 }
5426 mExtras.putStringArrayList(name, value);
5427 return this;
5428 }
5429
5430 /**
5431 * Add extended data to the intent. The name must include a package
5432 * prefix, for example the app com.android.contacts would use names
5433 * like "com.android.contacts.ShowAll".
5434 *
5435 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005436 * @param value The ArrayList<CharSequence> data value.
5437 *
5438 * @return Returns the same Intent object, for chaining multiple calls
5439 * into a single statement.
5440 *
5441 * @see #putExtras
5442 * @see #removeExtra
5443 * @see #getCharSequenceArrayListExtra(String)
5444 */
5445 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5446 if (mExtras == null) {
5447 mExtras = new Bundle();
5448 }
5449 mExtras.putCharSequenceArrayList(name, value);
5450 return this;
5451 }
5452
5453 /**
5454 * Add extended data to the intent. The name must include a package
5455 * prefix, for example the app com.android.contacts would use names
5456 * like "com.android.contacts.ShowAll".
5457 *
5458 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005459 * @param value The Serializable data value.
5460 *
5461 * @return Returns the same Intent object, for chaining multiple calls
5462 * into a single statement.
5463 *
5464 * @see #putExtras
5465 * @see #removeExtra
5466 * @see #getSerializableExtra(String)
5467 */
5468 public Intent putExtra(String name, Serializable value) {
5469 if (mExtras == null) {
5470 mExtras = new Bundle();
5471 }
5472 mExtras.putSerializable(name, value);
5473 return this;
5474 }
5475
5476 /**
5477 * Add extended data to the intent. The name must include a package
5478 * prefix, for example the app com.android.contacts would use names
5479 * like "com.android.contacts.ShowAll".
5480 *
5481 * @param name The name of the extra data, with package prefix.
5482 * @param value The boolean array data value.
5483 *
5484 * @return Returns the same Intent object, for chaining multiple calls
5485 * into a single statement.
5486 *
5487 * @see #putExtras
5488 * @see #removeExtra
5489 * @see #getBooleanArrayExtra(String)
5490 */
5491 public Intent putExtra(String name, boolean[] value) {
5492 if (mExtras == null) {
5493 mExtras = new Bundle();
5494 }
5495 mExtras.putBooleanArray(name, value);
5496 return this;
5497 }
5498
5499 /**
5500 * Add extended data to the intent. The name must include a package
5501 * prefix, for example the app com.android.contacts would use names
5502 * like "com.android.contacts.ShowAll".
5503 *
5504 * @param name The name of the extra data, with package prefix.
5505 * @param value The byte array data value.
5506 *
5507 * @return Returns the same Intent object, for chaining multiple calls
5508 * into a single statement.
5509 *
5510 * @see #putExtras
5511 * @see #removeExtra
5512 * @see #getByteArrayExtra(String)
5513 */
5514 public Intent putExtra(String name, byte[] value) {
5515 if (mExtras == null) {
5516 mExtras = new Bundle();
5517 }
5518 mExtras.putByteArray(name, value);
5519 return this;
5520 }
5521
5522 /**
5523 * Add extended data to the intent. The name must include a package
5524 * prefix, for example the app com.android.contacts would use names
5525 * like "com.android.contacts.ShowAll".
5526 *
5527 * @param name The name of the extra data, with package prefix.
5528 * @param value The short array data value.
5529 *
5530 * @return Returns the same Intent object, for chaining multiple calls
5531 * into a single statement.
5532 *
5533 * @see #putExtras
5534 * @see #removeExtra
5535 * @see #getShortArrayExtra(String)
5536 */
5537 public Intent putExtra(String name, short[] value) {
5538 if (mExtras == null) {
5539 mExtras = new Bundle();
5540 }
5541 mExtras.putShortArray(name, value);
5542 return this;
5543 }
5544
5545 /**
5546 * Add extended data to the intent. The name must include a package
5547 * prefix, for example the app com.android.contacts would use names
5548 * like "com.android.contacts.ShowAll".
5549 *
5550 * @param name The name of the extra data, with package prefix.
5551 * @param value The char array data value.
5552 *
5553 * @return Returns the same Intent object, for chaining multiple calls
5554 * into a single statement.
5555 *
5556 * @see #putExtras
5557 * @see #removeExtra
5558 * @see #getCharArrayExtra(String)
5559 */
5560 public Intent putExtra(String name, char[] value) {
5561 if (mExtras == null) {
5562 mExtras = new Bundle();
5563 }
5564 mExtras.putCharArray(name, value);
5565 return this;
5566 }
5567
5568 /**
5569 * Add extended data to the intent. The name must include a package
5570 * prefix, for example the app com.android.contacts would use names
5571 * like "com.android.contacts.ShowAll".
5572 *
5573 * @param name The name of the extra data, with package prefix.
5574 * @param value The int array data value.
5575 *
5576 * @return Returns the same Intent object, for chaining multiple calls
5577 * into a single statement.
5578 *
5579 * @see #putExtras
5580 * @see #removeExtra
5581 * @see #getIntArrayExtra(String)
5582 */
5583 public Intent putExtra(String name, int[] value) {
5584 if (mExtras == null) {
5585 mExtras = new Bundle();
5586 }
5587 mExtras.putIntArray(name, value);
5588 return this;
5589 }
5590
5591 /**
5592 * Add extended data to the intent. The name must include a package
5593 * prefix, for example the app com.android.contacts would use names
5594 * like "com.android.contacts.ShowAll".
5595 *
5596 * @param name The name of the extra data, with package prefix.
5597 * @param value The byte array data value.
5598 *
5599 * @return Returns the same Intent object, for chaining multiple calls
5600 * into a single statement.
5601 *
5602 * @see #putExtras
5603 * @see #removeExtra
5604 * @see #getLongArrayExtra(String)
5605 */
5606 public Intent putExtra(String name, long[] value) {
5607 if (mExtras == null) {
5608 mExtras = new Bundle();
5609 }
5610 mExtras.putLongArray(name, value);
5611 return this;
5612 }
5613
5614 /**
5615 * Add extended data to the intent. The name must include a package
5616 * prefix, for example the app com.android.contacts would use names
5617 * like "com.android.contacts.ShowAll".
5618 *
5619 * @param name The name of the extra data, with package prefix.
5620 * @param value The float array data value.
5621 *
5622 * @return Returns the same Intent object, for chaining multiple calls
5623 * into a single statement.
5624 *
5625 * @see #putExtras
5626 * @see #removeExtra
5627 * @see #getFloatArrayExtra(String)
5628 */
5629 public Intent putExtra(String name, float[] value) {
5630 if (mExtras == null) {
5631 mExtras = new Bundle();
5632 }
5633 mExtras.putFloatArray(name, value);
5634 return this;
5635 }
5636
5637 /**
5638 * Add extended data to the intent. The name must include a package
5639 * prefix, for example the app com.android.contacts would use names
5640 * like "com.android.contacts.ShowAll".
5641 *
5642 * @param name The name of the extra data, with package prefix.
5643 * @param value The double array data value.
5644 *
5645 * @return Returns the same Intent object, for chaining multiple calls
5646 * into a single statement.
5647 *
5648 * @see #putExtras
5649 * @see #removeExtra
5650 * @see #getDoubleArrayExtra(String)
5651 */
5652 public Intent putExtra(String name, double[] value) {
5653 if (mExtras == null) {
5654 mExtras = new Bundle();
5655 }
5656 mExtras.putDoubleArray(name, value);
5657 return this;
5658 }
5659
5660 /**
5661 * Add extended data to the intent. The name must include a package
5662 * prefix, for example the app com.android.contacts would use names
5663 * like "com.android.contacts.ShowAll".
5664 *
5665 * @param name The name of the extra data, with package prefix.
5666 * @param value The String array data value.
5667 *
5668 * @return Returns the same Intent object, for chaining multiple calls
5669 * into a single statement.
5670 *
5671 * @see #putExtras
5672 * @see #removeExtra
5673 * @see #getStringArrayExtra(String)
5674 */
5675 public Intent putExtra(String name, String[] value) {
5676 if (mExtras == null) {
5677 mExtras = new Bundle();
5678 }
5679 mExtras.putStringArray(name, value);
5680 return this;
5681 }
5682
5683 /**
5684 * Add extended data to the intent. The name must include a package
5685 * prefix, for example the app com.android.contacts would use names
5686 * like "com.android.contacts.ShowAll".
5687 *
5688 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005689 * @param value The CharSequence array data value.
5690 *
5691 * @return Returns the same Intent object, for chaining multiple calls
5692 * into a single statement.
5693 *
5694 * @see #putExtras
5695 * @see #removeExtra
5696 * @see #getCharSequenceArrayExtra(String)
5697 */
5698 public Intent putExtra(String name, CharSequence[] value) {
5699 if (mExtras == null) {
5700 mExtras = new Bundle();
5701 }
5702 mExtras.putCharSequenceArray(name, value);
5703 return this;
5704 }
5705
5706 /**
5707 * Add extended data to the intent. The name must include a package
5708 * prefix, for example the app com.android.contacts would use names
5709 * like "com.android.contacts.ShowAll".
5710 *
5711 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005712 * @param value The Bundle data value.
5713 *
5714 * @return Returns the same Intent object, for chaining multiple calls
5715 * into a single statement.
5716 *
5717 * @see #putExtras
5718 * @see #removeExtra
5719 * @see #getBundleExtra(String)
5720 */
5721 public Intent putExtra(String name, Bundle value) {
5722 if (mExtras == null) {
5723 mExtras = new Bundle();
5724 }
5725 mExtras.putBundle(name, value);
5726 return this;
5727 }
5728
5729 /**
5730 * Add extended data to the intent. The name must include a package
5731 * prefix, for example the app com.android.contacts would use names
5732 * like "com.android.contacts.ShowAll".
5733 *
5734 * @param name The name of the extra data, with package prefix.
5735 * @param value The IBinder data value.
5736 *
5737 * @return Returns the same Intent object, for chaining multiple calls
5738 * into a single statement.
5739 *
5740 * @see #putExtras
5741 * @see #removeExtra
5742 * @see #getIBinderExtra(String)
5743 *
5744 * @deprecated
5745 * @hide
5746 */
5747 @Deprecated
5748 public Intent putExtra(String name, IBinder value) {
5749 if (mExtras == null) {
5750 mExtras = new Bundle();
5751 }
5752 mExtras.putIBinder(name, value);
5753 return this;
5754 }
5755
5756 /**
5757 * Copy all extras in 'src' in to this intent.
5758 *
5759 * @param src Contains the extras to copy.
5760 *
5761 * @see #putExtra
5762 */
5763 public Intent putExtras(Intent src) {
5764 if (src.mExtras != null) {
5765 if (mExtras == null) {
5766 mExtras = new Bundle(src.mExtras);
5767 } else {
5768 mExtras.putAll(src.mExtras);
5769 }
5770 }
5771 return this;
5772 }
5773
5774 /**
5775 * Add a set of extended data to the intent. The keys must include a package
5776 * prefix, for example the app com.android.contacts would use names
5777 * like "com.android.contacts.ShowAll".
5778 *
5779 * @param extras The Bundle of extras to add to this intent.
5780 *
5781 * @see #putExtra
5782 * @see #removeExtra
5783 */
5784 public Intent putExtras(Bundle extras) {
5785 if (mExtras == null) {
5786 mExtras = new Bundle();
5787 }
5788 mExtras.putAll(extras);
5789 return this;
5790 }
5791
5792 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005793 * Completely replace the extras in the Intent with the extras in the
5794 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005795 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005796 * @param src The exact extras contained in this Intent are copied
5797 * into the target intent, replacing any that were previously there.
5798 */
5799 public Intent replaceExtras(Intent src) {
5800 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5801 return this;
5802 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005803
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005804 /**
5805 * Completely replace the extras in the Intent with the given Bundle of
5806 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005807 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005808 * @param extras The new set of extras in the Intent, or null to erase
5809 * all extras.
5810 */
5811 public Intent replaceExtras(Bundle extras) {
5812 mExtras = extras != null ? new Bundle(extras) : null;
5813 return this;
5814 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005815
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005816 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005817 * Remove extended data from the intent.
5818 *
5819 * @see #putExtra
5820 */
5821 public void removeExtra(String name) {
5822 if (mExtras != null) {
5823 mExtras.remove(name);
5824 if (mExtras.size() == 0) {
5825 mExtras = null;
5826 }
5827 }
5828 }
5829
5830 /**
5831 * Set special flags controlling how this intent is handled. Most values
5832 * here depend on the type of component being executed by the Intent,
5833 * specifically the FLAG_ACTIVITY_* flags are all for use with
5834 * {@link Context#startActivity Context.startActivity()} and the
5835 * FLAG_RECEIVER_* flags are all for use with
5836 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5837 *
Scott Main7aee61f2011-02-08 11:25:01 -08005838 * <p>See the
5839 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5840 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005841 * the behavior of your application.
5842 *
5843 * @param flags The desired flags.
5844 *
5845 * @return Returns the same Intent object, for chaining multiple calls
5846 * into a single statement.
5847 *
5848 * @see #getFlags
5849 * @see #addFlags
5850 *
5851 * @see #FLAG_GRANT_READ_URI_PERMISSION
5852 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5853 * @see #FLAG_DEBUG_LOG_RESOLUTION
5854 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005855 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005856 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005857 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005858 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005859 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5860 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005861 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005862 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5863 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005864 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005865 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005866 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005867 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5868 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005869 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005870 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005871 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005872 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5873 */
5874 public Intent setFlags(int flags) {
5875 mFlags = flags;
5876 return this;
5877 }
5878
5879 /**
5880 * Add additional flags to the intent (or with existing flags
5881 * value).
5882 *
5883 * @param flags The new flags to set.
5884 *
5885 * @return Returns the same Intent object, for chaining multiple calls
5886 * into a single statement.
5887 *
5888 * @see #setFlags
5889 */
5890 public Intent addFlags(int flags) {
5891 mFlags |= flags;
5892 return this;
5893 }
5894
5895 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005896 * (Usually optional) Set an explicit application package name that limits
5897 * the components this Intent will resolve to. If left to the default
5898 * value of null, all components in all applications will considered.
5899 * If non-null, the Intent can only match the components in the given
5900 * application package.
5901 *
5902 * @param packageName The name of the application package to handle the
5903 * intent, or null to allow any application package.
5904 *
5905 * @return Returns the same Intent object, for chaining multiple calls
5906 * into a single statement.
5907 *
5908 * @see #getPackage
5909 * @see #resolveActivity
5910 */
5911 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005912 if (packageName != null && mSelector != null) {
5913 throw new IllegalArgumentException(
5914 "Can't set package name when selector is already set");
5915 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005916 mPackage = packageName;
5917 return this;
5918 }
5919
5920 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005921 * (Usually optional) Explicitly set the component to handle the intent.
5922 * If left with the default value of null, the system will determine the
5923 * appropriate class to use based on the other fields (action, data,
5924 * type, categories) in the Intent. If this class is defined, the
5925 * specified class will always be used regardless of the other fields. You
5926 * should only set this value when you know you absolutely want a specific
5927 * class to be used; otherwise it is better to let the system find the
5928 * appropriate class so that you will respect the installed applications
5929 * and user preferences.
5930 *
5931 * @param component The name of the application component to handle the
5932 * intent, or null to let the system find one for you.
5933 *
5934 * @return Returns the same Intent object, for chaining multiple calls
5935 * into a single statement.
5936 *
5937 * @see #setClass
5938 * @see #setClassName(Context, String)
5939 * @see #setClassName(String, String)
5940 * @see #getComponent
5941 * @see #resolveActivity
5942 */
5943 public Intent setComponent(ComponentName component) {
5944 mComponent = component;
5945 return this;
5946 }
5947
5948 /**
5949 * Convenience for calling {@link #setComponent} with an
5950 * explicit class name.
5951 *
5952 * @param packageContext A Context of the application package implementing
5953 * this class.
5954 * @param className The name of a class inside of the application package
5955 * that will be used as the component for this Intent.
5956 *
5957 * @return Returns the same Intent object, for chaining multiple calls
5958 * into a single statement.
5959 *
5960 * @see #setComponent
5961 * @see #setClass
5962 */
5963 public Intent setClassName(Context packageContext, String className) {
5964 mComponent = new ComponentName(packageContext, className);
5965 return this;
5966 }
5967
5968 /**
5969 * Convenience for calling {@link #setComponent} with an
5970 * explicit application package name and class name.
5971 *
5972 * @param packageName The name of the package implementing the desired
5973 * component.
5974 * @param className The name of a class inside of the application package
5975 * that will be used as the component for this Intent.
5976 *
5977 * @return Returns the same Intent object, for chaining multiple calls
5978 * into a single statement.
5979 *
5980 * @see #setComponent
5981 * @see #setClass
5982 */
5983 public Intent setClassName(String packageName, String className) {
5984 mComponent = new ComponentName(packageName, className);
5985 return this;
5986 }
5987
5988 /**
5989 * Convenience for calling {@link #setComponent(ComponentName)} with the
5990 * name returned by a {@link Class} object.
5991 *
5992 * @param packageContext A Context of the application package implementing
5993 * this class.
5994 * @param cls The class name to set, equivalent to
5995 * <code>setClassName(context, cls.getName())</code>.
5996 *
5997 * @return Returns the same Intent object, for chaining multiple calls
5998 * into a single statement.
5999 *
6000 * @see #setComponent
6001 */
6002 public Intent setClass(Context packageContext, Class<?> cls) {
6003 mComponent = new ComponentName(packageContext, cls);
6004 return this;
6005 }
6006
6007 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006008 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6009 * used as a hint to the receiver for animations and the like. Null means that there
6010 * is no source bounds.
6011 */
6012 public void setSourceBounds(Rect r) {
6013 if (r != null) {
6014 mSourceBounds = new Rect(r);
6015 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006016 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006017 }
6018 }
6019
6020 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006021 * Use with {@link #fillIn} to allow the current action value to be
6022 * overwritten, even if it is already set.
6023 */
6024 public static final int FILL_IN_ACTION = 1<<0;
6025
6026 /**
6027 * Use with {@link #fillIn} to allow the current data or type value
6028 * overwritten, even if it is already set.
6029 */
6030 public static final int FILL_IN_DATA = 1<<1;
6031
6032 /**
6033 * Use with {@link #fillIn} to allow the current categories to be
6034 * overwritten, even if they are already set.
6035 */
6036 public static final int FILL_IN_CATEGORIES = 1<<2;
6037
6038 /**
6039 * Use with {@link #fillIn} to allow the current component value to be
6040 * overwritten, even if it is already set.
6041 */
6042 public static final int FILL_IN_COMPONENT = 1<<3;
6043
6044 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006045 * Use with {@link #fillIn} to allow the current package value to be
6046 * overwritten, even if it is already set.
6047 */
6048 public static final int FILL_IN_PACKAGE = 1<<4;
6049
6050 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006051 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006052 * overwritten, even if it is already set.
6053 */
6054 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6055
6056 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006057 * Use with {@link #fillIn} to allow the current selector to be
6058 * overwritten, even if it is already set.
6059 */
6060 public static final int FILL_IN_SELECTOR = 1<<6;
6061
6062 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006063 * Use with {@link #fillIn} to allow the current ClipData to be
6064 * overwritten, even if it is already set.
6065 */
6066 public static final int FILL_IN_CLIP_DATA = 1<<7;
6067
6068 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006069 * Copy the contents of <var>other</var> in to this object, but only
6070 * where fields are not defined by this object. For purposes of a field
6071 * being defined, the following pieces of data in the Intent are
6072 * considered to be separate fields:
6073 *
6074 * <ul>
6075 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006076 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006077 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6078 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006079 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006080 * <li> component, as set by {@link #setComponent(ComponentName)} or
6081 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006082 * <li> source bounds, as set by {@link #setSourceBounds}.
6083 * <li> selector, as set by {@link #setSelector(Intent)}.
6084 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006085 * <li> each top-level name in the associated extras.
6086 * </ul>
6087 *
6088 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006089 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006090 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6091 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6092 * the restriction where the corresponding field will not be replaced if
6093 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006094 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006095 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6096 * is explicitly specified. The selector will only be copied if
6097 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006098 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006099 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6100 * and Intent B with {action="gotit", data-type="some/thing",
6101 * categories="one","two"}.
6102 *
6103 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6104 * containing: {action="gotit", data-type="some/thing",
6105 * categories="bar"}.
6106 *
6107 * @param other Another Intent whose values are to be used to fill in
6108 * the current one.
6109 * @param flags Options to control which fields can be filled in.
6110 *
6111 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006112 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006113 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6114 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006115 */
6116 public int fillIn(Intent other, int flags) {
6117 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006118 if (other.mAction != null
6119 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006120 mAction = other.mAction;
6121 changes |= FILL_IN_ACTION;
6122 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006123 if ((other.mData != null || other.mType != null)
6124 && ((mData == null && mType == null)
6125 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006126 mData = other.mData;
6127 mType = other.mType;
6128 changes |= FILL_IN_DATA;
6129 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006130 if (other.mCategories != null
6131 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006132 if (other.mCategories != null) {
6133 mCategories = new HashSet<String>(other.mCategories);
6134 }
6135 changes |= FILL_IN_CATEGORIES;
6136 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006137 if (other.mPackage != null
6138 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006139 // Only do this if mSelector is not set.
6140 if (mSelector == null) {
6141 mPackage = other.mPackage;
6142 changes |= FILL_IN_PACKAGE;
6143 }
6144 }
6145 // Selector is special: it can only be set if explicitly allowed,
6146 // for the same reason as the component name.
6147 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6148 if (mPackage == null) {
6149 mSelector = new Intent(other.mSelector);
6150 mPackage = null;
6151 changes |= FILL_IN_SELECTOR;
6152 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006153 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006154 if (other.mClipData != null
6155 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6156 mClipData = other.mClipData;
6157 changes |= FILL_IN_CLIP_DATA;
6158 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006159 // Component is special: it can -only- be set if explicitly allowed,
6160 // since otherwise the sender could force the intent somewhere the
6161 // originator didn't intend.
6162 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006163 mComponent = other.mComponent;
6164 changes |= FILL_IN_COMPONENT;
6165 }
6166 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006167 if (other.mSourceBounds != null
6168 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6169 mSourceBounds = new Rect(other.mSourceBounds);
6170 changes |= FILL_IN_SOURCE_BOUNDS;
6171 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006172 if (mExtras == null) {
6173 if (other.mExtras != null) {
6174 mExtras = new Bundle(other.mExtras);
6175 }
6176 } else if (other.mExtras != null) {
6177 try {
6178 Bundle newb = new Bundle(other.mExtras);
6179 newb.putAll(mExtras);
6180 mExtras = newb;
6181 } catch (RuntimeException e) {
6182 // Modifying the extras can cause us to unparcel the contents
6183 // of the bundle, and if we do this in the system process that
6184 // may fail. We really should handle this (i.e., the Bundle
6185 // impl shouldn't be on top of a plain map), but for now just
6186 // ignore it and keep the original contents. :(
6187 Log.w("Intent", "Failure filling in extras", e);
6188 }
6189 }
6190 return changes;
6191 }
6192
6193 /**
6194 * Wrapper class holding an Intent and implementing comparisons on it for
6195 * the purpose of filtering. The class implements its
6196 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6197 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6198 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6199 * on the wrapped Intent.
6200 */
6201 public static final class FilterComparison {
6202 private final Intent mIntent;
6203 private final int mHashCode;
6204
6205 public FilterComparison(Intent intent) {
6206 mIntent = intent;
6207 mHashCode = intent.filterHashCode();
6208 }
6209
6210 /**
6211 * Return the Intent that this FilterComparison represents.
6212 * @return Returns the Intent held by the FilterComparison. Do
6213 * not modify!
6214 */
6215 public Intent getIntent() {
6216 return mIntent;
6217 }
6218
6219 @Override
6220 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006221 if (obj instanceof FilterComparison) {
6222 Intent other = ((FilterComparison)obj).mIntent;
6223 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006224 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006225 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006226 }
6227
6228 @Override
6229 public int hashCode() {
6230 return mHashCode;
6231 }
6232 }
6233
6234 /**
6235 * Determine if two intents are the same for the purposes of intent
6236 * resolution (filtering). That is, if their action, data, type,
6237 * class, and categories are the same. This does <em>not</em> compare
6238 * any extra data included in the intents.
6239 *
6240 * @param other The other Intent to compare against.
6241 *
6242 * @return Returns true if action, data, type, class, and categories
6243 * are the same.
6244 */
6245 public boolean filterEquals(Intent other) {
6246 if (other == null) {
6247 return false;
6248 }
6249 if (mAction != other.mAction) {
6250 if (mAction != null) {
6251 if (!mAction.equals(other.mAction)) {
6252 return false;
6253 }
6254 } else {
6255 if (!other.mAction.equals(mAction)) {
6256 return false;
6257 }
6258 }
6259 }
6260 if (mData != other.mData) {
6261 if (mData != null) {
6262 if (!mData.equals(other.mData)) {
6263 return false;
6264 }
6265 } else {
6266 if (!other.mData.equals(mData)) {
6267 return false;
6268 }
6269 }
6270 }
6271 if (mType != other.mType) {
6272 if (mType != null) {
6273 if (!mType.equals(other.mType)) {
6274 return false;
6275 }
6276 } else {
6277 if (!other.mType.equals(mType)) {
6278 return false;
6279 }
6280 }
6281 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006282 if (mPackage != other.mPackage) {
6283 if (mPackage != null) {
6284 if (!mPackage.equals(other.mPackage)) {
6285 return false;
6286 }
6287 } else {
6288 if (!other.mPackage.equals(mPackage)) {
6289 return false;
6290 }
6291 }
6292 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006293 if (mComponent != other.mComponent) {
6294 if (mComponent != null) {
6295 if (!mComponent.equals(other.mComponent)) {
6296 return false;
6297 }
6298 } else {
6299 if (!other.mComponent.equals(mComponent)) {
6300 return false;
6301 }
6302 }
6303 }
6304 if (mCategories != other.mCategories) {
6305 if (mCategories != null) {
6306 if (!mCategories.equals(other.mCategories)) {
6307 return false;
6308 }
6309 } else {
6310 if (!other.mCategories.equals(mCategories)) {
6311 return false;
6312 }
6313 }
6314 }
6315
6316 return true;
6317 }
6318
6319 /**
6320 * Generate hash code that matches semantics of filterEquals().
6321 *
6322 * @return Returns the hash value of the action, data, type, class, and
6323 * categories.
6324 *
6325 * @see #filterEquals
6326 */
6327 public int filterHashCode() {
6328 int code = 0;
6329 if (mAction != null) {
6330 code += mAction.hashCode();
6331 }
6332 if (mData != null) {
6333 code += mData.hashCode();
6334 }
6335 if (mType != null) {
6336 code += mType.hashCode();
6337 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006338 if (mPackage != null) {
6339 code += mPackage.hashCode();
6340 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006341 if (mComponent != null) {
6342 code += mComponent.hashCode();
6343 }
6344 if (mCategories != null) {
6345 code += mCategories.hashCode();
6346 }
6347 return code;
6348 }
6349
6350 @Override
6351 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006352 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006353
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006354 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006355 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006356 b.append(" }");
6357
6358 return b.toString();
6359 }
6360
6361 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006362 public String toInsecureString() {
6363 StringBuilder b = new StringBuilder(128);
6364
6365 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006366 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006367 b.append(" }");
6368
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006369 return b.toString();
6370 }
Romain Guy4969af72009-06-17 10:53:19 -07006371
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006372 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006373 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006374 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006375
6376 b.append("Intent { ");
6377 toShortString(b, false, true, true, true);
6378 b.append(" }");
6379
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006380 return b.toString();
6381 }
6382
6383 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006384 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6385 StringBuilder b = new StringBuilder(128);
6386 toShortString(b, secure, comp, extras, clip);
6387 return b.toString();
6388 }
6389
6390 /** @hide */
6391 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6392 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006393 boolean first = true;
6394 if (mAction != null) {
6395 b.append("act=").append(mAction);
6396 first = false;
6397 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006398 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006399 if (!first) {
6400 b.append(' ');
6401 }
6402 first = false;
6403 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 Iterator<String> i = mCategories.iterator();
6405 boolean didone = false;
6406 while (i.hasNext()) {
6407 if (didone) b.append(",");
6408 didone = true;
6409 b.append(i.next());
6410 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006411 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006412 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006413 if (mData != null) {
6414 if (!first) {
6415 b.append(' ');
6416 }
6417 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006418 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006419 if (secure) {
6420 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006421 } else {
6422 b.append(mData);
6423 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006424 }
6425 if (mType != null) {
6426 if (!first) {
6427 b.append(' ');
6428 }
6429 first = false;
6430 b.append("typ=").append(mType);
6431 }
6432 if (mFlags != 0) {
6433 if (!first) {
6434 b.append(' ');
6435 }
6436 first = false;
6437 b.append("flg=0x").append(Integer.toHexString(mFlags));
6438 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006439 if (mPackage != null) {
6440 if (!first) {
6441 b.append(' ');
6442 }
6443 first = false;
6444 b.append("pkg=").append(mPackage);
6445 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006446 if (comp && mComponent != null) {
6447 if (!first) {
6448 b.append(' ');
6449 }
6450 first = false;
6451 b.append("cmp=").append(mComponent.flattenToShortString());
6452 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006453 if (mSourceBounds != null) {
6454 if (!first) {
6455 b.append(' ');
6456 }
6457 first = false;
6458 b.append("bnds=").append(mSourceBounds.toShortString());
6459 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006460 if (mClipData != null) {
6461 if (!first) {
6462 b.append(' ');
6463 }
6464 first = false;
6465 if (clip) {
6466 b.append("clip={");
6467 mClipData.toShortString(b);
6468 b.append('}');
6469 } else {
6470 b.append("(has clip)");
6471 }
6472 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006473 if (extras && mExtras != null) {
6474 if (!first) {
6475 b.append(' ');
6476 }
6477 first = false;
6478 b.append("(has extras)");
6479 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006480 if (mSelector != null) {
6481 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006482 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006483 b.append("}");
6484 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006485 }
6486
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006487 /**
6488 * Call {@link #toUri} with 0 flags.
6489 * @deprecated Use {@link #toUri} instead.
6490 */
6491 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006492 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006493 return toUri(0);
6494 }
6495
6496 /**
6497 * Convert this Intent into a String holding a URI representation of it.
6498 * The returned URI string has been properly URI encoded, so it can be
6499 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6500 * Intent's data as the base URI, with an additional fragment describing
6501 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006502 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006503 * <p>You can convert the returned string back to an Intent with
6504 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006505 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006506 * @param flags Additional operating flags. Either 0 or
6507 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006508 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006509 * @return Returns a URI encoding URI string describing the entire contents
6510 * of the Intent.
6511 */
6512 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006513 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006514 String scheme = null;
6515 if (mData != null) {
6516 String data = mData.toString();
6517 if ((flags&URI_INTENT_SCHEME) != 0) {
6518 final int N = data.length();
6519 for (int i=0; i<N; i++) {
6520 char c = data.charAt(i);
6521 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6522 || c == '.' || c == '-') {
6523 continue;
6524 }
6525 if (c == ':' && i > 0) {
6526 // Valid scheme.
6527 scheme = data.substring(0, i);
6528 uri.append("intent:");
6529 data = data.substring(i+1);
6530 break;
6531 }
Tom Taylord4a47292009-12-21 13:59:18 -08006532
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006533 // No scheme.
6534 break;
6535 }
6536 }
6537 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006538
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006539 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6540 uri.append("intent:");
6541 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006542
6543 uri.append("#Intent;");
6544
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006545 toUriInner(uri, scheme, flags);
6546 if (mSelector != null) {
6547 uri.append("SEL;");
6548 // Note that for now we are not going to try to handle the
6549 // data part; not clear how to represent this as a URI, and
6550 // not much utility in it.
6551 mSelector.toUriInner(uri, null, flags);
6552 }
6553
6554 uri.append("end");
6555
6556 return uri.toString();
6557 }
6558
6559 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006560 if (scheme != null) {
6561 uri.append("scheme=").append(scheme).append(';');
6562 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006563 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006564 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006565 }
6566 if (mCategories != null) {
6567 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006568 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006569 }
6570 }
6571 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006572 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006573 }
6574 if (mFlags != 0) {
6575 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6576 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006577 if (mPackage != null) {
6578 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6579 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006580 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006581 uri.append("component=").append(Uri.encode(
6582 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006583 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006584 if (mSourceBounds != null) {
6585 uri.append("sourceBounds=")
6586 .append(Uri.encode(mSourceBounds.flattenToString()))
6587 .append(';');
6588 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006589 if (mExtras != null) {
6590 for (String key : mExtras.keySet()) {
6591 final Object value = mExtras.get(key);
6592 char entryType =
6593 value instanceof String ? 'S' :
6594 value instanceof Boolean ? 'B' :
6595 value instanceof Byte ? 'b' :
6596 value instanceof Character ? 'c' :
6597 value instanceof Double ? 'd' :
6598 value instanceof Float ? 'f' :
6599 value instanceof Integer ? 'i' :
6600 value instanceof Long ? 'l' :
6601 value instanceof Short ? 's' :
6602 '\0';
6603
6604 if (entryType != '\0') {
6605 uri.append(entryType);
6606 uri.append('.');
6607 uri.append(Uri.encode(key));
6608 uri.append('=');
6609 uri.append(Uri.encode(value.toString()));
6610 uri.append(';');
6611 }
6612 }
6613 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006614 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006615
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006616 public int describeContents() {
6617 return (mExtras != null) ? mExtras.describeContents() : 0;
6618 }
6619
6620 public void writeToParcel(Parcel out, int flags) {
6621 out.writeString(mAction);
6622 Uri.writeToParcel(out, mData);
6623 out.writeString(mType);
6624 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006625 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006626 ComponentName.writeToParcel(mComponent, out);
6627
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006628 if (mSourceBounds != null) {
6629 out.writeInt(1);
6630 mSourceBounds.writeToParcel(out, flags);
6631 } else {
6632 out.writeInt(0);
6633 }
6634
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006635 if (mCategories != null) {
6636 out.writeInt(mCategories.size());
6637 for (String category : mCategories) {
6638 out.writeString(category);
6639 }
6640 } else {
6641 out.writeInt(0);
6642 }
6643
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006644 if (mSelector != null) {
6645 out.writeInt(1);
6646 mSelector.writeToParcel(out, flags);
6647 } else {
6648 out.writeInt(0);
6649 }
6650
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006651 if (mClipData != null) {
6652 out.writeInt(1);
6653 mClipData.writeToParcel(out, flags);
6654 } else {
6655 out.writeInt(0);
6656 }
6657
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006658 out.writeBundle(mExtras);
6659 }
6660
6661 public static final Parcelable.Creator<Intent> CREATOR
6662 = new Parcelable.Creator<Intent>() {
6663 public Intent createFromParcel(Parcel in) {
6664 return new Intent(in);
6665 }
6666 public Intent[] newArray(int size) {
6667 return new Intent[size];
6668 }
6669 };
6670
Dianne Hackborneb034652009-09-07 00:49:58 -07006671 /** @hide */
6672 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006673 readFromParcel(in);
6674 }
6675
6676 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006677 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006678 mData = Uri.CREATOR.createFromParcel(in);
6679 mType = in.readString();
6680 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006681 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006682 mComponent = ComponentName.readFromParcel(in);
6683
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006684 if (in.readInt() != 0) {
6685 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6686 }
6687
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006688 int N = in.readInt();
6689 if (N > 0) {
6690 mCategories = new HashSet<String>();
6691 int i;
6692 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006693 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006694 }
6695 } else {
6696 mCategories = null;
6697 }
6698
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006699 if (in.readInt() != 0) {
6700 mSelector = new Intent(in);
6701 }
6702
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006703 if (in.readInt() != 0) {
6704 mClipData = new ClipData(in);
6705 }
6706
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006707 mExtras = in.readBundle();
6708 }
6709
6710 /**
6711 * Parses the "intent" element (and its children) from XML and instantiates
6712 * an Intent object. The given XML parser should be located at the tag
6713 * where parsing should start (often named "intent"), from which the
6714 * basic action, data, type, and package and class name will be
6715 * retrieved. The function will then parse in to any child elements,
6716 * looking for <category android:name="xxx"> tags to add categories and
6717 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6718 * to the intent.
6719 *
6720 * @param resources The Resources to use when inflating resources.
6721 * @param parser The XML parser pointing at an "intent" tag.
6722 * @param attrs The AttributeSet interface for retrieving extended
6723 * attribute data at the current <var>parser</var> location.
6724 * @return An Intent object matching the XML data.
6725 * @throws XmlPullParserException If there was an XML parsing error.
6726 * @throws IOException If there was an I/O error.
6727 */
6728 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6729 throws XmlPullParserException, IOException {
6730 Intent intent = new Intent();
6731
6732 TypedArray sa = resources.obtainAttributes(attrs,
6733 com.android.internal.R.styleable.Intent);
6734
6735 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6736
6737 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6738 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6739 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6740
6741 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6742 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6743 if (packageName != null && className != null) {
6744 intent.setComponent(new ComponentName(packageName, className));
6745 }
6746
6747 sa.recycle();
6748
6749 int outerDepth = parser.getDepth();
6750 int type;
6751 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6752 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6753 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6754 continue;
6755 }
6756
6757 String nodeName = parser.getName();
6758 if (nodeName.equals("category")) {
6759 sa = resources.obtainAttributes(attrs,
6760 com.android.internal.R.styleable.IntentCategory);
6761 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6762 sa.recycle();
6763
6764 if (cat != null) {
6765 intent.addCategory(cat);
6766 }
6767 XmlUtils.skipCurrentTag(parser);
6768
6769 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006770 if (intent.mExtras == null) {
6771 intent.mExtras = new Bundle();
6772 }
6773 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6774 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006775
6776 } else {
6777 XmlUtils.skipCurrentTag(parser);
6778 }
6779 }
6780
6781 return intent;
6782 }
Nick Pellyccae4122012-01-09 14:12:58 -08006783
6784 /**
6785 * Normalize a MIME data type.
6786 *
6787 * <p>A normalized MIME type has white-space trimmed,
6788 * content-type parameters removed, and is lower-case.
6789 * This aligns the type with Android best practices for
6790 * intent filtering.
6791 *
6792 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6793 * "text/x-vCard" becomes "text/x-vcard".
6794 *
6795 * <p>All MIME types received from outside Android (such as user input,
6796 * or external sources like Bluetooth, NFC, or the Internet) should
6797 * be normalized before they are used to create an Intent.
6798 *
6799 * @param type MIME data type to normalize
6800 * @return normalized MIME data type, or null if the input was null
6801 * @see {@link #setType}
6802 * @see {@link #setTypeAndNormalize}
6803 */
6804 public static String normalizeMimeType(String type) {
6805 if (type == null) {
6806 return null;
6807 }
6808
6809 type = type.trim().toLowerCase(Locale.US);
6810
6811 final int semicolonIndex = type.indexOf(';');
6812 if (semicolonIndex != -1) {
6813 type = type.substring(0, semicolonIndex);
6814 }
6815 return type;
6816 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006817
6818 /**
6819 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006820 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6821 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006822 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006823 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006824 * @hide
6825 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006826 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006827 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006828 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006829
6830 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006831 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006832
6833 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006834 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006835 try {
6836 // Inspect target intent to see if we need to migrate
6837 final Intent target = getParcelableExtra(EXTRA_INTENT);
6838 if (target != null && target.migrateExtraStreamToClipData()) {
6839 // Since we migrated in child, we need to promote ClipData
6840 // and flags to ourselves to grant.
6841 setClipData(target.getClipData());
6842 addFlags(target.getFlags()
6843 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6844 return true;
6845 } else {
6846 return false;
6847 }
6848 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006849 }
6850
6851 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006852 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006853 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6854 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6855 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6856 if (stream != null || text != null || htmlText != null) {
6857 final ClipData clipData = new ClipData(
6858 null, new String[] { getType() },
6859 new ClipData.Item(text, htmlText, null, stream));
6860 setClipData(clipData);
6861 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006862 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006863 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006864 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006865 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006866
6867 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006868 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006869 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6870 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6871 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6872 int num = -1;
6873 if (streams != null) {
6874 num = streams.size();
6875 }
6876 if (texts != null) {
6877 if (num >= 0 && num != texts.size()) {
6878 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006879 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006880 }
6881 num = texts.size();
6882 }
6883 if (htmlTexts != null) {
6884 if (num >= 0 && num != htmlTexts.size()) {
6885 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006886 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006887 }
6888 num = htmlTexts.size();
6889 }
6890 if (num > 0) {
6891 final ClipData clipData = new ClipData(
6892 null, new String[] { getType() },
6893 makeClipItem(streams, texts, htmlTexts, 0));
6894
6895 for (int i = 1; i < num; i++) {
6896 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6897 }
6898
6899 setClipData(clipData);
6900 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006901 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006902 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006903 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006904 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006905 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006906
6907 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006908 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006909
6910 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6911 ArrayList<String> htmlTexts, int which) {
6912 Uri uri = streams != null ? streams.get(which) : null;
6913 CharSequence text = texts != null ? texts.get(which) : null;
6914 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6915 return new ClipData.Item(text, htmlText, null, uri);
6916 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006917}