blob: b9518b8913475987e384689d24ee7d8b523f66da [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 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001308 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1309 * package. Tells the installer UI to skip the confirmation with the user
1310 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001311 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1312 * will no longer show an interstitial message about updating existing
1313 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001314 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001315 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001316 public static final String EXTRA_ALLOW_REPLACE
1317 = "android.intent.extra.ALLOW_REPLACE";
1318
1319 /**
1320 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1321 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1322 * return to the application the result code of the install/uninstall. The returned result
1323 * code will be {@link android.app.Activity#RESULT_OK} on success or
1324 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1325 */
1326 public static final String EXTRA_RETURN_RESULT
1327 = "android.intent.extra.RETURN_RESULT";
1328
1329 /**
1330 * Package manager install result code. @hide because result codes are not
1331 * yet ready to be exposed.
1332 */
1333 public static final String EXTRA_INSTALL_RESULT
1334 = "android.intent.extra.INSTALL_RESULT";
1335
1336 /**
1337 * Activity Action: Launch application uninstaller.
1338 * <p>
1339 * Input: The data must be a package: URI whose scheme specific part is
1340 * the package name of the current installed package to be uninstalled.
1341 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1342 * <p>
1343 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1344 * succeeded.
1345 */
1346 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1347 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1348
1349 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001350 * Specify whether the package should be uninstalled for all users.
1351 * @hide because these should not be part of normal application flow.
1352 */
1353 public static final String EXTRA_UNINSTALL_ALL_USERS
1354 = "android.intent.extra.UNINSTALL_ALL_USERS";
1355
1356 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001357 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1358 * describing the last run version of the platform that was setup.
1359 * @hide
1360 */
1361 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1362
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001363 // ---------------------------------------------------------------------
1364 // ---------------------------------------------------------------------
1365 // Standard intent broadcast actions (see action variable).
1366
1367 /**
1368 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001369 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001370 * <p class="note">This is a protected intent that can only be sent
1371 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001372 */
1373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1374 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1375 /**
1376 * Broadcast Action: Sent after the screen turns on.
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_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001383
1384 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001385 * 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 -07001386 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001387 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001388 * <p class="note">This is a protected intent that can only be sent
1389 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001390 */
1391 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001392 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001393
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001394 /**
1395 * Broadcast Action: The current time has changed. Sent every
1396 * minute. You can <em>not</em> receive this through components declared
1397 * in manifests, only by exlicitly registering for it with
1398 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1399 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001400 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001401 * <p class="note">This is a protected intent that can only be sent
1402 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001403 */
1404 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1405 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1406 /**
1407 * Broadcast Action: The time was set.
1408 */
1409 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1410 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1411 /**
1412 * Broadcast Action: The date has changed.
1413 */
1414 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1415 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1416 /**
1417 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1418 * <ul>
1419 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1420 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001421 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001422 * <p class="note">This is a protected intent that can only be sent
1423 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001424 */
1425 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1426 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1427 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001428 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1429 * DNS entries should be tossed.
1430 * @hide
1431 */
1432 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1433 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1434 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001435 * Alarm Changed Action: This is broadcast when the AlarmClock
1436 * application's alarm is set or unset. It is used by the
1437 * AlarmClock application and the StatusBar service.
1438 * @hide
1439 */
1440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1441 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1442 /**
1443 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1444 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1445 * @hide
1446 */
1447 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1448 public static final String ACTION_SYNC_STATE_CHANGED
1449 = "android.intent.action.SYNC_STATE_CHANGED";
1450 /**
1451 * Broadcast Action: This is broadcast once, after the system has finished
1452 * booting. It can be used to perform application-specific initialization,
1453 * such as installing alarms. You must hold the
1454 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1455 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001456 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001457 * <p class="note">This is a protected intent that can only be sent
1458 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001459 */
1460 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1461 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1462 /**
1463 * Broadcast Action: This is broadcast when a user action should request a
1464 * temporary system dialog to dismiss. Some examples of temporary system
1465 * dialogs are the notification window-shade and the recent tasks dialog.
1466 */
1467 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1468 /**
1469 * Broadcast Action: Trigger the download and eventual installation
1470 * of a package.
1471 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001472 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001473 * <p class="note">This is a protected intent that can only be sent
1474 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001475 *
1476 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001477 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001478 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1480 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1481 /**
1482 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001483 * device. The data contains the name of the package. Note that the
1484 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001485 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001486 * <ul>
1487 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1488 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1489 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1490 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001491 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001492 * <p class="note">This is a protected intent that can only be sent
1493 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001494 */
1495 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1496 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1497 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001498 * Broadcast Action: A new version of an application package has been
1499 * installed, replacing an existing version that was previously installed.
1500 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001501 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001502 * <ul>
1503 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1504 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001505 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001506 * <p class="note">This is a protected intent that can only be sent
1507 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001508 */
1509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1510 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1511 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001512 * Broadcast Action: A new version of your application has been installed
1513 * over an existing one. This is only sent to the application that was
1514 * replaced. It does not contain any additional data; to receive it, just
1515 * use an intent filter for this action.
1516 *
1517 * <p class="note">This is a protected intent that can only be sent
1518 * by the system.
1519 */
1520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1521 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1522 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001523 * Broadcast Action: An existing application package has been removed from
1524 * the device. The data contains the name of the package. The package
1525 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001526 * <ul>
1527 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1528 * to the package.
1529 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1530 * application -- data and code -- is being removed.
1531 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1532 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1533 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001534 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001535 * <p class="note">This is a protected intent that can only be sent
1536 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1540 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001541 * Broadcast Action: An existing application package has been completely
1542 * removed from the device. The data contains the name of the package.
1543 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1544 * {@link #EXTRA_DATA_REMOVED} is true and
1545 * {@link #EXTRA_REPLACING} is false of that broadcast.
1546 *
1547 * <ul>
1548 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1549 * to the package.
1550 * </ul>
1551 *
1552 * <p class="note">This is a protected intent that can only be sent
1553 * by the system.
1554 */
1555 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1556 public static final String ACTION_PACKAGE_FULLY_REMOVED
1557 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1558 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001559 * Broadcast Action: An existing application package has been changed (e.g.
1560 * a component has been enabled or disabled). The data contains the name of
1561 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001562 * <ul>
1563 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001564 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1565 * of the changed components.
1566 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1567 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001568 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001569 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001570 * <p class="note">This is a protected intent that can only be sent
1571 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001572 */
1573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1574 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1575 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001576 * @hide
1577 * Broadcast Action: Ask system services if there is any reason to
1578 * restart the given package. The data contains the name of the
1579 * package.
1580 * <ul>
1581 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1582 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1583 * </ul>
1584 *
1585 * <p class="note">This is a protected intent that can only be sent
1586 * by the system.
1587 */
1588 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1589 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1590 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001591 * Broadcast Action: The user has restarted a package, and all of its
1592 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001593 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001594 * be removed. Note that the restarted package does <em>not</em>
1595 * receive this broadcast.
1596 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001597 * <ul>
1598 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1599 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001600 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001601 * <p class="note">This is a protected intent that can only be sent
1602 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001603 */
1604 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1605 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1606 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001607 * Broadcast Action: The user has cleared the data of a package. This should
1608 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001609 * its persistent data is erased and this broadcast sent.
1610 * Note that the cleared package does <em>not</em>
1611 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001612 * <ul>
1613 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1614 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001615 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001616 * <p class="note">This is a protected intent that can only be sent
1617 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001618 */
1619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1620 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1621 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001622 * Broadcast Action: A user ID has been removed from the system. The user
1623 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001624 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001625 * <p class="note">This is a protected intent that can only be sent
1626 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001627 */
1628 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1629 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001630
1631 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001632 * Broadcast Action: Sent to the installer package of an application
1633 * when that application is first launched (that is the first time it
1634 * is moved out of the stopped state). The data contains the name of the package.
1635 *
1636 * <p class="note">This is a protected intent that can only be sent
1637 * by the system.
1638 */
1639 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1640 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1641
1642 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001643 * Broadcast Action: Sent to the system package verifier when a package
1644 * needs to be verified. The data contains the package URI.
1645 * <p class="note">
1646 * This is a protected intent that can only be sent by the system.
1647 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001648 */
1649 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1650 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1651
1652 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001653 * Broadcast Action: Sent to the system package verifier when a package is
1654 * verified. The data contains the package URI.
1655 * <p class="note">
1656 * This is a protected intent that can only be sent by the system.
1657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1660
1661 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001662 * Broadcast Action: Resources for a set of packages (which were
1663 * previously unavailable) are currently
1664 * available since the media on which they exist is available.
1665 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1666 * list of packages whose availability changed.
1667 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1668 * list of uids of packages whose availability changed.
1669 * Note that the
1670 * packages in this list do <em>not</em> receive this broadcast.
1671 * The specified set of packages are now available on the system.
1672 * <p>Includes the following extras:
1673 * <ul>
1674 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1675 * whose resources(were previously unavailable) are currently available.
1676 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1677 * packages whose resources(were previously unavailable)
1678 * are currently available.
1679 * </ul>
1680 *
1681 * <p class="note">This is a protected intent that can only be sent
1682 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001685 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1686 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001687
1688 /**
1689 * Broadcast Action: Resources for a set of packages are currently
1690 * unavailable since the media on which they exist is unavailable.
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 * The specified set of packages can no longer be
1696 * launched and are practically unavailable on the system.
1697 * <p>Inclues the following extras:
1698 * <ul>
1699 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1700 * whose resources are no longer available.
1701 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1702 * whose resources are no longer available.
1703 * </ul>
1704 *
1705 * <p class="note">This is a protected intent that can only be sent
1706 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001707 */
1708 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001709 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001710 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001711
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001712 /**
1713 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001714 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001715 * This should <em>only</em> be used to determine when the wallpaper
1716 * has changed to show the new wallpaper to the user. You should certainly
1717 * never, in response to this, change the wallpaper or other attributes of
1718 * it such as the suggested size. That would be crazy, right? You'd cause
1719 * all kinds of loops, especially if other apps are doing similar things,
1720 * right? Of course. So please don't do this.
1721 *
1722 * @deprecated Modern applications should use
1723 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1724 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1725 * shown behind their UI, rather than watching for this broadcast and
1726 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001727 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001728 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001729 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1730 /**
1731 * Broadcast Action: The current device {@link android.content.res.Configuration}
1732 * (orientation, locale, etc) has changed. When such a change happens, the
1733 * UIs (view hierarchy) will need to be rebuilt based on this new
1734 * information; for the most part, applications don't need to worry about
1735 * this, because the system will take care of stopping and restarting the
1736 * application to make sure it sees the new changes. Some system code that
1737 * can not be restarted will need to watch for this action and handle it
1738 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001739 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001740 * <p class="note">
1741 * You can <em>not</em> receive this through components declared
1742 * in manifests, only by explicitly registering for it with
1743 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1744 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001745 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001746 * <p class="note">This is a protected intent that can only be sent
1747 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001748 *
1749 * @see android.content.res.Configuration
1750 */
1751 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1752 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1753 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001754 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001755 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001756 * <p class="note">This is a protected intent that can only be sent
1757 * by the system.
1758 */
1759 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1760 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1761 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001762 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1763 * charging state, level, and other information about the battery.
1764 * See {@link android.os.BatteryManager} for documentation on the
1765 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001766 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001767 * <p class="note">
1768 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001769 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001770 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001771 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1772 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1773 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1774 * broadcasts that are sent and can be received through manifest
1775 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001776 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001777 * <p class="note">This is a protected intent that can only be sent
1778 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001779 */
1780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1781 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1782 /**
1783 * Broadcast Action: Indicates low battery condition on the device.
1784 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001785 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001786 * <p class="note">This is a protected intent that can only be sent
1787 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001788 */
1789 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1790 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1791 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001792 * Broadcast Action: Indicates the battery is now okay after being low.
1793 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1794 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001795 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001796 * <p class="note">This is a protected intent that can only be sent
1797 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001798 */
1799 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1800 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1801 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001802 * Broadcast Action: External power has been connected to the device.
1803 * This is intended for applications that wish to register specifically to this notification.
1804 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1805 * stay active to receive this notification. This action can be used to implement actions
1806 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001807 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001808 * <p class="note">This is a protected intent that can only be sent
1809 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001810 */
1811 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001812 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001813 /**
1814 * Broadcast Action: External power has been removed from the device.
1815 * This is intended for applications that wish to register specifically to this notification.
1816 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1817 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001818 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001819 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001820 * <p class="note">This is a protected intent that can only be sent
1821 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001824 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001825 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001826 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001827 * Broadcast Action: Device is shutting down.
1828 * This is broadcast when the device is being shut down (completely turned
1829 * off, not sleeping). Once the broadcast is complete, the final shutdown
1830 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001831 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001832 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001833 * <p class="note">This is a protected intent that can only be sent
1834 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001835 */
1836 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001837 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001838 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001839 * Activity Action: Start this activity to request system shutdown.
1840 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1841 * to request confirmation from the user before shutting down.
1842 *
1843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
1845 *
1846 * {@hide}
1847 */
1848 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1849 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001850 * Broadcast Action: A sticky broadcast that indicates low memory
1851 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001853 * <p class="note">This is a protected intent that can only be sent
1854 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1858 /**
1859 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001860 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001861 * <p class="note">This is a protected intent that can only be sent
1862 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001863 */
1864 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1865 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1866 /**
Jake Hambybb371632010-08-23 18:16:48 -07001867 * Broadcast Action: A sticky broadcast that indicates a memory full
1868 * condition on the device. This is intended for activities that want
1869 * to be able to fill the data partition completely, leaving only
1870 * enough free space to prevent system-wide SQLite failures.
1871 *
1872 * <p class="note">This is a protected intent that can only be sent
1873 * by the system.
1874 *
1875 * {@hide}
1876 */
1877 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1878 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1879 /**
1880 * Broadcast Action: Indicates memory full condition on the device
1881 * no longer exists.
1882 *
1883 * <p class="note">This is a protected intent that can only be sent
1884 * by the system.
1885 *
1886 * {@hide}
1887 */
1888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1889 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1890 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001891 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1892 * and package management should be started.
1893 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1894 * notification.
1895 */
1896 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1897 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1898 /**
1899 * Broadcast Action: The device has entered USB Mass Storage mode.
1900 * This is used mainly for the USB Settings panel.
1901 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1902 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001903 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001904 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001905 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001906 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1907
1908 /**
1909 * Broadcast Action: The device has exited USB Mass Storage mode.
1910 * This is used mainly for the USB Settings panel.
1911 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1912 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001913 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001914 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001915 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001916 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1917
1918 /**
1919 * Broadcast Action: External media has been removed.
1920 * The path to the mount point for the removed media is contained in the Intent.mData field.
1921 */
1922 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1923 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1924
1925 /**
1926 * Broadcast Action: External media is present, but not mounted at its mount point.
1927 * The path to the mount point for the removed media is contained in the Intent.mData field.
1928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1930 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1931
1932 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001933 * Broadcast Action: External media is present, and being disk-checked
1934 * 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 -08001935 */
1936 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1937 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1938
1939 /**
1940 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1941 * 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 -08001942 */
1943 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1944 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1945
1946 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 * Broadcast Action: External media is present and mounted at its mount point.
1948 * The path to the mount point for the removed media is contained in the Intent.mData field.
1949 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1950 * media was mounted read only.
1951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1954
1955 /**
1956 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001957 * 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 -07001958 */
1959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1960 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1961
1962 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001963 * Broadcast Action: External media is no longer being shared via USB mass storage.
1964 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1965 *
1966 * @hide
1967 */
1968 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1969
1970 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001971 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1972 * The path to the mount point for the removed media is contained in the Intent.mData field.
1973 */
1974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1975 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1976
1977 /**
1978 * Broadcast Action: External media is present but cannot be mounted.
1979 * The path to the mount point for the removed media is contained in the Intent.mData field.
1980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1983
1984 /**
1985 * Broadcast Action: User has expressed the desire to remove the external storage media.
1986 * Applications should close all files they have open within the mount point when they receive this intent.
1987 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1991
1992 /**
1993 * Broadcast Action: The media scanner has started scanning a directory.
1994 * The path to the directory being scanned is contained in the Intent.mData field.
1995 */
1996 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1997 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1998
1999 /**
2000 * Broadcast Action: The media scanner has finished scanning a directory.
2001 * The path to the scanned directory is contained in the Intent.mData field.
2002 */
2003 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2004 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2005
2006 /**
2007 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2008 * The path to the file is contained in the Intent.mData field.
2009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2012
2013 /**
2014 * Broadcast Action: The "Media Button" was pressed. Includes a single
2015 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2016 * caused the broadcast.
2017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2020
2021 /**
2022 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2023 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2024 * caused the broadcast.
2025 */
2026 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2027 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2028
2029 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2030 // location; they are not general-purpose actions.
2031
2032 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002033 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002034 */
2035 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2036 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2037 "android.intent.action.GTALK_CONNECTED";
2038
2039 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002040 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002041 */
2042 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2043 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2044 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002045
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002046 /**
2047 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002048 */
2049 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2050 public static final String ACTION_INPUT_METHOD_CHANGED =
2051 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002052
2053 /**
2054 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2055 * more radios have been turned off or on. The intent will have the following extra value:</p>
2056 * <ul>
2057 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2058 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2059 * turned off</li>
2060 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002061 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002062 * <p class="note">This is a protected intent that can only be sent
2063 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 */
2065 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2066 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2067
2068 /**
2069 * Broadcast Action: Some content providers have parts of their namespace
2070 * where they publish new events or items that the user may be especially
2071 * interested in. For these things, they may broadcast this action when the
2072 * set of interesting items change.
2073 *
2074 * For example, GmailProvider sends this notification when the set of unread
2075 * mail in the inbox changes.
2076 *
2077 * <p>The data of the intent identifies which part of which provider
2078 * changed. When queried through the content resolver, the data URI will
2079 * return the data set in question.
2080 *
2081 * <p>The intent will have the following extra values:
2082 * <ul>
2083 * <li><em>count</em> - The number of items in the data set. This is the
2084 * same as the number of items in the cursor returned by querying the
2085 * data URI. </li>
2086 * </ul>
2087 *
2088 * This intent will be sent at boot (if the count is non-zero) and when the
2089 * data set changes. It is possible for the data set to change without the
2090 * count changing (for example, if a new unread message arrives in the same
2091 * sync operation in which a message is archived). The phone should still
2092 * ring/vibrate/etc as normal in this case.
2093 */
2094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2095 public static final String ACTION_PROVIDER_CHANGED =
2096 "android.intent.action.PROVIDER_CHANGED";
2097
2098 /**
2099 * Broadcast Action: Wired Headset plugged in or unplugged.
2100 *
2101 * <p>The intent will have the following extra values:
2102 * <ul>
2103 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2104 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002105 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002106 * </ul>
2107 * </ul>
2108 */
2109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2110 public static final String ACTION_HEADSET_PLUG =
2111 "android.intent.action.HEADSET_PLUG";
2112
2113 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002114 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2115 *
2116 * <p>The intent will have the following extra values:
2117 * <ul>
2118 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2119 * <li><em>name</em> - Headset type, human readable string </li>
2120 * </ul>
2121 * </ul>
2122 * @hide
2123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002125 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2126 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002127
2128 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002129 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002130 *
2131 * <p>The intent will have the following extra values:
2132 * <ul>
2133 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2134 * <li><em>name</em> - Headset type, human readable string </li>
2135 * </ul>
2136 * </ul>
2137 * @hide
2138 */
2139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002140 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2141 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002142
2143 /**
2144 * Broadcast Action: A HMDI cable was plugged or unplugged
2145 *
2146 * <p>The intent will have the following extra values:
2147 * <ul>
2148 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2149 * <li><em>name</em> - HDMI cable, human readable string </li>
2150 * </ul>
2151 * </ul>
2152 * @hide
2153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_HDMI_AUDIO_PLUG =
2156 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002157
2158 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002159 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2160 *
2161 * <p>The intent will have the following extra values:
2162 * <ul>
2163 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2164 * <li><em>card</em> - ALSA card number (integer) </li>
2165 * <li><em>device</em> - ALSA device number (integer) </li>
2166 * </ul>
2167 * </ul>
2168 * @hide
2169 */
2170 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2171 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2172 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2173
2174 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002175 * Broadcast Action: A USB audio device was plugged in or unplugged.
2176 *
2177 * <p>The intent will have the following extra values:
2178 * <ul>
2179 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2180 * <li><em>card</em> - ALSA card number (integer) </li>
2181 * <li><em>device</em> - ALSA device number (integer) </li>
2182 * </ul>
2183 * </ul>
2184 * @hide
2185 */
2186 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2187 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2188 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2189
2190 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002191 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2192 * <ul>
2193 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2194 * </ul>
2195 *
2196 * <p class="note">This is a protected intent that can only be sent
2197 * by the system.
2198 *
2199 * @hide
2200 */
2201 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2202 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2203 = "android.intent.action.ADVANCED_SETTINGS";
2204
2205 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002206 * Broadcast Action: An outgoing call is about to be placed.
2207 *
2208 * <p>The Intent will have the following extra value:
2209 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002210 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002211 * the phone number originally intended to be dialed.</li>
2212 * </ul>
2213 * <p>Once the broadcast is finished, the resultData is used as the actual
2214 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002215 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002216 * outgoing call in turn: for example, a parental control application
2217 * might verify that the user is authorized to place the call at that
2218 * time, then a number-rewriting application might add an area code if
2219 * one was not specified.</p>
2220 * <p>For consistency, any receiver whose purpose is to prohibit phone
2221 * calls should have a priority of 0, to ensure it will see the final
2222 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002223 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002224 * should have a positive priority.
2225 * Negative priorities are reserved for the system for this broadcast;
2226 * using them may cause problems.</p>
2227 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2228 * abort the broadcast.</p>
2229 * <p>Emergency calls cannot be intercepted using this mechanism, and
2230 * other calls cannot be modified to call emergency numbers using this
2231 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002232 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002233 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2234 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002235 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002236 * <p class="note">This is a protected intent that can only be sent
2237 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002238 */
2239 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2240 public static final String ACTION_NEW_OUTGOING_CALL =
2241 "android.intent.action.NEW_OUTGOING_CALL";
2242
2243 /**
2244 * Broadcast Action: Have the device reboot. This is only for use by
2245 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002246 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002247 * <p class="note">This is a protected intent that can only be sent
2248 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2251 public static final String ACTION_REBOOT =
2252 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002253
Wei Huang97ecc9c2009-05-11 17:44:20 -07002254 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002255 * Broadcast Action: A sticky broadcast for changes in the physical
2256 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002257 *
2258 * <p>The intent will have the following extra values:
2259 * <ul>
2260 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002261 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002262 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002263 * <p>This is intended for monitoring the current physical dock state.
2264 * See {@link android.app.UiModeManager} for the normal API dealing with
2265 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002266 */
2267 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2268 public static final String ACTION_DOCK_EVENT =
2269 "android.intent.action.DOCK_EVENT";
2270
2271 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002272 * Broadcast Action: a remote intent is to be broadcasted.
2273 *
2274 * A remote intent is used for remote RPC between devices. The remote intent
2275 * is serialized and sent from one device to another device. The receiving
2276 * device parses the remote intent and broadcasts it. Note that anyone can
2277 * broadcast a remote intent. However, if the intent receiver of the remote intent
2278 * does not trust intent broadcasts from arbitrary intent senders, it should require
2279 * the sender to hold certain permissions so only trusted sender's broadcast will be
2280 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002281 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002282 */
2283 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002284 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002285
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002286 /**
2287 * Broadcast Action: hook for permforming cleanup after a system update.
2288 *
2289 * The broadcast is sent when the system is booting, before the
2290 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2291 * image. A receiver for this should do its work and then disable itself
2292 * so that it does not get run again at the next boot.
2293 * @hide
2294 */
2295 public static final String ACTION_PRE_BOOT_COMPLETED =
2296 "android.intent.action.PRE_BOOT_COMPLETED";
2297
Amith Yamasani13593602012-03-22 16:16:17 -07002298 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002299 * Sent the first time a user is starting, to allow system apps to
2300 * perform one time initialization. (This will not be seen by third
2301 * party applications because a newly initialized user does not have any
2302 * third party applications installed for it.) This is sent early in
2303 * starting the user, around the time the home app is started, before
2304 * {@link #ACTION_BOOT_COMPLETED} is sent.
2305 */
2306 public static final String ACTION_USER_INITIALIZE =
2307 "android.intent.action.USER_INITIALIZE";
2308
2309 /**
2310 * Sent when a user switch is happening, causing the process's user to be
2311 * brought to the foreground. This is only sent to receivers registered
2312 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2313 * Context.registerReceiver}. It is sent to the user that is going to the
2314 * foreground.
2315 */
2316 public static final String ACTION_USER_FOREGROUND =
2317 "android.intent.action.USER_FOREGROUND";
2318
2319 /**
2320 * Sent when a user switch is happening, causing the process's user to be
2321 * sent to the background. This is only sent to receivers registered
2322 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2323 * Context.registerReceiver}. It is sent to the user that is going to the
2324 * background.
2325 */
2326 public static final String ACTION_USER_BACKGROUND =
2327 "android.intent.action.USER_BACKGROUND";
2328
2329 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002330 * 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 -07002331 * userHandle of the new user. It is sent to all running users. You must hold
2332 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002333 * @hide
2334 */
2335 public static final String ACTION_USER_ADDED =
2336 "android.intent.action.USER_ADDED";
2337
2338 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002339 * Broadcast sent to the system when a user is started. Carries an extra EXTRA_USER_HANDLE that has
2340 * the userHandle of the user. This is only sent to
2341 * registered receivers, not manifest receivers. It is sent to the user
2342 * that has been started.
2343 * @hide
2344 */
2345 public static final String ACTION_USER_STARTED =
2346 "android.intent.action.USER_STARTED";
2347
2348 /**
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002349 * Broadcast sent to the system when a user is stopped. Carries an extra EXTRA_USER_HANDLE that has
2350 * the userHandle of the user. This is similar to {@link #ACTION_PACKAGE_RESTARTED},
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002351 * but for an entire user instead of a specific package. This is only sent to
2352 * registered receivers, not manifest receivers. It is sent to all running
2353 * users <em>except</em> the one that has just been stopped (which is no
2354 * longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002355 * @hide
2356 */
2357 public static final String ACTION_USER_STOPPED =
2358 "android.intent.action.USER_STOPPED";
2359
2360 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002361 * 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 -07002362 * the userHandle of the user. It is sent to all running users except the
2363 * one that has been removed. You must hold
2364 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002365 * @hide
2366 */
2367 public static final String ACTION_USER_REMOVED =
2368 "android.intent.action.USER_REMOVED";
2369
2370 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002371 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002372 * the userHandle of the user to become the current one. This is only sent to
2373 * registered receivers, not manifest receivers. It is sent to all running users.
2374 * You must hold
2375 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002376 * @hide
2377 */
2378 public static final String ACTION_USER_SWITCHED =
2379 "android.intent.action.USER_SWITCHED";
2380
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002381 /**
2382 * Broadcast sent to the system when a user's information changes. Carries an extra
2383 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2384 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2385 * whose information has changed.
2386 * @hide
2387 */
2388 public static final String ACTION_USER_INFO_CHANGED =
2389 "android.intent.action.USER_INFO_CHANGED";
2390
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002391 // ---------------------------------------------------------------------
2392 // ---------------------------------------------------------------------
2393 // Standard intent categories (see addCategory()).
2394
2395 /**
2396 * Set if the activity should be an option for the default action
2397 * (center press) to perform on a piece of data. Setting this will
2398 * hide from the user any activities without it set when performing an
2399 * action on some data. Note that this is normal -not- set in the
2400 * Intent when initiating an action -- it is for use in intent filters
2401 * specified in packages.
2402 */
2403 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2404 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2405 /**
2406 * Activities that can be safely invoked from a browser must support this
2407 * category. For example, if the user is viewing a web page or an e-mail
2408 * and clicks on a link in the text, the Intent generated execute that
2409 * link will require the BROWSABLE category, so that only activities
2410 * supporting this category will be considered as possible actions. By
2411 * supporting this category, you are promising that there is nothing
2412 * damaging (without user intervention) that can happen by invoking any
2413 * matching Intent.
2414 */
2415 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2416 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2417 /**
2418 * Set if the activity should be considered as an alternative action to
2419 * the data the user is currently viewing. See also
2420 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2421 * applies to the selection in a list of items.
2422 *
2423 * <p>Supporting this category means that you would like your activity to be
2424 * displayed in the set of alternative things the user can do, usually as
2425 * part of the current activity's options menu. You will usually want to
2426 * include a specific label in the &lt;intent-filter&gt; of this action
2427 * describing to the user what it does.
2428 *
2429 * <p>The action of IntentFilter with this category is important in that it
2430 * describes the specific action the target will perform. This generally
2431 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2432 * a specific name such as "com.android.camera.action.CROP. Only one
2433 * alternative of any particular action will be shown to the user, so using
2434 * a specific action like this makes sure that your alternative will be
2435 * displayed while also allowing other applications to provide their own
2436 * overrides of that particular action.
2437 */
2438 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2439 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2440 /**
2441 * Set if the activity should be considered as an alternative selection
2442 * action to the data the user has currently selected. This is like
2443 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2444 * of items from which the user can select, giving them alternatives to the
2445 * default action that will be performed on it.
2446 */
2447 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2448 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2449 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002450 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002451 */
2452 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2453 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2454 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002455 * Should be displayed in the top-level launcher.
2456 */
2457 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2458 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2459 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002460 * Provides information about the package it is in; typically used if
2461 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2462 * a front-door to the user without having to be shown in the all apps list.
2463 */
2464 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2465 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2466 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002467 * This is the home activity, that is the first activity that is displayed
2468 * when the device boots.
2469 */
2470 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2471 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2472 /**
2473 * This activity is a preference panel.
2474 */
2475 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2476 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2477 /**
2478 * This activity is a development preference panel.
2479 */
2480 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2481 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2482 /**
2483 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002484 */
2485 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2486 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2487 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002488 * This activity allows the user to browse and download new applications.
2489 */
2490 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2491 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2492 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002493 * This activity may be exercised by the monkey or other automated test tools.
2494 */
2495 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2496 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2497 /**
2498 * To be used as a test (not part of the normal user experience).
2499 */
2500 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2501 /**
2502 * To be used as a unit test (run through the Test Harness).
2503 */
2504 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2505 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002506 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002507 * experience).
2508 */
2509 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2510 /**
2511 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2512 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2513 * when queried, though it is allowable for those columns to be blank.
2514 */
2515 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2516 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2517
2518 /**
2519 * To be used as code under test for framework instrumentation tests.
2520 */
2521 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2522 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002523 /**
2524 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002525 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2526 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002527 */
2528 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2529 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2530 /**
2531 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002532 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2533 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002534 */
2535 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2536 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002537 /**
2538 * An activity to run when device is inserted into a analog (low end) dock.
2539 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2540 * information, see {@link android.app.UiModeManager}.
2541 */
2542 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2543 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2544
2545 /**
2546 * An activity to run when device is inserted into a digital (high end) dock.
2547 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2548 * information, see {@link android.app.UiModeManager}.
2549 */
2550 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2551 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002552
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002553 /**
2554 * Used to indicate that the activity can be used in a car environment.
2555 */
2556 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2557 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2558
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002559 // ---------------------------------------------------------------------
2560 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002561 // Application launch intent categories (see addCategory()).
2562
2563 /**
2564 * Used with {@link #ACTION_MAIN} to launch the browser application.
2565 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002566 * <p>NOTE: This should not be used as the primary key of an Intent,
2567 * since it will not result in the app launching with the correct
2568 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002569 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002570 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002571 */
2572 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2573 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2574
2575 /**
2576 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2577 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002578 * <p>NOTE: This should not be used as the primary key of an Intent,
2579 * since it will not result in the app launching with the correct
2580 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002581 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002582 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002583 */
2584 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2585 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2586
2587 /**
2588 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2589 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002590 * <p>NOTE: This should not be used as the primary key of an Intent,
2591 * since it will not result in the app launching with the correct
2592 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002593 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002594 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002595 */
2596 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2597 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2598
2599 /**
2600 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2601 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002602 * <p>NOTE: This should not be used as the primary key of an Intent,
2603 * since it will not result in the app launching with the correct
2604 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002605 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002606 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002607 */
2608 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2609 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2610
2611 /**
2612 * Used with {@link #ACTION_MAIN} to launch the email application.
2613 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002614 * <p>NOTE: This should not be used as the primary key of an Intent,
2615 * since it will not result in the app launching with the correct
2616 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002617 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002618 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002619 */
2620 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2621 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2622
2623 /**
2624 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2625 * The activity should be able to view and manipulate image and video files
2626 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002627 * <p>NOTE: This should not be used as the primary key of an Intent,
2628 * since it will not result in the app launching with the correct
2629 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002630 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002631 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002632 */
2633 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2634 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2635
2636 /**
2637 * Used with {@link #ACTION_MAIN} to launch the maps application.
2638 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002639 * <p>NOTE: This should not be used as the primary key of an Intent,
2640 * since it will not result in the app launching with the correct
2641 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002642 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002643 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002644 */
2645 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2646 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2647
2648 /**
2649 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2650 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002651 * <p>NOTE: This should not be used as the primary key of an Intent,
2652 * since it will not result in the app launching with the correct
2653 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002654 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002655 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002656 */
2657 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2658 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2659
2660 /**
2661 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002662 * The activity should be able to play, browse, or manipulate music files
2663 * stored on the device.
2664 * <p>NOTE: This should not be used as the primary key of an Intent,
2665 * since it will not result in the app launching with the correct
2666 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002667 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002668 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002669 */
2670 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2671 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2672
2673 // ---------------------------------------------------------------------
2674 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002675 // Standard extra data keys.
2676
2677 /**
2678 * The initial data to place in a newly created record. Use with
2679 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2680 * fields as would be given to the underlying ContentProvider.insert()
2681 * call.
2682 */
2683 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2684
2685 /**
2686 * A constant CharSequence that is associated with the Intent, used with
2687 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2688 * this may be a styled CharSequence, so you must use
2689 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2690 * retrieve it.
2691 */
2692 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2693
2694 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002695 * A constant String that is associated with the Intent, used with
2696 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2697 * as HTML formatted text. Note that you <em>must</em> also supply
2698 * {@link #EXTRA_TEXT}.
2699 */
2700 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2701
2702 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002703 * A content: URI holding a stream of data associated with the Intent,
2704 * used with {@link #ACTION_SEND} to supply the data being sent.
2705 */
2706 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2707
2708 /**
2709 * A String[] holding e-mail addresses that should be delivered to.
2710 */
2711 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2712
2713 /**
2714 * A String[] holding e-mail addresses that should be carbon copied.
2715 */
2716 public static final String EXTRA_CC = "android.intent.extra.CC";
2717
2718 /**
2719 * A String[] holding e-mail addresses that should be blind carbon copied.
2720 */
2721 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2722
2723 /**
2724 * A constant string holding the desired subject line of a message.
2725 */
2726 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2727
2728 /**
2729 * An Intent describing the choices you would like shown with
2730 * {@link #ACTION_PICK_ACTIVITY}.
2731 */
2732 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2733
2734 /**
2735 * A CharSequence dialog title to provide to the user when used with a
2736 * {@link #ACTION_CHOOSER}.
2737 */
2738 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2739
2740 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002741 * A Parcelable[] of {@link Intent} or
2742 * {@link android.content.pm.LabeledIntent} objects as set with
2743 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2744 * a the front of the list of choices, when shown to the user with a
2745 * {@link #ACTION_CHOOSER}.
2746 */
2747 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2748
2749 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002750 * A {@link android.view.KeyEvent} object containing the event that
2751 * triggered the creation of the Intent it is in.
2752 */
2753 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2754
2755 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002756 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2757 * before shutting down.
2758 *
2759 * {@hide}
2760 */
2761 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2762
2763 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002764 * 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 -07002765 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2766 * of restarting the application.
2767 */
2768 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2769
2770 /**
2771 * A String holding the phone number originally entered in
2772 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2773 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2774 */
2775 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002776
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002777 /**
2778 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2779 * intents to supply the uid the package had been assigned. Also an optional
2780 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2781 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2782 * purpose.
2783 */
2784 public static final String EXTRA_UID = "android.intent.extra.UID";
2785
2786 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002787 * @hide String array of package names.
2788 */
2789 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2790
2791 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002792 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2793 * intents to indicate whether this represents a full uninstall (removing
2794 * both the code and its data) or a partial uninstall (leaving its data,
2795 * implying that this is an update).
2796 */
2797 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002798
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002799 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002800 * @hide
2801 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2802 * intents to indicate that at this point the package has been removed for
2803 * all users on the device.
2804 */
2805 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2806 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2807
2808 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002809 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2810 * intents to indicate that this is a replacement of the package, so this
2811 * broadcast will immediately be followed by an add broadcast for a
2812 * different version of the same package.
2813 */
2814 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002815
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002816 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002817 * Used as an int extra field in {@link android.app.AlarmManager} intents
2818 * to tell the application being invoked how many pending alarms are being
2819 * delievered with the intent. For one-shot alarms this will always be 1.
2820 * For recurring alarms, this might be greater than 1 if the device was
2821 * asleep or powered off at the time an earlier alarm would have been
2822 * delivered.
2823 */
2824 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002825
Jacek Surazski86b6c532009-05-13 14:38:28 +02002826 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002827 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2828 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002829 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2830 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002831 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2832 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2833 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002834 */
2835 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2836
2837 /**
2838 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2839 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002840 */
2841 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2842
2843 /**
2844 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2845 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002846 */
2847 public static final int EXTRA_DOCK_STATE_DESK = 1;
2848
2849 /**
2850 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2851 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002852 */
2853 public static final int EXTRA_DOCK_STATE_CAR = 2;
2854
2855 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002856 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2857 * to represent that the phone is in a analog (low end) dock.
2858 */
2859 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2860
2861 /**
2862 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2863 * to represent that the phone is in a digital (high end) dock.
2864 */
2865 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2866
2867 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002868 * Boolean that can be supplied as meta-data with a dock activity, to
2869 * indicate that the dock should take over the home key when it is active.
2870 */
2871 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002872
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002873 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002874 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2875 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002876 */
2877 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2878
2879 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002880 * Used in the extra field in the remote intent. It's astring token passed with the
2881 * remote intent.
2882 */
2883 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2884 "android.intent.extra.remote_intent_token";
2885
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002886 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002887 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002888 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002889 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002890 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002891 "android.intent.extra.changed_component_name";
2892
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002893 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002894 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002895 * and contains a string array of all of the components that have changed.
2896 */
2897 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2898 "android.intent.extra.changed_component_name_list";
2899
2900 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002901 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002902 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2903 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002904 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002905 */
2906 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2907 "android.intent.extra.changed_package_list";
2908
2909 /**
2910 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002911 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2912 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002913 * and contains an integer array of uids of all of the components
2914 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002915 */
2916 public static final String EXTRA_CHANGED_UID_LIST =
2917 "android.intent.extra.changed_uid_list";
2918
2919 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002920 * @hide
2921 * Magic extra system code can use when binding, to give a label for
2922 * who it is that has bound to a service. This is an integer giving
2923 * a framework string resource that can be displayed to the user.
2924 */
2925 public static final String EXTRA_CLIENT_LABEL =
2926 "android.intent.extra.client_label";
2927
2928 /**
2929 * @hide
2930 * Magic extra system code can use when binding, to give a PendingIntent object
2931 * that can be launched for the user to disable the system's use of this
2932 * service.
2933 */
2934 public static final String EXTRA_CLIENT_INTENT =
2935 "android.intent.extra.client_intent";
2936
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002937 /**
2938 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2939 * data that is on the local device. This is a boolean extra; the default
2940 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2941 * the user to select media that is already on the device, not requiring it
2942 * be downloaded from a remote service when opened. Another way to look
2943 * at it is that such content should generally have a "_data" column to the
2944 * path of the content on local external storage.
2945 */
2946 public static final String EXTRA_LOCAL_ONLY =
2947 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002948
Amith Yamasani13593602012-03-22 16:16:17 -07002949 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002950 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07002951 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2952 * @hide
2953 */
Amith Yamasani2a003292012-08-14 18:25:45 -07002954 public static final String EXTRA_USER_HANDLE =
2955 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07002956
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002957 // ---------------------------------------------------------------------
2958 // ---------------------------------------------------------------------
2959 // Intent flags (see mFlags variable).
2960
2961 /**
2962 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002963 * perform read operations on the Uri in the Intent's data and any URIs
2964 * specified in its ClipData. When applying to an Intent's ClipData,
2965 * all URIs as well as recursive traversals through data or other ClipData
2966 * in Intent items will be granted; only the grant flags of the top-level
2967 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002968 */
2969 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2970 /**
2971 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002972 * perform write operations on the Uri in the Intent's data and any URIs
2973 * specified in its ClipData. When applying to an Intent's ClipData,
2974 * all URIs as well as recursive traversals through data or other ClipData
2975 * in Intent items will be granted; only the grant flags of the top-level
2976 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002977 */
2978 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2979 /**
2980 * Can be set by the caller to indicate that this Intent is coming from
2981 * a background operation, not from direct user interaction.
2982 */
2983 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2984 /**
2985 * A flag you can enable for debugging: when set, log messages will be
2986 * printed during the resolution of this intent to show you what has
2987 * been found to create the final resolved list.
2988 */
2989 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002990 /**
2991 * If set, this intent will not match any components in packages that
2992 * are currently stopped. If this is not set, then the default behavior
2993 * is to include such applications in the result.
2994 */
2995 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2996 /**
2997 * If set, this intent will always match any components in packages that
2998 * are currently stopped. This is the default behavior when
2999 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3000 * flags are set, this one wins (it allows overriding of exclude for
3001 * places where the framework may automatically set the exclude flag).
3002 */
3003 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003004
3005 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003006 * If set, the new activity is not kept in the history stack. As soon as
3007 * the user navigates away from it, the activity is finished. This may also
3008 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3009 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003010 */
3011 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3012 /**
3013 * If set, the activity will not be launched if it is already running
3014 * at the top of the history stack.
3015 */
3016 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3017 /**
3018 * If set, this activity will become the start of a new task on this
3019 * history stack. A task (from the activity that started it to the
3020 * next task activity) defines an atomic group of activities that the
3021 * user can move to. Tasks can be moved to the foreground and background;
3022 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003023 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003024 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3025 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003026 *
3027 * <p>This flag is generally used by activities that want
3028 * to present a "launcher" style behavior: they give the user a list of
3029 * separate things that can be done, which otherwise run completely
3030 * independently of the activity launching them.
3031 *
3032 * <p>When using this flag, if a task is already running for the activity
3033 * you are now starting, then a new activity will not be started; instead,
3034 * the current task will simply be brought to the front of the screen with
3035 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3036 * to disable this behavior.
3037 *
3038 * <p>This flag can not be used when the caller is requesting a result from
3039 * the activity being launched.
3040 */
3041 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3042 /**
3043 * <strong>Do not use this flag unless you are implementing your own
3044 * top-level application launcher.</strong> Used in conjunction with
3045 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3046 * behavior of bringing an existing task to the foreground. When set,
3047 * a new task is <em>always</em> started to host the Activity for the
3048 * Intent, regardless of whether there is already an existing task running
3049 * the same thing.
3050 *
3051 * <p><strong>Because the default system does not include graphical task management,
3052 * you should not use this flag unless you provide some way for a user to
3053 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003054 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003055 * <p>This flag is ignored if
3056 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3057 *
Scott Main7aee61f2011-02-08 11:25:01 -08003058 * <p>See
3059 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3060 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003061 */
3062 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3063 /**
3064 * If set, and the activity being launched is already running in the
3065 * current task, then instead of launching a new instance of that activity,
3066 * all of the other activities on top of it will be closed and this Intent
3067 * will be delivered to the (now on top) old activity as a new Intent.
3068 *
3069 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3070 * If D calls startActivity() with an Intent that resolves to the component
3071 * of activity B, then C and D will be finished and B receive the given
3072 * Intent, resulting in the stack now being: A, B.
3073 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003074 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003075 * either receive the new intent you are starting here in its
3076 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003077 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003078 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3079 * the same intent, then it will be finished and re-created; for all other
3080 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3081 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003082 *
3083 * <p>This launch mode can also be used to good effect in conjunction with
3084 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3085 * of a task, it will bring any currently running instance of that task
3086 * to the foreground, and then clear it to its root state. This is
3087 * especially useful, for example, when launching an activity from the
3088 * notification manager.
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_CLEAR_TOP = 0x04000000;
3095 /**
3096 * If set and this intent is being used to launch a new activity from an
3097 * existing one, then the reply target of the existing activity will be
3098 * transfered to the new activity. This way the new activity can call
3099 * {@link android.app.Activity#setResult} and have that result sent back to
3100 * the reply target of the original activity.
3101 */
3102 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3103 /**
3104 * If set and this intent is being used to launch a new activity from an
3105 * existing one, the current activity will not be counted as the top
3106 * activity for deciding whether the new intent should be delivered to
3107 * the top instead of starting a new one. The previous activity will
3108 * be used as the top, with the assumption being that the current activity
3109 * will finish itself immediately.
3110 */
3111 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3112 /**
3113 * If set, the new activity is not kept in the list of recently launched
3114 * activities.
3115 */
3116 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3117 /**
3118 * This flag is not normally set by application code, but set for you by
3119 * the system as described in the
3120 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3121 * launchMode} documentation for the singleTask mode.
3122 */
3123 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3124 /**
3125 * If set, and this activity is either being started in a new task or
3126 * bringing to the top an existing task, then it will be launched as
3127 * the front door of the task. This will result in the application of
3128 * any affinities needed to have that task in the proper state (either
3129 * moving activities to or from it), or simply resetting that task to
3130 * its initial state if needed.
3131 */
3132 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3133 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003134 * This flag is not normally set by application code, but set for you by
3135 * the system if this activity is being launched from history
3136 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003137 */
3138 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003139 /**
3140 * If set, this marks a point in the task's activity stack that should
3141 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003142 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003143 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3144 * the user re-launching it from home), this activity and all on top of
3145 * it will be finished so that the user does not return to them, but
3146 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003147 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003148 * <p>This is useful for cases where you have a logical break in your
3149 * application. For example, an e-mail application may have a command
3150 * to view an attachment, which launches an image view activity to
3151 * display it. This activity should be part of the e-mail application's
3152 * task, since it is a part of the task the user is involved in. However,
3153 * if the user leaves that task, and later selects the e-mail app from
3154 * home, we may like them to return to the conversation they were
3155 * viewing, not the picture attachment, since that is confusing. By
3156 * setting this flag when launching the image viewer, that viewer and
3157 * any activities it starts will be removed the next time the user returns
3158 * to mail.
3159 */
3160 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003161 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003162 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003163 * callback from occurring on the current frontmost activity before it is
3164 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003165 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003166 * <p>Typically, an activity can rely on that callback to indicate that an
3167 * explicit user action has caused their activity to be moved out of the
3168 * foreground. The callback marks an appropriate point in the activity's
3169 * lifecycle for it to dismiss any notifications that it intends to display
3170 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003171 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003172 * <p>If an activity is ever started via any non-user-driven events such as
3173 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3174 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003175 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003176 */
3177 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003178 /**
3179 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3180 * this flag will cause the launched activity to be brought to the front of its
3181 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003182 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003183 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3184 * If D calls startActivity() with an Intent that resolves to the component
3185 * of activity B, then B will be brought to the front of the history stack,
3186 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003187 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003188 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003189 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003190 */
3191 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003192 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003193 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3194 * this flag will prevent the system from applying an activity transition
3195 * animation to go to the next activity state. This doesn't mean an
3196 * animation will never run -- if another activity change happens that doesn't
3197 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003198 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003199 * when you are going to do a series of activity operations but the
3200 * animation seen by the user shouldn't be driven by the first activity
3201 * change but rather a later one.
3202 */
3203 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3204 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003205 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3206 * this flag will cause any existing task that would be associated with the
3207 * activity to be cleared before the activity is started. That is, the activity
3208 * becomes the new root of an otherwise empty task, and any old activities
3209 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3210 */
3211 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3212 /**
3213 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3214 * this flag will cause a newly launching task to be placed on top of the current
3215 * home activity task (if there is one). That is, pressing back from the task
3216 * will always return the user to home even if that was not the last activity they
3217 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3218 */
3219 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3220 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003221 * If set, when sending a broadcast only registered receivers will be
3222 * called -- no BroadcastReceiver components will be launched.
3223 */
3224 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003225 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003226 * If set, when sending a broadcast the new broadcast will replace
3227 * any existing pending broadcast that matches it. Matching is defined
3228 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3229 * true for the intents of the two broadcasts. When a match is found,
3230 * the new broadcast (and receivers associated with it) will replace the
3231 * existing one in the pending broadcast list, remaining at the same
3232 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003233 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003234 * <p>This flag is most typically used with sticky broadcasts, which
3235 * only care about delivering the most recent values of the broadcast
3236 * to their receivers.
3237 */
3238 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3239 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003240 * If set, when sending a broadcast the recipient is allowed to run at
3241 * foreground priority, with a shorter timeout interval. During normal
3242 * broadcasts the receivers are not automatically hoisted out of the
3243 * background priority class.
3244 */
3245 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3246 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003247 * If set, when sending a broadcast <i>before boot has completed</i> only
3248 * registered receivers will be called -- no BroadcastReceiver components
3249 * will be launched. Sticky intent state will be recorded properly even
3250 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3251 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003252 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003253 * <p>This flag is only for use by system sevices as a convenience to
3254 * avoid having to implement a more complex mechanism around detection
3255 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003256 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003257 * @hide
3258 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003259 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003260 /**
3261 * Set when this broadcast is for a boot upgrade, a special mode that
3262 * allows the broadcast to be sent before the system is ready and launches
3263 * the app process with no providers running in it.
3264 * @hide
3265 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003266 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003267
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003268 /**
3269 * @hide Flags that can't be changed with PendingIntent.
3270 */
3271 public static final int IMMUTABLE_FLAGS =
3272 FLAG_GRANT_READ_URI_PERMISSION
3273 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003274
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003275 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003276 // ---------------------------------------------------------------------
3277 // toUri() and parseUri() options.
3278
3279 /**
3280 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3281 * always has the "intent:" scheme. This syntax can be used when you want
3282 * to later disambiguate between URIs that are intended to describe an
3283 * Intent vs. all others that should be treated as raw URIs. When used
3284 * with {@link #parseUri}, any other scheme will result in a generic
3285 * VIEW action for that raw URI.
3286 */
3287 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003288
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003289 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003290
3291 private String mAction;
3292 private Uri mData;
3293 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003294 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003295 private ComponentName mComponent;
3296 private int mFlags;
3297 private HashSet<String> mCategories;
3298 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003299 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003300 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003301 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003302
3303 // ---------------------------------------------------------------------
3304
3305 /**
3306 * Create an empty intent.
3307 */
3308 public Intent() {
3309 }
3310
3311 /**
3312 * Copy constructor.
3313 */
3314 public Intent(Intent o) {
3315 this.mAction = o.mAction;
3316 this.mData = o.mData;
3317 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003318 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003319 this.mComponent = o.mComponent;
3320 this.mFlags = o.mFlags;
3321 if (o.mCategories != null) {
3322 this.mCategories = new HashSet<String>(o.mCategories);
3323 }
3324 if (o.mExtras != null) {
3325 this.mExtras = new Bundle(o.mExtras);
3326 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003327 if (o.mSourceBounds != null) {
3328 this.mSourceBounds = new Rect(o.mSourceBounds);
3329 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003330 if (o.mSelector != null) {
3331 this.mSelector = new Intent(o.mSelector);
3332 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003333 if (o.mClipData != null) {
3334 this.mClipData = new ClipData(o.mClipData);
3335 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003336 }
3337
3338 @Override
3339 public Object clone() {
3340 return new Intent(this);
3341 }
3342
3343 private Intent(Intent o, boolean all) {
3344 this.mAction = o.mAction;
3345 this.mData = o.mData;
3346 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003347 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003348 this.mComponent = o.mComponent;
3349 if (o.mCategories != null) {
3350 this.mCategories = new HashSet<String>(o.mCategories);
3351 }
3352 }
3353
3354 /**
3355 * Make a clone of only the parts of the Intent that are relevant for
3356 * filter matching: the action, data, type, component, and categories.
3357 */
3358 public Intent cloneFilter() {
3359 return new Intent(this, false);
3360 }
3361
3362 /**
3363 * Create an intent with a given action. All other fields (data, type,
3364 * class) are null. Note that the action <em>must</em> be in a
3365 * namespace because Intents are used globally in the system -- for
3366 * example the system VIEW action is android.intent.action.VIEW; an
3367 * application's custom action would be something like
3368 * com.google.app.myapp.CUSTOM_ACTION.
3369 *
3370 * @param action The Intent action, such as ACTION_VIEW.
3371 */
3372 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003373 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003374 }
3375
3376 /**
3377 * Create an intent with a given action and for a given data url. Note
3378 * that the action <em>must</em> be in a namespace because Intents are
3379 * used globally in the system -- for example the system VIEW action is
3380 * android.intent.action.VIEW; an application's custom action would be
3381 * something like com.google.app.myapp.CUSTOM_ACTION.
3382 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003383 * <p><em>Note: scheme and host name matching in the Android framework is
3384 * case-sensitive, unlike the formal RFC. As a result,
3385 * you should always ensure that you write your Uri with these elements
3386 * using lower case letters, and normalize any Uris you receive from
3387 * outside of Android to ensure the scheme and host is lower case.</em></p>
3388 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003389 * @param action The Intent action, such as ACTION_VIEW.
3390 * @param uri The Intent data URI.
3391 */
3392 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003393 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003394 mData = uri;
3395 }
3396
3397 /**
3398 * Create an intent for a specific component. All other fields (action, data,
3399 * type, class) are null, though they can be modified later with explicit
3400 * calls. This provides a convenient way to create an intent that is
3401 * intended to execute a hard-coded class name, rather than relying on the
3402 * system to find an appropriate class for you; see {@link #setComponent}
3403 * for more information on the repercussions of this.
3404 *
3405 * @param packageContext A Context of the application package implementing
3406 * this class.
3407 * @param cls The component class that is to be used for the intent.
3408 *
3409 * @see #setClass
3410 * @see #setComponent
3411 * @see #Intent(String, android.net.Uri , Context, Class)
3412 */
3413 public Intent(Context packageContext, Class<?> cls) {
3414 mComponent = new ComponentName(packageContext, cls);
3415 }
3416
3417 /**
3418 * Create an intent for a specific component with a specified action and data.
3419 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3420 * construct the Intent and then calling {@link #setClass} to set its
3421 * class.
3422 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003423 * <p><em>Note: scheme and host name matching in the Android framework is
3424 * case-sensitive, unlike the formal RFC. As a result,
3425 * you should always ensure that you write your Uri with these elements
3426 * using lower case letters, and normalize any Uris you receive from
3427 * outside of Android to ensure the scheme and host is lower case.</em></p>
3428 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003429 * @param action The Intent action, such as ACTION_VIEW.
3430 * @param uri The Intent data URI.
3431 * @param packageContext A Context of the application package implementing
3432 * this class.
3433 * @param cls The component class that is to be used for the intent.
3434 *
3435 * @see #Intent(String, android.net.Uri)
3436 * @see #Intent(Context, Class)
3437 * @see #setClass
3438 * @see #setComponent
3439 */
3440 public Intent(String action, Uri uri,
3441 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003442 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003443 mData = uri;
3444 mComponent = new ComponentName(packageContext, cls);
3445 }
3446
3447 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003448 * Create an intent to launch the main (root) activity of a task. This
3449 * is the Intent that is started when the application's is launched from
3450 * Home. For anything else that wants to launch an application in the
3451 * same way, it is important that they use an Intent structured the same
3452 * way, and can use this function to ensure this is the case.
3453 *
3454 * <p>The returned Intent has the given Activity component as its explicit
3455 * component, {@link #ACTION_MAIN} as its action, and includes the
3456 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3457 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3458 * to do that through {@link #addFlags(int)} on the returned Intent.
3459 *
3460 * @param mainActivity The main activity component that this Intent will
3461 * launch.
3462 * @return Returns a newly created Intent that can be used to launch the
3463 * activity as a main application entry.
3464 *
3465 * @see #setClass
3466 * @see #setComponent
3467 */
3468 public static Intent makeMainActivity(ComponentName mainActivity) {
3469 Intent intent = new Intent(ACTION_MAIN);
3470 intent.setComponent(mainActivity);
3471 intent.addCategory(CATEGORY_LAUNCHER);
3472 return intent;
3473 }
3474
3475 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003476 * Make an Intent for the main activity of an application, without
3477 * specifying a specific activity to run but giving a selector to find
3478 * the activity. This results in a final Intent that is structured
3479 * the same as when the application is launched from
3480 * Home. For anything else that wants to launch an application in the
3481 * same way, it is important that they use an Intent structured the same
3482 * way, and can use this function to ensure this is the case.
3483 *
3484 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3485 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3486 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3487 * to do that through {@link #addFlags(int)} on the returned Intent.
3488 *
3489 * @param selectorAction The action name of the Intent's selector.
3490 * @param selectorCategory The name of a category to add to the Intent's
3491 * selector.
3492 * @return Returns a newly created Intent that can be used to launch the
3493 * activity as a main application entry.
3494 *
3495 * @see #setSelector(Intent)
3496 */
3497 public static Intent makeMainSelectorActivity(String selectorAction,
3498 String selectorCategory) {
3499 Intent intent = new Intent(ACTION_MAIN);
3500 intent.addCategory(CATEGORY_LAUNCHER);
3501 Intent selector = new Intent();
3502 selector.setAction(selectorAction);
3503 selector.addCategory(selectorCategory);
3504 intent.setSelector(selector);
3505 return intent;
3506 }
3507
3508 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003509 * Make an Intent that can be used to re-launch an application's task
3510 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3511 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3512 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3513 *
3514 * @param mainActivity The activity component that is the root of the
3515 * task; this is the activity that has been published in the application's
3516 * manifest as the main launcher icon.
3517 *
3518 * @return Returns a newly created Intent that can be used to relaunch the
3519 * activity's task in its root state.
3520 */
3521 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3522 Intent intent = makeMainActivity(mainActivity);
3523 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3524 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3525 return intent;
3526 }
3527
3528 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003529 * Call {@link #parseUri} with 0 flags.
3530 * @deprecated Use {@link #parseUri} instead.
3531 */
3532 @Deprecated
3533 public static Intent getIntent(String uri) throws URISyntaxException {
3534 return parseUri(uri, 0);
3535 }
Tom Taylord4a47292009-12-21 13:59:18 -08003536
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003537 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003538 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003539 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003540 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003541 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003542 *
3543 * <p>The URI given here must not be relative -- that is, it must include
3544 * the scheme and full path.
3545 *
3546 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003547 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003548 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003549 *
3550 * @return Intent The newly created Intent object.
3551 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003552 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3553 * it bad (as parsed by the Uri class) or the Intent data within the
3554 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003555 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003556 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003557 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003558 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003559 int i = 0;
3560 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003561 // Validate intent scheme for if requested.
3562 if ((flags&URI_INTENT_SCHEME) != 0) {
3563 if (!uri.startsWith("intent:")) {
3564 Intent intent = new Intent(ACTION_VIEW);
3565 try {
3566 intent.setData(Uri.parse(uri));
3567 } catch (IllegalArgumentException e) {
3568 throw new URISyntaxException(uri, e.getMessage());
3569 }
3570 return intent;
3571 }
3572 }
Tom Taylord4a47292009-12-21 13:59:18 -08003573
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003574 // simple case
3575 i = uri.lastIndexOf("#");
3576 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3577
3578 // old format Intent URI
3579 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003580
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003581 // new format
3582 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003583 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003584
3585 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003586 String data = i >= 0 ? uri.substring(0, i) : null;
3587 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003588 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003589
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003590 // loop over contents of Intent, all name=value;
3591 while (!uri.startsWith("end", i)) {
3592 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003593 if (eq < 0) eq = i-1;
3594 int semi = uri.indexOf(';', i);
3595 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003596
3597 // action
3598 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003599 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003600 }
3601
3602 // categories
3603 else if (uri.startsWith("category=", i)) {
3604 intent.addCategory(value);
3605 }
3606
3607 // type
3608 else if (uri.startsWith("type=", i)) {
3609 intent.mType = value;
3610 }
3611
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003612 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 else if (uri.startsWith("launchFlags=", i)) {
3614 intent.mFlags = Integer.decode(value).intValue();
3615 }
3616
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003617 // package
3618 else if (uri.startsWith("package=", i)) {
3619 intent.mPackage = value;
3620 }
3621
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003622 // component
3623 else if (uri.startsWith("component=", i)) {
3624 intent.mComponent = ComponentName.unflattenFromString(value);
3625 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003626
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003627 // scheme
3628 else if (uri.startsWith("scheme=", i)) {
3629 scheme = value;
3630 }
3631
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003632 // source bounds
3633 else if (uri.startsWith("sourceBounds=", i)) {
3634 intent.mSourceBounds = Rect.unflattenFromString(value);
3635 }
3636
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003637 // selector
3638 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3639 intent = new Intent();
3640 }
3641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003642 // extra
3643 else {
3644 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003645 // create Bundle if it doesn't already exist
3646 if (intent.mExtras == null) intent.mExtras = new Bundle();
3647 Bundle b = intent.mExtras;
3648 // add EXTRA
3649 if (uri.startsWith("S.", i)) b.putString(key, value);
3650 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3651 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3652 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3653 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3654 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3655 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3656 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3657 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3658 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3659 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003661 // move to the next item
3662 i = semi + 1;
3663 }
3664
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003665 if (intent != baseIntent) {
3666 // The Intent had a selector; fix it up.
3667 baseIntent.setSelector(intent);
3668 intent = baseIntent;
3669 }
3670
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003671 if (data != null) {
3672 if (data.startsWith("intent:")) {
3673 data = data.substring(7);
3674 if (scheme != null) {
3675 data = scheme + ':' + data;
3676 }
3677 }
Tom Taylord4a47292009-12-21 13:59:18 -08003678
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003679 if (data.length() > 0) {
3680 try {
3681 intent.mData = Uri.parse(data);
3682 } catch (IllegalArgumentException e) {
3683 throw new URISyntaxException(uri, e.getMessage());
3684 }
3685 }
3686 }
Tom Taylord4a47292009-12-21 13:59:18 -08003687
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003688 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003689
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003690 } catch (IndexOutOfBoundsException e) {
3691 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3692 }
3693 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003694
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003695 public static Intent getIntentOld(String uri) throws URISyntaxException {
3696 Intent intent;
3697
3698 int i = uri.lastIndexOf('#');
3699 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003700 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003701 final int intentFragmentStart = i;
3702 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003703
3704 i++;
3705
3706 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003707 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003708 i += 7;
3709 int j = uri.indexOf(')', i);
3710 action = uri.substring(i, j);
3711 i = j + 1;
3712 }
3713
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003714 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003715
3716 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003717 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003718 i += 11;
3719 int j = uri.indexOf(')', i);
3720 while (i < j) {
3721 int sep = uri.indexOf('!', i);
3722 if (sep < 0) sep = j;
3723 if (i < sep) {
3724 intent.addCategory(uri.substring(i, sep));
3725 }
3726 i = sep + 1;
3727 }
3728 i = j + 1;
3729 }
3730
3731 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003732 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003733 i += 5;
3734 int j = uri.indexOf(')', i);
3735 intent.mType = uri.substring(i, j);
3736 i = j + 1;
3737 }
3738
3739 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003740 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003741 i += 12;
3742 int j = uri.indexOf(')', i);
3743 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3744 i = j + 1;
3745 }
3746
3747 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003748 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003749 i += 10;
3750 int j = uri.indexOf(')', i);
3751 int sep = uri.indexOf('!', i);
3752 if (sep >= 0 && sep < j) {
3753 String pkg = uri.substring(i, sep);
3754 String cls = uri.substring(sep + 1, j);
3755 intent.mComponent = new ComponentName(pkg, cls);
3756 }
3757 i = j + 1;
3758 }
3759
3760 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003761 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003762 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003763
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003764 final int closeParen = uri.indexOf(')', i);
3765 if (closeParen == -1) throw new URISyntaxException(uri,
3766 "EXTRA missing trailing ')'", i);
3767
3768 while (i < closeParen) {
3769 // fetch the key value
3770 int j = uri.indexOf('=', i);
3771 if (j <= i + 1 || i >= closeParen) {
3772 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3773 }
3774 char type = uri.charAt(i);
3775 i++;
3776 String key = uri.substring(i, j);
3777 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003778
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003779 // get type-value
3780 j = uri.indexOf('!', i);
3781 if (j == -1 || j >= closeParen) j = closeParen;
3782 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3783 String value = uri.substring(i, j);
3784 i = j;
3785
3786 // create Bundle if it doesn't already exist
3787 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003788
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003789 // add item to bundle
3790 try {
3791 switch (type) {
3792 case 'S':
3793 intent.mExtras.putString(key, Uri.decode(value));
3794 break;
3795 case 'B':
3796 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3797 break;
3798 case 'b':
3799 intent.mExtras.putByte(key, Byte.parseByte(value));
3800 break;
3801 case 'c':
3802 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3803 break;
3804 case 'd':
3805 intent.mExtras.putDouble(key, Double.parseDouble(value));
3806 break;
3807 case 'f':
3808 intent.mExtras.putFloat(key, Float.parseFloat(value));
3809 break;
3810 case 'i':
3811 intent.mExtras.putInt(key, Integer.parseInt(value));
3812 break;
3813 case 'l':
3814 intent.mExtras.putLong(key, Long.parseLong(value));
3815 break;
3816 case 's':
3817 intent.mExtras.putShort(key, Short.parseShort(value));
3818 break;
3819 default:
3820 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3821 }
3822 } catch (NumberFormatException e) {
3823 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3824 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003825
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003826 char ch = uri.charAt(i);
3827 if (ch == ')') break;
3828 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3829 i++;
3830 }
3831 }
3832
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003833 if (isIntentFragment) {
3834 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3835 } else {
3836 intent.mData = Uri.parse(uri);
3837 }
Tom Taylord4a47292009-12-21 13:59:18 -08003838
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003839 if (intent.mAction == null) {
3840 // By default, if no action is specified, then use VIEW.
3841 intent.mAction = ACTION_VIEW;
3842 }
3843
3844 } else {
3845 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3846 }
3847
3848 return intent;
3849 }
3850
3851 /**
3852 * Retrieve the general action to be performed, such as
3853 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3854 * the information in the intent should be interpreted -- most importantly,
3855 * what to do with the data returned by {@link #getData}.
3856 *
3857 * @return The action of this intent or null if none is specified.
3858 *
3859 * @see #setAction
3860 */
3861 public String getAction() {
3862 return mAction;
3863 }
3864
3865 /**
3866 * Retrieve data this intent is operating on. This URI specifies the name
3867 * of the data; often it uses the content: scheme, specifying data in a
3868 * content provider. Other schemes may be handled by specific activities,
3869 * such as http: by the web browser.
3870 *
3871 * @return The URI of the data this intent is targeting or null.
3872 *
3873 * @see #getScheme
3874 * @see #setData
3875 */
3876 public Uri getData() {
3877 return mData;
3878 }
3879
3880 /**
3881 * The same as {@link #getData()}, but returns the URI as an encoded
3882 * String.
3883 */
3884 public String getDataString() {
3885 return mData != null ? mData.toString() : null;
3886 }
3887
3888 /**
3889 * Return the scheme portion of the intent's data. If the data is null or
3890 * does not include a scheme, null is returned. Otherwise, the scheme
3891 * prefix without the final ':' is returned, i.e. "http".
3892 *
3893 * <p>This is the same as calling getData().getScheme() (and checking for
3894 * null data).
3895 *
3896 * @return The scheme of this intent.
3897 *
3898 * @see #getData
3899 */
3900 public String getScheme() {
3901 return mData != null ? mData.getScheme() : null;
3902 }
3903
3904 /**
3905 * Retrieve any explicit MIME type included in the intent. This is usually
3906 * null, as the type is determined by the intent data.
3907 *
3908 * @return If a type was manually set, it is returned; else null is
3909 * returned.
3910 *
3911 * @see #resolveType(ContentResolver)
3912 * @see #setType
3913 */
3914 public String getType() {
3915 return mType;
3916 }
3917
3918 /**
3919 * Return the MIME data type of this intent. If the type field is
3920 * explicitly set, that is simply returned. Otherwise, if the data is set,
3921 * the type of that data is returned. If neither fields are set, a null is
3922 * returned.
3923 *
3924 * @return The MIME type of this intent.
3925 *
3926 * @see #getType
3927 * @see #resolveType(ContentResolver)
3928 */
3929 public String resolveType(Context context) {
3930 return resolveType(context.getContentResolver());
3931 }
3932
3933 /**
3934 * Return the MIME data type of this intent. If the type field is
3935 * explicitly set, that is simply returned. Otherwise, if the data is set,
3936 * the type of that data is returned. If neither fields are set, a null is
3937 * returned.
3938 *
3939 * @param resolver A ContentResolver that can be used to determine the MIME
3940 * type of the intent's data.
3941 *
3942 * @return The MIME type of this intent.
3943 *
3944 * @see #getType
3945 * @see #resolveType(Context)
3946 */
3947 public String resolveType(ContentResolver resolver) {
3948 if (mType != null) {
3949 return mType;
3950 }
3951 if (mData != null) {
3952 if ("content".equals(mData.getScheme())) {
3953 return resolver.getType(mData);
3954 }
3955 }
3956 return null;
3957 }
3958
3959 /**
3960 * Return the MIME data type of this intent, only if it will be needed for
3961 * intent resolution. This is not generally useful for application code;
3962 * it is used by the frameworks for communicating with back-end system
3963 * services.
3964 *
3965 * @param resolver A ContentResolver that can be used to determine the MIME
3966 * type of the intent's data.
3967 *
3968 * @return The MIME type of this intent, or null if it is unknown or not
3969 * needed.
3970 */
3971 public String resolveTypeIfNeeded(ContentResolver resolver) {
3972 if (mComponent != null) {
3973 return mType;
3974 }
3975 return resolveType(resolver);
3976 }
3977
3978 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003979 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003980 *
3981 * @param category The category to check.
3982 *
3983 * @return boolean True if the intent contains the category, else false.
3984 *
3985 * @see #getCategories
3986 * @see #addCategory
3987 */
3988 public boolean hasCategory(String category) {
3989 return mCategories != null && mCategories.contains(category);
3990 }
3991
3992 /**
3993 * Return the set of all categories in the intent. If there are no categories,
3994 * returns NULL.
3995 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003996 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003997 *
3998 * @see #hasCategory
3999 * @see #addCategory
4000 */
4001 public Set<String> getCategories() {
4002 return mCategories;
4003 }
4004
4005 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004006 * Return the specific selector associated with this Intent. If there is
4007 * none, returns null. See {@link #setSelector} for more information.
4008 *
4009 * @see #setSelector
4010 */
4011 public Intent getSelector() {
4012 return mSelector;
4013 }
4014
4015 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004016 * Return the {@link ClipData} associated with this Intent. If there is
4017 * none, returns null. See {@link #setClipData} for more information.
4018 *
4019 * @see #setClipData;
4020 */
4021 public ClipData getClipData() {
4022 return mClipData;
4023 }
4024
4025 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004026 * Sets the ClassLoader that will be used when unmarshalling
4027 * any Parcelable values from the extras of this Intent.
4028 *
4029 * @param loader a ClassLoader, or null to use the default loader
4030 * at the time of unmarshalling.
4031 */
4032 public void setExtrasClassLoader(ClassLoader loader) {
4033 if (mExtras != null) {
4034 mExtras.setClassLoader(loader);
4035 }
4036 }
4037
4038 /**
4039 * Returns true if an extra value is associated with the given name.
4040 * @param name the extra's name
4041 * @return true if the given extra is present.
4042 */
4043 public boolean hasExtra(String name) {
4044 return mExtras != null && mExtras.containsKey(name);
4045 }
4046
4047 /**
4048 * Returns true if the Intent's extras contain a parcelled file descriptor.
4049 * @return true if the Intent contains a parcelled file descriptor.
4050 */
4051 public boolean hasFileDescriptors() {
4052 return mExtras != null && mExtras.hasFileDescriptors();
4053 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004054
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004055 /** @hide */
4056 public void setAllowFds(boolean allowFds) {
4057 if (mExtras != null) {
4058 mExtras.setAllowFds(allowFds);
4059 }
4060 }
4061
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004062 /**
4063 * Retrieve extended data from the intent.
4064 *
4065 * @param name The name of the desired item.
4066 *
4067 * @return the value of an item that previously added with putExtra()
4068 * or null if none was found.
4069 *
4070 * @deprecated
4071 * @hide
4072 */
4073 @Deprecated
4074 public Object getExtra(String name) {
4075 return getExtra(name, null);
4076 }
4077
4078 /**
4079 * Retrieve extended data from the intent.
4080 *
4081 * @param name The name of the desired item.
4082 * @param defaultValue the value to be returned if no value of the desired
4083 * type is stored with the given name.
4084 *
4085 * @return the value of an item that previously added with putExtra()
4086 * or the default value if none was found.
4087 *
4088 * @see #putExtra(String, boolean)
4089 */
4090 public boolean getBooleanExtra(String name, boolean defaultValue) {
4091 return mExtras == null ? defaultValue :
4092 mExtras.getBoolean(name, defaultValue);
4093 }
4094
4095 /**
4096 * Retrieve extended data from the intent.
4097 *
4098 * @param name The name of the desired item.
4099 * @param defaultValue the value to be returned if no value of the desired
4100 * type is stored with the given name.
4101 *
4102 * @return the value of an item that previously added with putExtra()
4103 * or the default value if none was found.
4104 *
4105 * @see #putExtra(String, byte)
4106 */
4107 public byte getByteExtra(String name, byte defaultValue) {
4108 return mExtras == null ? defaultValue :
4109 mExtras.getByte(name, defaultValue);
4110 }
4111
4112 /**
4113 * Retrieve extended data from the intent.
4114 *
4115 * @param name The name of the desired item.
4116 * @param defaultValue the value to be returned if no value of the desired
4117 * type is stored with the given name.
4118 *
4119 * @return the value of an item that previously added with putExtra()
4120 * or the default value if none was found.
4121 *
4122 * @see #putExtra(String, short)
4123 */
4124 public short getShortExtra(String name, short defaultValue) {
4125 return mExtras == null ? defaultValue :
4126 mExtras.getShort(name, defaultValue);
4127 }
4128
4129 /**
4130 * Retrieve extended data from the intent.
4131 *
4132 * @param name The name of the desired item.
4133 * @param defaultValue the value to be returned if no value of the desired
4134 * type is stored with the given name.
4135 *
4136 * @return the value of an item that previously added with putExtra()
4137 * or the default value if none was found.
4138 *
4139 * @see #putExtra(String, char)
4140 */
4141 public char getCharExtra(String name, char defaultValue) {
4142 return mExtras == null ? defaultValue :
4143 mExtras.getChar(name, defaultValue);
4144 }
4145
4146 /**
4147 * Retrieve extended data from the intent.
4148 *
4149 * @param name The name of the desired item.
4150 * @param defaultValue the value to be returned if no value of the desired
4151 * type is stored with the given name.
4152 *
4153 * @return the value of an item that previously added with putExtra()
4154 * or the default value if none was found.
4155 *
4156 * @see #putExtra(String, int)
4157 */
4158 public int getIntExtra(String name, int defaultValue) {
4159 return mExtras == null ? defaultValue :
4160 mExtras.getInt(name, defaultValue);
4161 }
4162
4163 /**
4164 * Retrieve extended data from the intent.
4165 *
4166 * @param name The name of the desired item.
4167 * @param defaultValue the value to be returned if no value of the desired
4168 * type is stored with the given name.
4169 *
4170 * @return the value of an item that previously added with putExtra()
4171 * or the default value if none was found.
4172 *
4173 * @see #putExtra(String, long)
4174 */
4175 public long getLongExtra(String name, long defaultValue) {
4176 return mExtras == null ? defaultValue :
4177 mExtras.getLong(name, defaultValue);
4178 }
4179
4180 /**
4181 * Retrieve extended data from the intent.
4182 *
4183 * @param name The name of the desired item.
4184 * @param defaultValue the value to be returned if no value of the desired
4185 * type is stored with the given name.
4186 *
4187 * @return the value of an item that previously added with putExtra(),
4188 * or the default value if no such item is present
4189 *
4190 * @see #putExtra(String, float)
4191 */
4192 public float getFloatExtra(String name, float defaultValue) {
4193 return mExtras == null ? defaultValue :
4194 mExtras.getFloat(name, defaultValue);
4195 }
4196
4197 /**
4198 * Retrieve extended data from the intent.
4199 *
4200 * @param name The name of the desired item.
4201 * @param defaultValue the value to be returned if no value of the desired
4202 * type is stored with the given name.
4203 *
4204 * @return the value of an item that previously added with putExtra()
4205 * or the default value if none was found.
4206 *
4207 * @see #putExtra(String, double)
4208 */
4209 public double getDoubleExtra(String name, double defaultValue) {
4210 return mExtras == null ? defaultValue :
4211 mExtras.getDouble(name, defaultValue);
4212 }
4213
4214 /**
4215 * Retrieve extended data from the intent.
4216 *
4217 * @param name The name of the desired item.
4218 *
4219 * @return the value of an item that previously added with putExtra()
4220 * or null if no String value was found.
4221 *
4222 * @see #putExtra(String, String)
4223 */
4224 public String getStringExtra(String name) {
4225 return mExtras == null ? null : mExtras.getString(name);
4226 }
4227
4228 /**
4229 * Retrieve extended data from the intent.
4230 *
4231 * @param name The name of the desired item.
4232 *
4233 * @return the value of an item that previously added with putExtra()
4234 * or null if no CharSequence value was found.
4235 *
4236 * @see #putExtra(String, CharSequence)
4237 */
4238 public CharSequence getCharSequenceExtra(String name) {
4239 return mExtras == null ? null : mExtras.getCharSequence(name);
4240 }
4241
4242 /**
4243 * Retrieve extended data from the intent.
4244 *
4245 * @param name The name of the desired item.
4246 *
4247 * @return the value of an item that previously added with putExtra()
4248 * or null if no Parcelable value was found.
4249 *
4250 * @see #putExtra(String, Parcelable)
4251 */
4252 public <T extends Parcelable> T getParcelableExtra(String name) {
4253 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4254 }
4255
4256 /**
4257 * Retrieve extended data from the intent.
4258 *
4259 * @param name The name of the desired item.
4260 *
4261 * @return the value of an item that previously added with putExtra()
4262 * or null if no Parcelable[] value was found.
4263 *
4264 * @see #putExtra(String, Parcelable[])
4265 */
4266 public Parcelable[] getParcelableArrayExtra(String name) {
4267 return mExtras == null ? null : mExtras.getParcelableArray(name);
4268 }
4269
4270 /**
4271 * Retrieve extended data from the intent.
4272 *
4273 * @param name The name of the desired item.
4274 *
4275 * @return the value of an item that previously added with putExtra()
4276 * or null if no ArrayList<Parcelable> value was found.
4277 *
4278 * @see #putParcelableArrayListExtra(String, ArrayList)
4279 */
4280 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4281 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4282 }
4283
4284 /**
4285 * Retrieve extended data from the intent.
4286 *
4287 * @param name The name of the desired item.
4288 *
4289 * @return the value of an item that previously added with putExtra()
4290 * or null if no Serializable value was found.
4291 *
4292 * @see #putExtra(String, Serializable)
4293 */
4294 public Serializable getSerializableExtra(String name) {
4295 return mExtras == null ? null : mExtras.getSerializable(name);
4296 }
4297
4298 /**
4299 * Retrieve extended data from the intent.
4300 *
4301 * @param name The name of the desired item.
4302 *
4303 * @return the value of an item that previously added with putExtra()
4304 * or null if no ArrayList<Integer> value was found.
4305 *
4306 * @see #putIntegerArrayListExtra(String, ArrayList)
4307 */
4308 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4309 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4310 }
4311
4312 /**
4313 * Retrieve extended data from the intent.
4314 *
4315 * @param name The name of the desired item.
4316 *
4317 * @return the value of an item that previously added with putExtra()
4318 * or null if no ArrayList<String> value was found.
4319 *
4320 * @see #putStringArrayListExtra(String, ArrayList)
4321 */
4322 public ArrayList<String> getStringArrayListExtra(String name) {
4323 return mExtras == null ? null : mExtras.getStringArrayList(name);
4324 }
4325
4326 /**
4327 * Retrieve extended data from the intent.
4328 *
4329 * @param name The name of the desired item.
4330 *
4331 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004332 * or null if no ArrayList<CharSequence> value was found.
4333 *
4334 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4335 */
4336 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4337 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4338 }
4339
4340 /**
4341 * Retrieve extended data from the intent.
4342 *
4343 * @param name The name of the desired item.
4344 *
4345 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004346 * or null if no boolean array value was found.
4347 *
4348 * @see #putExtra(String, boolean[])
4349 */
4350 public boolean[] getBooleanArrayExtra(String name) {
4351 return mExtras == null ? null : mExtras.getBooleanArray(name);
4352 }
4353
4354 /**
4355 * Retrieve extended data from the intent.
4356 *
4357 * @param name The name of the desired item.
4358 *
4359 * @return the value of an item that previously added with putExtra()
4360 * or null if no byte array value was found.
4361 *
4362 * @see #putExtra(String, byte[])
4363 */
4364 public byte[] getByteArrayExtra(String name) {
4365 return mExtras == null ? null : mExtras.getByteArray(name);
4366 }
4367
4368 /**
4369 * Retrieve extended data from the intent.
4370 *
4371 * @param name The name of the desired item.
4372 *
4373 * @return the value of an item that previously added with putExtra()
4374 * or null if no short array value was found.
4375 *
4376 * @see #putExtra(String, short[])
4377 */
4378 public short[] getShortArrayExtra(String name) {
4379 return mExtras == null ? null : mExtras.getShortArray(name);
4380 }
4381
4382 /**
4383 * Retrieve extended data from the intent.
4384 *
4385 * @param name The name of the desired item.
4386 *
4387 * @return the value of an item that previously added with putExtra()
4388 * or null if no char array value was found.
4389 *
4390 * @see #putExtra(String, char[])
4391 */
4392 public char[] getCharArrayExtra(String name) {
4393 return mExtras == null ? null : mExtras.getCharArray(name);
4394 }
4395
4396 /**
4397 * Retrieve extended data from the intent.
4398 *
4399 * @param name The name of the desired item.
4400 *
4401 * @return the value of an item that previously added with putExtra()
4402 * or null if no int array value was found.
4403 *
4404 * @see #putExtra(String, int[])
4405 */
4406 public int[] getIntArrayExtra(String name) {
4407 return mExtras == null ? null : mExtras.getIntArray(name);
4408 }
4409
4410 /**
4411 * Retrieve extended data from the intent.
4412 *
4413 * @param name The name of the desired item.
4414 *
4415 * @return the value of an item that previously added with putExtra()
4416 * or null if no long array value was found.
4417 *
4418 * @see #putExtra(String, long[])
4419 */
4420 public long[] getLongArrayExtra(String name) {
4421 return mExtras == null ? null : mExtras.getLongArray(name);
4422 }
4423
4424 /**
4425 * Retrieve extended data from the intent.
4426 *
4427 * @param name The name of the desired item.
4428 *
4429 * @return the value of an item that previously added with putExtra()
4430 * or null if no float array value was found.
4431 *
4432 * @see #putExtra(String, float[])
4433 */
4434 public float[] getFloatArrayExtra(String name) {
4435 return mExtras == null ? null : mExtras.getFloatArray(name);
4436 }
4437
4438 /**
4439 * Retrieve extended data from the intent.
4440 *
4441 * @param name The name of the desired item.
4442 *
4443 * @return the value of an item that previously added with putExtra()
4444 * or null if no double array value was found.
4445 *
4446 * @see #putExtra(String, double[])
4447 */
4448 public double[] getDoubleArrayExtra(String name) {
4449 return mExtras == null ? null : mExtras.getDoubleArray(name);
4450 }
4451
4452 /**
4453 * Retrieve extended data from the intent.
4454 *
4455 * @param name The name of the desired item.
4456 *
4457 * @return the value of an item that previously added with putExtra()
4458 * or null if no String array value was found.
4459 *
4460 * @see #putExtra(String, String[])
4461 */
4462 public String[] getStringArrayExtra(String name) {
4463 return mExtras == null ? null : mExtras.getStringArray(name);
4464 }
4465
4466 /**
4467 * Retrieve extended data from the intent.
4468 *
4469 * @param name The name of the desired item.
4470 *
4471 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004472 * or null if no CharSequence array value was found.
4473 *
4474 * @see #putExtra(String, CharSequence[])
4475 */
4476 public CharSequence[] getCharSequenceArrayExtra(String name) {
4477 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4478 }
4479
4480 /**
4481 * Retrieve extended data from the intent.
4482 *
4483 * @param name The name of the desired item.
4484 *
4485 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004486 * or null if no Bundle value was found.
4487 *
4488 * @see #putExtra(String, Bundle)
4489 */
4490 public Bundle getBundleExtra(String name) {
4491 return mExtras == null ? null : mExtras.getBundle(name);
4492 }
4493
4494 /**
4495 * Retrieve extended data from the intent.
4496 *
4497 * @param name The name of the desired item.
4498 *
4499 * @return the value of an item that previously added with putExtra()
4500 * or null if no IBinder value was found.
4501 *
4502 * @see #putExtra(String, IBinder)
4503 *
4504 * @deprecated
4505 * @hide
4506 */
4507 @Deprecated
4508 public IBinder getIBinderExtra(String name) {
4509 return mExtras == null ? null : mExtras.getIBinder(name);
4510 }
4511
4512 /**
4513 * Retrieve extended data from the intent.
4514 *
4515 * @param name The name of the desired item.
4516 * @param defaultValue The default value to return in case no item is
4517 * associated with the key 'name'
4518 *
4519 * @return the value of an item that previously added with putExtra()
4520 * or defaultValue if none was found.
4521 *
4522 * @see #putExtra
4523 *
4524 * @deprecated
4525 * @hide
4526 */
4527 @Deprecated
4528 public Object getExtra(String name, Object defaultValue) {
4529 Object result = defaultValue;
4530 if (mExtras != null) {
4531 Object result2 = mExtras.get(name);
4532 if (result2 != null) {
4533 result = result2;
4534 }
4535 }
4536
4537 return result;
4538 }
4539
4540 /**
4541 * Retrieves a map of extended data from the intent.
4542 *
4543 * @return the map of all extras previously added with putExtra(),
4544 * or null if none have been added.
4545 */
4546 public Bundle getExtras() {
4547 return (mExtras != null)
4548 ? new Bundle(mExtras)
4549 : null;
4550 }
4551
4552 /**
4553 * Retrieve any special flags associated with this intent. You will
4554 * normally just set them with {@link #setFlags} and let the system
4555 * take the appropriate action with them.
4556 *
4557 * @return int The currently set flags.
4558 *
4559 * @see #setFlags
4560 */
4561 public int getFlags() {
4562 return mFlags;
4563 }
4564
Dianne Hackborne7f97212011-02-24 14:40:20 -08004565 /** @hide */
4566 public boolean isExcludingStopped() {
4567 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4568 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4569 }
4570
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004571 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004572 * Retrieve the application package name this Intent is limited to. When
4573 * resolving an Intent, if non-null this limits the resolution to only
4574 * components in the given application package.
4575 *
4576 * @return The name of the application package for the Intent.
4577 *
4578 * @see #resolveActivity
4579 * @see #setPackage
4580 */
4581 public String getPackage() {
4582 return mPackage;
4583 }
4584
4585 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004586 * Retrieve the concrete component associated with the intent. When receiving
4587 * an intent, this is the component that was found to best handle it (that is,
4588 * yourself) and will always be non-null; in all other cases it will be
4589 * null unless explicitly set.
4590 *
4591 * @return The name of the application component to handle the intent.
4592 *
4593 * @see #resolveActivity
4594 * @see #setComponent
4595 */
4596 public ComponentName getComponent() {
4597 return mComponent;
4598 }
4599
4600 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004601 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4602 * used as a hint to the receiver for animations and the like. Null means that there
4603 * is no source bounds.
4604 */
4605 public Rect getSourceBounds() {
4606 return mSourceBounds;
4607 }
4608
4609 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004610 * Return the Activity component that should be used to handle this intent.
4611 * The appropriate component is determined based on the information in the
4612 * intent, evaluated as follows:
4613 *
4614 * <p>If {@link #getComponent} returns an explicit class, that is returned
4615 * without any further consideration.
4616 *
4617 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4618 * category to be considered.
4619 *
4620 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4621 * action.
4622 *
4623 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4624 * this type.
4625 *
4626 * <p>If {@link #addCategory} has added any categories, the activity must
4627 * handle ALL of the categories specified.
4628 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004629 * <p>If {@link #getPackage} is non-NULL, only activity components in
4630 * that application package will be considered.
4631 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004632 * <p>If there are no activities that satisfy all of these conditions, a
4633 * null string is returned.
4634 *
4635 * <p>If multiple activities are found to satisfy the intent, the one with
4636 * the highest priority will be used. If there are multiple activities
4637 * with the same priority, the system will either pick the best activity
4638 * based on user preference, or resolve to a system class that will allow
4639 * the user to pick an activity and forward from there.
4640 *
4641 * <p>This method is implemented simply by calling
4642 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4643 * true.</p>
4644 * <p> This API is called for you as part of starting an activity from an
4645 * intent. You do not normally need to call it yourself.</p>
4646 *
4647 * @param pm The package manager with which to resolve the Intent.
4648 *
4649 * @return Name of the component implementing an activity that can
4650 * display the intent.
4651 *
4652 * @see #setComponent
4653 * @see #getComponent
4654 * @see #resolveActivityInfo
4655 */
4656 public ComponentName resolveActivity(PackageManager pm) {
4657 if (mComponent != null) {
4658 return mComponent;
4659 }
4660
4661 ResolveInfo info = pm.resolveActivity(
4662 this, PackageManager.MATCH_DEFAULT_ONLY);
4663 if (info != null) {
4664 return new ComponentName(
4665 info.activityInfo.applicationInfo.packageName,
4666 info.activityInfo.name);
4667 }
4668
4669 return null;
4670 }
4671
4672 /**
4673 * Resolve the Intent into an {@link ActivityInfo}
4674 * describing the activity that should execute the intent. Resolution
4675 * follows the same rules as described for {@link #resolveActivity}, but
4676 * you get back the completely information about the resolved activity
4677 * instead of just its class name.
4678 *
4679 * @param pm The package manager with which to resolve the Intent.
4680 * @param flags Addition information to retrieve as per
4681 * {@link PackageManager#getActivityInfo(ComponentName, int)
4682 * PackageManager.getActivityInfo()}.
4683 *
4684 * @return PackageManager.ActivityInfo
4685 *
4686 * @see #resolveActivity
4687 */
4688 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4689 ActivityInfo ai = null;
4690 if (mComponent != null) {
4691 try {
4692 ai = pm.getActivityInfo(mComponent, flags);
4693 } catch (PackageManager.NameNotFoundException e) {
4694 // ignore
4695 }
4696 } else {
4697 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004698 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004699 if (info != null) {
4700 ai = info.activityInfo;
4701 }
4702 }
4703
4704 return ai;
4705 }
4706
4707 /**
4708 * Set the general action to be performed.
4709 *
4710 * @param action An action name, such as ACTION_VIEW. Application-specific
4711 * actions should be prefixed with the vendor's package name.
4712 *
4713 * @return Returns the same Intent object, for chaining multiple calls
4714 * into a single statement.
4715 *
4716 * @see #getAction
4717 */
4718 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004719 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004720 return this;
4721 }
4722
4723 /**
4724 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004725 * clears any type that was previously set by {@link #setType} or
4726 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004727 *
Nick Pellyccae4122012-01-09 14:12:58 -08004728 * <p><em>Note: scheme matching in the Android framework is
4729 * case-sensitive, unlike the formal RFC. As a result,
4730 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004731 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004732 * {@link #setDataAndNormalize}
4733 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004734 *
Nick Pellyccae4122012-01-09 14:12:58 -08004735 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004736 *
4737 * @return Returns the same Intent object, for chaining multiple calls
4738 * into a single statement.
4739 *
4740 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004741 * @see #setDataAndNormalize
4742 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004743 */
4744 public Intent setData(Uri data) {
4745 mData = data;
4746 mType = null;
4747 return this;
4748 }
4749
4750 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004751 * Normalize and set the data this intent is operating on.
4752 *
4753 * <p>This method automatically clears any type that was
4754 * previously set (for example, by {@link #setType}).
4755 *
4756 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004757 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004758 * so really this is just a convenience method for
4759 * <pre>
4760 * setData(data.normalize())
4761 * </pre>
4762 *
4763 * @param data The Uri of the data this intent is now targeting.
4764 *
4765 * @return Returns the same Intent object, for chaining multiple calls
4766 * into a single statement.
4767 *
4768 * @see #getData
4769 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004770 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004771 */
4772 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004773 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004774 }
4775
4776 /**
4777 * Set an explicit MIME data type.
4778 *
4779 * <p>This is used to create intents that only specify a type and not data,
4780 * for example to indicate the type of data to return.
4781 *
4782 * <p>This method automatically clears any data that was
4783 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004784 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004785 * <p><em>Note: MIME type matching in the Android framework is
4786 * case-sensitive, unlike formal RFC MIME types. As a result,
4787 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004788 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4789 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004790 *
4791 * @param type The MIME type of the data being handled by this intent.
4792 *
4793 * @return Returns the same Intent object, for chaining multiple calls
4794 * into a single statement.
4795 *
4796 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004797 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004798 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004799 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004800 */
4801 public Intent setType(String type) {
4802 mData = null;
4803 mType = type;
4804 return this;
4805 }
4806
4807 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004808 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004809 *
Nick Pellyccae4122012-01-09 14:12:58 -08004810 * <p>This is used to create intents that only specify a type and not data,
4811 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004812 *
Nick Pellyccae4122012-01-09 14:12:58 -08004813 * <p>This method automatically clears any data that was
4814 * previously set (for example by {@link #setData}).
4815 *
4816 * <p>The MIME type is normalized using
4817 * {@link #normalizeMimeType} before it is set,
4818 * so really this is just a convenience method for
4819 * <pre>
4820 * setType(Intent.normalizeMimeType(type))
4821 * </pre>
4822 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004823 * @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 *
Nick Pellyccae4122012-01-09 14:12:58 -08004828 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004829 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004830 * @see #normalizeMimeType
4831 */
4832 public Intent setTypeAndNormalize(String type) {
4833 return setType(normalizeMimeType(type));
4834 }
4835
4836 /**
4837 * (Usually optional) Set the data for the intent along with an explicit
4838 * MIME data type. This method should very rarely be used -- it allows you
4839 * to override the MIME type that would ordinarily be inferred from the
4840 * data with your own type given here.
4841 *
4842 * <p><em>Note: MIME type and Uri scheme matching in the
4843 * Android framework is case-sensitive, unlike the formal RFC definitions.
4844 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004845 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004846 * {@link #setDataAndTypeAndNormalize}
4847 * to ensure that they are converted to lower case.</em>
4848 *
4849 * @param data The Uri of the data this intent is now targeting.
4850 * @param type The MIME type of the data being handled by this intent.
4851 *
4852 * @return Returns the same Intent object, for chaining multiple calls
4853 * into a single statement.
4854 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004855 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004856 * @see #setData
4857 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004858 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004859 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004860 */
4861 public Intent setDataAndType(Uri data, String type) {
4862 mData = data;
4863 mType = type;
4864 return this;
4865 }
4866
4867 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004868 * (Usually optional) Normalize and set both the data Uri and an explicit
4869 * MIME data type. This method should very rarely be used -- it allows you
4870 * to override the MIME type that would ordinarily be inferred from the
4871 * data with your own type given here.
4872 *
4873 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004874 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004875 * before they are set, so really this is just a convenience method for
4876 * <pre>
4877 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4878 * </pre>
4879 *
4880 * @param data The Uri of the data this intent is now targeting.
4881 * @param type The MIME type of the data being handled by this intent.
4882 *
4883 * @return Returns the same Intent object, for chaining multiple calls
4884 * into a single statement.
4885 *
4886 * @see #setType
4887 * @see #setData
4888 * @see #setDataAndType
4889 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004890 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004891 */
4892 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004893 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004894 }
4895
4896 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004897 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004898 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004899 * activities that provide <em>all</em> of the requested categories will be
4900 * used.
4901 *
4902 * @param category The desired category. This can be either one of the
4903 * predefined Intent categories, or a custom category in your own
4904 * namespace.
4905 *
4906 * @return Returns the same Intent object, for chaining multiple calls
4907 * into a single statement.
4908 *
4909 * @see #hasCategory
4910 * @see #removeCategory
4911 */
4912 public Intent addCategory(String category) {
4913 if (mCategories == null) {
4914 mCategories = new HashSet<String>();
4915 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004916 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004917 return this;
4918 }
4919
4920 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004921 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004922 *
4923 * @param category The category to remove.
4924 *
4925 * @see #addCategory
4926 */
4927 public void removeCategory(String category) {
4928 if (mCategories != null) {
4929 mCategories.remove(category);
4930 if (mCategories.size() == 0) {
4931 mCategories = null;
4932 }
4933 }
4934 }
4935
4936 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004937 * Set a selector for this Intent. This is a modification to the kinds of
4938 * things the Intent will match. If the selector is set, it will be used
4939 * when trying to find entities that can handle the Intent, instead of the
4940 * main contents of the Intent. This allows you build an Intent containing
4941 * a generic protocol while targeting it more specifically.
4942 *
4943 * <p>An example of where this may be used is with things like
4944 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4945 * Intent that will launch the Browser application. However, the correct
4946 * main entry point of an application is actually {@link #ACTION_MAIN}
4947 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4948 * used to specify the actual Activity to launch. If you launch the browser
4949 * with something different, undesired behavior may happen if the user has
4950 * previously or later launches it the normal way, since they do not match.
4951 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4952 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4953 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4954 *
4955 * <p>Setting a selector does not impact the behavior of
4956 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4957 * desired behavior of a selector -- it does not impact the base meaning
4958 * of the Intent, just what kinds of things will be matched against it
4959 * when determining who can handle it.</p>
4960 *
4961 * <p>You can not use both a selector and {@link #setPackage(String)} on
4962 * the same base Intent.</p>
4963 *
4964 * @param selector The desired selector Intent; set to null to not use
4965 * a special selector.
4966 */
4967 public void setSelector(Intent selector) {
4968 if (selector == this) {
4969 throw new IllegalArgumentException(
4970 "Intent being set as a selector of itself");
4971 }
4972 if (selector != null && mPackage != null) {
4973 throw new IllegalArgumentException(
4974 "Can't set selector when package name is already set");
4975 }
4976 mSelector = selector;
4977 }
4978
4979 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004980 * Set a {@link ClipData} associated with this Intent. This replaces any
4981 * previously set ClipData.
4982 *
4983 * <p>The ClipData in an intent is not used for Intent matching or other
4984 * such operations. Semantically it is like extras, used to transmit
4985 * additional data with the Intent. The main feature of using this over
4986 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4987 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4988 * items included in the clip data. This is useful, in particular, if
4989 * you want to transmit an Intent containing multiple <code>content:</code>
4990 * URIs for which the recipient may not have global permission to access the
4991 * content provider.
4992 *
4993 * <p>If the ClipData contains items that are themselves Intents, any
4994 * grant flags in those Intents will be ignored. Only the top-level flags
4995 * of the main Intent are respected, and will be applied to all Uri or
4996 * Intent items in the clip (or sub-items of the clip).
4997 *
4998 * <p>The MIME type, label, and icon in the ClipData object are not
4999 * directly used by Intent. Applications should generally rely on the
5000 * MIME type of the Intent itself, not what it may find in the ClipData.
5001 * A common practice is to construct a ClipData for use with an Intent
5002 * with a MIME type of "*\/*".
5003 *
5004 * @param clip The new clip to set. May be null to clear the current clip.
5005 */
5006 public void setClipData(ClipData clip) {
5007 mClipData = clip;
5008 }
5009
5010 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005011 * Add extended data to the intent. The name must include a package
5012 * prefix, for example the app com.android.contacts would use names
5013 * like "com.android.contacts.ShowAll".
5014 *
5015 * @param name The name of the extra data, with package prefix.
5016 * @param value The boolean data value.
5017 *
5018 * @return Returns the same Intent object, for chaining multiple calls
5019 * into a single statement.
5020 *
5021 * @see #putExtras
5022 * @see #removeExtra
5023 * @see #getBooleanExtra(String, boolean)
5024 */
5025 public Intent putExtra(String name, boolean value) {
5026 if (mExtras == null) {
5027 mExtras = new Bundle();
5028 }
5029 mExtras.putBoolean(name, value);
5030 return this;
5031 }
5032
5033 /**
5034 * Add extended data to the intent. The name must include a package
5035 * prefix, for example the app com.android.contacts would use names
5036 * like "com.android.contacts.ShowAll".
5037 *
5038 * @param name The name of the extra data, with package prefix.
5039 * @param value The byte data value.
5040 *
5041 * @return Returns the same Intent object, for chaining multiple calls
5042 * into a single statement.
5043 *
5044 * @see #putExtras
5045 * @see #removeExtra
5046 * @see #getByteExtra(String, byte)
5047 */
5048 public Intent putExtra(String name, byte value) {
5049 if (mExtras == null) {
5050 mExtras = new Bundle();
5051 }
5052 mExtras.putByte(name, value);
5053 return this;
5054 }
5055
5056 /**
5057 * Add extended data to the intent. The name must include a package
5058 * prefix, for example the app com.android.contacts would use names
5059 * like "com.android.contacts.ShowAll".
5060 *
5061 * @param name The name of the extra data, with package prefix.
5062 * @param value The char data value.
5063 *
5064 * @return Returns the same Intent object, for chaining multiple calls
5065 * into a single statement.
5066 *
5067 * @see #putExtras
5068 * @see #removeExtra
5069 * @see #getCharExtra(String, char)
5070 */
5071 public Intent putExtra(String name, char value) {
5072 if (mExtras == null) {
5073 mExtras = new Bundle();
5074 }
5075 mExtras.putChar(name, value);
5076 return this;
5077 }
5078
5079 /**
5080 * Add extended data to the intent. The name must include a package
5081 * prefix, for example the app com.android.contacts would use names
5082 * like "com.android.contacts.ShowAll".
5083 *
5084 * @param name The name of the extra data, with package prefix.
5085 * @param value The short data value.
5086 *
5087 * @return Returns the same Intent object, for chaining multiple calls
5088 * into a single statement.
5089 *
5090 * @see #putExtras
5091 * @see #removeExtra
5092 * @see #getShortExtra(String, short)
5093 */
5094 public Intent putExtra(String name, short value) {
5095 if (mExtras == null) {
5096 mExtras = new Bundle();
5097 }
5098 mExtras.putShort(name, value);
5099 return this;
5100 }
5101
5102 /**
5103 * Add extended data to the intent. The name must include a package
5104 * prefix, for example the app com.android.contacts would use names
5105 * like "com.android.contacts.ShowAll".
5106 *
5107 * @param name The name of the extra data, with package prefix.
5108 * @param value The integer data value.
5109 *
5110 * @return Returns the same Intent object, for chaining multiple calls
5111 * into a single statement.
5112 *
5113 * @see #putExtras
5114 * @see #removeExtra
5115 * @see #getIntExtra(String, int)
5116 */
5117 public Intent putExtra(String name, int value) {
5118 if (mExtras == null) {
5119 mExtras = new Bundle();
5120 }
5121 mExtras.putInt(name, value);
5122 return this;
5123 }
5124
5125 /**
5126 * Add extended data to the intent. The name must include a package
5127 * prefix, for example the app com.android.contacts would use names
5128 * like "com.android.contacts.ShowAll".
5129 *
5130 * @param name The name of the extra data, with package prefix.
5131 * @param value The long data value.
5132 *
5133 * @return Returns the same Intent object, for chaining multiple calls
5134 * into a single statement.
5135 *
5136 * @see #putExtras
5137 * @see #removeExtra
5138 * @see #getLongExtra(String, long)
5139 */
5140 public Intent putExtra(String name, long value) {
5141 if (mExtras == null) {
5142 mExtras = new Bundle();
5143 }
5144 mExtras.putLong(name, value);
5145 return this;
5146 }
5147
5148 /**
5149 * Add extended data to the intent. The name must include a package
5150 * prefix, for example the app com.android.contacts would use names
5151 * like "com.android.contacts.ShowAll".
5152 *
5153 * @param name The name of the extra data, with package prefix.
5154 * @param value The float data value.
5155 *
5156 * @return Returns the same Intent object, for chaining multiple calls
5157 * into a single statement.
5158 *
5159 * @see #putExtras
5160 * @see #removeExtra
5161 * @see #getFloatExtra(String, float)
5162 */
5163 public Intent putExtra(String name, float value) {
5164 if (mExtras == null) {
5165 mExtras = new Bundle();
5166 }
5167 mExtras.putFloat(name, value);
5168 return this;
5169 }
5170
5171 /**
5172 * Add extended data to the intent. The name must include a package
5173 * prefix, for example the app com.android.contacts would use names
5174 * like "com.android.contacts.ShowAll".
5175 *
5176 * @param name The name of the extra data, with package prefix.
5177 * @param value The double data value.
5178 *
5179 * @return Returns the same Intent object, for chaining multiple calls
5180 * into a single statement.
5181 *
5182 * @see #putExtras
5183 * @see #removeExtra
5184 * @see #getDoubleExtra(String, double)
5185 */
5186 public Intent putExtra(String name, double value) {
5187 if (mExtras == null) {
5188 mExtras = new Bundle();
5189 }
5190 mExtras.putDouble(name, value);
5191 return this;
5192 }
5193
5194 /**
5195 * Add extended data to the intent. The name must include a package
5196 * prefix, for example the app com.android.contacts would use names
5197 * like "com.android.contacts.ShowAll".
5198 *
5199 * @param name The name of the extra data, with package prefix.
5200 * @param value The String data value.
5201 *
5202 * @return Returns the same Intent object, for chaining multiple calls
5203 * into a single statement.
5204 *
5205 * @see #putExtras
5206 * @see #removeExtra
5207 * @see #getStringExtra(String)
5208 */
5209 public Intent putExtra(String name, String value) {
5210 if (mExtras == null) {
5211 mExtras = new Bundle();
5212 }
5213 mExtras.putString(name, value);
5214 return this;
5215 }
5216
5217 /**
5218 * Add extended data to the intent. The name must include a package
5219 * prefix, for example the app com.android.contacts would use names
5220 * like "com.android.contacts.ShowAll".
5221 *
5222 * @param name The name of the extra data, with package prefix.
5223 * @param value The CharSequence data value.
5224 *
5225 * @return Returns the same Intent object, for chaining multiple calls
5226 * into a single statement.
5227 *
5228 * @see #putExtras
5229 * @see #removeExtra
5230 * @see #getCharSequenceExtra(String)
5231 */
5232 public Intent putExtra(String name, CharSequence value) {
5233 if (mExtras == null) {
5234 mExtras = new Bundle();
5235 }
5236 mExtras.putCharSequence(name, value);
5237 return this;
5238 }
5239
5240 /**
5241 * Add extended data to the intent. The name must include a package
5242 * prefix, for example the app com.android.contacts would use names
5243 * like "com.android.contacts.ShowAll".
5244 *
5245 * @param name The name of the extra data, with package prefix.
5246 * @param value The Parcelable data value.
5247 *
5248 * @return Returns the same Intent object, for chaining multiple calls
5249 * into a single statement.
5250 *
5251 * @see #putExtras
5252 * @see #removeExtra
5253 * @see #getParcelableExtra(String)
5254 */
5255 public Intent putExtra(String name, Parcelable value) {
5256 if (mExtras == null) {
5257 mExtras = new Bundle();
5258 }
5259 mExtras.putParcelable(name, value);
5260 return this;
5261 }
5262
5263 /**
5264 * Add extended data to the intent. The name must include a package
5265 * prefix, for example the app com.android.contacts would use names
5266 * like "com.android.contacts.ShowAll".
5267 *
5268 * @param name The name of the extra data, with package prefix.
5269 * @param value The Parcelable[] data value.
5270 *
5271 * @return Returns the same Intent object, for chaining multiple calls
5272 * into a single statement.
5273 *
5274 * @see #putExtras
5275 * @see #removeExtra
5276 * @see #getParcelableArrayExtra(String)
5277 */
5278 public Intent putExtra(String name, Parcelable[] value) {
5279 if (mExtras == null) {
5280 mExtras = new Bundle();
5281 }
5282 mExtras.putParcelableArray(name, value);
5283 return this;
5284 }
5285
5286 /**
5287 * Add extended data to the intent. The name must include a package
5288 * prefix, for example the app com.android.contacts would use names
5289 * like "com.android.contacts.ShowAll".
5290 *
5291 * @param name The name of the extra data, with package prefix.
5292 * @param value The ArrayList<Parcelable> data value.
5293 *
5294 * @return Returns the same Intent object, for chaining multiple calls
5295 * into a single statement.
5296 *
5297 * @see #putExtras
5298 * @see #removeExtra
5299 * @see #getParcelableArrayListExtra(String)
5300 */
5301 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5302 if (mExtras == null) {
5303 mExtras = new Bundle();
5304 }
5305 mExtras.putParcelableArrayList(name, value);
5306 return this;
5307 }
5308
5309 /**
5310 * Add extended data to the intent. The name must include a package
5311 * prefix, for example the app com.android.contacts would use names
5312 * like "com.android.contacts.ShowAll".
5313 *
5314 * @param name The name of the extra data, with package prefix.
5315 * @param value The ArrayList<Integer> data value.
5316 *
5317 * @return Returns the same Intent object, for chaining multiple calls
5318 * into a single statement.
5319 *
5320 * @see #putExtras
5321 * @see #removeExtra
5322 * @see #getIntegerArrayListExtra(String)
5323 */
5324 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5325 if (mExtras == null) {
5326 mExtras = new Bundle();
5327 }
5328 mExtras.putIntegerArrayList(name, value);
5329 return this;
5330 }
5331
5332 /**
5333 * Add extended data to the intent. The name must include a package
5334 * prefix, for example the app com.android.contacts would use names
5335 * like "com.android.contacts.ShowAll".
5336 *
5337 * @param name The name of the extra data, with package prefix.
5338 * @param value The ArrayList<String> data value.
5339 *
5340 * @return Returns the same Intent object, for chaining multiple calls
5341 * into a single statement.
5342 *
5343 * @see #putExtras
5344 * @see #removeExtra
5345 * @see #getStringArrayListExtra(String)
5346 */
5347 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5348 if (mExtras == null) {
5349 mExtras = new Bundle();
5350 }
5351 mExtras.putStringArrayList(name, value);
5352 return this;
5353 }
5354
5355 /**
5356 * Add extended data to the intent. The name must include a package
5357 * prefix, for example the app com.android.contacts would use names
5358 * like "com.android.contacts.ShowAll".
5359 *
5360 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005361 * @param value The ArrayList<CharSequence> data value.
5362 *
5363 * @return Returns the same Intent object, for chaining multiple calls
5364 * into a single statement.
5365 *
5366 * @see #putExtras
5367 * @see #removeExtra
5368 * @see #getCharSequenceArrayListExtra(String)
5369 */
5370 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5371 if (mExtras == null) {
5372 mExtras = new Bundle();
5373 }
5374 mExtras.putCharSequenceArrayList(name, value);
5375 return this;
5376 }
5377
5378 /**
5379 * Add extended data to the intent. The name must include a package
5380 * prefix, for example the app com.android.contacts would use names
5381 * like "com.android.contacts.ShowAll".
5382 *
5383 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005384 * @param value The Serializable data value.
5385 *
5386 * @return Returns the same Intent object, for chaining multiple calls
5387 * into a single statement.
5388 *
5389 * @see #putExtras
5390 * @see #removeExtra
5391 * @see #getSerializableExtra(String)
5392 */
5393 public Intent putExtra(String name, Serializable value) {
5394 if (mExtras == null) {
5395 mExtras = new Bundle();
5396 }
5397 mExtras.putSerializable(name, value);
5398 return this;
5399 }
5400
5401 /**
5402 * Add extended data to the intent. The name must include a package
5403 * prefix, for example the app com.android.contacts would use names
5404 * like "com.android.contacts.ShowAll".
5405 *
5406 * @param name The name of the extra data, with package prefix.
5407 * @param value The boolean array data value.
5408 *
5409 * @return Returns the same Intent object, for chaining multiple calls
5410 * into a single statement.
5411 *
5412 * @see #putExtras
5413 * @see #removeExtra
5414 * @see #getBooleanArrayExtra(String)
5415 */
5416 public Intent putExtra(String name, boolean[] value) {
5417 if (mExtras == null) {
5418 mExtras = new Bundle();
5419 }
5420 mExtras.putBooleanArray(name, value);
5421 return this;
5422 }
5423
5424 /**
5425 * Add extended data to the intent. The name must include a package
5426 * prefix, for example the app com.android.contacts would use names
5427 * like "com.android.contacts.ShowAll".
5428 *
5429 * @param name The name of the extra data, with package prefix.
5430 * @param value The byte array data value.
5431 *
5432 * @return Returns the same Intent object, for chaining multiple calls
5433 * into a single statement.
5434 *
5435 * @see #putExtras
5436 * @see #removeExtra
5437 * @see #getByteArrayExtra(String)
5438 */
5439 public Intent putExtra(String name, byte[] value) {
5440 if (mExtras == null) {
5441 mExtras = new Bundle();
5442 }
5443 mExtras.putByteArray(name, value);
5444 return this;
5445 }
5446
5447 /**
5448 * Add extended data to the intent. The name must include a package
5449 * prefix, for example the app com.android.contacts would use names
5450 * like "com.android.contacts.ShowAll".
5451 *
5452 * @param name The name of the extra data, with package prefix.
5453 * @param value The short array data value.
5454 *
5455 * @return Returns the same Intent object, for chaining multiple calls
5456 * into a single statement.
5457 *
5458 * @see #putExtras
5459 * @see #removeExtra
5460 * @see #getShortArrayExtra(String)
5461 */
5462 public Intent putExtra(String name, short[] value) {
5463 if (mExtras == null) {
5464 mExtras = new Bundle();
5465 }
5466 mExtras.putShortArray(name, value);
5467 return this;
5468 }
5469
5470 /**
5471 * Add extended data to the intent. The name must include a package
5472 * prefix, for example the app com.android.contacts would use names
5473 * like "com.android.contacts.ShowAll".
5474 *
5475 * @param name The name of the extra data, with package prefix.
5476 * @param value The char array data value.
5477 *
5478 * @return Returns the same Intent object, for chaining multiple calls
5479 * into a single statement.
5480 *
5481 * @see #putExtras
5482 * @see #removeExtra
5483 * @see #getCharArrayExtra(String)
5484 */
5485 public Intent putExtra(String name, char[] value) {
5486 if (mExtras == null) {
5487 mExtras = new Bundle();
5488 }
5489 mExtras.putCharArray(name, value);
5490 return this;
5491 }
5492
5493 /**
5494 * Add extended data to the intent. The name must include a package
5495 * prefix, for example the app com.android.contacts would use names
5496 * like "com.android.contacts.ShowAll".
5497 *
5498 * @param name The name of the extra data, with package prefix.
5499 * @param value The int array data value.
5500 *
5501 * @return Returns the same Intent object, for chaining multiple calls
5502 * into a single statement.
5503 *
5504 * @see #putExtras
5505 * @see #removeExtra
5506 * @see #getIntArrayExtra(String)
5507 */
5508 public Intent putExtra(String name, int[] value) {
5509 if (mExtras == null) {
5510 mExtras = new Bundle();
5511 }
5512 mExtras.putIntArray(name, value);
5513 return this;
5514 }
5515
5516 /**
5517 * Add extended data to the intent. The name must include a package
5518 * prefix, for example the app com.android.contacts would use names
5519 * like "com.android.contacts.ShowAll".
5520 *
5521 * @param name The name of the extra data, with package prefix.
5522 * @param value The byte array data value.
5523 *
5524 * @return Returns the same Intent object, for chaining multiple calls
5525 * into a single statement.
5526 *
5527 * @see #putExtras
5528 * @see #removeExtra
5529 * @see #getLongArrayExtra(String)
5530 */
5531 public Intent putExtra(String name, long[] value) {
5532 if (mExtras == null) {
5533 mExtras = new Bundle();
5534 }
5535 mExtras.putLongArray(name, value);
5536 return this;
5537 }
5538
5539 /**
5540 * Add extended data to the intent. The name must include a package
5541 * prefix, for example the app com.android.contacts would use names
5542 * like "com.android.contacts.ShowAll".
5543 *
5544 * @param name The name of the extra data, with package prefix.
5545 * @param value The float array data value.
5546 *
5547 * @return Returns the same Intent object, for chaining multiple calls
5548 * into a single statement.
5549 *
5550 * @see #putExtras
5551 * @see #removeExtra
5552 * @see #getFloatArrayExtra(String)
5553 */
5554 public Intent putExtra(String name, float[] value) {
5555 if (mExtras == null) {
5556 mExtras = new Bundle();
5557 }
5558 mExtras.putFloatArray(name, value);
5559 return this;
5560 }
5561
5562 /**
5563 * Add extended data to the intent. The name must include a package
5564 * prefix, for example the app com.android.contacts would use names
5565 * like "com.android.contacts.ShowAll".
5566 *
5567 * @param name The name of the extra data, with package prefix.
5568 * @param value The double array data value.
5569 *
5570 * @return Returns the same Intent object, for chaining multiple calls
5571 * into a single statement.
5572 *
5573 * @see #putExtras
5574 * @see #removeExtra
5575 * @see #getDoubleArrayExtra(String)
5576 */
5577 public Intent putExtra(String name, double[] value) {
5578 if (mExtras == null) {
5579 mExtras = new Bundle();
5580 }
5581 mExtras.putDoubleArray(name, value);
5582 return this;
5583 }
5584
5585 /**
5586 * Add extended data to the intent. The name must include a package
5587 * prefix, for example the app com.android.contacts would use names
5588 * like "com.android.contacts.ShowAll".
5589 *
5590 * @param name The name of the extra data, with package prefix.
5591 * @param value The String array data value.
5592 *
5593 * @return Returns the same Intent object, for chaining multiple calls
5594 * into a single statement.
5595 *
5596 * @see #putExtras
5597 * @see #removeExtra
5598 * @see #getStringArrayExtra(String)
5599 */
5600 public Intent putExtra(String name, String[] value) {
5601 if (mExtras == null) {
5602 mExtras = new Bundle();
5603 }
5604 mExtras.putStringArray(name, value);
5605 return this;
5606 }
5607
5608 /**
5609 * Add extended data to the intent. The name must include a package
5610 * prefix, for example the app com.android.contacts would use names
5611 * like "com.android.contacts.ShowAll".
5612 *
5613 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005614 * @param value The CharSequence array data value.
5615 *
5616 * @return Returns the same Intent object, for chaining multiple calls
5617 * into a single statement.
5618 *
5619 * @see #putExtras
5620 * @see #removeExtra
5621 * @see #getCharSequenceArrayExtra(String)
5622 */
5623 public Intent putExtra(String name, CharSequence[] value) {
5624 if (mExtras == null) {
5625 mExtras = new Bundle();
5626 }
5627 mExtras.putCharSequenceArray(name, value);
5628 return this;
5629 }
5630
5631 /**
5632 * Add extended data to the intent. The name must include a package
5633 * prefix, for example the app com.android.contacts would use names
5634 * like "com.android.contacts.ShowAll".
5635 *
5636 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005637 * @param value The Bundle data value.
5638 *
5639 * @return Returns the same Intent object, for chaining multiple calls
5640 * into a single statement.
5641 *
5642 * @see #putExtras
5643 * @see #removeExtra
5644 * @see #getBundleExtra(String)
5645 */
5646 public Intent putExtra(String name, Bundle value) {
5647 if (mExtras == null) {
5648 mExtras = new Bundle();
5649 }
5650 mExtras.putBundle(name, value);
5651 return this;
5652 }
5653
5654 /**
5655 * Add extended data to the intent. The name must include a package
5656 * prefix, for example the app com.android.contacts would use names
5657 * like "com.android.contacts.ShowAll".
5658 *
5659 * @param name The name of the extra data, with package prefix.
5660 * @param value The IBinder data value.
5661 *
5662 * @return Returns the same Intent object, for chaining multiple calls
5663 * into a single statement.
5664 *
5665 * @see #putExtras
5666 * @see #removeExtra
5667 * @see #getIBinderExtra(String)
5668 *
5669 * @deprecated
5670 * @hide
5671 */
5672 @Deprecated
5673 public Intent putExtra(String name, IBinder value) {
5674 if (mExtras == null) {
5675 mExtras = new Bundle();
5676 }
5677 mExtras.putIBinder(name, value);
5678 return this;
5679 }
5680
5681 /**
5682 * Copy all extras in 'src' in to this intent.
5683 *
5684 * @param src Contains the extras to copy.
5685 *
5686 * @see #putExtra
5687 */
5688 public Intent putExtras(Intent src) {
5689 if (src.mExtras != null) {
5690 if (mExtras == null) {
5691 mExtras = new Bundle(src.mExtras);
5692 } else {
5693 mExtras.putAll(src.mExtras);
5694 }
5695 }
5696 return this;
5697 }
5698
5699 /**
5700 * Add a set of extended data to the intent. The keys must include a package
5701 * prefix, for example the app com.android.contacts would use names
5702 * like "com.android.contacts.ShowAll".
5703 *
5704 * @param extras The Bundle of extras to add to this intent.
5705 *
5706 * @see #putExtra
5707 * @see #removeExtra
5708 */
5709 public Intent putExtras(Bundle extras) {
5710 if (mExtras == null) {
5711 mExtras = new Bundle();
5712 }
5713 mExtras.putAll(extras);
5714 return this;
5715 }
5716
5717 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005718 * Completely replace the extras in the Intent with the extras in the
5719 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005720 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005721 * @param src The exact extras contained in this Intent are copied
5722 * into the target intent, replacing any that were previously there.
5723 */
5724 public Intent replaceExtras(Intent src) {
5725 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5726 return this;
5727 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005728
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005729 /**
5730 * Completely replace the extras in the Intent with the given Bundle of
5731 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005732 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005733 * @param extras The new set of extras in the Intent, or null to erase
5734 * all extras.
5735 */
5736 public Intent replaceExtras(Bundle extras) {
5737 mExtras = extras != null ? new Bundle(extras) : null;
5738 return this;
5739 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005740
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005741 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005742 * Remove extended data from the intent.
5743 *
5744 * @see #putExtra
5745 */
5746 public void removeExtra(String name) {
5747 if (mExtras != null) {
5748 mExtras.remove(name);
5749 if (mExtras.size() == 0) {
5750 mExtras = null;
5751 }
5752 }
5753 }
5754
5755 /**
5756 * Set special flags controlling how this intent is handled. Most values
5757 * here depend on the type of component being executed by the Intent,
5758 * specifically the FLAG_ACTIVITY_* flags are all for use with
5759 * {@link Context#startActivity Context.startActivity()} and the
5760 * FLAG_RECEIVER_* flags are all for use with
5761 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5762 *
Scott Main7aee61f2011-02-08 11:25:01 -08005763 * <p>See the
5764 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5765 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005766 * the behavior of your application.
5767 *
5768 * @param flags The desired flags.
5769 *
5770 * @return Returns the same Intent object, for chaining multiple calls
5771 * into a single statement.
5772 *
5773 * @see #getFlags
5774 * @see #addFlags
5775 *
5776 * @see #FLAG_GRANT_READ_URI_PERMISSION
5777 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5778 * @see #FLAG_DEBUG_LOG_RESOLUTION
5779 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005780 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005781 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005782 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005783 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005784 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5785 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005786 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005787 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5788 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005789 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005790 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005791 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005792 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5793 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005794 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005795 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005796 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005797 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5798 */
5799 public Intent setFlags(int flags) {
5800 mFlags = flags;
5801 return this;
5802 }
5803
5804 /**
5805 * Add additional flags to the intent (or with existing flags
5806 * value).
5807 *
5808 * @param flags The new flags to set.
5809 *
5810 * @return Returns the same Intent object, for chaining multiple calls
5811 * into a single statement.
5812 *
5813 * @see #setFlags
5814 */
5815 public Intent addFlags(int flags) {
5816 mFlags |= flags;
5817 return this;
5818 }
5819
5820 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005821 * (Usually optional) Set an explicit application package name that limits
5822 * the components this Intent will resolve to. If left to the default
5823 * value of null, all components in all applications will considered.
5824 * If non-null, the Intent can only match the components in the given
5825 * application package.
5826 *
5827 * @param packageName The name of the application package to handle the
5828 * intent, or null to allow any application package.
5829 *
5830 * @return Returns the same Intent object, for chaining multiple calls
5831 * into a single statement.
5832 *
5833 * @see #getPackage
5834 * @see #resolveActivity
5835 */
5836 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005837 if (packageName != null && mSelector != null) {
5838 throw new IllegalArgumentException(
5839 "Can't set package name when selector is already set");
5840 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005841 mPackage = packageName;
5842 return this;
5843 }
5844
5845 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005846 * (Usually optional) Explicitly set the component to handle the intent.
5847 * If left with the default value of null, the system will determine the
5848 * appropriate class to use based on the other fields (action, data,
5849 * type, categories) in the Intent. If this class is defined, the
5850 * specified class will always be used regardless of the other fields. You
5851 * should only set this value when you know you absolutely want a specific
5852 * class to be used; otherwise it is better to let the system find the
5853 * appropriate class so that you will respect the installed applications
5854 * and user preferences.
5855 *
5856 * @param component The name of the application component to handle the
5857 * intent, or null to let the system find one for you.
5858 *
5859 * @return Returns the same Intent object, for chaining multiple calls
5860 * into a single statement.
5861 *
5862 * @see #setClass
5863 * @see #setClassName(Context, String)
5864 * @see #setClassName(String, String)
5865 * @see #getComponent
5866 * @see #resolveActivity
5867 */
5868 public Intent setComponent(ComponentName component) {
5869 mComponent = component;
5870 return this;
5871 }
5872
5873 /**
5874 * Convenience for calling {@link #setComponent} with an
5875 * explicit class name.
5876 *
5877 * @param packageContext A Context of the application package implementing
5878 * this class.
5879 * @param className The name of a class inside of the application package
5880 * that will be used as the component for this Intent.
5881 *
5882 * @return Returns the same Intent object, for chaining multiple calls
5883 * into a single statement.
5884 *
5885 * @see #setComponent
5886 * @see #setClass
5887 */
5888 public Intent setClassName(Context packageContext, String className) {
5889 mComponent = new ComponentName(packageContext, className);
5890 return this;
5891 }
5892
5893 /**
5894 * Convenience for calling {@link #setComponent} with an
5895 * explicit application package name and class name.
5896 *
5897 * @param packageName The name of the package implementing the desired
5898 * component.
5899 * @param className The name of a class inside of the application package
5900 * that will be used as the component for this Intent.
5901 *
5902 * @return Returns the same Intent object, for chaining multiple calls
5903 * into a single statement.
5904 *
5905 * @see #setComponent
5906 * @see #setClass
5907 */
5908 public Intent setClassName(String packageName, String className) {
5909 mComponent = new ComponentName(packageName, className);
5910 return this;
5911 }
5912
5913 /**
5914 * Convenience for calling {@link #setComponent(ComponentName)} with the
5915 * name returned by a {@link Class} object.
5916 *
5917 * @param packageContext A Context of the application package implementing
5918 * this class.
5919 * @param cls The class name to set, equivalent to
5920 * <code>setClassName(context, cls.getName())</code>.
5921 *
5922 * @return Returns the same Intent object, for chaining multiple calls
5923 * into a single statement.
5924 *
5925 * @see #setComponent
5926 */
5927 public Intent setClass(Context packageContext, Class<?> cls) {
5928 mComponent = new ComponentName(packageContext, cls);
5929 return this;
5930 }
5931
5932 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005933 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5934 * used as a hint to the receiver for animations and the like. Null means that there
5935 * is no source bounds.
5936 */
5937 public void setSourceBounds(Rect r) {
5938 if (r != null) {
5939 mSourceBounds = new Rect(r);
5940 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005941 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005942 }
5943 }
5944
5945 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005946 * Use with {@link #fillIn} to allow the current action value to be
5947 * overwritten, even if it is already set.
5948 */
5949 public static final int FILL_IN_ACTION = 1<<0;
5950
5951 /**
5952 * Use with {@link #fillIn} to allow the current data or type value
5953 * overwritten, even if it is already set.
5954 */
5955 public static final int FILL_IN_DATA = 1<<1;
5956
5957 /**
5958 * Use with {@link #fillIn} to allow the current categories to be
5959 * overwritten, even if they are already set.
5960 */
5961 public static final int FILL_IN_CATEGORIES = 1<<2;
5962
5963 /**
5964 * Use with {@link #fillIn} to allow the current component value to be
5965 * overwritten, even if it is already set.
5966 */
5967 public static final int FILL_IN_COMPONENT = 1<<3;
5968
5969 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005970 * Use with {@link #fillIn} to allow the current package value to be
5971 * overwritten, even if it is already set.
5972 */
5973 public static final int FILL_IN_PACKAGE = 1<<4;
5974
5975 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005976 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005977 * overwritten, even if it is already set.
5978 */
5979 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5980
5981 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005982 * Use with {@link #fillIn} to allow the current selector to be
5983 * overwritten, even if it is already set.
5984 */
5985 public static final int FILL_IN_SELECTOR = 1<<6;
5986
5987 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005988 * Use with {@link #fillIn} to allow the current ClipData to be
5989 * overwritten, even if it is already set.
5990 */
5991 public static final int FILL_IN_CLIP_DATA = 1<<7;
5992
5993 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005994 * Copy the contents of <var>other</var> in to this object, but only
5995 * where fields are not defined by this object. For purposes of a field
5996 * being defined, the following pieces of data in the Intent are
5997 * considered to be separate fields:
5998 *
5999 * <ul>
6000 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006001 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006002 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6003 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006004 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006005 * <li> component, as set by {@link #setComponent(ComponentName)} or
6006 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006007 * <li> source bounds, as set by {@link #setSourceBounds}.
6008 * <li> selector, as set by {@link #setSelector(Intent)}.
6009 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006010 * <li> each top-level name in the associated extras.
6011 * </ul>
6012 *
6013 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006014 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006015 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6016 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6017 * the restriction where the corresponding field will not be replaced if
6018 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006019 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006020 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6021 * is explicitly specified. The selector will only be copied if
6022 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006023 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006024 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6025 * and Intent B with {action="gotit", data-type="some/thing",
6026 * categories="one","two"}.
6027 *
6028 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6029 * containing: {action="gotit", data-type="some/thing",
6030 * categories="bar"}.
6031 *
6032 * @param other Another Intent whose values are to be used to fill in
6033 * the current one.
6034 * @param flags Options to control which fields can be filled in.
6035 *
6036 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006037 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006038 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6039 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006040 */
6041 public int fillIn(Intent other, int flags) {
6042 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006043 if (other.mAction != null
6044 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006045 mAction = other.mAction;
6046 changes |= FILL_IN_ACTION;
6047 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006048 if ((other.mData != null || other.mType != null)
6049 && ((mData == null && mType == null)
6050 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006051 mData = other.mData;
6052 mType = other.mType;
6053 changes |= FILL_IN_DATA;
6054 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006055 if (other.mCategories != null
6056 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006057 if (other.mCategories != null) {
6058 mCategories = new HashSet<String>(other.mCategories);
6059 }
6060 changes |= FILL_IN_CATEGORIES;
6061 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006062 if (other.mPackage != null
6063 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006064 // Only do this if mSelector is not set.
6065 if (mSelector == null) {
6066 mPackage = other.mPackage;
6067 changes |= FILL_IN_PACKAGE;
6068 }
6069 }
6070 // Selector is special: it can only be set if explicitly allowed,
6071 // for the same reason as the component name.
6072 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6073 if (mPackage == null) {
6074 mSelector = new Intent(other.mSelector);
6075 mPackage = null;
6076 changes |= FILL_IN_SELECTOR;
6077 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006078 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006079 if (other.mClipData != null
6080 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6081 mClipData = other.mClipData;
6082 changes |= FILL_IN_CLIP_DATA;
6083 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006084 // Component is special: it can -only- be set if explicitly allowed,
6085 // since otherwise the sender could force the intent somewhere the
6086 // originator didn't intend.
6087 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006088 mComponent = other.mComponent;
6089 changes |= FILL_IN_COMPONENT;
6090 }
6091 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006092 if (other.mSourceBounds != null
6093 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6094 mSourceBounds = new Rect(other.mSourceBounds);
6095 changes |= FILL_IN_SOURCE_BOUNDS;
6096 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006097 if (mExtras == null) {
6098 if (other.mExtras != null) {
6099 mExtras = new Bundle(other.mExtras);
6100 }
6101 } else if (other.mExtras != null) {
6102 try {
6103 Bundle newb = new Bundle(other.mExtras);
6104 newb.putAll(mExtras);
6105 mExtras = newb;
6106 } catch (RuntimeException e) {
6107 // Modifying the extras can cause us to unparcel the contents
6108 // of the bundle, and if we do this in the system process that
6109 // may fail. We really should handle this (i.e., the Bundle
6110 // impl shouldn't be on top of a plain map), but for now just
6111 // ignore it and keep the original contents. :(
6112 Log.w("Intent", "Failure filling in extras", e);
6113 }
6114 }
6115 return changes;
6116 }
6117
6118 /**
6119 * Wrapper class holding an Intent and implementing comparisons on it for
6120 * the purpose of filtering. The class implements its
6121 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6122 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6123 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6124 * on the wrapped Intent.
6125 */
6126 public static final class FilterComparison {
6127 private final Intent mIntent;
6128 private final int mHashCode;
6129
6130 public FilterComparison(Intent intent) {
6131 mIntent = intent;
6132 mHashCode = intent.filterHashCode();
6133 }
6134
6135 /**
6136 * Return the Intent that this FilterComparison represents.
6137 * @return Returns the Intent held by the FilterComparison. Do
6138 * not modify!
6139 */
6140 public Intent getIntent() {
6141 return mIntent;
6142 }
6143
6144 @Override
6145 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006146 if (obj instanceof FilterComparison) {
6147 Intent other = ((FilterComparison)obj).mIntent;
6148 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006149 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006150 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006151 }
6152
6153 @Override
6154 public int hashCode() {
6155 return mHashCode;
6156 }
6157 }
6158
6159 /**
6160 * Determine if two intents are the same for the purposes of intent
6161 * resolution (filtering). That is, if their action, data, type,
6162 * class, and categories are the same. This does <em>not</em> compare
6163 * any extra data included in the intents.
6164 *
6165 * @param other The other Intent to compare against.
6166 *
6167 * @return Returns true if action, data, type, class, and categories
6168 * are the same.
6169 */
6170 public boolean filterEquals(Intent other) {
6171 if (other == null) {
6172 return false;
6173 }
6174 if (mAction != other.mAction) {
6175 if (mAction != null) {
6176 if (!mAction.equals(other.mAction)) {
6177 return false;
6178 }
6179 } else {
6180 if (!other.mAction.equals(mAction)) {
6181 return false;
6182 }
6183 }
6184 }
6185 if (mData != other.mData) {
6186 if (mData != null) {
6187 if (!mData.equals(other.mData)) {
6188 return false;
6189 }
6190 } else {
6191 if (!other.mData.equals(mData)) {
6192 return false;
6193 }
6194 }
6195 }
6196 if (mType != other.mType) {
6197 if (mType != null) {
6198 if (!mType.equals(other.mType)) {
6199 return false;
6200 }
6201 } else {
6202 if (!other.mType.equals(mType)) {
6203 return false;
6204 }
6205 }
6206 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006207 if (mPackage != other.mPackage) {
6208 if (mPackage != null) {
6209 if (!mPackage.equals(other.mPackage)) {
6210 return false;
6211 }
6212 } else {
6213 if (!other.mPackage.equals(mPackage)) {
6214 return false;
6215 }
6216 }
6217 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006218 if (mComponent != other.mComponent) {
6219 if (mComponent != null) {
6220 if (!mComponent.equals(other.mComponent)) {
6221 return false;
6222 }
6223 } else {
6224 if (!other.mComponent.equals(mComponent)) {
6225 return false;
6226 }
6227 }
6228 }
6229 if (mCategories != other.mCategories) {
6230 if (mCategories != null) {
6231 if (!mCategories.equals(other.mCategories)) {
6232 return false;
6233 }
6234 } else {
6235 if (!other.mCategories.equals(mCategories)) {
6236 return false;
6237 }
6238 }
6239 }
6240
6241 return true;
6242 }
6243
6244 /**
6245 * Generate hash code that matches semantics of filterEquals().
6246 *
6247 * @return Returns the hash value of the action, data, type, class, and
6248 * categories.
6249 *
6250 * @see #filterEquals
6251 */
6252 public int filterHashCode() {
6253 int code = 0;
6254 if (mAction != null) {
6255 code += mAction.hashCode();
6256 }
6257 if (mData != null) {
6258 code += mData.hashCode();
6259 }
6260 if (mType != null) {
6261 code += mType.hashCode();
6262 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006263 if (mPackage != null) {
6264 code += mPackage.hashCode();
6265 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006266 if (mComponent != null) {
6267 code += mComponent.hashCode();
6268 }
6269 if (mCategories != null) {
6270 code += mCategories.hashCode();
6271 }
6272 return code;
6273 }
6274
6275 @Override
6276 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006277 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006278
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006279 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006280 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006281 b.append(" }");
6282
6283 return b.toString();
6284 }
6285
6286 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006287 public String toInsecureString() {
6288 StringBuilder b = new StringBuilder(128);
6289
6290 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006291 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006292 b.append(" }");
6293
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006294 return b.toString();
6295 }
Romain Guy4969af72009-06-17 10:53:19 -07006296
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006297 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006298 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006299 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006300
6301 b.append("Intent { ");
6302 toShortString(b, false, true, true, true);
6303 b.append(" }");
6304
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006305 return b.toString();
6306 }
6307
6308 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006309 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6310 StringBuilder b = new StringBuilder(128);
6311 toShortString(b, secure, comp, extras, clip);
6312 return b.toString();
6313 }
6314
6315 /** @hide */
6316 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6317 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006318 boolean first = true;
6319 if (mAction != null) {
6320 b.append("act=").append(mAction);
6321 first = false;
6322 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006323 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006324 if (!first) {
6325 b.append(' ');
6326 }
6327 first = false;
6328 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006329 Iterator<String> i = mCategories.iterator();
6330 boolean didone = false;
6331 while (i.hasNext()) {
6332 if (didone) b.append(",");
6333 didone = true;
6334 b.append(i.next());
6335 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006336 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006337 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006338 if (mData != null) {
6339 if (!first) {
6340 b.append(' ');
6341 }
6342 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006343 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006344 if (secure) {
6345 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006346 } else {
6347 b.append(mData);
6348 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006349 }
6350 if (mType != null) {
6351 if (!first) {
6352 b.append(' ');
6353 }
6354 first = false;
6355 b.append("typ=").append(mType);
6356 }
6357 if (mFlags != 0) {
6358 if (!first) {
6359 b.append(' ');
6360 }
6361 first = false;
6362 b.append("flg=0x").append(Integer.toHexString(mFlags));
6363 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006364 if (mPackage != null) {
6365 if (!first) {
6366 b.append(' ');
6367 }
6368 first = false;
6369 b.append("pkg=").append(mPackage);
6370 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006371 if (comp && mComponent != null) {
6372 if (!first) {
6373 b.append(' ');
6374 }
6375 first = false;
6376 b.append("cmp=").append(mComponent.flattenToShortString());
6377 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006378 if (mSourceBounds != null) {
6379 if (!first) {
6380 b.append(' ');
6381 }
6382 first = false;
6383 b.append("bnds=").append(mSourceBounds.toShortString());
6384 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006385 if (mClipData != null) {
6386 if (!first) {
6387 b.append(' ');
6388 }
6389 first = false;
6390 if (clip) {
6391 b.append("clip={");
6392 mClipData.toShortString(b);
6393 b.append('}');
6394 } else {
6395 b.append("(has clip)");
6396 }
6397 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006398 if (extras && mExtras != null) {
6399 if (!first) {
6400 b.append(' ');
6401 }
6402 first = false;
6403 b.append("(has extras)");
6404 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006405 if (mSelector != null) {
6406 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006407 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006408 b.append("}");
6409 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006410 }
6411
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006412 /**
6413 * Call {@link #toUri} with 0 flags.
6414 * @deprecated Use {@link #toUri} instead.
6415 */
6416 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006417 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006418 return toUri(0);
6419 }
6420
6421 /**
6422 * Convert this Intent into a String holding a URI representation of it.
6423 * The returned URI string has been properly URI encoded, so it can be
6424 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6425 * Intent's data as the base URI, with an additional fragment describing
6426 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006427 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006428 * <p>You can convert the returned string back to an Intent with
6429 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006430 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006431 * @param flags Additional operating flags. Either 0 or
6432 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006433 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006434 * @return Returns a URI encoding URI string describing the entire contents
6435 * of the Intent.
6436 */
6437 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006438 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006439 String scheme = null;
6440 if (mData != null) {
6441 String data = mData.toString();
6442 if ((flags&URI_INTENT_SCHEME) != 0) {
6443 final int N = data.length();
6444 for (int i=0; i<N; i++) {
6445 char c = data.charAt(i);
6446 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6447 || c == '.' || c == '-') {
6448 continue;
6449 }
6450 if (c == ':' && i > 0) {
6451 // Valid scheme.
6452 scheme = data.substring(0, i);
6453 uri.append("intent:");
6454 data = data.substring(i+1);
6455 break;
6456 }
Tom Taylord4a47292009-12-21 13:59:18 -08006457
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006458 // No scheme.
6459 break;
6460 }
6461 }
6462 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006463
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006464 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6465 uri.append("intent:");
6466 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006467
6468 uri.append("#Intent;");
6469
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006470 toUriInner(uri, scheme, flags);
6471 if (mSelector != null) {
6472 uri.append("SEL;");
6473 // Note that for now we are not going to try to handle the
6474 // data part; not clear how to represent this as a URI, and
6475 // not much utility in it.
6476 mSelector.toUriInner(uri, null, flags);
6477 }
6478
6479 uri.append("end");
6480
6481 return uri.toString();
6482 }
6483
6484 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006485 if (scheme != null) {
6486 uri.append("scheme=").append(scheme).append(';');
6487 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006488 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006489 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006490 }
6491 if (mCategories != null) {
6492 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006493 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006494 }
6495 }
6496 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006497 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006498 }
6499 if (mFlags != 0) {
6500 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6501 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006502 if (mPackage != null) {
6503 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6504 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006505 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006506 uri.append("component=").append(Uri.encode(
6507 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006508 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006509 if (mSourceBounds != null) {
6510 uri.append("sourceBounds=")
6511 .append(Uri.encode(mSourceBounds.flattenToString()))
6512 .append(';');
6513 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006514 if (mExtras != null) {
6515 for (String key : mExtras.keySet()) {
6516 final Object value = mExtras.get(key);
6517 char entryType =
6518 value instanceof String ? 'S' :
6519 value instanceof Boolean ? 'B' :
6520 value instanceof Byte ? 'b' :
6521 value instanceof Character ? 'c' :
6522 value instanceof Double ? 'd' :
6523 value instanceof Float ? 'f' :
6524 value instanceof Integer ? 'i' :
6525 value instanceof Long ? 'l' :
6526 value instanceof Short ? 's' :
6527 '\0';
6528
6529 if (entryType != '\0') {
6530 uri.append(entryType);
6531 uri.append('.');
6532 uri.append(Uri.encode(key));
6533 uri.append('=');
6534 uri.append(Uri.encode(value.toString()));
6535 uri.append(';');
6536 }
6537 }
6538 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006539 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006540
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006541 public int describeContents() {
6542 return (mExtras != null) ? mExtras.describeContents() : 0;
6543 }
6544
6545 public void writeToParcel(Parcel out, int flags) {
6546 out.writeString(mAction);
6547 Uri.writeToParcel(out, mData);
6548 out.writeString(mType);
6549 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006550 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006551 ComponentName.writeToParcel(mComponent, out);
6552
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006553 if (mSourceBounds != null) {
6554 out.writeInt(1);
6555 mSourceBounds.writeToParcel(out, flags);
6556 } else {
6557 out.writeInt(0);
6558 }
6559
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006560 if (mCategories != null) {
6561 out.writeInt(mCategories.size());
6562 for (String category : mCategories) {
6563 out.writeString(category);
6564 }
6565 } else {
6566 out.writeInt(0);
6567 }
6568
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006569 if (mSelector != null) {
6570 out.writeInt(1);
6571 mSelector.writeToParcel(out, flags);
6572 } else {
6573 out.writeInt(0);
6574 }
6575
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006576 if (mClipData != null) {
6577 out.writeInt(1);
6578 mClipData.writeToParcel(out, flags);
6579 } else {
6580 out.writeInt(0);
6581 }
6582
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006583 out.writeBundle(mExtras);
6584 }
6585
6586 public static final Parcelable.Creator<Intent> CREATOR
6587 = new Parcelable.Creator<Intent>() {
6588 public Intent createFromParcel(Parcel in) {
6589 return new Intent(in);
6590 }
6591 public Intent[] newArray(int size) {
6592 return new Intent[size];
6593 }
6594 };
6595
Dianne Hackborneb034652009-09-07 00:49:58 -07006596 /** @hide */
6597 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006598 readFromParcel(in);
6599 }
6600
6601 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006602 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006603 mData = Uri.CREATOR.createFromParcel(in);
6604 mType = in.readString();
6605 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006606 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006607 mComponent = ComponentName.readFromParcel(in);
6608
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006609 if (in.readInt() != 0) {
6610 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6611 }
6612
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006613 int N = in.readInt();
6614 if (N > 0) {
6615 mCategories = new HashSet<String>();
6616 int i;
6617 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006618 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006619 }
6620 } else {
6621 mCategories = null;
6622 }
6623
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006624 if (in.readInt() != 0) {
6625 mSelector = new Intent(in);
6626 }
6627
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006628 if (in.readInt() != 0) {
6629 mClipData = new ClipData(in);
6630 }
6631
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006632 mExtras = in.readBundle();
6633 }
6634
6635 /**
6636 * Parses the "intent" element (and its children) from XML and instantiates
6637 * an Intent object. The given XML parser should be located at the tag
6638 * where parsing should start (often named "intent"), from which the
6639 * basic action, data, type, and package and class name will be
6640 * retrieved. The function will then parse in to any child elements,
6641 * looking for <category android:name="xxx"> tags to add categories and
6642 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6643 * to the intent.
6644 *
6645 * @param resources The Resources to use when inflating resources.
6646 * @param parser The XML parser pointing at an "intent" tag.
6647 * @param attrs The AttributeSet interface for retrieving extended
6648 * attribute data at the current <var>parser</var> location.
6649 * @return An Intent object matching the XML data.
6650 * @throws XmlPullParserException If there was an XML parsing error.
6651 * @throws IOException If there was an I/O error.
6652 */
6653 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6654 throws XmlPullParserException, IOException {
6655 Intent intent = new Intent();
6656
6657 TypedArray sa = resources.obtainAttributes(attrs,
6658 com.android.internal.R.styleable.Intent);
6659
6660 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6661
6662 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6663 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6664 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6665
6666 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6667 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6668 if (packageName != null && className != null) {
6669 intent.setComponent(new ComponentName(packageName, className));
6670 }
6671
6672 sa.recycle();
6673
6674 int outerDepth = parser.getDepth();
6675 int type;
6676 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6677 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6678 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6679 continue;
6680 }
6681
6682 String nodeName = parser.getName();
6683 if (nodeName.equals("category")) {
6684 sa = resources.obtainAttributes(attrs,
6685 com.android.internal.R.styleable.IntentCategory);
6686 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6687 sa.recycle();
6688
6689 if (cat != null) {
6690 intent.addCategory(cat);
6691 }
6692 XmlUtils.skipCurrentTag(parser);
6693
6694 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006695 if (intent.mExtras == null) {
6696 intent.mExtras = new Bundle();
6697 }
6698 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6699 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006700
6701 } else {
6702 XmlUtils.skipCurrentTag(parser);
6703 }
6704 }
6705
6706 return intent;
6707 }
Nick Pellyccae4122012-01-09 14:12:58 -08006708
6709 /**
6710 * Normalize a MIME data type.
6711 *
6712 * <p>A normalized MIME type has white-space trimmed,
6713 * content-type parameters removed, and is lower-case.
6714 * This aligns the type with Android best practices for
6715 * intent filtering.
6716 *
6717 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6718 * "text/x-vCard" becomes "text/x-vcard".
6719 *
6720 * <p>All MIME types received from outside Android (such as user input,
6721 * or external sources like Bluetooth, NFC, or the Internet) should
6722 * be normalized before they are used to create an Intent.
6723 *
6724 * @param type MIME data type to normalize
6725 * @return normalized MIME data type, or null if the input was null
6726 * @see {@link #setType}
6727 * @see {@link #setTypeAndNormalize}
6728 */
6729 public static String normalizeMimeType(String type) {
6730 if (type == null) {
6731 return null;
6732 }
6733
6734 type = type.trim().toLowerCase(Locale.US);
6735
6736 final int semicolonIndex = type.indexOf(';');
6737 if (semicolonIndex != -1) {
6738 type = type.substring(0, semicolonIndex);
6739 }
6740 return type;
6741 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006742
6743 /**
6744 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006745 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6746 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006747 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006748 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006749 * @hide
6750 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006751 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006752 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006753 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006754
6755 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006756 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006757
6758 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006759 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006760 try {
6761 // Inspect target intent to see if we need to migrate
6762 final Intent target = getParcelableExtra(EXTRA_INTENT);
6763 if (target != null && target.migrateExtraStreamToClipData()) {
6764 // Since we migrated in child, we need to promote ClipData
6765 // and flags to ourselves to grant.
6766 setClipData(target.getClipData());
6767 addFlags(target.getFlags()
6768 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6769 return true;
6770 } else {
6771 return false;
6772 }
6773 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006774 }
6775
6776 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006777 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006778 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6779 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6780 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6781 if (stream != null || text != null || htmlText != null) {
6782 final ClipData clipData = new ClipData(
6783 null, new String[] { getType() },
6784 new ClipData.Item(text, htmlText, null, stream));
6785 setClipData(clipData);
6786 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006787 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006788 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006789 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006790 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006791
6792 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006793 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006794 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6795 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6796 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6797 int num = -1;
6798 if (streams != null) {
6799 num = streams.size();
6800 }
6801 if (texts != null) {
6802 if (num >= 0 && num != texts.size()) {
6803 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006804 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006805 }
6806 num = texts.size();
6807 }
6808 if (htmlTexts != null) {
6809 if (num >= 0 && num != htmlTexts.size()) {
6810 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006811 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006812 }
6813 num = htmlTexts.size();
6814 }
6815 if (num > 0) {
6816 final ClipData clipData = new ClipData(
6817 null, new String[] { getType() },
6818 makeClipItem(streams, texts, htmlTexts, 0));
6819
6820 for (int i = 1; i < num; i++) {
6821 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6822 }
6823
6824 setClipData(clipData);
6825 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006826 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006827 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006828 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006829 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006830 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006831
6832 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006833 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006834
6835 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6836 ArrayList<String> htmlTexts, int which) {
6837 Uri uri = streams != null ? streams.get(which) : null;
6838 CharSequence text = texts != null ? texts.get(which) : null;
6839 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6840 return new ClipData.Item(text, htmlText, null, uri);
6841 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006842}