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