blob: 2ffb63cf6ac0285644c1a36ce12fc1add33d715f [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";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001143
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001144 /**
Jim Miller07994402012-05-02 14:22:27 -07001145 * Activity Action: Perform assist action.
1146 * <p>
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001147 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1148 * additional optional contextual information about where the user was when they requested
1149 * the assist.
Jim Miller07994402012-05-02 14:22:27 -07001150 * Output: nothing.
1151 */
1152 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1153 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001154
1155 /**
1156 * An optional field on {@link #ACTION_ASSIST} containing the name of the current
1157 * foreground application package at the time the assist was invoked.
1158 */
1159 public static final String EXTRA_ASSIST_PACKAGE
1160 = "android.intent.extra.ASSIST_PACKAGE";
1161
1162 /**
1163 * An optional field on {@link #ACTION_ASSIST} containing additional contextual
1164 * information supplied by the current foreground app at the time of the assist
1165 * request. This is a {@link Bundle} of additional data.
1166 */
1167 public static final String EXTRA_ASSIST_CONTEXT
1168 = "android.intent.extra.ASSIST_CONTEXT";
1169
Jim Miller07994402012-05-02 14:22:27 -07001170 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001171 * Activity Action: List all available applications
1172 * <p>Input: Nothing.
1173 * <p>Output: nothing.
1174 */
1175 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1176 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1177 /**
1178 * Activity Action: Show settings for choosing wallpaper
1179 * <p>Input: Nothing.
1180 * <p>Output: Nothing.
1181 */
1182 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1183 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1184
1185 /**
1186 * Activity Action: Show activity for reporting a bug.
1187 * <p>Input: Nothing.
1188 * <p>Output: Nothing.
1189 */
1190 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1191 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1192
1193 /**
1194 * Activity Action: Main entry point for factory tests. Only used when
1195 * the device is booting in factory test node. The implementing package
1196 * must be installed in the system image.
1197 * <p>Input: nothing
1198 * <p>Output: nothing
1199 */
1200 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1201
1202 /**
1203 * Activity Action: The user pressed the "call" button to go to the dialer
1204 * or other appropriate UI for placing a call.
1205 * <p>Input: Nothing.
1206 * <p>Output: Nothing.
1207 */
1208 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1209 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1210
1211 /**
1212 * Activity Action: Start Voice Command.
1213 * <p>Input: Nothing.
1214 * <p>Output: Nothing.
1215 */
1216 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1217 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001218
1219 /**
1220 * Activity Action: Start action associated with long pressing on the
1221 * search key.
1222 * <p>Input: Nothing.
1223 * <p>Output: Nothing.
1224 */
1225 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1226 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001227
Jacek Surazski86b6c532009-05-13 14:38:28 +02001228 /**
1229 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1230 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001231 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001232 * <p>Input: No data is specified. The bug report is passed in using
1233 * an {@link #EXTRA_BUG_REPORT} field.
1234 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001235 *
1236 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001237 */
1238 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1239 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001240
1241 /**
1242 * Activity Action: Show power usage information to the user.
1243 * <p>Input: Nothing.
1244 * <p>Output: Nothing.
1245 */
1246 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1247 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001248
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001249 /**
1250 * Activity Action: Setup wizard to launch after a platform update. This
1251 * activity should have a string meta-data field associated with it,
1252 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1253 * the platform for setup. The activity will be launched only if
1254 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1255 * same value.
1256 * <p>Input: Nothing.
1257 * <p>Output: Nothing.
1258 * @hide
1259 */
1260 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1261 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001262
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001263 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001264 * Activity Action: Show settings for managing network data usage of a
1265 * specific application. Applications should define an activity that offers
1266 * options to control data usage.
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_MANAGE_NETWORK_USAGE =
1270 "android.intent.action.MANAGE_NETWORK_USAGE";
1271
1272 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001273 * Activity Action: Launch application installer.
1274 * <p>
1275 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001276 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1277 * you can also use "package:<package-name>" to install an application for the
1278 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001279 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1280 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1281 * <p>
1282 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1283 * succeeded.
1284 *
1285 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1286 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1287 * @see #EXTRA_RETURN_RESULT
1288 */
1289 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1290 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1291
1292 /**
1293 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1294 * package. Specifies the installer package name; this package will receive the
1295 * {@link #ACTION_APP_ERROR} intent.
1296 */
1297 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1298 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1299
1300 /**
1301 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1302 * package. Specifies that the application being installed should not be
1303 * treated as coming from an unknown source, but as coming from the app
1304 * invoking the Intent. For this to work you must start the installer with
1305 * startActivityForResult().
1306 */
1307 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1308 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1309
1310 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001311 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1312 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001313 * data field originated from.
1314 */
rich cannings706e8ba2012-08-20 13:20:14 -07001315 public static final String EXTRA_ORIGINATING_URI
1316 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001317
1318 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001319 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1320 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1321 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001322 */
1323 public static final String EXTRA_REFERRER
1324 = "android.intent.extra.REFERRER";
1325
1326 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001327 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1328 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1329 * @hide
1330 */
1331 public static final String EXTRA_ORIGINATING_UID
1332 = "android.intent.extra.ORIGINATING_UID";
1333
1334 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001335 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1336 * package. Tells the installer UI to skip the confirmation with the user
1337 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001338 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1339 * will no longer show an interstitial message about updating existing
1340 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001341 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001342 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001343 public static final String EXTRA_ALLOW_REPLACE
1344 = "android.intent.extra.ALLOW_REPLACE";
1345
1346 /**
1347 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1348 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1349 * return to the application the result code of the install/uninstall. The returned result
1350 * code will be {@link android.app.Activity#RESULT_OK} on success or
1351 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1352 */
1353 public static final String EXTRA_RETURN_RESULT
1354 = "android.intent.extra.RETURN_RESULT";
1355
1356 /**
1357 * Package manager install result code. @hide because result codes are not
1358 * yet ready to be exposed.
1359 */
1360 public static final String EXTRA_INSTALL_RESULT
1361 = "android.intent.extra.INSTALL_RESULT";
1362
1363 /**
1364 * Activity Action: Launch application uninstaller.
1365 * <p>
1366 * Input: The data must be a package: URI whose scheme specific part is
1367 * the package name of the current installed package to be uninstalled.
1368 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1369 * <p>
1370 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1371 * succeeded.
1372 */
1373 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1374 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1375
1376 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001377 * Specify whether the package should be uninstalled for all users.
1378 * @hide because these should not be part of normal application flow.
1379 */
1380 public static final String EXTRA_UNINSTALL_ALL_USERS
1381 = "android.intent.extra.UNINSTALL_ALL_USERS";
1382
1383 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001384 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1385 * describing the last run version of the platform that was setup.
1386 * @hide
1387 */
1388 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1389
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001390 // ---------------------------------------------------------------------
1391 // ---------------------------------------------------------------------
1392 // Standard intent broadcast actions (see action variable).
1393
1394 /**
1395 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001396 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001397 * <p class="note">This is a protected intent that can only be sent
1398 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001399 */
1400 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1401 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1402 /**
1403 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001404 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001405 * <p class="note">This is a protected intent that can only be sent
1406 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001407 */
1408 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1409 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001410
1411 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001412 * Broadcast Action: Sent after the system stops dreaming.
1413 *
1414 * <p class="note">This is a protected intent that can only be sent by the system.
1415 * It is only sent to registered receivers.</p>
1416 */
1417 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1418 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1419
1420 /**
1421 * Broadcast Action: Sent after the system starts dreaming.
1422 *
1423 * <p class="note">This is a protected intent that can only be sent by the system.
1424 * It is only sent to registered receivers.</p>
1425 */
1426 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1427 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1428
1429 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001430 * 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 -07001431 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001432 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001433 * <p class="note">This is a protected intent that can only be sent
1434 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001435 */
1436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001437 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001438
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001439 /**
1440 * Broadcast Action: The current time has changed. Sent every
1441 * minute. You can <em>not</em> receive this through components declared
1442 * in manifests, only by exlicitly registering for it with
1443 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1444 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001445 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001446 * <p class="note">This is a protected intent that can only be sent
1447 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001448 */
1449 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1450 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1451 /**
1452 * Broadcast Action: The time was set.
1453 */
1454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1455 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1456 /**
1457 * Broadcast Action: The date has changed.
1458 */
1459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1460 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1461 /**
1462 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1463 * <ul>
1464 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1465 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001466 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001467 * <p class="note">This is a protected intent that can only be sent
1468 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001469 */
1470 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1471 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1472 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001473 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1474 * DNS entries should be tossed.
1475 * @hide
1476 */
1477 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1478 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1479 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001480 * Alarm Changed Action: This is broadcast when the AlarmClock
1481 * application's alarm is set or unset. It is used by the
1482 * AlarmClock application and the StatusBar service.
1483 * @hide
1484 */
1485 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1486 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1487 /**
1488 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1489 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1490 * @hide
1491 */
1492 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1493 public static final String ACTION_SYNC_STATE_CHANGED
1494 = "android.intent.action.SYNC_STATE_CHANGED";
1495 /**
1496 * Broadcast Action: This is broadcast once, after the system has finished
1497 * booting. It can be used to perform application-specific initialization,
1498 * such as installing alarms. You must hold the
1499 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1500 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001501 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001502 * <p class="note">This is a protected intent that can only be sent
1503 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001504 */
1505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1506 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1507 /**
1508 * Broadcast Action: This is broadcast when a user action should request a
1509 * temporary system dialog to dismiss. Some examples of temporary system
1510 * dialogs are the notification window-shade and the recent tasks dialog.
1511 */
1512 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1513 /**
1514 * Broadcast Action: Trigger the download and eventual installation
1515 * of a package.
1516 * <p>Input: {@link #getData} is the URI of the package file to download.
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.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001520 *
1521 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001522 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001523 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001524 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1525 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1526 /**
1527 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001528 * device. The data contains the name of the package. Note that the
1529 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001530 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001531 * <ul>
1532 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1533 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1534 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1535 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001536 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001537 * <p class="note">This is a protected intent that can only be sent
1538 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001539 */
1540 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1541 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1542 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001543 * Broadcast Action: A new version of an application package has been
1544 * installed, replacing an existing version that was previously installed.
1545 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001546 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001547 * <ul>
1548 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1549 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001550 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001551 * <p class="note">This is a protected intent that can only be sent
1552 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001553 */
1554 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1555 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1556 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001557 * Broadcast Action: A new version of your application has been installed
1558 * over an existing one. This is only sent to the application that was
1559 * replaced. It does not contain any additional data; to receive it, just
1560 * use an intent filter for this action.
1561 *
1562 * <p class="note">This is a protected intent that can only be sent
1563 * by the system.
1564 */
1565 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1566 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1567 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001568 * Broadcast Action: An existing application package has been removed from
1569 * the device. The data contains the name of the package. The package
1570 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001571 * <ul>
1572 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1573 * to the package.
1574 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1575 * application -- data and code -- is being removed.
1576 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1577 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1578 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001579 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001580 * <p class="note">This is a protected intent that can only be sent
1581 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001582 */
1583 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1584 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1585 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001586 * Broadcast Action: An existing application package has been completely
1587 * removed from the device. The data contains the name of the package.
1588 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1589 * {@link #EXTRA_DATA_REMOVED} is true and
1590 * {@link #EXTRA_REPLACING} is false of that broadcast.
1591 *
1592 * <ul>
1593 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1594 * to the package.
1595 * </ul>
1596 *
1597 * <p class="note">This is a protected intent that can only be sent
1598 * by the system.
1599 */
1600 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1601 public static final String ACTION_PACKAGE_FULLY_REMOVED
1602 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1603 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001604 * Broadcast Action: An existing application package has been changed (e.g.
1605 * a component has been enabled or disabled). The data contains the name of
1606 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001607 * <ul>
1608 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001609 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1610 * of the changed components.
1611 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1612 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001613 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001614 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001615 * <p class="note">This is a protected intent that can only be sent
1616 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001617 */
1618 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1619 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1620 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001621 * @hide
1622 * Broadcast Action: Ask system services if there is any reason to
1623 * restart the given package. The data contains the name of the
1624 * package.
1625 * <ul>
1626 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1627 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1628 * </ul>
1629 *
1630 * <p class="note">This is a protected intent that can only be sent
1631 * by the system.
1632 */
1633 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1634 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1635 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001636 * Broadcast Action: The user has restarted a package, and all of its
1637 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001638 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001639 * be removed. Note that the restarted package does <em>not</em>
1640 * receive this broadcast.
1641 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001642 * <ul>
1643 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1644 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001645 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001646 * <p class="note">This is a protected intent that can only be sent
1647 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001648 */
1649 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1650 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1651 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001652 * Broadcast Action: The user has cleared the data of a package. This should
1653 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001654 * its persistent data is erased and this broadcast sent.
1655 * Note that the cleared package does <em>not</em>
1656 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001657 * <ul>
1658 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1659 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001660 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001661 * <p class="note">This is a protected intent that can only be sent
1662 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001663 */
1664 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1665 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1666 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001667 * Broadcast Action: A user ID has been removed from the system. The user
1668 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001669 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001670 * <p class="note">This is a protected intent that can only be sent
1671 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001672 */
1673 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1674 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001675
1676 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001677 * Broadcast Action: Sent to the installer package of an application
1678 * when that application is first launched (that is the first time it
1679 * is moved out of the stopped state). The data contains the name of the package.
1680 *
1681 * <p class="note">This is a protected intent that can only be sent
1682 * by the system.
1683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1685 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1686
1687 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001688 * Broadcast Action: Sent to the system package verifier when a package
1689 * needs to be verified. The data contains the package URI.
1690 * <p class="note">
1691 * This is a protected intent that can only be sent by the system.
1692 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001693 */
1694 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1695 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1696
1697 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001698 * Broadcast Action: Sent to the system package verifier when a package is
1699 * verified. The data contains the package URI.
1700 * <p class="note">
1701 * This is a protected intent that can only be sent by the system.
1702 */
1703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1704 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1705
1706 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001707 * Broadcast Action: Resources for a set of packages (which were
1708 * previously unavailable) are currently
1709 * available since the media on which they exist is available.
1710 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1711 * list of packages whose availability changed.
1712 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1713 * list of uids of packages whose availability changed.
1714 * Note that the
1715 * packages in this list do <em>not</em> receive this broadcast.
1716 * The specified set of packages are now available on the system.
1717 * <p>Includes the following extras:
1718 * <ul>
1719 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1720 * whose resources(were previously unavailable) are currently available.
1721 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1722 * packages whose resources(were previously unavailable)
1723 * are currently available.
1724 * </ul>
1725 *
1726 * <p class="note">This is a protected intent that can only be sent
1727 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001728 */
1729 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001730 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1731 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001732
1733 /**
1734 * Broadcast Action: Resources for a set of packages are currently
1735 * unavailable since the media on which they exist is unavailable.
1736 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1737 * list of packages whose availability changed.
1738 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1739 * list of uids of packages whose availability changed.
1740 * The specified set of packages can no longer be
1741 * launched and are practically unavailable on the system.
1742 * <p>Inclues the following extras:
1743 * <ul>
1744 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1745 * whose resources are no longer available.
1746 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1747 * whose resources are no longer available.
1748 * </ul>
1749 *
1750 * <p class="note">This is a protected intent that can only be sent
1751 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001752 */
1753 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001754 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001755 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001756
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001757 /**
1758 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001759 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001760 * This should <em>only</em> be used to determine when the wallpaper
1761 * has changed to show the new wallpaper to the user. You should certainly
1762 * never, in response to this, change the wallpaper or other attributes of
1763 * it such as the suggested size. That would be crazy, right? You'd cause
1764 * all kinds of loops, especially if other apps are doing similar things,
1765 * right? Of course. So please don't do this.
1766 *
1767 * @deprecated Modern applications should use
1768 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1769 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1770 * shown behind their UI, rather than watching for this broadcast and
1771 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001772 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001773 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001774 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1775 /**
1776 * Broadcast Action: The current device {@link android.content.res.Configuration}
1777 * (orientation, locale, etc) has changed. When such a change happens, the
1778 * UIs (view hierarchy) will need to be rebuilt based on this new
1779 * information; for the most part, applications don't need to worry about
1780 * this, because the system will take care of stopping and restarting the
1781 * application to make sure it sees the new changes. Some system code that
1782 * can not be restarted will need to watch for this action and handle it
1783 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001784 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001785 * <p class="note">
1786 * You can <em>not</em> receive this through components declared
1787 * in manifests, only by explicitly registering for it with
1788 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1789 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001790 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001791 * <p class="note">This is a protected intent that can only be sent
1792 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 *
1794 * @see android.content.res.Configuration
1795 */
1796 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1797 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1798 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001799 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001800 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001801 * <p class="note">This is a protected intent that can only be sent
1802 * by the system.
1803 */
1804 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1805 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1806 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001807 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1808 * charging state, level, and other information about the battery.
1809 * See {@link android.os.BatteryManager} for documentation on the
1810 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001811 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001812 * <p class="note">
1813 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001814 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001815 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001816 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1817 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1818 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1819 * broadcasts that are sent and can be received through manifest
1820 * receivers.
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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001824 */
1825 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1826 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1827 /**
1828 * Broadcast Action: Indicates low battery condition on the device.
1829 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001830 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001831 * <p class="note">This is a protected intent that can only be sent
1832 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001833 */
1834 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1835 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1836 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001837 * Broadcast Action: Indicates the battery is now okay after being low.
1838 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1839 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001840 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001841 * <p class="note">This is a protected intent that can only be sent
1842 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001843 */
1844 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1845 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1846 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001847 * Broadcast Action: External power has been connected to the device.
1848 * This is intended for applications that wish to register specifically to this notification.
1849 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1850 * stay active to receive this notification. This action can be used to implement actions
1851 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001853 * <p class="note">This is a protected intent that can only be sent
1854 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001857 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001858 /**
1859 * Broadcast Action: External power has been removed from the device.
1860 * This is intended for applications that wish to register specifically to this notification.
1861 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1862 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001863 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001864 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001865 * <p class="note">This is a protected intent that can only be sent
1866 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001867 */
1868 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001869 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001870 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001871 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001872 * Broadcast Action: Device is shutting down.
1873 * This is broadcast when the device is being shut down (completely turned
1874 * off, not sleeping). Once the broadcast is complete, the final shutdown
1875 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001876 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001877 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001878 * <p class="note">This is a protected intent that can only be sent
1879 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001880 */
1881 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001882 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001883 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001884 * Activity Action: Start this activity to request system shutdown.
1885 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1886 * to request confirmation from the user before shutting down.
1887 *
1888 * <p class="note">This is a protected intent that can only be sent
1889 * by the system.
1890 *
1891 * {@hide}
1892 */
1893 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1894 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001895 * Broadcast Action: A sticky broadcast that indicates low memory
1896 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001897 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001898 * <p class="note">This is a protected intent that can only be sent
1899 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1902 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1903 /**
1904 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001905 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001906 * <p class="note">This is a protected intent that can only be sent
1907 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001908 */
1909 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1910 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1911 /**
Jake Hambybb371632010-08-23 18:16:48 -07001912 * Broadcast Action: A sticky broadcast that indicates a memory full
1913 * condition on the device. This is intended for activities that want
1914 * to be able to fill the data partition completely, leaving only
1915 * enough free space to prevent system-wide SQLite failures.
1916 *
1917 * <p class="note">This is a protected intent that can only be sent
1918 * by the system.
1919 *
1920 * {@hide}
1921 */
1922 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1923 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1924 /**
1925 * Broadcast Action: Indicates memory full condition on the device
1926 * no longer exists.
1927 *
1928 * <p class="note">This is a protected intent that can only be sent
1929 * by the system.
1930 *
1931 * {@hide}
1932 */
1933 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1934 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1935 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001936 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1937 * and package management should be started.
1938 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1939 * notification.
1940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1943 /**
1944 * Broadcast Action: The device has entered USB Mass Storage mode.
1945 * This is used mainly for the USB Settings panel.
1946 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1947 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001948 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001949 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001950 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001951 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1952
1953 /**
1954 * Broadcast Action: The device has exited USB Mass Storage mode.
1955 * This is used mainly for the USB Settings panel.
1956 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1957 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001958 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001959 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001960 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001961 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1962
1963 /**
1964 * Broadcast Action: External media has been removed.
1965 * The path to the mount point for the removed media is contained in the Intent.mData field.
1966 */
1967 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1968 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1969
1970 /**
1971 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001972 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 */
1974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1975 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1976
1977 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001978 * Broadcast Action: External media is present, and being disk-checked
1979 * 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 -08001980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1983
1984 /**
1985 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1986 * 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 -08001987 */
1988 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1989 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1990
1991 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001992 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001993 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001994 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1995 * media was mounted read only.
1996 */
1997 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1998 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1999
2000 /**
2001 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002002 * 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 -07002003 */
2004 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2005 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2006
2007 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002008 * Broadcast Action: External media is no longer being shared via USB mass storage.
2009 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2010 *
2011 * @hide
2012 */
2013 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2014
2015 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2017 * The path to the mount point for the removed media is contained in the Intent.mData field.
2018 */
2019 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2020 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2021
2022 /**
2023 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002024 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002025 */
2026 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2027 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2028
2029 /**
2030 * Broadcast Action: User has expressed the desire to remove the external storage media.
2031 * Applications should close all files they have open within the mount point when they receive this intent.
2032 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2033 */
2034 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2035 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2036
2037 /**
2038 * Broadcast Action: The media scanner has started scanning a directory.
2039 * The path to the directory being scanned is contained in the Intent.mData field.
2040 */
2041 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2042 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2043
2044 /**
2045 * Broadcast Action: The media scanner has finished scanning a directory.
2046 * The path to the scanned directory is contained in the Intent.mData field.
2047 */
2048 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2049 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2050
2051 /**
2052 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2053 * The path to the file is contained in the Intent.mData field.
2054 */
2055 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2056 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2057
2058 /**
2059 * Broadcast Action: The "Media Button" was pressed. Includes a single
2060 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2061 * caused the broadcast.
2062 */
2063 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2064 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2065
2066 /**
2067 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2068 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2069 * caused the broadcast.
2070 */
2071 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2072 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2073
2074 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2075 // location; they are not general-purpose actions.
2076
2077 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002078 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002079 */
2080 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2081 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2082 "android.intent.action.GTALK_CONNECTED";
2083
2084 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002085 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002086 */
2087 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2088 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2089 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002090
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002091 /**
2092 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002093 */
2094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2095 public static final String ACTION_INPUT_METHOD_CHANGED =
2096 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002097
2098 /**
2099 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2100 * more radios have been turned off or on. The intent will have the following extra value:</p>
2101 * <ul>
2102 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2103 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2104 * turned off</li>
2105 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002106 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002107 * <p class="note">This is a protected intent that can only be sent
2108 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002109 */
2110 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2111 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2112
2113 /**
2114 * Broadcast Action: Some content providers have parts of their namespace
2115 * where they publish new events or items that the user may be especially
2116 * interested in. For these things, they may broadcast this action when the
2117 * set of interesting items change.
2118 *
2119 * For example, GmailProvider sends this notification when the set of unread
2120 * mail in the inbox changes.
2121 *
2122 * <p>The data of the intent identifies which part of which provider
2123 * changed. When queried through the content resolver, the data URI will
2124 * return the data set in question.
2125 *
2126 * <p>The intent will have the following extra values:
2127 * <ul>
2128 * <li><em>count</em> - The number of items in the data set. This is the
2129 * same as the number of items in the cursor returned by querying the
2130 * data URI. </li>
2131 * </ul>
2132 *
2133 * This intent will be sent at boot (if the count is non-zero) and when the
2134 * data set changes. It is possible for the data set to change without the
2135 * count changing (for example, if a new unread message arrives in the same
2136 * sync operation in which a message is archived). The phone should still
2137 * ring/vibrate/etc as normal in this case.
2138 */
2139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2140 public static final String ACTION_PROVIDER_CHANGED =
2141 "android.intent.action.PROVIDER_CHANGED";
2142
2143 /**
2144 * Broadcast Action: Wired Headset plugged in or unplugged.
2145 *
2146 * <p>The intent will have the following extra values:
2147 * <ul>
2148 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2149 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002150 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002151 * </ul>
2152 * </ul>
2153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_HEADSET_PLUG =
2156 "android.intent.action.HEADSET_PLUG";
2157
2158 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002159 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2160 *
2161 * <p>The intent will have the following extra values:
2162 * <ul>
2163 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2164 * <li><em>name</em> - Headset type, human readable string </li>
2165 * </ul>
2166 * </ul>
2167 * @hide
2168 */
2169 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002170 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2171 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002172
2173 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002174 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002175 *
2176 * <p>The intent will have the following extra values:
2177 * <ul>
2178 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2179 * <li><em>name</em> - Headset type, human readable string </li>
2180 * </ul>
2181 * </ul>
2182 * @hide
2183 */
2184 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002185 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2186 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002187
2188 /**
2189 * Broadcast Action: A HMDI cable was plugged or unplugged
2190 *
2191 * <p>The intent will have the following extra values:
2192 * <ul>
2193 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2194 * <li><em>name</em> - HDMI cable, human readable string </li>
2195 * </ul>
2196 * </ul>
2197 * @hide
2198 */
2199 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2200 public static final String ACTION_HDMI_AUDIO_PLUG =
2201 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002202
2203 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002204 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2205 *
2206 * <p>The intent will have the following extra values:
2207 * <ul>
2208 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2209 * <li><em>card</em> - ALSA card number (integer) </li>
2210 * <li><em>device</em> - ALSA device number (integer) </li>
2211 * </ul>
2212 * </ul>
2213 * @hide
2214 */
2215 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2216 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2217 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2218
2219 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002220 * Broadcast Action: A USB audio device was plugged in or unplugged.
2221 *
2222 * <p>The intent will have the following extra values:
2223 * <ul>
2224 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2225 * <li><em>card</em> - ALSA card number (integer) </li>
2226 * <li><em>device</em> - ALSA device number (integer) </li>
2227 * </ul>
2228 * </ul>
2229 * @hide
2230 */
2231 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2232 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2233 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2234
2235 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002236 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2237 * <ul>
2238 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2239 * </ul>
2240 *
2241 * <p class="note">This is a protected intent that can only be sent
2242 * by the system.
2243 *
2244 * @hide
2245 */
2246 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2247 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2248 = "android.intent.action.ADVANCED_SETTINGS";
2249
2250 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002251 * Broadcast Action: An outgoing call is about to be placed.
2252 *
2253 * <p>The Intent will have the following extra value:
2254 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002255 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002256 * the phone number originally intended to be dialed.</li>
2257 * </ul>
2258 * <p>Once the broadcast is finished, the resultData is used as the actual
2259 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002260 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002261 * outgoing call in turn: for example, a parental control application
2262 * might verify that the user is authorized to place the call at that
2263 * time, then a number-rewriting application might add an area code if
2264 * one was not specified.</p>
2265 * <p>For consistency, any receiver whose purpose is to prohibit phone
2266 * calls should have a priority of 0, to ensure it will see the final
2267 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002268 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002269 * should have a positive priority.
2270 * Negative priorities are reserved for the system for this broadcast;
2271 * using them may cause problems.</p>
2272 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2273 * abort the broadcast.</p>
2274 * <p>Emergency calls cannot be intercepted using this mechanism, and
2275 * other calls cannot be modified to call emergency numbers using this
2276 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002277 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002278 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2279 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002280 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002281 * <p class="note">This is a protected intent that can only be sent
2282 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002283 */
2284 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2285 public static final String ACTION_NEW_OUTGOING_CALL =
2286 "android.intent.action.NEW_OUTGOING_CALL";
2287
2288 /**
2289 * Broadcast Action: Have the device reboot. This is only for use by
2290 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002291 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002292 * <p class="note">This is a protected intent that can only be sent
2293 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002294 */
2295 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2296 public static final String ACTION_REBOOT =
2297 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002298
Wei Huang97ecc9c2009-05-11 17:44:20 -07002299 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002300 * Broadcast Action: A sticky broadcast for changes in the physical
2301 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002302 *
2303 * <p>The intent will have the following extra values:
2304 * <ul>
2305 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002306 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002307 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002308 * <p>This is intended for monitoring the current physical dock state.
2309 * See {@link android.app.UiModeManager} for the normal API dealing with
2310 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002311 */
2312 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2313 public static final String ACTION_DOCK_EVENT =
2314 "android.intent.action.DOCK_EVENT";
2315
2316 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002317 * Broadcast Action: a remote intent is to be broadcasted.
2318 *
2319 * A remote intent is used for remote RPC between devices. The remote intent
2320 * is serialized and sent from one device to another device. The receiving
2321 * device parses the remote intent and broadcasts it. Note that anyone can
2322 * broadcast a remote intent. However, if the intent receiver of the remote intent
2323 * does not trust intent broadcasts from arbitrary intent senders, it should require
2324 * the sender to hold certain permissions so only trusted sender's broadcast will be
2325 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002326 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002327 */
2328 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002329 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002330
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002331 /**
2332 * Broadcast Action: hook for permforming cleanup after a system update.
2333 *
2334 * The broadcast is sent when the system is booting, before the
2335 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2336 * image. A receiver for this should do its work and then disable itself
2337 * so that it does not get run again at the next boot.
2338 * @hide
2339 */
2340 public static final String ACTION_PRE_BOOT_COMPLETED =
2341 "android.intent.action.PRE_BOOT_COMPLETED";
2342
Amith Yamasani13593602012-03-22 16:16:17 -07002343 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002344 * Sent the first time a user is starting, to allow system apps to
2345 * perform one time initialization. (This will not be seen by third
2346 * party applications because a newly initialized user does not have any
2347 * third party applications installed for it.) This is sent early in
2348 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002349 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2350 * broadcast, since it is part of a visible user interaction; be as quick
2351 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002352 */
2353 public static final String ACTION_USER_INITIALIZE =
2354 "android.intent.action.USER_INITIALIZE";
2355
2356 /**
2357 * Sent when a user switch is happening, causing the process's user to be
2358 * brought to the foreground. This is only sent to receivers registered
2359 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2360 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002361 * foreground. This is sent as a foreground
2362 * broadcast, since it is part of a visible user interaction; be as quick
2363 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002364 */
2365 public static final String ACTION_USER_FOREGROUND =
2366 "android.intent.action.USER_FOREGROUND";
2367
2368 /**
2369 * Sent when a user switch is happening, causing the process's user to be
2370 * sent to the background. This is only sent to receivers registered
2371 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2372 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002373 * background. 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 */
2377 public static final String ACTION_USER_BACKGROUND =
2378 "android.intent.action.USER_BACKGROUND";
2379
2380 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002381 * Broadcast sent to the system when a user is added. Carries an extra
2382 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2383 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002384 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002385 * @hide
2386 */
2387 public static final String ACTION_USER_ADDED =
2388 "android.intent.action.USER_ADDED";
2389
2390 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002391 * Broadcast sent by the system when a user is started. Carries an extra
2392 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002393 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002394 * that has been started. This is sent as a foreground
2395 * broadcast, since it is part of a visible user interaction; be as quick
2396 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002397 * @hide
2398 */
2399 public static final String ACTION_USER_STARTED =
2400 "android.intent.action.USER_STARTED";
2401
2402 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002403 * Broadcast sent when a user is in the process of starting. Carries an extra
2404 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2405 * sent to registered receivers, not manifest receivers. It is sent to all
2406 * users (including the one that is being started). You must hold
2407 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2408 * this broadcast. This is sent as a background broadcast, since
2409 * its result is not part of the primary UX flow; to safely keep track of
2410 * started/stopped state of a user you can use this in conjunction with
2411 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2412 * other user state broadcasts since those are foreground broadcasts so can
2413 * execute in a different order.
2414 * @hide
2415 */
2416 public static final String ACTION_USER_STARTING =
2417 "android.intent.action.USER_STARTING";
2418
2419 /**
2420 * Broadcast sent when a user is going to be stopped. Carries an extra
2421 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2422 * sent to registered receivers, not manifest receivers. It is sent to all
2423 * users (including the one that is being stopped). You must hold
2424 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2425 * this broadcast. The user will not stop until all receivers have
2426 * handled the broadcast. This is sent as a background broadcast, since
2427 * its result is not part of the primary UX flow; to safely keep track of
2428 * started/stopped state of a user you can use this in conjunction with
2429 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2430 * other user state broadcasts since those are foreground broadcasts so can
2431 * execute in a different order.
2432 * @hide
2433 */
2434 public static final String ACTION_USER_STOPPING =
2435 "android.intent.action.USER_STOPPING";
2436
2437 /**
2438 * Broadcast sent to the system when a user is stopped. Carries an extra
2439 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2440 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2441 * specific package. This is only sent to registered receivers, not manifest
2442 * receivers. It is sent to all running users <em>except</em> the one that
2443 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002444 * @hide
2445 */
2446 public static final String ACTION_USER_STOPPED =
2447 "android.intent.action.USER_STOPPED";
2448
2449 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002450 * 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 -07002451 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002452 * one that has been removed. The user will not be completely removed until all receivers have
2453 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002454 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002455 * @hide
2456 */
2457 public static final String ACTION_USER_REMOVED =
2458 "android.intent.action.USER_REMOVED";
2459
2460 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002461 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002462 * the userHandle of the user to become the current one. This is only sent to
2463 * registered receivers, not manifest receivers. It is sent to all running users.
2464 * You must hold
2465 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002466 * @hide
2467 */
2468 public static final String ACTION_USER_SWITCHED =
2469 "android.intent.action.USER_SWITCHED";
2470
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002471 /**
2472 * Broadcast sent to the system when a user's information changes. Carries an extra
2473 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2474 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2475 * whose information has changed.
2476 * @hide
2477 */
2478 public static final String ACTION_USER_INFO_CHANGED =
2479 "android.intent.action.USER_INFO_CHANGED";
2480
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002481 /**
2482 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2483 */
2484 public static final String ACTION_QUICK_CLOCK =
2485 "android.intent.action.QUICK_CLOCK";
2486
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002487 // ---------------------------------------------------------------------
2488 // ---------------------------------------------------------------------
2489 // Standard intent categories (see addCategory()).
2490
2491 /**
2492 * Set if the activity should be an option for the default action
2493 * (center press) to perform on a piece of data. Setting this will
2494 * hide from the user any activities without it set when performing an
2495 * action on some data. Note that this is normal -not- set in the
2496 * Intent when initiating an action -- it is for use in intent filters
2497 * specified in packages.
2498 */
2499 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2500 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2501 /**
2502 * Activities that can be safely invoked from a browser must support this
2503 * category. For example, if the user is viewing a web page or an e-mail
2504 * and clicks on a link in the text, the Intent generated execute that
2505 * link will require the BROWSABLE category, so that only activities
2506 * supporting this category will be considered as possible actions. By
2507 * supporting this category, you are promising that there is nothing
2508 * damaging (without user intervention) that can happen by invoking any
2509 * matching Intent.
2510 */
2511 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2512 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2513 /**
2514 * Set if the activity should be considered as an alternative action to
2515 * the data the user is currently viewing. See also
2516 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2517 * applies to the selection in a list of items.
2518 *
2519 * <p>Supporting this category means that you would like your activity to be
2520 * displayed in the set of alternative things the user can do, usually as
2521 * part of the current activity's options menu. You will usually want to
2522 * include a specific label in the &lt;intent-filter&gt; of this action
2523 * describing to the user what it does.
2524 *
2525 * <p>The action of IntentFilter with this category is important in that it
2526 * describes the specific action the target will perform. This generally
2527 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2528 * a specific name such as "com.android.camera.action.CROP. Only one
2529 * alternative of any particular action will be shown to the user, so using
2530 * a specific action like this makes sure that your alternative will be
2531 * displayed while also allowing other applications to provide their own
2532 * overrides of that particular action.
2533 */
2534 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2535 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2536 /**
2537 * Set if the activity should be considered as an alternative selection
2538 * action to the data the user has currently selected. This is like
2539 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2540 * of items from which the user can select, giving them alternatives to the
2541 * default action that will be performed on it.
2542 */
2543 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2544 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2545 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002546 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002547 */
2548 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2549 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2550 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002551 * Should be displayed in the top-level launcher.
2552 */
2553 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2554 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2555 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002556 * Provides information about the package it is in; typically used if
2557 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2558 * a front-door to the user without having to be shown in the all apps list.
2559 */
2560 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2561 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2562 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002563 * This is the home activity, that is the first activity that is displayed
2564 * when the device boots.
2565 */
2566 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2567 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2568 /**
2569 * This activity is a preference panel.
2570 */
2571 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2572 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2573 /**
2574 * This activity is a development preference panel.
2575 */
2576 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2577 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2578 /**
2579 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002580 */
2581 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2582 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2583 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002584 * This activity allows the user to browse and download new applications.
2585 */
2586 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2587 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2588 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002589 * This activity may be exercised by the monkey or other automated test tools.
2590 */
2591 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2592 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2593 /**
2594 * To be used as a test (not part of the normal user experience).
2595 */
2596 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2597 /**
2598 * To be used as a unit test (run through the Test Harness).
2599 */
2600 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2601 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002602 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002603 * experience).
2604 */
2605 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2606 /**
2607 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2608 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2609 * when queried, though it is allowable for those columns to be blank.
2610 */
2611 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2612 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2613
2614 /**
2615 * To be used as code under test for framework instrumentation tests.
2616 */
2617 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2618 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002619 /**
2620 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002621 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2622 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002623 */
2624 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2625 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2626 /**
2627 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002628 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2629 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002630 */
2631 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2632 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002633 /**
2634 * An activity to run when device is inserted into a analog (low end) dock.
2635 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2636 * information, see {@link android.app.UiModeManager}.
2637 */
2638 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2639 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2640
2641 /**
2642 * An activity to run when device is inserted into a digital (high end) dock.
2643 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2644 * information, see {@link android.app.UiModeManager}.
2645 */
2646 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2647 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002648
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002649 /**
2650 * Used to indicate that the activity can be used in a car environment.
2651 */
2652 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2653 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2654
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002655 // ---------------------------------------------------------------------
2656 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002657 // Application launch intent categories (see addCategory()).
2658
2659 /**
2660 * Used with {@link #ACTION_MAIN} to launch the browser application.
2661 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002662 * <p>NOTE: This should not be used as the primary key of an Intent,
2663 * since it will not result in the app launching with the correct
2664 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002665 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002666 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002667 */
2668 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2669 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2670
2671 /**
2672 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2673 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002674 * <p>NOTE: This should not be used as the primary key of an Intent,
2675 * since it will not result in the app launching with the correct
2676 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002677 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002678 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002679 */
2680 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2681 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2682
2683 /**
2684 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2685 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002686 * <p>NOTE: This should not be used as the primary key of an Intent,
2687 * since it will not result in the app launching with the correct
2688 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002689 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002690 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002691 */
2692 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2693 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2694
2695 /**
2696 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2697 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002698 * <p>NOTE: This should not be used as the primary key of an Intent,
2699 * since it will not result in the app launching with the correct
2700 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002701 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002702 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002703 */
2704 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2705 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2706
2707 /**
2708 * Used with {@link #ACTION_MAIN} to launch the email application.
2709 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002710 * <p>NOTE: This should not be used as the primary key of an Intent,
2711 * since it will not result in the app launching with the correct
2712 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002713 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002714 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002715 */
2716 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2717 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2718
2719 /**
2720 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2721 * The activity should be able to view and manipulate image and video files
2722 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002723 * <p>NOTE: This should not be used as the primary key of an Intent,
2724 * since it will not result in the app launching with the correct
2725 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002726 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002727 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002728 */
2729 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2730 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2731
2732 /**
2733 * Used with {@link #ACTION_MAIN} to launch the maps application.
2734 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002735 * <p>NOTE: This should not be used as the primary key of an Intent,
2736 * since it will not result in the app launching with the correct
2737 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002738 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002739 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002740 */
2741 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2742 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2743
2744 /**
2745 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2746 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002747 * <p>NOTE: This should not be used as the primary key of an Intent,
2748 * since it will not result in the app launching with the correct
2749 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002750 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002751 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002752 */
2753 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2754 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2755
2756 /**
2757 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002758 * The activity should be able to play, browse, or manipulate music files
2759 * stored on the device.
2760 * <p>NOTE: This should not be used as the primary key of an Intent,
2761 * since it will not result in the app launching with the correct
2762 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002763 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002764 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002765 */
2766 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2767 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2768
2769 // ---------------------------------------------------------------------
2770 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002771 // Standard extra data keys.
2772
2773 /**
2774 * The initial data to place in a newly created record. Use with
2775 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2776 * fields as would be given to the underlying ContentProvider.insert()
2777 * call.
2778 */
2779 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2780
2781 /**
2782 * A constant CharSequence that is associated with the Intent, used with
2783 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2784 * this may be a styled CharSequence, so you must use
2785 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2786 * retrieve it.
2787 */
2788 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2789
2790 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002791 * A constant String that is associated with the Intent, used with
2792 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2793 * as HTML formatted text. Note that you <em>must</em> also supply
2794 * {@link #EXTRA_TEXT}.
2795 */
2796 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2797
2798 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002799 * A content: URI holding a stream of data associated with the Intent,
2800 * used with {@link #ACTION_SEND} to supply the data being sent.
2801 */
2802 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2803
2804 /**
2805 * A String[] holding e-mail addresses that should be delivered to.
2806 */
2807 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2808
2809 /**
2810 * A String[] holding e-mail addresses that should be carbon copied.
2811 */
2812 public static final String EXTRA_CC = "android.intent.extra.CC";
2813
2814 /**
2815 * A String[] holding e-mail addresses that should be blind carbon copied.
2816 */
2817 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2818
2819 /**
2820 * A constant string holding the desired subject line of a message.
2821 */
2822 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2823
2824 /**
2825 * An Intent describing the choices you would like shown with
2826 * {@link #ACTION_PICK_ACTIVITY}.
2827 */
2828 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2829
2830 /**
2831 * A CharSequence dialog title to provide to the user when used with a
2832 * {@link #ACTION_CHOOSER}.
2833 */
2834 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2835
2836 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002837 * A Parcelable[] of {@link Intent} or
2838 * {@link android.content.pm.LabeledIntent} objects as set with
2839 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2840 * a the front of the list of choices, when shown to the user with a
2841 * {@link #ACTION_CHOOSER}.
2842 */
2843 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2844
2845 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002846 * A {@link android.view.KeyEvent} object containing the event that
2847 * triggered the creation of the Intent it is in.
2848 */
2849 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2850
2851 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002852 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2853 * before shutting down.
2854 *
2855 * {@hide}
2856 */
2857 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2858
2859 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002860 * 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 -07002861 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2862 * of restarting the application.
2863 */
2864 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2865
2866 /**
2867 * A String holding the phone number originally entered in
2868 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2869 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2870 */
2871 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002872
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002873 /**
2874 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2875 * intents to supply the uid the package had been assigned. Also an optional
2876 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2877 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2878 * purpose.
2879 */
2880 public static final String EXTRA_UID = "android.intent.extra.UID";
2881
2882 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002883 * @hide String array of package names.
2884 */
2885 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2886
2887 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002888 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2889 * intents to indicate whether this represents a full uninstall (removing
2890 * both the code and its data) or a partial uninstall (leaving its data,
2891 * implying that this is an update).
2892 */
2893 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002894
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002895 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002896 * @hide
2897 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2898 * intents to indicate that at this point the package has been removed for
2899 * all users on the device.
2900 */
2901 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2902 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2903
2904 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002905 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2906 * intents to indicate that this is a replacement of the package, so this
2907 * broadcast will immediately be followed by an add broadcast for a
2908 * different version of the same package.
2909 */
2910 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002911
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002912 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002913 * Used as an int extra field in {@link android.app.AlarmManager} intents
2914 * to tell the application being invoked how many pending alarms are being
2915 * delievered with the intent. For one-shot alarms this will always be 1.
2916 * For recurring alarms, this might be greater than 1 if the device was
2917 * asleep or powered off at the time an earlier alarm would have been
2918 * delivered.
2919 */
2920 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002921
Jacek Surazski86b6c532009-05-13 14:38:28 +02002922 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002923 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2924 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002925 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2926 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002927 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2928 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2929 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002930 */
2931 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2932
2933 /**
2934 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2935 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002936 */
2937 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2938
2939 /**
2940 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2941 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002942 */
2943 public static final int EXTRA_DOCK_STATE_DESK = 1;
2944
2945 /**
2946 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2947 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002948 */
2949 public static final int EXTRA_DOCK_STATE_CAR = 2;
2950
2951 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002952 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2953 * to represent that the phone is in a analog (low end) dock.
2954 */
2955 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2956
2957 /**
2958 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2959 * to represent that the phone is in a digital (high end) dock.
2960 */
2961 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2962
2963 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002964 * Boolean that can be supplied as meta-data with a dock activity, to
2965 * indicate that the dock should take over the home key when it is active.
2966 */
2967 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002968
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002969 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002970 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2971 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002972 */
2973 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2974
2975 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002976 * Used in the extra field in the remote intent. It's astring token passed with the
2977 * remote intent.
2978 */
2979 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2980 "android.intent.extra.remote_intent_token";
2981
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002982 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002983 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002984 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002985 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002986 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002987 "android.intent.extra.changed_component_name";
2988
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002989 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002990 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002991 * and contains a string array of all of the components that have changed.
2992 */
2993 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2994 "android.intent.extra.changed_component_name_list";
2995
2996 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002997 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002998 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2999 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003000 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003001 */
3002 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3003 "android.intent.extra.changed_package_list";
3004
3005 /**
3006 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003007 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3008 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003009 * and contains an integer array of uids of all of the components
3010 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003011 */
3012 public static final String EXTRA_CHANGED_UID_LIST =
3013 "android.intent.extra.changed_uid_list";
3014
3015 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003016 * @hide
3017 * Magic extra system code can use when binding, to give a label for
3018 * who it is that has bound to a service. This is an integer giving
3019 * a framework string resource that can be displayed to the user.
3020 */
3021 public static final String EXTRA_CLIENT_LABEL =
3022 "android.intent.extra.client_label";
3023
3024 /**
3025 * @hide
3026 * Magic extra system code can use when binding, to give a PendingIntent object
3027 * that can be launched for the user to disable the system's use of this
3028 * service.
3029 */
3030 public static final String EXTRA_CLIENT_INTENT =
3031 "android.intent.extra.client_intent";
3032
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003033 /**
3034 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3035 * data that is on the local device. This is a boolean extra; the default
3036 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3037 * the user to select media that is already on the device, not requiring it
3038 * be downloaded from a remote service when opened. Another way to look
3039 * at it is that such content should generally have a "_data" column to the
3040 * path of the content on local external storage.
3041 */
3042 public static final String EXTRA_LOCAL_ONLY =
3043 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003044
Amith Yamasani13593602012-03-22 16:16:17 -07003045 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003046 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003047 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3048 * @hide
3049 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003050 public static final String EXTRA_USER_HANDLE =
3051 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003052
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003053 // ---------------------------------------------------------------------
3054 // ---------------------------------------------------------------------
3055 // Intent flags (see mFlags variable).
3056
3057 /**
3058 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003059 * perform read operations on the Uri in the Intent's data and any URIs
3060 * specified in its ClipData. When applying to an Intent's ClipData,
3061 * all URIs as well as recursive traversals through data or other ClipData
3062 * in Intent items will be granted; only the grant flags of the top-level
3063 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003064 */
3065 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3066 /**
3067 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003068 * perform write operations on the Uri in the Intent's data and any URIs
3069 * specified in its ClipData. When applying to an Intent's ClipData,
3070 * all URIs as well as recursive traversals through data or other ClipData
3071 * in Intent items will be granted; only the grant flags of the top-level
3072 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003073 */
3074 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3075 /**
3076 * Can be set by the caller to indicate that this Intent is coming from
3077 * a background operation, not from direct user interaction.
3078 */
3079 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3080 /**
3081 * A flag you can enable for debugging: when set, log messages will be
3082 * printed during the resolution of this intent to show you what has
3083 * been found to create the final resolved list.
3084 */
3085 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003086 /**
3087 * If set, this intent will not match any components in packages that
3088 * are currently stopped. If this is not set, then the default behavior
3089 * is to include such applications in the result.
3090 */
3091 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3092 /**
3093 * If set, this intent will always match any components in packages that
3094 * are currently stopped. This is the default behavior when
3095 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3096 * flags are set, this one wins (it allows overriding of exclude for
3097 * places where the framework may automatically set the exclude flag).
3098 */
3099 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003100
3101 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003102 * If set, the new activity is not kept in the history stack. As soon as
3103 * the user navigates away from it, the activity is finished. This may also
3104 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3105 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003106 */
3107 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3108 /**
3109 * If set, the activity will not be launched if it is already running
3110 * at the top of the history stack.
3111 */
3112 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3113 /**
3114 * If set, this activity will become the start of a new task on this
3115 * history stack. A task (from the activity that started it to the
3116 * next task activity) defines an atomic group of activities that the
3117 * user can move to. Tasks can be moved to the foreground and background;
3118 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003119 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003120 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3121 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003122 *
3123 * <p>This flag is generally used by activities that want
3124 * to present a "launcher" style behavior: they give the user a list of
3125 * separate things that can be done, which otherwise run completely
3126 * independently of the activity launching them.
3127 *
3128 * <p>When using this flag, if a task is already running for the activity
3129 * you are now starting, then a new activity will not be started; instead,
3130 * the current task will simply be brought to the front of the screen with
3131 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3132 * to disable this behavior.
3133 *
3134 * <p>This flag can not be used when the caller is requesting a result from
3135 * the activity being launched.
3136 */
3137 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3138 /**
3139 * <strong>Do not use this flag unless you are implementing your own
3140 * top-level application launcher.</strong> Used in conjunction with
3141 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3142 * behavior of bringing an existing task to the foreground. When set,
3143 * a new task is <em>always</em> started to host the Activity for the
3144 * Intent, regardless of whether there is already an existing task running
3145 * the same thing.
3146 *
3147 * <p><strong>Because the default system does not include graphical task management,
3148 * you should not use this flag unless you provide some way for a user to
3149 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003150 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003151 * <p>This flag is ignored if
3152 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3153 *
Scott Main7aee61f2011-02-08 11:25:01 -08003154 * <p>See
3155 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3156 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003157 */
3158 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3159 /**
3160 * If set, and the activity being launched is already running in the
3161 * current task, then instead of launching a new instance of that activity,
3162 * all of the other activities on top of it will be closed and this Intent
3163 * will be delivered to the (now on top) old activity as a new Intent.
3164 *
3165 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3166 * If D calls startActivity() with an Intent that resolves to the component
3167 * of activity B, then C and D will be finished and B receive the given
3168 * Intent, resulting in the stack now being: A, B.
3169 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003170 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003171 * either receive the new intent you are starting here in its
3172 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003173 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003174 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3175 * the same intent, then it will be finished and re-created; for all other
3176 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3177 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003178 *
3179 * <p>This launch mode can also be used to good effect in conjunction with
3180 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3181 * of a task, it will bring any currently running instance of that task
3182 * to the foreground, and then clear it to its root state. This is
3183 * especially useful, for example, when launching an activity from the
3184 * notification manager.
3185 *
Scott Main7aee61f2011-02-08 11:25:01 -08003186 * <p>See
3187 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3188 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003189 */
3190 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3191 /**
3192 * If set and this intent is being used to launch a new activity from an
3193 * existing one, then the reply target of the existing activity will be
3194 * transfered to the new activity. This way the new activity can call
3195 * {@link android.app.Activity#setResult} and have that result sent back to
3196 * the reply target of the original activity.
3197 */
3198 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3199 /**
3200 * If set and this intent is being used to launch a new activity from an
3201 * existing one, the current activity will not be counted as the top
3202 * activity for deciding whether the new intent should be delivered to
3203 * the top instead of starting a new one. The previous activity will
3204 * be used as the top, with the assumption being that the current activity
3205 * will finish itself immediately.
3206 */
3207 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3208 /**
3209 * If set, the new activity is not kept in the list of recently launched
3210 * activities.
3211 */
3212 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3213 /**
3214 * This flag is not normally set by application code, but set for you by
3215 * the system as described in the
3216 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3217 * launchMode} documentation for the singleTask mode.
3218 */
3219 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3220 /**
3221 * If set, and this activity is either being started in a new task or
3222 * bringing to the top an existing task, then it will be launched as
3223 * the front door of the task. This will result in the application of
3224 * any affinities needed to have that task in the proper state (either
3225 * moving activities to or from it), or simply resetting that task to
3226 * its initial state if needed.
3227 */
3228 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3229 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003230 * This flag is not normally set by application code, but set for you by
3231 * the system if this activity is being launched from history
3232 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003233 */
3234 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003235 /**
3236 * If set, this marks a point in the task's activity stack that should
3237 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003238 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003239 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3240 * the user re-launching it from home), this activity and all on top of
3241 * it will be finished so that the user does not return to them, but
3242 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003243 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003244 * <p>This is useful for cases where you have a logical break in your
3245 * application. For example, an e-mail application may have a command
3246 * to view an attachment, which launches an image view activity to
3247 * display it. This activity should be part of the e-mail application's
3248 * task, since it is a part of the task the user is involved in. However,
3249 * if the user leaves that task, and later selects the e-mail app from
3250 * home, we may like them to return to the conversation they were
3251 * viewing, not the picture attachment, since that is confusing. By
3252 * setting this flag when launching the image viewer, that viewer and
3253 * any activities it starts will be removed the next time the user returns
3254 * to mail.
3255 */
3256 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003257 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003258 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003259 * callback from occurring on the current frontmost activity before it is
3260 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003261 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003262 * <p>Typically, an activity can rely on that callback to indicate that an
3263 * explicit user action has caused their activity to be moved out of the
3264 * foreground. The callback marks an appropriate point in the activity's
3265 * lifecycle for it to dismiss any notifications that it intends to display
3266 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003267 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003268 * <p>If an activity is ever started via any non-user-driven events such as
3269 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3270 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003271 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003272 */
3273 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003274 /**
3275 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3276 * this flag will cause the launched activity to be brought to the front of its
3277 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003278 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003279 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3280 * If D calls startActivity() with an Intent that resolves to the component
3281 * of activity B, then B will be brought to the front of the history stack,
3282 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003283 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003284 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003285 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003286 */
3287 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003288 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003289 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3290 * this flag will prevent the system from applying an activity transition
3291 * animation to go to the next activity state. This doesn't mean an
3292 * animation will never run -- if another activity change happens that doesn't
3293 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003294 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003295 * when you are going to do a series of activity operations but the
3296 * animation seen by the user shouldn't be driven by the first activity
3297 * change but rather a later one.
3298 */
3299 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3300 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003301 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3302 * this flag will cause any existing task that would be associated with the
3303 * activity to be cleared before the activity is started. That is, the activity
3304 * becomes the new root of an otherwise empty task, and any old activities
3305 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3306 */
3307 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3308 /**
3309 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3310 * this flag will cause a newly launching task to be placed on top of the current
3311 * home activity task (if there is one). That is, pressing back from the task
3312 * will always return the user to home even if that was not the last activity they
3313 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3314 */
3315 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3316 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003317 * If set, when sending a broadcast only registered receivers will be
3318 * called -- no BroadcastReceiver components will be launched.
3319 */
3320 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003321 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003322 * If set, when sending a broadcast the new broadcast will replace
3323 * any existing pending broadcast that matches it. Matching is defined
3324 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3325 * true for the intents of the two broadcasts. When a match is found,
3326 * the new broadcast (and receivers associated with it) will replace the
3327 * existing one in the pending broadcast list, remaining at the same
3328 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003329 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003330 * <p>This flag is most typically used with sticky broadcasts, which
3331 * only care about delivering the most recent values of the broadcast
3332 * to their receivers.
3333 */
3334 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3335 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003336 * If set, when sending a broadcast the recipient is allowed to run at
3337 * foreground priority, with a shorter timeout interval. During normal
3338 * broadcasts the receivers are not automatically hoisted out of the
3339 * background priority class.
3340 */
3341 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3342 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003343 * If set, when sending a broadcast <i>before boot has completed</i> only
3344 * registered receivers will be called -- no BroadcastReceiver components
3345 * will be launched. Sticky intent state will be recorded properly even
3346 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3347 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003348 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003349 * <p>This flag is only for use by system sevices as a convenience to
3350 * avoid having to implement a more complex mechanism around detection
3351 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003352 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003353 * @hide
3354 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003355 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003356 /**
3357 * Set when this broadcast is for a boot upgrade, a special mode that
3358 * allows the broadcast to be sent before the system is ready and launches
3359 * the app process with no providers running in it.
3360 * @hide
3361 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003362 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003363
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003364 /**
3365 * @hide Flags that can't be changed with PendingIntent.
3366 */
3367 public static final int IMMUTABLE_FLAGS =
3368 FLAG_GRANT_READ_URI_PERMISSION
3369 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003370
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003371 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003372 // ---------------------------------------------------------------------
3373 // toUri() and parseUri() options.
3374
3375 /**
3376 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3377 * always has the "intent:" scheme. This syntax can be used when you want
3378 * to later disambiguate between URIs that are intended to describe an
3379 * Intent vs. all others that should be treated as raw URIs. When used
3380 * with {@link #parseUri}, any other scheme will result in a generic
3381 * VIEW action for that raw URI.
3382 */
3383 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003384
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003385 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003386
3387 private String mAction;
3388 private Uri mData;
3389 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003390 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003391 private ComponentName mComponent;
3392 private int mFlags;
3393 private HashSet<String> mCategories;
3394 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003395 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003396 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003397 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003398
3399 // ---------------------------------------------------------------------
3400
3401 /**
3402 * Create an empty intent.
3403 */
3404 public Intent() {
3405 }
3406
3407 /**
3408 * Copy constructor.
3409 */
3410 public Intent(Intent o) {
3411 this.mAction = o.mAction;
3412 this.mData = o.mData;
3413 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003414 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003415 this.mComponent = o.mComponent;
3416 this.mFlags = o.mFlags;
3417 if (o.mCategories != null) {
3418 this.mCategories = new HashSet<String>(o.mCategories);
3419 }
3420 if (o.mExtras != null) {
3421 this.mExtras = new Bundle(o.mExtras);
3422 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003423 if (o.mSourceBounds != null) {
3424 this.mSourceBounds = new Rect(o.mSourceBounds);
3425 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003426 if (o.mSelector != null) {
3427 this.mSelector = new Intent(o.mSelector);
3428 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003429 if (o.mClipData != null) {
3430 this.mClipData = new ClipData(o.mClipData);
3431 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003432 }
3433
3434 @Override
3435 public Object clone() {
3436 return new Intent(this);
3437 }
3438
3439 private Intent(Intent o, boolean all) {
3440 this.mAction = o.mAction;
3441 this.mData = o.mData;
3442 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003443 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003444 this.mComponent = o.mComponent;
3445 if (o.mCategories != null) {
3446 this.mCategories = new HashSet<String>(o.mCategories);
3447 }
3448 }
3449
3450 /**
3451 * Make a clone of only the parts of the Intent that are relevant for
3452 * filter matching: the action, data, type, component, and categories.
3453 */
3454 public Intent cloneFilter() {
3455 return new Intent(this, false);
3456 }
3457
3458 /**
3459 * Create an intent with a given action. All other fields (data, type,
3460 * class) are null. Note that the action <em>must</em> be in a
3461 * namespace because Intents are used globally in the system -- for
3462 * example the system VIEW action is android.intent.action.VIEW; an
3463 * application's custom action would be something like
3464 * com.google.app.myapp.CUSTOM_ACTION.
3465 *
3466 * @param action The Intent action, such as ACTION_VIEW.
3467 */
3468 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003469 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003470 }
3471
3472 /**
3473 * Create an intent with a given action and for a given data url. Note
3474 * that the action <em>must</em> be in a namespace because Intents are
3475 * used globally in the system -- for example the system VIEW action is
3476 * android.intent.action.VIEW; an application's custom action would be
3477 * something like com.google.app.myapp.CUSTOM_ACTION.
3478 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003479 * <p><em>Note: scheme and host name matching in the Android framework is
3480 * case-sensitive, unlike the formal RFC. As a result,
3481 * you should always ensure that you write your Uri with these elements
3482 * using lower case letters, and normalize any Uris you receive from
3483 * outside of Android to ensure the scheme and host is lower case.</em></p>
3484 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003485 * @param action The Intent action, such as ACTION_VIEW.
3486 * @param uri The Intent data URI.
3487 */
3488 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003489 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003490 mData = uri;
3491 }
3492
3493 /**
3494 * Create an intent for a specific component. All other fields (action, data,
3495 * type, class) are null, though they can be modified later with explicit
3496 * calls. This provides a convenient way to create an intent that is
3497 * intended to execute a hard-coded class name, rather than relying on the
3498 * system to find an appropriate class for you; see {@link #setComponent}
3499 * for more information on the repercussions of this.
3500 *
3501 * @param packageContext A Context of the application package implementing
3502 * this class.
3503 * @param cls The component class that is to be used for the intent.
3504 *
3505 * @see #setClass
3506 * @see #setComponent
3507 * @see #Intent(String, android.net.Uri , Context, Class)
3508 */
3509 public Intent(Context packageContext, Class<?> cls) {
3510 mComponent = new ComponentName(packageContext, cls);
3511 }
3512
3513 /**
3514 * Create an intent for a specific component with a specified action and data.
3515 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3516 * construct the Intent and then calling {@link #setClass} to set its
3517 * class.
3518 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003519 * <p><em>Note: scheme and host name matching in the Android framework is
3520 * case-sensitive, unlike the formal RFC. As a result,
3521 * you should always ensure that you write your Uri with these elements
3522 * using lower case letters, and normalize any Uris you receive from
3523 * outside of Android to ensure the scheme and host is lower case.</em></p>
3524 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003525 * @param action The Intent action, such as ACTION_VIEW.
3526 * @param uri The Intent data URI.
3527 * @param packageContext A Context of the application package implementing
3528 * this class.
3529 * @param cls The component class that is to be used for the intent.
3530 *
3531 * @see #Intent(String, android.net.Uri)
3532 * @see #Intent(Context, Class)
3533 * @see #setClass
3534 * @see #setComponent
3535 */
3536 public Intent(String action, Uri uri,
3537 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003538 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003539 mData = uri;
3540 mComponent = new ComponentName(packageContext, cls);
3541 }
3542
3543 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003544 * Create an intent to launch the main (root) activity of a task. This
3545 * is the Intent that is started when the application's is launched from
3546 * Home. For anything else that wants to launch an application in the
3547 * same way, it is important that they use an Intent structured the same
3548 * way, and can use this function to ensure this is the case.
3549 *
3550 * <p>The returned Intent has the given Activity component as its explicit
3551 * component, {@link #ACTION_MAIN} as its action, and includes the
3552 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3553 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3554 * to do that through {@link #addFlags(int)} on the returned Intent.
3555 *
3556 * @param mainActivity The main activity component that this Intent will
3557 * launch.
3558 * @return Returns a newly created Intent that can be used to launch the
3559 * activity as a main application entry.
3560 *
3561 * @see #setClass
3562 * @see #setComponent
3563 */
3564 public static Intent makeMainActivity(ComponentName mainActivity) {
3565 Intent intent = new Intent(ACTION_MAIN);
3566 intent.setComponent(mainActivity);
3567 intent.addCategory(CATEGORY_LAUNCHER);
3568 return intent;
3569 }
3570
3571 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003572 * Make an Intent for the main activity of an application, without
3573 * specifying a specific activity to run but giving a selector to find
3574 * the activity. This results in a final Intent that is structured
3575 * the same as when the application is launched from
3576 * Home. For anything else that wants to launch an application in the
3577 * same way, it is important that they use an Intent structured the same
3578 * way, and can use this function to ensure this is the case.
3579 *
3580 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3581 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3582 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3583 * to do that through {@link #addFlags(int)} on the returned Intent.
3584 *
3585 * @param selectorAction The action name of the Intent's selector.
3586 * @param selectorCategory The name of a category to add to the Intent's
3587 * selector.
3588 * @return Returns a newly created Intent that can be used to launch the
3589 * activity as a main application entry.
3590 *
3591 * @see #setSelector(Intent)
3592 */
3593 public static Intent makeMainSelectorActivity(String selectorAction,
3594 String selectorCategory) {
3595 Intent intent = new Intent(ACTION_MAIN);
3596 intent.addCategory(CATEGORY_LAUNCHER);
3597 Intent selector = new Intent();
3598 selector.setAction(selectorAction);
3599 selector.addCategory(selectorCategory);
3600 intent.setSelector(selector);
3601 return intent;
3602 }
3603
3604 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003605 * Make an Intent that can be used to re-launch an application's task
3606 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3607 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3608 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3609 *
3610 * @param mainActivity The activity component that is the root of the
3611 * task; this is the activity that has been published in the application's
3612 * manifest as the main launcher icon.
3613 *
3614 * @return Returns a newly created Intent that can be used to relaunch the
3615 * activity's task in its root state.
3616 */
3617 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3618 Intent intent = makeMainActivity(mainActivity);
3619 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3620 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3621 return intent;
3622 }
3623
3624 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003625 * Call {@link #parseUri} with 0 flags.
3626 * @deprecated Use {@link #parseUri} instead.
3627 */
3628 @Deprecated
3629 public static Intent getIntent(String uri) throws URISyntaxException {
3630 return parseUri(uri, 0);
3631 }
Tom Taylord4a47292009-12-21 13:59:18 -08003632
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003633 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003635 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003636 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003637 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003638 *
3639 * <p>The URI given here must not be relative -- that is, it must include
3640 * the scheme and full path.
3641 *
3642 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003643 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003644 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003645 *
3646 * @return Intent The newly created Intent object.
3647 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003648 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3649 * it bad (as parsed by the Uri class) or the Intent data within the
3650 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003651 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003652 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003653 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003654 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003655 int i = 0;
3656 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003657 // Validate intent scheme for if requested.
3658 if ((flags&URI_INTENT_SCHEME) != 0) {
3659 if (!uri.startsWith("intent:")) {
3660 Intent intent = new Intent(ACTION_VIEW);
3661 try {
3662 intent.setData(Uri.parse(uri));
3663 } catch (IllegalArgumentException e) {
3664 throw new URISyntaxException(uri, e.getMessage());
3665 }
3666 return intent;
3667 }
3668 }
Tom Taylord4a47292009-12-21 13:59:18 -08003669
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003670 // simple case
3671 i = uri.lastIndexOf("#");
3672 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3673
3674 // old format Intent URI
3675 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003676
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677 // new format
3678 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003679 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003680
3681 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003682 String data = i >= 0 ? uri.substring(0, i) : null;
3683 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003684 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003685
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003686 // loop over contents of Intent, all name=value;
3687 while (!uri.startsWith("end", i)) {
3688 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003689 if (eq < 0) eq = i-1;
3690 int semi = uri.indexOf(';', i);
3691 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003692
3693 // action
3694 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003695 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003696 }
3697
3698 // categories
3699 else if (uri.startsWith("category=", i)) {
3700 intent.addCategory(value);
3701 }
3702
3703 // type
3704 else if (uri.startsWith("type=", i)) {
3705 intent.mType = value;
3706 }
3707
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003708 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003709 else if (uri.startsWith("launchFlags=", i)) {
3710 intent.mFlags = Integer.decode(value).intValue();
3711 }
3712
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003713 // package
3714 else if (uri.startsWith("package=", i)) {
3715 intent.mPackage = value;
3716 }
3717
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003718 // component
3719 else if (uri.startsWith("component=", i)) {
3720 intent.mComponent = ComponentName.unflattenFromString(value);
3721 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003722
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003723 // scheme
3724 else if (uri.startsWith("scheme=", i)) {
3725 scheme = value;
3726 }
3727
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003728 // source bounds
3729 else if (uri.startsWith("sourceBounds=", i)) {
3730 intent.mSourceBounds = Rect.unflattenFromString(value);
3731 }
3732
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003733 // selector
3734 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3735 intent = new Intent();
3736 }
3737
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003738 // extra
3739 else {
3740 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003741 // create Bundle if it doesn't already exist
3742 if (intent.mExtras == null) intent.mExtras = new Bundle();
3743 Bundle b = intent.mExtras;
3744 // add EXTRA
3745 if (uri.startsWith("S.", i)) b.putString(key, value);
3746 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3747 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3748 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3749 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3750 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3751 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3752 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3753 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3754 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3755 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003756
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003757 // move to the next item
3758 i = semi + 1;
3759 }
3760
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003761 if (intent != baseIntent) {
3762 // The Intent had a selector; fix it up.
3763 baseIntent.setSelector(intent);
3764 intent = baseIntent;
3765 }
3766
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003767 if (data != null) {
3768 if (data.startsWith("intent:")) {
3769 data = data.substring(7);
3770 if (scheme != null) {
3771 data = scheme + ':' + data;
3772 }
3773 }
Tom Taylord4a47292009-12-21 13:59:18 -08003774
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003775 if (data.length() > 0) {
3776 try {
3777 intent.mData = Uri.parse(data);
3778 } catch (IllegalArgumentException e) {
3779 throw new URISyntaxException(uri, e.getMessage());
3780 }
3781 }
3782 }
Tom Taylord4a47292009-12-21 13:59:18 -08003783
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003784 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003785
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003786 } catch (IndexOutOfBoundsException e) {
3787 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3788 }
3789 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003790
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003791 public static Intent getIntentOld(String uri) throws URISyntaxException {
3792 Intent intent;
3793
3794 int i = uri.lastIndexOf('#');
3795 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003796 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003797 final int intentFragmentStart = i;
3798 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003799
3800 i++;
3801
3802 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003803 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003804 i += 7;
3805 int j = uri.indexOf(')', i);
3806 action = uri.substring(i, j);
3807 i = j + 1;
3808 }
3809
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003810 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003811
3812 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003813 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003814 i += 11;
3815 int j = uri.indexOf(')', i);
3816 while (i < j) {
3817 int sep = uri.indexOf('!', i);
3818 if (sep < 0) sep = j;
3819 if (i < sep) {
3820 intent.addCategory(uri.substring(i, sep));
3821 }
3822 i = sep + 1;
3823 }
3824 i = j + 1;
3825 }
3826
3827 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003828 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003829 i += 5;
3830 int j = uri.indexOf(')', i);
3831 intent.mType = uri.substring(i, j);
3832 i = j + 1;
3833 }
3834
3835 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003836 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003837 i += 12;
3838 int j = uri.indexOf(')', i);
3839 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3840 i = j + 1;
3841 }
3842
3843 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003844 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003845 i += 10;
3846 int j = uri.indexOf(')', i);
3847 int sep = uri.indexOf('!', i);
3848 if (sep >= 0 && sep < j) {
3849 String pkg = uri.substring(i, sep);
3850 String cls = uri.substring(sep + 1, j);
3851 intent.mComponent = new ComponentName(pkg, cls);
3852 }
3853 i = j + 1;
3854 }
3855
3856 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003857 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003858 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003859
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003860 final int closeParen = uri.indexOf(')', i);
3861 if (closeParen == -1) throw new URISyntaxException(uri,
3862 "EXTRA missing trailing ')'", i);
3863
3864 while (i < closeParen) {
3865 // fetch the key value
3866 int j = uri.indexOf('=', i);
3867 if (j <= i + 1 || i >= closeParen) {
3868 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3869 }
3870 char type = uri.charAt(i);
3871 i++;
3872 String key = uri.substring(i, j);
3873 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003874
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003875 // get type-value
3876 j = uri.indexOf('!', i);
3877 if (j == -1 || j >= closeParen) j = closeParen;
3878 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3879 String value = uri.substring(i, j);
3880 i = j;
3881
3882 // create Bundle if it doesn't already exist
3883 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003885 // add item to bundle
3886 try {
3887 switch (type) {
3888 case 'S':
3889 intent.mExtras.putString(key, Uri.decode(value));
3890 break;
3891 case 'B':
3892 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3893 break;
3894 case 'b':
3895 intent.mExtras.putByte(key, Byte.parseByte(value));
3896 break;
3897 case 'c':
3898 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3899 break;
3900 case 'd':
3901 intent.mExtras.putDouble(key, Double.parseDouble(value));
3902 break;
3903 case 'f':
3904 intent.mExtras.putFloat(key, Float.parseFloat(value));
3905 break;
3906 case 'i':
3907 intent.mExtras.putInt(key, Integer.parseInt(value));
3908 break;
3909 case 'l':
3910 intent.mExtras.putLong(key, Long.parseLong(value));
3911 break;
3912 case 's':
3913 intent.mExtras.putShort(key, Short.parseShort(value));
3914 break;
3915 default:
3916 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3917 }
3918 } catch (NumberFormatException e) {
3919 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3920 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003921
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003922 char ch = uri.charAt(i);
3923 if (ch == ')') break;
3924 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3925 i++;
3926 }
3927 }
3928
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003929 if (isIntentFragment) {
3930 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3931 } else {
3932 intent.mData = Uri.parse(uri);
3933 }
Tom Taylord4a47292009-12-21 13:59:18 -08003934
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003935 if (intent.mAction == null) {
3936 // By default, if no action is specified, then use VIEW.
3937 intent.mAction = ACTION_VIEW;
3938 }
3939
3940 } else {
3941 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3942 }
3943
3944 return intent;
3945 }
3946
3947 /**
3948 * Retrieve the general action to be performed, such as
3949 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3950 * the information in the intent should be interpreted -- most importantly,
3951 * what to do with the data returned by {@link #getData}.
3952 *
3953 * @return The action of this intent or null if none is specified.
3954 *
3955 * @see #setAction
3956 */
3957 public String getAction() {
3958 return mAction;
3959 }
3960
3961 /**
3962 * Retrieve data this intent is operating on. This URI specifies the name
3963 * of the data; often it uses the content: scheme, specifying data in a
3964 * content provider. Other schemes may be handled by specific activities,
3965 * such as http: by the web browser.
3966 *
3967 * @return The URI of the data this intent is targeting or null.
3968 *
3969 * @see #getScheme
3970 * @see #setData
3971 */
3972 public Uri getData() {
3973 return mData;
3974 }
3975
3976 /**
3977 * The same as {@link #getData()}, but returns the URI as an encoded
3978 * String.
3979 */
3980 public String getDataString() {
3981 return mData != null ? mData.toString() : null;
3982 }
3983
3984 /**
3985 * Return the scheme portion of the intent's data. If the data is null or
3986 * does not include a scheme, null is returned. Otherwise, the scheme
3987 * prefix without the final ':' is returned, i.e. "http".
3988 *
3989 * <p>This is the same as calling getData().getScheme() (and checking for
3990 * null data).
3991 *
3992 * @return The scheme of this intent.
3993 *
3994 * @see #getData
3995 */
3996 public String getScheme() {
3997 return mData != null ? mData.getScheme() : null;
3998 }
3999
4000 /**
4001 * Retrieve any explicit MIME type included in the intent. This is usually
4002 * null, as the type is determined by the intent data.
4003 *
4004 * @return If a type was manually set, it is returned; else null is
4005 * returned.
4006 *
4007 * @see #resolveType(ContentResolver)
4008 * @see #setType
4009 */
4010 public String getType() {
4011 return mType;
4012 }
4013
4014 /**
4015 * Return the MIME data type of this intent. If the type field is
4016 * explicitly set, that is simply returned. Otherwise, if the data is set,
4017 * the type of that data is returned. If neither fields are set, a null is
4018 * returned.
4019 *
4020 * @return The MIME type of this intent.
4021 *
4022 * @see #getType
4023 * @see #resolveType(ContentResolver)
4024 */
4025 public String resolveType(Context context) {
4026 return resolveType(context.getContentResolver());
4027 }
4028
4029 /**
4030 * Return the MIME data type of this intent. If the type field is
4031 * explicitly set, that is simply returned. Otherwise, if the data is set,
4032 * the type of that data is returned. If neither fields are set, a null is
4033 * returned.
4034 *
4035 * @param resolver A ContentResolver that can be used to determine the MIME
4036 * type of the intent's data.
4037 *
4038 * @return The MIME type of this intent.
4039 *
4040 * @see #getType
4041 * @see #resolveType(Context)
4042 */
4043 public String resolveType(ContentResolver resolver) {
4044 if (mType != null) {
4045 return mType;
4046 }
4047 if (mData != null) {
4048 if ("content".equals(mData.getScheme())) {
4049 return resolver.getType(mData);
4050 }
4051 }
4052 return null;
4053 }
4054
4055 /**
4056 * Return the MIME data type of this intent, only if it will be needed for
4057 * intent resolution. This is not generally useful for application code;
4058 * it is used by the frameworks for communicating with back-end system
4059 * services.
4060 *
4061 * @param resolver A ContentResolver that can be used to determine the MIME
4062 * type of the intent's data.
4063 *
4064 * @return The MIME type of this intent, or null if it is unknown or not
4065 * needed.
4066 */
4067 public String resolveTypeIfNeeded(ContentResolver resolver) {
4068 if (mComponent != null) {
4069 return mType;
4070 }
4071 return resolveType(resolver);
4072 }
4073
4074 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004075 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004076 *
4077 * @param category The category to check.
4078 *
4079 * @return boolean True if the intent contains the category, else false.
4080 *
4081 * @see #getCategories
4082 * @see #addCategory
4083 */
4084 public boolean hasCategory(String category) {
4085 return mCategories != null && mCategories.contains(category);
4086 }
4087
4088 /**
4089 * Return the set of all categories in the intent. If there are no categories,
4090 * returns NULL.
4091 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004092 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004093 *
4094 * @see #hasCategory
4095 * @see #addCategory
4096 */
4097 public Set<String> getCategories() {
4098 return mCategories;
4099 }
4100
4101 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004102 * Return the specific selector associated with this Intent. If there is
4103 * none, returns null. See {@link #setSelector} for more information.
4104 *
4105 * @see #setSelector
4106 */
4107 public Intent getSelector() {
4108 return mSelector;
4109 }
4110
4111 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004112 * Return the {@link ClipData} associated with this Intent. If there is
4113 * none, returns null. See {@link #setClipData} for more information.
4114 *
4115 * @see #setClipData;
4116 */
4117 public ClipData getClipData() {
4118 return mClipData;
4119 }
4120
4121 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004122 * Sets the ClassLoader that will be used when unmarshalling
4123 * any Parcelable values from the extras of this Intent.
4124 *
4125 * @param loader a ClassLoader, or null to use the default loader
4126 * at the time of unmarshalling.
4127 */
4128 public void setExtrasClassLoader(ClassLoader loader) {
4129 if (mExtras != null) {
4130 mExtras.setClassLoader(loader);
4131 }
4132 }
4133
4134 /**
4135 * Returns true if an extra value is associated with the given name.
4136 * @param name the extra's name
4137 * @return true if the given extra is present.
4138 */
4139 public boolean hasExtra(String name) {
4140 return mExtras != null && mExtras.containsKey(name);
4141 }
4142
4143 /**
4144 * Returns true if the Intent's extras contain a parcelled file descriptor.
4145 * @return true if the Intent contains a parcelled file descriptor.
4146 */
4147 public boolean hasFileDescriptors() {
4148 return mExtras != null && mExtras.hasFileDescriptors();
4149 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004150
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004151 /** @hide */
4152 public void setAllowFds(boolean allowFds) {
4153 if (mExtras != null) {
4154 mExtras.setAllowFds(allowFds);
4155 }
4156 }
4157
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004158 /**
4159 * Retrieve extended data from the intent.
4160 *
4161 * @param name The name of the desired item.
4162 *
4163 * @return the value of an item that previously added with putExtra()
4164 * or null if none was found.
4165 *
4166 * @deprecated
4167 * @hide
4168 */
4169 @Deprecated
4170 public Object getExtra(String name) {
4171 return getExtra(name, null);
4172 }
4173
4174 /**
4175 * Retrieve extended data from the intent.
4176 *
4177 * @param name The name of the desired item.
4178 * @param defaultValue the value to be returned if no value of the desired
4179 * type is stored with the given name.
4180 *
4181 * @return the value of an item that previously added with putExtra()
4182 * or the default value if none was found.
4183 *
4184 * @see #putExtra(String, boolean)
4185 */
4186 public boolean getBooleanExtra(String name, boolean defaultValue) {
4187 return mExtras == null ? defaultValue :
4188 mExtras.getBoolean(name, defaultValue);
4189 }
4190
4191 /**
4192 * Retrieve extended data from the intent.
4193 *
4194 * @param name The name of the desired item.
4195 * @param defaultValue the value to be returned if no value of the desired
4196 * type is stored with the given name.
4197 *
4198 * @return the value of an item that previously added with putExtra()
4199 * or the default value if none was found.
4200 *
4201 * @see #putExtra(String, byte)
4202 */
4203 public byte getByteExtra(String name, byte defaultValue) {
4204 return mExtras == null ? defaultValue :
4205 mExtras.getByte(name, defaultValue);
4206 }
4207
4208 /**
4209 * Retrieve extended data from the intent.
4210 *
4211 * @param name The name of the desired item.
4212 * @param defaultValue the value to be returned if no value of the desired
4213 * type is stored with the given name.
4214 *
4215 * @return the value of an item that previously added with putExtra()
4216 * or the default value if none was found.
4217 *
4218 * @see #putExtra(String, short)
4219 */
4220 public short getShortExtra(String name, short defaultValue) {
4221 return mExtras == null ? defaultValue :
4222 mExtras.getShort(name, defaultValue);
4223 }
4224
4225 /**
4226 * Retrieve extended data from the intent.
4227 *
4228 * @param name The name of the desired item.
4229 * @param defaultValue the value to be returned if no value of the desired
4230 * type is stored with the given name.
4231 *
4232 * @return the value of an item that previously added with putExtra()
4233 * or the default value if none was found.
4234 *
4235 * @see #putExtra(String, char)
4236 */
4237 public char getCharExtra(String name, char defaultValue) {
4238 return mExtras == null ? defaultValue :
4239 mExtras.getChar(name, defaultValue);
4240 }
4241
4242 /**
4243 * Retrieve extended data from the intent.
4244 *
4245 * @param name The name of the desired item.
4246 * @param defaultValue the value to be returned if no value of the desired
4247 * type is stored with the given name.
4248 *
4249 * @return the value of an item that previously added with putExtra()
4250 * or the default value if none was found.
4251 *
4252 * @see #putExtra(String, int)
4253 */
4254 public int getIntExtra(String name, int defaultValue) {
4255 return mExtras == null ? defaultValue :
4256 mExtras.getInt(name, defaultValue);
4257 }
4258
4259 /**
4260 * Retrieve extended data from the intent.
4261 *
4262 * @param name The name of the desired item.
4263 * @param defaultValue the value to be returned if no value of the desired
4264 * type is stored with the given name.
4265 *
4266 * @return the value of an item that previously added with putExtra()
4267 * or the default value if none was found.
4268 *
4269 * @see #putExtra(String, long)
4270 */
4271 public long getLongExtra(String name, long defaultValue) {
4272 return mExtras == null ? defaultValue :
4273 mExtras.getLong(name, defaultValue);
4274 }
4275
4276 /**
4277 * Retrieve extended data from the intent.
4278 *
4279 * @param name The name of the desired item.
4280 * @param defaultValue the value to be returned if no value of the desired
4281 * type is stored with the given name.
4282 *
4283 * @return the value of an item that previously added with putExtra(),
4284 * or the default value if no such item is present
4285 *
4286 * @see #putExtra(String, float)
4287 */
4288 public float getFloatExtra(String name, float defaultValue) {
4289 return mExtras == null ? defaultValue :
4290 mExtras.getFloat(name, defaultValue);
4291 }
4292
4293 /**
4294 * Retrieve extended data from the intent.
4295 *
4296 * @param name The name of the desired item.
4297 * @param defaultValue the value to be returned if no value of the desired
4298 * type is stored with the given name.
4299 *
4300 * @return the value of an item that previously added with putExtra()
4301 * or the default value if none was found.
4302 *
4303 * @see #putExtra(String, double)
4304 */
4305 public double getDoubleExtra(String name, double defaultValue) {
4306 return mExtras == null ? defaultValue :
4307 mExtras.getDouble(name, defaultValue);
4308 }
4309
4310 /**
4311 * Retrieve extended data from the intent.
4312 *
4313 * @param name The name of the desired item.
4314 *
4315 * @return the value of an item that previously added with putExtra()
4316 * or null if no String value was found.
4317 *
4318 * @see #putExtra(String, String)
4319 */
4320 public String getStringExtra(String name) {
4321 return mExtras == null ? null : mExtras.getString(name);
4322 }
4323
4324 /**
4325 * Retrieve extended data from the intent.
4326 *
4327 * @param name The name of the desired item.
4328 *
4329 * @return the value of an item that previously added with putExtra()
4330 * or null if no CharSequence value was found.
4331 *
4332 * @see #putExtra(String, CharSequence)
4333 */
4334 public CharSequence getCharSequenceExtra(String name) {
4335 return mExtras == null ? null : mExtras.getCharSequence(name);
4336 }
4337
4338 /**
4339 * Retrieve extended data from the intent.
4340 *
4341 * @param name The name of the desired item.
4342 *
4343 * @return the value of an item that previously added with putExtra()
4344 * or null if no Parcelable value was found.
4345 *
4346 * @see #putExtra(String, Parcelable)
4347 */
4348 public <T extends Parcelable> T getParcelableExtra(String name) {
4349 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4350 }
4351
4352 /**
4353 * Retrieve extended data from the intent.
4354 *
4355 * @param name The name of the desired item.
4356 *
4357 * @return the value of an item that previously added with putExtra()
4358 * or null if no Parcelable[] value was found.
4359 *
4360 * @see #putExtra(String, Parcelable[])
4361 */
4362 public Parcelable[] getParcelableArrayExtra(String name) {
4363 return mExtras == null ? null : mExtras.getParcelableArray(name);
4364 }
4365
4366 /**
4367 * Retrieve extended data from the intent.
4368 *
4369 * @param name The name of the desired item.
4370 *
4371 * @return the value of an item that previously added with putExtra()
4372 * or null if no ArrayList<Parcelable> value was found.
4373 *
4374 * @see #putParcelableArrayListExtra(String, ArrayList)
4375 */
4376 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4377 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4378 }
4379
4380 /**
4381 * Retrieve extended data from the intent.
4382 *
4383 * @param name The name of the desired item.
4384 *
4385 * @return the value of an item that previously added with putExtra()
4386 * or null if no Serializable value was found.
4387 *
4388 * @see #putExtra(String, Serializable)
4389 */
4390 public Serializable getSerializableExtra(String name) {
4391 return mExtras == null ? null : mExtras.getSerializable(name);
4392 }
4393
4394 /**
4395 * Retrieve extended data from the intent.
4396 *
4397 * @param name The name of the desired item.
4398 *
4399 * @return the value of an item that previously added with putExtra()
4400 * or null if no ArrayList<Integer> value was found.
4401 *
4402 * @see #putIntegerArrayListExtra(String, ArrayList)
4403 */
4404 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4405 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4406 }
4407
4408 /**
4409 * Retrieve extended data from the intent.
4410 *
4411 * @param name The name of the desired item.
4412 *
4413 * @return the value of an item that previously added with putExtra()
4414 * or null if no ArrayList<String> value was found.
4415 *
4416 * @see #putStringArrayListExtra(String, ArrayList)
4417 */
4418 public ArrayList<String> getStringArrayListExtra(String name) {
4419 return mExtras == null ? null : mExtras.getStringArrayList(name);
4420 }
4421
4422 /**
4423 * Retrieve extended data from the intent.
4424 *
4425 * @param name The name of the desired item.
4426 *
4427 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004428 * or null if no ArrayList<CharSequence> value was found.
4429 *
4430 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4431 */
4432 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4433 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4434 }
4435
4436 /**
4437 * Retrieve extended data from the intent.
4438 *
4439 * @param name The name of the desired item.
4440 *
4441 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004442 * or null if no boolean array value was found.
4443 *
4444 * @see #putExtra(String, boolean[])
4445 */
4446 public boolean[] getBooleanArrayExtra(String name) {
4447 return mExtras == null ? null : mExtras.getBooleanArray(name);
4448 }
4449
4450 /**
4451 * Retrieve extended data from the intent.
4452 *
4453 * @param name The name of the desired item.
4454 *
4455 * @return the value of an item that previously added with putExtra()
4456 * or null if no byte array value was found.
4457 *
4458 * @see #putExtra(String, byte[])
4459 */
4460 public byte[] getByteArrayExtra(String name) {
4461 return mExtras == null ? null : mExtras.getByteArray(name);
4462 }
4463
4464 /**
4465 * Retrieve extended data from the intent.
4466 *
4467 * @param name The name of the desired item.
4468 *
4469 * @return the value of an item that previously added with putExtra()
4470 * or null if no short array value was found.
4471 *
4472 * @see #putExtra(String, short[])
4473 */
4474 public short[] getShortArrayExtra(String name) {
4475 return mExtras == null ? null : mExtras.getShortArray(name);
4476 }
4477
4478 /**
4479 * Retrieve extended data from the intent.
4480 *
4481 * @param name The name of the desired item.
4482 *
4483 * @return the value of an item that previously added with putExtra()
4484 * or null if no char array value was found.
4485 *
4486 * @see #putExtra(String, char[])
4487 */
4488 public char[] getCharArrayExtra(String name) {
4489 return mExtras == null ? null : mExtras.getCharArray(name);
4490 }
4491
4492 /**
4493 * Retrieve extended data from the intent.
4494 *
4495 * @param name The name of the desired item.
4496 *
4497 * @return the value of an item that previously added with putExtra()
4498 * or null if no int array value was found.
4499 *
4500 * @see #putExtra(String, int[])
4501 */
4502 public int[] getIntArrayExtra(String name) {
4503 return mExtras == null ? null : mExtras.getIntArray(name);
4504 }
4505
4506 /**
4507 * Retrieve extended data from the intent.
4508 *
4509 * @param name The name of the desired item.
4510 *
4511 * @return the value of an item that previously added with putExtra()
4512 * or null if no long array value was found.
4513 *
4514 * @see #putExtra(String, long[])
4515 */
4516 public long[] getLongArrayExtra(String name) {
4517 return mExtras == null ? null : mExtras.getLongArray(name);
4518 }
4519
4520 /**
4521 * Retrieve extended data from the intent.
4522 *
4523 * @param name The name of the desired item.
4524 *
4525 * @return the value of an item that previously added with putExtra()
4526 * or null if no float array value was found.
4527 *
4528 * @see #putExtra(String, float[])
4529 */
4530 public float[] getFloatArrayExtra(String name) {
4531 return mExtras == null ? null : mExtras.getFloatArray(name);
4532 }
4533
4534 /**
4535 * Retrieve extended data from the intent.
4536 *
4537 * @param name The name of the desired item.
4538 *
4539 * @return the value of an item that previously added with putExtra()
4540 * or null if no double array value was found.
4541 *
4542 * @see #putExtra(String, double[])
4543 */
4544 public double[] getDoubleArrayExtra(String name) {
4545 return mExtras == null ? null : mExtras.getDoubleArray(name);
4546 }
4547
4548 /**
4549 * Retrieve extended data from the intent.
4550 *
4551 * @param name The name of the desired item.
4552 *
4553 * @return the value of an item that previously added with putExtra()
4554 * or null if no String array value was found.
4555 *
4556 * @see #putExtra(String, String[])
4557 */
4558 public String[] getStringArrayExtra(String name) {
4559 return mExtras == null ? null : mExtras.getStringArray(name);
4560 }
4561
4562 /**
4563 * Retrieve extended data from the intent.
4564 *
4565 * @param name The name of the desired item.
4566 *
4567 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004568 * or null if no CharSequence array value was found.
4569 *
4570 * @see #putExtra(String, CharSequence[])
4571 */
4572 public CharSequence[] getCharSequenceArrayExtra(String name) {
4573 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4574 }
4575
4576 /**
4577 * Retrieve extended data from the intent.
4578 *
4579 * @param name The name of the desired item.
4580 *
4581 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004582 * or null if no Bundle value was found.
4583 *
4584 * @see #putExtra(String, Bundle)
4585 */
4586 public Bundle getBundleExtra(String name) {
4587 return mExtras == null ? null : mExtras.getBundle(name);
4588 }
4589
4590 /**
4591 * Retrieve extended data from the intent.
4592 *
4593 * @param name The name of the desired item.
4594 *
4595 * @return the value of an item that previously added with putExtra()
4596 * or null if no IBinder value was found.
4597 *
4598 * @see #putExtra(String, IBinder)
4599 *
4600 * @deprecated
4601 * @hide
4602 */
4603 @Deprecated
4604 public IBinder getIBinderExtra(String name) {
4605 return mExtras == null ? null : mExtras.getIBinder(name);
4606 }
4607
4608 /**
4609 * Retrieve extended data from the intent.
4610 *
4611 * @param name The name of the desired item.
4612 * @param defaultValue The default value to return in case no item is
4613 * associated with the key 'name'
4614 *
4615 * @return the value of an item that previously added with putExtra()
4616 * or defaultValue if none was found.
4617 *
4618 * @see #putExtra
4619 *
4620 * @deprecated
4621 * @hide
4622 */
4623 @Deprecated
4624 public Object getExtra(String name, Object defaultValue) {
4625 Object result = defaultValue;
4626 if (mExtras != null) {
4627 Object result2 = mExtras.get(name);
4628 if (result2 != null) {
4629 result = result2;
4630 }
4631 }
4632
4633 return result;
4634 }
4635
4636 /**
4637 * Retrieves a map of extended data from the intent.
4638 *
4639 * @return the map of all extras previously added with putExtra(),
4640 * or null if none have been added.
4641 */
4642 public Bundle getExtras() {
4643 return (mExtras != null)
4644 ? new Bundle(mExtras)
4645 : null;
4646 }
4647
4648 /**
4649 * Retrieve any special flags associated with this intent. You will
4650 * normally just set them with {@link #setFlags} and let the system
4651 * take the appropriate action with them.
4652 *
4653 * @return int The currently set flags.
4654 *
4655 * @see #setFlags
4656 */
4657 public int getFlags() {
4658 return mFlags;
4659 }
4660
Dianne Hackborne7f97212011-02-24 14:40:20 -08004661 /** @hide */
4662 public boolean isExcludingStopped() {
4663 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4664 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4665 }
4666
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004667 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004668 * Retrieve the application package name this Intent is limited to. When
4669 * resolving an Intent, if non-null this limits the resolution to only
4670 * components in the given application package.
4671 *
4672 * @return The name of the application package for the Intent.
4673 *
4674 * @see #resolveActivity
4675 * @see #setPackage
4676 */
4677 public String getPackage() {
4678 return mPackage;
4679 }
4680
4681 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004682 * Retrieve the concrete component associated with the intent. When receiving
4683 * an intent, this is the component that was found to best handle it (that is,
4684 * yourself) and will always be non-null; in all other cases it will be
4685 * null unless explicitly set.
4686 *
4687 * @return The name of the application component to handle the intent.
4688 *
4689 * @see #resolveActivity
4690 * @see #setComponent
4691 */
4692 public ComponentName getComponent() {
4693 return mComponent;
4694 }
4695
4696 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004697 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4698 * used as a hint to the receiver for animations and the like. Null means that there
4699 * is no source bounds.
4700 */
4701 public Rect getSourceBounds() {
4702 return mSourceBounds;
4703 }
4704
4705 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004706 * Return the Activity component that should be used to handle this intent.
4707 * The appropriate component is determined based on the information in the
4708 * intent, evaluated as follows:
4709 *
4710 * <p>If {@link #getComponent} returns an explicit class, that is returned
4711 * without any further consideration.
4712 *
4713 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4714 * category to be considered.
4715 *
4716 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4717 * action.
4718 *
4719 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4720 * this type.
4721 *
4722 * <p>If {@link #addCategory} has added any categories, the activity must
4723 * handle ALL of the categories specified.
4724 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004725 * <p>If {@link #getPackage} is non-NULL, only activity components in
4726 * that application package will be considered.
4727 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004728 * <p>If there are no activities that satisfy all of these conditions, a
4729 * null string is returned.
4730 *
4731 * <p>If multiple activities are found to satisfy the intent, the one with
4732 * the highest priority will be used. If there are multiple activities
4733 * with the same priority, the system will either pick the best activity
4734 * based on user preference, or resolve to a system class that will allow
4735 * the user to pick an activity and forward from there.
4736 *
4737 * <p>This method is implemented simply by calling
4738 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4739 * true.</p>
4740 * <p> This API is called for you as part of starting an activity from an
4741 * intent. You do not normally need to call it yourself.</p>
4742 *
4743 * @param pm The package manager with which to resolve the Intent.
4744 *
4745 * @return Name of the component implementing an activity that can
4746 * display the intent.
4747 *
4748 * @see #setComponent
4749 * @see #getComponent
4750 * @see #resolveActivityInfo
4751 */
4752 public ComponentName resolveActivity(PackageManager pm) {
4753 if (mComponent != null) {
4754 return mComponent;
4755 }
4756
4757 ResolveInfo info = pm.resolveActivity(
4758 this, PackageManager.MATCH_DEFAULT_ONLY);
4759 if (info != null) {
4760 return new ComponentName(
4761 info.activityInfo.applicationInfo.packageName,
4762 info.activityInfo.name);
4763 }
4764
4765 return null;
4766 }
4767
4768 /**
4769 * Resolve the Intent into an {@link ActivityInfo}
4770 * describing the activity that should execute the intent. Resolution
4771 * follows the same rules as described for {@link #resolveActivity}, but
4772 * you get back the completely information about the resolved activity
4773 * instead of just its class name.
4774 *
4775 * @param pm The package manager with which to resolve the Intent.
4776 * @param flags Addition information to retrieve as per
4777 * {@link PackageManager#getActivityInfo(ComponentName, int)
4778 * PackageManager.getActivityInfo()}.
4779 *
4780 * @return PackageManager.ActivityInfo
4781 *
4782 * @see #resolveActivity
4783 */
4784 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4785 ActivityInfo ai = null;
4786 if (mComponent != null) {
4787 try {
4788 ai = pm.getActivityInfo(mComponent, flags);
4789 } catch (PackageManager.NameNotFoundException e) {
4790 // ignore
4791 }
4792 } else {
4793 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004794 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004795 if (info != null) {
4796 ai = info.activityInfo;
4797 }
4798 }
4799
4800 return ai;
4801 }
4802
4803 /**
4804 * Set the general action to be performed.
4805 *
4806 * @param action An action name, such as ACTION_VIEW. Application-specific
4807 * actions should be prefixed with the vendor's package name.
4808 *
4809 * @return Returns the same Intent object, for chaining multiple calls
4810 * into a single statement.
4811 *
4812 * @see #getAction
4813 */
4814 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004815 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004816 return this;
4817 }
4818
4819 /**
4820 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004821 * clears any type that was previously set by {@link #setType} or
4822 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004823 *
Nick Pellyccae4122012-01-09 14:12:58 -08004824 * <p><em>Note: scheme matching in the Android framework is
4825 * case-sensitive, unlike the formal RFC. As a result,
4826 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004827 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004828 * {@link #setDataAndNormalize}
4829 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004830 *
Nick Pellyccae4122012-01-09 14:12:58 -08004831 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004832 *
4833 * @return Returns the same Intent object, for chaining multiple calls
4834 * into a single statement.
4835 *
4836 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004837 * @see #setDataAndNormalize
4838 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004839 */
4840 public Intent setData(Uri data) {
4841 mData = data;
4842 mType = null;
4843 return this;
4844 }
4845
4846 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004847 * Normalize and set the data this intent is operating on.
4848 *
4849 * <p>This method automatically clears any type that was
4850 * previously set (for example, by {@link #setType}).
4851 *
4852 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004853 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004854 * so really this is just a convenience method for
4855 * <pre>
4856 * setData(data.normalize())
4857 * </pre>
4858 *
4859 * @param data The Uri of the data this intent is now targeting.
4860 *
4861 * @return Returns the same Intent object, for chaining multiple calls
4862 * into a single statement.
4863 *
4864 * @see #getData
4865 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004866 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004867 */
4868 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004869 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004870 }
4871
4872 /**
4873 * Set an explicit MIME data type.
4874 *
4875 * <p>This is used to create intents that only specify a type and not data,
4876 * for example to indicate the type of data to return.
4877 *
4878 * <p>This method automatically clears any data that was
4879 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004880 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004881 * <p><em>Note: MIME type matching in the Android framework is
4882 * case-sensitive, unlike formal RFC MIME types. As a result,
4883 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004884 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4885 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004886 *
4887 * @param type The MIME type of the data being handled by this intent.
4888 *
4889 * @return Returns the same Intent object, for chaining multiple calls
4890 * into a single statement.
4891 *
4892 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004893 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004894 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004895 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004896 */
4897 public Intent setType(String type) {
4898 mData = null;
4899 mType = type;
4900 return this;
4901 }
4902
4903 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004904 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004905 *
Nick Pellyccae4122012-01-09 14:12:58 -08004906 * <p>This is used to create intents that only specify a type and not data,
4907 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004908 *
Nick Pellyccae4122012-01-09 14:12:58 -08004909 * <p>This method automatically clears any data that was
4910 * previously set (for example by {@link #setData}).
4911 *
4912 * <p>The MIME type is normalized using
4913 * {@link #normalizeMimeType} before it is set,
4914 * so really this is just a convenience method for
4915 * <pre>
4916 * setType(Intent.normalizeMimeType(type))
4917 * </pre>
4918 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004919 * @param type The MIME type of the data being handled by this intent.
4920 *
4921 * @return Returns the same Intent object, for chaining multiple calls
4922 * into a single statement.
4923 *
Nick Pellyccae4122012-01-09 14:12:58 -08004924 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004925 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004926 * @see #normalizeMimeType
4927 */
4928 public Intent setTypeAndNormalize(String type) {
4929 return setType(normalizeMimeType(type));
4930 }
4931
4932 /**
4933 * (Usually optional) Set the data for the intent along with an explicit
4934 * MIME data type. This method should very rarely be used -- it allows you
4935 * to override the MIME type that would ordinarily be inferred from the
4936 * data with your own type given here.
4937 *
4938 * <p><em>Note: MIME type and Uri scheme matching in the
4939 * Android framework is case-sensitive, unlike the formal RFC definitions.
4940 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004941 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004942 * {@link #setDataAndTypeAndNormalize}
4943 * to ensure that they are converted to lower case.</em>
4944 *
4945 * @param data The Uri of the data this intent is now targeting.
4946 * @param type The MIME type of the data being handled by this intent.
4947 *
4948 * @return Returns the same Intent object, for chaining multiple calls
4949 * into a single statement.
4950 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004951 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004952 * @see #setData
4953 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004954 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004955 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004956 */
4957 public Intent setDataAndType(Uri data, String type) {
4958 mData = data;
4959 mType = type;
4960 return this;
4961 }
4962
4963 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004964 * (Usually optional) Normalize and set both the data Uri and an explicit
4965 * MIME data type. This method should very rarely be used -- it allows you
4966 * to override the MIME type that would ordinarily be inferred from the
4967 * data with your own type given here.
4968 *
4969 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004970 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004971 * before they are set, so really this is just a convenience method for
4972 * <pre>
4973 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4974 * </pre>
4975 *
4976 * @param data The Uri of the data this intent is now targeting.
4977 * @param type The MIME type of the data being handled by this intent.
4978 *
4979 * @return Returns the same Intent object, for chaining multiple calls
4980 * into a single statement.
4981 *
4982 * @see #setType
4983 * @see #setData
4984 * @see #setDataAndType
4985 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004986 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004987 */
4988 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004989 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004990 }
4991
4992 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004993 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004994 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004995 * activities that provide <em>all</em> of the requested categories will be
4996 * used.
4997 *
4998 * @param category The desired category. This can be either one of the
4999 * predefined Intent categories, or a custom category in your own
5000 * namespace.
5001 *
5002 * @return Returns the same Intent object, for chaining multiple calls
5003 * into a single statement.
5004 *
5005 * @see #hasCategory
5006 * @see #removeCategory
5007 */
5008 public Intent addCategory(String category) {
5009 if (mCategories == null) {
5010 mCategories = new HashSet<String>();
5011 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005012 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005013 return this;
5014 }
5015
5016 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005017 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005018 *
5019 * @param category The category to remove.
5020 *
5021 * @see #addCategory
5022 */
5023 public void removeCategory(String category) {
5024 if (mCategories != null) {
5025 mCategories.remove(category);
5026 if (mCategories.size() == 0) {
5027 mCategories = null;
5028 }
5029 }
5030 }
5031
5032 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005033 * Set a selector for this Intent. This is a modification to the kinds of
5034 * things the Intent will match. If the selector is set, it will be used
5035 * when trying to find entities that can handle the Intent, instead of the
5036 * main contents of the Intent. This allows you build an Intent containing
5037 * a generic protocol while targeting it more specifically.
5038 *
5039 * <p>An example of where this may be used is with things like
5040 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5041 * Intent that will launch the Browser application. However, the correct
5042 * main entry point of an application is actually {@link #ACTION_MAIN}
5043 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5044 * used to specify the actual Activity to launch. If you launch the browser
5045 * with something different, undesired behavior may happen if the user has
5046 * previously or later launches it the normal way, since they do not match.
5047 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5048 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5049 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5050 *
5051 * <p>Setting a selector does not impact the behavior of
5052 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5053 * desired behavior of a selector -- it does not impact the base meaning
5054 * of the Intent, just what kinds of things will be matched against it
5055 * when determining who can handle it.</p>
5056 *
5057 * <p>You can not use both a selector and {@link #setPackage(String)} on
5058 * the same base Intent.</p>
5059 *
5060 * @param selector The desired selector Intent; set to null to not use
5061 * a special selector.
5062 */
5063 public void setSelector(Intent selector) {
5064 if (selector == this) {
5065 throw new IllegalArgumentException(
5066 "Intent being set as a selector of itself");
5067 }
5068 if (selector != null && mPackage != null) {
5069 throw new IllegalArgumentException(
5070 "Can't set selector when package name is already set");
5071 }
5072 mSelector = selector;
5073 }
5074
5075 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005076 * Set a {@link ClipData} associated with this Intent. This replaces any
5077 * previously set ClipData.
5078 *
5079 * <p>The ClipData in an intent is not used for Intent matching or other
5080 * such operations. Semantically it is like extras, used to transmit
5081 * additional data with the Intent. The main feature of using this over
5082 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5083 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5084 * items included in the clip data. This is useful, in particular, if
5085 * you want to transmit an Intent containing multiple <code>content:</code>
5086 * URIs for which the recipient may not have global permission to access the
5087 * content provider.
5088 *
5089 * <p>If the ClipData contains items that are themselves Intents, any
5090 * grant flags in those Intents will be ignored. Only the top-level flags
5091 * of the main Intent are respected, and will be applied to all Uri or
5092 * Intent items in the clip (or sub-items of the clip).
5093 *
5094 * <p>The MIME type, label, and icon in the ClipData object are not
5095 * directly used by Intent. Applications should generally rely on the
5096 * MIME type of the Intent itself, not what it may find in the ClipData.
5097 * A common practice is to construct a ClipData for use with an Intent
5098 * with a MIME type of "*\/*".
5099 *
5100 * @param clip The new clip to set. May be null to clear the current clip.
5101 */
5102 public void setClipData(ClipData clip) {
5103 mClipData = clip;
5104 }
5105
5106 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005107 * Add extended data to the intent. The name must include a package
5108 * prefix, for example the app com.android.contacts would use names
5109 * like "com.android.contacts.ShowAll".
5110 *
5111 * @param name The name of the extra data, with package prefix.
5112 * @param value The boolean data value.
5113 *
5114 * @return Returns the same Intent object, for chaining multiple calls
5115 * into a single statement.
5116 *
5117 * @see #putExtras
5118 * @see #removeExtra
5119 * @see #getBooleanExtra(String, boolean)
5120 */
5121 public Intent putExtra(String name, boolean value) {
5122 if (mExtras == null) {
5123 mExtras = new Bundle();
5124 }
5125 mExtras.putBoolean(name, value);
5126 return this;
5127 }
5128
5129 /**
5130 * Add extended data to the intent. The name must include a package
5131 * prefix, for example the app com.android.contacts would use names
5132 * like "com.android.contacts.ShowAll".
5133 *
5134 * @param name The name of the extra data, with package prefix.
5135 * @param value The byte data value.
5136 *
5137 * @return Returns the same Intent object, for chaining multiple calls
5138 * into a single statement.
5139 *
5140 * @see #putExtras
5141 * @see #removeExtra
5142 * @see #getByteExtra(String, byte)
5143 */
5144 public Intent putExtra(String name, byte value) {
5145 if (mExtras == null) {
5146 mExtras = new Bundle();
5147 }
5148 mExtras.putByte(name, value);
5149 return this;
5150 }
5151
5152 /**
5153 * Add extended data to the intent. The name must include a package
5154 * prefix, for example the app com.android.contacts would use names
5155 * like "com.android.contacts.ShowAll".
5156 *
5157 * @param name The name of the extra data, with package prefix.
5158 * @param value The char data value.
5159 *
5160 * @return Returns the same Intent object, for chaining multiple calls
5161 * into a single statement.
5162 *
5163 * @see #putExtras
5164 * @see #removeExtra
5165 * @see #getCharExtra(String, char)
5166 */
5167 public Intent putExtra(String name, char value) {
5168 if (mExtras == null) {
5169 mExtras = new Bundle();
5170 }
5171 mExtras.putChar(name, value);
5172 return this;
5173 }
5174
5175 /**
5176 * Add extended data to the intent. The name must include a package
5177 * prefix, for example the app com.android.contacts would use names
5178 * like "com.android.contacts.ShowAll".
5179 *
5180 * @param name The name of the extra data, with package prefix.
5181 * @param value The short data value.
5182 *
5183 * @return Returns the same Intent object, for chaining multiple calls
5184 * into a single statement.
5185 *
5186 * @see #putExtras
5187 * @see #removeExtra
5188 * @see #getShortExtra(String, short)
5189 */
5190 public Intent putExtra(String name, short value) {
5191 if (mExtras == null) {
5192 mExtras = new Bundle();
5193 }
5194 mExtras.putShort(name, value);
5195 return this;
5196 }
5197
5198 /**
5199 * Add extended data to the intent. The name must include a package
5200 * prefix, for example the app com.android.contacts would use names
5201 * like "com.android.contacts.ShowAll".
5202 *
5203 * @param name The name of the extra data, with package prefix.
5204 * @param value The integer data value.
5205 *
5206 * @return Returns the same Intent object, for chaining multiple calls
5207 * into a single statement.
5208 *
5209 * @see #putExtras
5210 * @see #removeExtra
5211 * @see #getIntExtra(String, int)
5212 */
5213 public Intent putExtra(String name, int value) {
5214 if (mExtras == null) {
5215 mExtras = new Bundle();
5216 }
5217 mExtras.putInt(name, value);
5218 return this;
5219 }
5220
5221 /**
5222 * Add extended data to the intent. The name must include a package
5223 * prefix, for example the app com.android.contacts would use names
5224 * like "com.android.contacts.ShowAll".
5225 *
5226 * @param name The name of the extra data, with package prefix.
5227 * @param value The long data value.
5228 *
5229 * @return Returns the same Intent object, for chaining multiple calls
5230 * into a single statement.
5231 *
5232 * @see #putExtras
5233 * @see #removeExtra
5234 * @see #getLongExtra(String, long)
5235 */
5236 public Intent putExtra(String name, long value) {
5237 if (mExtras == null) {
5238 mExtras = new Bundle();
5239 }
5240 mExtras.putLong(name, value);
5241 return this;
5242 }
5243
5244 /**
5245 * Add extended data to the intent. The name must include a package
5246 * prefix, for example the app com.android.contacts would use names
5247 * like "com.android.contacts.ShowAll".
5248 *
5249 * @param name The name of the extra data, with package prefix.
5250 * @param value The float data value.
5251 *
5252 * @return Returns the same Intent object, for chaining multiple calls
5253 * into a single statement.
5254 *
5255 * @see #putExtras
5256 * @see #removeExtra
5257 * @see #getFloatExtra(String, float)
5258 */
5259 public Intent putExtra(String name, float value) {
5260 if (mExtras == null) {
5261 mExtras = new Bundle();
5262 }
5263 mExtras.putFloat(name, value);
5264 return this;
5265 }
5266
5267 /**
5268 * Add extended data to the intent. The name must include a package
5269 * prefix, for example the app com.android.contacts would use names
5270 * like "com.android.contacts.ShowAll".
5271 *
5272 * @param name The name of the extra data, with package prefix.
5273 * @param value The double data value.
5274 *
5275 * @return Returns the same Intent object, for chaining multiple calls
5276 * into a single statement.
5277 *
5278 * @see #putExtras
5279 * @see #removeExtra
5280 * @see #getDoubleExtra(String, double)
5281 */
5282 public Intent putExtra(String name, double value) {
5283 if (mExtras == null) {
5284 mExtras = new Bundle();
5285 }
5286 mExtras.putDouble(name, value);
5287 return this;
5288 }
5289
5290 /**
5291 * Add extended data to the intent. The name must include a package
5292 * prefix, for example the app com.android.contacts would use names
5293 * like "com.android.contacts.ShowAll".
5294 *
5295 * @param name The name of the extra data, with package prefix.
5296 * @param value The String data value.
5297 *
5298 * @return Returns the same Intent object, for chaining multiple calls
5299 * into a single statement.
5300 *
5301 * @see #putExtras
5302 * @see #removeExtra
5303 * @see #getStringExtra(String)
5304 */
5305 public Intent putExtra(String name, String value) {
5306 if (mExtras == null) {
5307 mExtras = new Bundle();
5308 }
5309 mExtras.putString(name, value);
5310 return this;
5311 }
5312
5313 /**
5314 * Add extended data to the intent. The name must include a package
5315 * prefix, for example the app com.android.contacts would use names
5316 * like "com.android.contacts.ShowAll".
5317 *
5318 * @param name The name of the extra data, with package prefix.
5319 * @param value The CharSequence data value.
5320 *
5321 * @return Returns the same Intent object, for chaining multiple calls
5322 * into a single statement.
5323 *
5324 * @see #putExtras
5325 * @see #removeExtra
5326 * @see #getCharSequenceExtra(String)
5327 */
5328 public Intent putExtra(String name, CharSequence value) {
5329 if (mExtras == null) {
5330 mExtras = new Bundle();
5331 }
5332 mExtras.putCharSequence(name, value);
5333 return this;
5334 }
5335
5336 /**
5337 * Add extended data to the intent. The name must include a package
5338 * prefix, for example the app com.android.contacts would use names
5339 * like "com.android.contacts.ShowAll".
5340 *
5341 * @param name The name of the extra data, with package prefix.
5342 * @param value The Parcelable data value.
5343 *
5344 * @return Returns the same Intent object, for chaining multiple calls
5345 * into a single statement.
5346 *
5347 * @see #putExtras
5348 * @see #removeExtra
5349 * @see #getParcelableExtra(String)
5350 */
5351 public Intent putExtra(String name, Parcelable value) {
5352 if (mExtras == null) {
5353 mExtras = new Bundle();
5354 }
5355 mExtras.putParcelable(name, value);
5356 return this;
5357 }
5358
5359 /**
5360 * Add extended data to the intent. The name must include a package
5361 * prefix, for example the app com.android.contacts would use names
5362 * like "com.android.contacts.ShowAll".
5363 *
5364 * @param name The name of the extra data, with package prefix.
5365 * @param value The Parcelable[] data value.
5366 *
5367 * @return Returns the same Intent object, for chaining multiple calls
5368 * into a single statement.
5369 *
5370 * @see #putExtras
5371 * @see #removeExtra
5372 * @see #getParcelableArrayExtra(String)
5373 */
5374 public Intent putExtra(String name, Parcelable[] value) {
5375 if (mExtras == null) {
5376 mExtras = new Bundle();
5377 }
5378 mExtras.putParcelableArray(name, value);
5379 return this;
5380 }
5381
5382 /**
5383 * Add extended data to the intent. The name must include a package
5384 * prefix, for example the app com.android.contacts would use names
5385 * like "com.android.contacts.ShowAll".
5386 *
5387 * @param name The name of the extra data, with package prefix.
5388 * @param value The ArrayList<Parcelable> data value.
5389 *
5390 * @return Returns the same Intent object, for chaining multiple calls
5391 * into a single statement.
5392 *
5393 * @see #putExtras
5394 * @see #removeExtra
5395 * @see #getParcelableArrayListExtra(String)
5396 */
5397 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5398 if (mExtras == null) {
5399 mExtras = new Bundle();
5400 }
5401 mExtras.putParcelableArrayList(name, value);
5402 return this;
5403 }
5404
5405 /**
5406 * Add extended data to the intent. The name must include a package
5407 * prefix, for example the app com.android.contacts would use names
5408 * like "com.android.contacts.ShowAll".
5409 *
5410 * @param name The name of the extra data, with package prefix.
5411 * @param value The ArrayList<Integer> data value.
5412 *
5413 * @return Returns the same Intent object, for chaining multiple calls
5414 * into a single statement.
5415 *
5416 * @see #putExtras
5417 * @see #removeExtra
5418 * @see #getIntegerArrayListExtra(String)
5419 */
5420 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5421 if (mExtras == null) {
5422 mExtras = new Bundle();
5423 }
5424 mExtras.putIntegerArrayList(name, value);
5425 return this;
5426 }
5427
5428 /**
5429 * Add extended data to the intent. The name must include a package
5430 * prefix, for example the app com.android.contacts would use names
5431 * like "com.android.contacts.ShowAll".
5432 *
5433 * @param name The name of the extra data, with package prefix.
5434 * @param value The ArrayList<String> data value.
5435 *
5436 * @return Returns the same Intent object, for chaining multiple calls
5437 * into a single statement.
5438 *
5439 * @see #putExtras
5440 * @see #removeExtra
5441 * @see #getStringArrayListExtra(String)
5442 */
5443 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5444 if (mExtras == null) {
5445 mExtras = new Bundle();
5446 }
5447 mExtras.putStringArrayList(name, value);
5448 return this;
5449 }
5450
5451 /**
5452 * Add extended data to the intent. The name must include a package
5453 * prefix, for example the app com.android.contacts would use names
5454 * like "com.android.contacts.ShowAll".
5455 *
5456 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005457 * @param value The ArrayList<CharSequence> data value.
5458 *
5459 * @return Returns the same Intent object, for chaining multiple calls
5460 * into a single statement.
5461 *
5462 * @see #putExtras
5463 * @see #removeExtra
5464 * @see #getCharSequenceArrayListExtra(String)
5465 */
5466 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5467 if (mExtras == null) {
5468 mExtras = new Bundle();
5469 }
5470 mExtras.putCharSequenceArrayList(name, value);
5471 return this;
5472 }
5473
5474 /**
5475 * Add extended data to the intent. The name must include a package
5476 * prefix, for example the app com.android.contacts would use names
5477 * like "com.android.contacts.ShowAll".
5478 *
5479 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005480 * @param value The Serializable data value.
5481 *
5482 * @return Returns the same Intent object, for chaining multiple calls
5483 * into a single statement.
5484 *
5485 * @see #putExtras
5486 * @see #removeExtra
5487 * @see #getSerializableExtra(String)
5488 */
5489 public Intent putExtra(String name, Serializable value) {
5490 if (mExtras == null) {
5491 mExtras = new Bundle();
5492 }
5493 mExtras.putSerializable(name, value);
5494 return this;
5495 }
5496
5497 /**
5498 * Add extended data to the intent. The name must include a package
5499 * prefix, for example the app com.android.contacts would use names
5500 * like "com.android.contacts.ShowAll".
5501 *
5502 * @param name The name of the extra data, with package prefix.
5503 * @param value The boolean array data value.
5504 *
5505 * @return Returns the same Intent object, for chaining multiple calls
5506 * into a single statement.
5507 *
5508 * @see #putExtras
5509 * @see #removeExtra
5510 * @see #getBooleanArrayExtra(String)
5511 */
5512 public Intent putExtra(String name, boolean[] value) {
5513 if (mExtras == null) {
5514 mExtras = new Bundle();
5515 }
5516 mExtras.putBooleanArray(name, value);
5517 return this;
5518 }
5519
5520 /**
5521 * Add extended data to the intent. The name must include a package
5522 * prefix, for example the app com.android.contacts would use names
5523 * like "com.android.contacts.ShowAll".
5524 *
5525 * @param name The name of the extra data, with package prefix.
5526 * @param value The byte array data value.
5527 *
5528 * @return Returns the same Intent object, for chaining multiple calls
5529 * into a single statement.
5530 *
5531 * @see #putExtras
5532 * @see #removeExtra
5533 * @see #getByteArrayExtra(String)
5534 */
5535 public Intent putExtra(String name, byte[] value) {
5536 if (mExtras == null) {
5537 mExtras = new Bundle();
5538 }
5539 mExtras.putByteArray(name, value);
5540 return this;
5541 }
5542
5543 /**
5544 * Add extended data to the intent. The name must include a package
5545 * prefix, for example the app com.android.contacts would use names
5546 * like "com.android.contacts.ShowAll".
5547 *
5548 * @param name The name of the extra data, with package prefix.
5549 * @param value The short array data value.
5550 *
5551 * @return Returns the same Intent object, for chaining multiple calls
5552 * into a single statement.
5553 *
5554 * @see #putExtras
5555 * @see #removeExtra
5556 * @see #getShortArrayExtra(String)
5557 */
5558 public Intent putExtra(String name, short[] value) {
5559 if (mExtras == null) {
5560 mExtras = new Bundle();
5561 }
5562 mExtras.putShortArray(name, value);
5563 return this;
5564 }
5565
5566 /**
5567 * Add extended data to the intent. The name must include a package
5568 * prefix, for example the app com.android.contacts would use names
5569 * like "com.android.contacts.ShowAll".
5570 *
5571 * @param name The name of the extra data, with package prefix.
5572 * @param value The char array data value.
5573 *
5574 * @return Returns the same Intent object, for chaining multiple calls
5575 * into a single statement.
5576 *
5577 * @see #putExtras
5578 * @see #removeExtra
5579 * @see #getCharArrayExtra(String)
5580 */
5581 public Intent putExtra(String name, char[] value) {
5582 if (mExtras == null) {
5583 mExtras = new Bundle();
5584 }
5585 mExtras.putCharArray(name, value);
5586 return this;
5587 }
5588
5589 /**
5590 * Add extended data to the intent. The name must include a package
5591 * prefix, for example the app com.android.contacts would use names
5592 * like "com.android.contacts.ShowAll".
5593 *
5594 * @param name The name of the extra data, with package prefix.
5595 * @param value The int array data value.
5596 *
5597 * @return Returns the same Intent object, for chaining multiple calls
5598 * into a single statement.
5599 *
5600 * @see #putExtras
5601 * @see #removeExtra
5602 * @see #getIntArrayExtra(String)
5603 */
5604 public Intent putExtra(String name, int[] value) {
5605 if (mExtras == null) {
5606 mExtras = new Bundle();
5607 }
5608 mExtras.putIntArray(name, value);
5609 return this;
5610 }
5611
5612 /**
5613 * Add extended data to the intent. The name must include a package
5614 * prefix, for example the app com.android.contacts would use names
5615 * like "com.android.contacts.ShowAll".
5616 *
5617 * @param name The name of the extra data, with package prefix.
5618 * @param value The byte array data value.
5619 *
5620 * @return Returns the same Intent object, for chaining multiple calls
5621 * into a single statement.
5622 *
5623 * @see #putExtras
5624 * @see #removeExtra
5625 * @see #getLongArrayExtra(String)
5626 */
5627 public Intent putExtra(String name, long[] value) {
5628 if (mExtras == null) {
5629 mExtras = new Bundle();
5630 }
5631 mExtras.putLongArray(name, value);
5632 return this;
5633 }
5634
5635 /**
5636 * Add extended data to the intent. The name must include a package
5637 * prefix, for example the app com.android.contacts would use names
5638 * like "com.android.contacts.ShowAll".
5639 *
5640 * @param name The name of the extra data, with package prefix.
5641 * @param value The float array data value.
5642 *
5643 * @return Returns the same Intent object, for chaining multiple calls
5644 * into a single statement.
5645 *
5646 * @see #putExtras
5647 * @see #removeExtra
5648 * @see #getFloatArrayExtra(String)
5649 */
5650 public Intent putExtra(String name, float[] value) {
5651 if (mExtras == null) {
5652 mExtras = new Bundle();
5653 }
5654 mExtras.putFloatArray(name, value);
5655 return this;
5656 }
5657
5658 /**
5659 * Add extended data to the intent. The name must include a package
5660 * prefix, for example the app com.android.contacts would use names
5661 * like "com.android.contacts.ShowAll".
5662 *
5663 * @param name The name of the extra data, with package prefix.
5664 * @param value The double array data value.
5665 *
5666 * @return Returns the same Intent object, for chaining multiple calls
5667 * into a single statement.
5668 *
5669 * @see #putExtras
5670 * @see #removeExtra
5671 * @see #getDoubleArrayExtra(String)
5672 */
5673 public Intent putExtra(String name, double[] value) {
5674 if (mExtras == null) {
5675 mExtras = new Bundle();
5676 }
5677 mExtras.putDoubleArray(name, value);
5678 return this;
5679 }
5680
5681 /**
5682 * Add extended data to the intent. The name must include a package
5683 * prefix, for example the app com.android.contacts would use names
5684 * like "com.android.contacts.ShowAll".
5685 *
5686 * @param name The name of the extra data, with package prefix.
5687 * @param value The String array data value.
5688 *
5689 * @return Returns the same Intent object, for chaining multiple calls
5690 * into a single statement.
5691 *
5692 * @see #putExtras
5693 * @see #removeExtra
5694 * @see #getStringArrayExtra(String)
5695 */
5696 public Intent putExtra(String name, String[] value) {
5697 if (mExtras == null) {
5698 mExtras = new Bundle();
5699 }
5700 mExtras.putStringArray(name, value);
5701 return this;
5702 }
5703
5704 /**
5705 * Add extended data to the intent. The name must include a package
5706 * prefix, for example the app com.android.contacts would use names
5707 * like "com.android.contacts.ShowAll".
5708 *
5709 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005710 * @param value The CharSequence array data value.
5711 *
5712 * @return Returns the same Intent object, for chaining multiple calls
5713 * into a single statement.
5714 *
5715 * @see #putExtras
5716 * @see #removeExtra
5717 * @see #getCharSequenceArrayExtra(String)
5718 */
5719 public Intent putExtra(String name, CharSequence[] value) {
5720 if (mExtras == null) {
5721 mExtras = new Bundle();
5722 }
5723 mExtras.putCharSequenceArray(name, value);
5724 return this;
5725 }
5726
5727 /**
5728 * Add extended data to the intent. The name must include a package
5729 * prefix, for example the app com.android.contacts would use names
5730 * like "com.android.contacts.ShowAll".
5731 *
5732 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005733 * @param value The Bundle data value.
5734 *
5735 * @return Returns the same Intent object, for chaining multiple calls
5736 * into a single statement.
5737 *
5738 * @see #putExtras
5739 * @see #removeExtra
5740 * @see #getBundleExtra(String)
5741 */
5742 public Intent putExtra(String name, Bundle value) {
5743 if (mExtras == null) {
5744 mExtras = new Bundle();
5745 }
5746 mExtras.putBundle(name, value);
5747 return this;
5748 }
5749
5750 /**
5751 * Add extended data to the intent. The name must include a package
5752 * prefix, for example the app com.android.contacts would use names
5753 * like "com.android.contacts.ShowAll".
5754 *
5755 * @param name The name of the extra data, with package prefix.
5756 * @param value The IBinder data value.
5757 *
5758 * @return Returns the same Intent object, for chaining multiple calls
5759 * into a single statement.
5760 *
5761 * @see #putExtras
5762 * @see #removeExtra
5763 * @see #getIBinderExtra(String)
5764 *
5765 * @deprecated
5766 * @hide
5767 */
5768 @Deprecated
5769 public Intent putExtra(String name, IBinder value) {
5770 if (mExtras == null) {
5771 mExtras = new Bundle();
5772 }
5773 mExtras.putIBinder(name, value);
5774 return this;
5775 }
5776
5777 /**
5778 * Copy all extras in 'src' in to this intent.
5779 *
5780 * @param src Contains the extras to copy.
5781 *
5782 * @see #putExtra
5783 */
5784 public Intent putExtras(Intent src) {
5785 if (src.mExtras != null) {
5786 if (mExtras == null) {
5787 mExtras = new Bundle(src.mExtras);
5788 } else {
5789 mExtras.putAll(src.mExtras);
5790 }
5791 }
5792 return this;
5793 }
5794
5795 /**
5796 * Add a set of extended data to the intent. The keys must include a package
5797 * prefix, for example the app com.android.contacts would use names
5798 * like "com.android.contacts.ShowAll".
5799 *
5800 * @param extras The Bundle of extras to add to this intent.
5801 *
5802 * @see #putExtra
5803 * @see #removeExtra
5804 */
5805 public Intent putExtras(Bundle extras) {
5806 if (mExtras == null) {
5807 mExtras = new Bundle();
5808 }
5809 mExtras.putAll(extras);
5810 return this;
5811 }
5812
5813 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005814 * Completely replace the extras in the Intent with the extras in the
5815 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005816 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005817 * @param src The exact extras contained in this Intent are copied
5818 * into the target intent, replacing any that were previously there.
5819 */
5820 public Intent replaceExtras(Intent src) {
5821 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5822 return this;
5823 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005824
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005825 /**
5826 * Completely replace the extras in the Intent with the given Bundle of
5827 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005828 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005829 * @param extras The new set of extras in the Intent, or null to erase
5830 * all extras.
5831 */
5832 public Intent replaceExtras(Bundle extras) {
5833 mExtras = extras != null ? new Bundle(extras) : null;
5834 return this;
5835 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005836
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005837 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005838 * Remove extended data from the intent.
5839 *
5840 * @see #putExtra
5841 */
5842 public void removeExtra(String name) {
5843 if (mExtras != null) {
5844 mExtras.remove(name);
5845 if (mExtras.size() == 0) {
5846 mExtras = null;
5847 }
5848 }
5849 }
5850
5851 /**
5852 * Set special flags controlling how this intent is handled. Most values
5853 * here depend on the type of component being executed by the Intent,
5854 * specifically the FLAG_ACTIVITY_* flags are all for use with
5855 * {@link Context#startActivity Context.startActivity()} and the
5856 * FLAG_RECEIVER_* flags are all for use with
5857 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5858 *
Scott Main7aee61f2011-02-08 11:25:01 -08005859 * <p>See the
5860 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5861 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005862 * the behavior of your application.
5863 *
5864 * @param flags The desired flags.
5865 *
5866 * @return Returns the same Intent object, for chaining multiple calls
5867 * into a single statement.
5868 *
5869 * @see #getFlags
5870 * @see #addFlags
5871 *
5872 * @see #FLAG_GRANT_READ_URI_PERMISSION
5873 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5874 * @see #FLAG_DEBUG_LOG_RESOLUTION
5875 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005876 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005877 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005878 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005879 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005880 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5881 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005882 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005883 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5884 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005885 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005886 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005887 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005888 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5889 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005890 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005891 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005892 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005893 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5894 */
5895 public Intent setFlags(int flags) {
5896 mFlags = flags;
5897 return this;
5898 }
5899
5900 /**
5901 * Add additional flags to the intent (or with existing flags
5902 * value).
5903 *
5904 * @param flags The new flags to set.
5905 *
5906 * @return Returns the same Intent object, for chaining multiple calls
5907 * into a single statement.
5908 *
5909 * @see #setFlags
5910 */
5911 public Intent addFlags(int flags) {
5912 mFlags |= flags;
5913 return this;
5914 }
5915
5916 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005917 * (Usually optional) Set an explicit application package name that limits
5918 * the components this Intent will resolve to. If left to the default
5919 * value of null, all components in all applications will considered.
5920 * If non-null, the Intent can only match the components in the given
5921 * application package.
5922 *
5923 * @param packageName The name of the application package to handle the
5924 * intent, or null to allow any application package.
5925 *
5926 * @return Returns the same Intent object, for chaining multiple calls
5927 * into a single statement.
5928 *
5929 * @see #getPackage
5930 * @see #resolveActivity
5931 */
5932 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005933 if (packageName != null && mSelector != null) {
5934 throw new IllegalArgumentException(
5935 "Can't set package name when selector is already set");
5936 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005937 mPackage = packageName;
5938 return this;
5939 }
5940
5941 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005942 * (Usually optional) Explicitly set the component to handle the intent.
5943 * If left with the default value of null, the system will determine the
5944 * appropriate class to use based on the other fields (action, data,
5945 * type, categories) in the Intent. If this class is defined, the
5946 * specified class will always be used regardless of the other fields. You
5947 * should only set this value when you know you absolutely want a specific
5948 * class to be used; otherwise it is better to let the system find the
5949 * appropriate class so that you will respect the installed applications
5950 * and user preferences.
5951 *
5952 * @param component The name of the application component to handle the
5953 * intent, or null to let the system find one for you.
5954 *
5955 * @return Returns the same Intent object, for chaining multiple calls
5956 * into a single statement.
5957 *
5958 * @see #setClass
5959 * @see #setClassName(Context, String)
5960 * @see #setClassName(String, String)
5961 * @see #getComponent
5962 * @see #resolveActivity
5963 */
5964 public Intent setComponent(ComponentName component) {
5965 mComponent = component;
5966 return this;
5967 }
5968
5969 /**
5970 * Convenience for calling {@link #setComponent} with an
5971 * explicit class name.
5972 *
5973 * @param packageContext A Context of the application package implementing
5974 * this class.
5975 * @param className The name of a class inside of the application package
5976 * that will be used as the component for this Intent.
5977 *
5978 * @return Returns the same Intent object, for chaining multiple calls
5979 * into a single statement.
5980 *
5981 * @see #setComponent
5982 * @see #setClass
5983 */
5984 public Intent setClassName(Context packageContext, String className) {
5985 mComponent = new ComponentName(packageContext, className);
5986 return this;
5987 }
5988
5989 /**
5990 * Convenience for calling {@link #setComponent} with an
5991 * explicit application package name and class name.
5992 *
5993 * @param packageName The name of the package implementing the desired
5994 * component.
5995 * @param className The name of a class inside of the application package
5996 * that will be used as the component for this Intent.
5997 *
5998 * @return Returns the same Intent object, for chaining multiple calls
5999 * into a single statement.
6000 *
6001 * @see #setComponent
6002 * @see #setClass
6003 */
6004 public Intent setClassName(String packageName, String className) {
6005 mComponent = new ComponentName(packageName, className);
6006 return this;
6007 }
6008
6009 /**
6010 * Convenience for calling {@link #setComponent(ComponentName)} with the
6011 * name returned by a {@link Class} object.
6012 *
6013 * @param packageContext A Context of the application package implementing
6014 * this class.
6015 * @param cls The class name to set, equivalent to
6016 * <code>setClassName(context, cls.getName())</code>.
6017 *
6018 * @return Returns the same Intent object, for chaining multiple calls
6019 * into a single statement.
6020 *
6021 * @see #setComponent
6022 */
6023 public Intent setClass(Context packageContext, Class<?> cls) {
6024 mComponent = new ComponentName(packageContext, cls);
6025 return this;
6026 }
6027
6028 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006029 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6030 * used as a hint to the receiver for animations and the like. Null means that there
6031 * is no source bounds.
6032 */
6033 public void setSourceBounds(Rect r) {
6034 if (r != null) {
6035 mSourceBounds = new Rect(r);
6036 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006037 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006038 }
6039 }
6040
6041 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006042 * Use with {@link #fillIn} to allow the current action value to be
6043 * overwritten, even if it is already set.
6044 */
6045 public static final int FILL_IN_ACTION = 1<<0;
6046
6047 /**
6048 * Use with {@link #fillIn} to allow the current data or type value
6049 * overwritten, even if it is already set.
6050 */
6051 public static final int FILL_IN_DATA = 1<<1;
6052
6053 /**
6054 * Use with {@link #fillIn} to allow the current categories to be
6055 * overwritten, even if they are already set.
6056 */
6057 public static final int FILL_IN_CATEGORIES = 1<<2;
6058
6059 /**
6060 * Use with {@link #fillIn} to allow the current component value to be
6061 * overwritten, even if it is already set.
6062 */
6063 public static final int FILL_IN_COMPONENT = 1<<3;
6064
6065 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006066 * Use with {@link #fillIn} to allow the current package value to be
6067 * overwritten, even if it is already set.
6068 */
6069 public static final int FILL_IN_PACKAGE = 1<<4;
6070
6071 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006072 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006073 * overwritten, even if it is already set.
6074 */
6075 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6076
6077 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006078 * Use with {@link #fillIn} to allow the current selector to be
6079 * overwritten, even if it is already set.
6080 */
6081 public static final int FILL_IN_SELECTOR = 1<<6;
6082
6083 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006084 * Use with {@link #fillIn} to allow the current ClipData to be
6085 * overwritten, even if it is already set.
6086 */
6087 public static final int FILL_IN_CLIP_DATA = 1<<7;
6088
6089 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006090 * Copy the contents of <var>other</var> in to this object, but only
6091 * where fields are not defined by this object. For purposes of a field
6092 * being defined, the following pieces of data in the Intent are
6093 * considered to be separate fields:
6094 *
6095 * <ul>
6096 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006097 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006098 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6099 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006100 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006101 * <li> component, as set by {@link #setComponent(ComponentName)} or
6102 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006103 * <li> source bounds, as set by {@link #setSourceBounds}.
6104 * <li> selector, as set by {@link #setSelector(Intent)}.
6105 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006106 * <li> each top-level name in the associated extras.
6107 * </ul>
6108 *
6109 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006110 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006111 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6112 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6113 * the restriction where the corresponding field will not be replaced if
6114 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006115 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006116 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6117 * is explicitly specified. The selector will only be copied if
6118 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006119 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006120 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6121 * and Intent B with {action="gotit", data-type="some/thing",
6122 * categories="one","two"}.
6123 *
6124 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6125 * containing: {action="gotit", data-type="some/thing",
6126 * categories="bar"}.
6127 *
6128 * @param other Another Intent whose values are to be used to fill in
6129 * the current one.
6130 * @param flags Options to control which fields can be filled in.
6131 *
6132 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006133 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006134 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6135 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006136 */
6137 public int fillIn(Intent other, int flags) {
6138 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006139 if (other.mAction != null
6140 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006141 mAction = other.mAction;
6142 changes |= FILL_IN_ACTION;
6143 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006144 if ((other.mData != null || other.mType != null)
6145 && ((mData == null && mType == null)
6146 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006147 mData = other.mData;
6148 mType = other.mType;
6149 changes |= FILL_IN_DATA;
6150 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006151 if (other.mCategories != null
6152 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006153 if (other.mCategories != null) {
6154 mCategories = new HashSet<String>(other.mCategories);
6155 }
6156 changes |= FILL_IN_CATEGORIES;
6157 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006158 if (other.mPackage != null
6159 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006160 // Only do this if mSelector is not set.
6161 if (mSelector == null) {
6162 mPackage = other.mPackage;
6163 changes |= FILL_IN_PACKAGE;
6164 }
6165 }
6166 // Selector is special: it can only be set if explicitly allowed,
6167 // for the same reason as the component name.
6168 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6169 if (mPackage == null) {
6170 mSelector = new Intent(other.mSelector);
6171 mPackage = null;
6172 changes |= FILL_IN_SELECTOR;
6173 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006174 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006175 if (other.mClipData != null
6176 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6177 mClipData = other.mClipData;
6178 changes |= FILL_IN_CLIP_DATA;
6179 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006180 // Component is special: it can -only- be set if explicitly allowed,
6181 // since otherwise the sender could force the intent somewhere the
6182 // originator didn't intend.
6183 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006184 mComponent = other.mComponent;
6185 changes |= FILL_IN_COMPONENT;
6186 }
6187 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006188 if (other.mSourceBounds != null
6189 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6190 mSourceBounds = new Rect(other.mSourceBounds);
6191 changes |= FILL_IN_SOURCE_BOUNDS;
6192 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006193 if (mExtras == null) {
6194 if (other.mExtras != null) {
6195 mExtras = new Bundle(other.mExtras);
6196 }
6197 } else if (other.mExtras != null) {
6198 try {
6199 Bundle newb = new Bundle(other.mExtras);
6200 newb.putAll(mExtras);
6201 mExtras = newb;
6202 } catch (RuntimeException e) {
6203 // Modifying the extras can cause us to unparcel the contents
6204 // of the bundle, and if we do this in the system process that
6205 // may fail. We really should handle this (i.e., the Bundle
6206 // impl shouldn't be on top of a plain map), but for now just
6207 // ignore it and keep the original contents. :(
6208 Log.w("Intent", "Failure filling in extras", e);
6209 }
6210 }
6211 return changes;
6212 }
6213
6214 /**
6215 * Wrapper class holding an Intent and implementing comparisons on it for
6216 * the purpose of filtering. The class implements its
6217 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6218 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6219 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6220 * on the wrapped Intent.
6221 */
6222 public static final class FilterComparison {
6223 private final Intent mIntent;
6224 private final int mHashCode;
6225
6226 public FilterComparison(Intent intent) {
6227 mIntent = intent;
6228 mHashCode = intent.filterHashCode();
6229 }
6230
6231 /**
6232 * Return the Intent that this FilterComparison represents.
6233 * @return Returns the Intent held by the FilterComparison. Do
6234 * not modify!
6235 */
6236 public Intent getIntent() {
6237 return mIntent;
6238 }
6239
6240 @Override
6241 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006242 if (obj instanceof FilterComparison) {
6243 Intent other = ((FilterComparison)obj).mIntent;
6244 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006245 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006246 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006247 }
6248
6249 @Override
6250 public int hashCode() {
6251 return mHashCode;
6252 }
6253 }
6254
6255 /**
6256 * Determine if two intents are the same for the purposes of intent
6257 * resolution (filtering). That is, if their action, data, type,
6258 * class, and categories are the same. This does <em>not</em> compare
6259 * any extra data included in the intents.
6260 *
6261 * @param other The other Intent to compare against.
6262 *
6263 * @return Returns true if action, data, type, class, and categories
6264 * are the same.
6265 */
6266 public boolean filterEquals(Intent other) {
6267 if (other == null) {
6268 return false;
6269 }
6270 if (mAction != other.mAction) {
6271 if (mAction != null) {
6272 if (!mAction.equals(other.mAction)) {
6273 return false;
6274 }
6275 } else {
6276 if (!other.mAction.equals(mAction)) {
6277 return false;
6278 }
6279 }
6280 }
6281 if (mData != other.mData) {
6282 if (mData != null) {
6283 if (!mData.equals(other.mData)) {
6284 return false;
6285 }
6286 } else {
6287 if (!other.mData.equals(mData)) {
6288 return false;
6289 }
6290 }
6291 }
6292 if (mType != other.mType) {
6293 if (mType != null) {
6294 if (!mType.equals(other.mType)) {
6295 return false;
6296 }
6297 } else {
6298 if (!other.mType.equals(mType)) {
6299 return false;
6300 }
6301 }
6302 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006303 if (mPackage != other.mPackage) {
6304 if (mPackage != null) {
6305 if (!mPackage.equals(other.mPackage)) {
6306 return false;
6307 }
6308 } else {
6309 if (!other.mPackage.equals(mPackage)) {
6310 return false;
6311 }
6312 }
6313 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006314 if (mComponent != other.mComponent) {
6315 if (mComponent != null) {
6316 if (!mComponent.equals(other.mComponent)) {
6317 return false;
6318 }
6319 } else {
6320 if (!other.mComponent.equals(mComponent)) {
6321 return false;
6322 }
6323 }
6324 }
6325 if (mCategories != other.mCategories) {
6326 if (mCategories != null) {
6327 if (!mCategories.equals(other.mCategories)) {
6328 return false;
6329 }
6330 } else {
6331 if (!other.mCategories.equals(mCategories)) {
6332 return false;
6333 }
6334 }
6335 }
6336
6337 return true;
6338 }
6339
6340 /**
6341 * Generate hash code that matches semantics of filterEquals().
6342 *
6343 * @return Returns the hash value of the action, data, type, class, and
6344 * categories.
6345 *
6346 * @see #filterEquals
6347 */
6348 public int filterHashCode() {
6349 int code = 0;
6350 if (mAction != null) {
6351 code += mAction.hashCode();
6352 }
6353 if (mData != null) {
6354 code += mData.hashCode();
6355 }
6356 if (mType != null) {
6357 code += mType.hashCode();
6358 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006359 if (mPackage != null) {
6360 code += mPackage.hashCode();
6361 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006362 if (mComponent != null) {
6363 code += mComponent.hashCode();
6364 }
6365 if (mCategories != null) {
6366 code += mCategories.hashCode();
6367 }
6368 return code;
6369 }
6370
6371 @Override
6372 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006373 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006374
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006375 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006376 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006377 b.append(" }");
6378
6379 return b.toString();
6380 }
6381
6382 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006383 public String toInsecureString() {
6384 StringBuilder b = new StringBuilder(128);
6385
6386 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006387 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006388 b.append(" }");
6389
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006390 return b.toString();
6391 }
Romain Guy4969af72009-06-17 10:53:19 -07006392
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006393 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006394 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006395 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006396
6397 b.append("Intent { ");
6398 toShortString(b, false, true, true, true);
6399 b.append(" }");
6400
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006401 return b.toString();
6402 }
6403
6404 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006405 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6406 StringBuilder b = new StringBuilder(128);
6407 toShortString(b, secure, comp, extras, clip);
6408 return b.toString();
6409 }
6410
6411 /** @hide */
6412 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6413 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006414 boolean first = true;
6415 if (mAction != null) {
6416 b.append("act=").append(mAction);
6417 first = false;
6418 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006419 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006420 if (!first) {
6421 b.append(' ');
6422 }
6423 first = false;
6424 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006425 Iterator<String> i = mCategories.iterator();
6426 boolean didone = false;
6427 while (i.hasNext()) {
6428 if (didone) b.append(",");
6429 didone = true;
6430 b.append(i.next());
6431 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006432 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006433 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006434 if (mData != null) {
6435 if (!first) {
6436 b.append(' ');
6437 }
6438 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006439 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006440 if (secure) {
6441 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006442 } else {
6443 b.append(mData);
6444 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006445 }
6446 if (mType != null) {
6447 if (!first) {
6448 b.append(' ');
6449 }
6450 first = false;
6451 b.append("typ=").append(mType);
6452 }
6453 if (mFlags != 0) {
6454 if (!first) {
6455 b.append(' ');
6456 }
6457 first = false;
6458 b.append("flg=0x").append(Integer.toHexString(mFlags));
6459 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006460 if (mPackage != null) {
6461 if (!first) {
6462 b.append(' ');
6463 }
6464 first = false;
6465 b.append("pkg=").append(mPackage);
6466 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006467 if (comp && mComponent != null) {
6468 if (!first) {
6469 b.append(' ');
6470 }
6471 first = false;
6472 b.append("cmp=").append(mComponent.flattenToShortString());
6473 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006474 if (mSourceBounds != null) {
6475 if (!first) {
6476 b.append(' ');
6477 }
6478 first = false;
6479 b.append("bnds=").append(mSourceBounds.toShortString());
6480 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006481 if (mClipData != null) {
6482 if (!first) {
6483 b.append(' ');
6484 }
6485 first = false;
6486 if (clip) {
6487 b.append("clip={");
6488 mClipData.toShortString(b);
6489 b.append('}');
6490 } else {
6491 b.append("(has clip)");
6492 }
6493 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006494 if (extras && mExtras != null) {
6495 if (!first) {
6496 b.append(' ');
6497 }
6498 first = false;
6499 b.append("(has extras)");
6500 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006501 if (mSelector != null) {
6502 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006503 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006504 b.append("}");
6505 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006506 }
6507
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006508 /**
6509 * Call {@link #toUri} with 0 flags.
6510 * @deprecated Use {@link #toUri} instead.
6511 */
6512 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006513 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006514 return toUri(0);
6515 }
6516
6517 /**
6518 * Convert this Intent into a String holding a URI representation of it.
6519 * The returned URI string has been properly URI encoded, so it can be
6520 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6521 * Intent's data as the base URI, with an additional fragment describing
6522 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006523 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006524 * <p>You can convert the returned string back to an Intent with
6525 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006526 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006527 * @param flags Additional operating flags. Either 0 or
6528 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006529 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006530 * @return Returns a URI encoding URI string describing the entire contents
6531 * of the Intent.
6532 */
6533 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006534 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006535 String scheme = null;
6536 if (mData != null) {
6537 String data = mData.toString();
6538 if ((flags&URI_INTENT_SCHEME) != 0) {
6539 final int N = data.length();
6540 for (int i=0; i<N; i++) {
6541 char c = data.charAt(i);
6542 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6543 || c == '.' || c == '-') {
6544 continue;
6545 }
6546 if (c == ':' && i > 0) {
6547 // Valid scheme.
6548 scheme = data.substring(0, i);
6549 uri.append("intent:");
6550 data = data.substring(i+1);
6551 break;
6552 }
Tom Taylord4a47292009-12-21 13:59:18 -08006553
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006554 // No scheme.
6555 break;
6556 }
6557 }
6558 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006559
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006560 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6561 uri.append("intent:");
6562 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006563
6564 uri.append("#Intent;");
6565
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006566 toUriInner(uri, scheme, flags);
6567 if (mSelector != null) {
6568 uri.append("SEL;");
6569 // Note that for now we are not going to try to handle the
6570 // data part; not clear how to represent this as a URI, and
6571 // not much utility in it.
6572 mSelector.toUriInner(uri, null, flags);
6573 }
6574
6575 uri.append("end");
6576
6577 return uri.toString();
6578 }
6579
6580 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006581 if (scheme != null) {
6582 uri.append("scheme=").append(scheme).append(';');
6583 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006584 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006585 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006586 }
6587 if (mCategories != null) {
6588 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006589 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006590 }
6591 }
6592 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006593 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006594 }
6595 if (mFlags != 0) {
6596 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6597 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006598 if (mPackage != null) {
6599 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6600 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006601 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006602 uri.append("component=").append(Uri.encode(
6603 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006604 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006605 if (mSourceBounds != null) {
6606 uri.append("sourceBounds=")
6607 .append(Uri.encode(mSourceBounds.flattenToString()))
6608 .append(';');
6609 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006610 if (mExtras != null) {
6611 for (String key : mExtras.keySet()) {
6612 final Object value = mExtras.get(key);
6613 char entryType =
6614 value instanceof String ? 'S' :
6615 value instanceof Boolean ? 'B' :
6616 value instanceof Byte ? 'b' :
6617 value instanceof Character ? 'c' :
6618 value instanceof Double ? 'd' :
6619 value instanceof Float ? 'f' :
6620 value instanceof Integer ? 'i' :
6621 value instanceof Long ? 'l' :
6622 value instanceof Short ? 's' :
6623 '\0';
6624
6625 if (entryType != '\0') {
6626 uri.append(entryType);
6627 uri.append('.');
6628 uri.append(Uri.encode(key));
6629 uri.append('=');
6630 uri.append(Uri.encode(value.toString()));
6631 uri.append(';');
6632 }
6633 }
6634 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006635 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006636
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006637 public int describeContents() {
6638 return (mExtras != null) ? mExtras.describeContents() : 0;
6639 }
6640
6641 public void writeToParcel(Parcel out, int flags) {
6642 out.writeString(mAction);
6643 Uri.writeToParcel(out, mData);
6644 out.writeString(mType);
6645 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006646 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006647 ComponentName.writeToParcel(mComponent, out);
6648
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006649 if (mSourceBounds != null) {
6650 out.writeInt(1);
6651 mSourceBounds.writeToParcel(out, flags);
6652 } else {
6653 out.writeInt(0);
6654 }
6655
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006656 if (mCategories != null) {
6657 out.writeInt(mCategories.size());
6658 for (String category : mCategories) {
6659 out.writeString(category);
6660 }
6661 } else {
6662 out.writeInt(0);
6663 }
6664
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006665 if (mSelector != null) {
6666 out.writeInt(1);
6667 mSelector.writeToParcel(out, flags);
6668 } else {
6669 out.writeInt(0);
6670 }
6671
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006672 if (mClipData != null) {
6673 out.writeInt(1);
6674 mClipData.writeToParcel(out, flags);
6675 } else {
6676 out.writeInt(0);
6677 }
6678
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006679 out.writeBundle(mExtras);
6680 }
6681
6682 public static final Parcelable.Creator<Intent> CREATOR
6683 = new Parcelable.Creator<Intent>() {
6684 public Intent createFromParcel(Parcel in) {
6685 return new Intent(in);
6686 }
6687 public Intent[] newArray(int size) {
6688 return new Intent[size];
6689 }
6690 };
6691
Dianne Hackborneb034652009-09-07 00:49:58 -07006692 /** @hide */
6693 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006694 readFromParcel(in);
6695 }
6696
6697 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006698 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006699 mData = Uri.CREATOR.createFromParcel(in);
6700 mType = in.readString();
6701 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006702 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006703 mComponent = ComponentName.readFromParcel(in);
6704
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006705 if (in.readInt() != 0) {
6706 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6707 }
6708
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006709 int N = in.readInt();
6710 if (N > 0) {
6711 mCategories = new HashSet<String>();
6712 int i;
6713 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006714 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006715 }
6716 } else {
6717 mCategories = null;
6718 }
6719
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006720 if (in.readInt() != 0) {
6721 mSelector = new Intent(in);
6722 }
6723
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006724 if (in.readInt() != 0) {
6725 mClipData = new ClipData(in);
6726 }
6727
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006728 mExtras = in.readBundle();
6729 }
6730
6731 /**
6732 * Parses the "intent" element (and its children) from XML and instantiates
6733 * an Intent object. The given XML parser should be located at the tag
6734 * where parsing should start (often named "intent"), from which the
6735 * basic action, data, type, and package and class name will be
6736 * retrieved. The function will then parse in to any child elements,
6737 * looking for <category android:name="xxx"> tags to add categories and
6738 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6739 * to the intent.
6740 *
6741 * @param resources The Resources to use when inflating resources.
6742 * @param parser The XML parser pointing at an "intent" tag.
6743 * @param attrs The AttributeSet interface for retrieving extended
6744 * attribute data at the current <var>parser</var> location.
6745 * @return An Intent object matching the XML data.
6746 * @throws XmlPullParserException If there was an XML parsing error.
6747 * @throws IOException If there was an I/O error.
6748 */
6749 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6750 throws XmlPullParserException, IOException {
6751 Intent intent = new Intent();
6752
6753 TypedArray sa = resources.obtainAttributes(attrs,
6754 com.android.internal.R.styleable.Intent);
6755
6756 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6757
6758 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6759 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6760 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6761
6762 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6763 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6764 if (packageName != null && className != null) {
6765 intent.setComponent(new ComponentName(packageName, className));
6766 }
6767
6768 sa.recycle();
6769
6770 int outerDepth = parser.getDepth();
6771 int type;
6772 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6773 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6774 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6775 continue;
6776 }
6777
6778 String nodeName = parser.getName();
6779 if (nodeName.equals("category")) {
6780 sa = resources.obtainAttributes(attrs,
6781 com.android.internal.R.styleable.IntentCategory);
6782 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6783 sa.recycle();
6784
6785 if (cat != null) {
6786 intent.addCategory(cat);
6787 }
6788 XmlUtils.skipCurrentTag(parser);
6789
6790 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006791 if (intent.mExtras == null) {
6792 intent.mExtras = new Bundle();
6793 }
6794 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6795 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006796
6797 } else {
6798 XmlUtils.skipCurrentTag(parser);
6799 }
6800 }
6801
6802 return intent;
6803 }
Nick Pellyccae4122012-01-09 14:12:58 -08006804
6805 /**
6806 * Normalize a MIME data type.
6807 *
6808 * <p>A normalized MIME type has white-space trimmed,
6809 * content-type parameters removed, and is lower-case.
6810 * This aligns the type with Android best practices for
6811 * intent filtering.
6812 *
6813 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6814 * "text/x-vCard" becomes "text/x-vcard".
6815 *
6816 * <p>All MIME types received from outside Android (such as user input,
6817 * or external sources like Bluetooth, NFC, or the Internet) should
6818 * be normalized before they are used to create an Intent.
6819 *
6820 * @param type MIME data type to normalize
6821 * @return normalized MIME data type, or null if the input was null
6822 * @see {@link #setType}
6823 * @see {@link #setTypeAndNormalize}
6824 */
6825 public static String normalizeMimeType(String type) {
6826 if (type == null) {
6827 return null;
6828 }
6829
6830 type = type.trim().toLowerCase(Locale.US);
6831
6832 final int semicolonIndex = type.indexOf(';');
6833 if (semicolonIndex != -1) {
6834 type = type.substring(0, semicolonIndex);
6835 }
6836 return type;
6837 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006838
6839 /**
6840 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006841 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6842 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006843 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006844 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006845 * @hide
6846 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006847 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006848 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006849 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006850
6851 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006852 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006853
6854 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006855 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006856 try {
6857 // Inspect target intent to see if we need to migrate
6858 final Intent target = getParcelableExtra(EXTRA_INTENT);
6859 if (target != null && target.migrateExtraStreamToClipData()) {
6860 // Since we migrated in child, we need to promote ClipData
6861 // and flags to ourselves to grant.
6862 setClipData(target.getClipData());
6863 addFlags(target.getFlags()
6864 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6865 return true;
6866 } else {
6867 return false;
6868 }
6869 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006870 }
6871
6872 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006873 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006874 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6875 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6876 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6877 if (stream != null || text != null || htmlText != null) {
6878 final ClipData clipData = new ClipData(
6879 null, new String[] { getType() },
6880 new ClipData.Item(text, htmlText, null, stream));
6881 setClipData(clipData);
6882 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006883 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006884 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006885 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006886 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006887
6888 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006889 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006890 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6891 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6892 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6893 int num = -1;
6894 if (streams != null) {
6895 num = streams.size();
6896 }
6897 if (texts != null) {
6898 if (num >= 0 && num != texts.size()) {
6899 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006900 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006901 }
6902 num = texts.size();
6903 }
6904 if (htmlTexts != null) {
6905 if (num >= 0 && num != htmlTexts.size()) {
6906 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006907 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006908 }
6909 num = htmlTexts.size();
6910 }
6911 if (num > 0) {
6912 final ClipData clipData = new ClipData(
6913 null, new String[] { getType() },
6914 makeClipItem(streams, texts, htmlTexts, 0));
6915
6916 for (int i = 1; i < num; i++) {
6917 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6918 }
6919
6920 setClipData(clipData);
6921 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006922 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006923 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006924 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006925 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006926 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006927
6928 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006929 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006930
6931 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6932 ArrayList<String> htmlTexts, int which) {
6933 Uri uri = streams != null ? streams.get(which) : null;
6934 CharSequence text = texts != null ? texts.get(which) : null;
6935 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6936 return new ClipData.Item(text, htmlText, null, uri);
6937 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006938}