blob: fb0b89641044ccc2119f56e74e16ff891177087b [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
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800886 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700887 * 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>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800920 * If the caller can handle multiple returned items (the user performing
921 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
922 * to indicate this.
923 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700924 * Input: {@link #getType} is the desired MIME type to retrieve. Note
925 * that no URI is supplied in the intent, as there are no constraints on
926 * where the returned data originally comes from. You may also include the
927 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800928 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800929 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
930 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700931 * <p>
932 * Output: The URI of the item that was picked. This must be a content:
933 * URI so that any receiver can access it.
934 */
935 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
936 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
937 /**
938 * Activity Action: Dial a number as specified by the data. This shows a
939 * UI with the number being dialed, allowing the user to explicitly
940 * initiate the call.
941 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
942 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
943 * number.
944 * <p>Output: nothing.
945 */
946 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
947 public static final String ACTION_DIAL = "android.intent.action.DIAL";
948 /**
949 * Activity Action: Perform a call to someone specified by the data.
950 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
951 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
952 * number.
953 * <p>Output: nothing.
954 *
955 * <p>Note: there will be restrictions on which applications can initiate a
956 * call; most applications should use the {@link #ACTION_DIAL}.
957 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
958 * numbers. Applications can <strong>dial</strong> emergency numbers using
959 * {@link #ACTION_DIAL}, however.
960 */
961 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
962 public static final String ACTION_CALL = "android.intent.action.CALL";
963 /**
964 * Activity Action: Perform a call to an emergency number specified by the
965 * data.
966 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
967 * tel: URI of an explicit phone number.
968 * <p>Output: nothing.
969 * @hide
970 */
971 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
972 /**
973 * Activity action: Perform a call to any number (emergency or not)
974 * specified by the data.
975 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
976 * tel: URI of an explicit phone number.
977 * <p>Output: nothing.
978 * @hide
979 */
980 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
981 /**
982 * Activity Action: Send a message to someone specified by the data.
983 * <p>Input: {@link #getData} is URI describing the target.
984 * <p>Output: nothing.
985 */
986 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
987 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
988 /**
989 * Activity Action: Deliver some data to someone else. Who the data is
990 * being delivered to is not specified; it is up to the receiver of this
991 * action to ask the user where the data should be sent.
992 * <p>
993 * When launching a SEND intent, you should usually wrap it in a chooser
994 * (through {@link #createChooser}), which will give the proper interface
995 * for the user to pick how to send your data and allow you to specify
996 * a prompt indicating what they are doing.
997 * <p>
998 * Input: {@link #getType} is the MIME type of the data being sent.
999 * get*Extra can have either a {@link #EXTRA_TEXT}
1000 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1001 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1002 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1003 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001004 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1005 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1006 * your text with HTML formatting.
1007 * <p>
1008 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1009 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1010 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1011 * content: URIs and other advanced features of {@link ClipData}. If
1012 * using this approach, you still must supply the same data through the
1013 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1014 * for compatibility with old applications. If you don't set a ClipData,
1015 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001016 * <p>
1017 * Optional standard extras, which may be interpreted by some recipients as
1018 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1019 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1020 * <p>
1021 * Output: nothing.
1022 */
1023 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1024 public static final String ACTION_SEND = "android.intent.action.SEND";
1025 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001026 * Activity Action: Deliver multiple data to someone else.
1027 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001028 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001029 * <p>
1030 * Input: {@link #getType} is the MIME type of the data being sent.
1031 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001032 * #EXTRA_STREAM} field, containing the data to be sent. If using
1033 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1034 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001035 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001036 * Multiple types are supported, and receivers should handle mixed types
1037 * whenever possible. The right way for the receiver to check them is to
1038 * use the content resolver on each URI. The intent sender should try to
1039 * put the most concrete mime type in the intent type, but it can fall
1040 * back to {@literal <type>/*} or {@literal *}/* as needed.
1041 * <p>
1042 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1043 * be image/jpg, but if you are sending image/jpg and image/png, then the
1044 * intent's type should be image/*.
1045 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001046 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1047 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1048 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1049 * content: URIs and other advanced features of {@link ClipData}. If
1050 * using this approach, you still must supply the same data through the
1051 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1052 * for compatibility with old applications. If you don't set a ClipData,
1053 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1054 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001055 * Optional standard extras, which may be interpreted by some recipients as
1056 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1057 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1058 * <p>
1059 * Output: nothing.
1060 */
1061 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1062 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1063 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001064 * Activity Action: Handle an incoming phone call.
1065 * <p>Input: nothing.
1066 * <p>Output: nothing.
1067 */
1068 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1069 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1070 /**
1071 * Activity Action: Insert an empty item into the given container.
1072 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1073 * in which to place the data.
1074 * <p>Output: URI of the new data that was created.
1075 */
1076 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1077 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1078 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001079 * Activity Action: Create a new item in the given container, initializing it
1080 * from the current contents of the clipboard.
1081 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1082 * in which to place the data.
1083 * <p>Output: URI of the new data that was created.
1084 */
1085 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1086 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1087 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001088 * Activity Action: Delete the given data from its container.
1089 * <p>Input: {@link #getData} is URI of data to be deleted.
1090 * <p>Output: nothing.
1091 */
1092 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1093 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1094 /**
1095 * Activity Action: Run the data, whatever that means.
1096 * <p>Input: ? (Note: this is currently specific to the test harness.)
1097 * <p>Output: nothing.
1098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_RUN = "android.intent.action.RUN";
1101 /**
1102 * Activity Action: Perform a data synchronization.
1103 * <p>Input: ?
1104 * <p>Output: ?
1105 */
1106 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1107 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1108 /**
1109 * Activity Action: Pick an activity given an intent, returning the class
1110 * selected.
1111 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1112 * used with {@link PackageManager#queryIntentActivities} to determine the
1113 * set of activities from which to pick.
1114 * <p>Output: Class name of the activity that was selected.
1115 */
1116 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1117 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1118 /**
1119 * Activity Action: Perform a search.
1120 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1121 * is the text to search for. If empty, simply
1122 * enter your search results Activity with the search UI activated.
1123 * <p>Output: nothing.
1124 */
1125 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1126 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1127 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001128 * Activity Action: Start the platform-defined tutorial
1129 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1130 * is the text to search for. If empty, simply
1131 * enter your search results Activity with the search UI activated.
1132 * <p>Output: nothing.
1133 */
1134 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1135 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1136 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001137 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001138 * <p>
1139 * Input: {@link android.app.SearchManager#QUERY
1140 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1141 * a url starts with http or https, the site will be opened. If it is plain
1142 * text, Google search will be applied.
1143 * <p>
1144 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001145 */
1146 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1147 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001148
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001149 /**
Jim Miller07994402012-05-02 14:22:27 -07001150 * Activity Action: Perform assist action.
1151 * <p>
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001152 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1153 * additional optional contextual information about where the user was when they requested
1154 * the assist.
Jim Miller07994402012-05-02 14:22:27 -07001155 * Output: nothing.
1156 */
1157 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1158 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001159
1160 /**
1161 * An optional field on {@link #ACTION_ASSIST} containing the name of the current
1162 * foreground application package at the time the assist was invoked.
1163 */
1164 public static final String EXTRA_ASSIST_PACKAGE
1165 = "android.intent.extra.ASSIST_PACKAGE";
1166
1167 /**
1168 * An optional field on {@link #ACTION_ASSIST} containing additional contextual
1169 * information supplied by the current foreground app at the time of the assist
1170 * request. This is a {@link Bundle} of additional data.
1171 */
1172 public static final String EXTRA_ASSIST_CONTEXT
1173 = "android.intent.extra.ASSIST_CONTEXT";
1174
Jim Miller07994402012-05-02 14:22:27 -07001175 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001176 * Activity Action: List all available applications
1177 * <p>Input: Nothing.
1178 * <p>Output: nothing.
1179 */
1180 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1181 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1182 /**
1183 * Activity Action: Show settings for choosing wallpaper
1184 * <p>Input: Nothing.
1185 * <p>Output: Nothing.
1186 */
1187 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1188 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1189
1190 /**
1191 * Activity Action: Show activity for reporting a bug.
1192 * <p>Input: Nothing.
1193 * <p>Output: Nothing.
1194 */
1195 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1196 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1197
1198 /**
1199 * Activity Action: Main entry point for factory tests. Only used when
1200 * the device is booting in factory test node. The implementing package
1201 * must be installed in the system image.
1202 * <p>Input: nothing
1203 * <p>Output: nothing
1204 */
1205 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1206
1207 /**
1208 * Activity Action: The user pressed the "call" button to go to the dialer
1209 * or other appropriate UI for placing a call.
1210 * <p>Input: Nothing.
1211 * <p>Output: Nothing.
1212 */
1213 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1214 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1215
1216 /**
1217 * Activity Action: Start Voice Command.
1218 * <p>Input: Nothing.
1219 * <p>Output: Nothing.
1220 */
1221 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1222 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001223
1224 /**
1225 * Activity Action: Start action associated with long pressing on the
1226 * search key.
1227 * <p>Input: Nothing.
1228 * <p>Output: Nothing.
1229 */
1230 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1231 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001232
Jacek Surazski86b6c532009-05-13 14:38:28 +02001233 /**
1234 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1235 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001236 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001237 * <p>Input: No data is specified. The bug report is passed in using
1238 * an {@link #EXTRA_BUG_REPORT} field.
1239 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001240 *
1241 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001242 */
1243 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1244 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001245
1246 /**
1247 * Activity Action: Show power usage information to the user.
1248 * <p>Input: Nothing.
1249 * <p>Output: Nothing.
1250 */
1251 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1252 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001253
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001254 /**
1255 * Activity Action: Setup wizard to launch after a platform update. This
1256 * activity should have a string meta-data field associated with it,
1257 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1258 * the platform for setup. The activity will be launched only if
1259 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1260 * same value.
1261 * <p>Input: Nothing.
1262 * <p>Output: Nothing.
1263 * @hide
1264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001267
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001268 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001269 * Activity Action: Show settings for managing network data usage of a
1270 * specific application. Applications should define an activity that offers
1271 * options to control data usage.
1272 */
1273 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1274 public static final String ACTION_MANAGE_NETWORK_USAGE =
1275 "android.intent.action.MANAGE_NETWORK_USAGE";
1276
1277 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001278 * Activity Action: Launch application installer.
1279 * <p>
1280 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001281 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1282 * you can also use "package:<package-name>" to install an application for the
1283 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001284 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1285 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1286 * <p>
1287 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1288 * succeeded.
1289 *
1290 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1291 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1292 * @see #EXTRA_RETURN_RESULT
1293 */
1294 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1295 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1296
1297 /**
1298 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1299 * package. Specifies the installer package name; this package will receive the
1300 * {@link #ACTION_APP_ERROR} intent.
1301 */
1302 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1303 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1304
1305 /**
1306 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1307 * package. Specifies that the application being installed should not be
1308 * treated as coming from an unknown source, but as coming from the app
1309 * invoking the Intent. For this to work you must start the installer with
1310 * startActivityForResult().
1311 */
1312 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1313 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1314
1315 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001316 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1317 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001318 * data field originated from.
1319 */
rich cannings706e8ba2012-08-20 13:20:14 -07001320 public static final String EXTRA_ORIGINATING_URI
1321 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001322
1323 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001324 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1325 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1326 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001327 */
1328 public static final String EXTRA_REFERRER
1329 = "android.intent.extra.REFERRER";
1330
1331 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001332 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1333 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1334 * @hide
1335 */
1336 public static final String EXTRA_ORIGINATING_UID
1337 = "android.intent.extra.ORIGINATING_UID";
1338
1339 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001340 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1341 * package. Tells the installer UI to skip the confirmation with the user
1342 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001343 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1344 * will no longer show an interstitial message about updating existing
1345 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001346 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001347 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001348 public static final String EXTRA_ALLOW_REPLACE
1349 = "android.intent.extra.ALLOW_REPLACE";
1350
1351 /**
1352 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1353 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1354 * return to the application the result code of the install/uninstall. The returned result
1355 * code will be {@link android.app.Activity#RESULT_OK} on success or
1356 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1357 */
1358 public static final String EXTRA_RETURN_RESULT
1359 = "android.intent.extra.RETURN_RESULT";
1360
1361 /**
1362 * Package manager install result code. @hide because result codes are not
1363 * yet ready to be exposed.
1364 */
1365 public static final String EXTRA_INSTALL_RESULT
1366 = "android.intent.extra.INSTALL_RESULT";
1367
1368 /**
1369 * Activity Action: Launch application uninstaller.
1370 * <p>
1371 * Input: The data must be a package: URI whose scheme specific part is
1372 * the package name of the current installed package to be uninstalled.
1373 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1374 * <p>
1375 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1376 * succeeded.
1377 */
1378 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1379 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1380
1381 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001382 * Specify whether the package should be uninstalled for all users.
1383 * @hide because these should not be part of normal application flow.
1384 */
1385 public static final String EXTRA_UNINSTALL_ALL_USERS
1386 = "android.intent.extra.UNINSTALL_ALL_USERS";
1387
1388 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001389 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1390 * describing the last run version of the platform that was setup.
1391 * @hide
1392 */
1393 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1394
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001395 // ---------------------------------------------------------------------
1396 // ---------------------------------------------------------------------
1397 // Standard intent broadcast actions (see action variable).
1398
1399 /**
1400 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001401 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001402 * <p class="note">This is a protected intent that can only be sent
1403 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001404 */
1405 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1406 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1407 /**
1408 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001409 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001410 * <p class="note">This is a protected intent that can only be sent
1411 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001412 */
1413 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1414 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001415
1416 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001417 * Broadcast Action: Sent after the system stops dreaming.
1418 *
1419 * <p class="note">This is a protected intent that can only be sent by the system.
1420 * It is only sent to registered receivers.</p>
1421 */
1422 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1423 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1424
1425 /**
1426 * Broadcast Action: Sent after the system starts dreaming.
1427 *
1428 * <p class="note">This is a protected intent that can only be sent by the system.
1429 * It is only sent to registered receivers.</p>
1430 */
1431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1432 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1433
1434 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001435 * 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 -07001436 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001437 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001438 * <p class="note">This is a protected intent that can only be sent
1439 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001440 */
1441 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001442 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001443
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001444 /**
1445 * Broadcast Action: The current time has changed. Sent every
1446 * minute. You can <em>not</em> receive this through components declared
1447 * in manifests, only by exlicitly registering for it with
1448 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1449 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001450 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001451 * <p class="note">This is a protected intent that can only be sent
1452 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001453 */
1454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1455 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1456 /**
1457 * Broadcast Action: The time was set.
1458 */
1459 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1460 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1461 /**
1462 * Broadcast Action: The date has changed.
1463 */
1464 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1465 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1466 /**
1467 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1468 * <ul>
1469 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1470 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001471 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001472 * <p class="note">This is a protected intent that can only be sent
1473 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001474 */
1475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1476 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1477 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001478 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1479 * DNS entries should be tossed.
1480 * @hide
1481 */
1482 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1483 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1484 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001485 * Alarm Changed Action: This is broadcast when the AlarmClock
1486 * application's alarm is set or unset. It is used by the
1487 * AlarmClock application and the StatusBar service.
1488 * @hide
1489 */
1490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1491 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1492 /**
1493 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1494 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1495 * @hide
1496 */
1497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1498 public static final String ACTION_SYNC_STATE_CHANGED
1499 = "android.intent.action.SYNC_STATE_CHANGED";
1500 /**
1501 * Broadcast Action: This is broadcast once, after the system has finished
1502 * booting. It can be used to perform application-specific initialization,
1503 * such as installing alarms. You must hold the
1504 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1505 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001506 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001507 * <p class="note">This is a protected intent that can only be sent
1508 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001509 */
1510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1511 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1512 /**
1513 * Broadcast Action: This is broadcast when a user action should request a
1514 * temporary system dialog to dismiss. Some examples of temporary system
1515 * dialogs are the notification window-shade and the recent tasks dialog.
1516 */
1517 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1518 /**
1519 * Broadcast Action: Trigger the download and eventual installation
1520 * of a package.
1521 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001522 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001523 * <p class="note">This is a protected intent that can only be sent
1524 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001525 *
1526 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001527 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001528 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1530 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1531 /**
1532 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001533 * device. The data contains the name of the package. Note that the
1534 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001535 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001536 * <ul>
1537 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1538 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1539 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1540 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001541 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001542 * <p class="note">This is a protected intent that can only be sent
1543 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001544 */
1545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1546 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1547 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001548 * Broadcast Action: A new version of an application package has been
1549 * installed, replacing an existing version that was previously installed.
1550 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001551 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001552 * <ul>
1553 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1554 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001555 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001556 * <p class="note">This is a protected intent that can only be sent
1557 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001558 */
1559 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1560 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1561 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001562 * Broadcast Action: A new version of your application has been installed
1563 * over an existing one. This is only sent to the application that was
1564 * replaced. It does not contain any additional data; to receive it, just
1565 * use an intent filter for this action.
1566 *
1567 * <p class="note">This is a protected intent that can only be sent
1568 * by the system.
1569 */
1570 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1571 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1572 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001573 * Broadcast Action: An existing application package has been removed from
1574 * the device. The data contains the name of the package. The package
1575 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001576 * <ul>
1577 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1578 * to the package.
1579 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1580 * application -- data and code -- is being removed.
1581 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1582 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1583 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001584 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001585 * <p class="note">This is a protected intent that can only be sent
1586 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001587 */
1588 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1589 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1590 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001591 * Broadcast Action: An existing application package has been completely
1592 * removed from the device. The data contains the name of the package.
1593 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1594 * {@link #EXTRA_DATA_REMOVED} is true and
1595 * {@link #EXTRA_REPLACING} is false of that broadcast.
1596 *
1597 * <ul>
1598 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1599 * to the package.
1600 * </ul>
1601 *
1602 * <p class="note">This is a protected intent that can only be sent
1603 * by the system.
1604 */
1605 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1606 public static final String ACTION_PACKAGE_FULLY_REMOVED
1607 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1608 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001609 * Broadcast Action: An existing application package has been changed (e.g.
1610 * a component has been enabled or disabled). The data contains the name of
1611 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001612 * <ul>
1613 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001614 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001615 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001616 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1617 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001618 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001619 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001620 * <p class="note">This is a protected intent that can only be sent
1621 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001622 */
1623 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1624 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1625 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001626 * @hide
1627 * Broadcast Action: Ask system services if there is any reason to
1628 * restart the given package. The data contains the name of the
1629 * package.
1630 * <ul>
1631 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1632 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1633 * </ul>
1634 *
1635 * <p class="note">This is a protected intent that can only be sent
1636 * by the system.
1637 */
1638 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1639 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1640 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001641 * Broadcast Action: The user has restarted a package, and all of its
1642 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001643 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001644 * be removed. Note that the restarted package does <em>not</em>
1645 * receive this broadcast.
1646 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001647 * <ul>
1648 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1649 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001650 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001651 * <p class="note">This is a protected intent that can only be sent
1652 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001653 */
1654 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1655 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1656 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001657 * Broadcast Action: The user has cleared the data of a package. This should
1658 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001659 * its persistent data is erased and this broadcast sent.
1660 * Note that the cleared package does <em>not</em>
1661 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001662 * <ul>
1663 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1664 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001665 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001666 * <p class="note">This is a protected intent that can only be sent
1667 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001668 */
1669 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1670 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1671 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001672 * Broadcast Action: A user ID has been removed from the system. The user
1673 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001674 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001675 * <p class="note">This is a protected intent that can only be sent
1676 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001677 */
1678 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1679 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001680
1681 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001682 * Broadcast Action: Sent to the installer package of an application
1683 * when that application is first launched (that is the first time it
1684 * is moved out of the stopped state). The data contains the name of the package.
1685 *
1686 * <p class="note">This is a protected intent that can only be sent
1687 * by the system.
1688 */
1689 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1690 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1691
1692 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001693 * Broadcast Action: Sent to the system package verifier when a package
1694 * needs to be verified. The data contains the package URI.
1695 * <p class="note">
1696 * This is a protected intent that can only be sent by the system.
1697 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001698 */
1699 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1700 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1701
1702 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001703 * Broadcast Action: Sent to the system package verifier when a package is
1704 * verified. The data contains the package URI.
1705 * <p class="note">
1706 * This is a protected intent that can only be sent by the system.
1707 */
1708 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1709 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1710
1711 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001712 * Broadcast Action: Resources for a set of packages (which were
1713 * previously unavailable) are currently
1714 * available since the media on which they exist is available.
1715 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1716 * list of packages whose availability changed.
1717 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1718 * list of uids of packages whose availability changed.
1719 * Note that the
1720 * packages in this list do <em>not</em> receive this broadcast.
1721 * The specified set of packages are now available on the system.
1722 * <p>Includes the following extras:
1723 * <ul>
1724 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1725 * whose resources(were previously unavailable) are currently available.
1726 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1727 * packages whose resources(were previously unavailable)
1728 * are currently available.
1729 * </ul>
1730 *
1731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001733 */
1734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001735 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1736 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001737
1738 /**
1739 * Broadcast Action: Resources for a set of packages are currently
1740 * unavailable since the media on which they exist is unavailable.
1741 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1742 * list of packages whose availability changed.
1743 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1744 * list of uids of packages whose availability changed.
1745 * The specified set of packages can no longer be
1746 * launched and are practically unavailable on the system.
1747 * <p>Inclues the following extras:
1748 * <ul>
1749 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1750 * whose resources are no longer available.
1751 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1752 * whose resources are no longer available.
1753 * </ul>
1754 *
1755 * <p class="note">This is a protected intent that can only be sent
1756 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001757 */
1758 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001759 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001760 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001761
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001762 /**
1763 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001764 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001765 * This should <em>only</em> be used to determine when the wallpaper
1766 * has changed to show the new wallpaper to the user. You should certainly
1767 * never, in response to this, change the wallpaper or other attributes of
1768 * it such as the suggested size. That would be crazy, right? You'd cause
1769 * all kinds of loops, especially if other apps are doing similar things,
1770 * right? Of course. So please don't do this.
1771 *
1772 * @deprecated Modern applications should use
1773 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1774 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1775 * shown behind their UI, rather than watching for this broadcast and
1776 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001777 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001778 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001779 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1780 /**
1781 * Broadcast Action: The current device {@link android.content.res.Configuration}
1782 * (orientation, locale, etc) has changed. When such a change happens, the
1783 * UIs (view hierarchy) will need to be rebuilt based on this new
1784 * information; for the most part, applications don't need to worry about
1785 * this, because the system will take care of stopping and restarting the
1786 * application to make sure it sees the new changes. Some system code that
1787 * can not be restarted will need to watch for this action and handle it
1788 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001789 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001790 * <p class="note">
1791 * You can <em>not</em> receive this through components declared
1792 * in manifests, only by explicitly registering for it with
1793 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1794 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001795 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001796 * <p class="note">This is a protected intent that can only be sent
1797 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001798 *
1799 * @see android.content.res.Configuration
1800 */
1801 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1802 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1803 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001804 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001805 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001806 * <p class="note">This is a protected intent that can only be sent
1807 * by the system.
1808 */
1809 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1810 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1811 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001812 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1813 * charging state, level, and other information about the battery.
1814 * See {@link android.os.BatteryManager} for documentation on the
1815 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001816 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001817 * <p class="note">
1818 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001819 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001820 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001821 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1822 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1823 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1824 * broadcasts that are sent and can be received through manifest
1825 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001826 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001827 * <p class="note">This is a protected intent that can only be sent
1828 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001829 */
1830 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1831 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1832 /**
1833 * Broadcast Action: Indicates low battery condition on the device.
1834 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001835 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001836 * <p class="note">This is a protected intent that can only be sent
1837 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001838 */
1839 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1840 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1841 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001842 * Broadcast Action: Indicates the battery is now okay after being low.
1843 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1844 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001845 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001846 * <p class="note">This is a protected intent that can only be sent
1847 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001848 */
1849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1850 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1851 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001852 * Broadcast Action: External power has been connected to the device.
1853 * This is intended for applications that wish to register specifically to this notification.
1854 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1855 * stay active to receive this notification. This action can be used to implement actions
1856 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001857 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001858 * <p class="note">This is a protected intent that can only be sent
1859 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001860 */
1861 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001862 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001863 /**
1864 * Broadcast Action: External power has been removed from the device.
1865 * This is intended for applications that wish to register specifically to this notification.
1866 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1867 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001868 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001869 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001870 * <p class="note">This is a protected intent that can only be sent
1871 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001872 */
1873 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001874 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001875 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001876 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001877 * Broadcast Action: Device is shutting down.
1878 * This is broadcast when the device is being shut down (completely turned
1879 * off, not sleeping). Once the broadcast is complete, the final shutdown
1880 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001881 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001882 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001883 * <p class="note">This is a protected intent that can only be sent
1884 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001885 */
1886 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001887 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001888 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001889 * Activity Action: Start this activity to request system shutdown.
1890 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1891 * to request confirmation from the user before shutting down.
1892 *
1893 * <p class="note">This is a protected intent that can only be sent
1894 * by the system.
1895 *
1896 * {@hide}
1897 */
1898 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1899 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001900 * Broadcast Action: A sticky broadcast that indicates low memory
1901 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001902 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001903 * <p class="note">This is a protected intent that can only be sent
1904 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001905 */
1906 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1907 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1908 /**
1909 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001910 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001911 * <p class="note">This is a protected intent that can only be sent
1912 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001913 */
1914 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1915 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1916 /**
Jake Hambybb371632010-08-23 18:16:48 -07001917 * Broadcast Action: A sticky broadcast that indicates a memory full
1918 * condition on the device. This is intended for activities that want
1919 * to be able to fill the data partition completely, leaving only
1920 * enough free space to prevent system-wide SQLite failures.
1921 *
1922 * <p class="note">This is a protected intent that can only be sent
1923 * by the system.
1924 *
1925 * {@hide}
1926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1929 /**
1930 * Broadcast Action: Indicates memory full condition on the device
1931 * no longer exists.
1932 *
1933 * <p class="note">This is a protected intent that can only be sent
1934 * by the system.
1935 *
1936 * {@hide}
1937 */
1938 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1939 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1940 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001941 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1942 * and package management should be started.
1943 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1944 * notification.
1945 */
1946 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1947 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1948 /**
1949 * Broadcast Action: The device has entered USB Mass Storage mode.
1950 * This is used mainly for the USB Settings panel.
1951 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1952 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001953 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001954 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001955 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001956 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1957
1958 /**
1959 * Broadcast Action: The device has exited USB Mass Storage mode.
1960 * This is used mainly for the USB Settings panel.
1961 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1962 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001963 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001964 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001965 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001966 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1967
1968 /**
1969 * Broadcast Action: External media has been removed.
1970 * The path to the mount point for the removed media is contained in the Intent.mData field.
1971 */
1972 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1973 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1974
1975 /**
1976 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001977 * 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 -07001978 */
1979 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1980 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1981
1982 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001983 * Broadcast Action: External media is present, and being disk-checked
1984 * 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 -08001985 */
1986 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1987 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1988
1989 /**
1990 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1991 * 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 -08001992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1995
1996 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001997 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001998 * 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 -07001999 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2000 * media was mounted read only.
2001 */
2002 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2003 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2004
2005 /**
2006 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002007 * 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 -07002008 */
2009 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2010 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2011
2012 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002013 * Broadcast Action: External media is no longer being shared via USB mass storage.
2014 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2015 *
2016 * @hide
2017 */
2018 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2019
2020 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002021 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2022 * The path to the mount point for the removed media is contained in the Intent.mData field.
2023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2026
2027 /**
2028 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002029 * 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 -07002030 */
2031 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2032 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2033
2034 /**
2035 * Broadcast Action: User has expressed the desire to remove the external storage media.
2036 * Applications should close all files they have open within the mount point when they receive this intent.
2037 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2038 */
2039 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2040 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2041
2042 /**
2043 * Broadcast Action: The media scanner has started scanning a directory.
2044 * The path to the directory being scanned is contained in the Intent.mData field.
2045 */
2046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2047 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2048
2049 /**
2050 * Broadcast Action: The media scanner has finished scanning a directory.
2051 * The path to the scanned directory is contained in the Intent.mData field.
2052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2055
2056 /**
2057 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2058 * The path to the file is contained in the Intent.mData field.
2059 */
2060 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2061 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2062
2063 /**
2064 * Broadcast Action: The "Media Button" was pressed. Includes a single
2065 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2066 * caused the broadcast.
2067 */
2068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2070
2071 /**
2072 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2073 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2074 * caused the broadcast.
2075 */
2076 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2077 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2078
2079 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2080 // location; they are not general-purpose actions.
2081
2082 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002083 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002084 */
2085 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2086 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2087 "android.intent.action.GTALK_CONNECTED";
2088
2089 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002090 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002091 */
2092 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2093 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2094 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002095
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002096 /**
2097 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_INPUT_METHOD_CHANGED =
2101 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002102
2103 /**
2104 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2105 * more radios have been turned off or on. The intent will have the following extra value:</p>
2106 * <ul>
2107 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2108 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2109 * turned off</li>
2110 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002111 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002112 * <p class="note">This is a protected intent that can only be sent
2113 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002114 */
2115 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2116 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2117
2118 /**
2119 * Broadcast Action: Some content providers have parts of their namespace
2120 * where they publish new events or items that the user may be especially
2121 * interested in. For these things, they may broadcast this action when the
2122 * set of interesting items change.
2123 *
2124 * For example, GmailProvider sends this notification when the set of unread
2125 * mail in the inbox changes.
2126 *
2127 * <p>The data of the intent identifies which part of which provider
2128 * changed. When queried through the content resolver, the data URI will
2129 * return the data set in question.
2130 *
2131 * <p>The intent will have the following extra values:
2132 * <ul>
2133 * <li><em>count</em> - The number of items in the data set. This is the
2134 * same as the number of items in the cursor returned by querying the
2135 * data URI. </li>
2136 * </ul>
2137 *
2138 * This intent will be sent at boot (if the count is non-zero) and when the
2139 * data set changes. It is possible for the data set to change without the
2140 * count changing (for example, if a new unread message arrives in the same
2141 * sync operation in which a message is archived). The phone should still
2142 * ring/vibrate/etc as normal in this case.
2143 */
2144 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2145 public static final String ACTION_PROVIDER_CHANGED =
2146 "android.intent.action.PROVIDER_CHANGED";
2147
2148 /**
2149 * Broadcast Action: Wired Headset plugged in or unplugged.
2150 *
2151 * <p>The intent will have the following extra values:
2152 * <ul>
2153 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2154 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002155 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002156 * </ul>
2157 * </ul>
2158 */
2159 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2160 public static final String ACTION_HEADSET_PLUG =
2161 "android.intent.action.HEADSET_PLUG";
2162
2163 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002164 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2165 *
2166 * <p>The intent will have the following extra values:
2167 * <ul>
2168 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2169 * <li><em>name</em> - Headset type, human readable string </li>
2170 * </ul>
2171 * </ul>
2172 * @hide
2173 */
2174 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002175 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2176 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002177
2178 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002179 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002180 *
2181 * <p>The intent will have the following extra values:
2182 * <ul>
2183 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2184 * <li><em>name</em> - Headset type, human readable string </li>
2185 * </ul>
2186 * </ul>
2187 * @hide
2188 */
2189 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002190 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2191 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002192
2193 /**
2194 * Broadcast Action: A HMDI cable was plugged or unplugged
2195 *
2196 * <p>The intent will have the following extra values:
2197 * <ul>
2198 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2199 * <li><em>name</em> - HDMI cable, human readable string </li>
2200 * </ul>
2201 * </ul>
2202 * @hide
2203 */
2204 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2205 public static final String ACTION_HDMI_AUDIO_PLUG =
2206 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002207
2208 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002209 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2210 *
2211 * <p>The intent will have the following extra values:
2212 * <ul>
2213 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2214 * <li><em>card</em> - ALSA card number (integer) </li>
2215 * <li><em>device</em> - ALSA device number (integer) </li>
2216 * </ul>
2217 * </ul>
2218 * @hide
2219 */
2220 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2221 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2222 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2223
2224 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002225 * Broadcast Action: A USB audio device was plugged in or unplugged.
2226 *
2227 * <p>The intent will have the following extra values:
2228 * <ul>
2229 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2230 * <li><em>card</em> - ALSA card number (integer) </li>
2231 * <li><em>device</em> - ALSA device number (integer) </li>
2232 * </ul>
2233 * </ul>
2234 * @hide
2235 */
2236 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2237 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2238 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2239
2240 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002241 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2242 * <ul>
2243 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2244 * </ul>
2245 *
2246 * <p class="note">This is a protected intent that can only be sent
2247 * by the system.
2248 *
2249 * @hide
2250 */
2251 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2252 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2253 = "android.intent.action.ADVANCED_SETTINGS";
2254
2255 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002256 * Broadcast Action: An outgoing call is about to be placed.
2257 *
2258 * <p>The Intent will have the following extra value:
2259 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002260 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002261 * the phone number originally intended to be dialed.</li>
2262 * </ul>
2263 * <p>Once the broadcast is finished, the resultData is used as the actual
2264 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002265 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002266 * outgoing call in turn: for example, a parental control application
2267 * might verify that the user is authorized to place the call at that
2268 * time, then a number-rewriting application might add an area code if
2269 * one was not specified.</p>
2270 * <p>For consistency, any receiver whose purpose is to prohibit phone
2271 * calls should have a priority of 0, to ensure it will see the final
2272 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002273 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002274 * should have a positive priority.
2275 * Negative priorities are reserved for the system for this broadcast;
2276 * using them may cause problems.</p>
2277 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2278 * abort the broadcast.</p>
2279 * <p>Emergency calls cannot be intercepted using this mechanism, and
2280 * other calls cannot be modified to call emergency numbers using this
2281 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002282 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002283 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2284 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002285 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002286 * <p class="note">This is a protected intent that can only be sent
2287 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288 */
2289 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2290 public static final String ACTION_NEW_OUTGOING_CALL =
2291 "android.intent.action.NEW_OUTGOING_CALL";
2292
2293 /**
2294 * Broadcast Action: Have the device reboot. This is only for use by
2295 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002296 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002297 * <p class="note">This is a protected intent that can only be sent
2298 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002299 */
2300 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2301 public static final String ACTION_REBOOT =
2302 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002303
Wei Huang97ecc9c2009-05-11 17:44:20 -07002304 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002305 * Broadcast Action: A sticky broadcast for changes in the physical
2306 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002307 *
2308 * <p>The intent will have the following extra values:
2309 * <ul>
2310 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002311 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002312 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002313 * <p>This is intended for monitoring the current physical dock state.
2314 * See {@link android.app.UiModeManager} for the normal API dealing with
2315 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002316 */
2317 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2318 public static final String ACTION_DOCK_EVENT =
2319 "android.intent.action.DOCK_EVENT";
2320
2321 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002322 * Broadcast Action: a remote intent is to be broadcasted.
2323 *
2324 * A remote intent is used for remote RPC between devices. The remote intent
2325 * is serialized and sent from one device to another device. The receiving
2326 * device parses the remote intent and broadcasts it. Note that anyone can
2327 * broadcast a remote intent. However, if the intent receiver of the remote intent
2328 * does not trust intent broadcasts from arbitrary intent senders, it should require
2329 * the sender to hold certain permissions so only trusted sender's broadcast will be
2330 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002331 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002332 */
2333 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002334 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002335
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002336 /**
2337 * Broadcast Action: hook for permforming cleanup after a system update.
2338 *
2339 * The broadcast is sent when the system is booting, before the
2340 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2341 * image. A receiver for this should do its work and then disable itself
2342 * so that it does not get run again at the next boot.
2343 * @hide
2344 */
2345 public static final String ACTION_PRE_BOOT_COMPLETED =
2346 "android.intent.action.PRE_BOOT_COMPLETED";
2347
Amith Yamasani13593602012-03-22 16:16:17 -07002348 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002349 * Sent the first time a user is starting, to allow system apps to
2350 * perform one time initialization. (This will not be seen by third
2351 * party applications because a newly initialized user does not have any
2352 * third party applications installed for it.) This is sent early in
2353 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002354 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2355 * broadcast, since it is part of a visible user interaction; be as quick
2356 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002357 */
2358 public static final String ACTION_USER_INITIALIZE =
2359 "android.intent.action.USER_INITIALIZE";
2360
2361 /**
2362 * Sent when a user switch is happening, causing the process's user to be
2363 * brought to the foreground. This is only sent to receivers registered
2364 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2365 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002366 * foreground. This is sent as a foreground
2367 * broadcast, since it is part of a visible user interaction; be as quick
2368 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002369 */
2370 public static final String ACTION_USER_FOREGROUND =
2371 "android.intent.action.USER_FOREGROUND";
2372
2373 /**
2374 * Sent when a user switch is happening, causing the process's user to be
2375 * sent to the background. This is only sent to receivers registered
2376 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2377 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002378 * background. This is sent as a foreground
2379 * broadcast, since it is part of a visible user interaction; be as quick
2380 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002381 */
2382 public static final String ACTION_USER_BACKGROUND =
2383 "android.intent.action.USER_BACKGROUND";
2384
2385 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002386 * Broadcast sent to the system when a user is added. Carries an extra
2387 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2388 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002389 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002390 * @hide
2391 */
2392 public static final String ACTION_USER_ADDED =
2393 "android.intent.action.USER_ADDED";
2394
2395 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002396 * Broadcast sent by the system when a user is started. Carries an extra
2397 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002398 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002399 * that has been started. This is sent as a foreground
2400 * broadcast, since it is part of a visible user interaction; be as quick
2401 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002402 * @hide
2403 */
2404 public static final String ACTION_USER_STARTED =
2405 "android.intent.action.USER_STARTED";
2406
2407 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002408 * Broadcast sent when a user is in the process of starting. Carries an extra
2409 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2410 * sent to registered receivers, not manifest receivers. It is sent to all
2411 * users (including the one that is being started). You must hold
2412 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2413 * this broadcast. This is sent as a background broadcast, since
2414 * its result is not part of the primary UX flow; to safely keep track of
2415 * started/stopped state of a user you can use this in conjunction with
2416 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2417 * other user state broadcasts since those are foreground broadcasts so can
2418 * execute in a different order.
2419 * @hide
2420 */
2421 public static final String ACTION_USER_STARTING =
2422 "android.intent.action.USER_STARTING";
2423
2424 /**
2425 * Broadcast sent when a user is going to be stopped. Carries an extra
2426 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2427 * sent to registered receivers, not manifest receivers. It is sent to all
2428 * users (including the one that is being stopped). You must hold
2429 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2430 * this broadcast. The user will not stop until all receivers have
2431 * handled the broadcast. This is sent as a background broadcast, since
2432 * its result is not part of the primary UX flow; to safely keep track of
2433 * started/stopped state of a user you can use this in conjunction with
2434 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2435 * other user state broadcasts since those are foreground broadcasts so can
2436 * execute in a different order.
2437 * @hide
2438 */
2439 public static final String ACTION_USER_STOPPING =
2440 "android.intent.action.USER_STOPPING";
2441
2442 /**
2443 * Broadcast sent to the system when a user is stopped. Carries an extra
2444 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2445 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2446 * specific package. This is only sent to registered receivers, not manifest
2447 * receivers. It is sent to all running users <em>except</em> the one that
2448 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002449 * @hide
2450 */
2451 public static final String ACTION_USER_STOPPED =
2452 "android.intent.action.USER_STOPPED";
2453
2454 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002455 * 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 -07002456 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002457 * one that has been removed. The user will not be completely removed until all receivers have
2458 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002459 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002460 * @hide
2461 */
2462 public static final String ACTION_USER_REMOVED =
2463 "android.intent.action.USER_REMOVED";
2464
2465 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002466 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002467 * the userHandle of the user to become the current one. This is only sent to
2468 * registered receivers, not manifest receivers. It is sent to all running users.
2469 * You must hold
2470 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002471 * @hide
2472 */
2473 public static final String ACTION_USER_SWITCHED =
2474 "android.intent.action.USER_SWITCHED";
2475
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002476 /**
2477 * Broadcast sent to the system when a user's information changes. Carries an extra
2478 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2479 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2480 * whose information has changed.
2481 * @hide
2482 */
2483 public static final String ACTION_USER_INFO_CHANGED =
2484 "android.intent.action.USER_INFO_CHANGED";
2485
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002486 /**
2487 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2488 */
2489 public static final String ACTION_QUICK_CLOCK =
2490 "android.intent.action.QUICK_CLOCK";
2491
Michael Wright0087a142013-02-05 16:29:39 -08002492 /**
2493 * Broadcast Action: This is broadcast when a user action should request the
2494 * brightness setting dialog.
2495 * @hide
2496 */
2497 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2498 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2499
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002500 // ---------------------------------------------------------------------
2501 // ---------------------------------------------------------------------
2502 // Standard intent categories (see addCategory()).
2503
2504 /**
2505 * Set if the activity should be an option for the default action
2506 * (center press) to perform on a piece of data. Setting this will
2507 * hide from the user any activities without it set when performing an
2508 * action on some data. Note that this is normal -not- set in the
2509 * Intent when initiating an action -- it is for use in intent filters
2510 * specified in packages.
2511 */
2512 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2513 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2514 /**
2515 * Activities that can be safely invoked from a browser must support this
2516 * category. For example, if the user is viewing a web page or an e-mail
2517 * and clicks on a link in the text, the Intent generated execute that
2518 * link will require the BROWSABLE category, so that only activities
2519 * supporting this category will be considered as possible actions. By
2520 * supporting this category, you are promising that there is nothing
2521 * damaging (without user intervention) that can happen by invoking any
2522 * matching Intent.
2523 */
2524 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2525 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2526 /**
2527 * Set if the activity should be considered as an alternative action to
2528 * the data the user is currently viewing. See also
2529 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2530 * applies to the selection in a list of items.
2531 *
2532 * <p>Supporting this category means that you would like your activity to be
2533 * displayed in the set of alternative things the user can do, usually as
2534 * part of the current activity's options menu. You will usually want to
2535 * include a specific label in the &lt;intent-filter&gt; of this action
2536 * describing to the user what it does.
2537 *
2538 * <p>The action of IntentFilter with this category is important in that it
2539 * describes the specific action the target will perform. This generally
2540 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2541 * a specific name such as "com.android.camera.action.CROP. Only one
2542 * alternative of any particular action will be shown to the user, so using
2543 * a specific action like this makes sure that your alternative will be
2544 * displayed while also allowing other applications to provide their own
2545 * overrides of that particular action.
2546 */
2547 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2548 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2549 /**
2550 * Set if the activity should be considered as an alternative selection
2551 * action to the data the user has currently selected. This is like
2552 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2553 * of items from which the user can select, giving them alternatives to the
2554 * default action that will be performed on it.
2555 */
2556 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2557 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2558 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002559 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002560 */
2561 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2562 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2563 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002564 * Should be displayed in the top-level launcher.
2565 */
2566 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2567 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2568 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002569 * Provides information about the package it is in; typically used if
2570 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2571 * a front-door to the user without having to be shown in the all apps list.
2572 */
2573 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2574 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2575 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002576 * This is the home activity, that is the first activity that is displayed
2577 * when the device boots.
2578 */
2579 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2580 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2581 /**
2582 * This activity is a preference panel.
2583 */
2584 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2585 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2586 /**
2587 * This activity is a development preference panel.
2588 */
2589 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2590 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2591 /**
2592 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002593 */
2594 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2595 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2596 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002597 * This activity allows the user to browse and download new applications.
2598 */
2599 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2600 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2601 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002602 * This activity may be exercised by the monkey or other automated test tools.
2603 */
2604 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2605 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2606 /**
2607 * To be used as a test (not part of the normal user experience).
2608 */
2609 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2610 /**
2611 * To be used as a unit test (run through the Test Harness).
2612 */
2613 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2614 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002615 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002616 * experience).
2617 */
2618 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2619 /**
2620 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2621 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2622 * when queried, though it is allowable for those columns to be blank.
2623 */
2624 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2625 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2626
2627 /**
2628 * To be used as code under test for framework instrumentation tests.
2629 */
2630 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2631 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002632 /**
2633 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002634 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2635 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002636 */
2637 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2638 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2639 /**
2640 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002641 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2642 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002643 */
2644 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2645 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002646 /**
2647 * An activity to run when device is inserted into a analog (low end) dock.
2648 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2649 * information, see {@link android.app.UiModeManager}.
2650 */
2651 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2652 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2653
2654 /**
2655 * An activity to run when device is inserted into a digital (high end) dock.
2656 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2657 * information, see {@link android.app.UiModeManager}.
2658 */
2659 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2660 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002661
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002662 /**
2663 * Used to indicate that the activity can be used in a car environment.
2664 */
2665 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2666 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2667
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002668 // ---------------------------------------------------------------------
2669 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002670 // Application launch intent categories (see addCategory()).
2671
2672 /**
2673 * Used with {@link #ACTION_MAIN} to launch the browser application.
2674 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002675 * <p>NOTE: This should not be used as the primary key of an Intent,
2676 * since it will not result in the app launching with the correct
2677 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002678 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002679 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002680 */
2681 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2682 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2683
2684 /**
2685 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2686 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002687 * <p>NOTE: This should not be used as the primary key of an Intent,
2688 * since it will not result in the app launching with the correct
2689 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002690 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002691 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002692 */
2693 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2694 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2695
2696 /**
2697 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2698 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002699 * <p>NOTE: This should not be used as the primary key of an Intent,
2700 * since it will not result in the app launching with the correct
2701 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002702 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002703 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002704 */
2705 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2706 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2707
2708 /**
2709 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2710 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002711 * <p>NOTE: This should not be used as the primary key of an Intent,
2712 * since it will not result in the app launching with the correct
2713 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002714 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002715 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002716 */
2717 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2718 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2719
2720 /**
2721 * Used with {@link #ACTION_MAIN} to launch the email application.
2722 * The activity should be able to send and receive email.
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_EMAIL = "android.intent.category.APP_EMAIL";
2731
2732 /**
2733 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2734 * The activity should be able to view and manipulate image and video files
2735 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002736 * <p>NOTE: This should not be used as the primary key of an Intent,
2737 * since it will not result in the app launching with the correct
2738 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002739 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002740 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002741 */
2742 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2743 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2744
2745 /**
2746 * Used with {@link #ACTION_MAIN} to launch the maps application.
2747 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002748 * <p>NOTE: This should not be used as the primary key of an Intent,
2749 * since it will not result in the app launching with the correct
2750 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002751 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002752 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002753 */
2754 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2755 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2756
2757 /**
2758 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2759 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002760 * <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_MESSAGING = "android.intent.category.APP_MESSAGING";
2768
2769 /**
2770 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002771 * The activity should be able to play, browse, or manipulate music files
2772 * stored on the device.
2773 * <p>NOTE: This should not be used as the primary key of an Intent,
2774 * since it will not result in the app launching with the correct
2775 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002776 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002777 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002778 */
2779 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2780 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2781
2782 // ---------------------------------------------------------------------
2783 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002784 // Standard extra data keys.
2785
2786 /**
2787 * The initial data to place in a newly created record. Use with
2788 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2789 * fields as would be given to the underlying ContentProvider.insert()
2790 * call.
2791 */
2792 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2793
2794 /**
2795 * A constant CharSequence that is associated with the Intent, used with
2796 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2797 * this may be a styled CharSequence, so you must use
2798 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2799 * retrieve it.
2800 */
2801 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2802
2803 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002804 * A constant String that is associated with the Intent, used with
2805 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2806 * as HTML formatted text. Note that you <em>must</em> also supply
2807 * {@link #EXTRA_TEXT}.
2808 */
2809 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2810
2811 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002812 * A content: URI holding a stream of data associated with the Intent,
2813 * used with {@link #ACTION_SEND} to supply the data being sent.
2814 */
2815 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2816
2817 /**
2818 * A String[] holding e-mail addresses that should be delivered to.
2819 */
2820 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2821
2822 /**
2823 * A String[] holding e-mail addresses that should be carbon copied.
2824 */
2825 public static final String EXTRA_CC = "android.intent.extra.CC";
2826
2827 /**
2828 * A String[] holding e-mail addresses that should be blind carbon copied.
2829 */
2830 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2831
2832 /**
2833 * A constant string holding the desired subject line of a message.
2834 */
2835 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2836
2837 /**
2838 * An Intent describing the choices you would like shown with
2839 * {@link #ACTION_PICK_ACTIVITY}.
2840 */
2841 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2842
2843 /**
2844 * A CharSequence dialog title to provide to the user when used with a
2845 * {@link #ACTION_CHOOSER}.
2846 */
2847 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2848
2849 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002850 * A Parcelable[] of {@link Intent} or
2851 * {@link android.content.pm.LabeledIntent} objects as set with
2852 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2853 * a the front of the list of choices, when shown to the user with a
2854 * {@link #ACTION_CHOOSER}.
2855 */
2856 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2857
2858 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 * A {@link android.view.KeyEvent} object containing the event that
2860 * triggered the creation of the Intent it is in.
2861 */
2862 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2863
2864 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002865 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2866 * before shutting down.
2867 *
2868 * {@hide}
2869 */
2870 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2871
2872 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002873 * 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 -07002874 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2875 * of restarting the application.
2876 */
2877 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2878
2879 /**
2880 * A String holding the phone number originally entered in
2881 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2882 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2883 */
2884 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002885
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002886 /**
2887 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2888 * intents to supply the uid the package had been assigned. Also an optional
2889 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2890 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2891 * purpose.
2892 */
2893 public static final String EXTRA_UID = "android.intent.extra.UID";
2894
2895 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002896 * @hide String array of package names.
2897 */
2898 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2899
2900 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002901 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2902 * intents to indicate whether this represents a full uninstall (removing
2903 * both the code and its data) or a partial uninstall (leaving its data,
2904 * implying that this is an update).
2905 */
2906 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002907
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002908 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002909 * @hide
2910 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2911 * intents to indicate that at this point the package has been removed for
2912 * all users on the device.
2913 */
2914 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2915 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2916
2917 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002918 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2919 * intents to indicate that this is a replacement of the package, so this
2920 * broadcast will immediately be followed by an add broadcast for a
2921 * different version of the same package.
2922 */
2923 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002924
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002925 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002926 * Used as an int extra field in {@link android.app.AlarmManager} intents
2927 * to tell the application being invoked how many pending alarms are being
2928 * delievered with the intent. For one-shot alarms this will always be 1.
2929 * For recurring alarms, this might be greater than 1 if the device was
2930 * asleep or powered off at the time an earlier alarm would have been
2931 * delivered.
2932 */
2933 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002934
Jacek Surazski86b6c532009-05-13 14:38:28 +02002935 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002936 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2937 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002938 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2939 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002940 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2941 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2942 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002943 */
2944 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2945
2946 /**
2947 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2948 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002949 */
2950 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2951
2952 /**
2953 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2954 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002955 */
2956 public static final int EXTRA_DOCK_STATE_DESK = 1;
2957
2958 /**
2959 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2960 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002961 */
2962 public static final int EXTRA_DOCK_STATE_CAR = 2;
2963
2964 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002965 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2966 * to represent that the phone is in a analog (low end) dock.
2967 */
2968 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2969
2970 /**
2971 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2972 * to represent that the phone is in a digital (high end) dock.
2973 */
2974 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2975
2976 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002977 * Boolean that can be supplied as meta-data with a dock activity, to
2978 * indicate that the dock should take over the home key when it is active.
2979 */
2980 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002981
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002982 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002983 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2984 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002985 */
2986 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2987
2988 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002989 * Used in the extra field in the remote intent. It's astring token passed with the
2990 * remote intent.
2991 */
2992 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2993 "android.intent.extra.remote_intent_token";
2994
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002995 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002996 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002997 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002998 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002999 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003000 "android.intent.extra.changed_component_name";
3001
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003002 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003003 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003004 * and contains a string array of all of the components that have changed. If
3005 * the state of the overall package has changed, then it will contain an entry
3006 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003007 */
3008 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3009 "android.intent.extra.changed_component_name_list";
3010
3011 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003012 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003013 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3014 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003015 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003016 */
3017 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3018 "android.intent.extra.changed_package_list";
3019
3020 /**
3021 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003022 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3023 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003024 * and contains an integer array of uids of all of the components
3025 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003026 */
3027 public static final String EXTRA_CHANGED_UID_LIST =
3028 "android.intent.extra.changed_uid_list";
3029
3030 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003031 * @hide
3032 * Magic extra system code can use when binding, to give a label for
3033 * who it is that has bound to a service. This is an integer giving
3034 * a framework string resource that can be displayed to the user.
3035 */
3036 public static final String EXTRA_CLIENT_LABEL =
3037 "android.intent.extra.client_label";
3038
3039 /**
3040 * @hide
3041 * Magic extra system code can use when binding, to give a PendingIntent object
3042 * that can be launched for the user to disable the system's use of this
3043 * service.
3044 */
3045 public static final String EXTRA_CLIENT_INTENT =
3046 "android.intent.extra.client_intent";
3047
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003048 /**
3049 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3050 * data that is on the local device. This is a boolean extra; the default
3051 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3052 * the user to select media that is already on the device, not requiring it
3053 * be downloaded from a remote service when opened. Another way to look
3054 * at it is that such content should generally have a "_data" column to the
3055 * path of the content on local external storage.
3056 */
3057 public static final String EXTRA_LOCAL_ONLY =
3058 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003059
Amith Yamasani13593602012-03-22 16:16:17 -07003060 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003061 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3062 * user to select and return multiple items. This is a boolean extra; the default
3063 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3064 * present the user with a UI where they can pick multiple items that are all
3065 * returned to the caller. When this happens, they should be returned as
3066 * the {@link #getClipData()} part of the result Intent.
3067 */
3068 public static final String EXTRA_ALLOW_MULTIPLE =
3069 "android.intent.extra.ALLOW_MULTIPLE";
3070
3071 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003072 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003073 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3074 * @hide
3075 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003076 public static final String EXTRA_USER_HANDLE =
3077 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003078
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003079 // ---------------------------------------------------------------------
3080 // ---------------------------------------------------------------------
3081 // Intent flags (see mFlags variable).
3082
3083 /**
3084 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003085 * perform read operations on the Uri in the Intent's data and any URIs
3086 * specified in its ClipData. When applying to an Intent's ClipData,
3087 * all URIs as well as recursive traversals through data or other ClipData
3088 * in Intent items will be granted; only the grant flags of the top-level
3089 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003090 */
3091 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3092 /**
3093 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003094 * perform write operations on the Uri in the Intent's data and any URIs
3095 * specified in its ClipData. When applying to an Intent's ClipData,
3096 * all URIs as well as recursive traversals through data or other ClipData
3097 * in Intent items will be granted; only the grant flags of the top-level
3098 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003099 */
3100 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3101 /**
3102 * Can be set by the caller to indicate that this Intent is coming from
3103 * a background operation, not from direct user interaction.
3104 */
3105 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3106 /**
3107 * A flag you can enable for debugging: when set, log messages will be
3108 * printed during the resolution of this intent to show you what has
3109 * been found to create the final resolved list.
3110 */
3111 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003112 /**
3113 * If set, this intent will not match any components in packages that
3114 * are currently stopped. If this is not set, then the default behavior
3115 * is to include such applications in the result.
3116 */
3117 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3118 /**
3119 * If set, this intent will always match any components in packages that
3120 * are currently stopped. This is the default behavior when
3121 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3122 * flags are set, this one wins (it allows overriding of exclude for
3123 * places where the framework may automatically set the exclude flag).
3124 */
3125 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003126
3127 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003128 * If set, the new activity is not kept in the history stack. As soon as
3129 * the user navigates away from it, the activity is finished. This may also
3130 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3131 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003132 */
3133 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3134 /**
3135 * If set, the activity will not be launched if it is already running
3136 * at the top of the history stack.
3137 */
3138 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3139 /**
3140 * If set, this activity will become the start of a new task on this
3141 * history stack. A task (from the activity that started it to the
3142 * next task activity) defines an atomic group of activities that the
3143 * user can move to. Tasks can be moved to the foreground and background;
3144 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003145 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003146 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3147 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003148 *
3149 * <p>This flag is generally used by activities that want
3150 * to present a "launcher" style behavior: they give the user a list of
3151 * separate things that can be done, which otherwise run completely
3152 * independently of the activity launching them.
3153 *
3154 * <p>When using this flag, if a task is already running for the activity
3155 * you are now starting, then a new activity will not be started; instead,
3156 * the current task will simply be brought to the front of the screen with
3157 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3158 * to disable this behavior.
3159 *
3160 * <p>This flag can not be used when the caller is requesting a result from
3161 * the activity being launched.
3162 */
3163 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3164 /**
3165 * <strong>Do not use this flag unless you are implementing your own
3166 * top-level application launcher.</strong> Used in conjunction with
3167 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3168 * behavior of bringing an existing task to the foreground. When set,
3169 * a new task is <em>always</em> started to host the Activity for the
3170 * Intent, regardless of whether there is already an existing task running
3171 * the same thing.
3172 *
3173 * <p><strong>Because the default system does not include graphical task management,
3174 * you should not use this flag unless you provide some way for a user to
3175 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003176 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003177 * <p>This flag is ignored if
3178 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3179 *
Scott Main7aee61f2011-02-08 11:25:01 -08003180 * <p>See
3181 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3182 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003183 */
3184 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3185 /**
3186 * If set, and the activity being launched is already running in the
3187 * current task, then instead of launching a new instance of that activity,
3188 * all of the other activities on top of it will be closed and this Intent
3189 * will be delivered to the (now on top) old activity as a new Intent.
3190 *
3191 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3192 * If D calls startActivity() with an Intent that resolves to the component
3193 * of activity B, then C and D will be finished and B receive the given
3194 * Intent, resulting in the stack now being: A, B.
3195 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003196 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003197 * either receive the new intent you are starting here in its
3198 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003199 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003200 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3201 * the same intent, then it will be finished and re-created; for all other
3202 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3203 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003204 *
3205 * <p>This launch mode can also be used to good effect in conjunction with
3206 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3207 * of a task, it will bring any currently running instance of that task
3208 * to the foreground, and then clear it to its root state. This is
3209 * especially useful, for example, when launching an activity from the
3210 * notification manager.
3211 *
Scott Main7aee61f2011-02-08 11:25:01 -08003212 * <p>See
3213 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3214 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003215 */
3216 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3217 /**
3218 * If set and this intent is being used to launch a new activity from an
3219 * existing one, then the reply target of the existing activity will be
3220 * transfered to the new activity. This way the new activity can call
3221 * {@link android.app.Activity#setResult} and have that result sent back to
3222 * the reply target of the original activity.
3223 */
3224 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3225 /**
3226 * If set and this intent is being used to launch a new activity from an
3227 * existing one, the current activity will not be counted as the top
3228 * activity for deciding whether the new intent should be delivered to
3229 * the top instead of starting a new one. The previous activity will
3230 * be used as the top, with the assumption being that the current activity
3231 * will finish itself immediately.
3232 */
3233 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3234 /**
3235 * If set, the new activity is not kept in the list of recently launched
3236 * activities.
3237 */
3238 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3239 /**
3240 * This flag is not normally set by application code, but set for you by
3241 * the system as described in the
3242 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3243 * launchMode} documentation for the singleTask mode.
3244 */
3245 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3246 /**
3247 * If set, and this activity is either being started in a new task or
3248 * bringing to the top an existing task, then it will be launched as
3249 * the front door of the task. This will result in the application of
3250 * any affinities needed to have that task in the proper state (either
3251 * moving activities to or from it), or simply resetting that task to
3252 * its initial state if needed.
3253 */
3254 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3255 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003256 * This flag is not normally set by application code, but set for you by
3257 * the system if this activity is being launched from history
3258 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003259 */
3260 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003261 /**
3262 * If set, this marks a point in the task's activity stack that should
3263 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003264 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003265 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3266 * the user re-launching it from home), this activity and all on top of
3267 * it will be finished so that the user does not return to them, but
3268 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003269 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003270 * <p>This is useful for cases where you have a logical break in your
3271 * application. For example, an e-mail application may have a command
3272 * to view an attachment, which launches an image view activity to
3273 * display it. This activity should be part of the e-mail application's
3274 * task, since it is a part of the task the user is involved in. However,
3275 * if the user leaves that task, and later selects the e-mail app from
3276 * home, we may like them to return to the conversation they were
3277 * viewing, not the picture attachment, since that is confusing. By
3278 * setting this flag when launching the image viewer, that viewer and
3279 * any activities it starts will be removed the next time the user returns
3280 * to mail.
3281 */
3282 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003283 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003284 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003285 * callback from occurring on the current frontmost activity before it is
3286 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003287 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003288 * <p>Typically, an activity can rely on that callback to indicate that an
3289 * explicit user action has caused their activity to be moved out of the
3290 * foreground. The callback marks an appropriate point in the activity's
3291 * lifecycle for it to dismiss any notifications that it intends to display
3292 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003293 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003294 * <p>If an activity is ever started via any non-user-driven events such as
3295 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3296 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003297 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003298 */
3299 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003300 /**
3301 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3302 * this flag will cause the launched activity to be brought to the front of its
3303 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003304 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003305 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3306 * If D calls startActivity() with an Intent that resolves to the component
3307 * of activity B, then B will be brought to the front of the history stack,
3308 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003309 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003310 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003311 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003312 */
3313 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003314 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003315 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3316 * this flag will prevent the system from applying an activity transition
3317 * animation to go to the next activity state. This doesn't mean an
3318 * animation will never run -- if another activity change happens that doesn't
3319 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003320 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003321 * when you are going to do a series of activity operations but the
3322 * animation seen by the user shouldn't be driven by the first activity
3323 * change but rather a later one.
3324 */
3325 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3326 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003327 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3328 * this flag will cause any existing task that would be associated with the
3329 * activity to be cleared before the activity is started. That is, the activity
3330 * becomes the new root of an otherwise empty task, and any old activities
3331 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3332 */
3333 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3334 /**
3335 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3336 * this flag will cause a newly launching task to be placed on top of the current
3337 * home activity task (if there is one). That is, pressing back from the task
3338 * will always return the user to home even if that was not the last activity they
3339 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3340 */
3341 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3342 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003343 * If set, when sending a broadcast only registered receivers will be
3344 * called -- no BroadcastReceiver components will be launched.
3345 */
3346 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003347 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003348 * If set, when sending a broadcast the new broadcast will replace
3349 * any existing pending broadcast that matches it. Matching is defined
3350 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3351 * true for the intents of the two broadcasts. When a match is found,
3352 * the new broadcast (and receivers associated with it) will replace the
3353 * existing one in the pending broadcast list, remaining at the same
3354 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003355 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003356 * <p>This flag is most typically used with sticky broadcasts, which
3357 * only care about delivering the most recent values of the broadcast
3358 * to their receivers.
3359 */
3360 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3361 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003362 * If set, when sending a broadcast the recipient is allowed to run at
3363 * foreground priority, with a shorter timeout interval. During normal
3364 * broadcasts the receivers are not automatically hoisted out of the
3365 * background priority class.
3366 */
3367 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3368 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003369 * If set, when sending a broadcast <i>before boot has completed</i> only
3370 * registered receivers will be called -- no BroadcastReceiver components
3371 * will be launched. Sticky intent state will be recorded properly even
3372 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3373 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003374 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003375 * <p>This flag is only for use by system sevices as a convenience to
3376 * avoid having to implement a more complex mechanism around detection
3377 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003378 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003379 * @hide
3380 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003381 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003382 /**
3383 * Set when this broadcast is for a boot upgrade, a special mode that
3384 * allows the broadcast to be sent before the system is ready and launches
3385 * the app process with no providers running in it.
3386 * @hide
3387 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003388 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003389
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003390 /**
3391 * @hide Flags that can't be changed with PendingIntent.
3392 */
3393 public static final int IMMUTABLE_FLAGS =
3394 FLAG_GRANT_READ_URI_PERMISSION
3395 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003396
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003397 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003398 // ---------------------------------------------------------------------
3399 // toUri() and parseUri() options.
3400
3401 /**
3402 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3403 * always has the "intent:" scheme. This syntax can be used when you want
3404 * to later disambiguate between URIs that are intended to describe an
3405 * Intent vs. all others that should be treated as raw URIs. When used
3406 * with {@link #parseUri}, any other scheme will result in a generic
3407 * VIEW action for that raw URI.
3408 */
3409 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003410
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003411 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003412
3413 private String mAction;
3414 private Uri mData;
3415 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003416 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003417 private ComponentName mComponent;
3418 private int mFlags;
3419 private HashSet<String> mCategories;
3420 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003421 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003422 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003423 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003424
3425 // ---------------------------------------------------------------------
3426
3427 /**
3428 * Create an empty intent.
3429 */
3430 public Intent() {
3431 }
3432
3433 /**
3434 * Copy constructor.
3435 */
3436 public Intent(Intent o) {
3437 this.mAction = o.mAction;
3438 this.mData = o.mData;
3439 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003440 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003441 this.mComponent = o.mComponent;
3442 this.mFlags = o.mFlags;
3443 if (o.mCategories != null) {
3444 this.mCategories = new HashSet<String>(o.mCategories);
3445 }
3446 if (o.mExtras != null) {
3447 this.mExtras = new Bundle(o.mExtras);
3448 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003449 if (o.mSourceBounds != null) {
3450 this.mSourceBounds = new Rect(o.mSourceBounds);
3451 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003452 if (o.mSelector != null) {
3453 this.mSelector = new Intent(o.mSelector);
3454 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003455 if (o.mClipData != null) {
3456 this.mClipData = new ClipData(o.mClipData);
3457 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003458 }
3459
3460 @Override
3461 public Object clone() {
3462 return new Intent(this);
3463 }
3464
3465 private Intent(Intent o, boolean all) {
3466 this.mAction = o.mAction;
3467 this.mData = o.mData;
3468 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003469 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003470 this.mComponent = o.mComponent;
3471 if (o.mCategories != null) {
3472 this.mCategories = new HashSet<String>(o.mCategories);
3473 }
3474 }
3475
3476 /**
3477 * Make a clone of only the parts of the Intent that are relevant for
3478 * filter matching: the action, data, type, component, and categories.
3479 */
3480 public Intent cloneFilter() {
3481 return new Intent(this, false);
3482 }
3483
3484 /**
3485 * Create an intent with a given action. All other fields (data, type,
3486 * class) are null. Note that the action <em>must</em> be in a
3487 * namespace because Intents are used globally in the system -- for
3488 * example the system VIEW action is android.intent.action.VIEW; an
3489 * application's custom action would be something like
3490 * com.google.app.myapp.CUSTOM_ACTION.
3491 *
3492 * @param action The Intent action, such as ACTION_VIEW.
3493 */
3494 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003495 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003496 }
3497
3498 /**
3499 * Create an intent with a given action and for a given data url. Note
3500 * that the action <em>must</em> be in a namespace because Intents are
3501 * used globally in the system -- for example the system VIEW action is
3502 * android.intent.action.VIEW; an application's custom action would be
3503 * something like com.google.app.myapp.CUSTOM_ACTION.
3504 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003505 * <p><em>Note: scheme and host name matching in the Android framework is
3506 * case-sensitive, unlike the formal RFC. As a result,
3507 * you should always ensure that you write your Uri with these elements
3508 * using lower case letters, and normalize any Uris you receive from
3509 * outside of Android to ensure the scheme and host is lower case.</em></p>
3510 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003511 * @param action The Intent action, such as ACTION_VIEW.
3512 * @param uri The Intent data URI.
3513 */
3514 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003515 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003516 mData = uri;
3517 }
3518
3519 /**
3520 * Create an intent for a specific component. All other fields (action, data,
3521 * type, class) are null, though they can be modified later with explicit
3522 * calls. This provides a convenient way to create an intent that is
3523 * intended to execute a hard-coded class name, rather than relying on the
3524 * system to find an appropriate class for you; see {@link #setComponent}
3525 * for more information on the repercussions of this.
3526 *
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 #setClass
3532 * @see #setComponent
3533 * @see #Intent(String, android.net.Uri , Context, Class)
3534 */
3535 public Intent(Context packageContext, Class<?> cls) {
3536 mComponent = new ComponentName(packageContext, cls);
3537 }
3538
3539 /**
3540 * Create an intent for a specific component with a specified action and data.
3541 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3542 * construct the Intent and then calling {@link #setClass} to set its
3543 * class.
3544 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003545 * <p><em>Note: scheme and host name matching in the Android framework is
3546 * case-sensitive, unlike the formal RFC. As a result,
3547 * you should always ensure that you write your Uri with these elements
3548 * using lower case letters, and normalize any Uris you receive from
3549 * outside of Android to ensure the scheme and host is lower case.</em></p>
3550 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003551 * @param action The Intent action, such as ACTION_VIEW.
3552 * @param uri The Intent data URI.
3553 * @param packageContext A Context of the application package implementing
3554 * this class.
3555 * @param cls The component class that is to be used for the intent.
3556 *
3557 * @see #Intent(String, android.net.Uri)
3558 * @see #Intent(Context, Class)
3559 * @see #setClass
3560 * @see #setComponent
3561 */
3562 public Intent(String action, Uri uri,
3563 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003564 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003565 mData = uri;
3566 mComponent = new ComponentName(packageContext, cls);
3567 }
3568
3569 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003570 * Create an intent to launch the main (root) activity of a task. This
3571 * is the Intent that is started when the application's is launched from
3572 * Home. For anything else that wants to launch an application in the
3573 * same way, it is important that they use an Intent structured the same
3574 * way, and can use this function to ensure this is the case.
3575 *
3576 * <p>The returned Intent has the given Activity component as its explicit
3577 * component, {@link #ACTION_MAIN} as its action, and includes the
3578 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3579 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3580 * to do that through {@link #addFlags(int)} on the returned Intent.
3581 *
3582 * @param mainActivity The main activity component that this Intent will
3583 * launch.
3584 * @return Returns a newly created Intent that can be used to launch the
3585 * activity as a main application entry.
3586 *
3587 * @see #setClass
3588 * @see #setComponent
3589 */
3590 public static Intent makeMainActivity(ComponentName mainActivity) {
3591 Intent intent = new Intent(ACTION_MAIN);
3592 intent.setComponent(mainActivity);
3593 intent.addCategory(CATEGORY_LAUNCHER);
3594 return intent;
3595 }
3596
3597 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003598 * Make an Intent for the main activity of an application, without
3599 * specifying a specific activity to run but giving a selector to find
3600 * the activity. This results in a final Intent that is structured
3601 * the same as when the application is launched from
3602 * Home. For anything else that wants to launch an application in the
3603 * same way, it is important that they use an Intent structured the same
3604 * way, and can use this function to ensure this is the case.
3605 *
3606 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3607 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3608 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3609 * to do that through {@link #addFlags(int)} on the returned Intent.
3610 *
3611 * @param selectorAction The action name of the Intent's selector.
3612 * @param selectorCategory The name of a category to add to the Intent's
3613 * selector.
3614 * @return Returns a newly created Intent that can be used to launch the
3615 * activity as a main application entry.
3616 *
3617 * @see #setSelector(Intent)
3618 */
3619 public static Intent makeMainSelectorActivity(String selectorAction,
3620 String selectorCategory) {
3621 Intent intent = new Intent(ACTION_MAIN);
3622 intent.addCategory(CATEGORY_LAUNCHER);
3623 Intent selector = new Intent();
3624 selector.setAction(selectorAction);
3625 selector.addCategory(selectorCategory);
3626 intent.setSelector(selector);
3627 return intent;
3628 }
3629
3630 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003631 * Make an Intent that can be used to re-launch an application's task
3632 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3633 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3634 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3635 *
3636 * @param mainActivity The activity component that is the root of the
3637 * task; this is the activity that has been published in the application's
3638 * manifest as the main launcher icon.
3639 *
3640 * @return Returns a newly created Intent that can be used to relaunch the
3641 * activity's task in its root state.
3642 */
3643 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3644 Intent intent = makeMainActivity(mainActivity);
3645 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3646 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3647 return intent;
3648 }
3649
3650 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003651 * Call {@link #parseUri} with 0 flags.
3652 * @deprecated Use {@link #parseUri} instead.
3653 */
3654 @Deprecated
3655 public static Intent getIntent(String uri) throws URISyntaxException {
3656 return parseUri(uri, 0);
3657 }
Tom Taylord4a47292009-12-21 13:59:18 -08003658
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003659 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003660 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003661 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003662 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003663 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003664 *
3665 * <p>The URI given here must not be relative -- that is, it must include
3666 * the scheme and full path.
3667 *
3668 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003669 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003670 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003671 *
3672 * @return Intent The newly created Intent object.
3673 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003674 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3675 * it bad (as parsed by the Uri class) or the Intent data within the
3676 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003677 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003678 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003679 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003680 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003681 int i = 0;
3682 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003683 // Validate intent scheme for if requested.
3684 if ((flags&URI_INTENT_SCHEME) != 0) {
3685 if (!uri.startsWith("intent:")) {
3686 Intent intent = new Intent(ACTION_VIEW);
3687 try {
3688 intent.setData(Uri.parse(uri));
3689 } catch (IllegalArgumentException e) {
3690 throw new URISyntaxException(uri, e.getMessage());
3691 }
3692 return intent;
3693 }
3694 }
Tom Taylord4a47292009-12-21 13:59:18 -08003695
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003696 // simple case
3697 i = uri.lastIndexOf("#");
3698 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3699
3700 // old format Intent URI
3701 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003702
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003703 // new format
3704 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003705 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003706
3707 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003708 String data = i >= 0 ? uri.substring(0, i) : null;
3709 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003710 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003711
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003712 // loop over contents of Intent, all name=value;
3713 while (!uri.startsWith("end", i)) {
3714 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003715 if (eq < 0) eq = i-1;
3716 int semi = uri.indexOf(';', i);
3717 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003718
3719 // action
3720 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003721 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003722 }
3723
3724 // categories
3725 else if (uri.startsWith("category=", i)) {
3726 intent.addCategory(value);
3727 }
3728
3729 // type
3730 else if (uri.startsWith("type=", i)) {
3731 intent.mType = value;
3732 }
3733
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003734 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003735 else if (uri.startsWith("launchFlags=", i)) {
3736 intent.mFlags = Integer.decode(value).intValue();
3737 }
3738
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003739 // package
3740 else if (uri.startsWith("package=", i)) {
3741 intent.mPackage = value;
3742 }
3743
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003744 // component
3745 else if (uri.startsWith("component=", i)) {
3746 intent.mComponent = ComponentName.unflattenFromString(value);
3747 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003748
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003749 // scheme
3750 else if (uri.startsWith("scheme=", i)) {
3751 scheme = value;
3752 }
3753
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003754 // source bounds
3755 else if (uri.startsWith("sourceBounds=", i)) {
3756 intent.mSourceBounds = Rect.unflattenFromString(value);
3757 }
3758
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003759 // selector
3760 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3761 intent = new Intent();
3762 }
3763
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003764 // extra
3765 else {
3766 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003767 // create Bundle if it doesn't already exist
3768 if (intent.mExtras == null) intent.mExtras = new Bundle();
3769 Bundle b = intent.mExtras;
3770 // add EXTRA
3771 if (uri.startsWith("S.", i)) b.putString(key, value);
3772 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3773 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3774 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3775 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3776 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3777 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3778 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3779 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3780 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3781 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003782
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003783 // move to the next item
3784 i = semi + 1;
3785 }
3786
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003787 if (intent != baseIntent) {
3788 // The Intent had a selector; fix it up.
3789 baseIntent.setSelector(intent);
3790 intent = baseIntent;
3791 }
3792
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003793 if (data != null) {
3794 if (data.startsWith("intent:")) {
3795 data = data.substring(7);
3796 if (scheme != null) {
3797 data = scheme + ':' + data;
3798 }
3799 }
Tom Taylord4a47292009-12-21 13:59:18 -08003800
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003801 if (data.length() > 0) {
3802 try {
3803 intent.mData = Uri.parse(data);
3804 } catch (IllegalArgumentException e) {
3805 throw new URISyntaxException(uri, e.getMessage());
3806 }
3807 }
3808 }
Tom Taylord4a47292009-12-21 13:59:18 -08003809
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003810 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003811
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003812 } catch (IndexOutOfBoundsException e) {
3813 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3814 }
3815 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003816
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003817 public static Intent getIntentOld(String uri) throws URISyntaxException {
3818 Intent intent;
3819
3820 int i = uri.lastIndexOf('#');
3821 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003822 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003823 final int intentFragmentStart = i;
3824 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003825
3826 i++;
3827
3828 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003829 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003830 i += 7;
3831 int j = uri.indexOf(')', i);
3832 action = uri.substring(i, j);
3833 i = j + 1;
3834 }
3835
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003836 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003837
3838 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003839 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003840 i += 11;
3841 int j = uri.indexOf(')', i);
3842 while (i < j) {
3843 int sep = uri.indexOf('!', i);
3844 if (sep < 0) sep = j;
3845 if (i < sep) {
3846 intent.addCategory(uri.substring(i, sep));
3847 }
3848 i = sep + 1;
3849 }
3850 i = j + 1;
3851 }
3852
3853 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003854 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003855 i += 5;
3856 int j = uri.indexOf(')', i);
3857 intent.mType = uri.substring(i, j);
3858 i = j + 1;
3859 }
3860
3861 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003862 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003863 i += 12;
3864 int j = uri.indexOf(')', i);
3865 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3866 i = j + 1;
3867 }
3868
3869 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003870 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003871 i += 10;
3872 int j = uri.indexOf(')', i);
3873 int sep = uri.indexOf('!', i);
3874 if (sep >= 0 && sep < j) {
3875 String pkg = uri.substring(i, sep);
3876 String cls = uri.substring(sep + 1, j);
3877 intent.mComponent = new ComponentName(pkg, cls);
3878 }
3879 i = j + 1;
3880 }
3881
3882 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003883 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003884 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003885
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003886 final int closeParen = uri.indexOf(')', i);
3887 if (closeParen == -1) throw new URISyntaxException(uri,
3888 "EXTRA missing trailing ')'", i);
3889
3890 while (i < closeParen) {
3891 // fetch the key value
3892 int j = uri.indexOf('=', i);
3893 if (j <= i + 1 || i >= closeParen) {
3894 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3895 }
3896 char type = uri.charAt(i);
3897 i++;
3898 String key = uri.substring(i, j);
3899 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003900
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003901 // get type-value
3902 j = uri.indexOf('!', i);
3903 if (j == -1 || j >= closeParen) j = closeParen;
3904 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3905 String value = uri.substring(i, j);
3906 i = j;
3907
3908 // create Bundle if it doesn't already exist
3909 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003910
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003911 // add item to bundle
3912 try {
3913 switch (type) {
3914 case 'S':
3915 intent.mExtras.putString(key, Uri.decode(value));
3916 break;
3917 case 'B':
3918 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3919 break;
3920 case 'b':
3921 intent.mExtras.putByte(key, Byte.parseByte(value));
3922 break;
3923 case 'c':
3924 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3925 break;
3926 case 'd':
3927 intent.mExtras.putDouble(key, Double.parseDouble(value));
3928 break;
3929 case 'f':
3930 intent.mExtras.putFloat(key, Float.parseFloat(value));
3931 break;
3932 case 'i':
3933 intent.mExtras.putInt(key, Integer.parseInt(value));
3934 break;
3935 case 'l':
3936 intent.mExtras.putLong(key, Long.parseLong(value));
3937 break;
3938 case 's':
3939 intent.mExtras.putShort(key, Short.parseShort(value));
3940 break;
3941 default:
3942 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3943 }
3944 } catch (NumberFormatException e) {
3945 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3946 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003947
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003948 char ch = uri.charAt(i);
3949 if (ch == ')') break;
3950 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3951 i++;
3952 }
3953 }
3954
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003955 if (isIntentFragment) {
3956 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3957 } else {
3958 intent.mData = Uri.parse(uri);
3959 }
Tom Taylord4a47292009-12-21 13:59:18 -08003960
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003961 if (intent.mAction == null) {
3962 // By default, if no action is specified, then use VIEW.
3963 intent.mAction = ACTION_VIEW;
3964 }
3965
3966 } else {
3967 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3968 }
3969
3970 return intent;
3971 }
3972
3973 /**
3974 * Retrieve the general action to be performed, such as
3975 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3976 * the information in the intent should be interpreted -- most importantly,
3977 * what to do with the data returned by {@link #getData}.
3978 *
3979 * @return The action of this intent or null if none is specified.
3980 *
3981 * @see #setAction
3982 */
3983 public String getAction() {
3984 return mAction;
3985 }
3986
3987 /**
3988 * Retrieve data this intent is operating on. This URI specifies the name
3989 * of the data; often it uses the content: scheme, specifying data in a
3990 * content provider. Other schemes may be handled by specific activities,
3991 * such as http: by the web browser.
3992 *
3993 * @return The URI of the data this intent is targeting or null.
3994 *
3995 * @see #getScheme
3996 * @see #setData
3997 */
3998 public Uri getData() {
3999 return mData;
4000 }
4001
4002 /**
4003 * The same as {@link #getData()}, but returns the URI as an encoded
4004 * String.
4005 */
4006 public String getDataString() {
4007 return mData != null ? mData.toString() : null;
4008 }
4009
4010 /**
4011 * Return the scheme portion of the intent's data. If the data is null or
4012 * does not include a scheme, null is returned. Otherwise, the scheme
4013 * prefix without the final ':' is returned, i.e. "http".
4014 *
4015 * <p>This is the same as calling getData().getScheme() (and checking for
4016 * null data).
4017 *
4018 * @return The scheme of this intent.
4019 *
4020 * @see #getData
4021 */
4022 public String getScheme() {
4023 return mData != null ? mData.getScheme() : null;
4024 }
4025
4026 /**
4027 * Retrieve any explicit MIME type included in the intent. This is usually
4028 * null, as the type is determined by the intent data.
4029 *
4030 * @return If a type was manually set, it is returned; else null is
4031 * returned.
4032 *
4033 * @see #resolveType(ContentResolver)
4034 * @see #setType
4035 */
4036 public String getType() {
4037 return mType;
4038 }
4039
4040 /**
4041 * Return the MIME data type of this intent. If the type field is
4042 * explicitly set, that is simply returned. Otherwise, if the data is set,
4043 * the type of that data is returned. If neither fields are set, a null is
4044 * returned.
4045 *
4046 * @return The MIME type of this intent.
4047 *
4048 * @see #getType
4049 * @see #resolveType(ContentResolver)
4050 */
4051 public String resolveType(Context context) {
4052 return resolveType(context.getContentResolver());
4053 }
4054
4055 /**
4056 * Return the MIME data type of this intent. If the type field is
4057 * explicitly set, that is simply returned. Otherwise, if the data is set,
4058 * the type of that data is returned. If neither fields are set, a null is
4059 * returned.
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.
4065 *
4066 * @see #getType
4067 * @see #resolveType(Context)
4068 */
4069 public String resolveType(ContentResolver resolver) {
4070 if (mType != null) {
4071 return mType;
4072 }
4073 if (mData != null) {
4074 if ("content".equals(mData.getScheme())) {
4075 return resolver.getType(mData);
4076 }
4077 }
4078 return null;
4079 }
4080
4081 /**
4082 * Return the MIME data type of this intent, only if it will be needed for
4083 * intent resolution. This is not generally useful for application code;
4084 * it is used by the frameworks for communicating with back-end system
4085 * services.
4086 *
4087 * @param resolver A ContentResolver that can be used to determine the MIME
4088 * type of the intent's data.
4089 *
4090 * @return The MIME type of this intent, or null if it is unknown or not
4091 * needed.
4092 */
4093 public String resolveTypeIfNeeded(ContentResolver resolver) {
4094 if (mComponent != null) {
4095 return mType;
4096 }
4097 return resolveType(resolver);
4098 }
4099
4100 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004101 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004102 *
4103 * @param category The category to check.
4104 *
4105 * @return boolean True if the intent contains the category, else false.
4106 *
4107 * @see #getCategories
4108 * @see #addCategory
4109 */
4110 public boolean hasCategory(String category) {
4111 return mCategories != null && mCategories.contains(category);
4112 }
4113
4114 /**
4115 * Return the set of all categories in the intent. If there are no categories,
4116 * returns NULL.
4117 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004118 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004119 *
4120 * @see #hasCategory
4121 * @see #addCategory
4122 */
4123 public Set<String> getCategories() {
4124 return mCategories;
4125 }
4126
4127 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004128 * Return the specific selector associated with this Intent. If there is
4129 * none, returns null. See {@link #setSelector} for more information.
4130 *
4131 * @see #setSelector
4132 */
4133 public Intent getSelector() {
4134 return mSelector;
4135 }
4136
4137 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004138 * Return the {@link ClipData} associated with this Intent. If there is
4139 * none, returns null. See {@link #setClipData} for more information.
4140 *
4141 * @see #setClipData;
4142 */
4143 public ClipData getClipData() {
4144 return mClipData;
4145 }
4146
4147 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004148 * Sets the ClassLoader that will be used when unmarshalling
4149 * any Parcelable values from the extras of this Intent.
4150 *
4151 * @param loader a ClassLoader, or null to use the default loader
4152 * at the time of unmarshalling.
4153 */
4154 public void setExtrasClassLoader(ClassLoader loader) {
4155 if (mExtras != null) {
4156 mExtras.setClassLoader(loader);
4157 }
4158 }
4159
4160 /**
4161 * Returns true if an extra value is associated with the given name.
4162 * @param name the extra's name
4163 * @return true if the given extra is present.
4164 */
4165 public boolean hasExtra(String name) {
4166 return mExtras != null && mExtras.containsKey(name);
4167 }
4168
4169 /**
4170 * Returns true if the Intent's extras contain a parcelled file descriptor.
4171 * @return true if the Intent contains a parcelled file descriptor.
4172 */
4173 public boolean hasFileDescriptors() {
4174 return mExtras != null && mExtras.hasFileDescriptors();
4175 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004176
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004177 /** @hide */
4178 public void setAllowFds(boolean allowFds) {
4179 if (mExtras != null) {
4180 mExtras.setAllowFds(allowFds);
4181 }
4182 }
4183
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004184 /**
4185 * Retrieve extended data from the intent.
4186 *
4187 * @param name The name of the desired item.
4188 *
4189 * @return the value of an item that previously added with putExtra()
4190 * or null if none was found.
4191 *
4192 * @deprecated
4193 * @hide
4194 */
4195 @Deprecated
4196 public Object getExtra(String name) {
4197 return getExtra(name, null);
4198 }
4199
4200 /**
4201 * Retrieve extended data from the intent.
4202 *
4203 * @param name The name of the desired item.
4204 * @param defaultValue the value to be returned if no value of the desired
4205 * type is stored with the given name.
4206 *
4207 * @return the value of an item that previously added with putExtra()
4208 * or the default value if none was found.
4209 *
4210 * @see #putExtra(String, boolean)
4211 */
4212 public boolean getBooleanExtra(String name, boolean defaultValue) {
4213 return mExtras == null ? defaultValue :
4214 mExtras.getBoolean(name, defaultValue);
4215 }
4216
4217 /**
4218 * Retrieve extended data from the intent.
4219 *
4220 * @param name The name of the desired item.
4221 * @param defaultValue the value to be returned if no value of the desired
4222 * type is stored with the given name.
4223 *
4224 * @return the value of an item that previously added with putExtra()
4225 * or the default value if none was found.
4226 *
4227 * @see #putExtra(String, byte)
4228 */
4229 public byte getByteExtra(String name, byte defaultValue) {
4230 return mExtras == null ? defaultValue :
4231 mExtras.getByte(name, defaultValue);
4232 }
4233
4234 /**
4235 * Retrieve extended data from the intent.
4236 *
4237 * @param name The name of the desired item.
4238 * @param defaultValue the value to be returned if no value of the desired
4239 * type is stored with the given name.
4240 *
4241 * @return the value of an item that previously added with putExtra()
4242 * or the default value if none was found.
4243 *
4244 * @see #putExtra(String, short)
4245 */
4246 public short getShortExtra(String name, short defaultValue) {
4247 return mExtras == null ? defaultValue :
4248 mExtras.getShort(name, defaultValue);
4249 }
4250
4251 /**
4252 * Retrieve extended data from the intent.
4253 *
4254 * @param name The name of the desired item.
4255 * @param defaultValue the value to be returned if no value of the desired
4256 * type is stored with the given name.
4257 *
4258 * @return the value of an item that previously added with putExtra()
4259 * or the default value if none was found.
4260 *
4261 * @see #putExtra(String, char)
4262 */
4263 public char getCharExtra(String name, char defaultValue) {
4264 return mExtras == null ? defaultValue :
4265 mExtras.getChar(name, defaultValue);
4266 }
4267
4268 /**
4269 * Retrieve extended data from the intent.
4270 *
4271 * @param name The name of the desired item.
4272 * @param defaultValue the value to be returned if no value of the desired
4273 * type is stored with the given name.
4274 *
4275 * @return the value of an item that previously added with putExtra()
4276 * or the default value if none was found.
4277 *
4278 * @see #putExtra(String, int)
4279 */
4280 public int getIntExtra(String name, int defaultValue) {
4281 return mExtras == null ? defaultValue :
4282 mExtras.getInt(name, defaultValue);
4283 }
4284
4285 /**
4286 * Retrieve extended data from the intent.
4287 *
4288 * @param name The name of the desired item.
4289 * @param defaultValue the value to be returned if no value of the desired
4290 * type is stored with the given name.
4291 *
4292 * @return the value of an item that previously added with putExtra()
4293 * or the default value if none was found.
4294 *
4295 * @see #putExtra(String, long)
4296 */
4297 public long getLongExtra(String name, long defaultValue) {
4298 return mExtras == null ? defaultValue :
4299 mExtras.getLong(name, defaultValue);
4300 }
4301
4302 /**
4303 * Retrieve extended data from the intent.
4304 *
4305 * @param name The name of the desired item.
4306 * @param defaultValue the value to be returned if no value of the desired
4307 * type is stored with the given name.
4308 *
4309 * @return the value of an item that previously added with putExtra(),
4310 * or the default value if no such item is present
4311 *
4312 * @see #putExtra(String, float)
4313 */
4314 public float getFloatExtra(String name, float defaultValue) {
4315 return mExtras == null ? defaultValue :
4316 mExtras.getFloat(name, defaultValue);
4317 }
4318
4319 /**
4320 * Retrieve extended data from the intent.
4321 *
4322 * @param name The name of the desired item.
4323 * @param defaultValue the value to be returned if no value of the desired
4324 * type is stored with the given name.
4325 *
4326 * @return the value of an item that previously added with putExtra()
4327 * or the default value if none was found.
4328 *
4329 * @see #putExtra(String, double)
4330 */
4331 public double getDoubleExtra(String name, double defaultValue) {
4332 return mExtras == null ? defaultValue :
4333 mExtras.getDouble(name, defaultValue);
4334 }
4335
4336 /**
4337 * Retrieve extended data from the intent.
4338 *
4339 * @param name The name of the desired item.
4340 *
4341 * @return the value of an item that previously added with putExtra()
4342 * or null if no String value was found.
4343 *
4344 * @see #putExtra(String, String)
4345 */
4346 public String getStringExtra(String name) {
4347 return mExtras == null ? null : mExtras.getString(name);
4348 }
4349
4350 /**
4351 * Retrieve extended data from the intent.
4352 *
4353 * @param name The name of the desired item.
4354 *
4355 * @return the value of an item that previously added with putExtra()
4356 * or null if no CharSequence value was found.
4357 *
4358 * @see #putExtra(String, CharSequence)
4359 */
4360 public CharSequence getCharSequenceExtra(String name) {
4361 return mExtras == null ? null : mExtras.getCharSequence(name);
4362 }
4363
4364 /**
4365 * Retrieve extended data from the intent.
4366 *
4367 * @param name The name of the desired item.
4368 *
4369 * @return the value of an item that previously added with putExtra()
4370 * or null if no Parcelable value was found.
4371 *
4372 * @see #putExtra(String, Parcelable)
4373 */
4374 public <T extends Parcelable> T getParcelableExtra(String name) {
4375 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4376 }
4377
4378 /**
4379 * Retrieve extended data from the intent.
4380 *
4381 * @param name The name of the desired item.
4382 *
4383 * @return the value of an item that previously added with putExtra()
4384 * or null if no Parcelable[] value was found.
4385 *
4386 * @see #putExtra(String, Parcelable[])
4387 */
4388 public Parcelable[] getParcelableArrayExtra(String name) {
4389 return mExtras == null ? null : mExtras.getParcelableArray(name);
4390 }
4391
4392 /**
4393 * Retrieve extended data from the intent.
4394 *
4395 * @param name The name of the desired item.
4396 *
4397 * @return the value of an item that previously added with putExtra()
4398 * or null if no ArrayList<Parcelable> value was found.
4399 *
4400 * @see #putParcelableArrayListExtra(String, ArrayList)
4401 */
4402 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4403 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4404 }
4405
4406 /**
4407 * Retrieve extended data from the intent.
4408 *
4409 * @param name The name of the desired item.
4410 *
4411 * @return the value of an item that previously added with putExtra()
4412 * or null if no Serializable value was found.
4413 *
4414 * @see #putExtra(String, Serializable)
4415 */
4416 public Serializable getSerializableExtra(String name) {
4417 return mExtras == null ? null : mExtras.getSerializable(name);
4418 }
4419
4420 /**
4421 * Retrieve extended data from the intent.
4422 *
4423 * @param name The name of the desired item.
4424 *
4425 * @return the value of an item that previously added with putExtra()
4426 * or null if no ArrayList<Integer> value was found.
4427 *
4428 * @see #putIntegerArrayListExtra(String, ArrayList)
4429 */
4430 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4431 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4432 }
4433
4434 /**
4435 * Retrieve extended data from the intent.
4436 *
4437 * @param name The name of the desired item.
4438 *
4439 * @return the value of an item that previously added with putExtra()
4440 * or null if no ArrayList<String> value was found.
4441 *
4442 * @see #putStringArrayListExtra(String, ArrayList)
4443 */
4444 public ArrayList<String> getStringArrayListExtra(String name) {
4445 return mExtras == null ? null : mExtras.getStringArrayList(name);
4446 }
4447
4448 /**
4449 * Retrieve extended data from the intent.
4450 *
4451 * @param name The name of the desired item.
4452 *
4453 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004454 * or null if no ArrayList<CharSequence> value was found.
4455 *
4456 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4457 */
4458 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4459 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4460 }
4461
4462 /**
4463 * Retrieve extended data from the intent.
4464 *
4465 * @param name The name of the desired item.
4466 *
4467 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004468 * or null if no boolean array value was found.
4469 *
4470 * @see #putExtra(String, boolean[])
4471 */
4472 public boolean[] getBooleanArrayExtra(String name) {
4473 return mExtras == null ? null : mExtras.getBooleanArray(name);
4474 }
4475
4476 /**
4477 * Retrieve extended data from the intent.
4478 *
4479 * @param name The name of the desired item.
4480 *
4481 * @return the value of an item that previously added with putExtra()
4482 * or null if no byte array value was found.
4483 *
4484 * @see #putExtra(String, byte[])
4485 */
4486 public byte[] getByteArrayExtra(String name) {
4487 return mExtras == null ? null : mExtras.getByteArray(name);
4488 }
4489
4490 /**
4491 * Retrieve extended data from the intent.
4492 *
4493 * @param name The name of the desired item.
4494 *
4495 * @return the value of an item that previously added with putExtra()
4496 * or null if no short array value was found.
4497 *
4498 * @see #putExtra(String, short[])
4499 */
4500 public short[] getShortArrayExtra(String name) {
4501 return mExtras == null ? null : mExtras.getShortArray(name);
4502 }
4503
4504 /**
4505 * Retrieve extended data from the intent.
4506 *
4507 * @param name The name of the desired item.
4508 *
4509 * @return the value of an item that previously added with putExtra()
4510 * or null if no char array value was found.
4511 *
4512 * @see #putExtra(String, char[])
4513 */
4514 public char[] getCharArrayExtra(String name) {
4515 return mExtras == null ? null : mExtras.getCharArray(name);
4516 }
4517
4518 /**
4519 * Retrieve extended data from the intent.
4520 *
4521 * @param name The name of the desired item.
4522 *
4523 * @return the value of an item that previously added with putExtra()
4524 * or null if no int array value was found.
4525 *
4526 * @see #putExtra(String, int[])
4527 */
4528 public int[] getIntArrayExtra(String name) {
4529 return mExtras == null ? null : mExtras.getIntArray(name);
4530 }
4531
4532 /**
4533 * Retrieve extended data from the intent.
4534 *
4535 * @param name The name of the desired item.
4536 *
4537 * @return the value of an item that previously added with putExtra()
4538 * or null if no long array value was found.
4539 *
4540 * @see #putExtra(String, long[])
4541 */
4542 public long[] getLongArrayExtra(String name) {
4543 return mExtras == null ? null : mExtras.getLongArray(name);
4544 }
4545
4546 /**
4547 * Retrieve extended data from the intent.
4548 *
4549 * @param name The name of the desired item.
4550 *
4551 * @return the value of an item that previously added with putExtra()
4552 * or null if no float array value was found.
4553 *
4554 * @see #putExtra(String, float[])
4555 */
4556 public float[] getFloatArrayExtra(String name) {
4557 return mExtras == null ? null : mExtras.getFloatArray(name);
4558 }
4559
4560 /**
4561 * Retrieve extended data from the intent.
4562 *
4563 * @param name The name of the desired item.
4564 *
4565 * @return the value of an item that previously added with putExtra()
4566 * or null if no double array value was found.
4567 *
4568 * @see #putExtra(String, double[])
4569 */
4570 public double[] getDoubleArrayExtra(String name) {
4571 return mExtras == null ? null : mExtras.getDoubleArray(name);
4572 }
4573
4574 /**
4575 * Retrieve extended data from the intent.
4576 *
4577 * @param name The name of the desired item.
4578 *
4579 * @return the value of an item that previously added with putExtra()
4580 * or null if no String array value was found.
4581 *
4582 * @see #putExtra(String, String[])
4583 */
4584 public String[] getStringArrayExtra(String name) {
4585 return mExtras == null ? null : mExtras.getStringArray(name);
4586 }
4587
4588 /**
4589 * Retrieve extended data from the intent.
4590 *
4591 * @param name The name of the desired item.
4592 *
4593 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004594 * or null if no CharSequence array value was found.
4595 *
4596 * @see #putExtra(String, CharSequence[])
4597 */
4598 public CharSequence[] getCharSequenceArrayExtra(String name) {
4599 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4600 }
4601
4602 /**
4603 * Retrieve extended data from the intent.
4604 *
4605 * @param name The name of the desired item.
4606 *
4607 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004608 * or null if no Bundle value was found.
4609 *
4610 * @see #putExtra(String, Bundle)
4611 */
4612 public Bundle getBundleExtra(String name) {
4613 return mExtras == null ? null : mExtras.getBundle(name);
4614 }
4615
4616 /**
4617 * Retrieve extended data from the intent.
4618 *
4619 * @param name The name of the desired item.
4620 *
4621 * @return the value of an item that previously added with putExtra()
4622 * or null if no IBinder value was found.
4623 *
4624 * @see #putExtra(String, IBinder)
4625 *
4626 * @deprecated
4627 * @hide
4628 */
4629 @Deprecated
4630 public IBinder getIBinderExtra(String name) {
4631 return mExtras == null ? null : mExtras.getIBinder(name);
4632 }
4633
4634 /**
4635 * Retrieve extended data from the intent.
4636 *
4637 * @param name The name of the desired item.
4638 * @param defaultValue The default value to return in case no item is
4639 * associated with the key 'name'
4640 *
4641 * @return the value of an item that previously added with putExtra()
4642 * or defaultValue if none was found.
4643 *
4644 * @see #putExtra
4645 *
4646 * @deprecated
4647 * @hide
4648 */
4649 @Deprecated
4650 public Object getExtra(String name, Object defaultValue) {
4651 Object result = defaultValue;
4652 if (mExtras != null) {
4653 Object result2 = mExtras.get(name);
4654 if (result2 != null) {
4655 result = result2;
4656 }
4657 }
4658
4659 return result;
4660 }
4661
4662 /**
4663 * Retrieves a map of extended data from the intent.
4664 *
4665 * @return the map of all extras previously added with putExtra(),
4666 * or null if none have been added.
4667 */
4668 public Bundle getExtras() {
4669 return (mExtras != null)
4670 ? new Bundle(mExtras)
4671 : null;
4672 }
4673
4674 /**
4675 * Retrieve any special flags associated with this intent. You will
4676 * normally just set them with {@link #setFlags} and let the system
4677 * take the appropriate action with them.
4678 *
4679 * @return int The currently set flags.
4680 *
4681 * @see #setFlags
4682 */
4683 public int getFlags() {
4684 return mFlags;
4685 }
4686
Dianne Hackborne7f97212011-02-24 14:40:20 -08004687 /** @hide */
4688 public boolean isExcludingStopped() {
4689 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4690 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4691 }
4692
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004693 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004694 * Retrieve the application package name this Intent is limited to. When
4695 * resolving an Intent, if non-null this limits the resolution to only
4696 * components in the given application package.
4697 *
4698 * @return The name of the application package for the Intent.
4699 *
4700 * @see #resolveActivity
4701 * @see #setPackage
4702 */
4703 public String getPackage() {
4704 return mPackage;
4705 }
4706
4707 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004708 * Retrieve the concrete component associated with the intent. When receiving
4709 * an intent, this is the component that was found to best handle it (that is,
4710 * yourself) and will always be non-null; in all other cases it will be
4711 * null unless explicitly set.
4712 *
4713 * @return The name of the application component to handle the intent.
4714 *
4715 * @see #resolveActivity
4716 * @see #setComponent
4717 */
4718 public ComponentName getComponent() {
4719 return mComponent;
4720 }
4721
4722 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004723 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4724 * used as a hint to the receiver for animations and the like. Null means that there
4725 * is no source bounds.
4726 */
4727 public Rect getSourceBounds() {
4728 return mSourceBounds;
4729 }
4730
4731 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004732 * Return the Activity component that should be used to handle this intent.
4733 * The appropriate component is determined based on the information in the
4734 * intent, evaluated as follows:
4735 *
4736 * <p>If {@link #getComponent} returns an explicit class, that is returned
4737 * without any further consideration.
4738 *
4739 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4740 * category to be considered.
4741 *
4742 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4743 * action.
4744 *
4745 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4746 * this type.
4747 *
4748 * <p>If {@link #addCategory} has added any categories, the activity must
4749 * handle ALL of the categories specified.
4750 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004751 * <p>If {@link #getPackage} is non-NULL, only activity components in
4752 * that application package will be considered.
4753 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004754 * <p>If there are no activities that satisfy all of these conditions, a
4755 * null string is returned.
4756 *
4757 * <p>If multiple activities are found to satisfy the intent, the one with
4758 * the highest priority will be used. If there are multiple activities
4759 * with the same priority, the system will either pick the best activity
4760 * based on user preference, or resolve to a system class that will allow
4761 * the user to pick an activity and forward from there.
4762 *
4763 * <p>This method is implemented simply by calling
4764 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4765 * true.</p>
4766 * <p> This API is called for you as part of starting an activity from an
4767 * intent. You do not normally need to call it yourself.</p>
4768 *
4769 * @param pm The package manager with which to resolve the Intent.
4770 *
4771 * @return Name of the component implementing an activity that can
4772 * display the intent.
4773 *
4774 * @see #setComponent
4775 * @see #getComponent
4776 * @see #resolveActivityInfo
4777 */
4778 public ComponentName resolveActivity(PackageManager pm) {
4779 if (mComponent != null) {
4780 return mComponent;
4781 }
4782
4783 ResolveInfo info = pm.resolveActivity(
4784 this, PackageManager.MATCH_DEFAULT_ONLY);
4785 if (info != null) {
4786 return new ComponentName(
4787 info.activityInfo.applicationInfo.packageName,
4788 info.activityInfo.name);
4789 }
4790
4791 return null;
4792 }
4793
4794 /**
4795 * Resolve the Intent into an {@link ActivityInfo}
4796 * describing the activity that should execute the intent. Resolution
4797 * follows the same rules as described for {@link #resolveActivity}, but
4798 * you get back the completely information about the resolved activity
4799 * instead of just its class name.
4800 *
4801 * @param pm The package manager with which to resolve the Intent.
4802 * @param flags Addition information to retrieve as per
4803 * {@link PackageManager#getActivityInfo(ComponentName, int)
4804 * PackageManager.getActivityInfo()}.
4805 *
4806 * @return PackageManager.ActivityInfo
4807 *
4808 * @see #resolveActivity
4809 */
4810 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4811 ActivityInfo ai = null;
4812 if (mComponent != null) {
4813 try {
4814 ai = pm.getActivityInfo(mComponent, flags);
4815 } catch (PackageManager.NameNotFoundException e) {
4816 // ignore
4817 }
4818 } else {
4819 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004820 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004821 if (info != null) {
4822 ai = info.activityInfo;
4823 }
4824 }
4825
4826 return ai;
4827 }
4828
4829 /**
4830 * Set the general action to be performed.
4831 *
4832 * @param action An action name, such as ACTION_VIEW. Application-specific
4833 * actions should be prefixed with the vendor's package name.
4834 *
4835 * @return Returns the same Intent object, for chaining multiple calls
4836 * into a single statement.
4837 *
4838 * @see #getAction
4839 */
4840 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004841 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004842 return this;
4843 }
4844
4845 /**
4846 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004847 * clears any type that was previously set by {@link #setType} or
4848 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004849 *
Nick Pellyccae4122012-01-09 14:12:58 -08004850 * <p><em>Note: scheme matching in the Android framework is
4851 * case-sensitive, unlike the formal RFC. As a result,
4852 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004853 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004854 * {@link #setDataAndNormalize}
4855 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004856 *
Nick Pellyccae4122012-01-09 14:12:58 -08004857 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004858 *
4859 * @return Returns the same Intent object, for chaining multiple calls
4860 * into a single statement.
4861 *
4862 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004863 * @see #setDataAndNormalize
4864 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004865 */
4866 public Intent setData(Uri data) {
4867 mData = data;
4868 mType = null;
4869 return this;
4870 }
4871
4872 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004873 * Normalize and set the data this intent is operating on.
4874 *
4875 * <p>This method automatically clears any type that was
4876 * previously set (for example, by {@link #setType}).
4877 *
4878 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004879 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004880 * so really this is just a convenience method for
4881 * <pre>
4882 * setData(data.normalize())
4883 * </pre>
4884 *
4885 * @param data The Uri of the data this intent is now targeting.
4886 *
4887 * @return Returns the same Intent object, for chaining multiple calls
4888 * into a single statement.
4889 *
4890 * @see #getData
4891 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004892 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004893 */
4894 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004895 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004896 }
4897
4898 /**
4899 * Set an explicit MIME data type.
4900 *
4901 * <p>This is used to create intents that only specify a type and not data,
4902 * for example to indicate the type of data to return.
4903 *
4904 * <p>This method automatically clears any data that was
4905 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004906 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004907 * <p><em>Note: MIME type matching in the Android framework is
4908 * case-sensitive, unlike formal RFC MIME types. As a result,
4909 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004910 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4911 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004912 *
4913 * @param type The MIME type of the data being handled by this intent.
4914 *
4915 * @return Returns the same Intent object, for chaining multiple calls
4916 * into a single statement.
4917 *
4918 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004919 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004920 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004921 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004922 */
4923 public Intent setType(String type) {
4924 mData = null;
4925 mType = type;
4926 return this;
4927 }
4928
4929 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004930 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004931 *
Nick Pellyccae4122012-01-09 14:12:58 -08004932 * <p>This is used to create intents that only specify a type and not data,
4933 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004934 *
Nick Pellyccae4122012-01-09 14:12:58 -08004935 * <p>This method automatically clears any data that was
4936 * previously set (for example by {@link #setData}).
4937 *
4938 * <p>The MIME type is normalized using
4939 * {@link #normalizeMimeType} before it is set,
4940 * so really this is just a convenience method for
4941 * <pre>
4942 * setType(Intent.normalizeMimeType(type))
4943 * </pre>
4944 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004945 * @param type The MIME type of the data being handled by this intent.
4946 *
4947 * @return Returns the same Intent object, for chaining multiple calls
4948 * into a single statement.
4949 *
Nick Pellyccae4122012-01-09 14:12:58 -08004950 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004951 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004952 * @see #normalizeMimeType
4953 */
4954 public Intent setTypeAndNormalize(String type) {
4955 return setType(normalizeMimeType(type));
4956 }
4957
4958 /**
4959 * (Usually optional) Set the data for the intent along with an explicit
4960 * MIME data type. This method should very rarely be used -- it allows you
4961 * to override the MIME type that would ordinarily be inferred from the
4962 * data with your own type given here.
4963 *
4964 * <p><em>Note: MIME type and Uri scheme matching in the
4965 * Android framework is case-sensitive, unlike the formal RFC definitions.
4966 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004967 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004968 * {@link #setDataAndTypeAndNormalize}
4969 * to ensure that they are converted to lower case.</em>
4970 *
4971 * @param data The Uri of the data this intent is now targeting.
4972 * @param type The MIME type of the data being handled by this intent.
4973 *
4974 * @return Returns the same Intent object, for chaining multiple calls
4975 * into a single statement.
4976 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004977 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004978 * @see #setData
4979 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004980 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004981 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004982 */
4983 public Intent setDataAndType(Uri data, String type) {
4984 mData = data;
4985 mType = type;
4986 return this;
4987 }
4988
4989 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004990 * (Usually optional) Normalize and set both the data Uri and an explicit
4991 * MIME data type. This method should very rarely be used -- it allows you
4992 * to override the MIME type that would ordinarily be inferred from the
4993 * data with your own type given here.
4994 *
4995 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004996 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004997 * before they are set, so really this is just a convenience method for
4998 * <pre>
4999 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5000 * </pre>
5001 *
5002 * @param data The Uri of the data this intent is now targeting.
5003 * @param type The MIME type of the data being handled by this intent.
5004 *
5005 * @return Returns the same Intent object, for chaining multiple calls
5006 * into a single statement.
5007 *
5008 * @see #setType
5009 * @see #setData
5010 * @see #setDataAndType
5011 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005012 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005013 */
5014 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005015 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005016 }
5017
5018 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005019 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005020 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005021 * activities that provide <em>all</em> of the requested categories will be
5022 * used.
5023 *
5024 * @param category The desired category. This can be either one of the
5025 * predefined Intent categories, or a custom category in your own
5026 * namespace.
5027 *
5028 * @return Returns the same Intent object, for chaining multiple calls
5029 * into a single statement.
5030 *
5031 * @see #hasCategory
5032 * @see #removeCategory
5033 */
5034 public Intent addCategory(String category) {
5035 if (mCategories == null) {
5036 mCategories = new HashSet<String>();
5037 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005038 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005039 return this;
5040 }
5041
5042 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005043 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005044 *
5045 * @param category The category to remove.
5046 *
5047 * @see #addCategory
5048 */
5049 public void removeCategory(String category) {
5050 if (mCategories != null) {
5051 mCategories.remove(category);
5052 if (mCategories.size() == 0) {
5053 mCategories = null;
5054 }
5055 }
5056 }
5057
5058 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005059 * Set a selector for this Intent. This is a modification to the kinds of
5060 * things the Intent will match. If the selector is set, it will be used
5061 * when trying to find entities that can handle the Intent, instead of the
5062 * main contents of the Intent. This allows you build an Intent containing
5063 * a generic protocol while targeting it more specifically.
5064 *
5065 * <p>An example of where this may be used is with things like
5066 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5067 * Intent that will launch the Browser application. However, the correct
5068 * main entry point of an application is actually {@link #ACTION_MAIN}
5069 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5070 * used to specify the actual Activity to launch. If you launch the browser
5071 * with something different, undesired behavior may happen if the user has
5072 * previously or later launches it the normal way, since they do not match.
5073 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5074 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5075 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5076 *
5077 * <p>Setting a selector does not impact the behavior of
5078 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5079 * desired behavior of a selector -- it does not impact the base meaning
5080 * of the Intent, just what kinds of things will be matched against it
5081 * when determining who can handle it.</p>
5082 *
5083 * <p>You can not use both a selector and {@link #setPackage(String)} on
5084 * the same base Intent.</p>
5085 *
5086 * @param selector The desired selector Intent; set to null to not use
5087 * a special selector.
5088 */
5089 public void setSelector(Intent selector) {
5090 if (selector == this) {
5091 throw new IllegalArgumentException(
5092 "Intent being set as a selector of itself");
5093 }
5094 if (selector != null && mPackage != null) {
5095 throw new IllegalArgumentException(
5096 "Can't set selector when package name is already set");
5097 }
5098 mSelector = selector;
5099 }
5100
5101 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005102 * Set a {@link ClipData} associated with this Intent. This replaces any
5103 * previously set ClipData.
5104 *
5105 * <p>The ClipData in an intent is not used for Intent matching or other
5106 * such operations. Semantically it is like extras, used to transmit
5107 * additional data with the Intent. The main feature of using this over
5108 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5109 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5110 * items included in the clip data. This is useful, in particular, if
5111 * you want to transmit an Intent containing multiple <code>content:</code>
5112 * URIs for which the recipient may not have global permission to access the
5113 * content provider.
5114 *
5115 * <p>If the ClipData contains items that are themselves Intents, any
5116 * grant flags in those Intents will be ignored. Only the top-level flags
5117 * of the main Intent are respected, and will be applied to all Uri or
5118 * Intent items in the clip (or sub-items of the clip).
5119 *
5120 * <p>The MIME type, label, and icon in the ClipData object are not
5121 * directly used by Intent. Applications should generally rely on the
5122 * MIME type of the Intent itself, not what it may find in the ClipData.
5123 * A common practice is to construct a ClipData for use with an Intent
5124 * with a MIME type of "*\/*".
5125 *
5126 * @param clip The new clip to set. May be null to clear the current clip.
5127 */
5128 public void setClipData(ClipData clip) {
5129 mClipData = clip;
5130 }
5131
5132 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005133 * Add extended data to the intent. The name must include a package
5134 * prefix, for example the app com.android.contacts would use names
5135 * like "com.android.contacts.ShowAll".
5136 *
5137 * @param name The name of the extra data, with package prefix.
5138 * @param value The boolean data value.
5139 *
5140 * @return Returns the same Intent object, for chaining multiple calls
5141 * into a single statement.
5142 *
5143 * @see #putExtras
5144 * @see #removeExtra
5145 * @see #getBooleanExtra(String, boolean)
5146 */
5147 public Intent putExtra(String name, boolean value) {
5148 if (mExtras == null) {
5149 mExtras = new Bundle();
5150 }
5151 mExtras.putBoolean(name, value);
5152 return this;
5153 }
5154
5155 /**
5156 * Add extended data to the intent. The name must include a package
5157 * prefix, for example the app com.android.contacts would use names
5158 * like "com.android.contacts.ShowAll".
5159 *
5160 * @param name The name of the extra data, with package prefix.
5161 * @param value The byte data value.
5162 *
5163 * @return Returns the same Intent object, for chaining multiple calls
5164 * into a single statement.
5165 *
5166 * @see #putExtras
5167 * @see #removeExtra
5168 * @see #getByteExtra(String, byte)
5169 */
5170 public Intent putExtra(String name, byte value) {
5171 if (mExtras == null) {
5172 mExtras = new Bundle();
5173 }
5174 mExtras.putByte(name, value);
5175 return this;
5176 }
5177
5178 /**
5179 * Add extended data to the intent. The name must include a package
5180 * prefix, for example the app com.android.contacts would use names
5181 * like "com.android.contacts.ShowAll".
5182 *
5183 * @param name The name of the extra data, with package prefix.
5184 * @param value The char data value.
5185 *
5186 * @return Returns the same Intent object, for chaining multiple calls
5187 * into a single statement.
5188 *
5189 * @see #putExtras
5190 * @see #removeExtra
5191 * @see #getCharExtra(String, char)
5192 */
5193 public Intent putExtra(String name, char value) {
5194 if (mExtras == null) {
5195 mExtras = new Bundle();
5196 }
5197 mExtras.putChar(name, value);
5198 return this;
5199 }
5200
5201 /**
5202 * Add extended data to the intent. The name must include a package
5203 * prefix, for example the app com.android.contacts would use names
5204 * like "com.android.contacts.ShowAll".
5205 *
5206 * @param name The name of the extra data, with package prefix.
5207 * @param value The short data value.
5208 *
5209 * @return Returns the same Intent object, for chaining multiple calls
5210 * into a single statement.
5211 *
5212 * @see #putExtras
5213 * @see #removeExtra
5214 * @see #getShortExtra(String, short)
5215 */
5216 public Intent putExtra(String name, short value) {
5217 if (mExtras == null) {
5218 mExtras = new Bundle();
5219 }
5220 mExtras.putShort(name, value);
5221 return this;
5222 }
5223
5224 /**
5225 * Add extended data to the intent. The name must include a package
5226 * prefix, for example the app com.android.contacts would use names
5227 * like "com.android.contacts.ShowAll".
5228 *
5229 * @param name The name of the extra data, with package prefix.
5230 * @param value The integer data value.
5231 *
5232 * @return Returns the same Intent object, for chaining multiple calls
5233 * into a single statement.
5234 *
5235 * @see #putExtras
5236 * @see #removeExtra
5237 * @see #getIntExtra(String, int)
5238 */
5239 public Intent putExtra(String name, int value) {
5240 if (mExtras == null) {
5241 mExtras = new Bundle();
5242 }
5243 mExtras.putInt(name, value);
5244 return this;
5245 }
5246
5247 /**
5248 * Add extended data to the intent. The name must include a package
5249 * prefix, for example the app com.android.contacts would use names
5250 * like "com.android.contacts.ShowAll".
5251 *
5252 * @param name The name of the extra data, with package prefix.
5253 * @param value The long data value.
5254 *
5255 * @return Returns the same Intent object, for chaining multiple calls
5256 * into a single statement.
5257 *
5258 * @see #putExtras
5259 * @see #removeExtra
5260 * @see #getLongExtra(String, long)
5261 */
5262 public Intent putExtra(String name, long value) {
5263 if (mExtras == null) {
5264 mExtras = new Bundle();
5265 }
5266 mExtras.putLong(name, value);
5267 return this;
5268 }
5269
5270 /**
5271 * Add extended data to the intent. The name must include a package
5272 * prefix, for example the app com.android.contacts would use names
5273 * like "com.android.contacts.ShowAll".
5274 *
5275 * @param name The name of the extra data, with package prefix.
5276 * @param value The float data value.
5277 *
5278 * @return Returns the same Intent object, for chaining multiple calls
5279 * into a single statement.
5280 *
5281 * @see #putExtras
5282 * @see #removeExtra
5283 * @see #getFloatExtra(String, float)
5284 */
5285 public Intent putExtra(String name, float value) {
5286 if (mExtras == null) {
5287 mExtras = new Bundle();
5288 }
5289 mExtras.putFloat(name, value);
5290 return this;
5291 }
5292
5293 /**
5294 * Add extended data to the intent. The name must include a package
5295 * prefix, for example the app com.android.contacts would use names
5296 * like "com.android.contacts.ShowAll".
5297 *
5298 * @param name The name of the extra data, with package prefix.
5299 * @param value The double data value.
5300 *
5301 * @return Returns the same Intent object, for chaining multiple calls
5302 * into a single statement.
5303 *
5304 * @see #putExtras
5305 * @see #removeExtra
5306 * @see #getDoubleExtra(String, double)
5307 */
5308 public Intent putExtra(String name, double value) {
5309 if (mExtras == null) {
5310 mExtras = new Bundle();
5311 }
5312 mExtras.putDouble(name, value);
5313 return this;
5314 }
5315
5316 /**
5317 * Add extended data to the intent. The name must include a package
5318 * prefix, for example the app com.android.contacts would use names
5319 * like "com.android.contacts.ShowAll".
5320 *
5321 * @param name The name of the extra data, with package prefix.
5322 * @param value The String data value.
5323 *
5324 * @return Returns the same Intent object, for chaining multiple calls
5325 * into a single statement.
5326 *
5327 * @see #putExtras
5328 * @see #removeExtra
5329 * @see #getStringExtra(String)
5330 */
5331 public Intent putExtra(String name, String value) {
5332 if (mExtras == null) {
5333 mExtras = new Bundle();
5334 }
5335 mExtras.putString(name, value);
5336 return this;
5337 }
5338
5339 /**
5340 * Add extended data to the intent. The name must include a package
5341 * prefix, for example the app com.android.contacts would use names
5342 * like "com.android.contacts.ShowAll".
5343 *
5344 * @param name The name of the extra data, with package prefix.
5345 * @param value The CharSequence data value.
5346 *
5347 * @return Returns the same Intent object, for chaining multiple calls
5348 * into a single statement.
5349 *
5350 * @see #putExtras
5351 * @see #removeExtra
5352 * @see #getCharSequenceExtra(String)
5353 */
5354 public Intent putExtra(String name, CharSequence value) {
5355 if (mExtras == null) {
5356 mExtras = new Bundle();
5357 }
5358 mExtras.putCharSequence(name, value);
5359 return this;
5360 }
5361
5362 /**
5363 * Add extended data to the intent. The name must include a package
5364 * prefix, for example the app com.android.contacts would use names
5365 * like "com.android.contacts.ShowAll".
5366 *
5367 * @param name The name of the extra data, with package prefix.
5368 * @param value The Parcelable data value.
5369 *
5370 * @return Returns the same Intent object, for chaining multiple calls
5371 * into a single statement.
5372 *
5373 * @see #putExtras
5374 * @see #removeExtra
5375 * @see #getParcelableExtra(String)
5376 */
5377 public Intent putExtra(String name, Parcelable value) {
5378 if (mExtras == null) {
5379 mExtras = new Bundle();
5380 }
5381 mExtras.putParcelable(name, value);
5382 return this;
5383 }
5384
5385 /**
5386 * Add extended data to the intent. The name must include a package
5387 * prefix, for example the app com.android.contacts would use names
5388 * like "com.android.contacts.ShowAll".
5389 *
5390 * @param name The name of the extra data, with package prefix.
5391 * @param value The Parcelable[] data value.
5392 *
5393 * @return Returns the same Intent object, for chaining multiple calls
5394 * into a single statement.
5395 *
5396 * @see #putExtras
5397 * @see #removeExtra
5398 * @see #getParcelableArrayExtra(String)
5399 */
5400 public Intent putExtra(String name, Parcelable[] value) {
5401 if (mExtras == null) {
5402 mExtras = new Bundle();
5403 }
5404 mExtras.putParcelableArray(name, value);
5405 return this;
5406 }
5407
5408 /**
5409 * Add extended data to the intent. The name must include a package
5410 * prefix, for example the app com.android.contacts would use names
5411 * like "com.android.contacts.ShowAll".
5412 *
5413 * @param name The name of the extra data, with package prefix.
5414 * @param value The ArrayList<Parcelable> data value.
5415 *
5416 * @return Returns the same Intent object, for chaining multiple calls
5417 * into a single statement.
5418 *
5419 * @see #putExtras
5420 * @see #removeExtra
5421 * @see #getParcelableArrayListExtra(String)
5422 */
5423 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5424 if (mExtras == null) {
5425 mExtras = new Bundle();
5426 }
5427 mExtras.putParcelableArrayList(name, value);
5428 return this;
5429 }
5430
5431 /**
5432 * Add extended data to the intent. The name must include a package
5433 * prefix, for example the app com.android.contacts would use names
5434 * like "com.android.contacts.ShowAll".
5435 *
5436 * @param name The name of the extra data, with package prefix.
5437 * @param value The ArrayList<Integer> data value.
5438 *
5439 * @return Returns the same Intent object, for chaining multiple calls
5440 * into a single statement.
5441 *
5442 * @see #putExtras
5443 * @see #removeExtra
5444 * @see #getIntegerArrayListExtra(String)
5445 */
5446 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5447 if (mExtras == null) {
5448 mExtras = new Bundle();
5449 }
5450 mExtras.putIntegerArrayList(name, value);
5451 return this;
5452 }
5453
5454 /**
5455 * Add extended data to the intent. The name must include a package
5456 * prefix, for example the app com.android.contacts would use names
5457 * like "com.android.contacts.ShowAll".
5458 *
5459 * @param name The name of the extra data, with package prefix.
5460 * @param value The ArrayList<String> data value.
5461 *
5462 * @return Returns the same Intent object, for chaining multiple calls
5463 * into a single statement.
5464 *
5465 * @see #putExtras
5466 * @see #removeExtra
5467 * @see #getStringArrayListExtra(String)
5468 */
5469 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5470 if (mExtras == null) {
5471 mExtras = new Bundle();
5472 }
5473 mExtras.putStringArrayList(name, value);
5474 return this;
5475 }
5476
5477 /**
5478 * Add extended data to the intent. The name must include a package
5479 * prefix, for example the app com.android.contacts would use names
5480 * like "com.android.contacts.ShowAll".
5481 *
5482 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005483 * @param value The ArrayList<CharSequence> data value.
5484 *
5485 * @return Returns the same Intent object, for chaining multiple calls
5486 * into a single statement.
5487 *
5488 * @see #putExtras
5489 * @see #removeExtra
5490 * @see #getCharSequenceArrayListExtra(String)
5491 */
5492 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5493 if (mExtras == null) {
5494 mExtras = new Bundle();
5495 }
5496 mExtras.putCharSequenceArrayList(name, value);
5497 return this;
5498 }
5499
5500 /**
5501 * Add extended data to the intent. The name must include a package
5502 * prefix, for example the app com.android.contacts would use names
5503 * like "com.android.contacts.ShowAll".
5504 *
5505 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005506 * @param value The Serializable data value.
5507 *
5508 * @return Returns the same Intent object, for chaining multiple calls
5509 * into a single statement.
5510 *
5511 * @see #putExtras
5512 * @see #removeExtra
5513 * @see #getSerializableExtra(String)
5514 */
5515 public Intent putExtra(String name, Serializable value) {
5516 if (mExtras == null) {
5517 mExtras = new Bundle();
5518 }
5519 mExtras.putSerializable(name, value);
5520 return this;
5521 }
5522
5523 /**
5524 * Add extended data to the intent. The name must include a package
5525 * prefix, for example the app com.android.contacts would use names
5526 * like "com.android.contacts.ShowAll".
5527 *
5528 * @param name The name of the extra data, with package prefix.
5529 * @param value The boolean array data value.
5530 *
5531 * @return Returns the same Intent object, for chaining multiple calls
5532 * into a single statement.
5533 *
5534 * @see #putExtras
5535 * @see #removeExtra
5536 * @see #getBooleanArrayExtra(String)
5537 */
5538 public Intent putExtra(String name, boolean[] value) {
5539 if (mExtras == null) {
5540 mExtras = new Bundle();
5541 }
5542 mExtras.putBooleanArray(name, value);
5543 return this;
5544 }
5545
5546 /**
5547 * Add extended data to the intent. The name must include a package
5548 * prefix, for example the app com.android.contacts would use names
5549 * like "com.android.contacts.ShowAll".
5550 *
5551 * @param name The name of the extra data, with package prefix.
5552 * @param value The byte array data value.
5553 *
5554 * @return Returns the same Intent object, for chaining multiple calls
5555 * into a single statement.
5556 *
5557 * @see #putExtras
5558 * @see #removeExtra
5559 * @see #getByteArrayExtra(String)
5560 */
5561 public Intent putExtra(String name, byte[] value) {
5562 if (mExtras == null) {
5563 mExtras = new Bundle();
5564 }
5565 mExtras.putByteArray(name, value);
5566 return this;
5567 }
5568
5569 /**
5570 * Add extended data to the intent. The name must include a package
5571 * prefix, for example the app com.android.contacts would use names
5572 * like "com.android.contacts.ShowAll".
5573 *
5574 * @param name The name of the extra data, with package prefix.
5575 * @param value The short array data value.
5576 *
5577 * @return Returns the same Intent object, for chaining multiple calls
5578 * into a single statement.
5579 *
5580 * @see #putExtras
5581 * @see #removeExtra
5582 * @see #getShortArrayExtra(String)
5583 */
5584 public Intent putExtra(String name, short[] value) {
5585 if (mExtras == null) {
5586 mExtras = new Bundle();
5587 }
5588 mExtras.putShortArray(name, value);
5589 return this;
5590 }
5591
5592 /**
5593 * Add extended data to the intent. The name must include a package
5594 * prefix, for example the app com.android.contacts would use names
5595 * like "com.android.contacts.ShowAll".
5596 *
5597 * @param name The name of the extra data, with package prefix.
5598 * @param value The char array data value.
5599 *
5600 * @return Returns the same Intent object, for chaining multiple calls
5601 * into a single statement.
5602 *
5603 * @see #putExtras
5604 * @see #removeExtra
5605 * @see #getCharArrayExtra(String)
5606 */
5607 public Intent putExtra(String name, char[] value) {
5608 if (mExtras == null) {
5609 mExtras = new Bundle();
5610 }
5611 mExtras.putCharArray(name, value);
5612 return this;
5613 }
5614
5615 /**
5616 * Add extended data to the intent. The name must include a package
5617 * prefix, for example the app com.android.contacts would use names
5618 * like "com.android.contacts.ShowAll".
5619 *
5620 * @param name The name of the extra data, with package prefix.
5621 * @param value The int array data value.
5622 *
5623 * @return Returns the same Intent object, for chaining multiple calls
5624 * into a single statement.
5625 *
5626 * @see #putExtras
5627 * @see #removeExtra
5628 * @see #getIntArrayExtra(String)
5629 */
5630 public Intent putExtra(String name, int[] value) {
5631 if (mExtras == null) {
5632 mExtras = new Bundle();
5633 }
5634 mExtras.putIntArray(name, value);
5635 return this;
5636 }
5637
5638 /**
5639 * Add extended data to the intent. The name must include a package
5640 * prefix, for example the app com.android.contacts would use names
5641 * like "com.android.contacts.ShowAll".
5642 *
5643 * @param name The name of the extra data, with package prefix.
5644 * @param value The byte array data value.
5645 *
5646 * @return Returns the same Intent object, for chaining multiple calls
5647 * into a single statement.
5648 *
5649 * @see #putExtras
5650 * @see #removeExtra
5651 * @see #getLongArrayExtra(String)
5652 */
5653 public Intent putExtra(String name, long[] value) {
5654 if (mExtras == null) {
5655 mExtras = new Bundle();
5656 }
5657 mExtras.putLongArray(name, value);
5658 return this;
5659 }
5660
5661 /**
5662 * Add extended data to the intent. The name must include a package
5663 * prefix, for example the app com.android.contacts would use names
5664 * like "com.android.contacts.ShowAll".
5665 *
5666 * @param name The name of the extra data, with package prefix.
5667 * @param value The float array data value.
5668 *
5669 * @return Returns the same Intent object, for chaining multiple calls
5670 * into a single statement.
5671 *
5672 * @see #putExtras
5673 * @see #removeExtra
5674 * @see #getFloatArrayExtra(String)
5675 */
5676 public Intent putExtra(String name, float[] value) {
5677 if (mExtras == null) {
5678 mExtras = new Bundle();
5679 }
5680 mExtras.putFloatArray(name, value);
5681 return this;
5682 }
5683
5684 /**
5685 * Add extended data to the intent. The name must include a package
5686 * prefix, for example the app com.android.contacts would use names
5687 * like "com.android.contacts.ShowAll".
5688 *
5689 * @param name The name of the extra data, with package prefix.
5690 * @param value The double array data value.
5691 *
5692 * @return Returns the same Intent object, for chaining multiple calls
5693 * into a single statement.
5694 *
5695 * @see #putExtras
5696 * @see #removeExtra
5697 * @see #getDoubleArrayExtra(String)
5698 */
5699 public Intent putExtra(String name, double[] value) {
5700 if (mExtras == null) {
5701 mExtras = new Bundle();
5702 }
5703 mExtras.putDoubleArray(name, value);
5704 return this;
5705 }
5706
5707 /**
5708 * Add extended data to the intent. The name must include a package
5709 * prefix, for example the app com.android.contacts would use names
5710 * like "com.android.contacts.ShowAll".
5711 *
5712 * @param name The name of the extra data, with package prefix.
5713 * @param value The String array data value.
5714 *
5715 * @return Returns the same Intent object, for chaining multiple calls
5716 * into a single statement.
5717 *
5718 * @see #putExtras
5719 * @see #removeExtra
5720 * @see #getStringArrayExtra(String)
5721 */
5722 public Intent putExtra(String name, String[] value) {
5723 if (mExtras == null) {
5724 mExtras = new Bundle();
5725 }
5726 mExtras.putStringArray(name, value);
5727 return this;
5728 }
5729
5730 /**
5731 * Add extended data to the intent. The name must include a package
5732 * prefix, for example the app com.android.contacts would use names
5733 * like "com.android.contacts.ShowAll".
5734 *
5735 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005736 * @param value The CharSequence array data value.
5737 *
5738 * @return Returns the same Intent object, for chaining multiple calls
5739 * into a single statement.
5740 *
5741 * @see #putExtras
5742 * @see #removeExtra
5743 * @see #getCharSequenceArrayExtra(String)
5744 */
5745 public Intent putExtra(String name, CharSequence[] value) {
5746 if (mExtras == null) {
5747 mExtras = new Bundle();
5748 }
5749 mExtras.putCharSequenceArray(name, value);
5750 return this;
5751 }
5752
5753 /**
5754 * Add extended data to the intent. The name must include a package
5755 * prefix, for example the app com.android.contacts would use names
5756 * like "com.android.contacts.ShowAll".
5757 *
5758 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005759 * @param value The Bundle data value.
5760 *
5761 * @return Returns the same Intent object, for chaining multiple calls
5762 * into a single statement.
5763 *
5764 * @see #putExtras
5765 * @see #removeExtra
5766 * @see #getBundleExtra(String)
5767 */
5768 public Intent putExtra(String name, Bundle value) {
5769 if (mExtras == null) {
5770 mExtras = new Bundle();
5771 }
5772 mExtras.putBundle(name, value);
5773 return this;
5774 }
5775
5776 /**
5777 * Add extended data to the intent. The name must include a package
5778 * prefix, for example the app com.android.contacts would use names
5779 * like "com.android.contacts.ShowAll".
5780 *
5781 * @param name The name of the extra data, with package prefix.
5782 * @param value The IBinder data value.
5783 *
5784 * @return Returns the same Intent object, for chaining multiple calls
5785 * into a single statement.
5786 *
5787 * @see #putExtras
5788 * @see #removeExtra
5789 * @see #getIBinderExtra(String)
5790 *
5791 * @deprecated
5792 * @hide
5793 */
5794 @Deprecated
5795 public Intent putExtra(String name, IBinder value) {
5796 if (mExtras == null) {
5797 mExtras = new Bundle();
5798 }
5799 mExtras.putIBinder(name, value);
5800 return this;
5801 }
5802
5803 /**
5804 * Copy all extras in 'src' in to this intent.
5805 *
5806 * @param src Contains the extras to copy.
5807 *
5808 * @see #putExtra
5809 */
5810 public Intent putExtras(Intent src) {
5811 if (src.mExtras != null) {
5812 if (mExtras == null) {
5813 mExtras = new Bundle(src.mExtras);
5814 } else {
5815 mExtras.putAll(src.mExtras);
5816 }
5817 }
5818 return this;
5819 }
5820
5821 /**
5822 * Add a set of extended data to the intent. The keys must include a package
5823 * prefix, for example the app com.android.contacts would use names
5824 * like "com.android.contacts.ShowAll".
5825 *
5826 * @param extras The Bundle of extras to add to this intent.
5827 *
5828 * @see #putExtra
5829 * @see #removeExtra
5830 */
5831 public Intent putExtras(Bundle extras) {
5832 if (mExtras == null) {
5833 mExtras = new Bundle();
5834 }
5835 mExtras.putAll(extras);
5836 return this;
5837 }
5838
5839 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005840 * Completely replace the extras in the Intent with the extras in the
5841 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005842 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005843 * @param src The exact extras contained in this Intent are copied
5844 * into the target intent, replacing any that were previously there.
5845 */
5846 public Intent replaceExtras(Intent src) {
5847 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5848 return this;
5849 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005850
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005851 /**
5852 * Completely replace the extras in the Intent with the given Bundle of
5853 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005854 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005855 * @param extras The new set of extras in the Intent, or null to erase
5856 * all extras.
5857 */
5858 public Intent replaceExtras(Bundle extras) {
5859 mExtras = extras != null ? new Bundle(extras) : null;
5860 return this;
5861 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005862
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005863 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005864 * Remove extended data from the intent.
5865 *
5866 * @see #putExtra
5867 */
5868 public void removeExtra(String name) {
5869 if (mExtras != null) {
5870 mExtras.remove(name);
5871 if (mExtras.size() == 0) {
5872 mExtras = null;
5873 }
5874 }
5875 }
5876
5877 /**
5878 * Set special flags controlling how this intent is handled. Most values
5879 * here depend on the type of component being executed by the Intent,
5880 * specifically the FLAG_ACTIVITY_* flags are all for use with
5881 * {@link Context#startActivity Context.startActivity()} and the
5882 * FLAG_RECEIVER_* flags are all for use with
5883 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5884 *
Scott Main7aee61f2011-02-08 11:25:01 -08005885 * <p>See the
5886 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5887 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005888 * the behavior of your application.
5889 *
5890 * @param flags The desired flags.
5891 *
5892 * @return Returns the same Intent object, for chaining multiple calls
5893 * into a single statement.
5894 *
5895 * @see #getFlags
5896 * @see #addFlags
5897 *
5898 * @see #FLAG_GRANT_READ_URI_PERMISSION
5899 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5900 * @see #FLAG_DEBUG_LOG_RESOLUTION
5901 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005902 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005903 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005904 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005905 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005906 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5907 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005908 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005909 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5910 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005911 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005912 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005913 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005914 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5915 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005916 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005917 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005918 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005919 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5920 */
5921 public Intent setFlags(int flags) {
5922 mFlags = flags;
5923 return this;
5924 }
5925
5926 /**
5927 * Add additional flags to the intent (or with existing flags
5928 * value).
5929 *
5930 * @param flags The new flags to set.
5931 *
5932 * @return Returns the same Intent object, for chaining multiple calls
5933 * into a single statement.
5934 *
5935 * @see #setFlags
5936 */
5937 public Intent addFlags(int flags) {
5938 mFlags |= flags;
5939 return this;
5940 }
5941
5942 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005943 * (Usually optional) Set an explicit application package name that limits
5944 * the components this Intent will resolve to. If left to the default
5945 * value of null, all components in all applications will considered.
5946 * If non-null, the Intent can only match the components in the given
5947 * application package.
5948 *
5949 * @param packageName The name of the application package to handle the
5950 * intent, or null to allow any application package.
5951 *
5952 * @return Returns the same Intent object, for chaining multiple calls
5953 * into a single statement.
5954 *
5955 * @see #getPackage
5956 * @see #resolveActivity
5957 */
5958 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005959 if (packageName != null && mSelector != null) {
5960 throw new IllegalArgumentException(
5961 "Can't set package name when selector is already set");
5962 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005963 mPackage = packageName;
5964 return this;
5965 }
5966
5967 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005968 * (Usually optional) Explicitly set the component to handle the intent.
5969 * If left with the default value of null, the system will determine the
5970 * appropriate class to use based on the other fields (action, data,
5971 * type, categories) in the Intent. If this class is defined, the
5972 * specified class will always be used regardless of the other fields. You
5973 * should only set this value when you know you absolutely want a specific
5974 * class to be used; otherwise it is better to let the system find the
5975 * appropriate class so that you will respect the installed applications
5976 * and user preferences.
5977 *
5978 * @param component The name of the application component to handle the
5979 * intent, or null to let the system find one for you.
5980 *
5981 * @return Returns the same Intent object, for chaining multiple calls
5982 * into a single statement.
5983 *
5984 * @see #setClass
5985 * @see #setClassName(Context, String)
5986 * @see #setClassName(String, String)
5987 * @see #getComponent
5988 * @see #resolveActivity
5989 */
5990 public Intent setComponent(ComponentName component) {
5991 mComponent = component;
5992 return this;
5993 }
5994
5995 /**
5996 * Convenience for calling {@link #setComponent} with an
5997 * explicit class name.
5998 *
5999 * @param packageContext A Context of the application package implementing
6000 * this class.
6001 * @param className The name of a class inside of the application package
6002 * that will be used as the component for this Intent.
6003 *
6004 * @return Returns the same Intent object, for chaining multiple calls
6005 * into a single statement.
6006 *
6007 * @see #setComponent
6008 * @see #setClass
6009 */
6010 public Intent setClassName(Context packageContext, String className) {
6011 mComponent = new ComponentName(packageContext, className);
6012 return this;
6013 }
6014
6015 /**
6016 * Convenience for calling {@link #setComponent} with an
6017 * explicit application package name and class name.
6018 *
6019 * @param packageName The name of the package implementing the desired
6020 * component.
6021 * @param className The name of a class inside of the application package
6022 * that will be used as the component for this Intent.
6023 *
6024 * @return Returns the same Intent object, for chaining multiple calls
6025 * into a single statement.
6026 *
6027 * @see #setComponent
6028 * @see #setClass
6029 */
6030 public Intent setClassName(String packageName, String className) {
6031 mComponent = new ComponentName(packageName, className);
6032 return this;
6033 }
6034
6035 /**
6036 * Convenience for calling {@link #setComponent(ComponentName)} with the
6037 * name returned by a {@link Class} object.
6038 *
6039 * @param packageContext A Context of the application package implementing
6040 * this class.
6041 * @param cls The class name to set, equivalent to
6042 * <code>setClassName(context, cls.getName())</code>.
6043 *
6044 * @return Returns the same Intent object, for chaining multiple calls
6045 * into a single statement.
6046 *
6047 * @see #setComponent
6048 */
6049 public Intent setClass(Context packageContext, Class<?> cls) {
6050 mComponent = new ComponentName(packageContext, cls);
6051 return this;
6052 }
6053
6054 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006055 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6056 * used as a hint to the receiver for animations and the like. Null means that there
6057 * is no source bounds.
6058 */
6059 public void setSourceBounds(Rect r) {
6060 if (r != null) {
6061 mSourceBounds = new Rect(r);
6062 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006063 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006064 }
6065 }
6066
6067 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006068 * Use with {@link #fillIn} to allow the current action value to be
6069 * overwritten, even if it is already set.
6070 */
6071 public static final int FILL_IN_ACTION = 1<<0;
6072
6073 /**
6074 * Use with {@link #fillIn} to allow the current data or type value
6075 * overwritten, even if it is already set.
6076 */
6077 public static final int FILL_IN_DATA = 1<<1;
6078
6079 /**
6080 * Use with {@link #fillIn} to allow the current categories to be
6081 * overwritten, even if they are already set.
6082 */
6083 public static final int FILL_IN_CATEGORIES = 1<<2;
6084
6085 /**
6086 * Use with {@link #fillIn} to allow the current component value to be
6087 * overwritten, even if it is already set.
6088 */
6089 public static final int FILL_IN_COMPONENT = 1<<3;
6090
6091 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006092 * Use with {@link #fillIn} to allow the current package value to be
6093 * overwritten, even if it is already set.
6094 */
6095 public static final int FILL_IN_PACKAGE = 1<<4;
6096
6097 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006098 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006099 * overwritten, even if it is already set.
6100 */
6101 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6102
6103 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006104 * Use with {@link #fillIn} to allow the current selector to be
6105 * overwritten, even if it is already set.
6106 */
6107 public static final int FILL_IN_SELECTOR = 1<<6;
6108
6109 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006110 * Use with {@link #fillIn} to allow the current ClipData to be
6111 * overwritten, even if it is already set.
6112 */
6113 public static final int FILL_IN_CLIP_DATA = 1<<7;
6114
6115 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006116 * Copy the contents of <var>other</var> in to this object, but only
6117 * where fields are not defined by this object. For purposes of a field
6118 * being defined, the following pieces of data in the Intent are
6119 * considered to be separate fields:
6120 *
6121 * <ul>
6122 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006123 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006124 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6125 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006126 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006127 * <li> component, as set by {@link #setComponent(ComponentName)} or
6128 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006129 * <li> source bounds, as set by {@link #setSourceBounds}.
6130 * <li> selector, as set by {@link #setSelector(Intent)}.
6131 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006132 * <li> each top-level name in the associated extras.
6133 * </ul>
6134 *
6135 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006136 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006137 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6138 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6139 * the restriction where the corresponding field will not be replaced if
6140 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006141 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006142 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6143 * is explicitly specified. The selector will only be copied if
6144 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006145 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006146 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6147 * and Intent B with {action="gotit", data-type="some/thing",
6148 * categories="one","two"}.
6149 *
6150 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6151 * containing: {action="gotit", data-type="some/thing",
6152 * categories="bar"}.
6153 *
6154 * @param other Another Intent whose values are to be used to fill in
6155 * the current one.
6156 * @param flags Options to control which fields can be filled in.
6157 *
6158 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006159 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006160 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6161 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006162 */
6163 public int fillIn(Intent other, int flags) {
6164 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006165 if (other.mAction != null
6166 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006167 mAction = other.mAction;
6168 changes |= FILL_IN_ACTION;
6169 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006170 if ((other.mData != null || other.mType != null)
6171 && ((mData == null && mType == null)
6172 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006173 mData = other.mData;
6174 mType = other.mType;
6175 changes |= FILL_IN_DATA;
6176 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006177 if (other.mCategories != null
6178 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006179 if (other.mCategories != null) {
6180 mCategories = new HashSet<String>(other.mCategories);
6181 }
6182 changes |= FILL_IN_CATEGORIES;
6183 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006184 if (other.mPackage != null
6185 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006186 // Only do this if mSelector is not set.
6187 if (mSelector == null) {
6188 mPackage = other.mPackage;
6189 changes |= FILL_IN_PACKAGE;
6190 }
6191 }
6192 // Selector is special: it can only be set if explicitly allowed,
6193 // for the same reason as the component name.
6194 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6195 if (mPackage == null) {
6196 mSelector = new Intent(other.mSelector);
6197 mPackage = null;
6198 changes |= FILL_IN_SELECTOR;
6199 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006200 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006201 if (other.mClipData != null
6202 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6203 mClipData = other.mClipData;
6204 changes |= FILL_IN_CLIP_DATA;
6205 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006206 // Component is special: it can -only- be set if explicitly allowed,
6207 // since otherwise the sender could force the intent somewhere the
6208 // originator didn't intend.
6209 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006210 mComponent = other.mComponent;
6211 changes |= FILL_IN_COMPONENT;
6212 }
6213 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006214 if (other.mSourceBounds != null
6215 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6216 mSourceBounds = new Rect(other.mSourceBounds);
6217 changes |= FILL_IN_SOURCE_BOUNDS;
6218 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006219 if (mExtras == null) {
6220 if (other.mExtras != null) {
6221 mExtras = new Bundle(other.mExtras);
6222 }
6223 } else if (other.mExtras != null) {
6224 try {
6225 Bundle newb = new Bundle(other.mExtras);
6226 newb.putAll(mExtras);
6227 mExtras = newb;
6228 } catch (RuntimeException e) {
6229 // Modifying the extras can cause us to unparcel the contents
6230 // of the bundle, and if we do this in the system process that
6231 // may fail. We really should handle this (i.e., the Bundle
6232 // impl shouldn't be on top of a plain map), but for now just
6233 // ignore it and keep the original contents. :(
6234 Log.w("Intent", "Failure filling in extras", e);
6235 }
6236 }
6237 return changes;
6238 }
6239
6240 /**
6241 * Wrapper class holding an Intent and implementing comparisons on it for
6242 * the purpose of filtering. The class implements its
6243 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6244 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6245 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6246 * on the wrapped Intent.
6247 */
6248 public static final class FilterComparison {
6249 private final Intent mIntent;
6250 private final int mHashCode;
6251
6252 public FilterComparison(Intent intent) {
6253 mIntent = intent;
6254 mHashCode = intent.filterHashCode();
6255 }
6256
6257 /**
6258 * Return the Intent that this FilterComparison represents.
6259 * @return Returns the Intent held by the FilterComparison. Do
6260 * not modify!
6261 */
6262 public Intent getIntent() {
6263 return mIntent;
6264 }
6265
6266 @Override
6267 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006268 if (obj instanceof FilterComparison) {
6269 Intent other = ((FilterComparison)obj).mIntent;
6270 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006271 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006272 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006273 }
6274
6275 @Override
6276 public int hashCode() {
6277 return mHashCode;
6278 }
6279 }
6280
6281 /**
6282 * Determine if two intents are the same for the purposes of intent
6283 * resolution (filtering). That is, if their action, data, type,
6284 * class, and categories are the same. This does <em>not</em> compare
6285 * any extra data included in the intents.
6286 *
6287 * @param other The other Intent to compare against.
6288 *
6289 * @return Returns true if action, data, type, class, and categories
6290 * are the same.
6291 */
6292 public boolean filterEquals(Intent other) {
6293 if (other == null) {
6294 return false;
6295 }
6296 if (mAction != other.mAction) {
6297 if (mAction != null) {
6298 if (!mAction.equals(other.mAction)) {
6299 return false;
6300 }
6301 } else {
6302 if (!other.mAction.equals(mAction)) {
6303 return false;
6304 }
6305 }
6306 }
6307 if (mData != other.mData) {
6308 if (mData != null) {
6309 if (!mData.equals(other.mData)) {
6310 return false;
6311 }
6312 } else {
6313 if (!other.mData.equals(mData)) {
6314 return false;
6315 }
6316 }
6317 }
6318 if (mType != other.mType) {
6319 if (mType != null) {
6320 if (!mType.equals(other.mType)) {
6321 return false;
6322 }
6323 } else {
6324 if (!other.mType.equals(mType)) {
6325 return false;
6326 }
6327 }
6328 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006329 if (mPackage != other.mPackage) {
6330 if (mPackage != null) {
6331 if (!mPackage.equals(other.mPackage)) {
6332 return false;
6333 }
6334 } else {
6335 if (!other.mPackage.equals(mPackage)) {
6336 return false;
6337 }
6338 }
6339 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006340 if (mComponent != other.mComponent) {
6341 if (mComponent != null) {
6342 if (!mComponent.equals(other.mComponent)) {
6343 return false;
6344 }
6345 } else {
6346 if (!other.mComponent.equals(mComponent)) {
6347 return false;
6348 }
6349 }
6350 }
6351 if (mCategories != other.mCategories) {
6352 if (mCategories != null) {
6353 if (!mCategories.equals(other.mCategories)) {
6354 return false;
6355 }
6356 } else {
6357 if (!other.mCategories.equals(mCategories)) {
6358 return false;
6359 }
6360 }
6361 }
6362
6363 return true;
6364 }
6365
6366 /**
6367 * Generate hash code that matches semantics of filterEquals().
6368 *
6369 * @return Returns the hash value of the action, data, type, class, and
6370 * categories.
6371 *
6372 * @see #filterEquals
6373 */
6374 public int filterHashCode() {
6375 int code = 0;
6376 if (mAction != null) {
6377 code += mAction.hashCode();
6378 }
6379 if (mData != null) {
6380 code += mData.hashCode();
6381 }
6382 if (mType != null) {
6383 code += mType.hashCode();
6384 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006385 if (mPackage != null) {
6386 code += mPackage.hashCode();
6387 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006388 if (mComponent != null) {
6389 code += mComponent.hashCode();
6390 }
6391 if (mCategories != null) {
6392 code += mCategories.hashCode();
6393 }
6394 return code;
6395 }
6396
6397 @Override
6398 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006399 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006400
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006401 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006402 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006403 b.append(" }");
6404
6405 return b.toString();
6406 }
6407
6408 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006409 public String toInsecureString() {
6410 StringBuilder b = new StringBuilder(128);
6411
6412 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006413 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006414 b.append(" }");
6415
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006416 return b.toString();
6417 }
Romain Guy4969af72009-06-17 10:53:19 -07006418
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006419 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006420 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006421 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006422
6423 b.append("Intent { ");
6424 toShortString(b, false, true, true, true);
6425 b.append(" }");
6426
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006427 return b.toString();
6428 }
6429
6430 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006431 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6432 StringBuilder b = new StringBuilder(128);
6433 toShortString(b, secure, comp, extras, clip);
6434 return b.toString();
6435 }
6436
6437 /** @hide */
6438 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6439 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006440 boolean first = true;
6441 if (mAction != null) {
6442 b.append("act=").append(mAction);
6443 first = false;
6444 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006445 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006446 if (!first) {
6447 b.append(' ');
6448 }
6449 first = false;
6450 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006451 Iterator<String> i = mCategories.iterator();
6452 boolean didone = false;
6453 while (i.hasNext()) {
6454 if (didone) b.append(",");
6455 didone = true;
6456 b.append(i.next());
6457 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006458 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006459 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006460 if (mData != null) {
6461 if (!first) {
6462 b.append(' ');
6463 }
6464 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006465 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006466 if (secure) {
6467 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006468 } else {
6469 b.append(mData);
6470 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006471 }
6472 if (mType != null) {
6473 if (!first) {
6474 b.append(' ');
6475 }
6476 first = false;
6477 b.append("typ=").append(mType);
6478 }
6479 if (mFlags != 0) {
6480 if (!first) {
6481 b.append(' ');
6482 }
6483 first = false;
6484 b.append("flg=0x").append(Integer.toHexString(mFlags));
6485 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006486 if (mPackage != null) {
6487 if (!first) {
6488 b.append(' ');
6489 }
6490 first = false;
6491 b.append("pkg=").append(mPackage);
6492 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006493 if (comp && mComponent != null) {
6494 if (!first) {
6495 b.append(' ');
6496 }
6497 first = false;
6498 b.append("cmp=").append(mComponent.flattenToShortString());
6499 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006500 if (mSourceBounds != null) {
6501 if (!first) {
6502 b.append(' ');
6503 }
6504 first = false;
6505 b.append("bnds=").append(mSourceBounds.toShortString());
6506 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006507 if (mClipData != null) {
6508 if (!first) {
6509 b.append(' ');
6510 }
6511 first = false;
6512 if (clip) {
6513 b.append("clip={");
6514 mClipData.toShortString(b);
6515 b.append('}');
6516 } else {
6517 b.append("(has clip)");
6518 }
6519 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006520 if (extras && mExtras != null) {
6521 if (!first) {
6522 b.append(' ');
6523 }
6524 first = false;
6525 b.append("(has extras)");
6526 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006527 if (mSelector != null) {
6528 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006529 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006530 b.append("}");
6531 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006532 }
6533
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006534 /**
6535 * Call {@link #toUri} with 0 flags.
6536 * @deprecated Use {@link #toUri} instead.
6537 */
6538 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006539 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006540 return toUri(0);
6541 }
6542
6543 /**
6544 * Convert this Intent into a String holding a URI representation of it.
6545 * The returned URI string has been properly URI encoded, so it can be
6546 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6547 * Intent's data as the base URI, with an additional fragment describing
6548 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006549 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006550 * <p>You can convert the returned string back to an Intent with
6551 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006552 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006553 * @param flags Additional operating flags. Either 0 or
6554 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006555 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006556 * @return Returns a URI encoding URI string describing the entire contents
6557 * of the Intent.
6558 */
6559 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006560 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006561 String scheme = null;
6562 if (mData != null) {
6563 String data = mData.toString();
6564 if ((flags&URI_INTENT_SCHEME) != 0) {
6565 final int N = data.length();
6566 for (int i=0; i<N; i++) {
6567 char c = data.charAt(i);
6568 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6569 || c == '.' || c == '-') {
6570 continue;
6571 }
6572 if (c == ':' && i > 0) {
6573 // Valid scheme.
6574 scheme = data.substring(0, i);
6575 uri.append("intent:");
6576 data = data.substring(i+1);
6577 break;
6578 }
Tom Taylord4a47292009-12-21 13:59:18 -08006579
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006580 // No scheme.
6581 break;
6582 }
6583 }
6584 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006585
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006586 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6587 uri.append("intent:");
6588 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006589
6590 uri.append("#Intent;");
6591
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006592 toUriInner(uri, scheme, flags);
6593 if (mSelector != null) {
6594 uri.append("SEL;");
6595 // Note that for now we are not going to try to handle the
6596 // data part; not clear how to represent this as a URI, and
6597 // not much utility in it.
6598 mSelector.toUriInner(uri, null, flags);
6599 }
6600
6601 uri.append("end");
6602
6603 return uri.toString();
6604 }
6605
6606 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006607 if (scheme != null) {
6608 uri.append("scheme=").append(scheme).append(';');
6609 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006610 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006611 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006612 }
6613 if (mCategories != null) {
6614 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006615 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006616 }
6617 }
6618 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006619 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006620 }
6621 if (mFlags != 0) {
6622 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6623 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006624 if (mPackage != null) {
6625 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6626 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006627 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006628 uri.append("component=").append(Uri.encode(
6629 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006630 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006631 if (mSourceBounds != null) {
6632 uri.append("sourceBounds=")
6633 .append(Uri.encode(mSourceBounds.flattenToString()))
6634 .append(';');
6635 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006636 if (mExtras != null) {
6637 for (String key : mExtras.keySet()) {
6638 final Object value = mExtras.get(key);
6639 char entryType =
6640 value instanceof String ? 'S' :
6641 value instanceof Boolean ? 'B' :
6642 value instanceof Byte ? 'b' :
6643 value instanceof Character ? 'c' :
6644 value instanceof Double ? 'd' :
6645 value instanceof Float ? 'f' :
6646 value instanceof Integer ? 'i' :
6647 value instanceof Long ? 'l' :
6648 value instanceof Short ? 's' :
6649 '\0';
6650
6651 if (entryType != '\0') {
6652 uri.append(entryType);
6653 uri.append('.');
6654 uri.append(Uri.encode(key));
6655 uri.append('=');
6656 uri.append(Uri.encode(value.toString()));
6657 uri.append(';');
6658 }
6659 }
6660 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006661 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006663 public int describeContents() {
6664 return (mExtras != null) ? mExtras.describeContents() : 0;
6665 }
6666
6667 public void writeToParcel(Parcel out, int flags) {
6668 out.writeString(mAction);
6669 Uri.writeToParcel(out, mData);
6670 out.writeString(mType);
6671 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006672 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006673 ComponentName.writeToParcel(mComponent, out);
6674
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006675 if (mSourceBounds != null) {
6676 out.writeInt(1);
6677 mSourceBounds.writeToParcel(out, flags);
6678 } else {
6679 out.writeInt(0);
6680 }
6681
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006682 if (mCategories != null) {
6683 out.writeInt(mCategories.size());
6684 for (String category : mCategories) {
6685 out.writeString(category);
6686 }
6687 } else {
6688 out.writeInt(0);
6689 }
6690
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006691 if (mSelector != null) {
6692 out.writeInt(1);
6693 mSelector.writeToParcel(out, flags);
6694 } else {
6695 out.writeInt(0);
6696 }
6697
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006698 if (mClipData != null) {
6699 out.writeInt(1);
6700 mClipData.writeToParcel(out, flags);
6701 } else {
6702 out.writeInt(0);
6703 }
6704
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006705 out.writeBundle(mExtras);
6706 }
6707
6708 public static final Parcelable.Creator<Intent> CREATOR
6709 = new Parcelable.Creator<Intent>() {
6710 public Intent createFromParcel(Parcel in) {
6711 return new Intent(in);
6712 }
6713 public Intent[] newArray(int size) {
6714 return new Intent[size];
6715 }
6716 };
6717
Dianne Hackborneb034652009-09-07 00:49:58 -07006718 /** @hide */
6719 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006720 readFromParcel(in);
6721 }
6722
6723 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006724 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006725 mData = Uri.CREATOR.createFromParcel(in);
6726 mType = in.readString();
6727 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006728 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006729 mComponent = ComponentName.readFromParcel(in);
6730
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006731 if (in.readInt() != 0) {
6732 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6733 }
6734
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006735 int N = in.readInt();
6736 if (N > 0) {
6737 mCategories = new HashSet<String>();
6738 int i;
6739 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006740 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006741 }
6742 } else {
6743 mCategories = null;
6744 }
6745
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006746 if (in.readInt() != 0) {
6747 mSelector = new Intent(in);
6748 }
6749
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006750 if (in.readInt() != 0) {
6751 mClipData = new ClipData(in);
6752 }
6753
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006754 mExtras = in.readBundle();
6755 }
6756
6757 /**
6758 * Parses the "intent" element (and its children) from XML and instantiates
6759 * an Intent object. The given XML parser should be located at the tag
6760 * where parsing should start (often named "intent"), from which the
6761 * basic action, data, type, and package and class name will be
6762 * retrieved. The function will then parse in to any child elements,
6763 * looking for <category android:name="xxx"> tags to add categories and
6764 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6765 * to the intent.
6766 *
6767 * @param resources The Resources to use when inflating resources.
6768 * @param parser The XML parser pointing at an "intent" tag.
6769 * @param attrs The AttributeSet interface for retrieving extended
6770 * attribute data at the current <var>parser</var> location.
6771 * @return An Intent object matching the XML data.
6772 * @throws XmlPullParserException If there was an XML parsing error.
6773 * @throws IOException If there was an I/O error.
6774 */
6775 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6776 throws XmlPullParserException, IOException {
6777 Intent intent = new Intent();
6778
6779 TypedArray sa = resources.obtainAttributes(attrs,
6780 com.android.internal.R.styleable.Intent);
6781
6782 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6783
6784 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6785 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6786 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6787
6788 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6789 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6790 if (packageName != null && className != null) {
6791 intent.setComponent(new ComponentName(packageName, className));
6792 }
6793
6794 sa.recycle();
6795
6796 int outerDepth = parser.getDepth();
6797 int type;
6798 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6799 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6800 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6801 continue;
6802 }
6803
6804 String nodeName = parser.getName();
6805 if (nodeName.equals("category")) {
6806 sa = resources.obtainAttributes(attrs,
6807 com.android.internal.R.styleable.IntentCategory);
6808 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6809 sa.recycle();
6810
6811 if (cat != null) {
6812 intent.addCategory(cat);
6813 }
6814 XmlUtils.skipCurrentTag(parser);
6815
6816 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006817 if (intent.mExtras == null) {
6818 intent.mExtras = new Bundle();
6819 }
6820 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6821 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006822
6823 } else {
6824 XmlUtils.skipCurrentTag(parser);
6825 }
6826 }
6827
6828 return intent;
6829 }
Nick Pellyccae4122012-01-09 14:12:58 -08006830
6831 /**
6832 * Normalize a MIME data type.
6833 *
6834 * <p>A normalized MIME type has white-space trimmed,
6835 * content-type parameters removed, and is lower-case.
6836 * This aligns the type with Android best practices for
6837 * intent filtering.
6838 *
6839 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6840 * "text/x-vCard" becomes "text/x-vcard".
6841 *
6842 * <p>All MIME types received from outside Android (such as user input,
6843 * or external sources like Bluetooth, NFC, or the Internet) should
6844 * be normalized before they are used to create an Intent.
6845 *
6846 * @param type MIME data type to normalize
6847 * @return normalized MIME data type, or null if the input was null
6848 * @see {@link #setType}
6849 * @see {@link #setTypeAndNormalize}
6850 */
6851 public static String normalizeMimeType(String type) {
6852 if (type == null) {
6853 return null;
6854 }
6855
6856 type = type.trim().toLowerCase(Locale.US);
6857
6858 final int semicolonIndex = type.indexOf(';');
6859 if (semicolonIndex != -1) {
6860 type = type.substring(0, semicolonIndex);
6861 }
6862 return type;
6863 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006864
6865 /**
6866 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006867 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6868 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006869 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006870 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006871 * @hide
6872 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006873 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006874 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006875 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006876
6877 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006878 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006879
6880 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006881 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006882 try {
6883 // Inspect target intent to see if we need to migrate
6884 final Intent target = getParcelableExtra(EXTRA_INTENT);
6885 if (target != null && target.migrateExtraStreamToClipData()) {
6886 // Since we migrated in child, we need to promote ClipData
6887 // and flags to ourselves to grant.
6888 setClipData(target.getClipData());
6889 addFlags(target.getFlags()
6890 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6891 return true;
6892 } else {
6893 return false;
6894 }
6895 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006896 }
6897
6898 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006899 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006900 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6901 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6902 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6903 if (stream != null || text != null || htmlText != null) {
6904 final ClipData clipData = new ClipData(
6905 null, new String[] { getType() },
6906 new ClipData.Item(text, htmlText, null, stream));
6907 setClipData(clipData);
6908 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006909 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006910 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006911 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006912 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006913
6914 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006915 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006916 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6917 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6918 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6919 int num = -1;
6920 if (streams != null) {
6921 num = streams.size();
6922 }
6923 if (texts != null) {
6924 if (num >= 0 && num != texts.size()) {
6925 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006926 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006927 }
6928 num = texts.size();
6929 }
6930 if (htmlTexts != null) {
6931 if (num >= 0 && num != htmlTexts.size()) {
6932 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006933 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006934 }
6935 num = htmlTexts.size();
6936 }
6937 if (num > 0) {
6938 final ClipData clipData = new ClipData(
6939 null, new String[] { getType() },
6940 makeClipItem(streams, texts, htmlTexts, 0));
6941
6942 for (int i = 1; i < num; i++) {
6943 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6944 }
6945
6946 setClipData(clipData);
6947 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006948 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006949 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006950 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006951 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006952 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006953
6954 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006955 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006956
6957 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6958 ArrayList<String> htmlTexts, int which) {
6959 Uri uri = streams != null ? streams.get(which) : null;
6960 CharSequence text = texts != null ? texts.get(which) : null;
6961 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6962 return new ClipData.Item(text, htmlText, null, uri);
6963 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006964}