blob: c14a70308677d55045539be8d9303abeacbdb6ea [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700573 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800574 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700575 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
577 * <li> {@link #EXTRA_REPLACING}
578 * <li> {@link #EXTRA_SHORTCUT_ICON}
579 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
580 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700581 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800582 * <li> {@link #EXTRA_SHORTCUT_NAME}
583 * <li> {@link #EXTRA_SUBJECT}
584 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700585 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_TITLE}
587 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * </ul>
589 *
590 * <h3>Flags</h3>
591 *
592 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800593 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
594 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800596public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 // ---------------------------------------------------------------------
598 // ---------------------------------------------------------------------
599 // Standard intent activity actions (see action variable).
600
601 /**
602 * Activity Action: Start as a main entry point, does not expect to
603 * receive data.
604 * <p>Input: nothing
605 * <p>Output: nothing
606 */
607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
608 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700610 /**
611 * Activity Action: Display the data to the user. This is the most common
612 * action performed on data -- it is the generic action you can use on
613 * a piece of data to get the most reasonable thing to occur. For example,
614 * when used on a contacts entry it will view the entry; when used on a
615 * mailto: URI it will bring up a compose window filled with the information
616 * supplied by the URI; when used with a tel: URI it will invoke the
617 * dialer.
618 * <p>Input: {@link #getData} is URI from which to retrieve data.
619 * <p>Output: nothing.
620 */
621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
622 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 /**
625 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
626 * performed on a piece of data.
627 */
628 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Used to indicate that some piece of data should be attached to some other
632 * place. For example, image data could be attached to a contact. It is up
633 * to the recipient to decide where the data should be attached; the intent
634 * does not specify the ultimate destination.
635 * <p>Input: {@link #getData} is URI of data to be attached.
636 * <p>Output: nothing.
637 */
638 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
639 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700641 /**
642 * Activity Action: Provide explicit editable access to the given data.
643 * <p>Input: {@link #getData} is URI of data to be edited.
644 * <p>Output: nothing.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
651 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
652 * The extras can contain type specific data to pass through to the editing/creating
653 * activity.
654 * <p>Output: The URI of the item that was picked. This must be a content:
655 * URI so that any receiver can access it.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * Activity Action: Pick an item from the data, returning what was selected.
662 * <p>Input: {@link #getData} is URI containing a directory of data
663 * (vnd.android.cursor.dir/*) from which to pick an item.
664 * <p>Output: The URI of the item that was picked.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800671 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 * <p>Output: An Intent representing the shortcut. The intent must contain three
673 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
674 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675 * (value: ShortcutIconResource).</p>
676 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * @see #EXTRA_SHORTCUT_INTENT
678 * @see #EXTRA_SHORTCUT_NAME
679 * @see #EXTRA_SHORTCUT_ICON
680 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
681 * @see android.content.Intent.ShortcutIconResource
682 */
683 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
684 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
685
686 /**
687 * The name of the extra used to define the Intent of a shortcut.
688 *
689 * @see #ACTION_CREATE_SHORTCUT
690 */
691 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
692 /**
693 * The name of the extra used to define the name of a shortcut.
694 *
695 * @see #ACTION_CREATE_SHORTCUT
696 */
697 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
698 /**
699 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
700 *
701 * @see #ACTION_CREATE_SHORTCUT
702 */
703 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
704 /**
705 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
706 *
707 * @see #ACTION_CREATE_SHORTCUT
708 * @see android.content.Intent.ShortcutIconResource
709 */
710 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
711 "android.intent.extra.shortcut.ICON_RESOURCE";
712
713 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 *
716 * @see Intent#ACTION_CREATE_SHORTCUT
717 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
719 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 */
721 public static class ShortcutIconResource implements Parcelable {
722 /**
723 * The package name of the application containing the icon.
724 */
725 public String packageName;
726
727 /**
728 * The resource name of the icon, including package, name and type.
729 */
730 public String resourceName;
731
732 /**
733 * Creates a new ShortcutIconResource for the specified context and resource
734 * identifier.
735 *
736 * @param context The context of the application.
737 * @param resourceId The resource idenfitier for the icon.
738 * @return A new ShortcutIconResource with the specified's context package name
739 * and icon resource idenfitier.
740 */
741 public static ShortcutIconResource fromContext(Context context, int resourceId) {
742 ShortcutIconResource icon = new ShortcutIconResource();
743 icon.packageName = context.getPackageName();
744 icon.resourceName = context.getResources().getResourceName(resourceId);
745 return icon;
746 }
747
748 /**
749 * Used to read a ShortcutIconResource from a Parcel.
750 */
751 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
752 new Parcelable.Creator<ShortcutIconResource>() {
753
754 public ShortcutIconResource createFromParcel(Parcel source) {
755 ShortcutIconResource icon = new ShortcutIconResource();
756 icon.packageName = source.readString();
757 icon.resourceName = source.readString();
758 return icon;
759 }
760
761 public ShortcutIconResource[] newArray(int size) {
762 return new ShortcutIconResource[size];
763 }
764 };
765
766 /**
767 * No special parcel contents.
768 */
769 public int describeContents() {
770 return 0;
771 }
772
773 public void writeToParcel(Parcel dest, int flags) {
774 dest.writeString(packageName);
775 dest.writeString(resourceName);
776 }
777
778 @Override
779 public String toString() {
780 return resourceName;
781 }
782 }
783
784 /**
785 * Activity Action: Display an activity chooser, allowing the user to pick
786 * what they want to before proceeding. This can be used as an alternative
787 * to the standard activity picker that is displayed by the system when
788 * you try to start an activity with multiple possible matches, with these
789 * differences in behavior:
790 * <ul>
791 * <li>You can specify the title that will appear in the activity chooser.
792 * <li>The user does not have the option to make one of the matching
793 * activities a preferred activity, and all possible activities will
794 * always be shown even if one of them is currently marked as the
795 * preferred activity.
796 * </ul>
797 * <p>
798 * This action should be used when the user will naturally expect to
799 * select an activity in order to proceed. An example if when not to use
800 * it is when the user clicks on a "mailto:" link. They would naturally
801 * expect to go directly to their mail app, so startActivity() should be
802 * called directly: it will
803 * either launch the current preferred app, or put up a dialog allowing the
804 * user to pick an app to use and optionally marking that as preferred.
805 * <p>
806 * In contrast, if the user is selecting a menu item to send a picture
807 * they are viewing to someone else, there are many different things they
808 * may want to do at this point: send it through e-mail, upload it to a
809 * web service, etc. In this case the CHOOSER action should be used, to
810 * always present to the user a list of the things they can do, with a
811 * nice title given by the caller such as "Send this photo with:".
812 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700813 * If you need to grant URI permissions through a chooser, you must specify
814 * the permissions to be granted on the ACTION_CHOOSER Intent
815 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
816 * {@link #setClipData} to specify the URIs to be granted as well as
817 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
818 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
819 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 * As a convenience, an Intent of this form can be created with the
821 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700822 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
825 * and can optionally have a {@link #EXTRA_TITLE} field containing the
826 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700827 * <p>
828 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700829 */
830 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
831 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
832
833 /**
834 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
835 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700836 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
837 * target intent, also optionally supplying a title. If the target
838 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
839 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
840 * set in the returned chooser intent, with its ClipData set appropriately:
841 * either a direct reflection of {@link #getClipData()} if that is non-null,
842 * or a new ClipData build from {@link #getData()}.
843 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 * @param target The Intent that the user will be selecting an activity
845 * to perform.
846 * @param title Optional title that will be displayed in the chooser.
847 * @return Return a new Intent object that you can hand to
848 * {@link Context#startActivity(Intent) Context.startActivity()} and
849 * related methods.
850 */
851 public static Intent createChooser(Intent target, CharSequence title) {
852 Intent intent = new Intent(ACTION_CHOOSER);
853 intent.putExtra(EXTRA_INTENT, target);
854 if (title != null) {
855 intent.putExtra(EXTRA_TITLE, title);
856 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700857
858 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700859 int permFlags = target.getFlags()
860 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
861 if (permFlags != 0) {
862 ClipData targetClipData = target.getClipData();
863 if (targetClipData == null && target.getData() != null) {
864 ClipData.Item item = new ClipData.Item(target.getData());
865 String[] mimeTypes;
866 if (target.getType() != null) {
867 mimeTypes = new String[] { target.getType() };
868 } else {
869 mimeTypes = new String[] { };
870 }
871 targetClipData = new ClipData(null, mimeTypes, item);
872 }
873 if (targetClipData != null) {
874 intent.setClipData(targetClipData);
875 intent.addFlags(permFlags);
876 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700879 return intent;
880 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700882 /**
883 * Activity Action: Allow the user to select a particular kind of data and
884 * return it. This is different than {@link #ACTION_PICK} in that here we
885 * just say what kind of data is desired, not a URI of existing data from
886 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
887 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900888 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700889 * etc.
890 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900891 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * of data, such as a person contact, you set the MIME type to the kind of
893 * data you want and launch it with {@link Context#startActivity(Intent)}.
894 * The system will then launch the best application to select that kind
895 * of data for you.
896 * <p>
897 * You may also be interested in any of a set of types of content the user
898 * can pick. For example, an e-mail application that wants to allow the
899 * user to add an attachment to an e-mail message can use this action to
900 * bring up a list of all of the types of content the user can attach.
901 * <p>
902 * In this case, you should wrap the GET_CONTENT intent with a chooser
903 * (through {@link #createChooser}), which will give the proper interface
904 * for the user to pick how to send your data and allow you to specify
905 * a prompt indicating what they are doing. You will usually specify a
906 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
907 * broad range of content types the user can select from.
908 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900909 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * only pick from data that can be represented as a stream. This is
911 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
912 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800913 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900914 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800915 * is locally available on the device. For example, if this extra is set
916 * to true then an image picker should not show any pictures that are available
917 * from a remote server but not already on the local device (thus requiring
918 * they be downloaded when opened).
919 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700920 * Input: {@link #getType} is the desired MIME type to retrieve. Note
921 * that no URI is supplied in the intent, as there are no constraints on
922 * where the returned data originally comes from. You may also include the
923 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800924 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
925 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700926 * <p>
927 * Output: The URI of the item that was picked. This must be a content:
928 * URI so that any receiver can access it.
929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
932 /**
933 * Activity Action: Dial a number as specified by the data. This shows a
934 * UI with the number being dialed, allowing the user to explicitly
935 * initiate the call.
936 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
937 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
938 * number.
939 * <p>Output: nothing.
940 */
941 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
942 public static final String ACTION_DIAL = "android.intent.action.DIAL";
943 /**
944 * Activity Action: Perform a call to someone specified by the data.
945 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
946 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
947 * number.
948 * <p>Output: nothing.
949 *
950 * <p>Note: there will be restrictions on which applications can initiate a
951 * call; most applications should use the {@link #ACTION_DIAL}.
952 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
953 * numbers. Applications can <strong>dial</strong> emergency numbers using
954 * {@link #ACTION_DIAL}, however.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_CALL = "android.intent.action.CALL";
958 /**
959 * Activity Action: Perform a call to an emergency number specified by the
960 * data.
961 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
962 * tel: URI of an explicit phone number.
963 * <p>Output: nothing.
964 * @hide
965 */
966 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
967 /**
968 * Activity action: Perform a call to any number (emergency or not)
969 * specified by the data.
970 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
971 * tel: URI of an explicit phone number.
972 * <p>Output: nothing.
973 * @hide
974 */
975 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
976 /**
977 * Activity Action: Send a message to someone specified by the data.
978 * <p>Input: {@link #getData} is URI describing the target.
979 * <p>Output: nothing.
980 */
981 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
982 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
983 /**
984 * Activity Action: Deliver some data to someone else. Who the data is
985 * being delivered to is not specified; it is up to the receiver of this
986 * action to ask the user where the data should be sent.
987 * <p>
988 * When launching a SEND intent, you should usually wrap it in a chooser
989 * (through {@link #createChooser}), which will give the proper interface
990 * for the user to pick how to send your data and allow you to specify
991 * a prompt indicating what they are doing.
992 * <p>
993 * Input: {@link #getType} is the MIME type of the data being sent.
994 * get*Extra can have either a {@link #EXTRA_TEXT}
995 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
996 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
997 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
998 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700999 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1000 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1001 * your text with HTML formatting.
1002 * <p>
1003 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1004 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1005 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1006 * content: URIs and other advanced features of {@link ClipData}. If
1007 * using this approach, you still must supply the same data through the
1008 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1009 * for compatibility with old applications. If you don't set a ClipData,
1010 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * <p>
1012 * Optional standard extras, which may be interpreted by some recipients as
1013 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1014 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1015 * <p>
1016 * Output: nothing.
1017 */
1018 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1019 public static final String ACTION_SEND = "android.intent.action.SEND";
1020 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001021 * Activity Action: Deliver multiple data to someone else.
1022 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001023 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001024 * <p>
1025 * Input: {@link #getType} is the MIME type of the data being sent.
1026 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001027 * #EXTRA_STREAM} field, containing the data to be sent. If using
1028 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1029 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001031 * Multiple types are supported, and receivers should handle mixed types
1032 * whenever possible. The right way for the receiver to check them is to
1033 * use the content resolver on each URI. The intent sender should try to
1034 * put the most concrete mime type in the intent type, but it can fall
1035 * back to {@literal <type>/*} or {@literal *}/* as needed.
1036 * <p>
1037 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1038 * be image/jpg, but if you are sending image/jpg and image/png, then the
1039 * intent's type should be image/*.
1040 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001041 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1042 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1043 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1044 * content: URIs and other advanced features of {@link ClipData}. If
1045 * using this approach, you still must supply the same data through the
1046 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1047 * for compatibility with old applications. If you don't set a ClipData,
1048 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1049 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001050 * Optional standard extras, which may be interpreted by some recipients as
1051 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1052 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1053 * <p>
1054 * Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Activity Action: Handle an incoming phone call.
1060 * <p>Input: nothing.
1061 * <p>Output: nothing.
1062 */
1063 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1064 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1065 /**
1066 * Activity Action: Insert an empty item into the given container.
1067 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1068 * in which to place the data.
1069 * <p>Output: URI of the new data that was created.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1073 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001074 * Activity Action: Create a new item in the given container, initializing it
1075 * from the current contents of the clipboard.
1076 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1077 * in which to place the data.
1078 * <p>Output: URI of the new data that was created.
1079 */
1080 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1081 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1082 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001083 * Activity Action: Delete the given data from its container.
1084 * <p>Input: {@link #getData} is URI of data to be deleted.
1085 * <p>Output: nothing.
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1089 /**
1090 * Activity Action: Run the data, whatever that means.
1091 * <p>Input: ? (Note: this is currently specific to the test harness.)
1092 * <p>Output: nothing.
1093 */
1094 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1095 public static final String ACTION_RUN = "android.intent.action.RUN";
1096 /**
1097 * Activity Action: Perform a data synchronization.
1098 * <p>Input: ?
1099 * <p>Output: ?
1100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1103 /**
1104 * Activity Action: Pick an activity given an intent, returning the class
1105 * selected.
1106 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1107 * used with {@link PackageManager#queryIntentActivities} to determine the
1108 * set of activities from which to pick.
1109 * <p>Output: Class name of the activity that was selected.
1110 */
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1112 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1113 /**
1114 * Activity Action: Perform a search.
1115 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1116 * is the text to search for. If empty, simply
1117 * enter your search results Activity with the search UI activated.
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1122 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001123 * Activity Action: Start the platform-defined tutorial
1124 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1125 * is the text to search for. If empty, simply
1126 * enter your search results Activity with the search UI activated.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1131 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001132 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001133 * <p>
1134 * Input: {@link android.app.SearchManager#QUERY
1135 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1136 * a url starts with http or https, the site will be opened. If it is plain
1137 * text, Google search will be applied.
1138 * <p>
1139 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001140 */
1141 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1142 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1143 /**
Jim Miller07994402012-05-02 14:22:27 -07001144 * Activity Action: Perform assist action.
1145 * <p>
1146 * Input: nothing
1147 * Output: nothing.
1148 */
1149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1150 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
1151 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 * Activity Action: List all available applications
1153 * <p>Input: Nothing.
1154 * <p>Output: nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1158 /**
1159 * Activity Action: Show settings for choosing wallpaper
1160 * <p>Input: Nothing.
1161 * <p>Output: Nothing.
1162 */
1163 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1164 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1165
1166 /**
1167 * Activity Action: Show activity for reporting a bug.
1168 * <p>Input: Nothing.
1169 * <p>Output: Nothing.
1170 */
1171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1172 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1173
1174 /**
1175 * Activity Action: Main entry point for factory tests. Only used when
1176 * the device is booting in factory test node. The implementing package
1177 * must be installed in the system image.
1178 * <p>Input: nothing
1179 * <p>Output: nothing
1180 */
1181 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1182
1183 /**
1184 * Activity Action: The user pressed the "call" button to go to the dialer
1185 * or other appropriate UI for placing a call.
1186 * <p>Input: Nothing.
1187 * <p>Output: Nothing.
1188 */
1189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1190 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1191
1192 /**
1193 * Activity Action: Start Voice Command.
1194 * <p>Input: Nothing.
1195 * <p>Output: Nothing.
1196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001199
1200 /**
1201 * Activity Action: Start action associated with long pressing on the
1202 * search key.
1203 * <p>Input: Nothing.
1204 * <p>Output: Nothing.
1205 */
1206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1207 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001208
Jacek Surazski86b6c532009-05-13 14:38:28 +02001209 /**
1210 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1211 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001212 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001213 * <p>Input: No data is specified. The bug report is passed in using
1214 * an {@link #EXTRA_BUG_REPORT} field.
1215 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001216 *
1217 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001218 */
1219 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1220 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001221
1222 /**
1223 * Activity Action: Show power usage information to the user.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001229
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001230 /**
1231 * Activity Action: Setup wizard to launch after a platform update. This
1232 * activity should have a string meta-data field associated with it,
1233 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1234 * the platform for setup. The activity will be launched only if
1235 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1236 * same value.
1237 * <p>Input: Nothing.
1238 * <p>Output: Nothing.
1239 * @hide
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001243
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001244 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001245 * Activity Action: Show settings for managing network data usage of a
1246 * specific application. Applications should define an activity that offers
1247 * options to control data usage.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_MANAGE_NETWORK_USAGE =
1251 "android.intent.action.MANAGE_NETWORK_USAGE";
1252
1253 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 * Activity Action: Launch application installer.
1255 * <p>
1256 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001257 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1258 * you can also use "package:<package-name>" to install an application for the
1259 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001260 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1261 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1262 * <p>
1263 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1264 * succeeded.
1265 *
1266 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1267 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1268 * @see #EXTRA_RETURN_RESULT
1269 */
1270 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1271 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1272
1273 /**
1274 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1275 * package. Specifies the installer package name; this package will receive the
1276 * {@link #ACTION_APP_ERROR} intent.
1277 */
1278 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1279 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1280
1281 /**
1282 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1283 * package. Specifies that the application being installed should not be
1284 * treated as coming from an unknown source, but as coming from the app
1285 * invoking the Intent. For this to work you must start the installer with
1286 * startActivityForResult().
1287 */
1288 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1289 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1290
1291 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001292 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1293 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001294 * data field originated from.
1295 */
rich cannings706e8ba2012-08-20 13:20:14 -07001296 public static final String EXTRA_ORIGINATING_URI
1297 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001298
1299 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001300 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1301 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1302 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001303 */
1304 public static final String EXTRA_REFERRER
1305 = "android.intent.extra.REFERRER";
1306
1307 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001308 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1309 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1310 * @hide
1311 */
1312 public static final String EXTRA_ORIGINATING_UID
1313 = "android.intent.extra.ORIGINATING_UID";
1314
1315 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001316 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1317 * package. Tells the installer UI to skip the confirmation with the user
1318 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001319 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1320 * will no longer show an interstitial message about updating existing
1321 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001322 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001323 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001324 public static final String EXTRA_ALLOW_REPLACE
1325 = "android.intent.extra.ALLOW_REPLACE";
1326
1327 /**
1328 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1329 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1330 * return to the application the result code of the install/uninstall. The returned result
1331 * code will be {@link android.app.Activity#RESULT_OK} on success or
1332 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1333 */
1334 public static final String EXTRA_RETURN_RESULT
1335 = "android.intent.extra.RETURN_RESULT";
1336
1337 /**
1338 * Package manager install result code. @hide because result codes are not
1339 * yet ready to be exposed.
1340 */
1341 public static final String EXTRA_INSTALL_RESULT
1342 = "android.intent.extra.INSTALL_RESULT";
1343
1344 /**
1345 * Activity Action: Launch application uninstaller.
1346 * <p>
1347 * Input: The data must be a package: URI whose scheme specific part is
1348 * the package name of the current installed package to be uninstalled.
1349 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1350 * <p>
1351 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1352 * succeeded.
1353 */
1354 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1355 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1356
1357 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001358 * Specify whether the package should be uninstalled for all users.
1359 * @hide because these should not be part of normal application flow.
1360 */
1361 public static final String EXTRA_UNINSTALL_ALL_USERS
1362 = "android.intent.extra.UNINSTALL_ALL_USERS";
1363
1364 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001365 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1366 * describing the last run version of the platform that was setup.
1367 * @hide
1368 */
1369 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1370
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001371 // ---------------------------------------------------------------------
1372 // ---------------------------------------------------------------------
1373 // Standard intent broadcast actions (see action variable).
1374
1375 /**
1376 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001377 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001378 * <p class="note">This is a protected intent that can only be sent
1379 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001380 */
1381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1382 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1383 /**
1384 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001385 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001386 * <p class="note">This is a protected intent that can only be sent
1387 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001388 */
1389 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1390 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001391
1392 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001393 * Broadcast Action: Sent after the system stops dreaming.
1394 *
1395 * <p class="note">This is a protected intent that can only be sent by the system.
1396 * It is only sent to registered receivers.</p>
1397 */
1398 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1399 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1400
1401 /**
1402 * Broadcast Action: Sent after the system starts dreaming.
1403 *
1404 * <p class="note">This is a protected intent that can only be sent by the system.
1405 * It is only sent to registered receivers.</p>
1406 */
1407 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1408 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1409
1410 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001411 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001412 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001413 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001414 * <p class="note">This is a protected intent that can only be sent
1415 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001416 */
1417 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001418 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001419
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001420 /**
1421 * Broadcast Action: The current time has changed. Sent every
1422 * minute. You can <em>not</em> receive this through components declared
1423 * in manifests, only by exlicitly registering for it with
1424 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1425 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001426 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001427 * <p class="note">This is a protected intent that can only be sent
1428 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001429 */
1430 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1431 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1432 /**
1433 * Broadcast Action: The time was set.
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1437 /**
1438 * Broadcast Action: The date has changed.
1439 */
1440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1441 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1442 /**
1443 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1444 * <ul>
1445 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1446 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001447 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001448 * <p class="note">This is a protected intent that can only be sent
1449 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001450 */
1451 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1452 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1453 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001454 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1455 * DNS entries should be tossed.
1456 * @hide
1457 */
1458 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1459 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1460 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001461 * Alarm Changed Action: This is broadcast when the AlarmClock
1462 * application's alarm is set or unset. It is used by the
1463 * AlarmClock application and the StatusBar service.
1464 * @hide
1465 */
1466 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1467 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1468 /**
1469 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1470 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1471 * @hide
1472 */
1473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1474 public static final String ACTION_SYNC_STATE_CHANGED
1475 = "android.intent.action.SYNC_STATE_CHANGED";
1476 /**
1477 * Broadcast Action: This is broadcast once, after the system has finished
1478 * booting. It can be used to perform application-specific initialization,
1479 * such as installing alarms. You must hold the
1480 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1481 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001482 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001483 * <p class="note">This is a protected intent that can only be sent
1484 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001485 */
1486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1487 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1488 /**
1489 * Broadcast Action: This is broadcast when a user action should request a
1490 * temporary system dialog to dismiss. Some examples of temporary system
1491 * dialogs are the notification window-shade and the recent tasks dialog.
1492 */
1493 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1494 /**
1495 * Broadcast Action: Trigger the download and eventual installation
1496 * of a package.
1497 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001498 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001499 * <p class="note">This is a protected intent that can only be sent
1500 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001501 *
1502 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001503 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001504 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1506 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1507 /**
1508 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001509 * device. The data contains the name of the package. Note that the
1510 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001511 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001512 * <ul>
1513 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1514 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1515 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1516 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001517 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001518 * <p class="note">This is a protected intent that can only be sent
1519 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001520 */
1521 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1522 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1523 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001524 * Broadcast Action: A new version of an application package has been
1525 * installed, replacing an existing version that was previously installed.
1526 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001527 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001528 * <ul>
1529 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1530 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001531 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001532 * <p class="note">This is a protected intent that can only be sent
1533 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001534 */
1535 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1536 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1537 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001538 * Broadcast Action: A new version of your application has been installed
1539 * over an existing one. This is only sent to the application that was
1540 * replaced. It does not contain any additional data; to receive it, just
1541 * use an intent filter for this action.
1542 *
1543 * <p class="note">This is a protected intent that can only be sent
1544 * by the system.
1545 */
1546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1547 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1548 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001549 * Broadcast Action: An existing application package has been removed from
1550 * the device. The data contains the name of the package. The package
1551 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001552 * <ul>
1553 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1554 * to the package.
1555 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1556 * application -- data and code -- is being removed.
1557 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1558 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1559 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001560 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001561 * <p class="note">This is a protected intent that can only be sent
1562 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001563 */
1564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1565 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1566 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001567 * Broadcast Action: An existing application package has been completely
1568 * removed from the device. The data contains the name of the package.
1569 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1570 * {@link #EXTRA_DATA_REMOVED} is true and
1571 * {@link #EXTRA_REPLACING} is false of that broadcast.
1572 *
1573 * <ul>
1574 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1575 * to the package.
1576 * </ul>
1577 *
1578 * <p class="note">This is a protected intent that can only be sent
1579 * by the system.
1580 */
1581 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1582 public static final String ACTION_PACKAGE_FULLY_REMOVED
1583 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1584 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001585 * Broadcast Action: An existing application package has been changed (e.g.
1586 * a component has been enabled or disabled). The data contains the name of
1587 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001588 * <ul>
1589 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001590 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1591 * of the changed components.
1592 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1593 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001594 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001595 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001596 * <p class="note">This is a protected intent that can only be sent
1597 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001598 */
1599 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1600 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1601 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001602 * @hide
1603 * Broadcast Action: Ask system services if there is any reason to
1604 * restart the given package. The data contains the name of the
1605 * package.
1606 * <ul>
1607 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1608 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1609 * </ul>
1610 *
1611 * <p class="note">This is a protected intent that can only be sent
1612 * by the system.
1613 */
1614 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1615 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1616 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001617 * Broadcast Action: The user has restarted a package, and all of its
1618 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001619 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001620 * be removed. Note that the restarted package does <em>not</em>
1621 * receive this broadcast.
1622 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001623 * <ul>
1624 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1625 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001626 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001627 * <p class="note">This is a protected intent that can only be sent
1628 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001629 */
1630 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1631 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1632 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001633 * Broadcast Action: The user has cleared the data of a package. This should
1634 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001635 * its persistent data is erased and this broadcast sent.
1636 * Note that the cleared package does <em>not</em>
1637 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001638 * <ul>
1639 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1640 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001641 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001642 * <p class="note">This is a protected intent that can only be sent
1643 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001644 */
1645 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1646 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1647 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001648 * Broadcast Action: A user ID has been removed from the system. The user
1649 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001650 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001651 * <p class="note">This is a protected intent that can only be sent
1652 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001653 */
1654 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1655 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001656
1657 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001658 * Broadcast Action: Sent to the installer package of an application
1659 * when that application is first launched (that is the first time it
1660 * is moved out of the stopped state). The data contains the name of the package.
1661 *
1662 * <p class="note">This is a protected intent that can only be sent
1663 * by the system.
1664 */
1665 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1666 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1667
1668 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001669 * Broadcast Action: Sent to the system package verifier when a package
1670 * needs to be verified. The data contains the package URI.
1671 * <p class="note">
1672 * This is a protected intent that can only be sent by the system.
1673 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001674 */
1675 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1676 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1677
1678 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001679 * Broadcast Action: Sent to the system package verifier when a package is
1680 * verified. The data contains the package URI.
1681 * <p class="note">
1682 * This is a protected intent that can only be sent by the system.
1683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1685 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1686
1687 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001688 * Broadcast Action: Resources for a set of packages (which were
1689 * previously unavailable) are currently
1690 * available since the media on which they exist is available.
1691 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1692 * list of packages whose availability changed.
1693 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1694 * list of uids of packages whose availability changed.
1695 * Note that the
1696 * packages in this list do <em>not</em> receive this broadcast.
1697 * The specified set of packages are now available on the system.
1698 * <p>Includes the following extras:
1699 * <ul>
1700 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1701 * whose resources(were previously unavailable) are currently available.
1702 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1703 * packages whose resources(were previously unavailable)
1704 * are currently available.
1705 * </ul>
1706 *
1707 * <p class="note">This is a protected intent that can only be sent
1708 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001709 */
1710 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001711 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1712 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001713
1714 /**
1715 * Broadcast Action: Resources for a set of packages are currently
1716 * unavailable since the media on which they exist is unavailable.
1717 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1718 * list of packages whose availability changed.
1719 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1720 * list of uids of packages whose availability changed.
1721 * The specified set of packages can no longer be
1722 * launched and are practically unavailable on the system.
1723 * <p>Inclues the following extras:
1724 * <ul>
1725 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1726 * whose resources are no longer available.
1727 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1728 * whose resources are no longer available.
1729 * </ul>
1730 *
1731 * <p class="note">This is a protected intent that can only be sent
1732 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001733 */
1734 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001735 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001736 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001737
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001738 /**
1739 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001740 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001741 * This should <em>only</em> be used to determine when the wallpaper
1742 * has changed to show the new wallpaper to the user. You should certainly
1743 * never, in response to this, change the wallpaper or other attributes of
1744 * it such as the suggested size. That would be crazy, right? You'd cause
1745 * all kinds of loops, especially if other apps are doing similar things,
1746 * right? Of course. So please don't do this.
1747 *
1748 * @deprecated Modern applications should use
1749 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1750 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1751 * shown behind their UI, rather than watching for this broadcast and
1752 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001753 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001754 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001755 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1756 /**
1757 * Broadcast Action: The current device {@link android.content.res.Configuration}
1758 * (orientation, locale, etc) has changed. When such a change happens, the
1759 * UIs (view hierarchy) will need to be rebuilt based on this new
1760 * information; for the most part, applications don't need to worry about
1761 * this, because the system will take care of stopping and restarting the
1762 * application to make sure it sees the new changes. Some system code that
1763 * can not be restarted will need to watch for this action and handle it
1764 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001765 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001766 * <p class="note">
1767 * You can <em>not</em> receive this through components declared
1768 * in manifests, only by explicitly registering for it with
1769 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1770 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001771 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001772 * <p class="note">This is a protected intent that can only be sent
1773 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001774 *
1775 * @see android.content.res.Configuration
1776 */
1777 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1778 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1779 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001780 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001781 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001782 * <p class="note">This is a protected intent that can only be sent
1783 * by the system.
1784 */
1785 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1786 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1787 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001788 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1789 * charging state, level, and other information about the battery.
1790 * See {@link android.os.BatteryManager} for documentation on the
1791 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001792 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 * <p class="note">
1794 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001795 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001796 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001797 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1798 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1799 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1800 * broadcasts that are sent and can be received through manifest
1801 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001802 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001803 * <p class="note">This is a protected intent that can only be sent
1804 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001805 */
1806 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1807 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1808 /**
1809 * Broadcast Action: Indicates low battery condition on the device.
1810 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001811 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001812 * <p class="note">This is a protected intent that can only be sent
1813 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1817 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001818 * Broadcast Action: Indicates the battery is now okay after being low.
1819 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1820 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001821 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001822 * <p class="note">This is a protected intent that can only be sent
1823 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001824 */
1825 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1826 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1827 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001828 * Broadcast Action: External power has been connected to the device.
1829 * This is intended for applications that wish to register specifically to this notification.
1830 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1831 * stay active to receive this notification. This action can be used to implement actions
1832 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001833 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001834 * <p class="note">This is a protected intent that can only be sent
1835 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001836 */
1837 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001838 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001839 /**
1840 * Broadcast Action: External power has been removed from the device.
1841 * This is intended for applications that wish to register specifically to this notification.
1842 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1843 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001844 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001845 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001846 * <p class="note">This is a protected intent that can only be sent
1847 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001848 */
1849 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001850 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001851 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001852 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001853 * Broadcast Action: Device is shutting down.
1854 * This is broadcast when the device is being shut down (completely turned
1855 * off, not sleeping). Once the broadcast is complete, the final shutdown
1856 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001857 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001858 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001859 * <p class="note">This is a protected intent that can only be sent
1860 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001861 */
1862 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001863 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001864 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001865 * Activity Action: Start this activity to request system shutdown.
1866 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1867 * to request confirmation from the user before shutting down.
1868 *
1869 * <p class="note">This is a protected intent that can only be sent
1870 * by the system.
1871 *
1872 * {@hide}
1873 */
1874 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1875 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001876 * Broadcast Action: A sticky broadcast that indicates low memory
1877 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001878 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001879 * <p class="note">This is a protected intent that can only be sent
1880 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001881 */
1882 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1883 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1884 /**
1885 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001886 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001887 * <p class="note">This is a protected intent that can only be sent
1888 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001889 */
1890 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1891 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1892 /**
Jake Hambybb371632010-08-23 18:16:48 -07001893 * Broadcast Action: A sticky broadcast that indicates a memory full
1894 * condition on the device. This is intended for activities that want
1895 * to be able to fill the data partition completely, leaving only
1896 * enough free space to prevent system-wide SQLite failures.
1897 *
1898 * <p class="note">This is a protected intent that can only be sent
1899 * by the system.
1900 *
1901 * {@hide}
1902 */
1903 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1904 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1905 /**
1906 * Broadcast Action: Indicates memory full condition on the device
1907 * no longer exists.
1908 *
1909 * <p class="note">This is a protected intent that can only be sent
1910 * by the system.
1911 *
1912 * {@hide}
1913 */
1914 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1915 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1916 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001917 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1918 * and package management should be started.
1919 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1920 * notification.
1921 */
1922 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1923 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1924 /**
1925 * Broadcast Action: The device has entered USB Mass Storage mode.
1926 * This is used mainly for the USB Settings panel.
1927 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1928 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001929 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001930 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001931 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001932 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1933
1934 /**
1935 * Broadcast Action: The device has exited USB Mass Storage mode.
1936 * This is used mainly for the USB Settings panel.
1937 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1938 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001939 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001940 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001941 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001942 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1943
1944 /**
1945 * Broadcast Action: External media has been removed.
1946 * The path to the mount point for the removed media is contained in the Intent.mData field.
1947 */
1948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1949 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1950
1951 /**
1952 * Broadcast Action: External media is present, but not mounted at its mount point.
1953 * The path to the mount point for the removed media is contained in the Intent.mData field.
1954 */
1955 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1956 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1957
1958 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001959 * Broadcast Action: External media is present, and being disk-checked
1960 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001961 */
1962 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1963 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1964
1965 /**
1966 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1967 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001968 */
1969 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1970 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1971
1972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001973 * Broadcast Action: External media is present and mounted at its mount point.
1974 * The path to the mount point for the removed media is contained in the Intent.mData field.
1975 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1976 * media was mounted read only.
1977 */
1978 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1979 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1980
1981 /**
1982 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001983 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001984 */
1985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1986 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1987
1988 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001989 * Broadcast Action: External media is no longer being shared via USB mass storage.
1990 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1991 *
1992 * @hide
1993 */
1994 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1995
1996 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001997 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1998 * The path to the mount point for the removed media is contained in the Intent.mData field.
1999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2002
2003 /**
2004 * Broadcast Action: External media is present but cannot be mounted.
2005 * The path to the mount point for the removed media is contained in the Intent.mData field.
2006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2009
2010 /**
2011 * Broadcast Action: User has expressed the desire to remove the external storage media.
2012 * Applications should close all files they have open within the mount point when they receive this intent.
2013 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2014 */
2015 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2016 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2017
2018 /**
2019 * Broadcast Action: The media scanner has started scanning a directory.
2020 * The path to the directory being scanned is contained in the Intent.mData field.
2021 */
2022 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2023 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2024
2025 /**
2026 * Broadcast Action: The media scanner has finished scanning a directory.
2027 * The path to the scanned directory is contained in the Intent.mData field.
2028 */
2029 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2030 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2031
2032 /**
2033 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2034 * The path to the file is contained in the Intent.mData field.
2035 */
2036 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2037 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2038
2039 /**
2040 * Broadcast Action: The "Media Button" was pressed. Includes a single
2041 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2042 * caused the broadcast.
2043 */
2044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2045 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2046
2047 /**
2048 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2049 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2050 * caused the broadcast.
2051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2054
2055 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2056 // location; they are not general-purpose actions.
2057
2058 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002059 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002060 */
2061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2063 "android.intent.action.GTALK_CONNECTED";
2064
2065 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002066 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002067 */
2068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2070 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002071
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002072 /**
2073 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_INPUT_METHOD_CHANGED =
2077 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002078
2079 /**
2080 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2081 * more radios have been turned off or on. The intent will have the following extra value:</p>
2082 * <ul>
2083 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2084 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2085 * turned off</li>
2086 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002087 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002088 * <p class="note">This is a protected intent that can only be sent
2089 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002090 */
2091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2092 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2093
2094 /**
2095 * Broadcast Action: Some content providers have parts of their namespace
2096 * where they publish new events or items that the user may be especially
2097 * interested in. For these things, they may broadcast this action when the
2098 * set of interesting items change.
2099 *
2100 * For example, GmailProvider sends this notification when the set of unread
2101 * mail in the inbox changes.
2102 *
2103 * <p>The data of the intent identifies which part of which provider
2104 * changed. When queried through the content resolver, the data URI will
2105 * return the data set in question.
2106 *
2107 * <p>The intent will have the following extra values:
2108 * <ul>
2109 * <li><em>count</em> - The number of items in the data set. This is the
2110 * same as the number of items in the cursor returned by querying the
2111 * data URI. </li>
2112 * </ul>
2113 *
2114 * This intent will be sent at boot (if the count is non-zero) and when the
2115 * data set changes. It is possible for the data set to change without the
2116 * count changing (for example, if a new unread message arrives in the same
2117 * sync operation in which a message is archived). The phone should still
2118 * ring/vibrate/etc as normal in this case.
2119 */
2120 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2121 public static final String ACTION_PROVIDER_CHANGED =
2122 "android.intent.action.PROVIDER_CHANGED";
2123
2124 /**
2125 * Broadcast Action: Wired Headset plugged in or unplugged.
2126 *
2127 * <p>The intent will have the following extra values:
2128 * <ul>
2129 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2130 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002131 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002132 * </ul>
2133 * </ul>
2134 */
2135 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2136 public static final String ACTION_HEADSET_PLUG =
2137 "android.intent.action.HEADSET_PLUG";
2138
2139 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002140 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2141 *
2142 * <p>The intent will have the following extra values:
2143 * <ul>
2144 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2145 * <li><em>name</em> - Headset type, human readable string </li>
2146 * </ul>
2147 * </ul>
2148 * @hide
2149 */
2150 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002151 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2152 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002153
2154 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002155 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002156 *
2157 * <p>The intent will have the following extra values:
2158 * <ul>
2159 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2160 * <li><em>name</em> - Headset type, human readable string </li>
2161 * </ul>
2162 * </ul>
2163 * @hide
2164 */
2165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002166 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2167 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002168
2169 /**
2170 * Broadcast Action: A HMDI cable was plugged or unplugged
2171 *
2172 * <p>The intent will have the following extra values:
2173 * <ul>
2174 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2175 * <li><em>name</em> - HDMI cable, human readable string </li>
2176 * </ul>
2177 * </ul>
2178 * @hide
2179 */
2180 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2181 public static final String ACTION_HDMI_AUDIO_PLUG =
2182 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002183
2184 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002185 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2186 *
2187 * <p>The intent will have the following extra values:
2188 * <ul>
2189 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2190 * <li><em>card</em> - ALSA card number (integer) </li>
2191 * <li><em>device</em> - ALSA device number (integer) </li>
2192 * </ul>
2193 * </ul>
2194 * @hide
2195 */
2196 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2197 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2198 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2199
2200 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002201 * Broadcast Action: A USB audio device was plugged in or unplugged.
2202 *
2203 * <p>The intent will have the following extra values:
2204 * <ul>
2205 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2206 * <li><em>card</em> - ALSA card number (integer) </li>
2207 * <li><em>device</em> - ALSA device number (integer) </li>
2208 * </ul>
2209 * </ul>
2210 * @hide
2211 */
2212 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2213 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2214 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2215
2216 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002217 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2218 * <ul>
2219 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2220 * </ul>
2221 *
2222 * <p class="note">This is a protected intent that can only be sent
2223 * by the system.
2224 *
2225 * @hide
2226 */
2227 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2228 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2229 = "android.intent.action.ADVANCED_SETTINGS";
2230
2231 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002232 * Broadcast Action: An outgoing call is about to be placed.
2233 *
2234 * <p>The Intent will have the following extra value:
2235 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002236 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002237 * the phone number originally intended to be dialed.</li>
2238 * </ul>
2239 * <p>Once the broadcast is finished, the resultData is used as the actual
2240 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002241 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002242 * outgoing call in turn: for example, a parental control application
2243 * might verify that the user is authorized to place the call at that
2244 * time, then a number-rewriting application might add an area code if
2245 * one was not specified.</p>
2246 * <p>For consistency, any receiver whose purpose is to prohibit phone
2247 * calls should have a priority of 0, to ensure it will see the final
2248 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002249 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002250 * should have a positive priority.
2251 * Negative priorities are reserved for the system for this broadcast;
2252 * using them may cause problems.</p>
2253 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2254 * abort the broadcast.</p>
2255 * <p>Emergency calls cannot be intercepted using this mechanism, and
2256 * other calls cannot be modified to call emergency numbers using this
2257 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002258 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002259 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2260 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002261 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002262 * <p class="note">This is a protected intent that can only be sent
2263 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002264 */
2265 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_NEW_OUTGOING_CALL =
2267 "android.intent.action.NEW_OUTGOING_CALL";
2268
2269 /**
2270 * Broadcast Action: Have the device reboot. This is only for use by
2271 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002272 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002273 * <p class="note">This is a protected intent that can only be sent
2274 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 */
2276 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2277 public static final String ACTION_REBOOT =
2278 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002279
Wei Huang97ecc9c2009-05-11 17:44:20 -07002280 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002281 * Broadcast Action: A sticky broadcast for changes in the physical
2282 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002283 *
2284 * <p>The intent will have the following extra values:
2285 * <ul>
2286 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002287 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002288 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002289 * <p>This is intended for monitoring the current physical dock state.
2290 * See {@link android.app.UiModeManager} for the normal API dealing with
2291 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002292 */
2293 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2294 public static final String ACTION_DOCK_EVENT =
2295 "android.intent.action.DOCK_EVENT";
2296
2297 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002298 * Broadcast Action: a remote intent is to be broadcasted.
2299 *
2300 * A remote intent is used for remote RPC between devices. The remote intent
2301 * is serialized and sent from one device to another device. The receiving
2302 * device parses the remote intent and broadcasts it. Note that anyone can
2303 * broadcast a remote intent. However, if the intent receiver of the remote intent
2304 * does not trust intent broadcasts from arbitrary intent senders, it should require
2305 * the sender to hold certain permissions so only trusted sender's broadcast will be
2306 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002307 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002308 */
2309 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002310 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002311
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002312 /**
2313 * Broadcast Action: hook for permforming cleanup after a system update.
2314 *
2315 * The broadcast is sent when the system is booting, before the
2316 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2317 * image. A receiver for this should do its work and then disable itself
2318 * so that it does not get run again at the next boot.
2319 * @hide
2320 */
2321 public static final String ACTION_PRE_BOOT_COMPLETED =
2322 "android.intent.action.PRE_BOOT_COMPLETED";
2323
Amith Yamasani13593602012-03-22 16:16:17 -07002324 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002325 * Sent the first time a user is starting, to allow system apps to
2326 * perform one time initialization. (This will not be seen by third
2327 * party applications because a newly initialized user does not have any
2328 * third party applications installed for it.) This is sent early in
2329 * starting the user, around the time the home app is started, before
2330 * {@link #ACTION_BOOT_COMPLETED} is sent.
2331 */
2332 public static final String ACTION_USER_INITIALIZE =
2333 "android.intent.action.USER_INITIALIZE";
2334
2335 /**
2336 * Sent when a user switch is happening, causing the process's user to be
2337 * brought to the foreground. This is only sent to receivers registered
2338 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2339 * Context.registerReceiver}. It is sent to the user that is going to the
2340 * foreground.
2341 */
2342 public static final String ACTION_USER_FOREGROUND =
2343 "android.intent.action.USER_FOREGROUND";
2344
2345 /**
2346 * Sent when a user switch is happening, causing the process's user to be
2347 * sent to the background. This is only sent to receivers registered
2348 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2349 * Context.registerReceiver}. It is sent to the user that is going to the
2350 * background.
2351 */
2352 public static final String ACTION_USER_BACKGROUND =
2353 "android.intent.action.USER_BACKGROUND";
2354
2355 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002356 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USER_HANDLE that has the
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002357 * userHandle of the new user. It is sent to all running users. You must hold
2358 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002359 * @hide
2360 */
2361 public static final String ACTION_USER_ADDED =
2362 "android.intent.action.USER_ADDED";
2363
2364 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002365 * Broadcast sent to the system when a user is started. Carries an extra EXTRA_USER_HANDLE that has
2366 * the userHandle of the user. This is only sent to
2367 * registered receivers, not manifest receivers. It is sent to the user
2368 * that has been started.
2369 * @hide
2370 */
2371 public static final String ACTION_USER_STARTED =
2372 "android.intent.action.USER_STARTED";
2373
2374 /**
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002375 * Broadcast sent to the system when a user is stopped. Carries an extra EXTRA_USER_HANDLE that has
2376 * the userHandle of the user. This is similar to {@link #ACTION_PACKAGE_RESTARTED},
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002377 * but for an entire user instead of a specific package. This is only sent to
2378 * registered receivers, not manifest receivers. It is sent to all running
2379 * users <em>except</em> the one that has just been stopped (which is no
2380 * longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002381 * @hide
2382 */
2383 public static final String ACTION_USER_STOPPED =
2384 "android.intent.action.USER_STOPPED";
2385
2386 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002387 * 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 -07002388 * the userHandle of the user. It is sent to all running users except the
2389 * one that has been removed. You must hold
2390 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002391 * @hide
2392 */
2393 public static final String ACTION_USER_REMOVED =
2394 "android.intent.action.USER_REMOVED";
2395
2396 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002397 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002398 * the userHandle of the user to become the current one. This is only sent to
2399 * registered receivers, not manifest receivers. It is sent to all running users.
2400 * You must hold
2401 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002402 * @hide
2403 */
2404 public static final String ACTION_USER_SWITCHED =
2405 "android.intent.action.USER_SWITCHED";
2406
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002407 /**
2408 * Broadcast sent to the system when a user's information changes. Carries an extra
2409 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2410 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2411 * whose information has changed.
2412 * @hide
2413 */
2414 public static final String ACTION_USER_INFO_CHANGED =
2415 "android.intent.action.USER_INFO_CHANGED";
2416
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002417 /**
2418 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2419 */
2420 public static final String ACTION_QUICK_CLOCK =
2421 "android.intent.action.QUICK_CLOCK";
2422
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002423 // ---------------------------------------------------------------------
2424 // ---------------------------------------------------------------------
2425 // Standard intent categories (see addCategory()).
2426
2427 /**
2428 * Set if the activity should be an option for the default action
2429 * (center press) to perform on a piece of data. Setting this will
2430 * hide from the user any activities without it set when performing an
2431 * action on some data. Note that this is normal -not- set in the
2432 * Intent when initiating an action -- it is for use in intent filters
2433 * specified in packages.
2434 */
2435 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2436 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2437 /**
2438 * Activities that can be safely invoked from a browser must support this
2439 * category. For example, if the user is viewing a web page or an e-mail
2440 * and clicks on a link in the text, the Intent generated execute that
2441 * link will require the BROWSABLE category, so that only activities
2442 * supporting this category will be considered as possible actions. By
2443 * supporting this category, you are promising that there is nothing
2444 * damaging (without user intervention) that can happen by invoking any
2445 * matching Intent.
2446 */
2447 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2448 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2449 /**
2450 * Set if the activity should be considered as an alternative action to
2451 * the data the user is currently viewing. See also
2452 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2453 * applies to the selection in a list of items.
2454 *
2455 * <p>Supporting this category means that you would like your activity to be
2456 * displayed in the set of alternative things the user can do, usually as
2457 * part of the current activity's options menu. You will usually want to
2458 * include a specific label in the &lt;intent-filter&gt; of this action
2459 * describing to the user what it does.
2460 *
2461 * <p>The action of IntentFilter with this category is important in that it
2462 * describes the specific action the target will perform. This generally
2463 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2464 * a specific name such as "com.android.camera.action.CROP. Only one
2465 * alternative of any particular action will be shown to the user, so using
2466 * a specific action like this makes sure that your alternative will be
2467 * displayed while also allowing other applications to provide their own
2468 * overrides of that particular action.
2469 */
2470 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2471 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2472 /**
2473 * Set if the activity should be considered as an alternative selection
2474 * action to the data the user has currently selected. This is like
2475 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2476 * of items from which the user can select, giving them alternatives to the
2477 * default action that will be performed on it.
2478 */
2479 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2480 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2481 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002482 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002483 */
2484 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2485 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2486 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002487 * Should be displayed in the top-level launcher.
2488 */
2489 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2490 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2491 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002492 * Provides information about the package it is in; typically used if
2493 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2494 * a front-door to the user without having to be shown in the all apps list.
2495 */
2496 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2497 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2498 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002499 * This is the home activity, that is the first activity that is displayed
2500 * when the device boots.
2501 */
2502 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2503 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2504 /**
2505 * This activity is a preference panel.
2506 */
2507 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2508 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2509 /**
2510 * This activity is a development preference panel.
2511 */
2512 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2513 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2514 /**
2515 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002516 */
2517 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2518 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2519 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002520 * This activity allows the user to browse and download new applications.
2521 */
2522 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2523 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2524 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002525 * This activity may be exercised by the monkey or other automated test tools.
2526 */
2527 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2528 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2529 /**
2530 * To be used as a test (not part of the normal user experience).
2531 */
2532 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2533 /**
2534 * To be used as a unit test (run through the Test Harness).
2535 */
2536 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2537 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002538 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002539 * experience).
2540 */
2541 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2542 /**
2543 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2544 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2545 * when queried, though it is allowable for those columns to be blank.
2546 */
2547 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2548 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2549
2550 /**
2551 * To be used as code under test for framework instrumentation tests.
2552 */
2553 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2554 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002555 /**
2556 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002557 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2558 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002559 */
2560 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2561 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2562 /**
2563 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002564 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2565 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002566 */
2567 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2568 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002569 /**
2570 * An activity to run when device is inserted into a analog (low end) dock.
2571 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2572 * information, see {@link android.app.UiModeManager}.
2573 */
2574 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2575 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2576
2577 /**
2578 * An activity to run when device is inserted into a digital (high end) dock.
2579 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2580 * information, see {@link android.app.UiModeManager}.
2581 */
2582 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2583 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002584
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002585 /**
2586 * Used to indicate that the activity can be used in a car environment.
2587 */
2588 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2589 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2590
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002591 // ---------------------------------------------------------------------
2592 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002593 // Application launch intent categories (see addCategory()).
2594
2595 /**
2596 * Used with {@link #ACTION_MAIN} to launch the browser application.
2597 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002598 * <p>NOTE: This should not be used as the primary key of an Intent,
2599 * since it will not result in the app launching with the correct
2600 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002601 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002602 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002603 */
2604 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2605 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2606
2607 /**
2608 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2609 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002610 * <p>NOTE: This should not be used as the primary key of an Intent,
2611 * since it will not result in the app launching with the correct
2612 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002613 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002614 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002615 */
2616 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2617 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2618
2619 /**
2620 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2621 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002622 * <p>NOTE: This should not be used as the primary key of an Intent,
2623 * since it will not result in the app launching with the correct
2624 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002625 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002626 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002627 */
2628 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2629 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2630
2631 /**
2632 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2633 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002634 * <p>NOTE: This should not be used as the primary key of an Intent,
2635 * since it will not result in the app launching with the correct
2636 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002637 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002638 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002639 */
2640 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2641 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2642
2643 /**
2644 * Used with {@link #ACTION_MAIN} to launch the email application.
2645 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002646 * <p>NOTE: This should not be used as the primary key of an Intent,
2647 * since it will not result in the app launching with the correct
2648 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002649 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002650 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002651 */
2652 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2653 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2654
2655 /**
2656 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2657 * The activity should be able to view and manipulate image and video files
2658 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002659 * <p>NOTE: This should not be used as the primary key of an Intent,
2660 * since it will not result in the app launching with the correct
2661 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002662 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002663 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002664 */
2665 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2666 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2667
2668 /**
2669 * Used with {@link #ACTION_MAIN} to launch the maps application.
2670 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002671 * <p>NOTE: This should not be used as the primary key of an Intent,
2672 * since it will not result in the app launching with the correct
2673 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002674 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002675 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002676 */
2677 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2678 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2679
2680 /**
2681 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2682 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002683 * <p>NOTE: This should not be used as the primary key of an Intent,
2684 * since it will not result in the app launching with the correct
2685 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002686 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002687 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002688 */
2689 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2690 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2691
2692 /**
2693 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002694 * The activity should be able to play, browse, or manipulate music files
2695 * stored on the device.
2696 * <p>NOTE: This should not be used as the primary key of an Intent,
2697 * since it will not result in the app launching with the correct
2698 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002699 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002700 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002701 */
2702 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2703 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2704
2705 // ---------------------------------------------------------------------
2706 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002707 // Standard extra data keys.
2708
2709 /**
2710 * The initial data to place in a newly created record. Use with
2711 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2712 * fields as would be given to the underlying ContentProvider.insert()
2713 * call.
2714 */
2715 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2716
2717 /**
2718 * A constant CharSequence that is associated with the Intent, used with
2719 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2720 * this may be a styled CharSequence, so you must use
2721 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2722 * retrieve it.
2723 */
2724 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2725
2726 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002727 * A constant String that is associated with the Intent, used with
2728 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2729 * as HTML formatted text. Note that you <em>must</em> also supply
2730 * {@link #EXTRA_TEXT}.
2731 */
2732 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2733
2734 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002735 * A content: URI holding a stream of data associated with the Intent,
2736 * used with {@link #ACTION_SEND} to supply the data being sent.
2737 */
2738 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2739
2740 /**
2741 * A String[] holding e-mail addresses that should be delivered to.
2742 */
2743 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2744
2745 /**
2746 * A String[] holding e-mail addresses that should be carbon copied.
2747 */
2748 public static final String EXTRA_CC = "android.intent.extra.CC";
2749
2750 /**
2751 * A String[] holding e-mail addresses that should be blind carbon copied.
2752 */
2753 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2754
2755 /**
2756 * A constant string holding the desired subject line of a message.
2757 */
2758 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2759
2760 /**
2761 * An Intent describing the choices you would like shown with
2762 * {@link #ACTION_PICK_ACTIVITY}.
2763 */
2764 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2765
2766 /**
2767 * A CharSequence dialog title to provide to the user when used with a
2768 * {@link #ACTION_CHOOSER}.
2769 */
2770 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2771
2772 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002773 * A Parcelable[] of {@link Intent} or
2774 * {@link android.content.pm.LabeledIntent} objects as set with
2775 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2776 * a the front of the list of choices, when shown to the user with a
2777 * {@link #ACTION_CHOOSER}.
2778 */
2779 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2780
2781 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002782 * A {@link android.view.KeyEvent} object containing the event that
2783 * triggered the creation of the Intent it is in.
2784 */
2785 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2786
2787 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002788 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2789 * before shutting down.
2790 *
2791 * {@hide}
2792 */
2793 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2794
2795 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002796 * 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 -07002797 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2798 * of restarting the application.
2799 */
2800 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2801
2802 /**
2803 * A String holding the phone number originally entered in
2804 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2805 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2806 */
2807 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002808
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002809 /**
2810 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2811 * intents to supply the uid the package had been assigned. Also an optional
2812 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2813 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2814 * purpose.
2815 */
2816 public static final String EXTRA_UID = "android.intent.extra.UID";
2817
2818 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002819 * @hide String array of package names.
2820 */
2821 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2822
2823 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002824 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2825 * intents to indicate whether this represents a full uninstall (removing
2826 * both the code and its data) or a partial uninstall (leaving its data,
2827 * implying that this is an update).
2828 */
2829 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002830
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002831 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002832 * @hide
2833 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2834 * intents to indicate that at this point the package has been removed for
2835 * all users on the device.
2836 */
2837 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2838 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2839
2840 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002841 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2842 * intents to indicate that this is a replacement of the package, so this
2843 * broadcast will immediately be followed by an add broadcast for a
2844 * different version of the same package.
2845 */
2846 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002847
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002848 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002849 * Used as an int extra field in {@link android.app.AlarmManager} intents
2850 * to tell the application being invoked how many pending alarms are being
2851 * delievered with the intent. For one-shot alarms this will always be 1.
2852 * For recurring alarms, this might be greater than 1 if the device was
2853 * asleep or powered off at the time an earlier alarm would have been
2854 * delivered.
2855 */
2856 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002857
Jacek Surazski86b6c532009-05-13 14:38:28 +02002858 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002859 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2860 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002861 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2862 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002863 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2864 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2865 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002866 */
2867 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2868
2869 /**
2870 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2871 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002872 */
2873 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2874
2875 /**
2876 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2877 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002878 */
2879 public static final int EXTRA_DOCK_STATE_DESK = 1;
2880
2881 /**
2882 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2883 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002884 */
2885 public static final int EXTRA_DOCK_STATE_CAR = 2;
2886
2887 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002888 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2889 * to represent that the phone is in a analog (low end) dock.
2890 */
2891 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2892
2893 /**
2894 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2895 * to represent that the phone is in a digital (high end) dock.
2896 */
2897 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2898
2899 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002900 * Boolean that can be supplied as meta-data with a dock activity, to
2901 * indicate that the dock should take over the home key when it is active.
2902 */
2903 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002904
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002905 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002906 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2907 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002908 */
2909 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2910
2911 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002912 * Used in the extra field in the remote intent. It's astring token passed with the
2913 * remote intent.
2914 */
2915 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2916 "android.intent.extra.remote_intent_token";
2917
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002918 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002919 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002920 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002921 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002922 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002923 "android.intent.extra.changed_component_name";
2924
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002925 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002926 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002927 * and contains a string array of all of the components that have changed.
2928 */
2929 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2930 "android.intent.extra.changed_component_name_list";
2931
2932 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002933 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002934 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2935 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002936 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002937 */
2938 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2939 "android.intent.extra.changed_package_list";
2940
2941 /**
2942 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002943 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2944 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002945 * and contains an integer array of uids of all of the components
2946 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002947 */
2948 public static final String EXTRA_CHANGED_UID_LIST =
2949 "android.intent.extra.changed_uid_list";
2950
2951 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002952 * @hide
2953 * Magic extra system code can use when binding, to give a label for
2954 * who it is that has bound to a service. This is an integer giving
2955 * a framework string resource that can be displayed to the user.
2956 */
2957 public static final String EXTRA_CLIENT_LABEL =
2958 "android.intent.extra.client_label";
2959
2960 /**
2961 * @hide
2962 * Magic extra system code can use when binding, to give a PendingIntent object
2963 * that can be launched for the user to disable the system's use of this
2964 * service.
2965 */
2966 public static final String EXTRA_CLIENT_INTENT =
2967 "android.intent.extra.client_intent";
2968
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002969 /**
2970 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2971 * data that is on the local device. This is a boolean extra; the default
2972 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2973 * the user to select media that is already on the device, not requiring it
2974 * be downloaded from a remote service when opened. Another way to look
2975 * at it is that such content should generally have a "_data" column to the
2976 * path of the content on local external storage.
2977 */
2978 public static final String EXTRA_LOCAL_ONLY =
2979 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002980
Amith Yamasani13593602012-03-22 16:16:17 -07002981 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002982 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07002983 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2984 * @hide
2985 */
Amith Yamasani2a003292012-08-14 18:25:45 -07002986 public static final String EXTRA_USER_HANDLE =
2987 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07002988
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002989 // ---------------------------------------------------------------------
2990 // ---------------------------------------------------------------------
2991 // Intent flags (see mFlags variable).
2992
2993 /**
2994 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002995 * perform read operations on the Uri in the Intent's data and any URIs
2996 * specified in its ClipData. When applying to an Intent's ClipData,
2997 * all URIs as well as recursive traversals through data or other ClipData
2998 * in Intent items will be granted; only the grant flags of the top-level
2999 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003000 */
3001 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3002 /**
3003 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003004 * perform write operations on the Uri in the Intent's data and any URIs
3005 * specified in its ClipData. When applying to an Intent's ClipData,
3006 * all URIs as well as recursive traversals through data or other ClipData
3007 * in Intent items will be granted; only the grant flags of the top-level
3008 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003009 */
3010 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3011 /**
3012 * Can be set by the caller to indicate that this Intent is coming from
3013 * a background operation, not from direct user interaction.
3014 */
3015 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3016 /**
3017 * A flag you can enable for debugging: when set, log messages will be
3018 * printed during the resolution of this intent to show you what has
3019 * been found to create the final resolved list.
3020 */
3021 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003022 /**
3023 * If set, this intent will not match any components in packages that
3024 * are currently stopped. If this is not set, then the default behavior
3025 * is to include such applications in the result.
3026 */
3027 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3028 /**
3029 * If set, this intent will always match any components in packages that
3030 * are currently stopped. This is the default behavior when
3031 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3032 * flags are set, this one wins (it allows overriding of exclude for
3033 * places where the framework may automatically set the exclude flag).
3034 */
3035 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003036
3037 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003038 * If set, the new activity is not kept in the history stack. As soon as
3039 * the user navigates away from it, the activity is finished. This may also
3040 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3041 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003042 */
3043 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3044 /**
3045 * If set, the activity will not be launched if it is already running
3046 * at the top of the history stack.
3047 */
3048 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3049 /**
3050 * If set, this activity will become the start of a new task on this
3051 * history stack. A task (from the activity that started it to the
3052 * next task activity) defines an atomic group of activities that the
3053 * user can move to. Tasks can be moved to the foreground and background;
3054 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003055 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003056 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3057 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003058 *
3059 * <p>This flag is generally used by activities that want
3060 * to present a "launcher" style behavior: they give the user a list of
3061 * separate things that can be done, which otherwise run completely
3062 * independently of the activity launching them.
3063 *
3064 * <p>When using this flag, if a task is already running for the activity
3065 * you are now starting, then a new activity will not be started; instead,
3066 * the current task will simply be brought to the front of the screen with
3067 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3068 * to disable this behavior.
3069 *
3070 * <p>This flag can not be used when the caller is requesting a result from
3071 * the activity being launched.
3072 */
3073 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3074 /**
3075 * <strong>Do not use this flag unless you are implementing your own
3076 * top-level application launcher.</strong> Used in conjunction with
3077 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3078 * behavior of bringing an existing task to the foreground. When set,
3079 * a new task is <em>always</em> started to host the Activity for the
3080 * Intent, regardless of whether there is already an existing task running
3081 * the same thing.
3082 *
3083 * <p><strong>Because the default system does not include graphical task management,
3084 * you should not use this flag unless you provide some way for a user to
3085 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003086 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003087 * <p>This flag is ignored if
3088 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3089 *
Scott Main7aee61f2011-02-08 11:25:01 -08003090 * <p>See
3091 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3092 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003093 */
3094 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3095 /**
3096 * If set, and the activity being launched is already running in the
3097 * current task, then instead of launching a new instance of that activity,
3098 * all of the other activities on top of it will be closed and this Intent
3099 * will be delivered to the (now on top) old activity as a new Intent.
3100 *
3101 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3102 * If D calls startActivity() with an Intent that resolves to the component
3103 * of activity B, then C and D will be finished and B receive the given
3104 * Intent, resulting in the stack now being: A, B.
3105 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003106 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003107 * either receive the new intent you are starting here in its
3108 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003109 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003110 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3111 * the same intent, then it will be finished and re-created; for all other
3112 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3113 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003114 *
3115 * <p>This launch mode can also be used to good effect in conjunction with
3116 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3117 * of a task, it will bring any currently running instance of that task
3118 * to the foreground, and then clear it to its root state. This is
3119 * especially useful, for example, when launching an activity from the
3120 * notification manager.
3121 *
Scott Main7aee61f2011-02-08 11:25:01 -08003122 * <p>See
3123 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3124 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003125 */
3126 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3127 /**
3128 * If set and this intent is being used to launch a new activity from an
3129 * existing one, then the reply target of the existing activity will be
3130 * transfered to the new activity. This way the new activity can call
3131 * {@link android.app.Activity#setResult} and have that result sent back to
3132 * the reply target of the original activity.
3133 */
3134 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3135 /**
3136 * If set and this intent is being used to launch a new activity from an
3137 * existing one, the current activity will not be counted as the top
3138 * activity for deciding whether the new intent should be delivered to
3139 * the top instead of starting a new one. The previous activity will
3140 * be used as the top, with the assumption being that the current activity
3141 * will finish itself immediately.
3142 */
3143 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3144 /**
3145 * If set, the new activity is not kept in the list of recently launched
3146 * activities.
3147 */
3148 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3149 /**
3150 * This flag is not normally set by application code, but set for you by
3151 * the system as described in the
3152 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3153 * launchMode} documentation for the singleTask mode.
3154 */
3155 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3156 /**
3157 * If set, and this activity is either being started in a new task or
3158 * bringing to the top an existing task, then it will be launched as
3159 * the front door of the task. This will result in the application of
3160 * any affinities needed to have that task in the proper state (either
3161 * moving activities to or from it), or simply resetting that task to
3162 * its initial state if needed.
3163 */
3164 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3165 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003166 * This flag is not normally set by application code, but set for you by
3167 * the system if this activity is being launched from history
3168 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003169 */
3170 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003171 /**
3172 * If set, this marks a point in the task's activity stack that should
3173 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003174 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003175 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3176 * the user re-launching it from home), this activity and all on top of
3177 * it will be finished so that the user does not return to them, but
3178 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003179 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003180 * <p>This is useful for cases where you have a logical break in your
3181 * application. For example, an e-mail application may have a command
3182 * to view an attachment, which launches an image view activity to
3183 * display it. This activity should be part of the e-mail application's
3184 * task, since it is a part of the task the user is involved in. However,
3185 * if the user leaves that task, and later selects the e-mail app from
3186 * home, we may like them to return to the conversation they were
3187 * viewing, not the picture attachment, since that is confusing. By
3188 * setting this flag when launching the image viewer, that viewer and
3189 * any activities it starts will be removed the next time the user returns
3190 * to mail.
3191 */
3192 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003193 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003194 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003195 * callback from occurring on the current frontmost activity before it is
3196 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003197 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003198 * <p>Typically, an activity can rely on that callback to indicate that an
3199 * explicit user action has caused their activity to be moved out of the
3200 * foreground. The callback marks an appropriate point in the activity's
3201 * lifecycle for it to dismiss any notifications that it intends to display
3202 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003203 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003204 * <p>If an activity is ever started via any non-user-driven events such as
3205 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3206 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003207 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003208 */
3209 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003210 /**
3211 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3212 * this flag will cause the launched activity to be brought to the front of its
3213 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003214 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003215 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3216 * If D calls startActivity() with an Intent that resolves to the component
3217 * of activity B, then B will be brought to the front of the history stack,
3218 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003219 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003220 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003221 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003222 */
3223 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003224 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003225 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3226 * this flag will prevent the system from applying an activity transition
3227 * animation to go to the next activity state. This doesn't mean an
3228 * animation will never run -- if another activity change happens that doesn't
3229 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003230 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003231 * when you are going to do a series of activity operations but the
3232 * animation seen by the user shouldn't be driven by the first activity
3233 * change but rather a later one.
3234 */
3235 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3236 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003237 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3238 * this flag will cause any existing task that would be associated with the
3239 * activity to be cleared before the activity is started. That is, the activity
3240 * becomes the new root of an otherwise empty task, and any old activities
3241 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3242 */
3243 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3244 /**
3245 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3246 * this flag will cause a newly launching task to be placed on top of the current
3247 * home activity task (if there is one). That is, pressing back from the task
3248 * will always return the user to home even if that was not the last activity they
3249 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3250 */
3251 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3252 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003253 * If set, when sending a broadcast only registered receivers will be
3254 * called -- no BroadcastReceiver components will be launched.
3255 */
3256 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003257 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003258 * If set, when sending a broadcast the new broadcast will replace
3259 * any existing pending broadcast that matches it. Matching is defined
3260 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3261 * true for the intents of the two broadcasts. When a match is found,
3262 * the new broadcast (and receivers associated with it) will replace the
3263 * existing one in the pending broadcast list, remaining at the same
3264 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003265 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003266 * <p>This flag is most typically used with sticky broadcasts, which
3267 * only care about delivering the most recent values of the broadcast
3268 * to their receivers.
3269 */
3270 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3271 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003272 * If set, when sending a broadcast the recipient is allowed to run at
3273 * foreground priority, with a shorter timeout interval. During normal
3274 * broadcasts the receivers are not automatically hoisted out of the
3275 * background priority class.
3276 */
3277 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3278 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003279 * If set, when sending a broadcast <i>before boot has completed</i> only
3280 * registered receivers will be called -- no BroadcastReceiver components
3281 * will be launched. Sticky intent state will be recorded properly even
3282 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3283 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003284 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003285 * <p>This flag is only for use by system sevices as a convenience to
3286 * avoid having to implement a more complex mechanism around detection
3287 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003288 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003289 * @hide
3290 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003291 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003292 /**
3293 * Set when this broadcast is for a boot upgrade, a special mode that
3294 * allows the broadcast to be sent before the system is ready and launches
3295 * the app process with no providers running in it.
3296 * @hide
3297 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003298 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003299
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003300 /**
3301 * @hide Flags that can't be changed with PendingIntent.
3302 */
3303 public static final int IMMUTABLE_FLAGS =
3304 FLAG_GRANT_READ_URI_PERMISSION
3305 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003306
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003307 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003308 // ---------------------------------------------------------------------
3309 // toUri() and parseUri() options.
3310
3311 /**
3312 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3313 * always has the "intent:" scheme. This syntax can be used when you want
3314 * to later disambiguate between URIs that are intended to describe an
3315 * Intent vs. all others that should be treated as raw URIs. When used
3316 * with {@link #parseUri}, any other scheme will result in a generic
3317 * VIEW action for that raw URI.
3318 */
3319 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003320
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003321 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003322
3323 private String mAction;
3324 private Uri mData;
3325 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003326 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003327 private ComponentName mComponent;
3328 private int mFlags;
3329 private HashSet<String> mCategories;
3330 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003331 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003332 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003333 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003334
3335 // ---------------------------------------------------------------------
3336
3337 /**
3338 * Create an empty intent.
3339 */
3340 public Intent() {
3341 }
3342
3343 /**
3344 * Copy constructor.
3345 */
3346 public Intent(Intent o) {
3347 this.mAction = o.mAction;
3348 this.mData = o.mData;
3349 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003350 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003351 this.mComponent = o.mComponent;
3352 this.mFlags = o.mFlags;
3353 if (o.mCategories != null) {
3354 this.mCategories = new HashSet<String>(o.mCategories);
3355 }
3356 if (o.mExtras != null) {
3357 this.mExtras = new Bundle(o.mExtras);
3358 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003359 if (o.mSourceBounds != null) {
3360 this.mSourceBounds = new Rect(o.mSourceBounds);
3361 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003362 if (o.mSelector != null) {
3363 this.mSelector = new Intent(o.mSelector);
3364 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003365 if (o.mClipData != null) {
3366 this.mClipData = new ClipData(o.mClipData);
3367 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003368 }
3369
3370 @Override
3371 public Object clone() {
3372 return new Intent(this);
3373 }
3374
3375 private Intent(Intent o, boolean all) {
3376 this.mAction = o.mAction;
3377 this.mData = o.mData;
3378 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003379 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003380 this.mComponent = o.mComponent;
3381 if (o.mCategories != null) {
3382 this.mCategories = new HashSet<String>(o.mCategories);
3383 }
3384 }
3385
3386 /**
3387 * Make a clone of only the parts of the Intent that are relevant for
3388 * filter matching: the action, data, type, component, and categories.
3389 */
3390 public Intent cloneFilter() {
3391 return new Intent(this, false);
3392 }
3393
3394 /**
3395 * Create an intent with a given action. All other fields (data, type,
3396 * class) are null. Note that the action <em>must</em> be in a
3397 * namespace because Intents are used globally in the system -- for
3398 * example the system VIEW action is android.intent.action.VIEW; an
3399 * application's custom action would be something like
3400 * com.google.app.myapp.CUSTOM_ACTION.
3401 *
3402 * @param action The Intent action, such as ACTION_VIEW.
3403 */
3404 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003405 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003406 }
3407
3408 /**
3409 * Create an intent with a given action and for a given data url. Note
3410 * that the action <em>must</em> be in a namespace because Intents are
3411 * used globally in the system -- for example the system VIEW action is
3412 * android.intent.action.VIEW; an application's custom action would be
3413 * something like com.google.app.myapp.CUSTOM_ACTION.
3414 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003415 * <p><em>Note: scheme and host name matching in the Android framework is
3416 * case-sensitive, unlike the formal RFC. As a result,
3417 * you should always ensure that you write your Uri with these elements
3418 * using lower case letters, and normalize any Uris you receive from
3419 * outside of Android to ensure the scheme and host is lower case.</em></p>
3420 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003421 * @param action The Intent action, such as ACTION_VIEW.
3422 * @param uri The Intent data URI.
3423 */
3424 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003425 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003426 mData = uri;
3427 }
3428
3429 /**
3430 * Create an intent for a specific component. All other fields (action, data,
3431 * type, class) are null, though they can be modified later with explicit
3432 * calls. This provides a convenient way to create an intent that is
3433 * intended to execute a hard-coded class name, rather than relying on the
3434 * system to find an appropriate class for you; see {@link #setComponent}
3435 * for more information on the repercussions of this.
3436 *
3437 * @param packageContext A Context of the application package implementing
3438 * this class.
3439 * @param cls The component class that is to be used for the intent.
3440 *
3441 * @see #setClass
3442 * @see #setComponent
3443 * @see #Intent(String, android.net.Uri , Context, Class)
3444 */
3445 public Intent(Context packageContext, Class<?> cls) {
3446 mComponent = new ComponentName(packageContext, cls);
3447 }
3448
3449 /**
3450 * Create an intent for a specific component with a specified action and data.
3451 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3452 * construct the Intent and then calling {@link #setClass} to set its
3453 * class.
3454 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003455 * <p><em>Note: scheme and host name matching in the Android framework is
3456 * case-sensitive, unlike the formal RFC. As a result,
3457 * you should always ensure that you write your Uri with these elements
3458 * using lower case letters, and normalize any Uris you receive from
3459 * outside of Android to ensure the scheme and host is lower case.</em></p>
3460 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003461 * @param action The Intent action, such as ACTION_VIEW.
3462 * @param uri The Intent data URI.
3463 * @param packageContext A Context of the application package implementing
3464 * this class.
3465 * @param cls The component class that is to be used for the intent.
3466 *
3467 * @see #Intent(String, android.net.Uri)
3468 * @see #Intent(Context, Class)
3469 * @see #setClass
3470 * @see #setComponent
3471 */
3472 public Intent(String action, Uri uri,
3473 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003474 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003475 mData = uri;
3476 mComponent = new ComponentName(packageContext, cls);
3477 }
3478
3479 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003480 * Create an intent to launch the main (root) activity of a task. This
3481 * is the Intent that is started when the application's is launched from
3482 * Home. For anything else that wants to launch an application in the
3483 * same way, it is important that they use an Intent structured the same
3484 * way, and can use this function to ensure this is the case.
3485 *
3486 * <p>The returned Intent has the given Activity component as its explicit
3487 * component, {@link #ACTION_MAIN} as its action, and includes the
3488 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3489 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3490 * to do that through {@link #addFlags(int)} on the returned Intent.
3491 *
3492 * @param mainActivity The main activity component that this Intent will
3493 * launch.
3494 * @return Returns a newly created Intent that can be used to launch the
3495 * activity as a main application entry.
3496 *
3497 * @see #setClass
3498 * @see #setComponent
3499 */
3500 public static Intent makeMainActivity(ComponentName mainActivity) {
3501 Intent intent = new Intent(ACTION_MAIN);
3502 intent.setComponent(mainActivity);
3503 intent.addCategory(CATEGORY_LAUNCHER);
3504 return intent;
3505 }
3506
3507 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003508 * Make an Intent for the main activity of an application, without
3509 * specifying a specific activity to run but giving a selector to find
3510 * the activity. This results in a final Intent that is structured
3511 * the same as when the application is launched from
3512 * Home. For anything else that wants to launch an application in the
3513 * same way, it is important that they use an Intent structured the same
3514 * way, and can use this function to ensure this is the case.
3515 *
3516 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3517 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3518 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3519 * to do that through {@link #addFlags(int)} on the returned Intent.
3520 *
3521 * @param selectorAction The action name of the Intent's selector.
3522 * @param selectorCategory The name of a category to add to the Intent's
3523 * selector.
3524 * @return Returns a newly created Intent that can be used to launch the
3525 * activity as a main application entry.
3526 *
3527 * @see #setSelector(Intent)
3528 */
3529 public static Intent makeMainSelectorActivity(String selectorAction,
3530 String selectorCategory) {
3531 Intent intent = new Intent(ACTION_MAIN);
3532 intent.addCategory(CATEGORY_LAUNCHER);
3533 Intent selector = new Intent();
3534 selector.setAction(selectorAction);
3535 selector.addCategory(selectorCategory);
3536 intent.setSelector(selector);
3537 return intent;
3538 }
3539
3540 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003541 * Make an Intent that can be used to re-launch an application's task
3542 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3543 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3544 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3545 *
3546 * @param mainActivity The activity component that is the root of the
3547 * task; this is the activity that has been published in the application's
3548 * manifest as the main launcher icon.
3549 *
3550 * @return Returns a newly created Intent that can be used to relaunch the
3551 * activity's task in its root state.
3552 */
3553 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3554 Intent intent = makeMainActivity(mainActivity);
3555 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3556 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3557 return intent;
3558 }
3559
3560 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003561 * Call {@link #parseUri} with 0 flags.
3562 * @deprecated Use {@link #parseUri} instead.
3563 */
3564 @Deprecated
3565 public static Intent getIntent(String uri) throws URISyntaxException {
3566 return parseUri(uri, 0);
3567 }
Tom Taylord4a47292009-12-21 13:59:18 -08003568
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003569 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003570 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003571 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003572 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003573 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003574 *
3575 * <p>The URI given here must not be relative -- that is, it must include
3576 * the scheme and full path.
3577 *
3578 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003579 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003580 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003581 *
3582 * @return Intent The newly created Intent object.
3583 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003584 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3585 * it bad (as parsed by the Uri class) or the Intent data within the
3586 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003587 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003588 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003589 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003590 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003591 int i = 0;
3592 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003593 // Validate intent scheme for if requested.
3594 if ((flags&URI_INTENT_SCHEME) != 0) {
3595 if (!uri.startsWith("intent:")) {
3596 Intent intent = new Intent(ACTION_VIEW);
3597 try {
3598 intent.setData(Uri.parse(uri));
3599 } catch (IllegalArgumentException e) {
3600 throw new URISyntaxException(uri, e.getMessage());
3601 }
3602 return intent;
3603 }
3604 }
Tom Taylord4a47292009-12-21 13:59:18 -08003605
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003606 // simple case
3607 i = uri.lastIndexOf("#");
3608 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3609
3610 // old format Intent URI
3611 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003612
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 // new format
3614 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003615 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003616
3617 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003618 String data = i >= 0 ? uri.substring(0, i) : null;
3619 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003620 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003621
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003622 // loop over contents of Intent, all name=value;
3623 while (!uri.startsWith("end", i)) {
3624 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003625 if (eq < 0) eq = i-1;
3626 int semi = uri.indexOf(';', i);
3627 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003628
3629 // action
3630 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003631 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003632 }
3633
3634 // categories
3635 else if (uri.startsWith("category=", i)) {
3636 intent.addCategory(value);
3637 }
3638
3639 // type
3640 else if (uri.startsWith("type=", i)) {
3641 intent.mType = value;
3642 }
3643
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003644 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003645 else if (uri.startsWith("launchFlags=", i)) {
3646 intent.mFlags = Integer.decode(value).intValue();
3647 }
3648
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003649 // package
3650 else if (uri.startsWith("package=", i)) {
3651 intent.mPackage = value;
3652 }
3653
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003654 // component
3655 else if (uri.startsWith("component=", i)) {
3656 intent.mComponent = ComponentName.unflattenFromString(value);
3657 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003658
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003659 // scheme
3660 else if (uri.startsWith("scheme=", i)) {
3661 scheme = value;
3662 }
3663
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003664 // source bounds
3665 else if (uri.startsWith("sourceBounds=", i)) {
3666 intent.mSourceBounds = Rect.unflattenFromString(value);
3667 }
3668
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003669 // selector
3670 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3671 intent = new Intent();
3672 }
3673
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003674 // extra
3675 else {
3676 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677 // create Bundle if it doesn't already exist
3678 if (intent.mExtras == null) intent.mExtras = new Bundle();
3679 Bundle b = intent.mExtras;
3680 // add EXTRA
3681 if (uri.startsWith("S.", i)) b.putString(key, value);
3682 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3683 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3684 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3685 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3686 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3687 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3688 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3689 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3690 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3691 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003692
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003693 // move to the next item
3694 i = semi + 1;
3695 }
3696
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003697 if (intent != baseIntent) {
3698 // The Intent had a selector; fix it up.
3699 baseIntent.setSelector(intent);
3700 intent = baseIntent;
3701 }
3702
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003703 if (data != null) {
3704 if (data.startsWith("intent:")) {
3705 data = data.substring(7);
3706 if (scheme != null) {
3707 data = scheme + ':' + data;
3708 }
3709 }
Tom Taylord4a47292009-12-21 13:59:18 -08003710
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003711 if (data.length() > 0) {
3712 try {
3713 intent.mData = Uri.parse(data);
3714 } catch (IllegalArgumentException e) {
3715 throw new URISyntaxException(uri, e.getMessage());
3716 }
3717 }
3718 }
Tom Taylord4a47292009-12-21 13:59:18 -08003719
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003720 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003721
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003722 } catch (IndexOutOfBoundsException e) {
3723 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3724 }
3725 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003726
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003727 public static Intent getIntentOld(String uri) throws URISyntaxException {
3728 Intent intent;
3729
3730 int i = uri.lastIndexOf('#');
3731 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003732 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003733 final int intentFragmentStart = i;
3734 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003735
3736 i++;
3737
3738 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003739 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003740 i += 7;
3741 int j = uri.indexOf(')', i);
3742 action = uri.substring(i, j);
3743 i = j + 1;
3744 }
3745
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003746 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003747
3748 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003749 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003750 i += 11;
3751 int j = uri.indexOf(')', i);
3752 while (i < j) {
3753 int sep = uri.indexOf('!', i);
3754 if (sep < 0) sep = j;
3755 if (i < sep) {
3756 intent.addCategory(uri.substring(i, sep));
3757 }
3758 i = sep + 1;
3759 }
3760 i = j + 1;
3761 }
3762
3763 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003764 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003765 i += 5;
3766 int j = uri.indexOf(')', i);
3767 intent.mType = uri.substring(i, j);
3768 i = j + 1;
3769 }
3770
3771 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003772 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003773 i += 12;
3774 int j = uri.indexOf(')', i);
3775 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3776 i = j + 1;
3777 }
3778
3779 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003780 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003781 i += 10;
3782 int j = uri.indexOf(')', i);
3783 int sep = uri.indexOf('!', i);
3784 if (sep >= 0 && sep < j) {
3785 String pkg = uri.substring(i, sep);
3786 String cls = uri.substring(sep + 1, j);
3787 intent.mComponent = new ComponentName(pkg, cls);
3788 }
3789 i = j + 1;
3790 }
3791
3792 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003793 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003794 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003795
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003796 final int closeParen = uri.indexOf(')', i);
3797 if (closeParen == -1) throw new URISyntaxException(uri,
3798 "EXTRA missing trailing ')'", i);
3799
3800 while (i < closeParen) {
3801 // fetch the key value
3802 int j = uri.indexOf('=', i);
3803 if (j <= i + 1 || i >= closeParen) {
3804 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3805 }
3806 char type = uri.charAt(i);
3807 i++;
3808 String key = uri.substring(i, j);
3809 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003810
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003811 // get type-value
3812 j = uri.indexOf('!', i);
3813 if (j == -1 || j >= closeParen) j = closeParen;
3814 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3815 String value = uri.substring(i, j);
3816 i = j;
3817
3818 // create Bundle if it doesn't already exist
3819 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003820
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003821 // add item to bundle
3822 try {
3823 switch (type) {
3824 case 'S':
3825 intent.mExtras.putString(key, Uri.decode(value));
3826 break;
3827 case 'B':
3828 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3829 break;
3830 case 'b':
3831 intent.mExtras.putByte(key, Byte.parseByte(value));
3832 break;
3833 case 'c':
3834 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3835 break;
3836 case 'd':
3837 intent.mExtras.putDouble(key, Double.parseDouble(value));
3838 break;
3839 case 'f':
3840 intent.mExtras.putFloat(key, Float.parseFloat(value));
3841 break;
3842 case 'i':
3843 intent.mExtras.putInt(key, Integer.parseInt(value));
3844 break;
3845 case 'l':
3846 intent.mExtras.putLong(key, Long.parseLong(value));
3847 break;
3848 case 's':
3849 intent.mExtras.putShort(key, Short.parseShort(value));
3850 break;
3851 default:
3852 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3853 }
3854 } catch (NumberFormatException e) {
3855 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3856 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003857
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003858 char ch = uri.charAt(i);
3859 if (ch == ')') break;
3860 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3861 i++;
3862 }
3863 }
3864
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003865 if (isIntentFragment) {
3866 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3867 } else {
3868 intent.mData = Uri.parse(uri);
3869 }
Tom Taylord4a47292009-12-21 13:59:18 -08003870
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003871 if (intent.mAction == null) {
3872 // By default, if no action is specified, then use VIEW.
3873 intent.mAction = ACTION_VIEW;
3874 }
3875
3876 } else {
3877 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3878 }
3879
3880 return intent;
3881 }
3882
3883 /**
3884 * Retrieve the general action to be performed, such as
3885 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3886 * the information in the intent should be interpreted -- most importantly,
3887 * what to do with the data returned by {@link #getData}.
3888 *
3889 * @return The action of this intent or null if none is specified.
3890 *
3891 * @see #setAction
3892 */
3893 public String getAction() {
3894 return mAction;
3895 }
3896
3897 /**
3898 * Retrieve data this intent is operating on. This URI specifies the name
3899 * of the data; often it uses the content: scheme, specifying data in a
3900 * content provider. Other schemes may be handled by specific activities,
3901 * such as http: by the web browser.
3902 *
3903 * @return The URI of the data this intent is targeting or null.
3904 *
3905 * @see #getScheme
3906 * @see #setData
3907 */
3908 public Uri getData() {
3909 return mData;
3910 }
3911
3912 /**
3913 * The same as {@link #getData()}, but returns the URI as an encoded
3914 * String.
3915 */
3916 public String getDataString() {
3917 return mData != null ? mData.toString() : null;
3918 }
3919
3920 /**
3921 * Return the scheme portion of the intent's data. If the data is null or
3922 * does not include a scheme, null is returned. Otherwise, the scheme
3923 * prefix without the final ':' is returned, i.e. "http".
3924 *
3925 * <p>This is the same as calling getData().getScheme() (and checking for
3926 * null data).
3927 *
3928 * @return The scheme of this intent.
3929 *
3930 * @see #getData
3931 */
3932 public String getScheme() {
3933 return mData != null ? mData.getScheme() : null;
3934 }
3935
3936 /**
3937 * Retrieve any explicit MIME type included in the intent. This is usually
3938 * null, as the type is determined by the intent data.
3939 *
3940 * @return If a type was manually set, it is returned; else null is
3941 * returned.
3942 *
3943 * @see #resolveType(ContentResolver)
3944 * @see #setType
3945 */
3946 public String getType() {
3947 return mType;
3948 }
3949
3950 /**
3951 * Return the MIME data type of this intent. If the type field is
3952 * explicitly set, that is simply returned. Otherwise, if the data is set,
3953 * the type of that data is returned. If neither fields are set, a null is
3954 * returned.
3955 *
3956 * @return The MIME type of this intent.
3957 *
3958 * @see #getType
3959 * @see #resolveType(ContentResolver)
3960 */
3961 public String resolveType(Context context) {
3962 return resolveType(context.getContentResolver());
3963 }
3964
3965 /**
3966 * Return the MIME data type of this intent. If the type field is
3967 * explicitly set, that is simply returned. Otherwise, if the data is set,
3968 * the type of that data is returned. If neither fields are set, a null is
3969 * returned.
3970 *
3971 * @param resolver A ContentResolver that can be used to determine the MIME
3972 * type of the intent's data.
3973 *
3974 * @return The MIME type of this intent.
3975 *
3976 * @see #getType
3977 * @see #resolveType(Context)
3978 */
3979 public String resolveType(ContentResolver resolver) {
3980 if (mType != null) {
3981 return mType;
3982 }
3983 if (mData != null) {
3984 if ("content".equals(mData.getScheme())) {
3985 return resolver.getType(mData);
3986 }
3987 }
3988 return null;
3989 }
3990
3991 /**
3992 * Return the MIME data type of this intent, only if it will be needed for
3993 * intent resolution. This is not generally useful for application code;
3994 * it is used by the frameworks for communicating with back-end system
3995 * services.
3996 *
3997 * @param resolver A ContentResolver that can be used to determine the MIME
3998 * type of the intent's data.
3999 *
4000 * @return The MIME type of this intent, or null if it is unknown or not
4001 * needed.
4002 */
4003 public String resolveTypeIfNeeded(ContentResolver resolver) {
4004 if (mComponent != null) {
4005 return mType;
4006 }
4007 return resolveType(resolver);
4008 }
4009
4010 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004011 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004012 *
4013 * @param category The category to check.
4014 *
4015 * @return boolean True if the intent contains the category, else false.
4016 *
4017 * @see #getCategories
4018 * @see #addCategory
4019 */
4020 public boolean hasCategory(String category) {
4021 return mCategories != null && mCategories.contains(category);
4022 }
4023
4024 /**
4025 * Return the set of all categories in the intent. If there are no categories,
4026 * returns NULL.
4027 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004028 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004029 *
4030 * @see #hasCategory
4031 * @see #addCategory
4032 */
4033 public Set<String> getCategories() {
4034 return mCategories;
4035 }
4036
4037 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004038 * Return the specific selector associated with this Intent. If there is
4039 * none, returns null. See {@link #setSelector} for more information.
4040 *
4041 * @see #setSelector
4042 */
4043 public Intent getSelector() {
4044 return mSelector;
4045 }
4046
4047 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004048 * Return the {@link ClipData} associated with this Intent. If there is
4049 * none, returns null. See {@link #setClipData} for more information.
4050 *
4051 * @see #setClipData;
4052 */
4053 public ClipData getClipData() {
4054 return mClipData;
4055 }
4056
4057 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004058 * Sets the ClassLoader that will be used when unmarshalling
4059 * any Parcelable values from the extras of this Intent.
4060 *
4061 * @param loader a ClassLoader, or null to use the default loader
4062 * at the time of unmarshalling.
4063 */
4064 public void setExtrasClassLoader(ClassLoader loader) {
4065 if (mExtras != null) {
4066 mExtras.setClassLoader(loader);
4067 }
4068 }
4069
4070 /**
4071 * Returns true if an extra value is associated with the given name.
4072 * @param name the extra's name
4073 * @return true if the given extra is present.
4074 */
4075 public boolean hasExtra(String name) {
4076 return mExtras != null && mExtras.containsKey(name);
4077 }
4078
4079 /**
4080 * Returns true if the Intent's extras contain a parcelled file descriptor.
4081 * @return true if the Intent contains a parcelled file descriptor.
4082 */
4083 public boolean hasFileDescriptors() {
4084 return mExtras != null && mExtras.hasFileDescriptors();
4085 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004086
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004087 /** @hide */
4088 public void setAllowFds(boolean allowFds) {
4089 if (mExtras != null) {
4090 mExtras.setAllowFds(allowFds);
4091 }
4092 }
4093
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004094 /**
4095 * Retrieve extended data from the intent.
4096 *
4097 * @param name The name of the desired item.
4098 *
4099 * @return the value of an item that previously added with putExtra()
4100 * or null if none was found.
4101 *
4102 * @deprecated
4103 * @hide
4104 */
4105 @Deprecated
4106 public Object getExtra(String name) {
4107 return getExtra(name, null);
4108 }
4109
4110 /**
4111 * Retrieve extended data from the intent.
4112 *
4113 * @param name The name of the desired item.
4114 * @param defaultValue the value to be returned if no value of the desired
4115 * type is stored with the given name.
4116 *
4117 * @return the value of an item that previously added with putExtra()
4118 * or the default value if none was found.
4119 *
4120 * @see #putExtra(String, boolean)
4121 */
4122 public boolean getBooleanExtra(String name, boolean defaultValue) {
4123 return mExtras == null ? defaultValue :
4124 mExtras.getBoolean(name, defaultValue);
4125 }
4126
4127 /**
4128 * Retrieve extended data from the intent.
4129 *
4130 * @param name The name of the desired item.
4131 * @param defaultValue the value to be returned if no value of the desired
4132 * type is stored with the given name.
4133 *
4134 * @return the value of an item that previously added with putExtra()
4135 * or the default value if none was found.
4136 *
4137 * @see #putExtra(String, byte)
4138 */
4139 public byte getByteExtra(String name, byte defaultValue) {
4140 return mExtras == null ? defaultValue :
4141 mExtras.getByte(name, defaultValue);
4142 }
4143
4144 /**
4145 * Retrieve extended data from the intent.
4146 *
4147 * @param name The name of the desired item.
4148 * @param defaultValue the value to be returned if no value of the desired
4149 * type is stored with the given name.
4150 *
4151 * @return the value of an item that previously added with putExtra()
4152 * or the default value if none was found.
4153 *
4154 * @see #putExtra(String, short)
4155 */
4156 public short getShortExtra(String name, short defaultValue) {
4157 return mExtras == null ? defaultValue :
4158 mExtras.getShort(name, defaultValue);
4159 }
4160
4161 /**
4162 * Retrieve extended data from the intent.
4163 *
4164 * @param name The name of the desired item.
4165 * @param defaultValue the value to be returned if no value of the desired
4166 * type is stored with the given name.
4167 *
4168 * @return the value of an item that previously added with putExtra()
4169 * or the default value if none was found.
4170 *
4171 * @see #putExtra(String, char)
4172 */
4173 public char getCharExtra(String name, char defaultValue) {
4174 return mExtras == null ? defaultValue :
4175 mExtras.getChar(name, defaultValue);
4176 }
4177
4178 /**
4179 * Retrieve extended data from the intent.
4180 *
4181 * @param name The name of the desired item.
4182 * @param defaultValue the value to be returned if no value of the desired
4183 * type is stored with the given name.
4184 *
4185 * @return the value of an item that previously added with putExtra()
4186 * or the default value if none was found.
4187 *
4188 * @see #putExtra(String, int)
4189 */
4190 public int getIntExtra(String name, int defaultValue) {
4191 return mExtras == null ? defaultValue :
4192 mExtras.getInt(name, defaultValue);
4193 }
4194
4195 /**
4196 * Retrieve extended data from the intent.
4197 *
4198 * @param name The name of the desired item.
4199 * @param defaultValue the value to be returned if no value of the desired
4200 * type is stored with the given name.
4201 *
4202 * @return the value of an item that previously added with putExtra()
4203 * or the default value if none was found.
4204 *
4205 * @see #putExtra(String, long)
4206 */
4207 public long getLongExtra(String name, long defaultValue) {
4208 return mExtras == null ? defaultValue :
4209 mExtras.getLong(name, defaultValue);
4210 }
4211
4212 /**
4213 * Retrieve extended data from the intent.
4214 *
4215 * @param name The name of the desired item.
4216 * @param defaultValue the value to be returned if no value of the desired
4217 * type is stored with the given name.
4218 *
4219 * @return the value of an item that previously added with putExtra(),
4220 * or the default value if no such item is present
4221 *
4222 * @see #putExtra(String, float)
4223 */
4224 public float getFloatExtra(String name, float defaultValue) {
4225 return mExtras == null ? defaultValue :
4226 mExtras.getFloat(name, defaultValue);
4227 }
4228
4229 /**
4230 * Retrieve extended data from the intent.
4231 *
4232 * @param name The name of the desired item.
4233 * @param defaultValue the value to be returned if no value of the desired
4234 * type is stored with the given name.
4235 *
4236 * @return the value of an item that previously added with putExtra()
4237 * or the default value if none was found.
4238 *
4239 * @see #putExtra(String, double)
4240 */
4241 public double getDoubleExtra(String name, double defaultValue) {
4242 return mExtras == null ? defaultValue :
4243 mExtras.getDouble(name, defaultValue);
4244 }
4245
4246 /**
4247 * Retrieve extended data from the intent.
4248 *
4249 * @param name The name of the desired item.
4250 *
4251 * @return the value of an item that previously added with putExtra()
4252 * or null if no String value was found.
4253 *
4254 * @see #putExtra(String, String)
4255 */
4256 public String getStringExtra(String name) {
4257 return mExtras == null ? null : mExtras.getString(name);
4258 }
4259
4260 /**
4261 * Retrieve extended data from the intent.
4262 *
4263 * @param name The name of the desired item.
4264 *
4265 * @return the value of an item that previously added with putExtra()
4266 * or null if no CharSequence value was found.
4267 *
4268 * @see #putExtra(String, CharSequence)
4269 */
4270 public CharSequence getCharSequenceExtra(String name) {
4271 return mExtras == null ? null : mExtras.getCharSequence(name);
4272 }
4273
4274 /**
4275 * Retrieve extended data from the intent.
4276 *
4277 * @param name The name of the desired item.
4278 *
4279 * @return the value of an item that previously added with putExtra()
4280 * or null if no Parcelable value was found.
4281 *
4282 * @see #putExtra(String, Parcelable)
4283 */
4284 public <T extends Parcelable> T getParcelableExtra(String name) {
4285 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4286 }
4287
4288 /**
4289 * Retrieve extended data from the intent.
4290 *
4291 * @param name The name of the desired item.
4292 *
4293 * @return the value of an item that previously added with putExtra()
4294 * or null if no Parcelable[] value was found.
4295 *
4296 * @see #putExtra(String, Parcelable[])
4297 */
4298 public Parcelable[] getParcelableArrayExtra(String name) {
4299 return mExtras == null ? null : mExtras.getParcelableArray(name);
4300 }
4301
4302 /**
4303 * Retrieve extended data from the intent.
4304 *
4305 * @param name The name of the desired item.
4306 *
4307 * @return the value of an item that previously added with putExtra()
4308 * or null if no ArrayList<Parcelable> value was found.
4309 *
4310 * @see #putParcelableArrayListExtra(String, ArrayList)
4311 */
4312 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4313 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4314 }
4315
4316 /**
4317 * Retrieve extended data from the intent.
4318 *
4319 * @param name The name of the desired item.
4320 *
4321 * @return the value of an item that previously added with putExtra()
4322 * or null if no Serializable value was found.
4323 *
4324 * @see #putExtra(String, Serializable)
4325 */
4326 public Serializable getSerializableExtra(String name) {
4327 return mExtras == null ? null : mExtras.getSerializable(name);
4328 }
4329
4330 /**
4331 * Retrieve extended data from the intent.
4332 *
4333 * @param name The name of the desired item.
4334 *
4335 * @return the value of an item that previously added with putExtra()
4336 * or null if no ArrayList<Integer> value was found.
4337 *
4338 * @see #putIntegerArrayListExtra(String, ArrayList)
4339 */
4340 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4341 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4342 }
4343
4344 /**
4345 * Retrieve extended data from the intent.
4346 *
4347 * @param name The name of the desired item.
4348 *
4349 * @return the value of an item that previously added with putExtra()
4350 * or null if no ArrayList<String> value was found.
4351 *
4352 * @see #putStringArrayListExtra(String, ArrayList)
4353 */
4354 public ArrayList<String> getStringArrayListExtra(String name) {
4355 return mExtras == null ? null : mExtras.getStringArrayList(name);
4356 }
4357
4358 /**
4359 * Retrieve extended data from the intent.
4360 *
4361 * @param name The name of the desired item.
4362 *
4363 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004364 * or null if no ArrayList<CharSequence> value was found.
4365 *
4366 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4367 */
4368 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4369 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4370 }
4371
4372 /**
4373 * Retrieve extended data from the intent.
4374 *
4375 * @param name The name of the desired item.
4376 *
4377 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004378 * or null if no boolean array value was found.
4379 *
4380 * @see #putExtra(String, boolean[])
4381 */
4382 public boolean[] getBooleanArrayExtra(String name) {
4383 return mExtras == null ? null : mExtras.getBooleanArray(name);
4384 }
4385
4386 /**
4387 * Retrieve extended data from the intent.
4388 *
4389 * @param name The name of the desired item.
4390 *
4391 * @return the value of an item that previously added with putExtra()
4392 * or null if no byte array value was found.
4393 *
4394 * @see #putExtra(String, byte[])
4395 */
4396 public byte[] getByteArrayExtra(String name) {
4397 return mExtras == null ? null : mExtras.getByteArray(name);
4398 }
4399
4400 /**
4401 * Retrieve extended data from the intent.
4402 *
4403 * @param name The name of the desired item.
4404 *
4405 * @return the value of an item that previously added with putExtra()
4406 * or null if no short array value was found.
4407 *
4408 * @see #putExtra(String, short[])
4409 */
4410 public short[] getShortArrayExtra(String name) {
4411 return mExtras == null ? null : mExtras.getShortArray(name);
4412 }
4413
4414 /**
4415 * Retrieve extended data from the intent.
4416 *
4417 * @param name The name of the desired item.
4418 *
4419 * @return the value of an item that previously added with putExtra()
4420 * or null if no char array value was found.
4421 *
4422 * @see #putExtra(String, char[])
4423 */
4424 public char[] getCharArrayExtra(String name) {
4425 return mExtras == null ? null : mExtras.getCharArray(name);
4426 }
4427
4428 /**
4429 * Retrieve extended data from the intent.
4430 *
4431 * @param name The name of the desired item.
4432 *
4433 * @return the value of an item that previously added with putExtra()
4434 * or null if no int array value was found.
4435 *
4436 * @see #putExtra(String, int[])
4437 */
4438 public int[] getIntArrayExtra(String name) {
4439 return mExtras == null ? null : mExtras.getIntArray(name);
4440 }
4441
4442 /**
4443 * Retrieve extended data from the intent.
4444 *
4445 * @param name The name of the desired item.
4446 *
4447 * @return the value of an item that previously added with putExtra()
4448 * or null if no long array value was found.
4449 *
4450 * @see #putExtra(String, long[])
4451 */
4452 public long[] getLongArrayExtra(String name) {
4453 return mExtras == null ? null : mExtras.getLongArray(name);
4454 }
4455
4456 /**
4457 * Retrieve extended data from the intent.
4458 *
4459 * @param name The name of the desired item.
4460 *
4461 * @return the value of an item that previously added with putExtra()
4462 * or null if no float array value was found.
4463 *
4464 * @see #putExtra(String, float[])
4465 */
4466 public float[] getFloatArrayExtra(String name) {
4467 return mExtras == null ? null : mExtras.getFloatArray(name);
4468 }
4469
4470 /**
4471 * Retrieve extended data from the intent.
4472 *
4473 * @param name The name of the desired item.
4474 *
4475 * @return the value of an item that previously added with putExtra()
4476 * or null if no double array value was found.
4477 *
4478 * @see #putExtra(String, double[])
4479 */
4480 public double[] getDoubleArrayExtra(String name) {
4481 return mExtras == null ? null : mExtras.getDoubleArray(name);
4482 }
4483
4484 /**
4485 * Retrieve extended data from the intent.
4486 *
4487 * @param name The name of the desired item.
4488 *
4489 * @return the value of an item that previously added with putExtra()
4490 * or null if no String array value was found.
4491 *
4492 * @see #putExtra(String, String[])
4493 */
4494 public String[] getStringArrayExtra(String name) {
4495 return mExtras == null ? null : mExtras.getStringArray(name);
4496 }
4497
4498 /**
4499 * Retrieve extended data from the intent.
4500 *
4501 * @param name The name of the desired item.
4502 *
4503 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004504 * or null if no CharSequence array value was found.
4505 *
4506 * @see #putExtra(String, CharSequence[])
4507 */
4508 public CharSequence[] getCharSequenceArrayExtra(String name) {
4509 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4510 }
4511
4512 /**
4513 * Retrieve extended data from the intent.
4514 *
4515 * @param name The name of the desired item.
4516 *
4517 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004518 * or null if no Bundle value was found.
4519 *
4520 * @see #putExtra(String, Bundle)
4521 */
4522 public Bundle getBundleExtra(String name) {
4523 return mExtras == null ? null : mExtras.getBundle(name);
4524 }
4525
4526 /**
4527 * Retrieve extended data from the intent.
4528 *
4529 * @param name The name of the desired item.
4530 *
4531 * @return the value of an item that previously added with putExtra()
4532 * or null if no IBinder value was found.
4533 *
4534 * @see #putExtra(String, IBinder)
4535 *
4536 * @deprecated
4537 * @hide
4538 */
4539 @Deprecated
4540 public IBinder getIBinderExtra(String name) {
4541 return mExtras == null ? null : mExtras.getIBinder(name);
4542 }
4543
4544 /**
4545 * Retrieve extended data from the intent.
4546 *
4547 * @param name The name of the desired item.
4548 * @param defaultValue The default value to return in case no item is
4549 * associated with the key 'name'
4550 *
4551 * @return the value of an item that previously added with putExtra()
4552 * or defaultValue if none was found.
4553 *
4554 * @see #putExtra
4555 *
4556 * @deprecated
4557 * @hide
4558 */
4559 @Deprecated
4560 public Object getExtra(String name, Object defaultValue) {
4561 Object result = defaultValue;
4562 if (mExtras != null) {
4563 Object result2 = mExtras.get(name);
4564 if (result2 != null) {
4565 result = result2;
4566 }
4567 }
4568
4569 return result;
4570 }
4571
4572 /**
4573 * Retrieves a map of extended data from the intent.
4574 *
4575 * @return the map of all extras previously added with putExtra(),
4576 * or null if none have been added.
4577 */
4578 public Bundle getExtras() {
4579 return (mExtras != null)
4580 ? new Bundle(mExtras)
4581 : null;
4582 }
4583
4584 /**
4585 * Retrieve any special flags associated with this intent. You will
4586 * normally just set them with {@link #setFlags} and let the system
4587 * take the appropriate action with them.
4588 *
4589 * @return int The currently set flags.
4590 *
4591 * @see #setFlags
4592 */
4593 public int getFlags() {
4594 return mFlags;
4595 }
4596
Dianne Hackborne7f97212011-02-24 14:40:20 -08004597 /** @hide */
4598 public boolean isExcludingStopped() {
4599 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4600 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4601 }
4602
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004603 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004604 * Retrieve the application package name this Intent is limited to. When
4605 * resolving an Intent, if non-null this limits the resolution to only
4606 * components in the given application package.
4607 *
4608 * @return The name of the application package for the Intent.
4609 *
4610 * @see #resolveActivity
4611 * @see #setPackage
4612 */
4613 public String getPackage() {
4614 return mPackage;
4615 }
4616
4617 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004618 * Retrieve the concrete component associated with the intent. When receiving
4619 * an intent, this is the component that was found to best handle it (that is,
4620 * yourself) and will always be non-null; in all other cases it will be
4621 * null unless explicitly set.
4622 *
4623 * @return The name of the application component to handle the intent.
4624 *
4625 * @see #resolveActivity
4626 * @see #setComponent
4627 */
4628 public ComponentName getComponent() {
4629 return mComponent;
4630 }
4631
4632 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004633 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4634 * used as a hint to the receiver for animations and the like. Null means that there
4635 * is no source bounds.
4636 */
4637 public Rect getSourceBounds() {
4638 return mSourceBounds;
4639 }
4640
4641 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004642 * Return the Activity component that should be used to handle this intent.
4643 * The appropriate component is determined based on the information in the
4644 * intent, evaluated as follows:
4645 *
4646 * <p>If {@link #getComponent} returns an explicit class, that is returned
4647 * without any further consideration.
4648 *
4649 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4650 * category to be considered.
4651 *
4652 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4653 * action.
4654 *
4655 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4656 * this type.
4657 *
4658 * <p>If {@link #addCategory} has added any categories, the activity must
4659 * handle ALL of the categories specified.
4660 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004661 * <p>If {@link #getPackage} is non-NULL, only activity components in
4662 * that application package will be considered.
4663 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004664 * <p>If there are no activities that satisfy all of these conditions, a
4665 * null string is returned.
4666 *
4667 * <p>If multiple activities are found to satisfy the intent, the one with
4668 * the highest priority will be used. If there are multiple activities
4669 * with the same priority, the system will either pick the best activity
4670 * based on user preference, or resolve to a system class that will allow
4671 * the user to pick an activity and forward from there.
4672 *
4673 * <p>This method is implemented simply by calling
4674 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4675 * true.</p>
4676 * <p> This API is called for you as part of starting an activity from an
4677 * intent. You do not normally need to call it yourself.</p>
4678 *
4679 * @param pm The package manager with which to resolve the Intent.
4680 *
4681 * @return Name of the component implementing an activity that can
4682 * display the intent.
4683 *
4684 * @see #setComponent
4685 * @see #getComponent
4686 * @see #resolveActivityInfo
4687 */
4688 public ComponentName resolveActivity(PackageManager pm) {
4689 if (mComponent != null) {
4690 return mComponent;
4691 }
4692
4693 ResolveInfo info = pm.resolveActivity(
4694 this, PackageManager.MATCH_DEFAULT_ONLY);
4695 if (info != null) {
4696 return new ComponentName(
4697 info.activityInfo.applicationInfo.packageName,
4698 info.activityInfo.name);
4699 }
4700
4701 return null;
4702 }
4703
4704 /**
4705 * Resolve the Intent into an {@link ActivityInfo}
4706 * describing the activity that should execute the intent. Resolution
4707 * follows the same rules as described for {@link #resolveActivity}, but
4708 * you get back the completely information about the resolved activity
4709 * instead of just its class name.
4710 *
4711 * @param pm The package manager with which to resolve the Intent.
4712 * @param flags Addition information to retrieve as per
4713 * {@link PackageManager#getActivityInfo(ComponentName, int)
4714 * PackageManager.getActivityInfo()}.
4715 *
4716 * @return PackageManager.ActivityInfo
4717 *
4718 * @see #resolveActivity
4719 */
4720 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4721 ActivityInfo ai = null;
4722 if (mComponent != null) {
4723 try {
4724 ai = pm.getActivityInfo(mComponent, flags);
4725 } catch (PackageManager.NameNotFoundException e) {
4726 // ignore
4727 }
4728 } else {
4729 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004730 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004731 if (info != null) {
4732 ai = info.activityInfo;
4733 }
4734 }
4735
4736 return ai;
4737 }
4738
4739 /**
4740 * Set the general action to be performed.
4741 *
4742 * @param action An action name, such as ACTION_VIEW. Application-specific
4743 * actions should be prefixed with the vendor's package name.
4744 *
4745 * @return Returns the same Intent object, for chaining multiple calls
4746 * into a single statement.
4747 *
4748 * @see #getAction
4749 */
4750 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004751 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004752 return this;
4753 }
4754
4755 /**
4756 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004757 * clears any type that was previously set by {@link #setType} or
4758 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004759 *
Nick Pellyccae4122012-01-09 14:12:58 -08004760 * <p><em>Note: scheme matching in the Android framework is
4761 * case-sensitive, unlike the formal RFC. As a result,
4762 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004763 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004764 * {@link #setDataAndNormalize}
4765 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004766 *
Nick Pellyccae4122012-01-09 14:12:58 -08004767 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004768 *
4769 * @return Returns the same Intent object, for chaining multiple calls
4770 * into a single statement.
4771 *
4772 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004773 * @see #setDataAndNormalize
4774 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004775 */
4776 public Intent setData(Uri data) {
4777 mData = data;
4778 mType = null;
4779 return this;
4780 }
4781
4782 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004783 * Normalize and set the data this intent is operating on.
4784 *
4785 * <p>This method automatically clears any type that was
4786 * previously set (for example, by {@link #setType}).
4787 *
4788 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004789 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004790 * so really this is just a convenience method for
4791 * <pre>
4792 * setData(data.normalize())
4793 * </pre>
4794 *
4795 * @param data The Uri of the data this intent is now targeting.
4796 *
4797 * @return Returns the same Intent object, for chaining multiple calls
4798 * into a single statement.
4799 *
4800 * @see #getData
4801 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004802 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004803 */
4804 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004805 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004806 }
4807
4808 /**
4809 * Set an explicit MIME data type.
4810 *
4811 * <p>This is used to create intents that only specify a type and not data,
4812 * for example to indicate the type of data to return.
4813 *
4814 * <p>This method automatically clears any data that was
4815 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004816 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004817 * <p><em>Note: MIME type matching in the Android framework is
4818 * case-sensitive, unlike formal RFC MIME types. As a result,
4819 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004820 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4821 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004822 *
4823 * @param type The MIME type of the data being handled by this intent.
4824 *
4825 * @return Returns the same Intent object, for chaining multiple calls
4826 * into a single statement.
4827 *
4828 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004829 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004830 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004831 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004832 */
4833 public Intent setType(String type) {
4834 mData = null;
4835 mType = type;
4836 return this;
4837 }
4838
4839 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004840 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004841 *
Nick Pellyccae4122012-01-09 14:12:58 -08004842 * <p>This is used to create intents that only specify a type and not data,
4843 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004844 *
Nick Pellyccae4122012-01-09 14:12:58 -08004845 * <p>This method automatically clears any data that was
4846 * previously set (for example by {@link #setData}).
4847 *
4848 * <p>The MIME type is normalized using
4849 * {@link #normalizeMimeType} before it is set,
4850 * so really this is just a convenience method for
4851 * <pre>
4852 * setType(Intent.normalizeMimeType(type))
4853 * </pre>
4854 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004855 * @param type The MIME type of the data being handled by this intent.
4856 *
4857 * @return Returns the same Intent object, for chaining multiple calls
4858 * into a single statement.
4859 *
Nick Pellyccae4122012-01-09 14:12:58 -08004860 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004861 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004862 * @see #normalizeMimeType
4863 */
4864 public Intent setTypeAndNormalize(String type) {
4865 return setType(normalizeMimeType(type));
4866 }
4867
4868 /**
4869 * (Usually optional) Set the data for the intent along with an explicit
4870 * MIME data type. This method should very rarely be used -- it allows you
4871 * to override the MIME type that would ordinarily be inferred from the
4872 * data with your own type given here.
4873 *
4874 * <p><em>Note: MIME type and Uri scheme matching in the
4875 * Android framework is case-sensitive, unlike the formal RFC definitions.
4876 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004877 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004878 * {@link #setDataAndTypeAndNormalize}
4879 * to ensure that they are converted to lower case.</em>
4880 *
4881 * @param data The Uri of the data this intent is now targeting.
4882 * @param type The MIME type of the data being handled by this intent.
4883 *
4884 * @return Returns the same Intent object, for chaining multiple calls
4885 * into a single statement.
4886 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004887 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004888 * @see #setData
4889 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004890 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004891 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004892 */
4893 public Intent setDataAndType(Uri data, String type) {
4894 mData = data;
4895 mType = type;
4896 return this;
4897 }
4898
4899 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004900 * (Usually optional) Normalize and set both the data Uri and an explicit
4901 * MIME data type. This method should very rarely be used -- it allows you
4902 * to override the MIME type that would ordinarily be inferred from the
4903 * data with your own type given here.
4904 *
4905 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004906 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004907 * before they are set, so really this is just a convenience method for
4908 * <pre>
4909 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4910 * </pre>
4911 *
4912 * @param data The Uri of the data this intent is now targeting.
4913 * @param type The MIME type of the data being handled by this intent.
4914 *
4915 * @return Returns the same Intent object, for chaining multiple calls
4916 * into a single statement.
4917 *
4918 * @see #setType
4919 * @see #setData
4920 * @see #setDataAndType
4921 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004922 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004923 */
4924 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004925 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004926 }
4927
4928 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004929 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004930 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004931 * activities that provide <em>all</em> of the requested categories will be
4932 * used.
4933 *
4934 * @param category The desired category. This can be either one of the
4935 * predefined Intent categories, or a custom category in your own
4936 * namespace.
4937 *
4938 * @return Returns the same Intent object, for chaining multiple calls
4939 * into a single statement.
4940 *
4941 * @see #hasCategory
4942 * @see #removeCategory
4943 */
4944 public Intent addCategory(String category) {
4945 if (mCategories == null) {
4946 mCategories = new HashSet<String>();
4947 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004948 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004949 return this;
4950 }
4951
4952 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004953 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004954 *
4955 * @param category The category to remove.
4956 *
4957 * @see #addCategory
4958 */
4959 public void removeCategory(String category) {
4960 if (mCategories != null) {
4961 mCategories.remove(category);
4962 if (mCategories.size() == 0) {
4963 mCategories = null;
4964 }
4965 }
4966 }
4967
4968 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004969 * Set a selector for this Intent. This is a modification to the kinds of
4970 * things the Intent will match. If the selector is set, it will be used
4971 * when trying to find entities that can handle the Intent, instead of the
4972 * main contents of the Intent. This allows you build an Intent containing
4973 * a generic protocol while targeting it more specifically.
4974 *
4975 * <p>An example of where this may be used is with things like
4976 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4977 * Intent that will launch the Browser application. However, the correct
4978 * main entry point of an application is actually {@link #ACTION_MAIN}
4979 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4980 * used to specify the actual Activity to launch. If you launch the browser
4981 * with something different, undesired behavior may happen if the user has
4982 * previously or later launches it the normal way, since they do not match.
4983 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4984 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4985 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4986 *
4987 * <p>Setting a selector does not impact the behavior of
4988 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4989 * desired behavior of a selector -- it does not impact the base meaning
4990 * of the Intent, just what kinds of things will be matched against it
4991 * when determining who can handle it.</p>
4992 *
4993 * <p>You can not use both a selector and {@link #setPackage(String)} on
4994 * the same base Intent.</p>
4995 *
4996 * @param selector The desired selector Intent; set to null to not use
4997 * a special selector.
4998 */
4999 public void setSelector(Intent selector) {
5000 if (selector == this) {
5001 throw new IllegalArgumentException(
5002 "Intent being set as a selector of itself");
5003 }
5004 if (selector != null && mPackage != null) {
5005 throw new IllegalArgumentException(
5006 "Can't set selector when package name is already set");
5007 }
5008 mSelector = selector;
5009 }
5010
5011 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005012 * Set a {@link ClipData} associated with this Intent. This replaces any
5013 * previously set ClipData.
5014 *
5015 * <p>The ClipData in an intent is not used for Intent matching or other
5016 * such operations. Semantically it is like extras, used to transmit
5017 * additional data with the Intent. The main feature of using this over
5018 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5019 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5020 * items included in the clip data. This is useful, in particular, if
5021 * you want to transmit an Intent containing multiple <code>content:</code>
5022 * URIs for which the recipient may not have global permission to access the
5023 * content provider.
5024 *
5025 * <p>If the ClipData contains items that are themselves Intents, any
5026 * grant flags in those Intents will be ignored. Only the top-level flags
5027 * of the main Intent are respected, and will be applied to all Uri or
5028 * Intent items in the clip (or sub-items of the clip).
5029 *
5030 * <p>The MIME type, label, and icon in the ClipData object are not
5031 * directly used by Intent. Applications should generally rely on the
5032 * MIME type of the Intent itself, not what it may find in the ClipData.
5033 * A common practice is to construct a ClipData for use with an Intent
5034 * with a MIME type of "*\/*".
5035 *
5036 * @param clip The new clip to set. May be null to clear the current clip.
5037 */
5038 public void setClipData(ClipData clip) {
5039 mClipData = clip;
5040 }
5041
5042 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005043 * Add extended data to the intent. The name must include a package
5044 * prefix, for example the app com.android.contacts would use names
5045 * like "com.android.contacts.ShowAll".
5046 *
5047 * @param name The name of the extra data, with package prefix.
5048 * @param value The boolean data value.
5049 *
5050 * @return Returns the same Intent object, for chaining multiple calls
5051 * into a single statement.
5052 *
5053 * @see #putExtras
5054 * @see #removeExtra
5055 * @see #getBooleanExtra(String, boolean)
5056 */
5057 public Intent putExtra(String name, boolean value) {
5058 if (mExtras == null) {
5059 mExtras = new Bundle();
5060 }
5061 mExtras.putBoolean(name, value);
5062 return this;
5063 }
5064
5065 /**
5066 * Add extended data to the intent. The name must include a package
5067 * prefix, for example the app com.android.contacts would use names
5068 * like "com.android.contacts.ShowAll".
5069 *
5070 * @param name The name of the extra data, with package prefix.
5071 * @param value The byte data value.
5072 *
5073 * @return Returns the same Intent object, for chaining multiple calls
5074 * into a single statement.
5075 *
5076 * @see #putExtras
5077 * @see #removeExtra
5078 * @see #getByteExtra(String, byte)
5079 */
5080 public Intent putExtra(String name, byte value) {
5081 if (mExtras == null) {
5082 mExtras = new Bundle();
5083 }
5084 mExtras.putByte(name, value);
5085 return this;
5086 }
5087
5088 /**
5089 * Add extended data to the intent. The name must include a package
5090 * prefix, for example the app com.android.contacts would use names
5091 * like "com.android.contacts.ShowAll".
5092 *
5093 * @param name The name of the extra data, with package prefix.
5094 * @param value The char data value.
5095 *
5096 * @return Returns the same Intent object, for chaining multiple calls
5097 * into a single statement.
5098 *
5099 * @see #putExtras
5100 * @see #removeExtra
5101 * @see #getCharExtra(String, char)
5102 */
5103 public Intent putExtra(String name, char value) {
5104 if (mExtras == null) {
5105 mExtras = new Bundle();
5106 }
5107 mExtras.putChar(name, value);
5108 return this;
5109 }
5110
5111 /**
5112 * Add extended data to the intent. The name must include a package
5113 * prefix, for example the app com.android.contacts would use names
5114 * like "com.android.contacts.ShowAll".
5115 *
5116 * @param name The name of the extra data, with package prefix.
5117 * @param value The short data value.
5118 *
5119 * @return Returns the same Intent object, for chaining multiple calls
5120 * into a single statement.
5121 *
5122 * @see #putExtras
5123 * @see #removeExtra
5124 * @see #getShortExtra(String, short)
5125 */
5126 public Intent putExtra(String name, short value) {
5127 if (mExtras == null) {
5128 mExtras = new Bundle();
5129 }
5130 mExtras.putShort(name, value);
5131 return this;
5132 }
5133
5134 /**
5135 * Add extended data to the intent. The name must include a package
5136 * prefix, for example the app com.android.contacts would use names
5137 * like "com.android.contacts.ShowAll".
5138 *
5139 * @param name The name of the extra data, with package prefix.
5140 * @param value The integer data value.
5141 *
5142 * @return Returns the same Intent object, for chaining multiple calls
5143 * into a single statement.
5144 *
5145 * @see #putExtras
5146 * @see #removeExtra
5147 * @see #getIntExtra(String, int)
5148 */
5149 public Intent putExtra(String name, int value) {
5150 if (mExtras == null) {
5151 mExtras = new Bundle();
5152 }
5153 mExtras.putInt(name, value);
5154 return this;
5155 }
5156
5157 /**
5158 * Add extended data to the intent. The name must include a package
5159 * prefix, for example the app com.android.contacts would use names
5160 * like "com.android.contacts.ShowAll".
5161 *
5162 * @param name The name of the extra data, with package prefix.
5163 * @param value The long data value.
5164 *
5165 * @return Returns the same Intent object, for chaining multiple calls
5166 * into a single statement.
5167 *
5168 * @see #putExtras
5169 * @see #removeExtra
5170 * @see #getLongExtra(String, long)
5171 */
5172 public Intent putExtra(String name, long value) {
5173 if (mExtras == null) {
5174 mExtras = new Bundle();
5175 }
5176 mExtras.putLong(name, value);
5177 return this;
5178 }
5179
5180 /**
5181 * Add extended data to the intent. The name must include a package
5182 * prefix, for example the app com.android.contacts would use names
5183 * like "com.android.contacts.ShowAll".
5184 *
5185 * @param name The name of the extra data, with package prefix.
5186 * @param value The float data value.
5187 *
5188 * @return Returns the same Intent object, for chaining multiple calls
5189 * into a single statement.
5190 *
5191 * @see #putExtras
5192 * @see #removeExtra
5193 * @see #getFloatExtra(String, float)
5194 */
5195 public Intent putExtra(String name, float value) {
5196 if (mExtras == null) {
5197 mExtras = new Bundle();
5198 }
5199 mExtras.putFloat(name, value);
5200 return this;
5201 }
5202
5203 /**
5204 * Add extended data to the intent. The name must include a package
5205 * prefix, for example the app com.android.contacts would use names
5206 * like "com.android.contacts.ShowAll".
5207 *
5208 * @param name The name of the extra data, with package prefix.
5209 * @param value The double data value.
5210 *
5211 * @return Returns the same Intent object, for chaining multiple calls
5212 * into a single statement.
5213 *
5214 * @see #putExtras
5215 * @see #removeExtra
5216 * @see #getDoubleExtra(String, double)
5217 */
5218 public Intent putExtra(String name, double value) {
5219 if (mExtras == null) {
5220 mExtras = new Bundle();
5221 }
5222 mExtras.putDouble(name, value);
5223 return this;
5224 }
5225
5226 /**
5227 * Add extended data to the intent. The name must include a package
5228 * prefix, for example the app com.android.contacts would use names
5229 * like "com.android.contacts.ShowAll".
5230 *
5231 * @param name The name of the extra data, with package prefix.
5232 * @param value The String data value.
5233 *
5234 * @return Returns the same Intent object, for chaining multiple calls
5235 * into a single statement.
5236 *
5237 * @see #putExtras
5238 * @see #removeExtra
5239 * @see #getStringExtra(String)
5240 */
5241 public Intent putExtra(String name, String value) {
5242 if (mExtras == null) {
5243 mExtras = new Bundle();
5244 }
5245 mExtras.putString(name, value);
5246 return this;
5247 }
5248
5249 /**
5250 * Add extended data to the intent. The name must include a package
5251 * prefix, for example the app com.android.contacts would use names
5252 * like "com.android.contacts.ShowAll".
5253 *
5254 * @param name The name of the extra data, with package prefix.
5255 * @param value The CharSequence data value.
5256 *
5257 * @return Returns the same Intent object, for chaining multiple calls
5258 * into a single statement.
5259 *
5260 * @see #putExtras
5261 * @see #removeExtra
5262 * @see #getCharSequenceExtra(String)
5263 */
5264 public Intent putExtra(String name, CharSequence value) {
5265 if (mExtras == null) {
5266 mExtras = new Bundle();
5267 }
5268 mExtras.putCharSequence(name, value);
5269 return this;
5270 }
5271
5272 /**
5273 * Add extended data to the intent. The name must include a package
5274 * prefix, for example the app com.android.contacts would use names
5275 * like "com.android.contacts.ShowAll".
5276 *
5277 * @param name The name of the extra data, with package prefix.
5278 * @param value The Parcelable data value.
5279 *
5280 * @return Returns the same Intent object, for chaining multiple calls
5281 * into a single statement.
5282 *
5283 * @see #putExtras
5284 * @see #removeExtra
5285 * @see #getParcelableExtra(String)
5286 */
5287 public Intent putExtra(String name, Parcelable value) {
5288 if (mExtras == null) {
5289 mExtras = new Bundle();
5290 }
5291 mExtras.putParcelable(name, value);
5292 return this;
5293 }
5294
5295 /**
5296 * Add extended data to the intent. The name must include a package
5297 * prefix, for example the app com.android.contacts would use names
5298 * like "com.android.contacts.ShowAll".
5299 *
5300 * @param name The name of the extra data, with package prefix.
5301 * @param value The Parcelable[] data value.
5302 *
5303 * @return Returns the same Intent object, for chaining multiple calls
5304 * into a single statement.
5305 *
5306 * @see #putExtras
5307 * @see #removeExtra
5308 * @see #getParcelableArrayExtra(String)
5309 */
5310 public Intent putExtra(String name, Parcelable[] value) {
5311 if (mExtras == null) {
5312 mExtras = new Bundle();
5313 }
5314 mExtras.putParcelableArray(name, value);
5315 return this;
5316 }
5317
5318 /**
5319 * Add extended data to the intent. The name must include a package
5320 * prefix, for example the app com.android.contacts would use names
5321 * like "com.android.contacts.ShowAll".
5322 *
5323 * @param name The name of the extra data, with package prefix.
5324 * @param value The ArrayList<Parcelable> data value.
5325 *
5326 * @return Returns the same Intent object, for chaining multiple calls
5327 * into a single statement.
5328 *
5329 * @see #putExtras
5330 * @see #removeExtra
5331 * @see #getParcelableArrayListExtra(String)
5332 */
5333 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5334 if (mExtras == null) {
5335 mExtras = new Bundle();
5336 }
5337 mExtras.putParcelableArrayList(name, value);
5338 return this;
5339 }
5340
5341 /**
5342 * Add extended data to the intent. The name must include a package
5343 * prefix, for example the app com.android.contacts would use names
5344 * like "com.android.contacts.ShowAll".
5345 *
5346 * @param name The name of the extra data, with package prefix.
5347 * @param value The ArrayList<Integer> data value.
5348 *
5349 * @return Returns the same Intent object, for chaining multiple calls
5350 * into a single statement.
5351 *
5352 * @see #putExtras
5353 * @see #removeExtra
5354 * @see #getIntegerArrayListExtra(String)
5355 */
5356 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5357 if (mExtras == null) {
5358 mExtras = new Bundle();
5359 }
5360 mExtras.putIntegerArrayList(name, value);
5361 return this;
5362 }
5363
5364 /**
5365 * Add extended data to the intent. The name must include a package
5366 * prefix, for example the app com.android.contacts would use names
5367 * like "com.android.contacts.ShowAll".
5368 *
5369 * @param name The name of the extra data, with package prefix.
5370 * @param value The ArrayList<String> data value.
5371 *
5372 * @return Returns the same Intent object, for chaining multiple calls
5373 * into a single statement.
5374 *
5375 * @see #putExtras
5376 * @see #removeExtra
5377 * @see #getStringArrayListExtra(String)
5378 */
5379 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5380 if (mExtras == null) {
5381 mExtras = new Bundle();
5382 }
5383 mExtras.putStringArrayList(name, value);
5384 return this;
5385 }
5386
5387 /**
5388 * Add extended data to the intent. The name must include a package
5389 * prefix, for example the app com.android.contacts would use names
5390 * like "com.android.contacts.ShowAll".
5391 *
5392 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005393 * @param value The ArrayList<CharSequence> data value.
5394 *
5395 * @return Returns the same Intent object, for chaining multiple calls
5396 * into a single statement.
5397 *
5398 * @see #putExtras
5399 * @see #removeExtra
5400 * @see #getCharSequenceArrayListExtra(String)
5401 */
5402 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5403 if (mExtras == null) {
5404 mExtras = new Bundle();
5405 }
5406 mExtras.putCharSequenceArrayList(name, value);
5407 return this;
5408 }
5409
5410 /**
5411 * Add extended data to the intent. The name must include a package
5412 * prefix, for example the app com.android.contacts would use names
5413 * like "com.android.contacts.ShowAll".
5414 *
5415 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005416 * @param value The Serializable data value.
5417 *
5418 * @return Returns the same Intent object, for chaining multiple calls
5419 * into a single statement.
5420 *
5421 * @see #putExtras
5422 * @see #removeExtra
5423 * @see #getSerializableExtra(String)
5424 */
5425 public Intent putExtra(String name, Serializable value) {
5426 if (mExtras == null) {
5427 mExtras = new Bundle();
5428 }
5429 mExtras.putSerializable(name, value);
5430 return this;
5431 }
5432
5433 /**
5434 * Add extended data to the intent. The name must include a package
5435 * prefix, for example the app com.android.contacts would use names
5436 * like "com.android.contacts.ShowAll".
5437 *
5438 * @param name The name of the extra data, with package prefix.
5439 * @param value The boolean array data value.
5440 *
5441 * @return Returns the same Intent object, for chaining multiple calls
5442 * into a single statement.
5443 *
5444 * @see #putExtras
5445 * @see #removeExtra
5446 * @see #getBooleanArrayExtra(String)
5447 */
5448 public Intent putExtra(String name, boolean[] value) {
5449 if (mExtras == null) {
5450 mExtras = new Bundle();
5451 }
5452 mExtras.putBooleanArray(name, value);
5453 return this;
5454 }
5455
5456 /**
5457 * Add extended data to the intent. The name must include a package
5458 * prefix, for example the app com.android.contacts would use names
5459 * like "com.android.contacts.ShowAll".
5460 *
5461 * @param name The name of the extra data, with package prefix.
5462 * @param value The byte array data value.
5463 *
5464 * @return Returns the same Intent object, for chaining multiple calls
5465 * into a single statement.
5466 *
5467 * @see #putExtras
5468 * @see #removeExtra
5469 * @see #getByteArrayExtra(String)
5470 */
5471 public Intent putExtra(String name, byte[] value) {
5472 if (mExtras == null) {
5473 mExtras = new Bundle();
5474 }
5475 mExtras.putByteArray(name, value);
5476 return this;
5477 }
5478
5479 /**
5480 * Add extended data to the intent. The name must include a package
5481 * prefix, for example the app com.android.contacts would use names
5482 * like "com.android.contacts.ShowAll".
5483 *
5484 * @param name The name of the extra data, with package prefix.
5485 * @param value The short array data value.
5486 *
5487 * @return Returns the same Intent object, for chaining multiple calls
5488 * into a single statement.
5489 *
5490 * @see #putExtras
5491 * @see #removeExtra
5492 * @see #getShortArrayExtra(String)
5493 */
5494 public Intent putExtra(String name, short[] value) {
5495 if (mExtras == null) {
5496 mExtras = new Bundle();
5497 }
5498 mExtras.putShortArray(name, value);
5499 return this;
5500 }
5501
5502 /**
5503 * Add extended data to the intent. The name must include a package
5504 * prefix, for example the app com.android.contacts would use names
5505 * like "com.android.contacts.ShowAll".
5506 *
5507 * @param name The name of the extra data, with package prefix.
5508 * @param value The char array data value.
5509 *
5510 * @return Returns the same Intent object, for chaining multiple calls
5511 * into a single statement.
5512 *
5513 * @see #putExtras
5514 * @see #removeExtra
5515 * @see #getCharArrayExtra(String)
5516 */
5517 public Intent putExtra(String name, char[] value) {
5518 if (mExtras == null) {
5519 mExtras = new Bundle();
5520 }
5521 mExtras.putCharArray(name, value);
5522 return this;
5523 }
5524
5525 /**
5526 * Add extended data to the intent. The name must include a package
5527 * prefix, for example the app com.android.contacts would use names
5528 * like "com.android.contacts.ShowAll".
5529 *
5530 * @param name The name of the extra data, with package prefix.
5531 * @param value The int array data value.
5532 *
5533 * @return Returns the same Intent object, for chaining multiple calls
5534 * into a single statement.
5535 *
5536 * @see #putExtras
5537 * @see #removeExtra
5538 * @see #getIntArrayExtra(String)
5539 */
5540 public Intent putExtra(String name, int[] value) {
5541 if (mExtras == null) {
5542 mExtras = new Bundle();
5543 }
5544 mExtras.putIntArray(name, value);
5545 return this;
5546 }
5547
5548 /**
5549 * Add extended data to the intent. The name must include a package
5550 * prefix, for example the app com.android.contacts would use names
5551 * like "com.android.contacts.ShowAll".
5552 *
5553 * @param name The name of the extra data, with package prefix.
5554 * @param value The byte array data value.
5555 *
5556 * @return Returns the same Intent object, for chaining multiple calls
5557 * into a single statement.
5558 *
5559 * @see #putExtras
5560 * @see #removeExtra
5561 * @see #getLongArrayExtra(String)
5562 */
5563 public Intent putExtra(String name, long[] value) {
5564 if (mExtras == null) {
5565 mExtras = new Bundle();
5566 }
5567 mExtras.putLongArray(name, value);
5568 return this;
5569 }
5570
5571 /**
5572 * Add extended data to the intent. The name must include a package
5573 * prefix, for example the app com.android.contacts would use names
5574 * like "com.android.contacts.ShowAll".
5575 *
5576 * @param name The name of the extra data, with package prefix.
5577 * @param value The float array data value.
5578 *
5579 * @return Returns the same Intent object, for chaining multiple calls
5580 * into a single statement.
5581 *
5582 * @see #putExtras
5583 * @see #removeExtra
5584 * @see #getFloatArrayExtra(String)
5585 */
5586 public Intent putExtra(String name, float[] value) {
5587 if (mExtras == null) {
5588 mExtras = new Bundle();
5589 }
5590 mExtras.putFloatArray(name, value);
5591 return this;
5592 }
5593
5594 /**
5595 * Add extended data to the intent. The name must include a package
5596 * prefix, for example the app com.android.contacts would use names
5597 * like "com.android.contacts.ShowAll".
5598 *
5599 * @param name The name of the extra data, with package prefix.
5600 * @param value The double array data value.
5601 *
5602 * @return Returns the same Intent object, for chaining multiple calls
5603 * into a single statement.
5604 *
5605 * @see #putExtras
5606 * @see #removeExtra
5607 * @see #getDoubleArrayExtra(String)
5608 */
5609 public Intent putExtra(String name, double[] value) {
5610 if (mExtras == null) {
5611 mExtras = new Bundle();
5612 }
5613 mExtras.putDoubleArray(name, value);
5614 return this;
5615 }
5616
5617 /**
5618 * Add extended data to the intent. The name must include a package
5619 * prefix, for example the app com.android.contacts would use names
5620 * like "com.android.contacts.ShowAll".
5621 *
5622 * @param name The name of the extra data, with package prefix.
5623 * @param value The String array data value.
5624 *
5625 * @return Returns the same Intent object, for chaining multiple calls
5626 * into a single statement.
5627 *
5628 * @see #putExtras
5629 * @see #removeExtra
5630 * @see #getStringArrayExtra(String)
5631 */
5632 public Intent putExtra(String name, String[] value) {
5633 if (mExtras == null) {
5634 mExtras = new Bundle();
5635 }
5636 mExtras.putStringArray(name, value);
5637 return this;
5638 }
5639
5640 /**
5641 * Add extended data to the intent. The name must include a package
5642 * prefix, for example the app com.android.contacts would use names
5643 * like "com.android.contacts.ShowAll".
5644 *
5645 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005646 * @param value The CharSequence array data value.
5647 *
5648 * @return Returns the same Intent object, for chaining multiple calls
5649 * into a single statement.
5650 *
5651 * @see #putExtras
5652 * @see #removeExtra
5653 * @see #getCharSequenceArrayExtra(String)
5654 */
5655 public Intent putExtra(String name, CharSequence[] value) {
5656 if (mExtras == null) {
5657 mExtras = new Bundle();
5658 }
5659 mExtras.putCharSequenceArray(name, value);
5660 return this;
5661 }
5662
5663 /**
5664 * Add extended data to the intent. The name must include a package
5665 * prefix, for example the app com.android.contacts would use names
5666 * like "com.android.contacts.ShowAll".
5667 *
5668 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005669 * @param value The Bundle data value.
5670 *
5671 * @return Returns the same Intent object, for chaining multiple calls
5672 * into a single statement.
5673 *
5674 * @see #putExtras
5675 * @see #removeExtra
5676 * @see #getBundleExtra(String)
5677 */
5678 public Intent putExtra(String name, Bundle value) {
5679 if (mExtras == null) {
5680 mExtras = new Bundle();
5681 }
5682 mExtras.putBundle(name, value);
5683 return this;
5684 }
5685
5686 /**
5687 * Add extended data to the intent. The name must include a package
5688 * prefix, for example the app com.android.contacts would use names
5689 * like "com.android.contacts.ShowAll".
5690 *
5691 * @param name The name of the extra data, with package prefix.
5692 * @param value The IBinder data value.
5693 *
5694 * @return Returns the same Intent object, for chaining multiple calls
5695 * into a single statement.
5696 *
5697 * @see #putExtras
5698 * @see #removeExtra
5699 * @see #getIBinderExtra(String)
5700 *
5701 * @deprecated
5702 * @hide
5703 */
5704 @Deprecated
5705 public Intent putExtra(String name, IBinder value) {
5706 if (mExtras == null) {
5707 mExtras = new Bundle();
5708 }
5709 mExtras.putIBinder(name, value);
5710 return this;
5711 }
5712
5713 /**
5714 * Copy all extras in 'src' in to this intent.
5715 *
5716 * @param src Contains the extras to copy.
5717 *
5718 * @see #putExtra
5719 */
5720 public Intent putExtras(Intent src) {
5721 if (src.mExtras != null) {
5722 if (mExtras == null) {
5723 mExtras = new Bundle(src.mExtras);
5724 } else {
5725 mExtras.putAll(src.mExtras);
5726 }
5727 }
5728 return this;
5729 }
5730
5731 /**
5732 * Add a set of extended data to the intent. The keys 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 extras The Bundle of extras to add to this intent.
5737 *
5738 * @see #putExtra
5739 * @see #removeExtra
5740 */
5741 public Intent putExtras(Bundle extras) {
5742 if (mExtras == null) {
5743 mExtras = new Bundle();
5744 }
5745 mExtras.putAll(extras);
5746 return this;
5747 }
5748
5749 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005750 * Completely replace the extras in the Intent with the extras in the
5751 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005752 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005753 * @param src The exact extras contained in this Intent are copied
5754 * into the target intent, replacing any that were previously there.
5755 */
5756 public Intent replaceExtras(Intent src) {
5757 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5758 return this;
5759 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005760
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005761 /**
5762 * Completely replace the extras in the Intent with the given Bundle of
5763 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005764 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005765 * @param extras The new set of extras in the Intent, or null to erase
5766 * all extras.
5767 */
5768 public Intent replaceExtras(Bundle extras) {
5769 mExtras = extras != null ? new Bundle(extras) : null;
5770 return this;
5771 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005772
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005773 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005774 * Remove extended data from the intent.
5775 *
5776 * @see #putExtra
5777 */
5778 public void removeExtra(String name) {
5779 if (mExtras != null) {
5780 mExtras.remove(name);
5781 if (mExtras.size() == 0) {
5782 mExtras = null;
5783 }
5784 }
5785 }
5786
5787 /**
5788 * Set special flags controlling how this intent is handled. Most values
5789 * here depend on the type of component being executed by the Intent,
5790 * specifically the FLAG_ACTIVITY_* flags are all for use with
5791 * {@link Context#startActivity Context.startActivity()} and the
5792 * FLAG_RECEIVER_* flags are all for use with
5793 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5794 *
Scott Main7aee61f2011-02-08 11:25:01 -08005795 * <p>See the
5796 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5797 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005798 * the behavior of your application.
5799 *
5800 * @param flags The desired flags.
5801 *
5802 * @return Returns the same Intent object, for chaining multiple calls
5803 * into a single statement.
5804 *
5805 * @see #getFlags
5806 * @see #addFlags
5807 *
5808 * @see #FLAG_GRANT_READ_URI_PERMISSION
5809 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5810 * @see #FLAG_DEBUG_LOG_RESOLUTION
5811 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005812 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005813 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005814 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005815 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005816 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5817 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005818 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005819 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5820 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005821 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005822 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005823 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005824 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5825 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005826 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005827 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005828 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005829 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5830 */
5831 public Intent setFlags(int flags) {
5832 mFlags = flags;
5833 return this;
5834 }
5835
5836 /**
5837 * Add additional flags to the intent (or with existing flags
5838 * value).
5839 *
5840 * @param flags The new flags to set.
5841 *
5842 * @return Returns the same Intent object, for chaining multiple calls
5843 * into a single statement.
5844 *
5845 * @see #setFlags
5846 */
5847 public Intent addFlags(int flags) {
5848 mFlags |= flags;
5849 return this;
5850 }
5851
5852 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005853 * (Usually optional) Set an explicit application package name that limits
5854 * the components this Intent will resolve to. If left to the default
5855 * value of null, all components in all applications will considered.
5856 * If non-null, the Intent can only match the components in the given
5857 * application package.
5858 *
5859 * @param packageName The name of the application package to handle the
5860 * intent, or null to allow any application package.
5861 *
5862 * @return Returns the same Intent object, for chaining multiple calls
5863 * into a single statement.
5864 *
5865 * @see #getPackage
5866 * @see #resolveActivity
5867 */
5868 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005869 if (packageName != null && mSelector != null) {
5870 throw new IllegalArgumentException(
5871 "Can't set package name when selector is already set");
5872 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005873 mPackage = packageName;
5874 return this;
5875 }
5876
5877 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005878 * (Usually optional) Explicitly set the component to handle the intent.
5879 * If left with the default value of null, the system will determine the
5880 * appropriate class to use based on the other fields (action, data,
5881 * type, categories) in the Intent. If this class is defined, the
5882 * specified class will always be used regardless of the other fields. You
5883 * should only set this value when you know you absolutely want a specific
5884 * class to be used; otherwise it is better to let the system find the
5885 * appropriate class so that you will respect the installed applications
5886 * and user preferences.
5887 *
5888 * @param component The name of the application component to handle the
5889 * intent, or null to let the system find one for you.
5890 *
5891 * @return Returns the same Intent object, for chaining multiple calls
5892 * into a single statement.
5893 *
5894 * @see #setClass
5895 * @see #setClassName(Context, String)
5896 * @see #setClassName(String, String)
5897 * @see #getComponent
5898 * @see #resolveActivity
5899 */
5900 public Intent setComponent(ComponentName component) {
5901 mComponent = component;
5902 return this;
5903 }
5904
5905 /**
5906 * Convenience for calling {@link #setComponent} with an
5907 * explicit class name.
5908 *
5909 * @param packageContext A Context of the application package implementing
5910 * this class.
5911 * @param className The name of a class inside of the application package
5912 * that will be used as the component for this Intent.
5913 *
5914 * @return Returns the same Intent object, for chaining multiple calls
5915 * into a single statement.
5916 *
5917 * @see #setComponent
5918 * @see #setClass
5919 */
5920 public Intent setClassName(Context packageContext, String className) {
5921 mComponent = new ComponentName(packageContext, className);
5922 return this;
5923 }
5924
5925 /**
5926 * Convenience for calling {@link #setComponent} with an
5927 * explicit application package name and class name.
5928 *
5929 * @param packageName The name of the package implementing the desired
5930 * component.
5931 * @param className The name of a class inside of the application package
5932 * that will be used as the component for this Intent.
5933 *
5934 * @return Returns the same Intent object, for chaining multiple calls
5935 * into a single statement.
5936 *
5937 * @see #setComponent
5938 * @see #setClass
5939 */
5940 public Intent setClassName(String packageName, String className) {
5941 mComponent = new ComponentName(packageName, className);
5942 return this;
5943 }
5944
5945 /**
5946 * Convenience for calling {@link #setComponent(ComponentName)} with the
5947 * name returned by a {@link Class} object.
5948 *
5949 * @param packageContext A Context of the application package implementing
5950 * this class.
5951 * @param cls The class name to set, equivalent to
5952 * <code>setClassName(context, cls.getName())</code>.
5953 *
5954 * @return Returns the same Intent object, for chaining multiple calls
5955 * into a single statement.
5956 *
5957 * @see #setComponent
5958 */
5959 public Intent setClass(Context packageContext, Class<?> cls) {
5960 mComponent = new ComponentName(packageContext, cls);
5961 return this;
5962 }
5963
5964 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005965 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5966 * used as a hint to the receiver for animations and the like. Null means that there
5967 * is no source bounds.
5968 */
5969 public void setSourceBounds(Rect r) {
5970 if (r != null) {
5971 mSourceBounds = new Rect(r);
5972 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005973 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005974 }
5975 }
5976
5977 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005978 * Use with {@link #fillIn} to allow the current action value to be
5979 * overwritten, even if it is already set.
5980 */
5981 public static final int FILL_IN_ACTION = 1<<0;
5982
5983 /**
5984 * Use with {@link #fillIn} to allow the current data or type value
5985 * overwritten, even if it is already set.
5986 */
5987 public static final int FILL_IN_DATA = 1<<1;
5988
5989 /**
5990 * Use with {@link #fillIn} to allow the current categories to be
5991 * overwritten, even if they are already set.
5992 */
5993 public static final int FILL_IN_CATEGORIES = 1<<2;
5994
5995 /**
5996 * Use with {@link #fillIn} to allow the current component value to be
5997 * overwritten, even if it is already set.
5998 */
5999 public static final int FILL_IN_COMPONENT = 1<<3;
6000
6001 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006002 * Use with {@link #fillIn} to allow the current package value to be
6003 * overwritten, even if it is already set.
6004 */
6005 public static final int FILL_IN_PACKAGE = 1<<4;
6006
6007 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006008 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006009 * overwritten, even if it is already set.
6010 */
6011 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6012
6013 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006014 * Use with {@link #fillIn} to allow the current selector to be
6015 * overwritten, even if it is already set.
6016 */
6017 public static final int FILL_IN_SELECTOR = 1<<6;
6018
6019 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006020 * Use with {@link #fillIn} to allow the current ClipData to be
6021 * overwritten, even if it is already set.
6022 */
6023 public static final int FILL_IN_CLIP_DATA = 1<<7;
6024
6025 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006026 * Copy the contents of <var>other</var> in to this object, but only
6027 * where fields are not defined by this object. For purposes of a field
6028 * being defined, the following pieces of data in the Intent are
6029 * considered to be separate fields:
6030 *
6031 * <ul>
6032 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006033 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006034 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6035 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006036 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006037 * <li> component, as set by {@link #setComponent(ComponentName)} or
6038 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006039 * <li> source bounds, as set by {@link #setSourceBounds}.
6040 * <li> selector, as set by {@link #setSelector(Intent)}.
6041 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006042 * <li> each top-level name in the associated extras.
6043 * </ul>
6044 *
6045 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006046 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006047 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6048 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6049 * the restriction where the corresponding field will not be replaced if
6050 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006051 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006052 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6053 * is explicitly specified. The selector will only be copied if
6054 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006055 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006056 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6057 * and Intent B with {action="gotit", data-type="some/thing",
6058 * categories="one","two"}.
6059 *
6060 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6061 * containing: {action="gotit", data-type="some/thing",
6062 * categories="bar"}.
6063 *
6064 * @param other Another Intent whose values are to be used to fill in
6065 * the current one.
6066 * @param flags Options to control which fields can be filled in.
6067 *
6068 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006069 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006070 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6071 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006072 */
6073 public int fillIn(Intent other, int flags) {
6074 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006075 if (other.mAction != null
6076 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006077 mAction = other.mAction;
6078 changes |= FILL_IN_ACTION;
6079 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006080 if ((other.mData != null || other.mType != null)
6081 && ((mData == null && mType == null)
6082 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006083 mData = other.mData;
6084 mType = other.mType;
6085 changes |= FILL_IN_DATA;
6086 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006087 if (other.mCategories != null
6088 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006089 if (other.mCategories != null) {
6090 mCategories = new HashSet<String>(other.mCategories);
6091 }
6092 changes |= FILL_IN_CATEGORIES;
6093 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006094 if (other.mPackage != null
6095 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006096 // Only do this if mSelector is not set.
6097 if (mSelector == null) {
6098 mPackage = other.mPackage;
6099 changes |= FILL_IN_PACKAGE;
6100 }
6101 }
6102 // Selector is special: it can only be set if explicitly allowed,
6103 // for the same reason as the component name.
6104 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6105 if (mPackage == null) {
6106 mSelector = new Intent(other.mSelector);
6107 mPackage = null;
6108 changes |= FILL_IN_SELECTOR;
6109 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006110 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006111 if (other.mClipData != null
6112 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6113 mClipData = other.mClipData;
6114 changes |= FILL_IN_CLIP_DATA;
6115 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006116 // Component is special: it can -only- be set if explicitly allowed,
6117 // since otherwise the sender could force the intent somewhere the
6118 // originator didn't intend.
6119 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006120 mComponent = other.mComponent;
6121 changes |= FILL_IN_COMPONENT;
6122 }
6123 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006124 if (other.mSourceBounds != null
6125 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6126 mSourceBounds = new Rect(other.mSourceBounds);
6127 changes |= FILL_IN_SOURCE_BOUNDS;
6128 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006129 if (mExtras == null) {
6130 if (other.mExtras != null) {
6131 mExtras = new Bundle(other.mExtras);
6132 }
6133 } else if (other.mExtras != null) {
6134 try {
6135 Bundle newb = new Bundle(other.mExtras);
6136 newb.putAll(mExtras);
6137 mExtras = newb;
6138 } catch (RuntimeException e) {
6139 // Modifying the extras can cause us to unparcel the contents
6140 // of the bundle, and if we do this in the system process that
6141 // may fail. We really should handle this (i.e., the Bundle
6142 // impl shouldn't be on top of a plain map), but for now just
6143 // ignore it and keep the original contents. :(
6144 Log.w("Intent", "Failure filling in extras", e);
6145 }
6146 }
6147 return changes;
6148 }
6149
6150 /**
6151 * Wrapper class holding an Intent and implementing comparisons on it for
6152 * the purpose of filtering. The class implements its
6153 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6154 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6155 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6156 * on the wrapped Intent.
6157 */
6158 public static final class FilterComparison {
6159 private final Intent mIntent;
6160 private final int mHashCode;
6161
6162 public FilterComparison(Intent intent) {
6163 mIntent = intent;
6164 mHashCode = intent.filterHashCode();
6165 }
6166
6167 /**
6168 * Return the Intent that this FilterComparison represents.
6169 * @return Returns the Intent held by the FilterComparison. Do
6170 * not modify!
6171 */
6172 public Intent getIntent() {
6173 return mIntent;
6174 }
6175
6176 @Override
6177 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006178 if (obj instanceof FilterComparison) {
6179 Intent other = ((FilterComparison)obj).mIntent;
6180 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006181 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006182 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006183 }
6184
6185 @Override
6186 public int hashCode() {
6187 return mHashCode;
6188 }
6189 }
6190
6191 /**
6192 * Determine if two intents are the same for the purposes of intent
6193 * resolution (filtering). That is, if their action, data, type,
6194 * class, and categories are the same. This does <em>not</em> compare
6195 * any extra data included in the intents.
6196 *
6197 * @param other The other Intent to compare against.
6198 *
6199 * @return Returns true if action, data, type, class, and categories
6200 * are the same.
6201 */
6202 public boolean filterEquals(Intent other) {
6203 if (other == null) {
6204 return false;
6205 }
6206 if (mAction != other.mAction) {
6207 if (mAction != null) {
6208 if (!mAction.equals(other.mAction)) {
6209 return false;
6210 }
6211 } else {
6212 if (!other.mAction.equals(mAction)) {
6213 return false;
6214 }
6215 }
6216 }
6217 if (mData != other.mData) {
6218 if (mData != null) {
6219 if (!mData.equals(other.mData)) {
6220 return false;
6221 }
6222 } else {
6223 if (!other.mData.equals(mData)) {
6224 return false;
6225 }
6226 }
6227 }
6228 if (mType != other.mType) {
6229 if (mType != null) {
6230 if (!mType.equals(other.mType)) {
6231 return false;
6232 }
6233 } else {
6234 if (!other.mType.equals(mType)) {
6235 return false;
6236 }
6237 }
6238 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006239 if (mPackage != other.mPackage) {
6240 if (mPackage != null) {
6241 if (!mPackage.equals(other.mPackage)) {
6242 return false;
6243 }
6244 } else {
6245 if (!other.mPackage.equals(mPackage)) {
6246 return false;
6247 }
6248 }
6249 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006250 if (mComponent != other.mComponent) {
6251 if (mComponent != null) {
6252 if (!mComponent.equals(other.mComponent)) {
6253 return false;
6254 }
6255 } else {
6256 if (!other.mComponent.equals(mComponent)) {
6257 return false;
6258 }
6259 }
6260 }
6261 if (mCategories != other.mCategories) {
6262 if (mCategories != null) {
6263 if (!mCategories.equals(other.mCategories)) {
6264 return false;
6265 }
6266 } else {
6267 if (!other.mCategories.equals(mCategories)) {
6268 return false;
6269 }
6270 }
6271 }
6272
6273 return true;
6274 }
6275
6276 /**
6277 * Generate hash code that matches semantics of filterEquals().
6278 *
6279 * @return Returns the hash value of the action, data, type, class, and
6280 * categories.
6281 *
6282 * @see #filterEquals
6283 */
6284 public int filterHashCode() {
6285 int code = 0;
6286 if (mAction != null) {
6287 code += mAction.hashCode();
6288 }
6289 if (mData != null) {
6290 code += mData.hashCode();
6291 }
6292 if (mType != null) {
6293 code += mType.hashCode();
6294 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006295 if (mPackage != null) {
6296 code += mPackage.hashCode();
6297 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006298 if (mComponent != null) {
6299 code += mComponent.hashCode();
6300 }
6301 if (mCategories != null) {
6302 code += mCategories.hashCode();
6303 }
6304 return code;
6305 }
6306
6307 @Override
6308 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006309 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006310
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006311 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006312 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006313 b.append(" }");
6314
6315 return b.toString();
6316 }
6317
6318 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006319 public String toInsecureString() {
6320 StringBuilder b = new StringBuilder(128);
6321
6322 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006323 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006324 b.append(" }");
6325
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006326 return b.toString();
6327 }
Romain Guy4969af72009-06-17 10:53:19 -07006328
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006329 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006330 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006331 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006332
6333 b.append("Intent { ");
6334 toShortString(b, false, true, true, true);
6335 b.append(" }");
6336
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006337 return b.toString();
6338 }
6339
6340 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006341 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6342 StringBuilder b = new StringBuilder(128);
6343 toShortString(b, secure, comp, extras, clip);
6344 return b.toString();
6345 }
6346
6347 /** @hide */
6348 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6349 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006350 boolean first = true;
6351 if (mAction != null) {
6352 b.append("act=").append(mAction);
6353 first = false;
6354 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006355 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006356 if (!first) {
6357 b.append(' ');
6358 }
6359 first = false;
6360 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006361 Iterator<String> i = mCategories.iterator();
6362 boolean didone = false;
6363 while (i.hasNext()) {
6364 if (didone) b.append(",");
6365 didone = true;
6366 b.append(i.next());
6367 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006368 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006369 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006370 if (mData != null) {
6371 if (!first) {
6372 b.append(' ');
6373 }
6374 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006375 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006376 if (secure) {
6377 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006378 } else {
6379 b.append(mData);
6380 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006381 }
6382 if (mType != null) {
6383 if (!first) {
6384 b.append(' ');
6385 }
6386 first = false;
6387 b.append("typ=").append(mType);
6388 }
6389 if (mFlags != 0) {
6390 if (!first) {
6391 b.append(' ');
6392 }
6393 first = false;
6394 b.append("flg=0x").append(Integer.toHexString(mFlags));
6395 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006396 if (mPackage != null) {
6397 if (!first) {
6398 b.append(' ');
6399 }
6400 first = false;
6401 b.append("pkg=").append(mPackage);
6402 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006403 if (comp && mComponent != null) {
6404 if (!first) {
6405 b.append(' ');
6406 }
6407 first = false;
6408 b.append("cmp=").append(mComponent.flattenToShortString());
6409 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006410 if (mSourceBounds != null) {
6411 if (!first) {
6412 b.append(' ');
6413 }
6414 first = false;
6415 b.append("bnds=").append(mSourceBounds.toShortString());
6416 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006417 if (mClipData != null) {
6418 if (!first) {
6419 b.append(' ');
6420 }
6421 first = false;
6422 if (clip) {
6423 b.append("clip={");
6424 mClipData.toShortString(b);
6425 b.append('}');
6426 } else {
6427 b.append("(has clip)");
6428 }
6429 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006430 if (extras && mExtras != null) {
6431 if (!first) {
6432 b.append(' ');
6433 }
6434 first = false;
6435 b.append("(has extras)");
6436 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006437 if (mSelector != null) {
6438 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006439 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006440 b.append("}");
6441 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006442 }
6443
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006444 /**
6445 * Call {@link #toUri} with 0 flags.
6446 * @deprecated Use {@link #toUri} instead.
6447 */
6448 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006449 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006450 return toUri(0);
6451 }
6452
6453 /**
6454 * Convert this Intent into a String holding a URI representation of it.
6455 * The returned URI string has been properly URI encoded, so it can be
6456 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6457 * Intent's data as the base URI, with an additional fragment describing
6458 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006459 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006460 * <p>You can convert the returned string back to an Intent with
6461 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006462 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006463 * @param flags Additional operating flags. Either 0 or
6464 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006465 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006466 * @return Returns a URI encoding URI string describing the entire contents
6467 * of the Intent.
6468 */
6469 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006470 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006471 String scheme = null;
6472 if (mData != null) {
6473 String data = mData.toString();
6474 if ((flags&URI_INTENT_SCHEME) != 0) {
6475 final int N = data.length();
6476 for (int i=0; i<N; i++) {
6477 char c = data.charAt(i);
6478 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6479 || c == '.' || c == '-') {
6480 continue;
6481 }
6482 if (c == ':' && i > 0) {
6483 // Valid scheme.
6484 scheme = data.substring(0, i);
6485 uri.append("intent:");
6486 data = data.substring(i+1);
6487 break;
6488 }
Tom Taylord4a47292009-12-21 13:59:18 -08006489
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006490 // No scheme.
6491 break;
6492 }
6493 }
6494 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006495
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006496 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6497 uri.append("intent:");
6498 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006499
6500 uri.append("#Intent;");
6501
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006502 toUriInner(uri, scheme, flags);
6503 if (mSelector != null) {
6504 uri.append("SEL;");
6505 // Note that for now we are not going to try to handle the
6506 // data part; not clear how to represent this as a URI, and
6507 // not much utility in it.
6508 mSelector.toUriInner(uri, null, flags);
6509 }
6510
6511 uri.append("end");
6512
6513 return uri.toString();
6514 }
6515
6516 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006517 if (scheme != null) {
6518 uri.append("scheme=").append(scheme).append(';');
6519 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006520 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006521 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006522 }
6523 if (mCategories != null) {
6524 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006525 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006526 }
6527 }
6528 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006529 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006530 }
6531 if (mFlags != 0) {
6532 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6533 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006534 if (mPackage != null) {
6535 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6536 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006537 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006538 uri.append("component=").append(Uri.encode(
6539 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006540 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006541 if (mSourceBounds != null) {
6542 uri.append("sourceBounds=")
6543 .append(Uri.encode(mSourceBounds.flattenToString()))
6544 .append(';');
6545 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006546 if (mExtras != null) {
6547 for (String key : mExtras.keySet()) {
6548 final Object value = mExtras.get(key);
6549 char entryType =
6550 value instanceof String ? 'S' :
6551 value instanceof Boolean ? 'B' :
6552 value instanceof Byte ? 'b' :
6553 value instanceof Character ? 'c' :
6554 value instanceof Double ? 'd' :
6555 value instanceof Float ? 'f' :
6556 value instanceof Integer ? 'i' :
6557 value instanceof Long ? 'l' :
6558 value instanceof Short ? 's' :
6559 '\0';
6560
6561 if (entryType != '\0') {
6562 uri.append(entryType);
6563 uri.append('.');
6564 uri.append(Uri.encode(key));
6565 uri.append('=');
6566 uri.append(Uri.encode(value.toString()));
6567 uri.append(';');
6568 }
6569 }
6570 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006571 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006572
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006573 public int describeContents() {
6574 return (mExtras != null) ? mExtras.describeContents() : 0;
6575 }
6576
6577 public void writeToParcel(Parcel out, int flags) {
6578 out.writeString(mAction);
6579 Uri.writeToParcel(out, mData);
6580 out.writeString(mType);
6581 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006582 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006583 ComponentName.writeToParcel(mComponent, out);
6584
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006585 if (mSourceBounds != null) {
6586 out.writeInt(1);
6587 mSourceBounds.writeToParcel(out, flags);
6588 } else {
6589 out.writeInt(0);
6590 }
6591
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006592 if (mCategories != null) {
6593 out.writeInt(mCategories.size());
6594 for (String category : mCategories) {
6595 out.writeString(category);
6596 }
6597 } else {
6598 out.writeInt(0);
6599 }
6600
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006601 if (mSelector != null) {
6602 out.writeInt(1);
6603 mSelector.writeToParcel(out, flags);
6604 } else {
6605 out.writeInt(0);
6606 }
6607
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006608 if (mClipData != null) {
6609 out.writeInt(1);
6610 mClipData.writeToParcel(out, flags);
6611 } else {
6612 out.writeInt(0);
6613 }
6614
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006615 out.writeBundle(mExtras);
6616 }
6617
6618 public static final Parcelable.Creator<Intent> CREATOR
6619 = new Parcelable.Creator<Intent>() {
6620 public Intent createFromParcel(Parcel in) {
6621 return new Intent(in);
6622 }
6623 public Intent[] newArray(int size) {
6624 return new Intent[size];
6625 }
6626 };
6627
Dianne Hackborneb034652009-09-07 00:49:58 -07006628 /** @hide */
6629 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006630 readFromParcel(in);
6631 }
6632
6633 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006634 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006635 mData = Uri.CREATOR.createFromParcel(in);
6636 mType = in.readString();
6637 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006638 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006639 mComponent = ComponentName.readFromParcel(in);
6640
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006641 if (in.readInt() != 0) {
6642 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6643 }
6644
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006645 int N = in.readInt();
6646 if (N > 0) {
6647 mCategories = new HashSet<String>();
6648 int i;
6649 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006650 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006651 }
6652 } else {
6653 mCategories = null;
6654 }
6655
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006656 if (in.readInt() != 0) {
6657 mSelector = new Intent(in);
6658 }
6659
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006660 if (in.readInt() != 0) {
6661 mClipData = new ClipData(in);
6662 }
6663
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006664 mExtras = in.readBundle();
6665 }
6666
6667 /**
6668 * Parses the "intent" element (and its children) from XML and instantiates
6669 * an Intent object. The given XML parser should be located at the tag
6670 * where parsing should start (often named "intent"), from which the
6671 * basic action, data, type, and package and class name will be
6672 * retrieved. The function will then parse in to any child elements,
6673 * looking for <category android:name="xxx"> tags to add categories and
6674 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6675 * to the intent.
6676 *
6677 * @param resources The Resources to use when inflating resources.
6678 * @param parser The XML parser pointing at an "intent" tag.
6679 * @param attrs The AttributeSet interface for retrieving extended
6680 * attribute data at the current <var>parser</var> location.
6681 * @return An Intent object matching the XML data.
6682 * @throws XmlPullParserException If there was an XML parsing error.
6683 * @throws IOException If there was an I/O error.
6684 */
6685 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6686 throws XmlPullParserException, IOException {
6687 Intent intent = new Intent();
6688
6689 TypedArray sa = resources.obtainAttributes(attrs,
6690 com.android.internal.R.styleable.Intent);
6691
6692 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6693
6694 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6695 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6696 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6697
6698 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6699 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6700 if (packageName != null && className != null) {
6701 intent.setComponent(new ComponentName(packageName, className));
6702 }
6703
6704 sa.recycle();
6705
6706 int outerDepth = parser.getDepth();
6707 int type;
6708 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6709 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6710 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6711 continue;
6712 }
6713
6714 String nodeName = parser.getName();
6715 if (nodeName.equals("category")) {
6716 sa = resources.obtainAttributes(attrs,
6717 com.android.internal.R.styleable.IntentCategory);
6718 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6719 sa.recycle();
6720
6721 if (cat != null) {
6722 intent.addCategory(cat);
6723 }
6724 XmlUtils.skipCurrentTag(parser);
6725
6726 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006727 if (intent.mExtras == null) {
6728 intent.mExtras = new Bundle();
6729 }
6730 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6731 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006732
6733 } else {
6734 XmlUtils.skipCurrentTag(parser);
6735 }
6736 }
6737
6738 return intent;
6739 }
Nick Pellyccae4122012-01-09 14:12:58 -08006740
6741 /**
6742 * Normalize a MIME data type.
6743 *
6744 * <p>A normalized MIME type has white-space trimmed,
6745 * content-type parameters removed, and is lower-case.
6746 * This aligns the type with Android best practices for
6747 * intent filtering.
6748 *
6749 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6750 * "text/x-vCard" becomes "text/x-vcard".
6751 *
6752 * <p>All MIME types received from outside Android (such as user input,
6753 * or external sources like Bluetooth, NFC, or the Internet) should
6754 * be normalized before they are used to create an Intent.
6755 *
6756 * @param type MIME data type to normalize
6757 * @return normalized MIME data type, or null if the input was null
6758 * @see {@link #setType}
6759 * @see {@link #setTypeAndNormalize}
6760 */
6761 public static String normalizeMimeType(String type) {
6762 if (type == null) {
6763 return null;
6764 }
6765
6766 type = type.trim().toLowerCase(Locale.US);
6767
6768 final int semicolonIndex = type.indexOf(';');
6769 if (semicolonIndex != -1) {
6770 type = type.substring(0, semicolonIndex);
6771 }
6772 return type;
6773 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006774
6775 /**
6776 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006777 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6778 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006779 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006780 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006781 * @hide
6782 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006783 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006784 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006785 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006786
6787 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006788 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006789
6790 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006791 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006792 try {
6793 // Inspect target intent to see if we need to migrate
6794 final Intent target = getParcelableExtra(EXTRA_INTENT);
6795 if (target != null && target.migrateExtraStreamToClipData()) {
6796 // Since we migrated in child, we need to promote ClipData
6797 // and flags to ourselves to grant.
6798 setClipData(target.getClipData());
6799 addFlags(target.getFlags()
6800 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6801 return true;
6802 } else {
6803 return false;
6804 }
6805 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006806 }
6807
6808 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006809 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006810 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6811 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6812 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6813 if (stream != null || text != null || htmlText != null) {
6814 final ClipData clipData = new ClipData(
6815 null, new String[] { getType() },
6816 new ClipData.Item(text, htmlText, null, stream));
6817 setClipData(clipData);
6818 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006819 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006820 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006821 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006822 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006823
6824 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006825 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006826 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6827 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6828 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6829 int num = -1;
6830 if (streams != null) {
6831 num = streams.size();
6832 }
6833 if (texts != null) {
6834 if (num >= 0 && num != texts.size()) {
6835 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006836 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006837 }
6838 num = texts.size();
6839 }
6840 if (htmlTexts != null) {
6841 if (num >= 0 && num != htmlTexts.size()) {
6842 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006843 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006844 }
6845 num = htmlTexts.size();
6846 }
6847 if (num > 0) {
6848 final ClipData clipData = new ClipData(
6849 null, new String[] { getType() },
6850 makeClipItem(streams, texts, htmlTexts, 0));
6851
6852 for (int i = 1; i < num; i++) {
6853 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6854 }
6855
6856 setClipData(clipData);
6857 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006858 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006859 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006860 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006861 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006862 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006863
6864 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006865 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006866
6867 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6868 ArrayList<String> htmlTexts, int which) {
6869 Uri uri = streams != null ? streams.get(which) : null;
6870 CharSequence text = texts != null ? texts.get(which) : null;
6871 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6872 return new ClipData.Item(text, htmlText, null, uri);
6873 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006874}