blob: bbf3b69b0b1437fe00208fee14e3cc35da787750 [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 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002322 * Broadcast Action: A broadcast when idle maintenance can be started.
2323 * This means that the user is not interacting with the device and is
2324 * not expected to do so soon. Typical use of the idle maintenance is
2325 * to perform somehow expensive tasks that can be postponed at a moment
2326 * when they will not degrade user experience.
2327 * <p>
2328 * <p class="note">In order to keep the device responsive in case of an
2329 * unexpected user interaction, implementations of a maintenance task
2330 * should be interruptible. In such a scenario a broadcast with action
2331 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2332 * should not do the maintenance work in
2333 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2334 * maintenance service by {@link Context#startService(Intent)}. Also
2335 * you should hold a wake lock while your maintenance service is running
2336 * to prevent the device going to sleep.
2337 * </p>
2338 * <p>
2339 * <p class="note">This is a protected intent that can only be sent by
2340 * the system.
2341 * </p>
2342 *
2343 * @see #ACTION_IDLE_MAINTENANCE_END
2344 */
2345 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2346 public static final String ACTION_IDLE_MAINTENANCE_START =
2347 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2348
2349 /**
2350 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2351 * This means that the user was not interacting with the device as a result
2352 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2353 * was sent and now the user started interacting with the device. Typical
2354 * use of the idle maintenance is to perform somehow expensive tasks that
2355 * can be postponed at a moment when they will not degrade user experience.
2356 * <p>
2357 * <p class="note">In order to keep the device responsive in case of an
2358 * unexpected user interaction, implementations of a maintenance task
2359 * should be interruptible. Hence, on receiving a broadcast with this
2360 * action, the maintenance task should be interrupted as soon as possible.
2361 * In other words, you should not do the maintenance work in
2362 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2363 * maintenance service that was started on receiving of
2364 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2365 * lock you acquired when your maintenance service started.
2366 * </p>
2367 * <p class="note">This is a protected intent that can only be sent
2368 * by the system.
2369 *
2370 * @see #ACTION_IDLE_MAINTENANCE_START
2371 */
2372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2373 public static final String ACTION_IDLE_MAINTENANCE_END =
2374 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2375
2376 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002377 * Broadcast Action: a remote intent is to be broadcasted.
2378 *
2379 * A remote intent is used for remote RPC between devices. The remote intent
2380 * is serialized and sent from one device to another device. The receiving
2381 * device parses the remote intent and broadcasts it. Note that anyone can
2382 * broadcast a remote intent. However, if the intent receiver of the remote intent
2383 * does not trust intent broadcasts from arbitrary intent senders, it should require
2384 * the sender to hold certain permissions so only trusted sender's broadcast will be
2385 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002386 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002387 */
2388 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002389 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002390
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002391 /**
2392 * Broadcast Action: hook for permforming cleanup after a system update.
2393 *
2394 * The broadcast is sent when the system is booting, before the
2395 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2396 * image. A receiver for this should do its work and then disable itself
2397 * so that it does not get run again at the next boot.
2398 * @hide
2399 */
2400 public static final String ACTION_PRE_BOOT_COMPLETED =
2401 "android.intent.action.PRE_BOOT_COMPLETED";
2402
Amith Yamasani13593602012-03-22 16:16:17 -07002403 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002404 * Sent the first time a user is starting, to allow system apps to
2405 * perform one time initialization. (This will not be seen by third
2406 * party applications because a newly initialized user does not have any
2407 * third party applications installed for it.) This is sent early in
2408 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002409 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2410 * broadcast, since it is part of a visible user interaction; be as quick
2411 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002412 */
2413 public static final String ACTION_USER_INITIALIZE =
2414 "android.intent.action.USER_INITIALIZE";
2415
2416 /**
2417 * Sent when a user switch is happening, causing the process's user to be
2418 * brought to the foreground. This is only sent to receivers registered
2419 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2420 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002421 * foreground. This is sent as a foreground
2422 * broadcast, since it is part of a visible user interaction; be as quick
2423 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002424 */
2425 public static final String ACTION_USER_FOREGROUND =
2426 "android.intent.action.USER_FOREGROUND";
2427
2428 /**
2429 * Sent when a user switch is happening, causing the process's user to be
2430 * sent to the background. This is only sent to receivers registered
2431 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2432 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002433 * background. This is sent as a foreground
2434 * broadcast, since it is part of a visible user interaction; be as quick
2435 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002436 */
2437 public static final String ACTION_USER_BACKGROUND =
2438 "android.intent.action.USER_BACKGROUND";
2439
2440 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002441 * Broadcast sent to the system when a user is added. Carries an extra
2442 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2443 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002444 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002445 * @hide
2446 */
2447 public static final String ACTION_USER_ADDED =
2448 "android.intent.action.USER_ADDED";
2449
2450 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002451 * Broadcast sent by the system when a user is started. Carries an extra
2452 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002453 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002454 * that has been started. This is sent as a foreground
2455 * broadcast, since it is part of a visible user interaction; be as quick
2456 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002457 * @hide
2458 */
2459 public static final String ACTION_USER_STARTED =
2460 "android.intent.action.USER_STARTED";
2461
2462 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002463 * Broadcast sent when a user is in the process of starting. Carries an extra
2464 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2465 * sent to registered receivers, not manifest receivers. It is sent to all
2466 * users (including the one that is being started). You must hold
2467 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2468 * this broadcast. This is sent as a background broadcast, since
2469 * its result is not part of the primary UX flow; to safely keep track of
2470 * started/stopped state of a user you can use this in conjunction with
2471 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2472 * other user state broadcasts since those are foreground broadcasts so can
2473 * execute in a different order.
2474 * @hide
2475 */
2476 public static final String ACTION_USER_STARTING =
2477 "android.intent.action.USER_STARTING";
2478
2479 /**
2480 * Broadcast sent when a user is going to be stopped. Carries an extra
2481 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2482 * sent to registered receivers, not manifest receivers. It is sent to all
2483 * users (including the one that is being stopped). You must hold
2484 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2485 * this broadcast. The user will not stop until all receivers have
2486 * handled the broadcast. This is sent as a background broadcast, since
2487 * its result is not part of the primary UX flow; to safely keep track of
2488 * started/stopped state of a user you can use this in conjunction with
2489 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2490 * other user state broadcasts since those are foreground broadcasts so can
2491 * execute in a different order.
2492 * @hide
2493 */
2494 public static final String ACTION_USER_STOPPING =
2495 "android.intent.action.USER_STOPPING";
2496
2497 /**
2498 * Broadcast sent to the system when a user is stopped. Carries an extra
2499 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2500 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2501 * specific package. This is only sent to registered receivers, not manifest
2502 * receivers. It is sent to all running users <em>except</em> the one that
2503 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002504 * @hide
2505 */
2506 public static final String ACTION_USER_STOPPED =
2507 "android.intent.action.USER_STOPPED";
2508
2509 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002510 * 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 -07002511 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002512 * one that has been removed. The user will not be completely removed until all receivers have
2513 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002514 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002515 * @hide
2516 */
2517 public static final String ACTION_USER_REMOVED =
2518 "android.intent.action.USER_REMOVED";
2519
2520 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002521 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002522 * the userHandle of the user to become the current one. This is only sent to
2523 * registered receivers, not manifest receivers. It is sent to all running users.
2524 * You must hold
2525 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002526 * @hide
2527 */
2528 public static final String ACTION_USER_SWITCHED =
2529 "android.intent.action.USER_SWITCHED";
2530
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002531 /**
2532 * Broadcast sent to the system when a user's information changes. Carries an extra
2533 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2534 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2535 * whose information has changed.
2536 * @hide
2537 */
2538 public static final String ACTION_USER_INFO_CHANGED =
2539 "android.intent.action.USER_INFO_CHANGED";
2540
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002541 /**
2542 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2543 */
2544 public static final String ACTION_QUICK_CLOCK =
2545 "android.intent.action.QUICK_CLOCK";
2546
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002547 // ---------------------------------------------------------------------
2548 // ---------------------------------------------------------------------
2549 // Standard intent categories (see addCategory()).
2550
2551 /**
2552 * Set if the activity should be an option for the default action
2553 * (center press) to perform on a piece of data. Setting this will
2554 * hide from the user any activities without it set when performing an
2555 * action on some data. Note that this is normal -not- set in the
2556 * Intent when initiating an action -- it is for use in intent filters
2557 * specified in packages.
2558 */
2559 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2560 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2561 /**
2562 * Activities that can be safely invoked from a browser must support this
2563 * category. For example, if the user is viewing a web page or an e-mail
2564 * and clicks on a link in the text, the Intent generated execute that
2565 * link will require the BROWSABLE category, so that only activities
2566 * supporting this category will be considered as possible actions. By
2567 * supporting this category, you are promising that there is nothing
2568 * damaging (without user intervention) that can happen by invoking any
2569 * matching Intent.
2570 */
2571 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2572 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2573 /**
2574 * Set if the activity should be considered as an alternative action to
2575 * the data the user is currently viewing. See also
2576 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2577 * applies to the selection in a list of items.
2578 *
2579 * <p>Supporting this category means that you would like your activity to be
2580 * displayed in the set of alternative things the user can do, usually as
2581 * part of the current activity's options menu. You will usually want to
2582 * include a specific label in the &lt;intent-filter&gt; of this action
2583 * describing to the user what it does.
2584 *
2585 * <p>The action of IntentFilter with this category is important in that it
2586 * describes the specific action the target will perform. This generally
2587 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2588 * a specific name such as "com.android.camera.action.CROP. Only one
2589 * alternative of any particular action will be shown to the user, so using
2590 * a specific action like this makes sure that your alternative will be
2591 * displayed while also allowing other applications to provide their own
2592 * overrides of that particular action.
2593 */
2594 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2595 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2596 /**
2597 * Set if the activity should be considered as an alternative selection
2598 * action to the data the user has currently selected. This is like
2599 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2600 * of items from which the user can select, giving them alternatives to the
2601 * default action that will be performed on it.
2602 */
2603 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2604 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2605 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002606 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002607 */
2608 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2609 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2610 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002611 * Should be displayed in the top-level launcher.
2612 */
2613 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2614 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2615 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002616 * Provides information about the package it is in; typically used if
2617 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2618 * a front-door to the user without having to be shown in the all apps list.
2619 */
2620 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2621 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2622 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002623 * This is the home activity, that is the first activity that is displayed
2624 * when the device boots.
2625 */
2626 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2627 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2628 /**
2629 * This activity is a preference panel.
2630 */
2631 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2632 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2633 /**
2634 * This activity is a development preference panel.
2635 */
2636 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2637 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2638 /**
2639 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002640 */
2641 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2642 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2643 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002644 * This activity allows the user to browse and download new applications.
2645 */
2646 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2647 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2648 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002649 * This activity may be exercised by the monkey or other automated test tools.
2650 */
2651 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2652 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2653 /**
2654 * To be used as a test (not part of the normal user experience).
2655 */
2656 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2657 /**
2658 * To be used as a unit test (run through the Test Harness).
2659 */
2660 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2661 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002662 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002663 * experience).
2664 */
2665 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2666 /**
2667 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2668 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2669 * when queried, though it is allowable for those columns to be blank.
2670 */
2671 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2672 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2673
2674 /**
2675 * To be used as code under test for framework instrumentation tests.
2676 */
2677 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2678 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002679 /**
2680 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002681 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2682 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002683 */
2684 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2685 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2686 /**
2687 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002688 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2689 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002690 */
2691 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2692 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002693 /**
2694 * An activity to run when device is inserted into a analog (low end) dock.
2695 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2696 * information, see {@link android.app.UiModeManager}.
2697 */
2698 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2699 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2700
2701 /**
2702 * An activity to run when device is inserted into a digital (high end) dock.
2703 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2704 * information, see {@link android.app.UiModeManager}.
2705 */
2706 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2707 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002708
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002709 /**
2710 * Used to indicate that the activity can be used in a car environment.
2711 */
2712 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2713 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2714
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002715 // ---------------------------------------------------------------------
2716 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002717 // Application launch intent categories (see addCategory()).
2718
2719 /**
2720 * Used with {@link #ACTION_MAIN} to launch the browser application.
2721 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002722 * <p>NOTE: This should not be used as the primary key of an Intent,
2723 * since it will not result in the app launching with the correct
2724 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002725 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002726 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002727 */
2728 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2729 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2730
2731 /**
2732 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2733 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002734 * <p>NOTE: This should not be used as the primary key of an Intent,
2735 * since it will not result in the app launching with the correct
2736 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002737 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002738 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002739 */
2740 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2741 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2742
2743 /**
2744 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2745 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002746 * <p>NOTE: This should not be used as the primary key of an Intent,
2747 * since it will not result in the app launching with the correct
2748 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002749 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002750 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002751 */
2752 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2753 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2754
2755 /**
2756 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2757 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002758 * <p>NOTE: This should not be used as the primary key of an Intent,
2759 * since it will not result in the app launching with the correct
2760 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002761 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002762 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002763 */
2764 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2765 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2766
2767 /**
2768 * Used with {@link #ACTION_MAIN} to launch the email application.
2769 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002770 * <p>NOTE: This should not be used as the primary key of an Intent,
2771 * since it will not result in the app launching with the correct
2772 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002773 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002774 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002775 */
2776 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2777 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2778
2779 /**
2780 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2781 * The activity should be able to view and manipulate image and video files
2782 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002783 * <p>NOTE: This should not be used as the primary key of an Intent,
2784 * since it will not result in the app launching with the correct
2785 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002786 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002787 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002788 */
2789 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2790 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2791
2792 /**
2793 * Used with {@link #ACTION_MAIN} to launch the maps application.
2794 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002795 * <p>NOTE: This should not be used as the primary key of an Intent,
2796 * since it will not result in the app launching with the correct
2797 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002798 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002799 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002800 */
2801 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2802 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2803
2804 /**
2805 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2806 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002807 * <p>NOTE: This should not be used as the primary key of an Intent,
2808 * since it will not result in the app launching with the correct
2809 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002810 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002811 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002812 */
2813 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2814 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2815
2816 /**
2817 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002818 * The activity should be able to play, browse, or manipulate music files
2819 * stored on the device.
2820 * <p>NOTE: This should not be used as the primary key of an Intent,
2821 * since it will not result in the app launching with the correct
2822 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002823 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002824 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002825 */
2826 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2827 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2828
2829 // ---------------------------------------------------------------------
2830 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002831 // Standard extra data keys.
2832
2833 /**
2834 * The initial data to place in a newly created record. Use with
2835 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2836 * fields as would be given to the underlying ContentProvider.insert()
2837 * call.
2838 */
2839 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2840
2841 /**
2842 * A constant CharSequence that is associated with the Intent, used with
2843 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2844 * this may be a styled CharSequence, so you must use
2845 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2846 * retrieve it.
2847 */
2848 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2849
2850 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002851 * A constant String that is associated with the Intent, used with
2852 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2853 * as HTML formatted text. Note that you <em>must</em> also supply
2854 * {@link #EXTRA_TEXT}.
2855 */
2856 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2857
2858 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002859 * A content: URI holding a stream of data associated with the Intent,
2860 * used with {@link #ACTION_SEND} to supply the data being sent.
2861 */
2862 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2863
2864 /**
2865 * A String[] holding e-mail addresses that should be delivered to.
2866 */
2867 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2868
2869 /**
2870 * A String[] holding e-mail addresses that should be carbon copied.
2871 */
2872 public static final String EXTRA_CC = "android.intent.extra.CC";
2873
2874 /**
2875 * A String[] holding e-mail addresses that should be blind carbon copied.
2876 */
2877 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2878
2879 /**
2880 * A constant string holding the desired subject line of a message.
2881 */
2882 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2883
2884 /**
2885 * An Intent describing the choices you would like shown with
2886 * {@link #ACTION_PICK_ACTIVITY}.
2887 */
2888 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2889
2890 /**
2891 * A CharSequence dialog title to provide to the user when used with a
2892 * {@link #ACTION_CHOOSER}.
2893 */
2894 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2895
2896 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002897 * A Parcelable[] of {@link Intent} or
2898 * {@link android.content.pm.LabeledIntent} objects as set with
2899 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2900 * a the front of the list of choices, when shown to the user with a
2901 * {@link #ACTION_CHOOSER}.
2902 */
2903 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2904
2905 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002906 * A {@link android.view.KeyEvent} object containing the event that
2907 * triggered the creation of the Intent it is in.
2908 */
2909 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2910
2911 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002912 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2913 * before shutting down.
2914 *
2915 * {@hide}
2916 */
2917 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2918
2919 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002920 * 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 -07002921 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2922 * of restarting the application.
2923 */
2924 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2925
2926 /**
2927 * A String holding the phone number originally entered in
2928 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2929 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2930 */
2931 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002932
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002933 /**
2934 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2935 * intents to supply the uid the package had been assigned. Also an optional
2936 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2937 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2938 * purpose.
2939 */
2940 public static final String EXTRA_UID = "android.intent.extra.UID";
2941
2942 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002943 * @hide String array of package names.
2944 */
2945 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2946
2947 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002948 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2949 * intents to indicate whether this represents a full uninstall (removing
2950 * both the code and its data) or a partial uninstall (leaving its data,
2951 * implying that this is an update).
2952 */
2953 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002954
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002955 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002956 * @hide
2957 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2958 * intents to indicate that at this point the package has been removed for
2959 * all users on the device.
2960 */
2961 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2962 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2963
2964 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002965 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2966 * intents to indicate that this is a replacement of the package, so this
2967 * broadcast will immediately be followed by an add broadcast for a
2968 * different version of the same package.
2969 */
2970 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002971
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002973 * Used as an int extra field in {@link android.app.AlarmManager} intents
2974 * to tell the application being invoked how many pending alarms are being
2975 * delievered with the intent. For one-shot alarms this will always be 1.
2976 * For recurring alarms, this might be greater than 1 if the device was
2977 * asleep or powered off at the time an earlier alarm would have been
2978 * delivered.
2979 */
2980 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002981
Jacek Surazski86b6c532009-05-13 14:38:28 +02002982 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002983 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2984 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002985 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2986 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002987 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2988 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2989 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002990 */
2991 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2992
2993 /**
2994 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2995 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002996 */
2997 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2998
2999 /**
3000 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3001 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003002 */
3003 public static final int EXTRA_DOCK_STATE_DESK = 1;
3004
3005 /**
3006 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3007 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003008 */
3009 public static final int EXTRA_DOCK_STATE_CAR = 2;
3010
3011 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003012 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3013 * to represent that the phone is in a analog (low end) dock.
3014 */
3015 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3016
3017 /**
3018 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3019 * to represent that the phone is in a digital (high end) dock.
3020 */
3021 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3022
3023 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003024 * Boolean that can be supplied as meta-data with a dock activity, to
3025 * indicate that the dock should take over the home key when it is active.
3026 */
3027 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003028
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003029 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003030 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3031 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003032 */
3033 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3034
3035 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003036 * Used in the extra field in the remote intent. It's astring token passed with the
3037 * remote intent.
3038 */
3039 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3040 "android.intent.extra.remote_intent_token";
3041
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003042 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003043 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003044 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003045 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003046 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003047 "android.intent.extra.changed_component_name";
3048
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003049 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003050 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003051 * and contains a string array of all of the components that have changed. If
3052 * the state of the overall package has changed, then it will contain an entry
3053 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003054 */
3055 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3056 "android.intent.extra.changed_component_name_list";
3057
3058 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003059 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003060 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3061 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003062 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003063 */
3064 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3065 "android.intent.extra.changed_package_list";
3066
3067 /**
3068 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003069 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3070 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003071 * and contains an integer array of uids of all of the components
3072 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003073 */
3074 public static final String EXTRA_CHANGED_UID_LIST =
3075 "android.intent.extra.changed_uid_list";
3076
3077 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003078 * @hide
3079 * Magic extra system code can use when binding, to give a label for
3080 * who it is that has bound to a service. This is an integer giving
3081 * a framework string resource that can be displayed to the user.
3082 */
3083 public static final String EXTRA_CLIENT_LABEL =
3084 "android.intent.extra.client_label";
3085
3086 /**
3087 * @hide
3088 * Magic extra system code can use when binding, to give a PendingIntent object
3089 * that can be launched for the user to disable the system's use of this
3090 * service.
3091 */
3092 public static final String EXTRA_CLIENT_INTENT =
3093 "android.intent.extra.client_intent";
3094
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003095 /**
3096 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3097 * data that is on the local device. This is a boolean extra; the default
3098 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3099 * the user to select media that is already on the device, not requiring it
3100 * be downloaded from a remote service when opened. Another way to look
3101 * at it is that such content should generally have a "_data" column to the
3102 * path of the content on local external storage.
3103 */
3104 public static final String EXTRA_LOCAL_ONLY =
3105 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003106
Amith Yamasani13593602012-03-22 16:16:17 -07003107 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003108 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3109 * user to select and return multiple items. This is a boolean extra; the default
3110 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3111 * present the user with a UI where they can pick multiple items that are all
3112 * returned to the caller. When this happens, they should be returned as
3113 * the {@link #getClipData()} part of the result Intent.
3114 */
3115 public static final String EXTRA_ALLOW_MULTIPLE =
3116 "android.intent.extra.ALLOW_MULTIPLE";
3117
3118 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003119 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003120 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3121 * @hide
3122 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003123 public static final String EXTRA_USER_HANDLE =
3124 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003125
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003126 // ---------------------------------------------------------------------
3127 // ---------------------------------------------------------------------
3128 // Intent flags (see mFlags variable).
3129
3130 /**
3131 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003132 * perform read operations on the Uri in the Intent's data and any URIs
3133 * specified in its ClipData. When applying to an Intent's ClipData,
3134 * all URIs as well as recursive traversals through data or other ClipData
3135 * in Intent items will be granted; only the grant flags of the top-level
3136 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003137 */
3138 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3139 /**
3140 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003141 * perform write operations on the Uri in the Intent's data and any URIs
3142 * specified in its ClipData. When applying to an Intent's ClipData,
3143 * all URIs as well as recursive traversals through data or other ClipData
3144 * in Intent items will be granted; only the grant flags of the top-level
3145 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003146 */
3147 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3148 /**
3149 * Can be set by the caller to indicate that this Intent is coming from
3150 * a background operation, not from direct user interaction.
3151 */
3152 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3153 /**
3154 * A flag you can enable for debugging: when set, log messages will be
3155 * printed during the resolution of this intent to show you what has
3156 * been found to create the final resolved list.
3157 */
3158 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003159 /**
3160 * If set, this intent will not match any components in packages that
3161 * are currently stopped. If this is not set, then the default behavior
3162 * is to include such applications in the result.
3163 */
3164 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3165 /**
3166 * If set, this intent will always match any components in packages that
3167 * are currently stopped. This is the default behavior when
3168 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3169 * flags are set, this one wins (it allows overriding of exclude for
3170 * places where the framework may automatically set the exclude flag).
3171 */
3172 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003173
3174 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003175 * If set, the new activity is not kept in the history stack. As soon as
3176 * the user navigates away from it, the activity is finished. This may also
3177 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3178 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003179 */
3180 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3181 /**
3182 * If set, the activity will not be launched if it is already running
3183 * at the top of the history stack.
3184 */
3185 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3186 /**
3187 * If set, this activity will become the start of a new task on this
3188 * history stack. A task (from the activity that started it to the
3189 * next task activity) defines an atomic group of activities that the
3190 * user can move to. Tasks can be moved to the foreground and background;
3191 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003192 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003193 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3194 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003195 *
3196 * <p>This flag is generally used by activities that want
3197 * to present a "launcher" style behavior: they give the user a list of
3198 * separate things that can be done, which otherwise run completely
3199 * independently of the activity launching them.
3200 *
3201 * <p>When using this flag, if a task is already running for the activity
3202 * you are now starting, then a new activity will not be started; instead,
3203 * the current task will simply be brought to the front of the screen with
3204 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3205 * to disable this behavior.
3206 *
3207 * <p>This flag can not be used when the caller is requesting a result from
3208 * the activity being launched.
3209 */
3210 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3211 /**
3212 * <strong>Do not use this flag unless you are implementing your own
3213 * top-level application launcher.</strong> Used in conjunction with
3214 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3215 * behavior of bringing an existing task to the foreground. When set,
3216 * a new task is <em>always</em> started to host the Activity for the
3217 * Intent, regardless of whether there is already an existing task running
3218 * the same thing.
3219 *
3220 * <p><strong>Because the default system does not include graphical task management,
3221 * you should not use this flag unless you provide some way for a user to
3222 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003223 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003224 * <p>This flag is ignored if
3225 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3226 *
Scott Main7aee61f2011-02-08 11:25:01 -08003227 * <p>See
3228 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3229 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003230 */
3231 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3232 /**
3233 * If set, and the activity being launched is already running in the
3234 * current task, then instead of launching a new instance of that activity,
3235 * all of the other activities on top of it will be closed and this Intent
3236 * will be delivered to the (now on top) old activity as a new Intent.
3237 *
3238 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3239 * If D calls startActivity() with an Intent that resolves to the component
3240 * of activity B, then C and D will be finished and B receive the given
3241 * Intent, resulting in the stack now being: A, B.
3242 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003243 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003244 * either receive the new intent you are starting here in its
3245 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003246 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003247 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3248 * the same intent, then it will be finished and re-created; for all other
3249 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3250 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003251 *
3252 * <p>This launch mode can also be used to good effect in conjunction with
3253 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3254 * of a task, it will bring any currently running instance of that task
3255 * to the foreground, and then clear it to its root state. This is
3256 * especially useful, for example, when launching an activity from the
3257 * notification manager.
3258 *
Scott Main7aee61f2011-02-08 11:25:01 -08003259 * <p>See
3260 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3261 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003262 */
3263 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3264 /**
3265 * If set and this intent is being used to launch a new activity from an
3266 * existing one, then the reply target of the existing activity will be
3267 * transfered to the new activity. This way the new activity can call
3268 * {@link android.app.Activity#setResult} and have that result sent back to
3269 * the reply target of the original activity.
3270 */
3271 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3272 /**
3273 * If set and this intent is being used to launch a new activity from an
3274 * existing one, the current activity will not be counted as the top
3275 * activity for deciding whether the new intent should be delivered to
3276 * the top instead of starting a new one. The previous activity will
3277 * be used as the top, with the assumption being that the current activity
3278 * will finish itself immediately.
3279 */
3280 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3281 /**
3282 * If set, the new activity is not kept in the list of recently launched
3283 * activities.
3284 */
3285 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3286 /**
3287 * This flag is not normally set by application code, but set for you by
3288 * the system as described in the
3289 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3290 * launchMode} documentation for the singleTask mode.
3291 */
3292 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3293 /**
3294 * If set, and this activity is either being started in a new task or
3295 * bringing to the top an existing task, then it will be launched as
3296 * the front door of the task. This will result in the application of
3297 * any affinities needed to have that task in the proper state (either
3298 * moving activities to or from it), or simply resetting that task to
3299 * its initial state if needed.
3300 */
3301 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3302 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003303 * This flag is not normally set by application code, but set for you by
3304 * the system if this activity is being launched from history
3305 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003306 */
3307 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003308 /**
3309 * If set, this marks a point in the task's activity stack that should
3310 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003311 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003312 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3313 * the user re-launching it from home), this activity and all on top of
3314 * it will be finished so that the user does not return to them, but
3315 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003316 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003317 * <p>This is useful for cases where you have a logical break in your
3318 * application. For example, an e-mail application may have a command
3319 * to view an attachment, which launches an image view activity to
3320 * display it. This activity should be part of the e-mail application's
3321 * task, since it is a part of the task the user is involved in. However,
3322 * if the user leaves that task, and later selects the e-mail app from
3323 * home, we may like them to return to the conversation they were
3324 * viewing, not the picture attachment, since that is confusing. By
3325 * setting this flag when launching the image viewer, that viewer and
3326 * any activities it starts will be removed the next time the user returns
3327 * to mail.
3328 */
3329 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003330 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003331 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003332 * callback from occurring on the current frontmost activity before it is
3333 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003334 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003335 * <p>Typically, an activity can rely on that callback to indicate that an
3336 * explicit user action has caused their activity to be moved out of the
3337 * foreground. The callback marks an appropriate point in the activity's
3338 * lifecycle for it to dismiss any notifications that it intends to display
3339 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003340 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003341 * <p>If an activity is ever started via any non-user-driven events such as
3342 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3343 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003344 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003345 */
3346 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003347 /**
3348 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3349 * this flag will cause the launched activity to be brought to the front of its
3350 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003351 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003352 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3353 * If D calls startActivity() with an Intent that resolves to the component
3354 * of activity B, then B will be brought to the front of the history stack,
3355 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003356 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003357 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003358 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003359 */
3360 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003361 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003362 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3363 * this flag will prevent the system from applying an activity transition
3364 * animation to go to the next activity state. This doesn't mean an
3365 * animation will never run -- if another activity change happens that doesn't
3366 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003367 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003368 * when you are going to do a series of activity operations but the
3369 * animation seen by the user shouldn't be driven by the first activity
3370 * change but rather a later one.
3371 */
3372 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3373 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003374 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3375 * this flag will cause any existing task that would be associated with the
3376 * activity to be cleared before the activity is started. That is, the activity
3377 * becomes the new root of an otherwise empty task, and any old activities
3378 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3379 */
3380 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3381 /**
3382 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3383 * this flag will cause a newly launching task to be placed on top of the current
3384 * home activity task (if there is one). That is, pressing back from the task
3385 * will always return the user to home even if that was not the last activity they
3386 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3387 */
3388 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3389 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003390 * If set, when sending a broadcast only registered receivers will be
3391 * called -- no BroadcastReceiver components will be launched.
3392 */
3393 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003394 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003395 * If set, when sending a broadcast the new broadcast will replace
3396 * any existing pending broadcast that matches it. Matching is defined
3397 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3398 * true for the intents of the two broadcasts. When a match is found,
3399 * the new broadcast (and receivers associated with it) will replace the
3400 * existing one in the pending broadcast list, remaining at the same
3401 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003402 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003403 * <p>This flag is most typically used with sticky broadcasts, which
3404 * only care about delivering the most recent values of the broadcast
3405 * to their receivers.
3406 */
3407 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3408 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003409 * If set, when sending a broadcast the recipient is allowed to run at
3410 * foreground priority, with a shorter timeout interval. During normal
3411 * broadcasts the receivers are not automatically hoisted out of the
3412 * background priority class.
3413 */
3414 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3415 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003416 * If set, when sending a broadcast <i>before boot has completed</i> only
3417 * registered receivers will be called -- no BroadcastReceiver components
3418 * will be launched. Sticky intent state will be recorded properly even
3419 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3420 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003421 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003422 * <p>This flag is only for use by system sevices as a convenience to
3423 * avoid having to implement a more complex mechanism around detection
3424 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003425 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003426 * @hide
3427 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003428 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003429 /**
3430 * Set when this broadcast is for a boot upgrade, a special mode that
3431 * allows the broadcast to be sent before the system is ready and launches
3432 * the app process with no providers running in it.
3433 * @hide
3434 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003435 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003436
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003437 /**
3438 * @hide Flags that can't be changed with PendingIntent.
3439 */
3440 public static final int IMMUTABLE_FLAGS =
3441 FLAG_GRANT_READ_URI_PERMISSION
3442 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003443
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003444 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003445 // ---------------------------------------------------------------------
3446 // toUri() and parseUri() options.
3447
3448 /**
3449 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3450 * always has the "intent:" scheme. This syntax can be used when you want
3451 * to later disambiguate between URIs that are intended to describe an
3452 * Intent vs. all others that should be treated as raw URIs. When used
3453 * with {@link #parseUri}, any other scheme will result in a generic
3454 * VIEW action for that raw URI.
3455 */
3456 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003457
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003458 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003459
3460 private String mAction;
3461 private Uri mData;
3462 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003463 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003464 private ComponentName mComponent;
3465 private int mFlags;
3466 private HashSet<String> mCategories;
3467 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003468 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003469 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003470 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003471
3472 // ---------------------------------------------------------------------
3473
3474 /**
3475 * Create an empty intent.
3476 */
3477 public Intent() {
3478 }
3479
3480 /**
3481 * Copy constructor.
3482 */
3483 public Intent(Intent o) {
3484 this.mAction = o.mAction;
3485 this.mData = o.mData;
3486 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003487 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003488 this.mComponent = o.mComponent;
3489 this.mFlags = o.mFlags;
3490 if (o.mCategories != null) {
3491 this.mCategories = new HashSet<String>(o.mCategories);
3492 }
3493 if (o.mExtras != null) {
3494 this.mExtras = new Bundle(o.mExtras);
3495 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003496 if (o.mSourceBounds != null) {
3497 this.mSourceBounds = new Rect(o.mSourceBounds);
3498 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003499 if (o.mSelector != null) {
3500 this.mSelector = new Intent(o.mSelector);
3501 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003502 if (o.mClipData != null) {
3503 this.mClipData = new ClipData(o.mClipData);
3504 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003505 }
3506
3507 @Override
3508 public Object clone() {
3509 return new Intent(this);
3510 }
3511
3512 private Intent(Intent o, boolean all) {
3513 this.mAction = o.mAction;
3514 this.mData = o.mData;
3515 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003516 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003517 this.mComponent = o.mComponent;
3518 if (o.mCategories != null) {
3519 this.mCategories = new HashSet<String>(o.mCategories);
3520 }
3521 }
3522
3523 /**
3524 * Make a clone of only the parts of the Intent that are relevant for
3525 * filter matching: the action, data, type, component, and categories.
3526 */
3527 public Intent cloneFilter() {
3528 return new Intent(this, false);
3529 }
3530
3531 /**
3532 * Create an intent with a given action. All other fields (data, type,
3533 * class) are null. Note that the action <em>must</em> be in a
3534 * namespace because Intents are used globally in the system -- for
3535 * example the system VIEW action is android.intent.action.VIEW; an
3536 * application's custom action would be something like
3537 * com.google.app.myapp.CUSTOM_ACTION.
3538 *
3539 * @param action The Intent action, such as ACTION_VIEW.
3540 */
3541 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003542 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003543 }
3544
3545 /**
3546 * Create an intent with a given action and for a given data url. Note
3547 * that the action <em>must</em> be in a namespace because Intents are
3548 * used globally in the system -- for example the system VIEW action is
3549 * android.intent.action.VIEW; an application's custom action would be
3550 * something like com.google.app.myapp.CUSTOM_ACTION.
3551 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003552 * <p><em>Note: scheme and host name matching in the Android framework is
3553 * case-sensitive, unlike the formal RFC. As a result,
3554 * you should always ensure that you write your Uri with these elements
3555 * using lower case letters, and normalize any Uris you receive from
3556 * outside of Android to ensure the scheme and host is lower case.</em></p>
3557 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003558 * @param action The Intent action, such as ACTION_VIEW.
3559 * @param uri The Intent data URI.
3560 */
3561 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003562 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003563 mData = uri;
3564 }
3565
3566 /**
3567 * Create an intent for a specific component. All other fields (action, data,
3568 * type, class) are null, though they can be modified later with explicit
3569 * calls. This provides a convenient way to create an intent that is
3570 * intended to execute a hard-coded class name, rather than relying on the
3571 * system to find an appropriate class for you; see {@link #setComponent}
3572 * for more information on the repercussions of this.
3573 *
3574 * @param packageContext A Context of the application package implementing
3575 * this class.
3576 * @param cls The component class that is to be used for the intent.
3577 *
3578 * @see #setClass
3579 * @see #setComponent
3580 * @see #Intent(String, android.net.Uri , Context, Class)
3581 */
3582 public Intent(Context packageContext, Class<?> cls) {
3583 mComponent = new ComponentName(packageContext, cls);
3584 }
3585
3586 /**
3587 * Create an intent for a specific component with a specified action and data.
3588 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3589 * construct the Intent and then calling {@link #setClass} to set its
3590 * class.
3591 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003592 * <p><em>Note: scheme and host name matching in the Android framework is
3593 * case-sensitive, unlike the formal RFC. As a result,
3594 * you should always ensure that you write your Uri with these elements
3595 * using lower case letters, and normalize any Uris you receive from
3596 * outside of Android to ensure the scheme and host is lower case.</em></p>
3597 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003598 * @param action The Intent action, such as ACTION_VIEW.
3599 * @param uri The Intent data URI.
3600 * @param packageContext A Context of the application package implementing
3601 * this class.
3602 * @param cls The component class that is to be used for the intent.
3603 *
3604 * @see #Intent(String, android.net.Uri)
3605 * @see #Intent(Context, Class)
3606 * @see #setClass
3607 * @see #setComponent
3608 */
3609 public Intent(String action, Uri uri,
3610 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003611 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003612 mData = uri;
3613 mComponent = new ComponentName(packageContext, cls);
3614 }
3615
3616 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003617 * Create an intent to launch the main (root) activity of a task. This
3618 * is the Intent that is started when the application's is launched from
3619 * Home. For anything else that wants to launch an application in the
3620 * same way, it is important that they use an Intent structured the same
3621 * way, and can use this function to ensure this is the case.
3622 *
3623 * <p>The returned Intent has the given Activity component as its explicit
3624 * component, {@link #ACTION_MAIN} as its action, and includes the
3625 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3626 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3627 * to do that through {@link #addFlags(int)} on the returned Intent.
3628 *
3629 * @param mainActivity The main activity component that this Intent will
3630 * launch.
3631 * @return Returns a newly created Intent that can be used to launch the
3632 * activity as a main application entry.
3633 *
3634 * @see #setClass
3635 * @see #setComponent
3636 */
3637 public static Intent makeMainActivity(ComponentName mainActivity) {
3638 Intent intent = new Intent(ACTION_MAIN);
3639 intent.setComponent(mainActivity);
3640 intent.addCategory(CATEGORY_LAUNCHER);
3641 return intent;
3642 }
3643
3644 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003645 * Make an Intent for the main activity of an application, without
3646 * specifying a specific activity to run but giving a selector to find
3647 * the activity. This results in a final Intent that is structured
3648 * the same as when the application is launched from
3649 * Home. For anything else that wants to launch an application in the
3650 * same way, it is important that they use an Intent structured the same
3651 * way, and can use this function to ensure this is the case.
3652 *
3653 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3654 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3655 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3656 * to do that through {@link #addFlags(int)} on the returned Intent.
3657 *
3658 * @param selectorAction The action name of the Intent's selector.
3659 * @param selectorCategory The name of a category to add to the Intent's
3660 * selector.
3661 * @return Returns a newly created Intent that can be used to launch the
3662 * activity as a main application entry.
3663 *
3664 * @see #setSelector(Intent)
3665 */
3666 public static Intent makeMainSelectorActivity(String selectorAction,
3667 String selectorCategory) {
3668 Intent intent = new Intent(ACTION_MAIN);
3669 intent.addCategory(CATEGORY_LAUNCHER);
3670 Intent selector = new Intent();
3671 selector.setAction(selectorAction);
3672 selector.addCategory(selectorCategory);
3673 intent.setSelector(selector);
3674 return intent;
3675 }
3676
3677 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003678 * Make an Intent that can be used to re-launch an application's task
3679 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3680 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3681 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3682 *
3683 * @param mainActivity The activity component that is the root of the
3684 * task; this is the activity that has been published in the application's
3685 * manifest as the main launcher icon.
3686 *
3687 * @return Returns a newly created Intent that can be used to relaunch the
3688 * activity's task in its root state.
3689 */
3690 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3691 Intent intent = makeMainActivity(mainActivity);
3692 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3693 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3694 return intent;
3695 }
3696
3697 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003698 * Call {@link #parseUri} with 0 flags.
3699 * @deprecated Use {@link #parseUri} instead.
3700 */
3701 @Deprecated
3702 public static Intent getIntent(String uri) throws URISyntaxException {
3703 return parseUri(uri, 0);
3704 }
Tom Taylord4a47292009-12-21 13:59:18 -08003705
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003706 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003707 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003708 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003709 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003710 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003711 *
3712 * <p>The URI given here must not be relative -- that is, it must include
3713 * the scheme and full path.
3714 *
3715 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003716 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003717 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003718 *
3719 * @return Intent The newly created Intent object.
3720 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003721 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3722 * it bad (as parsed by the Uri class) or the Intent data within the
3723 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003724 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003725 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003726 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003727 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003728 int i = 0;
3729 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003730 // Validate intent scheme for if requested.
3731 if ((flags&URI_INTENT_SCHEME) != 0) {
3732 if (!uri.startsWith("intent:")) {
3733 Intent intent = new Intent(ACTION_VIEW);
3734 try {
3735 intent.setData(Uri.parse(uri));
3736 } catch (IllegalArgumentException e) {
3737 throw new URISyntaxException(uri, e.getMessage());
3738 }
3739 return intent;
3740 }
3741 }
Tom Taylord4a47292009-12-21 13:59:18 -08003742
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003743 // simple case
3744 i = uri.lastIndexOf("#");
3745 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3746
3747 // old format Intent URI
3748 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003749
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003750 // new format
3751 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003752 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003753
3754 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003755 String data = i >= 0 ? uri.substring(0, i) : null;
3756 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003757 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003758
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003759 // loop over contents of Intent, all name=value;
3760 while (!uri.startsWith("end", i)) {
3761 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003762 if (eq < 0) eq = i-1;
3763 int semi = uri.indexOf(';', i);
3764 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003765
3766 // action
3767 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003768 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003769 }
3770
3771 // categories
3772 else if (uri.startsWith("category=", i)) {
3773 intent.addCategory(value);
3774 }
3775
3776 // type
3777 else if (uri.startsWith("type=", i)) {
3778 intent.mType = value;
3779 }
3780
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003781 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003782 else if (uri.startsWith("launchFlags=", i)) {
3783 intent.mFlags = Integer.decode(value).intValue();
3784 }
3785
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003786 // package
3787 else if (uri.startsWith("package=", i)) {
3788 intent.mPackage = value;
3789 }
3790
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003791 // component
3792 else if (uri.startsWith("component=", i)) {
3793 intent.mComponent = ComponentName.unflattenFromString(value);
3794 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003795
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003796 // scheme
3797 else if (uri.startsWith("scheme=", i)) {
3798 scheme = value;
3799 }
3800
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003801 // source bounds
3802 else if (uri.startsWith("sourceBounds=", i)) {
3803 intent.mSourceBounds = Rect.unflattenFromString(value);
3804 }
3805
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003806 // selector
3807 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3808 intent = new Intent();
3809 }
3810
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003811 // extra
3812 else {
3813 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003814 // create Bundle if it doesn't already exist
3815 if (intent.mExtras == null) intent.mExtras = new Bundle();
3816 Bundle b = intent.mExtras;
3817 // add EXTRA
3818 if (uri.startsWith("S.", i)) b.putString(key, value);
3819 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3820 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3821 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3822 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3823 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3824 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3825 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3826 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3827 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3828 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003829
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003830 // move to the next item
3831 i = semi + 1;
3832 }
3833
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003834 if (intent != baseIntent) {
3835 // The Intent had a selector; fix it up.
3836 baseIntent.setSelector(intent);
3837 intent = baseIntent;
3838 }
3839
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003840 if (data != null) {
3841 if (data.startsWith("intent:")) {
3842 data = data.substring(7);
3843 if (scheme != null) {
3844 data = scheme + ':' + data;
3845 }
3846 }
Tom Taylord4a47292009-12-21 13:59:18 -08003847
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003848 if (data.length() > 0) {
3849 try {
3850 intent.mData = Uri.parse(data);
3851 } catch (IllegalArgumentException e) {
3852 throw new URISyntaxException(uri, e.getMessage());
3853 }
3854 }
3855 }
Tom Taylord4a47292009-12-21 13:59:18 -08003856
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003857 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003858
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003859 } catch (IndexOutOfBoundsException e) {
3860 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3861 }
3862 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003863
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003864 public static Intent getIntentOld(String uri) throws URISyntaxException {
3865 Intent intent;
3866
3867 int i = uri.lastIndexOf('#');
3868 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003869 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003870 final int intentFragmentStart = i;
3871 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003872
3873 i++;
3874
3875 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003876 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003877 i += 7;
3878 int j = uri.indexOf(')', i);
3879 action = uri.substring(i, j);
3880 i = j + 1;
3881 }
3882
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003883 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003884
3885 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003886 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003887 i += 11;
3888 int j = uri.indexOf(')', i);
3889 while (i < j) {
3890 int sep = uri.indexOf('!', i);
3891 if (sep < 0) sep = j;
3892 if (i < sep) {
3893 intent.addCategory(uri.substring(i, sep));
3894 }
3895 i = sep + 1;
3896 }
3897 i = j + 1;
3898 }
3899
3900 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003901 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003902 i += 5;
3903 int j = uri.indexOf(')', i);
3904 intent.mType = uri.substring(i, j);
3905 i = j + 1;
3906 }
3907
3908 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003909 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003910 i += 12;
3911 int j = uri.indexOf(')', i);
3912 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3913 i = j + 1;
3914 }
3915
3916 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003917 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003918 i += 10;
3919 int j = uri.indexOf(')', i);
3920 int sep = uri.indexOf('!', i);
3921 if (sep >= 0 && sep < j) {
3922 String pkg = uri.substring(i, sep);
3923 String cls = uri.substring(sep + 1, j);
3924 intent.mComponent = new ComponentName(pkg, cls);
3925 }
3926 i = j + 1;
3927 }
3928
3929 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003930 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003931 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003932
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003933 final int closeParen = uri.indexOf(')', i);
3934 if (closeParen == -1) throw new URISyntaxException(uri,
3935 "EXTRA missing trailing ')'", i);
3936
3937 while (i < closeParen) {
3938 // fetch the key value
3939 int j = uri.indexOf('=', i);
3940 if (j <= i + 1 || i >= closeParen) {
3941 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3942 }
3943 char type = uri.charAt(i);
3944 i++;
3945 String key = uri.substring(i, j);
3946 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003947
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003948 // get type-value
3949 j = uri.indexOf('!', i);
3950 if (j == -1 || j >= closeParen) j = closeParen;
3951 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3952 String value = uri.substring(i, j);
3953 i = j;
3954
3955 // create Bundle if it doesn't already exist
3956 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003957
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003958 // add item to bundle
3959 try {
3960 switch (type) {
3961 case 'S':
3962 intent.mExtras.putString(key, Uri.decode(value));
3963 break;
3964 case 'B':
3965 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3966 break;
3967 case 'b':
3968 intent.mExtras.putByte(key, Byte.parseByte(value));
3969 break;
3970 case 'c':
3971 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3972 break;
3973 case 'd':
3974 intent.mExtras.putDouble(key, Double.parseDouble(value));
3975 break;
3976 case 'f':
3977 intent.mExtras.putFloat(key, Float.parseFloat(value));
3978 break;
3979 case 'i':
3980 intent.mExtras.putInt(key, Integer.parseInt(value));
3981 break;
3982 case 'l':
3983 intent.mExtras.putLong(key, Long.parseLong(value));
3984 break;
3985 case 's':
3986 intent.mExtras.putShort(key, Short.parseShort(value));
3987 break;
3988 default:
3989 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3990 }
3991 } catch (NumberFormatException e) {
3992 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3993 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003994
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003995 char ch = uri.charAt(i);
3996 if (ch == ')') break;
3997 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3998 i++;
3999 }
4000 }
4001
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004002 if (isIntentFragment) {
4003 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4004 } else {
4005 intent.mData = Uri.parse(uri);
4006 }
Tom Taylord4a47292009-12-21 13:59:18 -08004007
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004008 if (intent.mAction == null) {
4009 // By default, if no action is specified, then use VIEW.
4010 intent.mAction = ACTION_VIEW;
4011 }
4012
4013 } else {
4014 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4015 }
4016
4017 return intent;
4018 }
4019
4020 /**
4021 * Retrieve the general action to be performed, such as
4022 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4023 * the information in the intent should be interpreted -- most importantly,
4024 * what to do with the data returned by {@link #getData}.
4025 *
4026 * @return The action of this intent or null if none is specified.
4027 *
4028 * @see #setAction
4029 */
4030 public String getAction() {
4031 return mAction;
4032 }
4033
4034 /**
4035 * Retrieve data this intent is operating on. This URI specifies the name
4036 * of the data; often it uses the content: scheme, specifying data in a
4037 * content provider. Other schemes may be handled by specific activities,
4038 * such as http: by the web browser.
4039 *
4040 * @return The URI of the data this intent is targeting or null.
4041 *
4042 * @see #getScheme
4043 * @see #setData
4044 */
4045 public Uri getData() {
4046 return mData;
4047 }
4048
4049 /**
4050 * The same as {@link #getData()}, but returns the URI as an encoded
4051 * String.
4052 */
4053 public String getDataString() {
4054 return mData != null ? mData.toString() : null;
4055 }
4056
4057 /**
4058 * Return the scheme portion of the intent's data. If the data is null or
4059 * does not include a scheme, null is returned. Otherwise, the scheme
4060 * prefix without the final ':' is returned, i.e. "http".
4061 *
4062 * <p>This is the same as calling getData().getScheme() (and checking for
4063 * null data).
4064 *
4065 * @return The scheme of this intent.
4066 *
4067 * @see #getData
4068 */
4069 public String getScheme() {
4070 return mData != null ? mData.getScheme() : null;
4071 }
4072
4073 /**
4074 * Retrieve any explicit MIME type included in the intent. This is usually
4075 * null, as the type is determined by the intent data.
4076 *
4077 * @return If a type was manually set, it is returned; else null is
4078 * returned.
4079 *
4080 * @see #resolveType(ContentResolver)
4081 * @see #setType
4082 */
4083 public String getType() {
4084 return mType;
4085 }
4086
4087 /**
4088 * Return the MIME data type of this intent. If the type field is
4089 * explicitly set, that is simply returned. Otherwise, if the data is set,
4090 * the type of that data is returned. If neither fields are set, a null is
4091 * returned.
4092 *
4093 * @return The MIME type of this intent.
4094 *
4095 * @see #getType
4096 * @see #resolveType(ContentResolver)
4097 */
4098 public String resolveType(Context context) {
4099 return resolveType(context.getContentResolver());
4100 }
4101
4102 /**
4103 * Return the MIME data type of this intent. If the type field is
4104 * explicitly set, that is simply returned. Otherwise, if the data is set,
4105 * the type of that data is returned. If neither fields are set, a null is
4106 * returned.
4107 *
4108 * @param resolver A ContentResolver that can be used to determine the MIME
4109 * type of the intent's data.
4110 *
4111 * @return The MIME type of this intent.
4112 *
4113 * @see #getType
4114 * @see #resolveType(Context)
4115 */
4116 public String resolveType(ContentResolver resolver) {
4117 if (mType != null) {
4118 return mType;
4119 }
4120 if (mData != null) {
4121 if ("content".equals(mData.getScheme())) {
4122 return resolver.getType(mData);
4123 }
4124 }
4125 return null;
4126 }
4127
4128 /**
4129 * Return the MIME data type of this intent, only if it will be needed for
4130 * intent resolution. This is not generally useful for application code;
4131 * it is used by the frameworks for communicating with back-end system
4132 * services.
4133 *
4134 * @param resolver A ContentResolver that can be used to determine the MIME
4135 * type of the intent's data.
4136 *
4137 * @return The MIME type of this intent, or null if it is unknown or not
4138 * needed.
4139 */
4140 public String resolveTypeIfNeeded(ContentResolver resolver) {
4141 if (mComponent != null) {
4142 return mType;
4143 }
4144 return resolveType(resolver);
4145 }
4146
4147 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004148 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004149 *
4150 * @param category The category to check.
4151 *
4152 * @return boolean True if the intent contains the category, else false.
4153 *
4154 * @see #getCategories
4155 * @see #addCategory
4156 */
4157 public boolean hasCategory(String category) {
4158 return mCategories != null && mCategories.contains(category);
4159 }
4160
4161 /**
4162 * Return the set of all categories in the intent. If there are no categories,
4163 * returns NULL.
4164 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004165 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004166 *
4167 * @see #hasCategory
4168 * @see #addCategory
4169 */
4170 public Set<String> getCategories() {
4171 return mCategories;
4172 }
4173
4174 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004175 * Return the specific selector associated with this Intent. If there is
4176 * none, returns null. See {@link #setSelector} for more information.
4177 *
4178 * @see #setSelector
4179 */
4180 public Intent getSelector() {
4181 return mSelector;
4182 }
4183
4184 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004185 * Return the {@link ClipData} associated with this Intent. If there is
4186 * none, returns null. See {@link #setClipData} for more information.
4187 *
4188 * @see #setClipData;
4189 */
4190 public ClipData getClipData() {
4191 return mClipData;
4192 }
4193
4194 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004195 * Sets the ClassLoader that will be used when unmarshalling
4196 * any Parcelable values from the extras of this Intent.
4197 *
4198 * @param loader a ClassLoader, or null to use the default loader
4199 * at the time of unmarshalling.
4200 */
4201 public void setExtrasClassLoader(ClassLoader loader) {
4202 if (mExtras != null) {
4203 mExtras.setClassLoader(loader);
4204 }
4205 }
4206
4207 /**
4208 * Returns true if an extra value is associated with the given name.
4209 * @param name the extra's name
4210 * @return true if the given extra is present.
4211 */
4212 public boolean hasExtra(String name) {
4213 return mExtras != null && mExtras.containsKey(name);
4214 }
4215
4216 /**
4217 * Returns true if the Intent's extras contain a parcelled file descriptor.
4218 * @return true if the Intent contains a parcelled file descriptor.
4219 */
4220 public boolean hasFileDescriptors() {
4221 return mExtras != null && mExtras.hasFileDescriptors();
4222 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004223
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004224 /** @hide */
4225 public void setAllowFds(boolean allowFds) {
4226 if (mExtras != null) {
4227 mExtras.setAllowFds(allowFds);
4228 }
4229 }
4230
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004231 /**
4232 * Retrieve extended data from the intent.
4233 *
4234 * @param name The name of the desired item.
4235 *
4236 * @return the value of an item that previously added with putExtra()
4237 * or null if none was found.
4238 *
4239 * @deprecated
4240 * @hide
4241 */
4242 @Deprecated
4243 public Object getExtra(String name) {
4244 return getExtra(name, null);
4245 }
4246
4247 /**
4248 * Retrieve extended data from the intent.
4249 *
4250 * @param name The name of the desired item.
4251 * @param defaultValue the value to be returned if no value of the desired
4252 * type is stored with the given name.
4253 *
4254 * @return the value of an item that previously added with putExtra()
4255 * or the default value if none was found.
4256 *
4257 * @see #putExtra(String, boolean)
4258 */
4259 public boolean getBooleanExtra(String name, boolean defaultValue) {
4260 return mExtras == null ? defaultValue :
4261 mExtras.getBoolean(name, defaultValue);
4262 }
4263
4264 /**
4265 * Retrieve extended data from the intent.
4266 *
4267 * @param name The name of the desired item.
4268 * @param defaultValue the value to be returned if no value of the desired
4269 * type is stored with the given name.
4270 *
4271 * @return the value of an item that previously added with putExtra()
4272 * or the default value if none was found.
4273 *
4274 * @see #putExtra(String, byte)
4275 */
4276 public byte getByteExtra(String name, byte defaultValue) {
4277 return mExtras == null ? defaultValue :
4278 mExtras.getByte(name, defaultValue);
4279 }
4280
4281 /**
4282 * Retrieve extended data from the intent.
4283 *
4284 * @param name The name of the desired item.
4285 * @param defaultValue the value to be returned if no value of the desired
4286 * type is stored with the given name.
4287 *
4288 * @return the value of an item that previously added with putExtra()
4289 * or the default value if none was found.
4290 *
4291 * @see #putExtra(String, short)
4292 */
4293 public short getShortExtra(String name, short defaultValue) {
4294 return mExtras == null ? defaultValue :
4295 mExtras.getShort(name, defaultValue);
4296 }
4297
4298 /**
4299 * Retrieve extended data from the intent.
4300 *
4301 * @param name The name of the desired item.
4302 * @param defaultValue the value to be returned if no value of the desired
4303 * type is stored with the given name.
4304 *
4305 * @return the value of an item that previously added with putExtra()
4306 * or the default value if none was found.
4307 *
4308 * @see #putExtra(String, char)
4309 */
4310 public char getCharExtra(String name, char defaultValue) {
4311 return mExtras == null ? defaultValue :
4312 mExtras.getChar(name, defaultValue);
4313 }
4314
4315 /**
4316 * Retrieve extended data from the intent.
4317 *
4318 * @param name The name of the desired item.
4319 * @param defaultValue the value to be returned if no value of the desired
4320 * type is stored with the given name.
4321 *
4322 * @return the value of an item that previously added with putExtra()
4323 * or the default value if none was found.
4324 *
4325 * @see #putExtra(String, int)
4326 */
4327 public int getIntExtra(String name, int defaultValue) {
4328 return mExtras == null ? defaultValue :
4329 mExtras.getInt(name, defaultValue);
4330 }
4331
4332 /**
4333 * Retrieve extended data from the intent.
4334 *
4335 * @param name The name of the desired item.
4336 * @param defaultValue the value to be returned if no value of the desired
4337 * type is stored with the given name.
4338 *
4339 * @return the value of an item that previously added with putExtra()
4340 * or the default value if none was found.
4341 *
4342 * @see #putExtra(String, long)
4343 */
4344 public long getLongExtra(String name, long defaultValue) {
4345 return mExtras == null ? defaultValue :
4346 mExtras.getLong(name, defaultValue);
4347 }
4348
4349 /**
4350 * Retrieve extended data from the intent.
4351 *
4352 * @param name The name of the desired item.
4353 * @param defaultValue the value to be returned if no value of the desired
4354 * type is stored with the given name.
4355 *
4356 * @return the value of an item that previously added with putExtra(),
4357 * or the default value if no such item is present
4358 *
4359 * @see #putExtra(String, float)
4360 */
4361 public float getFloatExtra(String name, float defaultValue) {
4362 return mExtras == null ? defaultValue :
4363 mExtras.getFloat(name, defaultValue);
4364 }
4365
4366 /**
4367 * Retrieve extended data from the intent.
4368 *
4369 * @param name The name of the desired item.
4370 * @param defaultValue the value to be returned if no value of the desired
4371 * type is stored with the given name.
4372 *
4373 * @return the value of an item that previously added with putExtra()
4374 * or the default value if none was found.
4375 *
4376 * @see #putExtra(String, double)
4377 */
4378 public double getDoubleExtra(String name, double defaultValue) {
4379 return mExtras == null ? defaultValue :
4380 mExtras.getDouble(name, defaultValue);
4381 }
4382
4383 /**
4384 * Retrieve extended data from the intent.
4385 *
4386 * @param name The name of the desired item.
4387 *
4388 * @return the value of an item that previously added with putExtra()
4389 * or null if no String value was found.
4390 *
4391 * @see #putExtra(String, String)
4392 */
4393 public String getStringExtra(String name) {
4394 return mExtras == null ? null : mExtras.getString(name);
4395 }
4396
4397 /**
4398 * Retrieve extended data from the intent.
4399 *
4400 * @param name The name of the desired item.
4401 *
4402 * @return the value of an item that previously added with putExtra()
4403 * or null if no CharSequence value was found.
4404 *
4405 * @see #putExtra(String, CharSequence)
4406 */
4407 public CharSequence getCharSequenceExtra(String name) {
4408 return mExtras == null ? null : mExtras.getCharSequence(name);
4409 }
4410
4411 /**
4412 * Retrieve extended data from the intent.
4413 *
4414 * @param name The name of the desired item.
4415 *
4416 * @return the value of an item that previously added with putExtra()
4417 * or null if no Parcelable value was found.
4418 *
4419 * @see #putExtra(String, Parcelable)
4420 */
4421 public <T extends Parcelable> T getParcelableExtra(String name) {
4422 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4423 }
4424
4425 /**
4426 * Retrieve extended data from the intent.
4427 *
4428 * @param name The name of the desired item.
4429 *
4430 * @return the value of an item that previously added with putExtra()
4431 * or null if no Parcelable[] value was found.
4432 *
4433 * @see #putExtra(String, Parcelable[])
4434 */
4435 public Parcelable[] getParcelableArrayExtra(String name) {
4436 return mExtras == null ? null : mExtras.getParcelableArray(name);
4437 }
4438
4439 /**
4440 * Retrieve extended data from the intent.
4441 *
4442 * @param name The name of the desired item.
4443 *
4444 * @return the value of an item that previously added with putExtra()
4445 * or null if no ArrayList<Parcelable> value was found.
4446 *
4447 * @see #putParcelableArrayListExtra(String, ArrayList)
4448 */
4449 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4450 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4451 }
4452
4453 /**
4454 * Retrieve extended data from the intent.
4455 *
4456 * @param name The name of the desired item.
4457 *
4458 * @return the value of an item that previously added with putExtra()
4459 * or null if no Serializable value was found.
4460 *
4461 * @see #putExtra(String, Serializable)
4462 */
4463 public Serializable getSerializableExtra(String name) {
4464 return mExtras == null ? null : mExtras.getSerializable(name);
4465 }
4466
4467 /**
4468 * Retrieve extended data from the intent.
4469 *
4470 * @param name The name of the desired item.
4471 *
4472 * @return the value of an item that previously added with putExtra()
4473 * or null if no ArrayList<Integer> value was found.
4474 *
4475 * @see #putIntegerArrayListExtra(String, ArrayList)
4476 */
4477 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4478 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4479 }
4480
4481 /**
4482 * Retrieve extended data from the intent.
4483 *
4484 * @param name The name of the desired item.
4485 *
4486 * @return the value of an item that previously added with putExtra()
4487 * or null if no ArrayList<String> value was found.
4488 *
4489 * @see #putStringArrayListExtra(String, ArrayList)
4490 */
4491 public ArrayList<String> getStringArrayListExtra(String name) {
4492 return mExtras == null ? null : mExtras.getStringArrayList(name);
4493 }
4494
4495 /**
4496 * Retrieve extended data from the intent.
4497 *
4498 * @param name The name of the desired item.
4499 *
4500 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004501 * or null if no ArrayList<CharSequence> value was found.
4502 *
4503 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4504 */
4505 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4506 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4507 }
4508
4509 /**
4510 * Retrieve extended data from the intent.
4511 *
4512 * @param name The name of the desired item.
4513 *
4514 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004515 * or null if no boolean array value was found.
4516 *
4517 * @see #putExtra(String, boolean[])
4518 */
4519 public boolean[] getBooleanArrayExtra(String name) {
4520 return mExtras == null ? null : mExtras.getBooleanArray(name);
4521 }
4522
4523 /**
4524 * Retrieve extended data from the intent.
4525 *
4526 * @param name The name of the desired item.
4527 *
4528 * @return the value of an item that previously added with putExtra()
4529 * or null if no byte array value was found.
4530 *
4531 * @see #putExtra(String, byte[])
4532 */
4533 public byte[] getByteArrayExtra(String name) {
4534 return mExtras == null ? null : mExtras.getByteArray(name);
4535 }
4536
4537 /**
4538 * Retrieve extended data from the intent.
4539 *
4540 * @param name The name of the desired item.
4541 *
4542 * @return the value of an item that previously added with putExtra()
4543 * or null if no short array value was found.
4544 *
4545 * @see #putExtra(String, short[])
4546 */
4547 public short[] getShortArrayExtra(String name) {
4548 return mExtras == null ? null : mExtras.getShortArray(name);
4549 }
4550
4551 /**
4552 * Retrieve extended data from the intent.
4553 *
4554 * @param name The name of the desired item.
4555 *
4556 * @return the value of an item that previously added with putExtra()
4557 * or null if no char array value was found.
4558 *
4559 * @see #putExtra(String, char[])
4560 */
4561 public char[] getCharArrayExtra(String name) {
4562 return mExtras == null ? null : mExtras.getCharArray(name);
4563 }
4564
4565 /**
4566 * Retrieve extended data from the intent.
4567 *
4568 * @param name The name of the desired item.
4569 *
4570 * @return the value of an item that previously added with putExtra()
4571 * or null if no int array value was found.
4572 *
4573 * @see #putExtra(String, int[])
4574 */
4575 public int[] getIntArrayExtra(String name) {
4576 return mExtras == null ? null : mExtras.getIntArray(name);
4577 }
4578
4579 /**
4580 * Retrieve extended data from the intent.
4581 *
4582 * @param name The name of the desired item.
4583 *
4584 * @return the value of an item that previously added with putExtra()
4585 * or null if no long array value was found.
4586 *
4587 * @see #putExtra(String, long[])
4588 */
4589 public long[] getLongArrayExtra(String name) {
4590 return mExtras == null ? null : mExtras.getLongArray(name);
4591 }
4592
4593 /**
4594 * Retrieve extended data from the intent.
4595 *
4596 * @param name The name of the desired item.
4597 *
4598 * @return the value of an item that previously added with putExtra()
4599 * or null if no float array value was found.
4600 *
4601 * @see #putExtra(String, float[])
4602 */
4603 public float[] getFloatArrayExtra(String name) {
4604 return mExtras == null ? null : mExtras.getFloatArray(name);
4605 }
4606
4607 /**
4608 * Retrieve extended data from the intent.
4609 *
4610 * @param name The name of the desired item.
4611 *
4612 * @return the value of an item that previously added with putExtra()
4613 * or null if no double array value was found.
4614 *
4615 * @see #putExtra(String, double[])
4616 */
4617 public double[] getDoubleArrayExtra(String name) {
4618 return mExtras == null ? null : mExtras.getDoubleArray(name);
4619 }
4620
4621 /**
4622 * Retrieve extended data from the intent.
4623 *
4624 * @param name The name of the desired item.
4625 *
4626 * @return the value of an item that previously added with putExtra()
4627 * or null if no String array value was found.
4628 *
4629 * @see #putExtra(String, String[])
4630 */
4631 public String[] getStringArrayExtra(String name) {
4632 return mExtras == null ? null : mExtras.getStringArray(name);
4633 }
4634
4635 /**
4636 * Retrieve extended data from the intent.
4637 *
4638 * @param name The name of the desired item.
4639 *
4640 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004641 * or null if no CharSequence array value was found.
4642 *
4643 * @see #putExtra(String, CharSequence[])
4644 */
4645 public CharSequence[] getCharSequenceArrayExtra(String name) {
4646 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4647 }
4648
4649 /**
4650 * Retrieve extended data from the intent.
4651 *
4652 * @param name The name of the desired item.
4653 *
4654 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004655 * or null if no Bundle value was found.
4656 *
4657 * @see #putExtra(String, Bundle)
4658 */
4659 public Bundle getBundleExtra(String name) {
4660 return mExtras == null ? null : mExtras.getBundle(name);
4661 }
4662
4663 /**
4664 * Retrieve extended data from the intent.
4665 *
4666 * @param name The name of the desired item.
4667 *
4668 * @return the value of an item that previously added with putExtra()
4669 * or null if no IBinder value was found.
4670 *
4671 * @see #putExtra(String, IBinder)
4672 *
4673 * @deprecated
4674 * @hide
4675 */
4676 @Deprecated
4677 public IBinder getIBinderExtra(String name) {
4678 return mExtras == null ? null : mExtras.getIBinder(name);
4679 }
4680
4681 /**
4682 * Retrieve extended data from the intent.
4683 *
4684 * @param name The name of the desired item.
4685 * @param defaultValue The default value to return in case no item is
4686 * associated with the key 'name'
4687 *
4688 * @return the value of an item that previously added with putExtra()
4689 * or defaultValue if none was found.
4690 *
4691 * @see #putExtra
4692 *
4693 * @deprecated
4694 * @hide
4695 */
4696 @Deprecated
4697 public Object getExtra(String name, Object defaultValue) {
4698 Object result = defaultValue;
4699 if (mExtras != null) {
4700 Object result2 = mExtras.get(name);
4701 if (result2 != null) {
4702 result = result2;
4703 }
4704 }
4705
4706 return result;
4707 }
4708
4709 /**
4710 * Retrieves a map of extended data from the intent.
4711 *
4712 * @return the map of all extras previously added with putExtra(),
4713 * or null if none have been added.
4714 */
4715 public Bundle getExtras() {
4716 return (mExtras != null)
4717 ? new Bundle(mExtras)
4718 : null;
4719 }
4720
4721 /**
4722 * Retrieve any special flags associated with this intent. You will
4723 * normally just set them with {@link #setFlags} and let the system
4724 * take the appropriate action with them.
4725 *
4726 * @return int The currently set flags.
4727 *
4728 * @see #setFlags
4729 */
4730 public int getFlags() {
4731 return mFlags;
4732 }
4733
Dianne Hackborne7f97212011-02-24 14:40:20 -08004734 /** @hide */
4735 public boolean isExcludingStopped() {
4736 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4737 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4738 }
4739
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004740 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004741 * Retrieve the application package name this Intent is limited to. When
4742 * resolving an Intent, if non-null this limits the resolution to only
4743 * components in the given application package.
4744 *
4745 * @return The name of the application package for the Intent.
4746 *
4747 * @see #resolveActivity
4748 * @see #setPackage
4749 */
4750 public String getPackage() {
4751 return mPackage;
4752 }
4753
4754 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004755 * Retrieve the concrete component associated with the intent. When receiving
4756 * an intent, this is the component that was found to best handle it (that is,
4757 * yourself) and will always be non-null; in all other cases it will be
4758 * null unless explicitly set.
4759 *
4760 * @return The name of the application component to handle the intent.
4761 *
4762 * @see #resolveActivity
4763 * @see #setComponent
4764 */
4765 public ComponentName getComponent() {
4766 return mComponent;
4767 }
4768
4769 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004770 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4771 * used as a hint to the receiver for animations and the like. Null means that there
4772 * is no source bounds.
4773 */
4774 public Rect getSourceBounds() {
4775 return mSourceBounds;
4776 }
4777
4778 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004779 * Return the Activity component that should be used to handle this intent.
4780 * The appropriate component is determined based on the information in the
4781 * intent, evaluated as follows:
4782 *
4783 * <p>If {@link #getComponent} returns an explicit class, that is returned
4784 * without any further consideration.
4785 *
4786 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4787 * category to be considered.
4788 *
4789 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4790 * action.
4791 *
4792 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4793 * this type.
4794 *
4795 * <p>If {@link #addCategory} has added any categories, the activity must
4796 * handle ALL of the categories specified.
4797 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004798 * <p>If {@link #getPackage} is non-NULL, only activity components in
4799 * that application package will be considered.
4800 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004801 * <p>If there are no activities that satisfy all of these conditions, a
4802 * null string is returned.
4803 *
4804 * <p>If multiple activities are found to satisfy the intent, the one with
4805 * the highest priority will be used. If there are multiple activities
4806 * with the same priority, the system will either pick the best activity
4807 * based on user preference, or resolve to a system class that will allow
4808 * the user to pick an activity and forward from there.
4809 *
4810 * <p>This method is implemented simply by calling
4811 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4812 * true.</p>
4813 * <p> This API is called for you as part of starting an activity from an
4814 * intent. You do not normally need to call it yourself.</p>
4815 *
4816 * @param pm The package manager with which to resolve the Intent.
4817 *
4818 * @return Name of the component implementing an activity that can
4819 * display the intent.
4820 *
4821 * @see #setComponent
4822 * @see #getComponent
4823 * @see #resolveActivityInfo
4824 */
4825 public ComponentName resolveActivity(PackageManager pm) {
4826 if (mComponent != null) {
4827 return mComponent;
4828 }
4829
4830 ResolveInfo info = pm.resolveActivity(
4831 this, PackageManager.MATCH_DEFAULT_ONLY);
4832 if (info != null) {
4833 return new ComponentName(
4834 info.activityInfo.applicationInfo.packageName,
4835 info.activityInfo.name);
4836 }
4837
4838 return null;
4839 }
4840
4841 /**
4842 * Resolve the Intent into an {@link ActivityInfo}
4843 * describing the activity that should execute the intent. Resolution
4844 * follows the same rules as described for {@link #resolveActivity}, but
4845 * you get back the completely information about the resolved activity
4846 * instead of just its class name.
4847 *
4848 * @param pm The package manager with which to resolve the Intent.
4849 * @param flags Addition information to retrieve as per
4850 * {@link PackageManager#getActivityInfo(ComponentName, int)
4851 * PackageManager.getActivityInfo()}.
4852 *
4853 * @return PackageManager.ActivityInfo
4854 *
4855 * @see #resolveActivity
4856 */
4857 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4858 ActivityInfo ai = null;
4859 if (mComponent != null) {
4860 try {
4861 ai = pm.getActivityInfo(mComponent, flags);
4862 } catch (PackageManager.NameNotFoundException e) {
4863 // ignore
4864 }
4865 } else {
4866 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004867 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004868 if (info != null) {
4869 ai = info.activityInfo;
4870 }
4871 }
4872
4873 return ai;
4874 }
4875
4876 /**
4877 * Set the general action to be performed.
4878 *
4879 * @param action An action name, such as ACTION_VIEW. Application-specific
4880 * actions should be prefixed with the vendor's package name.
4881 *
4882 * @return Returns the same Intent object, for chaining multiple calls
4883 * into a single statement.
4884 *
4885 * @see #getAction
4886 */
4887 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004888 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004889 return this;
4890 }
4891
4892 /**
4893 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004894 * clears any type that was previously set by {@link #setType} or
4895 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004896 *
Nick Pellyccae4122012-01-09 14:12:58 -08004897 * <p><em>Note: scheme matching in the Android framework is
4898 * case-sensitive, unlike the formal RFC. As a result,
4899 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004900 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004901 * {@link #setDataAndNormalize}
4902 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004903 *
Nick Pellyccae4122012-01-09 14:12:58 -08004904 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004905 *
4906 * @return Returns the same Intent object, for chaining multiple calls
4907 * into a single statement.
4908 *
4909 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004910 * @see #setDataAndNormalize
4911 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004912 */
4913 public Intent setData(Uri data) {
4914 mData = data;
4915 mType = null;
4916 return this;
4917 }
4918
4919 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004920 * Normalize and set the data this intent is operating on.
4921 *
4922 * <p>This method automatically clears any type that was
4923 * previously set (for example, by {@link #setType}).
4924 *
4925 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004926 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004927 * so really this is just a convenience method for
4928 * <pre>
4929 * setData(data.normalize())
4930 * </pre>
4931 *
4932 * @param data The Uri of the data this intent is now targeting.
4933 *
4934 * @return Returns the same Intent object, for chaining multiple calls
4935 * into a single statement.
4936 *
4937 * @see #getData
4938 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004939 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004940 */
4941 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004942 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004943 }
4944
4945 /**
4946 * Set an explicit MIME data type.
4947 *
4948 * <p>This is used to create intents that only specify a type and not data,
4949 * for example to indicate the type of data to return.
4950 *
4951 * <p>This method automatically clears any data that was
4952 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004953 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004954 * <p><em>Note: MIME type matching in the Android framework is
4955 * case-sensitive, unlike formal RFC MIME types. As a result,
4956 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004957 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4958 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004959 *
4960 * @param type The MIME type of the data being handled by this intent.
4961 *
4962 * @return Returns the same Intent object, for chaining multiple calls
4963 * into a single statement.
4964 *
4965 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004966 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004967 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004968 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004969 */
4970 public Intent setType(String type) {
4971 mData = null;
4972 mType = type;
4973 return this;
4974 }
4975
4976 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004977 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004978 *
Nick Pellyccae4122012-01-09 14:12:58 -08004979 * <p>This is used to create intents that only specify a type and not data,
4980 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004981 *
Nick Pellyccae4122012-01-09 14:12:58 -08004982 * <p>This method automatically clears any data that was
4983 * previously set (for example by {@link #setData}).
4984 *
4985 * <p>The MIME type is normalized using
4986 * {@link #normalizeMimeType} before it is set,
4987 * so really this is just a convenience method for
4988 * <pre>
4989 * setType(Intent.normalizeMimeType(type))
4990 * </pre>
4991 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004992 * @param type The MIME type of the data being handled by this intent.
4993 *
4994 * @return Returns the same Intent object, for chaining multiple calls
4995 * into a single statement.
4996 *
Nick Pellyccae4122012-01-09 14:12:58 -08004997 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004998 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004999 * @see #normalizeMimeType
5000 */
5001 public Intent setTypeAndNormalize(String type) {
5002 return setType(normalizeMimeType(type));
5003 }
5004
5005 /**
5006 * (Usually optional) Set the data for the intent along with an explicit
5007 * MIME data type. This method should very rarely be used -- it allows you
5008 * to override the MIME type that would ordinarily be inferred from the
5009 * data with your own type given here.
5010 *
5011 * <p><em>Note: MIME type and Uri scheme matching in the
5012 * Android framework is case-sensitive, unlike the formal RFC definitions.
5013 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005014 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005015 * {@link #setDataAndTypeAndNormalize}
5016 * to ensure that they are converted to lower case.</em>
5017 *
5018 * @param data The Uri of the data this intent is now targeting.
5019 * @param type The MIME type of the data being handled by this intent.
5020 *
5021 * @return Returns the same Intent object, for chaining multiple calls
5022 * into a single statement.
5023 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005024 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005025 * @see #setData
5026 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005027 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005028 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005029 */
5030 public Intent setDataAndType(Uri data, String type) {
5031 mData = data;
5032 mType = type;
5033 return this;
5034 }
5035
5036 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005037 * (Usually optional) Normalize and set both the data Uri and an explicit
5038 * MIME data type. This method should very rarely be used -- it allows you
5039 * to override the MIME type that would ordinarily be inferred from the
5040 * data with your own type given here.
5041 *
5042 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005043 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005044 * before they are set, so really this is just a convenience method for
5045 * <pre>
5046 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5047 * </pre>
5048 *
5049 * @param data The Uri of the data this intent is now targeting.
5050 * @param type The MIME type of the data being handled by this intent.
5051 *
5052 * @return Returns the same Intent object, for chaining multiple calls
5053 * into a single statement.
5054 *
5055 * @see #setType
5056 * @see #setData
5057 * @see #setDataAndType
5058 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005059 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005060 */
5061 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005062 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005063 }
5064
5065 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005066 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005067 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005068 * activities that provide <em>all</em> of the requested categories will be
5069 * used.
5070 *
5071 * @param category The desired category. This can be either one of the
5072 * predefined Intent categories, or a custom category in your own
5073 * namespace.
5074 *
5075 * @return Returns the same Intent object, for chaining multiple calls
5076 * into a single statement.
5077 *
5078 * @see #hasCategory
5079 * @see #removeCategory
5080 */
5081 public Intent addCategory(String category) {
5082 if (mCategories == null) {
5083 mCategories = new HashSet<String>();
5084 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005085 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005086 return this;
5087 }
5088
5089 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005090 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005091 *
5092 * @param category The category to remove.
5093 *
5094 * @see #addCategory
5095 */
5096 public void removeCategory(String category) {
5097 if (mCategories != null) {
5098 mCategories.remove(category);
5099 if (mCategories.size() == 0) {
5100 mCategories = null;
5101 }
5102 }
5103 }
5104
5105 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005106 * Set a selector for this Intent. This is a modification to the kinds of
5107 * things the Intent will match. If the selector is set, it will be used
5108 * when trying to find entities that can handle the Intent, instead of the
5109 * main contents of the Intent. This allows you build an Intent containing
5110 * a generic protocol while targeting it more specifically.
5111 *
5112 * <p>An example of where this may be used is with things like
5113 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5114 * Intent that will launch the Browser application. However, the correct
5115 * main entry point of an application is actually {@link #ACTION_MAIN}
5116 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5117 * used to specify the actual Activity to launch. If you launch the browser
5118 * with something different, undesired behavior may happen if the user has
5119 * previously or later launches it the normal way, since they do not match.
5120 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5121 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5122 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5123 *
5124 * <p>Setting a selector does not impact the behavior of
5125 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5126 * desired behavior of a selector -- it does not impact the base meaning
5127 * of the Intent, just what kinds of things will be matched against it
5128 * when determining who can handle it.</p>
5129 *
5130 * <p>You can not use both a selector and {@link #setPackage(String)} on
5131 * the same base Intent.</p>
5132 *
5133 * @param selector The desired selector Intent; set to null to not use
5134 * a special selector.
5135 */
5136 public void setSelector(Intent selector) {
5137 if (selector == this) {
5138 throw new IllegalArgumentException(
5139 "Intent being set as a selector of itself");
5140 }
5141 if (selector != null && mPackage != null) {
5142 throw new IllegalArgumentException(
5143 "Can't set selector when package name is already set");
5144 }
5145 mSelector = selector;
5146 }
5147
5148 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005149 * Set a {@link ClipData} associated with this Intent. This replaces any
5150 * previously set ClipData.
5151 *
5152 * <p>The ClipData in an intent is not used for Intent matching or other
5153 * such operations. Semantically it is like extras, used to transmit
5154 * additional data with the Intent. The main feature of using this over
5155 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5156 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5157 * items included in the clip data. This is useful, in particular, if
5158 * you want to transmit an Intent containing multiple <code>content:</code>
5159 * URIs for which the recipient may not have global permission to access the
5160 * content provider.
5161 *
5162 * <p>If the ClipData contains items that are themselves Intents, any
5163 * grant flags in those Intents will be ignored. Only the top-level flags
5164 * of the main Intent are respected, and will be applied to all Uri or
5165 * Intent items in the clip (or sub-items of the clip).
5166 *
5167 * <p>The MIME type, label, and icon in the ClipData object are not
5168 * directly used by Intent. Applications should generally rely on the
5169 * MIME type of the Intent itself, not what it may find in the ClipData.
5170 * A common practice is to construct a ClipData for use with an Intent
5171 * with a MIME type of "*\/*".
5172 *
5173 * @param clip The new clip to set. May be null to clear the current clip.
5174 */
5175 public void setClipData(ClipData clip) {
5176 mClipData = clip;
5177 }
5178
5179 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005180 * Add extended data to the intent. The name must include a package
5181 * prefix, for example the app com.android.contacts would use names
5182 * like "com.android.contacts.ShowAll".
5183 *
5184 * @param name The name of the extra data, with package prefix.
5185 * @param value The boolean data value.
5186 *
5187 * @return Returns the same Intent object, for chaining multiple calls
5188 * into a single statement.
5189 *
5190 * @see #putExtras
5191 * @see #removeExtra
5192 * @see #getBooleanExtra(String, boolean)
5193 */
5194 public Intent putExtra(String name, boolean value) {
5195 if (mExtras == null) {
5196 mExtras = new Bundle();
5197 }
5198 mExtras.putBoolean(name, value);
5199 return this;
5200 }
5201
5202 /**
5203 * Add extended data to the intent. The name must include a package
5204 * prefix, for example the app com.android.contacts would use names
5205 * like "com.android.contacts.ShowAll".
5206 *
5207 * @param name The name of the extra data, with package prefix.
5208 * @param value The byte data value.
5209 *
5210 * @return Returns the same Intent object, for chaining multiple calls
5211 * into a single statement.
5212 *
5213 * @see #putExtras
5214 * @see #removeExtra
5215 * @see #getByteExtra(String, byte)
5216 */
5217 public Intent putExtra(String name, byte value) {
5218 if (mExtras == null) {
5219 mExtras = new Bundle();
5220 }
5221 mExtras.putByte(name, value);
5222 return this;
5223 }
5224
5225 /**
5226 * Add extended data to the intent. The name must include a package
5227 * prefix, for example the app com.android.contacts would use names
5228 * like "com.android.contacts.ShowAll".
5229 *
5230 * @param name The name of the extra data, with package prefix.
5231 * @param value The char data value.
5232 *
5233 * @return Returns the same Intent object, for chaining multiple calls
5234 * into a single statement.
5235 *
5236 * @see #putExtras
5237 * @see #removeExtra
5238 * @see #getCharExtra(String, char)
5239 */
5240 public Intent putExtra(String name, char value) {
5241 if (mExtras == null) {
5242 mExtras = new Bundle();
5243 }
5244 mExtras.putChar(name, value);
5245 return this;
5246 }
5247
5248 /**
5249 * Add extended data to the intent. The name must include a package
5250 * prefix, for example the app com.android.contacts would use names
5251 * like "com.android.contacts.ShowAll".
5252 *
5253 * @param name The name of the extra data, with package prefix.
5254 * @param value The short data value.
5255 *
5256 * @return Returns the same Intent object, for chaining multiple calls
5257 * into a single statement.
5258 *
5259 * @see #putExtras
5260 * @see #removeExtra
5261 * @see #getShortExtra(String, short)
5262 */
5263 public Intent putExtra(String name, short value) {
5264 if (mExtras == null) {
5265 mExtras = new Bundle();
5266 }
5267 mExtras.putShort(name, value);
5268 return this;
5269 }
5270
5271 /**
5272 * Add extended data to the intent. The name must include a package
5273 * prefix, for example the app com.android.contacts would use names
5274 * like "com.android.contacts.ShowAll".
5275 *
5276 * @param name The name of the extra data, with package prefix.
5277 * @param value The integer data value.
5278 *
5279 * @return Returns the same Intent object, for chaining multiple calls
5280 * into a single statement.
5281 *
5282 * @see #putExtras
5283 * @see #removeExtra
5284 * @see #getIntExtra(String, int)
5285 */
5286 public Intent putExtra(String name, int value) {
5287 if (mExtras == null) {
5288 mExtras = new Bundle();
5289 }
5290 mExtras.putInt(name, value);
5291 return this;
5292 }
5293
5294 /**
5295 * Add extended data to the intent. The name must include a package
5296 * prefix, for example the app com.android.contacts would use names
5297 * like "com.android.contacts.ShowAll".
5298 *
5299 * @param name The name of the extra data, with package prefix.
5300 * @param value The long data value.
5301 *
5302 * @return Returns the same Intent object, for chaining multiple calls
5303 * into a single statement.
5304 *
5305 * @see #putExtras
5306 * @see #removeExtra
5307 * @see #getLongExtra(String, long)
5308 */
5309 public Intent putExtra(String name, long value) {
5310 if (mExtras == null) {
5311 mExtras = new Bundle();
5312 }
5313 mExtras.putLong(name, value);
5314 return this;
5315 }
5316
5317 /**
5318 * Add extended data to the intent. The name must include a package
5319 * prefix, for example the app com.android.contacts would use names
5320 * like "com.android.contacts.ShowAll".
5321 *
5322 * @param name The name of the extra data, with package prefix.
5323 * @param value The float data value.
5324 *
5325 * @return Returns the same Intent object, for chaining multiple calls
5326 * into a single statement.
5327 *
5328 * @see #putExtras
5329 * @see #removeExtra
5330 * @see #getFloatExtra(String, float)
5331 */
5332 public Intent putExtra(String name, float value) {
5333 if (mExtras == null) {
5334 mExtras = new Bundle();
5335 }
5336 mExtras.putFloat(name, value);
5337 return this;
5338 }
5339
5340 /**
5341 * Add extended data to the intent. The name must include a package
5342 * prefix, for example the app com.android.contacts would use names
5343 * like "com.android.contacts.ShowAll".
5344 *
5345 * @param name The name of the extra data, with package prefix.
5346 * @param value The double data value.
5347 *
5348 * @return Returns the same Intent object, for chaining multiple calls
5349 * into a single statement.
5350 *
5351 * @see #putExtras
5352 * @see #removeExtra
5353 * @see #getDoubleExtra(String, double)
5354 */
5355 public Intent putExtra(String name, double value) {
5356 if (mExtras == null) {
5357 mExtras = new Bundle();
5358 }
5359 mExtras.putDouble(name, value);
5360 return this;
5361 }
5362
5363 /**
5364 * Add extended data to the intent. The name must include a package
5365 * prefix, for example the app com.android.contacts would use names
5366 * like "com.android.contacts.ShowAll".
5367 *
5368 * @param name The name of the extra data, with package prefix.
5369 * @param value The String data value.
5370 *
5371 * @return Returns the same Intent object, for chaining multiple calls
5372 * into a single statement.
5373 *
5374 * @see #putExtras
5375 * @see #removeExtra
5376 * @see #getStringExtra(String)
5377 */
5378 public Intent putExtra(String name, String value) {
5379 if (mExtras == null) {
5380 mExtras = new Bundle();
5381 }
5382 mExtras.putString(name, value);
5383 return this;
5384 }
5385
5386 /**
5387 * Add extended data to the intent. The name must include a package
5388 * prefix, for example the app com.android.contacts would use names
5389 * like "com.android.contacts.ShowAll".
5390 *
5391 * @param name The name of the extra data, with package prefix.
5392 * @param value The CharSequence data value.
5393 *
5394 * @return Returns the same Intent object, for chaining multiple calls
5395 * into a single statement.
5396 *
5397 * @see #putExtras
5398 * @see #removeExtra
5399 * @see #getCharSequenceExtra(String)
5400 */
5401 public Intent putExtra(String name, CharSequence value) {
5402 if (mExtras == null) {
5403 mExtras = new Bundle();
5404 }
5405 mExtras.putCharSequence(name, value);
5406 return this;
5407 }
5408
5409 /**
5410 * Add extended data to the intent. The name must include a package
5411 * prefix, for example the app com.android.contacts would use names
5412 * like "com.android.contacts.ShowAll".
5413 *
5414 * @param name The name of the extra data, with package prefix.
5415 * @param value The Parcelable data value.
5416 *
5417 * @return Returns the same Intent object, for chaining multiple calls
5418 * into a single statement.
5419 *
5420 * @see #putExtras
5421 * @see #removeExtra
5422 * @see #getParcelableExtra(String)
5423 */
5424 public Intent putExtra(String name, Parcelable value) {
5425 if (mExtras == null) {
5426 mExtras = new Bundle();
5427 }
5428 mExtras.putParcelable(name, value);
5429 return this;
5430 }
5431
5432 /**
5433 * Add extended data to the intent. The name must include a package
5434 * prefix, for example the app com.android.contacts would use names
5435 * like "com.android.contacts.ShowAll".
5436 *
5437 * @param name The name of the extra data, with package prefix.
5438 * @param value The Parcelable[] data value.
5439 *
5440 * @return Returns the same Intent object, for chaining multiple calls
5441 * into a single statement.
5442 *
5443 * @see #putExtras
5444 * @see #removeExtra
5445 * @see #getParcelableArrayExtra(String)
5446 */
5447 public Intent putExtra(String name, Parcelable[] value) {
5448 if (mExtras == null) {
5449 mExtras = new Bundle();
5450 }
5451 mExtras.putParcelableArray(name, value);
5452 return this;
5453 }
5454
5455 /**
5456 * Add extended data to the intent. The name must include a package
5457 * prefix, for example the app com.android.contacts would use names
5458 * like "com.android.contacts.ShowAll".
5459 *
5460 * @param name The name of the extra data, with package prefix.
5461 * @param value The ArrayList<Parcelable> data value.
5462 *
5463 * @return Returns the same Intent object, for chaining multiple calls
5464 * into a single statement.
5465 *
5466 * @see #putExtras
5467 * @see #removeExtra
5468 * @see #getParcelableArrayListExtra(String)
5469 */
5470 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5471 if (mExtras == null) {
5472 mExtras = new Bundle();
5473 }
5474 mExtras.putParcelableArrayList(name, value);
5475 return this;
5476 }
5477
5478 /**
5479 * Add extended data to the intent. The name must include a package
5480 * prefix, for example the app com.android.contacts would use names
5481 * like "com.android.contacts.ShowAll".
5482 *
5483 * @param name The name of the extra data, with package prefix.
5484 * @param value The ArrayList<Integer> data value.
5485 *
5486 * @return Returns the same Intent object, for chaining multiple calls
5487 * into a single statement.
5488 *
5489 * @see #putExtras
5490 * @see #removeExtra
5491 * @see #getIntegerArrayListExtra(String)
5492 */
5493 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5494 if (mExtras == null) {
5495 mExtras = new Bundle();
5496 }
5497 mExtras.putIntegerArrayList(name, value);
5498 return this;
5499 }
5500
5501 /**
5502 * Add extended data to the intent. The name must include a package
5503 * prefix, for example the app com.android.contacts would use names
5504 * like "com.android.contacts.ShowAll".
5505 *
5506 * @param name The name of the extra data, with package prefix.
5507 * @param value The ArrayList<String> data value.
5508 *
5509 * @return Returns the same Intent object, for chaining multiple calls
5510 * into a single statement.
5511 *
5512 * @see #putExtras
5513 * @see #removeExtra
5514 * @see #getStringArrayListExtra(String)
5515 */
5516 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5517 if (mExtras == null) {
5518 mExtras = new Bundle();
5519 }
5520 mExtras.putStringArrayList(name, value);
5521 return this;
5522 }
5523
5524 /**
5525 * Add extended data to the intent. The name must include a package
5526 * prefix, for example the app com.android.contacts would use names
5527 * like "com.android.contacts.ShowAll".
5528 *
5529 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005530 * @param value The ArrayList<CharSequence> data value.
5531 *
5532 * @return Returns the same Intent object, for chaining multiple calls
5533 * into a single statement.
5534 *
5535 * @see #putExtras
5536 * @see #removeExtra
5537 * @see #getCharSequenceArrayListExtra(String)
5538 */
5539 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5540 if (mExtras == null) {
5541 mExtras = new Bundle();
5542 }
5543 mExtras.putCharSequenceArrayList(name, value);
5544 return this;
5545 }
5546
5547 /**
5548 * Add extended data to the intent. The name must include a package
5549 * prefix, for example the app com.android.contacts would use names
5550 * like "com.android.contacts.ShowAll".
5551 *
5552 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005553 * @param value The Serializable data value.
5554 *
5555 * @return Returns the same Intent object, for chaining multiple calls
5556 * into a single statement.
5557 *
5558 * @see #putExtras
5559 * @see #removeExtra
5560 * @see #getSerializableExtra(String)
5561 */
5562 public Intent putExtra(String name, Serializable value) {
5563 if (mExtras == null) {
5564 mExtras = new Bundle();
5565 }
5566 mExtras.putSerializable(name, value);
5567 return this;
5568 }
5569
5570 /**
5571 * Add extended data to the intent. The name must include a package
5572 * prefix, for example the app com.android.contacts would use names
5573 * like "com.android.contacts.ShowAll".
5574 *
5575 * @param name The name of the extra data, with package prefix.
5576 * @param value The boolean array data value.
5577 *
5578 * @return Returns the same Intent object, for chaining multiple calls
5579 * into a single statement.
5580 *
5581 * @see #putExtras
5582 * @see #removeExtra
5583 * @see #getBooleanArrayExtra(String)
5584 */
5585 public Intent putExtra(String name, boolean[] value) {
5586 if (mExtras == null) {
5587 mExtras = new Bundle();
5588 }
5589 mExtras.putBooleanArray(name, value);
5590 return this;
5591 }
5592
5593 /**
5594 * Add extended data to the intent. The name must include a package
5595 * prefix, for example the app com.android.contacts would use names
5596 * like "com.android.contacts.ShowAll".
5597 *
5598 * @param name The name of the extra data, with package prefix.
5599 * @param value The byte array data value.
5600 *
5601 * @return Returns the same Intent object, for chaining multiple calls
5602 * into a single statement.
5603 *
5604 * @see #putExtras
5605 * @see #removeExtra
5606 * @see #getByteArrayExtra(String)
5607 */
5608 public Intent putExtra(String name, byte[] value) {
5609 if (mExtras == null) {
5610 mExtras = new Bundle();
5611 }
5612 mExtras.putByteArray(name, value);
5613 return this;
5614 }
5615
5616 /**
5617 * Add extended data to the intent. The name must include a package
5618 * prefix, for example the app com.android.contacts would use names
5619 * like "com.android.contacts.ShowAll".
5620 *
5621 * @param name The name of the extra data, with package prefix.
5622 * @param value The short array data value.
5623 *
5624 * @return Returns the same Intent object, for chaining multiple calls
5625 * into a single statement.
5626 *
5627 * @see #putExtras
5628 * @see #removeExtra
5629 * @see #getShortArrayExtra(String)
5630 */
5631 public Intent putExtra(String name, short[] value) {
5632 if (mExtras == null) {
5633 mExtras = new Bundle();
5634 }
5635 mExtras.putShortArray(name, value);
5636 return this;
5637 }
5638
5639 /**
5640 * Add extended data to the intent. The name must include a package
5641 * prefix, for example the app com.android.contacts would use names
5642 * like "com.android.contacts.ShowAll".
5643 *
5644 * @param name The name of the extra data, with package prefix.
5645 * @param value The char array data value.
5646 *
5647 * @return Returns the same Intent object, for chaining multiple calls
5648 * into a single statement.
5649 *
5650 * @see #putExtras
5651 * @see #removeExtra
5652 * @see #getCharArrayExtra(String)
5653 */
5654 public Intent putExtra(String name, char[] value) {
5655 if (mExtras == null) {
5656 mExtras = new Bundle();
5657 }
5658 mExtras.putCharArray(name, value);
5659 return this;
5660 }
5661
5662 /**
5663 * Add extended data to the intent. The name must include a package
5664 * prefix, for example the app com.android.contacts would use names
5665 * like "com.android.contacts.ShowAll".
5666 *
5667 * @param name The name of the extra data, with package prefix.
5668 * @param value The int array data value.
5669 *
5670 * @return Returns the same Intent object, for chaining multiple calls
5671 * into a single statement.
5672 *
5673 * @see #putExtras
5674 * @see #removeExtra
5675 * @see #getIntArrayExtra(String)
5676 */
5677 public Intent putExtra(String name, int[] value) {
5678 if (mExtras == null) {
5679 mExtras = new Bundle();
5680 }
5681 mExtras.putIntArray(name, value);
5682 return this;
5683 }
5684
5685 /**
5686 * Add extended data to the intent. The name must include a package
5687 * prefix, for example the app com.android.contacts would use names
5688 * like "com.android.contacts.ShowAll".
5689 *
5690 * @param name The name of the extra data, with package prefix.
5691 * @param value The byte array data value.
5692 *
5693 * @return Returns the same Intent object, for chaining multiple calls
5694 * into a single statement.
5695 *
5696 * @see #putExtras
5697 * @see #removeExtra
5698 * @see #getLongArrayExtra(String)
5699 */
5700 public Intent putExtra(String name, long[] value) {
5701 if (mExtras == null) {
5702 mExtras = new Bundle();
5703 }
5704 mExtras.putLongArray(name, value);
5705 return this;
5706 }
5707
5708 /**
5709 * Add extended data to the intent. The name must include a package
5710 * prefix, for example the app com.android.contacts would use names
5711 * like "com.android.contacts.ShowAll".
5712 *
5713 * @param name The name of the extra data, with package prefix.
5714 * @param value The float array data value.
5715 *
5716 * @return Returns the same Intent object, for chaining multiple calls
5717 * into a single statement.
5718 *
5719 * @see #putExtras
5720 * @see #removeExtra
5721 * @see #getFloatArrayExtra(String)
5722 */
5723 public Intent putExtra(String name, float[] value) {
5724 if (mExtras == null) {
5725 mExtras = new Bundle();
5726 }
5727 mExtras.putFloatArray(name, value);
5728 return this;
5729 }
5730
5731 /**
5732 * Add extended data to the intent. The name must include a package
5733 * prefix, for example the app com.android.contacts would use names
5734 * like "com.android.contacts.ShowAll".
5735 *
5736 * @param name The name of the extra data, with package prefix.
5737 * @param value The double array data value.
5738 *
5739 * @return Returns the same Intent object, for chaining multiple calls
5740 * into a single statement.
5741 *
5742 * @see #putExtras
5743 * @see #removeExtra
5744 * @see #getDoubleArrayExtra(String)
5745 */
5746 public Intent putExtra(String name, double[] value) {
5747 if (mExtras == null) {
5748 mExtras = new Bundle();
5749 }
5750 mExtras.putDoubleArray(name, value);
5751 return this;
5752 }
5753
5754 /**
5755 * Add extended data to the intent. The name must include a package
5756 * prefix, for example the app com.android.contacts would use names
5757 * like "com.android.contacts.ShowAll".
5758 *
5759 * @param name The name of the extra data, with package prefix.
5760 * @param value The String array data value.
5761 *
5762 * @return Returns the same Intent object, for chaining multiple calls
5763 * into a single statement.
5764 *
5765 * @see #putExtras
5766 * @see #removeExtra
5767 * @see #getStringArrayExtra(String)
5768 */
5769 public Intent putExtra(String name, String[] value) {
5770 if (mExtras == null) {
5771 mExtras = new Bundle();
5772 }
5773 mExtras.putStringArray(name, value);
5774 return this;
5775 }
5776
5777 /**
5778 * Add extended data to the intent. The name must include a package
5779 * prefix, for example the app com.android.contacts would use names
5780 * like "com.android.contacts.ShowAll".
5781 *
5782 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005783 * @param value The CharSequence array data value.
5784 *
5785 * @return Returns the same Intent object, for chaining multiple calls
5786 * into a single statement.
5787 *
5788 * @see #putExtras
5789 * @see #removeExtra
5790 * @see #getCharSequenceArrayExtra(String)
5791 */
5792 public Intent putExtra(String name, CharSequence[] value) {
5793 if (mExtras == null) {
5794 mExtras = new Bundle();
5795 }
5796 mExtras.putCharSequenceArray(name, value);
5797 return this;
5798 }
5799
5800 /**
5801 * Add extended data to the intent. The name must include a package
5802 * prefix, for example the app com.android.contacts would use names
5803 * like "com.android.contacts.ShowAll".
5804 *
5805 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005806 * @param value The Bundle data value.
5807 *
5808 * @return Returns the same Intent object, for chaining multiple calls
5809 * into a single statement.
5810 *
5811 * @see #putExtras
5812 * @see #removeExtra
5813 * @see #getBundleExtra(String)
5814 */
5815 public Intent putExtra(String name, Bundle value) {
5816 if (mExtras == null) {
5817 mExtras = new Bundle();
5818 }
5819 mExtras.putBundle(name, value);
5820 return this;
5821 }
5822
5823 /**
5824 * Add extended data to the intent. The name must include a package
5825 * prefix, for example the app com.android.contacts would use names
5826 * like "com.android.contacts.ShowAll".
5827 *
5828 * @param name The name of the extra data, with package prefix.
5829 * @param value The IBinder data value.
5830 *
5831 * @return Returns the same Intent object, for chaining multiple calls
5832 * into a single statement.
5833 *
5834 * @see #putExtras
5835 * @see #removeExtra
5836 * @see #getIBinderExtra(String)
5837 *
5838 * @deprecated
5839 * @hide
5840 */
5841 @Deprecated
5842 public Intent putExtra(String name, IBinder value) {
5843 if (mExtras == null) {
5844 mExtras = new Bundle();
5845 }
5846 mExtras.putIBinder(name, value);
5847 return this;
5848 }
5849
5850 /**
5851 * Copy all extras in 'src' in to this intent.
5852 *
5853 * @param src Contains the extras to copy.
5854 *
5855 * @see #putExtra
5856 */
5857 public Intent putExtras(Intent src) {
5858 if (src.mExtras != null) {
5859 if (mExtras == null) {
5860 mExtras = new Bundle(src.mExtras);
5861 } else {
5862 mExtras.putAll(src.mExtras);
5863 }
5864 }
5865 return this;
5866 }
5867
5868 /**
5869 * Add a set of extended data to the intent. The keys must include a package
5870 * prefix, for example the app com.android.contacts would use names
5871 * like "com.android.contacts.ShowAll".
5872 *
5873 * @param extras The Bundle of extras to add to this intent.
5874 *
5875 * @see #putExtra
5876 * @see #removeExtra
5877 */
5878 public Intent putExtras(Bundle extras) {
5879 if (mExtras == null) {
5880 mExtras = new Bundle();
5881 }
5882 mExtras.putAll(extras);
5883 return this;
5884 }
5885
5886 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005887 * Completely replace the extras in the Intent with the extras in the
5888 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005889 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005890 * @param src The exact extras contained in this Intent are copied
5891 * into the target intent, replacing any that were previously there.
5892 */
5893 public Intent replaceExtras(Intent src) {
5894 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5895 return this;
5896 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005897
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005898 /**
5899 * Completely replace the extras in the Intent with the given Bundle of
5900 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005901 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005902 * @param extras The new set of extras in the Intent, or null to erase
5903 * all extras.
5904 */
5905 public Intent replaceExtras(Bundle extras) {
5906 mExtras = extras != null ? new Bundle(extras) : null;
5907 return this;
5908 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005909
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005910 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005911 * Remove extended data from the intent.
5912 *
5913 * @see #putExtra
5914 */
5915 public void removeExtra(String name) {
5916 if (mExtras != null) {
5917 mExtras.remove(name);
5918 if (mExtras.size() == 0) {
5919 mExtras = null;
5920 }
5921 }
5922 }
5923
5924 /**
5925 * Set special flags controlling how this intent is handled. Most values
5926 * here depend on the type of component being executed by the Intent,
5927 * specifically the FLAG_ACTIVITY_* flags are all for use with
5928 * {@link Context#startActivity Context.startActivity()} and the
5929 * FLAG_RECEIVER_* flags are all for use with
5930 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5931 *
Scott Main7aee61f2011-02-08 11:25:01 -08005932 * <p>See the
5933 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5934 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005935 * the behavior of your application.
5936 *
5937 * @param flags The desired flags.
5938 *
5939 * @return Returns the same Intent object, for chaining multiple calls
5940 * into a single statement.
5941 *
5942 * @see #getFlags
5943 * @see #addFlags
5944 *
5945 * @see #FLAG_GRANT_READ_URI_PERMISSION
5946 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5947 * @see #FLAG_DEBUG_LOG_RESOLUTION
5948 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005949 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005950 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005951 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005952 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005953 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5954 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005955 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005956 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5957 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005958 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005959 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005960 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005961 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5962 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005963 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005964 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005965 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005966 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5967 */
5968 public Intent setFlags(int flags) {
5969 mFlags = flags;
5970 return this;
5971 }
5972
5973 /**
5974 * Add additional flags to the intent (or with existing flags
5975 * value).
5976 *
5977 * @param flags The new flags to set.
5978 *
5979 * @return Returns the same Intent object, for chaining multiple calls
5980 * into a single statement.
5981 *
5982 * @see #setFlags
5983 */
5984 public Intent addFlags(int flags) {
5985 mFlags |= flags;
5986 return this;
5987 }
5988
5989 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005990 * (Usually optional) Set an explicit application package name that limits
5991 * the components this Intent will resolve to. If left to the default
5992 * value of null, all components in all applications will considered.
5993 * If non-null, the Intent can only match the components in the given
5994 * application package.
5995 *
5996 * @param packageName The name of the application package to handle the
5997 * intent, or null to allow any application package.
5998 *
5999 * @return Returns the same Intent object, for chaining multiple calls
6000 * into a single statement.
6001 *
6002 * @see #getPackage
6003 * @see #resolveActivity
6004 */
6005 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006006 if (packageName != null && mSelector != null) {
6007 throw new IllegalArgumentException(
6008 "Can't set package name when selector is already set");
6009 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006010 mPackage = packageName;
6011 return this;
6012 }
6013
6014 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006015 * (Usually optional) Explicitly set the component to handle the intent.
6016 * If left with the default value of null, the system will determine the
6017 * appropriate class to use based on the other fields (action, data,
6018 * type, categories) in the Intent. If this class is defined, the
6019 * specified class will always be used regardless of the other fields. You
6020 * should only set this value when you know you absolutely want a specific
6021 * class to be used; otherwise it is better to let the system find the
6022 * appropriate class so that you will respect the installed applications
6023 * and user preferences.
6024 *
6025 * @param component The name of the application component to handle the
6026 * intent, or null to let the system find one for you.
6027 *
6028 * @return Returns the same Intent object, for chaining multiple calls
6029 * into a single statement.
6030 *
6031 * @see #setClass
6032 * @see #setClassName(Context, String)
6033 * @see #setClassName(String, String)
6034 * @see #getComponent
6035 * @see #resolveActivity
6036 */
6037 public Intent setComponent(ComponentName component) {
6038 mComponent = component;
6039 return this;
6040 }
6041
6042 /**
6043 * Convenience for calling {@link #setComponent} with an
6044 * explicit class name.
6045 *
6046 * @param packageContext A Context of the application package implementing
6047 * this class.
6048 * @param className The name of a class inside of the application package
6049 * that will be used as the component for this Intent.
6050 *
6051 * @return Returns the same Intent object, for chaining multiple calls
6052 * into a single statement.
6053 *
6054 * @see #setComponent
6055 * @see #setClass
6056 */
6057 public Intent setClassName(Context packageContext, String className) {
6058 mComponent = new ComponentName(packageContext, className);
6059 return this;
6060 }
6061
6062 /**
6063 * Convenience for calling {@link #setComponent} with an
6064 * explicit application package name and class name.
6065 *
6066 * @param packageName The name of the package implementing the desired
6067 * component.
6068 * @param className The name of a class inside of the application package
6069 * that will be used as the component for this Intent.
6070 *
6071 * @return Returns the same Intent object, for chaining multiple calls
6072 * into a single statement.
6073 *
6074 * @see #setComponent
6075 * @see #setClass
6076 */
6077 public Intent setClassName(String packageName, String className) {
6078 mComponent = new ComponentName(packageName, className);
6079 return this;
6080 }
6081
6082 /**
6083 * Convenience for calling {@link #setComponent(ComponentName)} with the
6084 * name returned by a {@link Class} object.
6085 *
6086 * @param packageContext A Context of the application package implementing
6087 * this class.
6088 * @param cls The class name to set, equivalent to
6089 * <code>setClassName(context, cls.getName())</code>.
6090 *
6091 * @return Returns the same Intent object, for chaining multiple calls
6092 * into a single statement.
6093 *
6094 * @see #setComponent
6095 */
6096 public Intent setClass(Context packageContext, Class<?> cls) {
6097 mComponent = new ComponentName(packageContext, cls);
6098 return this;
6099 }
6100
6101 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006102 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6103 * used as a hint to the receiver for animations and the like. Null means that there
6104 * is no source bounds.
6105 */
6106 public void setSourceBounds(Rect r) {
6107 if (r != null) {
6108 mSourceBounds = new Rect(r);
6109 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006110 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006111 }
6112 }
6113
6114 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006115 * Use with {@link #fillIn} to allow the current action value to be
6116 * overwritten, even if it is already set.
6117 */
6118 public static final int FILL_IN_ACTION = 1<<0;
6119
6120 /**
6121 * Use with {@link #fillIn} to allow the current data or type value
6122 * overwritten, even if it is already set.
6123 */
6124 public static final int FILL_IN_DATA = 1<<1;
6125
6126 /**
6127 * Use with {@link #fillIn} to allow the current categories to be
6128 * overwritten, even if they are already set.
6129 */
6130 public static final int FILL_IN_CATEGORIES = 1<<2;
6131
6132 /**
6133 * Use with {@link #fillIn} to allow the current component value to be
6134 * overwritten, even if it is already set.
6135 */
6136 public static final int FILL_IN_COMPONENT = 1<<3;
6137
6138 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006139 * Use with {@link #fillIn} to allow the current package value to be
6140 * overwritten, even if it is already set.
6141 */
6142 public static final int FILL_IN_PACKAGE = 1<<4;
6143
6144 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006145 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006146 * overwritten, even if it is already set.
6147 */
6148 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6149
6150 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006151 * Use with {@link #fillIn} to allow the current selector to be
6152 * overwritten, even if it is already set.
6153 */
6154 public static final int FILL_IN_SELECTOR = 1<<6;
6155
6156 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006157 * Use with {@link #fillIn} to allow the current ClipData to be
6158 * overwritten, even if it is already set.
6159 */
6160 public static final int FILL_IN_CLIP_DATA = 1<<7;
6161
6162 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006163 * Copy the contents of <var>other</var> in to this object, but only
6164 * where fields are not defined by this object. For purposes of a field
6165 * being defined, the following pieces of data in the Intent are
6166 * considered to be separate fields:
6167 *
6168 * <ul>
6169 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006170 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006171 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6172 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006173 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006174 * <li> component, as set by {@link #setComponent(ComponentName)} or
6175 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006176 * <li> source bounds, as set by {@link #setSourceBounds}.
6177 * <li> selector, as set by {@link #setSelector(Intent)}.
6178 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006179 * <li> each top-level name in the associated extras.
6180 * </ul>
6181 *
6182 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006183 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006184 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6185 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6186 * the restriction where the corresponding field will not be replaced if
6187 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006188 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006189 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6190 * is explicitly specified. The selector will only be copied if
6191 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006192 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006193 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6194 * and Intent B with {action="gotit", data-type="some/thing",
6195 * categories="one","two"}.
6196 *
6197 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6198 * containing: {action="gotit", data-type="some/thing",
6199 * categories="bar"}.
6200 *
6201 * @param other Another Intent whose values are to be used to fill in
6202 * the current one.
6203 * @param flags Options to control which fields can be filled in.
6204 *
6205 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006206 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006207 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6208 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006209 */
6210 public int fillIn(Intent other, int flags) {
6211 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006212 if (other.mAction != null
6213 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006214 mAction = other.mAction;
6215 changes |= FILL_IN_ACTION;
6216 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006217 if ((other.mData != null || other.mType != null)
6218 && ((mData == null && mType == null)
6219 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006220 mData = other.mData;
6221 mType = other.mType;
6222 changes |= FILL_IN_DATA;
6223 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006224 if (other.mCategories != null
6225 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006226 if (other.mCategories != null) {
6227 mCategories = new HashSet<String>(other.mCategories);
6228 }
6229 changes |= FILL_IN_CATEGORIES;
6230 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006231 if (other.mPackage != null
6232 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006233 // Only do this if mSelector is not set.
6234 if (mSelector == null) {
6235 mPackage = other.mPackage;
6236 changes |= FILL_IN_PACKAGE;
6237 }
6238 }
6239 // Selector is special: it can only be set if explicitly allowed,
6240 // for the same reason as the component name.
6241 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6242 if (mPackage == null) {
6243 mSelector = new Intent(other.mSelector);
6244 mPackage = null;
6245 changes |= FILL_IN_SELECTOR;
6246 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006247 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006248 if (other.mClipData != null
6249 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6250 mClipData = other.mClipData;
6251 changes |= FILL_IN_CLIP_DATA;
6252 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006253 // Component is special: it can -only- be set if explicitly allowed,
6254 // since otherwise the sender could force the intent somewhere the
6255 // originator didn't intend.
6256 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006257 mComponent = other.mComponent;
6258 changes |= FILL_IN_COMPONENT;
6259 }
6260 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006261 if (other.mSourceBounds != null
6262 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6263 mSourceBounds = new Rect(other.mSourceBounds);
6264 changes |= FILL_IN_SOURCE_BOUNDS;
6265 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006266 if (mExtras == null) {
6267 if (other.mExtras != null) {
6268 mExtras = new Bundle(other.mExtras);
6269 }
6270 } else if (other.mExtras != null) {
6271 try {
6272 Bundle newb = new Bundle(other.mExtras);
6273 newb.putAll(mExtras);
6274 mExtras = newb;
6275 } catch (RuntimeException e) {
6276 // Modifying the extras can cause us to unparcel the contents
6277 // of the bundle, and if we do this in the system process that
6278 // may fail. We really should handle this (i.e., the Bundle
6279 // impl shouldn't be on top of a plain map), but for now just
6280 // ignore it and keep the original contents. :(
6281 Log.w("Intent", "Failure filling in extras", e);
6282 }
6283 }
6284 return changes;
6285 }
6286
6287 /**
6288 * Wrapper class holding an Intent and implementing comparisons on it for
6289 * the purpose of filtering. The class implements its
6290 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6291 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6292 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6293 * on the wrapped Intent.
6294 */
6295 public static final class FilterComparison {
6296 private final Intent mIntent;
6297 private final int mHashCode;
6298
6299 public FilterComparison(Intent intent) {
6300 mIntent = intent;
6301 mHashCode = intent.filterHashCode();
6302 }
6303
6304 /**
6305 * Return the Intent that this FilterComparison represents.
6306 * @return Returns the Intent held by the FilterComparison. Do
6307 * not modify!
6308 */
6309 public Intent getIntent() {
6310 return mIntent;
6311 }
6312
6313 @Override
6314 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006315 if (obj instanceof FilterComparison) {
6316 Intent other = ((FilterComparison)obj).mIntent;
6317 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006318 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006319 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006320 }
6321
6322 @Override
6323 public int hashCode() {
6324 return mHashCode;
6325 }
6326 }
6327
6328 /**
6329 * Determine if two intents are the same for the purposes of intent
6330 * resolution (filtering). That is, if their action, data, type,
6331 * class, and categories are the same. This does <em>not</em> compare
6332 * any extra data included in the intents.
6333 *
6334 * @param other The other Intent to compare against.
6335 *
6336 * @return Returns true if action, data, type, class, and categories
6337 * are the same.
6338 */
6339 public boolean filterEquals(Intent other) {
6340 if (other == null) {
6341 return false;
6342 }
6343 if (mAction != other.mAction) {
6344 if (mAction != null) {
6345 if (!mAction.equals(other.mAction)) {
6346 return false;
6347 }
6348 } else {
6349 if (!other.mAction.equals(mAction)) {
6350 return false;
6351 }
6352 }
6353 }
6354 if (mData != other.mData) {
6355 if (mData != null) {
6356 if (!mData.equals(other.mData)) {
6357 return false;
6358 }
6359 } else {
6360 if (!other.mData.equals(mData)) {
6361 return false;
6362 }
6363 }
6364 }
6365 if (mType != other.mType) {
6366 if (mType != null) {
6367 if (!mType.equals(other.mType)) {
6368 return false;
6369 }
6370 } else {
6371 if (!other.mType.equals(mType)) {
6372 return false;
6373 }
6374 }
6375 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006376 if (mPackage != other.mPackage) {
6377 if (mPackage != null) {
6378 if (!mPackage.equals(other.mPackage)) {
6379 return false;
6380 }
6381 } else {
6382 if (!other.mPackage.equals(mPackage)) {
6383 return false;
6384 }
6385 }
6386 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006387 if (mComponent != other.mComponent) {
6388 if (mComponent != null) {
6389 if (!mComponent.equals(other.mComponent)) {
6390 return false;
6391 }
6392 } else {
6393 if (!other.mComponent.equals(mComponent)) {
6394 return false;
6395 }
6396 }
6397 }
6398 if (mCategories != other.mCategories) {
6399 if (mCategories != null) {
6400 if (!mCategories.equals(other.mCategories)) {
6401 return false;
6402 }
6403 } else {
6404 if (!other.mCategories.equals(mCategories)) {
6405 return false;
6406 }
6407 }
6408 }
6409
6410 return true;
6411 }
6412
6413 /**
6414 * Generate hash code that matches semantics of filterEquals().
6415 *
6416 * @return Returns the hash value of the action, data, type, class, and
6417 * categories.
6418 *
6419 * @see #filterEquals
6420 */
6421 public int filterHashCode() {
6422 int code = 0;
6423 if (mAction != null) {
6424 code += mAction.hashCode();
6425 }
6426 if (mData != null) {
6427 code += mData.hashCode();
6428 }
6429 if (mType != null) {
6430 code += mType.hashCode();
6431 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006432 if (mPackage != null) {
6433 code += mPackage.hashCode();
6434 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006435 if (mComponent != null) {
6436 code += mComponent.hashCode();
6437 }
6438 if (mCategories != null) {
6439 code += mCategories.hashCode();
6440 }
6441 return code;
6442 }
6443
6444 @Override
6445 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006446 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006447
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006448 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006449 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006450 b.append(" }");
6451
6452 return b.toString();
6453 }
6454
6455 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006456 public String toInsecureString() {
6457 StringBuilder b = new StringBuilder(128);
6458
6459 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006460 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006461 b.append(" }");
6462
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006463 return b.toString();
6464 }
Romain Guy4969af72009-06-17 10:53:19 -07006465
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006466 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006467 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006468 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006469
6470 b.append("Intent { ");
6471 toShortString(b, false, true, true, true);
6472 b.append(" }");
6473
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006474 return b.toString();
6475 }
6476
6477 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006478 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6479 StringBuilder b = new StringBuilder(128);
6480 toShortString(b, secure, comp, extras, clip);
6481 return b.toString();
6482 }
6483
6484 /** @hide */
6485 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6486 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006487 boolean first = true;
6488 if (mAction != null) {
6489 b.append("act=").append(mAction);
6490 first = false;
6491 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006492 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006493 if (!first) {
6494 b.append(' ');
6495 }
6496 first = false;
6497 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006498 Iterator<String> i = mCategories.iterator();
6499 boolean didone = false;
6500 while (i.hasNext()) {
6501 if (didone) b.append(",");
6502 didone = true;
6503 b.append(i.next());
6504 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006505 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006506 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006507 if (mData != null) {
6508 if (!first) {
6509 b.append(' ');
6510 }
6511 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006512 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006513 if (secure) {
6514 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006515 } else {
6516 b.append(mData);
6517 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006518 }
6519 if (mType != null) {
6520 if (!first) {
6521 b.append(' ');
6522 }
6523 first = false;
6524 b.append("typ=").append(mType);
6525 }
6526 if (mFlags != 0) {
6527 if (!first) {
6528 b.append(' ');
6529 }
6530 first = false;
6531 b.append("flg=0x").append(Integer.toHexString(mFlags));
6532 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006533 if (mPackage != null) {
6534 if (!first) {
6535 b.append(' ');
6536 }
6537 first = false;
6538 b.append("pkg=").append(mPackage);
6539 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006540 if (comp && mComponent != null) {
6541 if (!first) {
6542 b.append(' ');
6543 }
6544 first = false;
6545 b.append("cmp=").append(mComponent.flattenToShortString());
6546 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006547 if (mSourceBounds != null) {
6548 if (!first) {
6549 b.append(' ');
6550 }
6551 first = false;
6552 b.append("bnds=").append(mSourceBounds.toShortString());
6553 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006554 if (mClipData != null) {
6555 if (!first) {
6556 b.append(' ');
6557 }
6558 first = false;
6559 if (clip) {
6560 b.append("clip={");
6561 mClipData.toShortString(b);
6562 b.append('}');
6563 } else {
6564 b.append("(has clip)");
6565 }
6566 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006567 if (extras && mExtras != null) {
6568 if (!first) {
6569 b.append(' ');
6570 }
6571 first = false;
6572 b.append("(has extras)");
6573 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006574 if (mSelector != null) {
6575 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006576 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006577 b.append("}");
6578 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006579 }
6580
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006581 /**
6582 * Call {@link #toUri} with 0 flags.
6583 * @deprecated Use {@link #toUri} instead.
6584 */
6585 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006586 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006587 return toUri(0);
6588 }
6589
6590 /**
6591 * Convert this Intent into a String holding a URI representation of it.
6592 * The returned URI string has been properly URI encoded, so it can be
6593 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6594 * Intent's data as the base URI, with an additional fragment describing
6595 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006596 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006597 * <p>You can convert the returned string back to an Intent with
6598 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006599 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006600 * @param flags Additional operating flags. Either 0 or
6601 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006602 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006603 * @return Returns a URI encoding URI string describing the entire contents
6604 * of the Intent.
6605 */
6606 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006607 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006608 String scheme = null;
6609 if (mData != null) {
6610 String data = mData.toString();
6611 if ((flags&URI_INTENT_SCHEME) != 0) {
6612 final int N = data.length();
6613 for (int i=0; i<N; i++) {
6614 char c = data.charAt(i);
6615 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6616 || c == '.' || c == '-') {
6617 continue;
6618 }
6619 if (c == ':' && i > 0) {
6620 // Valid scheme.
6621 scheme = data.substring(0, i);
6622 uri.append("intent:");
6623 data = data.substring(i+1);
6624 break;
6625 }
Tom Taylord4a47292009-12-21 13:59:18 -08006626
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006627 // No scheme.
6628 break;
6629 }
6630 }
6631 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006632
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006633 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6634 uri.append("intent:");
6635 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006636
6637 uri.append("#Intent;");
6638
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006639 toUriInner(uri, scheme, flags);
6640 if (mSelector != null) {
6641 uri.append("SEL;");
6642 // Note that for now we are not going to try to handle the
6643 // data part; not clear how to represent this as a URI, and
6644 // not much utility in it.
6645 mSelector.toUriInner(uri, null, flags);
6646 }
6647
6648 uri.append("end");
6649
6650 return uri.toString();
6651 }
6652
6653 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006654 if (scheme != null) {
6655 uri.append("scheme=").append(scheme).append(';');
6656 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006657 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006658 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006659 }
6660 if (mCategories != null) {
6661 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006662 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006663 }
6664 }
6665 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006666 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006667 }
6668 if (mFlags != 0) {
6669 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6670 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006671 if (mPackage != null) {
6672 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6673 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006674 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006675 uri.append("component=").append(Uri.encode(
6676 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006677 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006678 if (mSourceBounds != null) {
6679 uri.append("sourceBounds=")
6680 .append(Uri.encode(mSourceBounds.flattenToString()))
6681 .append(';');
6682 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006683 if (mExtras != null) {
6684 for (String key : mExtras.keySet()) {
6685 final Object value = mExtras.get(key);
6686 char entryType =
6687 value instanceof String ? 'S' :
6688 value instanceof Boolean ? 'B' :
6689 value instanceof Byte ? 'b' :
6690 value instanceof Character ? 'c' :
6691 value instanceof Double ? 'd' :
6692 value instanceof Float ? 'f' :
6693 value instanceof Integer ? 'i' :
6694 value instanceof Long ? 'l' :
6695 value instanceof Short ? 's' :
6696 '\0';
6697
6698 if (entryType != '\0') {
6699 uri.append(entryType);
6700 uri.append('.');
6701 uri.append(Uri.encode(key));
6702 uri.append('=');
6703 uri.append(Uri.encode(value.toString()));
6704 uri.append(';');
6705 }
6706 }
6707 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006708 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006709
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006710 public int describeContents() {
6711 return (mExtras != null) ? mExtras.describeContents() : 0;
6712 }
6713
6714 public void writeToParcel(Parcel out, int flags) {
6715 out.writeString(mAction);
6716 Uri.writeToParcel(out, mData);
6717 out.writeString(mType);
6718 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006719 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006720 ComponentName.writeToParcel(mComponent, out);
6721
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006722 if (mSourceBounds != null) {
6723 out.writeInt(1);
6724 mSourceBounds.writeToParcel(out, flags);
6725 } else {
6726 out.writeInt(0);
6727 }
6728
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006729 if (mCategories != null) {
6730 out.writeInt(mCategories.size());
6731 for (String category : mCategories) {
6732 out.writeString(category);
6733 }
6734 } else {
6735 out.writeInt(0);
6736 }
6737
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006738 if (mSelector != null) {
6739 out.writeInt(1);
6740 mSelector.writeToParcel(out, flags);
6741 } else {
6742 out.writeInt(0);
6743 }
6744
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006745 if (mClipData != null) {
6746 out.writeInt(1);
6747 mClipData.writeToParcel(out, flags);
6748 } else {
6749 out.writeInt(0);
6750 }
6751
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006752 out.writeBundle(mExtras);
6753 }
6754
6755 public static final Parcelable.Creator<Intent> CREATOR
6756 = new Parcelable.Creator<Intent>() {
6757 public Intent createFromParcel(Parcel in) {
6758 return new Intent(in);
6759 }
6760 public Intent[] newArray(int size) {
6761 return new Intent[size];
6762 }
6763 };
6764
Dianne Hackborneb034652009-09-07 00:49:58 -07006765 /** @hide */
6766 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006767 readFromParcel(in);
6768 }
6769
6770 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006771 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006772 mData = Uri.CREATOR.createFromParcel(in);
6773 mType = in.readString();
6774 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006775 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006776 mComponent = ComponentName.readFromParcel(in);
6777
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006778 if (in.readInt() != 0) {
6779 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6780 }
6781
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006782 int N = in.readInt();
6783 if (N > 0) {
6784 mCategories = new HashSet<String>();
6785 int i;
6786 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006787 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006788 }
6789 } else {
6790 mCategories = null;
6791 }
6792
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006793 if (in.readInt() != 0) {
6794 mSelector = new Intent(in);
6795 }
6796
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006797 if (in.readInt() != 0) {
6798 mClipData = new ClipData(in);
6799 }
6800
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006801 mExtras = in.readBundle();
6802 }
6803
6804 /**
6805 * Parses the "intent" element (and its children) from XML and instantiates
6806 * an Intent object. The given XML parser should be located at the tag
6807 * where parsing should start (often named "intent"), from which the
6808 * basic action, data, type, and package and class name will be
6809 * retrieved. The function will then parse in to any child elements,
6810 * looking for <category android:name="xxx"> tags to add categories and
6811 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6812 * to the intent.
6813 *
6814 * @param resources The Resources to use when inflating resources.
6815 * @param parser The XML parser pointing at an "intent" tag.
6816 * @param attrs The AttributeSet interface for retrieving extended
6817 * attribute data at the current <var>parser</var> location.
6818 * @return An Intent object matching the XML data.
6819 * @throws XmlPullParserException If there was an XML parsing error.
6820 * @throws IOException If there was an I/O error.
6821 */
6822 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6823 throws XmlPullParserException, IOException {
6824 Intent intent = new Intent();
6825
6826 TypedArray sa = resources.obtainAttributes(attrs,
6827 com.android.internal.R.styleable.Intent);
6828
6829 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6830
6831 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6832 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6833 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6834
6835 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6836 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6837 if (packageName != null && className != null) {
6838 intent.setComponent(new ComponentName(packageName, className));
6839 }
6840
6841 sa.recycle();
6842
6843 int outerDepth = parser.getDepth();
6844 int type;
6845 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6846 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6847 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6848 continue;
6849 }
6850
6851 String nodeName = parser.getName();
6852 if (nodeName.equals("category")) {
6853 sa = resources.obtainAttributes(attrs,
6854 com.android.internal.R.styleable.IntentCategory);
6855 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6856 sa.recycle();
6857
6858 if (cat != null) {
6859 intent.addCategory(cat);
6860 }
6861 XmlUtils.skipCurrentTag(parser);
6862
6863 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006864 if (intent.mExtras == null) {
6865 intent.mExtras = new Bundle();
6866 }
6867 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6868 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006869
6870 } else {
6871 XmlUtils.skipCurrentTag(parser);
6872 }
6873 }
6874
6875 return intent;
6876 }
Nick Pellyccae4122012-01-09 14:12:58 -08006877
6878 /**
6879 * Normalize a MIME data type.
6880 *
6881 * <p>A normalized MIME type has white-space trimmed,
6882 * content-type parameters removed, and is lower-case.
6883 * This aligns the type with Android best practices for
6884 * intent filtering.
6885 *
6886 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6887 * "text/x-vCard" becomes "text/x-vcard".
6888 *
6889 * <p>All MIME types received from outside Android (such as user input,
6890 * or external sources like Bluetooth, NFC, or the Internet) should
6891 * be normalized before they are used to create an Intent.
6892 *
6893 * @param type MIME data type to normalize
6894 * @return normalized MIME data type, or null if the input was null
6895 * @see {@link #setType}
6896 * @see {@link #setTypeAndNormalize}
6897 */
6898 public static String normalizeMimeType(String type) {
6899 if (type == null) {
6900 return null;
6901 }
6902
6903 type = type.trim().toLowerCase(Locale.US);
6904
6905 final int semicolonIndex = type.indexOf(';');
6906 if (semicolonIndex != -1) {
6907 type = type.substring(0, semicolonIndex);
6908 }
6909 return type;
6910 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006911
6912 /**
6913 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006914 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6915 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006916 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006917 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006918 * @hide
6919 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006920 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006921 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006922 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006923
6924 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006925 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006926
6927 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006928 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006929 try {
6930 // Inspect target intent to see if we need to migrate
6931 final Intent target = getParcelableExtra(EXTRA_INTENT);
6932 if (target != null && target.migrateExtraStreamToClipData()) {
6933 // Since we migrated in child, we need to promote ClipData
6934 // and flags to ourselves to grant.
6935 setClipData(target.getClipData());
6936 addFlags(target.getFlags()
6937 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6938 return true;
6939 } else {
6940 return false;
6941 }
6942 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006943 }
6944
6945 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006946 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006947 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6948 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6949 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6950 if (stream != null || text != null || htmlText != null) {
6951 final ClipData clipData = new ClipData(
6952 null, new String[] { getType() },
6953 new ClipData.Item(text, htmlText, null, stream));
6954 setClipData(clipData);
6955 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006956 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006957 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006958 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006959 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006960
6961 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006962 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006963 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6964 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6965 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6966 int num = -1;
6967 if (streams != null) {
6968 num = streams.size();
6969 }
6970 if (texts != null) {
6971 if (num >= 0 && num != texts.size()) {
6972 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006973 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006974 }
6975 num = texts.size();
6976 }
6977 if (htmlTexts != null) {
6978 if (num >= 0 && num != htmlTexts.size()) {
6979 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006980 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006981 }
6982 num = htmlTexts.size();
6983 }
6984 if (num > 0) {
6985 final ClipData clipData = new ClipData(
6986 null, new String[] { getType() },
6987 makeClipItem(streams, texts, htmlTexts, 0));
6988
6989 for (int i = 1; i < num; i++) {
6990 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6991 }
6992
6993 setClipData(clipData);
6994 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006995 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006996 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006997 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006998 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006999 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007000
7001 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007002 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007003
7004 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7005 ArrayList<String> htmlTexts, int which) {
7006 Uri uri = streams != null ? streams.get(which) : null;
7007 CharSequence text = texts != null ? texts.get(which) : null;
7008 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7009 return new ClipData.Item(text, htmlText, null, uri);
7010 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007011}