blob: 9e051112a71dd2b98bcbaf891a0371bd03b4d240 [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700573 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800574 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700575 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
577 * <li> {@link #EXTRA_REPLACING}
578 * <li> {@link #EXTRA_SHORTCUT_ICON}
579 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
580 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700581 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800582 * <li> {@link #EXTRA_SHORTCUT_NAME}
583 * <li> {@link #EXTRA_SUBJECT}
584 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700585 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_TITLE}
587 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * </ul>
589 *
590 * <h3>Flags</h3>
591 *
592 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800593 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
594 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800596public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 // ---------------------------------------------------------------------
598 // ---------------------------------------------------------------------
599 // Standard intent activity actions (see action variable).
600
601 /**
602 * Activity Action: Start as a main entry point, does not expect to
603 * receive data.
604 * <p>Input: nothing
605 * <p>Output: nothing
606 */
607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
608 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700610 /**
611 * Activity Action: Display the data to the user. This is the most common
612 * action performed on data -- it is the generic action you can use on
613 * a piece of data to get the most reasonable thing to occur. For example,
614 * when used on a contacts entry it will view the entry; when used on a
615 * mailto: URI it will bring up a compose window filled with the information
616 * supplied by the URI; when used with a tel: URI it will invoke the
617 * dialer.
618 * <p>Input: {@link #getData} is URI from which to retrieve data.
619 * <p>Output: nothing.
620 */
621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
622 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 /**
625 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
626 * performed on a piece of data.
627 */
628 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Used to indicate that some piece of data should be attached to some other
632 * place. For example, image data could be attached to a contact. It is up
633 * to the recipient to decide where the data should be attached; the intent
634 * does not specify the ultimate destination.
635 * <p>Input: {@link #getData} is URI of data to be attached.
636 * <p>Output: nothing.
637 */
638 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
639 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700641 /**
642 * Activity Action: Provide explicit editable access to the given data.
643 * <p>Input: {@link #getData} is URI of data to be edited.
644 * <p>Output: nothing.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
651 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
652 * The extras can contain type specific data to pass through to the editing/creating
653 * activity.
654 * <p>Output: The URI of the item that was picked. This must be a content:
655 * URI so that any receiver can access it.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * Activity Action: Pick an item from the data, returning what was selected.
662 * <p>Input: {@link #getData} is URI containing a directory of data
663 * (vnd.android.cursor.dir/*) from which to pick an item.
664 * <p>Output: The URI of the item that was picked.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800671 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 * <p>Output: An Intent representing the shortcut. The intent must contain three
673 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
674 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675 * (value: ShortcutIconResource).</p>
676 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * @see #EXTRA_SHORTCUT_INTENT
678 * @see #EXTRA_SHORTCUT_NAME
679 * @see #EXTRA_SHORTCUT_ICON
680 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
681 * @see android.content.Intent.ShortcutIconResource
682 */
683 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
684 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
685
686 /**
687 * The name of the extra used to define the Intent of a shortcut.
688 *
689 * @see #ACTION_CREATE_SHORTCUT
690 */
691 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
692 /**
693 * The name of the extra used to define the name of a shortcut.
694 *
695 * @see #ACTION_CREATE_SHORTCUT
696 */
697 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
698 /**
699 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
700 *
701 * @see #ACTION_CREATE_SHORTCUT
702 */
703 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
704 /**
705 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
706 *
707 * @see #ACTION_CREATE_SHORTCUT
708 * @see android.content.Intent.ShortcutIconResource
709 */
710 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
711 "android.intent.extra.shortcut.ICON_RESOURCE";
712
713 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 *
716 * @see Intent#ACTION_CREATE_SHORTCUT
717 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
719 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 */
721 public static class ShortcutIconResource implements Parcelable {
722 /**
723 * The package name of the application containing the icon.
724 */
725 public String packageName;
726
727 /**
728 * The resource name of the icon, including package, name and type.
729 */
730 public String resourceName;
731
732 /**
733 * Creates a new ShortcutIconResource for the specified context and resource
734 * identifier.
735 *
736 * @param context The context of the application.
737 * @param resourceId The resource idenfitier for the icon.
738 * @return A new ShortcutIconResource with the specified's context package name
739 * and icon resource idenfitier.
740 */
741 public static ShortcutIconResource fromContext(Context context, int resourceId) {
742 ShortcutIconResource icon = new ShortcutIconResource();
743 icon.packageName = context.getPackageName();
744 icon.resourceName = context.getResources().getResourceName(resourceId);
745 return icon;
746 }
747
748 /**
749 * Used to read a ShortcutIconResource from a Parcel.
750 */
751 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
752 new Parcelable.Creator<ShortcutIconResource>() {
753
754 public ShortcutIconResource createFromParcel(Parcel source) {
755 ShortcutIconResource icon = new ShortcutIconResource();
756 icon.packageName = source.readString();
757 icon.resourceName = source.readString();
758 return icon;
759 }
760
761 public ShortcutIconResource[] newArray(int size) {
762 return new ShortcutIconResource[size];
763 }
764 };
765
766 /**
767 * No special parcel contents.
768 */
769 public int describeContents() {
770 return 0;
771 }
772
773 public void writeToParcel(Parcel dest, int flags) {
774 dest.writeString(packageName);
775 dest.writeString(resourceName);
776 }
777
778 @Override
779 public String toString() {
780 return resourceName;
781 }
782 }
783
784 /**
785 * Activity Action: Display an activity chooser, allowing the user to pick
786 * what they want to before proceeding. This can be used as an alternative
787 * to the standard activity picker that is displayed by the system when
788 * you try to start an activity with multiple possible matches, with these
789 * differences in behavior:
790 * <ul>
791 * <li>You can specify the title that will appear in the activity chooser.
792 * <li>The user does not have the option to make one of the matching
793 * activities a preferred activity, and all possible activities will
794 * always be shown even if one of them is currently marked as the
795 * preferred activity.
796 * </ul>
797 * <p>
798 * This action should be used when the user will naturally expect to
799 * select an activity in order to proceed. An example if when not to use
800 * it is when the user clicks on a "mailto:" link. They would naturally
801 * expect to go directly to their mail app, so startActivity() should be
802 * called directly: it will
803 * either launch the current preferred app, or put up a dialog allowing the
804 * user to pick an app to use and optionally marking that as preferred.
805 * <p>
806 * In contrast, if the user is selecting a menu item to send a picture
807 * they are viewing to someone else, there are many different things they
808 * may want to do at this point: send it through e-mail, upload it to a
809 * web service, etc. In this case the CHOOSER action should be used, to
810 * always present to the user a list of the things they can do, with a
811 * nice title given by the caller such as "Send this photo with:".
812 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700813 * If you need to grant URI permissions through a chooser, you must specify
814 * the permissions to be granted on the ACTION_CHOOSER Intent
815 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
816 * {@link #setClipData} to specify the URIs to be granted as well as
817 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
818 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
819 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 * As a convenience, an Intent of this form can be created with the
821 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700822 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
825 * and can optionally have a {@link #EXTRA_TITLE} field containing the
826 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700827 * <p>
828 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700829 */
830 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
831 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
832
833 /**
834 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
835 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700836 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
837 * target intent, also optionally supplying a title. If the target
838 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
839 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
840 * set in the returned chooser intent, with its ClipData set appropriately:
841 * either a direct reflection of {@link #getClipData()} if that is non-null,
842 * or a new ClipData build from {@link #getData()}.
843 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 * @param target The Intent that the user will be selecting an activity
845 * to perform.
846 * @param title Optional title that will be displayed in the chooser.
847 * @return Return a new Intent object that you can hand to
848 * {@link Context#startActivity(Intent) Context.startActivity()} and
849 * related methods.
850 */
851 public static Intent createChooser(Intent target, CharSequence title) {
852 Intent intent = new Intent(ACTION_CHOOSER);
853 intent.putExtra(EXTRA_INTENT, target);
854 if (title != null) {
855 intent.putExtra(EXTRA_TITLE, title);
856 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700857
858 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700859 int permFlags = target.getFlags()
860 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
861 if (permFlags != 0) {
862 ClipData targetClipData = target.getClipData();
863 if (targetClipData == null && target.getData() != null) {
864 ClipData.Item item = new ClipData.Item(target.getData());
865 String[] mimeTypes;
866 if (target.getType() != null) {
867 mimeTypes = new String[] { target.getType() };
868 } else {
869 mimeTypes = new String[] { };
870 }
871 targetClipData = new ClipData(null, mimeTypes, item);
872 }
873 if (targetClipData != null) {
874 intent.setClipData(targetClipData);
875 intent.addFlags(permFlags);
876 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700879 return intent;
880 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700882 /**
883 * Activity Action: Allow the user to select a particular kind of data and
884 * return it. This is different than {@link #ACTION_PICK} in that here we
885 * just say what kind of data is desired, not a URI of existing data from
886 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
887 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900888 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700889 * etc.
890 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900891 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * of data, such as a person contact, you set the MIME type to the kind of
893 * data you want and launch it with {@link Context#startActivity(Intent)}.
894 * The system will then launch the best application to select that kind
895 * of data for you.
896 * <p>
897 * You may also be interested in any of a set of types of content the user
898 * can pick. For example, an e-mail application that wants to allow the
899 * user to add an attachment to an e-mail message can use this action to
900 * bring up a list of all of the types of content the user can attach.
901 * <p>
902 * In this case, you should wrap the GET_CONTENT intent with a chooser
903 * (through {@link #createChooser}), which will give the proper interface
904 * for the user to pick how to send your data and allow you to specify
905 * a prompt indicating what they are doing. You will usually specify a
906 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
907 * broad range of content types the user can select from.
908 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900909 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * only pick from data that can be represented as a stream. This is
911 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
912 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800913 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900914 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800915 * is locally available on the device. For example, if this extra is set
916 * to true then an image picker should not show any pictures that are available
917 * from a remote server but not already on the local device (thus requiring
918 * they be downloaded when opened).
919 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700920 * Input: {@link #getType} is the desired MIME type to retrieve. Note
921 * that no URI is supplied in the intent, as there are no constraints on
922 * where the returned data originally comes from. You may also include the
923 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800924 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
925 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700926 * <p>
927 * Output: The URI of the item that was picked. This must be a content:
928 * URI so that any receiver can access it.
929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
932 /**
933 * Activity Action: Dial a number as specified by the data. This shows a
934 * UI with the number being dialed, allowing the user to explicitly
935 * initiate the call.
936 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
937 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
938 * number.
939 * <p>Output: nothing.
940 */
941 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
942 public static final String ACTION_DIAL = "android.intent.action.DIAL";
943 /**
944 * Activity Action: Perform a call to someone specified by the data.
945 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
946 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
947 * number.
948 * <p>Output: nothing.
949 *
950 * <p>Note: there will be restrictions on which applications can initiate a
951 * call; most applications should use the {@link #ACTION_DIAL}.
952 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
953 * numbers. Applications can <strong>dial</strong> emergency numbers using
954 * {@link #ACTION_DIAL}, however.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_CALL = "android.intent.action.CALL";
958 /**
959 * Activity Action: Perform a call to an emergency number specified by the
960 * data.
961 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
962 * tel: URI of an explicit phone number.
963 * <p>Output: nothing.
964 * @hide
965 */
966 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
967 /**
968 * Activity action: Perform a call to any number (emergency or not)
969 * specified by the data.
970 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
971 * tel: URI of an explicit phone number.
972 * <p>Output: nothing.
973 * @hide
974 */
975 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
976 /**
977 * Activity Action: Send a message to someone specified by the data.
978 * <p>Input: {@link #getData} is URI describing the target.
979 * <p>Output: nothing.
980 */
981 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
982 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
983 /**
984 * Activity Action: Deliver some data to someone else. Who the data is
985 * being delivered to is not specified; it is up to the receiver of this
986 * action to ask the user where the data should be sent.
987 * <p>
988 * When launching a SEND intent, you should usually wrap it in a chooser
989 * (through {@link #createChooser}), which will give the proper interface
990 * for the user to pick how to send your data and allow you to specify
991 * a prompt indicating what they are doing.
992 * <p>
993 * Input: {@link #getType} is the MIME type of the data being sent.
994 * get*Extra can have either a {@link #EXTRA_TEXT}
995 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
996 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
997 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
998 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700999 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1000 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1001 * your text with HTML formatting.
1002 * <p>
1003 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1004 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1005 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1006 * content: URIs and other advanced features of {@link ClipData}. If
1007 * using this approach, you still must supply the same data through the
1008 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1009 * for compatibility with old applications. If you don't set a ClipData,
1010 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * <p>
1012 * Optional standard extras, which may be interpreted by some recipients as
1013 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1014 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1015 * <p>
1016 * Output: nothing.
1017 */
1018 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1019 public static final String ACTION_SEND = "android.intent.action.SEND";
1020 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001021 * Activity Action: Deliver multiple data to someone else.
1022 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001023 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001024 * <p>
1025 * Input: {@link #getType} is the MIME type of the data being sent.
1026 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001027 * #EXTRA_STREAM} field, containing the data to be sent. If using
1028 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1029 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001031 * Multiple types are supported, and receivers should handle mixed types
1032 * whenever possible. The right way for the receiver to check them is to
1033 * use the content resolver on each URI. The intent sender should try to
1034 * put the most concrete mime type in the intent type, but it can fall
1035 * back to {@literal <type>/*} or {@literal *}/* as needed.
1036 * <p>
1037 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1038 * be image/jpg, but if you are sending image/jpg and image/png, then the
1039 * intent's type should be image/*.
1040 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001041 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1042 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1043 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1044 * content: URIs and other advanced features of {@link ClipData}. If
1045 * using this approach, you still must supply the same data through the
1046 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1047 * for compatibility with old applications. If you don't set a ClipData,
1048 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1049 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001050 * Optional standard extras, which may be interpreted by some recipients as
1051 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1052 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1053 * <p>
1054 * Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Activity Action: Handle an incoming phone call.
1060 * <p>Input: nothing.
1061 * <p>Output: nothing.
1062 */
1063 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1064 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1065 /**
1066 * Activity Action: Insert an empty item into the given container.
1067 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1068 * in which to place the data.
1069 * <p>Output: URI of the new data that was created.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1073 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001074 * Activity Action: Create a new item in the given container, initializing it
1075 * from the current contents of the clipboard.
1076 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1077 * in which to place the data.
1078 * <p>Output: URI of the new data that was created.
1079 */
1080 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1081 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1082 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001083 * Activity Action: Delete the given data from its container.
1084 * <p>Input: {@link #getData} is URI of data to be deleted.
1085 * <p>Output: nothing.
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1089 /**
1090 * Activity Action: Run the data, whatever that means.
1091 * <p>Input: ? (Note: this is currently specific to the test harness.)
1092 * <p>Output: nothing.
1093 */
1094 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1095 public static final String ACTION_RUN = "android.intent.action.RUN";
1096 /**
1097 * Activity Action: Perform a data synchronization.
1098 * <p>Input: ?
1099 * <p>Output: ?
1100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1103 /**
1104 * Activity Action: Pick an activity given an intent, returning the class
1105 * selected.
1106 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1107 * used with {@link PackageManager#queryIntentActivities} to determine the
1108 * set of activities from which to pick.
1109 * <p>Output: Class name of the activity that was selected.
1110 */
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1112 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1113 /**
1114 * Activity Action: Perform a search.
1115 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1116 * is the text to search for. If empty, simply
1117 * enter your search results Activity with the search UI activated.
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1122 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001123 * Activity Action: Start the platform-defined tutorial
1124 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1125 * is the text to search for. If empty, simply
1126 * enter your search results Activity with the search UI activated.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1131 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001132 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001133 * <p>
1134 * Input: {@link android.app.SearchManager#QUERY
1135 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1136 * a url starts with http or https, the site will be opened. If it is plain
1137 * text, Google search will be applied.
1138 * <p>
1139 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001140 */
1141 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1142 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1143 /**
Jim Miller07994402012-05-02 14:22:27 -07001144 * Activity Action: Perform assist action.
1145 * <p>
1146 * Input: nothing
1147 * Output: nothing.
1148 */
1149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1150 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
1151 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 * Activity Action: List all available applications
1153 * <p>Input: Nothing.
1154 * <p>Output: nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1158 /**
1159 * Activity Action: Show settings for choosing wallpaper
1160 * <p>Input: Nothing.
1161 * <p>Output: Nothing.
1162 */
1163 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1164 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1165
1166 /**
1167 * Activity Action: Show activity for reporting a bug.
1168 * <p>Input: Nothing.
1169 * <p>Output: Nothing.
1170 */
1171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1172 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1173
1174 /**
1175 * Activity Action: Main entry point for factory tests. Only used when
1176 * the device is booting in factory test node. The implementing package
1177 * must be installed in the system image.
1178 * <p>Input: nothing
1179 * <p>Output: nothing
1180 */
1181 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1182
1183 /**
1184 * Activity Action: The user pressed the "call" button to go to the dialer
1185 * or other appropriate UI for placing a call.
1186 * <p>Input: Nothing.
1187 * <p>Output: Nothing.
1188 */
1189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1190 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1191
1192 /**
1193 * Activity Action: Start Voice Command.
1194 * <p>Input: Nothing.
1195 * <p>Output: Nothing.
1196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001199
1200 /**
1201 * Activity Action: Start action associated with long pressing on the
1202 * search key.
1203 * <p>Input: Nothing.
1204 * <p>Output: Nothing.
1205 */
1206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1207 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001208
Jacek Surazski86b6c532009-05-13 14:38:28 +02001209 /**
1210 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1211 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001212 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001213 * <p>Input: No data is specified. The bug report is passed in using
1214 * an {@link #EXTRA_BUG_REPORT} field.
1215 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001216 *
1217 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001218 */
1219 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1220 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001221
1222 /**
1223 * Activity Action: Show power usage information to the user.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001229
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001230 /**
1231 * Activity Action: Setup wizard to launch after a platform update. This
1232 * activity should have a string meta-data field associated with it,
1233 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1234 * the platform for setup. The activity will be launched only if
1235 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1236 * same value.
1237 * <p>Input: Nothing.
1238 * <p>Output: Nothing.
1239 * @hide
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001243
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001244 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001245 * Activity Action: Show settings for managing network data usage of a
1246 * specific application. Applications should define an activity that offers
1247 * options to control data usage.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_MANAGE_NETWORK_USAGE =
1251 "android.intent.action.MANAGE_NETWORK_USAGE";
1252
1253 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 * Activity Action: Launch application installer.
1255 * <p>
1256 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001257 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1258 * you can also use "package:<package-name>" to install an application for the
1259 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001260 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1261 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1262 * <p>
1263 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1264 * succeeded.
1265 *
1266 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1267 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1268 * @see #EXTRA_RETURN_RESULT
1269 */
1270 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1271 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1272
1273 /**
1274 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1275 * package. Specifies the installer package name; this package will receive the
1276 * {@link #ACTION_APP_ERROR} intent.
1277 */
1278 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1279 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1280
1281 /**
1282 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1283 * package. Specifies that the application being installed should not be
1284 * treated as coming from an unknown source, but as coming from the app
1285 * invoking the Intent. For this to work you must start the installer with
1286 * startActivityForResult().
1287 */
1288 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1289 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1290
1291 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001292 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1293 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001294 * data field originated from.
1295 */
rich cannings706e8ba2012-08-20 13:20:14 -07001296 public static final String EXTRA_ORIGINATING_URI
1297 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001298
1299 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001300 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1301 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1302 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001303 */
1304 public static final String EXTRA_REFERRER
1305 = "android.intent.extra.REFERRER";
1306
1307 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001308 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1309 * package. Tells the installer UI to skip the confirmation with the user
1310 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001311 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1312 * will no longer show an interstitial message about updating existing
1313 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001314 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001315 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001316 public static final String EXTRA_ALLOW_REPLACE
1317 = "android.intent.extra.ALLOW_REPLACE";
1318
1319 /**
1320 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1321 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1322 * return to the application the result code of the install/uninstall. The returned result
1323 * code will be {@link android.app.Activity#RESULT_OK} on success or
1324 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1325 */
1326 public static final String EXTRA_RETURN_RESULT
1327 = "android.intent.extra.RETURN_RESULT";
1328
1329 /**
1330 * Package manager install result code. @hide because result codes are not
1331 * yet ready to be exposed.
1332 */
1333 public static final String EXTRA_INSTALL_RESULT
1334 = "android.intent.extra.INSTALL_RESULT";
1335
1336 /**
1337 * Activity Action: Launch application uninstaller.
1338 * <p>
1339 * Input: The data must be a package: URI whose scheme specific part is
1340 * the package name of the current installed package to be uninstalled.
1341 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1342 * <p>
1343 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1344 * succeeded.
1345 */
1346 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1347 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1348
1349 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001350 * Specify whether the package should be uninstalled for all users.
1351 * @hide because these should not be part of normal application flow.
1352 */
1353 public static final String EXTRA_UNINSTALL_ALL_USERS
1354 = "android.intent.extra.UNINSTALL_ALL_USERS";
1355
1356 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001357 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1358 * describing the last run version of the platform that was setup.
1359 * @hide
1360 */
1361 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1362
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001363 // ---------------------------------------------------------------------
1364 // ---------------------------------------------------------------------
1365 // Standard intent broadcast actions (see action variable).
1366
1367 /**
1368 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001369 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001370 * <p class="note">This is a protected intent that can only be sent
1371 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001372 */
1373 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1374 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1375 /**
1376 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001377 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001378 * <p class="note">This is a protected intent that can only be sent
1379 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001380 */
1381 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1382 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001383
1384 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001385 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001386 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001387 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001388 * <p class="note">This is a protected intent that can only be sent
1389 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001390 */
1391 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001392 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001393
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001394 /**
1395 * Broadcast Action: The current time has changed. Sent every
1396 * minute. You can <em>not</em> receive this through components declared
1397 * in manifests, only by exlicitly registering for it with
1398 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1399 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001400 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001401 * <p class="note">This is a protected intent that can only be sent
1402 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001403 */
1404 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1405 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1406 /**
1407 * Broadcast Action: The time was set.
1408 */
1409 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1410 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1411 /**
1412 * Broadcast Action: The date has changed.
1413 */
1414 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1415 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1416 /**
1417 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1418 * <ul>
1419 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1420 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001421 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001422 * <p class="note">This is a protected intent that can only be sent
1423 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001424 */
1425 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1426 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1427 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001428 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1429 * DNS entries should be tossed.
1430 * @hide
1431 */
1432 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1433 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1434 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001435 * Alarm Changed Action: This is broadcast when the AlarmClock
1436 * application's alarm is set or unset. It is used by the
1437 * AlarmClock application and the StatusBar service.
1438 * @hide
1439 */
1440 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1441 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1442 /**
1443 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1444 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1445 * @hide
1446 */
1447 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1448 public static final String ACTION_SYNC_STATE_CHANGED
1449 = "android.intent.action.SYNC_STATE_CHANGED";
1450 /**
1451 * Broadcast Action: This is broadcast once, after the system has finished
1452 * booting. It can be used to perform application-specific initialization,
1453 * such as installing alarms. You must hold the
1454 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1455 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001456 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001457 * <p class="note">This is a protected intent that can only be sent
1458 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001459 */
1460 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1461 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1462 /**
1463 * Broadcast Action: This is broadcast when a user action should request a
1464 * temporary system dialog to dismiss. Some examples of temporary system
1465 * dialogs are the notification window-shade and the recent tasks dialog.
1466 */
1467 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1468 /**
1469 * Broadcast Action: Trigger the download and eventual installation
1470 * of a package.
1471 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001472 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001473 * <p class="note">This is a protected intent that can only be sent
1474 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001475 *
1476 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001477 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001478 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1480 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1481 /**
1482 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001483 * device. The data contains the name of the package. Note that the
1484 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001485 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001486 * <ul>
1487 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1488 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1489 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1490 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001491 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001492 * <p class="note">This is a protected intent that can only be sent
1493 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001494 */
1495 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1496 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1497 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001498 * Broadcast Action: A new version of an application package has been
1499 * installed, replacing an existing version that was previously installed.
1500 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001501 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001502 * <ul>
1503 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1504 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001505 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001506 * <p class="note">This is a protected intent that can only be sent
1507 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001508 */
1509 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1510 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1511 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001512 * Broadcast Action: A new version of your application has been installed
1513 * over an existing one. This is only sent to the application that was
1514 * replaced. It does not contain any additional data; to receive it, just
1515 * use an intent filter for this action.
1516 *
1517 * <p class="note">This is a protected intent that can only be sent
1518 * by the system.
1519 */
1520 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1521 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1522 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001523 * Broadcast Action: An existing application package has been removed from
1524 * the device. The data contains the name of the package. The package
1525 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001526 * <ul>
1527 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1528 * to the package.
1529 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1530 * application -- data and code -- is being removed.
1531 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1532 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1533 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001534 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001535 * <p class="note">This is a protected intent that can only be sent
1536 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001537 */
1538 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1539 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1540 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001541 * Broadcast Action: An existing application package has been completely
1542 * removed from the device. The data contains the name of the package.
1543 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1544 * {@link #EXTRA_DATA_REMOVED} is true and
1545 * {@link #EXTRA_REPLACING} is false of that broadcast.
1546 *
1547 * <ul>
1548 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1549 * to the package.
1550 * </ul>
1551 *
1552 * <p class="note">This is a protected intent that can only be sent
1553 * by the system.
1554 */
1555 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1556 public static final String ACTION_PACKAGE_FULLY_REMOVED
1557 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1558 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001559 * Broadcast Action: An existing application package has been changed (e.g.
1560 * a component has been enabled or disabled). The data contains the name of
1561 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001562 * <ul>
1563 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001564 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1565 * of the changed components.
1566 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1567 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001568 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001569 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001570 * <p class="note">This is a protected intent that can only be sent
1571 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001572 */
1573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1574 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1575 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001576 * @hide
1577 * Broadcast Action: Ask system services if there is any reason to
1578 * restart the given package. The data contains the name of the
1579 * package.
1580 * <ul>
1581 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1582 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1583 * </ul>
1584 *
1585 * <p class="note">This is a protected intent that can only be sent
1586 * by the system.
1587 */
1588 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1589 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1590 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001591 * Broadcast Action: The user has restarted a package, and all of its
1592 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001593 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001594 * be removed. Note that the restarted package does <em>not</em>
1595 * receive this broadcast.
1596 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001597 * <ul>
1598 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1599 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001600 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001601 * <p class="note">This is a protected intent that can only be sent
1602 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001603 */
1604 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1605 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1606 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001607 * Broadcast Action: The user has cleared the data of a package. This should
1608 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001609 * its persistent data is erased and this broadcast sent.
1610 * Note that the cleared package does <em>not</em>
1611 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001612 * <ul>
1613 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1614 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001615 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001616 * <p class="note">This is a protected intent that can only be sent
1617 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001618 */
1619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1620 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1621 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001622 * Broadcast Action: A user ID has been removed from the system. The user
1623 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001624 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001625 * <p class="note">This is a protected intent that can only be sent
1626 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001627 */
1628 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1629 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001630
1631 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001632 * Broadcast Action: Sent to the installer package of an application
1633 * when that application is first launched (that is the first time it
1634 * is moved out of the stopped state). The data contains the name of the package.
1635 *
1636 * <p class="note">This is a protected intent that can only be sent
1637 * by the system.
1638 */
1639 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1640 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1641
1642 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001643 * Broadcast Action: Sent to the system package verifier when a package
1644 * needs to be verified. The data contains the package URI.
1645 * <p class="note">
1646 * This is a protected intent that can only be sent by the system.
1647 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001648 */
1649 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1650 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1651
1652 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001653 * Broadcast Action: Sent to the system package verifier when a package is
1654 * verified. The data contains the package URI.
1655 * <p class="note">
1656 * This is a protected intent that can only be sent by the system.
1657 */
1658 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1659 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1660
1661 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001662 * Broadcast Action: Resources for a set of packages (which were
1663 * previously unavailable) are currently
1664 * available since the media on which they exist is available.
1665 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1666 * list of packages whose availability changed.
1667 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1668 * list of uids of packages whose availability changed.
1669 * Note that the
1670 * packages in this list do <em>not</em> receive this broadcast.
1671 * The specified set of packages are now available on the system.
1672 * <p>Includes the following extras:
1673 * <ul>
1674 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1675 * whose resources(were previously unavailable) are currently available.
1676 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1677 * packages whose resources(were previously unavailable)
1678 * are currently available.
1679 * </ul>
1680 *
1681 * <p class="note">This is a protected intent that can only be sent
1682 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001685 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1686 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001687
1688 /**
1689 * Broadcast Action: Resources for a set of packages are currently
1690 * unavailable since the media on which they exist is unavailable.
1691 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1692 * list of packages whose availability changed.
1693 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1694 * list of uids of packages whose availability changed.
1695 * The specified set of packages can no longer be
1696 * launched and are practically unavailable on the system.
1697 * <p>Inclues the following extras:
1698 * <ul>
1699 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1700 * whose resources are no longer available.
1701 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1702 * whose resources are no longer available.
1703 * </ul>
1704 *
1705 * <p class="note">This is a protected intent that can only be sent
1706 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001707 */
1708 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001709 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001710 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001711
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001712 /**
1713 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001714 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001715 * This should <em>only</em> be used to determine when the wallpaper
1716 * has changed to show the new wallpaper to the user. You should certainly
1717 * never, in response to this, change the wallpaper or other attributes of
1718 * it such as the suggested size. That would be crazy, right? You'd cause
1719 * all kinds of loops, especially if other apps are doing similar things,
1720 * right? Of course. So please don't do this.
1721 *
1722 * @deprecated Modern applications should use
1723 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1724 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1725 * shown behind their UI, rather than watching for this broadcast and
1726 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001727 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001728 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001729 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1730 /**
1731 * Broadcast Action: The current device {@link android.content.res.Configuration}
1732 * (orientation, locale, etc) has changed. When such a change happens, the
1733 * UIs (view hierarchy) will need to be rebuilt based on this new
1734 * information; for the most part, applications don't need to worry about
1735 * this, because the system will take care of stopping and restarting the
1736 * application to make sure it sees the new changes. Some system code that
1737 * can not be restarted will need to watch for this action and handle it
1738 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001739 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001740 * <p class="note">
1741 * You can <em>not</em> receive this through components declared
1742 * in manifests, only by explicitly registering for it with
1743 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1744 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001745 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001746 * <p class="note">This is a protected intent that can only be sent
1747 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001748 *
1749 * @see android.content.res.Configuration
1750 */
1751 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1752 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1753 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001754 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001755 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001756 * <p class="note">This is a protected intent that can only be sent
1757 * by the system.
1758 */
1759 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1760 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1761 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001762 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1763 * charging state, level, and other information about the battery.
1764 * See {@link android.os.BatteryManager} for documentation on the
1765 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001766 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001767 * <p class="note">
1768 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001769 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001770 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001771 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1772 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1773 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1774 * broadcasts that are sent and can be received through manifest
1775 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001776 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001777 * <p class="note">This is a protected intent that can only be sent
1778 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001779 */
1780 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1781 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1782 /**
1783 * Broadcast Action: Indicates low battery condition on the device.
1784 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001785 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001786 * <p class="note">This is a protected intent that can only be sent
1787 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001788 */
1789 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1790 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1791 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001792 * Broadcast Action: Indicates the battery is now okay after being low.
1793 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1794 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001795 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001796 * <p class="note">This is a protected intent that can only be sent
1797 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001798 */
1799 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1800 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1801 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001802 * Broadcast Action: External power has been connected to the device.
1803 * This is intended for applications that wish to register specifically to this notification.
1804 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1805 * stay active to receive this notification. This action can be used to implement actions
1806 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001807 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001808 * <p class="note">This is a protected intent that can only be sent
1809 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001810 */
1811 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001812 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001813 /**
1814 * Broadcast Action: External power has been removed from the device.
1815 * This is intended for applications that wish to register specifically to this notification.
1816 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1817 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001818 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001819 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001820 * <p class="note">This is a protected intent that can only be sent
1821 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001824 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001825 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001826 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001827 * Broadcast Action: Device is shutting down.
1828 * This is broadcast when the device is being shut down (completely turned
1829 * off, not sleeping). Once the broadcast is complete, the final shutdown
1830 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001831 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001832 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001833 * <p class="note">This is a protected intent that can only be sent
1834 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001835 */
1836 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001837 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001838 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001839 * Activity Action: Start this activity to request system shutdown.
1840 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1841 * to request confirmation from the user before shutting down.
1842 *
1843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
1845 *
1846 * {@hide}
1847 */
1848 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1849 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001850 * Broadcast Action: A sticky broadcast that indicates low memory
1851 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001852 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001853 * <p class="note">This is a protected intent that can only be sent
1854 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001855 */
1856 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1857 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1858 /**
1859 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001860 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001861 * <p class="note">This is a protected intent that can only be sent
1862 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001863 */
1864 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1865 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1866 /**
Jake Hambybb371632010-08-23 18:16:48 -07001867 * Broadcast Action: A sticky broadcast that indicates a memory full
1868 * condition on the device. This is intended for activities that want
1869 * to be able to fill the data partition completely, leaving only
1870 * enough free space to prevent system-wide SQLite failures.
1871 *
1872 * <p class="note">This is a protected intent that can only be sent
1873 * by the system.
1874 *
1875 * {@hide}
1876 */
1877 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1878 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1879 /**
1880 * Broadcast Action: Indicates memory full condition on the device
1881 * no longer exists.
1882 *
1883 * <p class="note">This is a protected intent that can only be sent
1884 * by the system.
1885 *
1886 * {@hide}
1887 */
1888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1889 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1890 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001891 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1892 * and package management should be started.
1893 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1894 * notification.
1895 */
1896 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1897 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1898 /**
1899 * Broadcast Action: The device has entered USB Mass Storage mode.
1900 * This is used mainly for the USB Settings panel.
1901 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1902 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001903 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001904 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001905 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001906 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1907
1908 /**
1909 * Broadcast Action: The device has exited USB Mass Storage mode.
1910 * This is used mainly for the USB Settings panel.
1911 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1912 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001913 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001914 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001915 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001916 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1917
1918 /**
1919 * Broadcast Action: External media has been removed.
1920 * The path to the mount point for the removed media is contained in the Intent.mData field.
1921 */
1922 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1923 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1924
1925 /**
1926 * Broadcast Action: External media is present, but not mounted at its mount point.
1927 * The path to the mount point for the removed media is contained in the Intent.mData field.
1928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1930 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1931
1932 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001933 * Broadcast Action: External media is present, and being disk-checked
1934 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001935 */
1936 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1937 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1938
1939 /**
1940 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1941 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001942 */
1943 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1944 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1945
1946 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001947 * Broadcast Action: External media is present and mounted at its mount point.
1948 * The path to the mount point for the removed media is contained in the Intent.mData field.
1949 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1950 * media was mounted read only.
1951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1954
1955 /**
1956 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001957 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001958 */
1959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1960 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1961
1962 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001963 * Broadcast Action: External media is no longer being shared via USB mass storage.
1964 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1965 *
1966 * @hide
1967 */
1968 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1969
1970 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001971 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1972 * The path to the mount point for the removed media is contained in the Intent.mData field.
1973 */
1974 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1975 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1976
1977 /**
1978 * Broadcast Action: External media is present but cannot be mounted.
1979 * The path to the mount point for the removed media is contained in the Intent.mData field.
1980 */
1981 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1982 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1983
1984 /**
1985 * Broadcast Action: User has expressed the desire to remove the external storage media.
1986 * Applications should close all files they have open within the mount point when they receive this intent.
1987 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1988 */
1989 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1990 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1991
1992 /**
1993 * Broadcast Action: The media scanner has started scanning a directory.
1994 * The path to the directory being scanned is contained in the Intent.mData field.
1995 */
1996 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1997 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1998
1999 /**
2000 * Broadcast Action: The media scanner has finished scanning a directory.
2001 * The path to the scanned directory is contained in the Intent.mData field.
2002 */
2003 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2004 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2005
2006 /**
2007 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2008 * The path to the file is contained in the Intent.mData field.
2009 */
2010 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2011 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2012
2013 /**
2014 * Broadcast Action: The "Media Button" was pressed. Includes a single
2015 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2016 * caused the broadcast.
2017 */
2018 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2019 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2020
2021 /**
2022 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2023 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2024 * caused the broadcast.
2025 */
2026 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2027 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2028
2029 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2030 // location; they are not general-purpose actions.
2031
2032 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002033 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002034 */
2035 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2036 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2037 "android.intent.action.GTALK_CONNECTED";
2038
2039 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002040 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002041 */
2042 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2043 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2044 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002045
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002046 /**
2047 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002048 */
2049 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2050 public static final String ACTION_INPUT_METHOD_CHANGED =
2051 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002052
2053 /**
2054 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2055 * more radios have been turned off or on. The intent will have the following extra value:</p>
2056 * <ul>
2057 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2058 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2059 * turned off</li>
2060 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002061 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002062 * <p class="note">This is a protected intent that can only be sent
2063 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002064 */
2065 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2066 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2067
2068 /**
2069 * Broadcast Action: Some content providers have parts of their namespace
2070 * where they publish new events or items that the user may be especially
2071 * interested in. For these things, they may broadcast this action when the
2072 * set of interesting items change.
2073 *
2074 * For example, GmailProvider sends this notification when the set of unread
2075 * mail in the inbox changes.
2076 *
2077 * <p>The data of the intent identifies which part of which provider
2078 * changed. When queried through the content resolver, the data URI will
2079 * return the data set in question.
2080 *
2081 * <p>The intent will have the following extra values:
2082 * <ul>
2083 * <li><em>count</em> - The number of items in the data set. This is the
2084 * same as the number of items in the cursor returned by querying the
2085 * data URI. </li>
2086 * </ul>
2087 *
2088 * This intent will be sent at boot (if the count is non-zero) and when the
2089 * data set changes. It is possible for the data set to change without the
2090 * count changing (for example, if a new unread message arrives in the same
2091 * sync operation in which a message is archived). The phone should still
2092 * ring/vibrate/etc as normal in this case.
2093 */
2094 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2095 public static final String ACTION_PROVIDER_CHANGED =
2096 "android.intent.action.PROVIDER_CHANGED";
2097
2098 /**
2099 * Broadcast Action: Wired Headset plugged in or unplugged.
2100 *
2101 * <p>The intent will have the following extra values:
2102 * <ul>
2103 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2104 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002105 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002106 * </ul>
2107 * </ul>
2108 */
2109 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2110 public static final String ACTION_HEADSET_PLUG =
2111 "android.intent.action.HEADSET_PLUG";
2112
2113 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002114 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2115 *
2116 * <p>The intent will have the following extra values:
2117 * <ul>
2118 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2119 * <li><em>name</em> - Headset type, human readable string </li>
2120 * </ul>
2121 * </ul>
2122 * @hide
2123 */
2124 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002125 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2126 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002127
2128 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002129 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002130 *
2131 * <p>The intent will have the following extra values:
2132 * <ul>
2133 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2134 * <li><em>name</em> - Headset type, human readable string </li>
2135 * </ul>
2136 * </ul>
2137 * @hide
2138 */
2139 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002140 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2141 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002142
2143 /**
2144 * Broadcast Action: A HMDI cable was plugged or unplugged
2145 *
2146 * <p>The intent will have the following extra values:
2147 * <ul>
2148 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2149 * <li><em>name</em> - HDMI cable, human readable string </li>
2150 * </ul>
2151 * </ul>
2152 * @hide
2153 */
2154 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2155 public static final String ACTION_HDMI_AUDIO_PLUG =
2156 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002157
2158 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002159 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2160 *
2161 * <p>The intent will have the following extra values:
2162 * <ul>
2163 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2164 * <li><em>card</em> - ALSA card number (integer) </li>
2165 * <li><em>device</em> - ALSA device number (integer) </li>
2166 * </ul>
2167 * </ul>
2168 * @hide
2169 */
2170 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2171 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2172 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2173
2174 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002175 * Broadcast Action: A USB audio device was plugged in or unplugged.
2176 *
2177 * <p>The intent will have the following extra values:
2178 * <ul>
2179 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2180 * <li><em>card</em> - ALSA card number (integer) </li>
2181 * <li><em>device</em> - ALSA device number (integer) </li>
2182 * </ul>
2183 * </ul>
2184 * @hide
2185 */
2186 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2187 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2188 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2189
2190 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002191 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2192 * <ul>
2193 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2194 * </ul>
2195 *
2196 * <p class="note">This is a protected intent that can only be sent
2197 * by the system.
2198 *
2199 * @hide
2200 */
2201 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2202 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2203 = "android.intent.action.ADVANCED_SETTINGS";
2204
2205 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002206 * Broadcast Action: An outgoing call is about to be placed.
2207 *
2208 * <p>The Intent will have the following extra value:
2209 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002210 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002211 * the phone number originally intended to be dialed.</li>
2212 * </ul>
2213 * <p>Once the broadcast is finished, the resultData is used as the actual
2214 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002215 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002216 * outgoing call in turn: for example, a parental control application
2217 * might verify that the user is authorized to place the call at that
2218 * time, then a number-rewriting application might add an area code if
2219 * one was not specified.</p>
2220 * <p>For consistency, any receiver whose purpose is to prohibit phone
2221 * calls should have a priority of 0, to ensure it will see the final
2222 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002223 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002224 * should have a positive priority.
2225 * Negative priorities are reserved for the system for this broadcast;
2226 * using them may cause problems.</p>
2227 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2228 * abort the broadcast.</p>
2229 * <p>Emergency calls cannot be intercepted using this mechanism, and
2230 * other calls cannot be modified to call emergency numbers using this
2231 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002232 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002233 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2234 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002235 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002236 * <p class="note">This is a protected intent that can only be sent
2237 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002238 */
2239 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2240 public static final String ACTION_NEW_OUTGOING_CALL =
2241 "android.intent.action.NEW_OUTGOING_CALL";
2242
2243 /**
2244 * Broadcast Action: Have the device reboot. This is only for use by
2245 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002246 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002247 * <p class="note">This is a protected intent that can only be sent
2248 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2251 public static final String ACTION_REBOOT =
2252 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002253
Wei Huang97ecc9c2009-05-11 17:44:20 -07002254 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002255 * Broadcast Action: A sticky broadcast for changes in the physical
2256 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002257 *
2258 * <p>The intent will have the following extra values:
2259 * <ul>
2260 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002261 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002262 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002263 * <p>This is intended for monitoring the current physical dock state.
2264 * See {@link android.app.UiModeManager} for the normal API dealing with
2265 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002266 */
2267 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2268 public static final String ACTION_DOCK_EVENT =
2269 "android.intent.action.DOCK_EVENT";
2270
2271 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002272 * Broadcast Action: a remote intent is to be broadcasted.
2273 *
2274 * A remote intent is used for remote RPC between devices. The remote intent
2275 * is serialized and sent from one device to another device. The receiving
2276 * device parses the remote intent and broadcasts it. Note that anyone can
2277 * broadcast a remote intent. However, if the intent receiver of the remote intent
2278 * does not trust intent broadcasts from arbitrary intent senders, it should require
2279 * the sender to hold certain permissions so only trusted sender's broadcast will be
2280 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002281 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002282 */
2283 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002284 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002285
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002286 /**
2287 * Broadcast Action: hook for permforming cleanup after a system update.
2288 *
2289 * The broadcast is sent when the system is booting, before the
2290 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2291 * image. A receiver for this should do its work and then disable itself
2292 * so that it does not get run again at the next boot.
2293 * @hide
2294 */
2295 public static final String ACTION_PRE_BOOT_COMPLETED =
2296 "android.intent.action.PRE_BOOT_COMPLETED";
2297
Amith Yamasani13593602012-03-22 16:16:17 -07002298 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002299 * Sent the first time a user is starting, to allow system apps to
2300 * perform one time initialization. (This will not be seen by third
2301 * party applications because a newly initialized user does not have any
2302 * third party applications installed for it.) This is sent early in
2303 * starting the user, around the time the home app is started, before
2304 * {@link #ACTION_BOOT_COMPLETED} is sent.
2305 */
2306 public static final String ACTION_USER_INITIALIZE =
2307 "android.intent.action.USER_INITIALIZE";
2308
2309 /**
2310 * Sent when a user switch is happening, causing the process's user to be
2311 * brought to the foreground. This is only sent to receivers registered
2312 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2313 * Context.registerReceiver}. It is sent to the user that is going to the
2314 * foreground.
2315 */
2316 public static final String ACTION_USER_FOREGROUND =
2317 "android.intent.action.USER_FOREGROUND";
2318
2319 /**
2320 * Sent when a user switch is happening, causing the process's user to be
2321 * sent to the background. This is only sent to receivers registered
2322 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2323 * Context.registerReceiver}. It is sent to the user that is going to the
2324 * background.
2325 */
2326 public static final String ACTION_USER_BACKGROUND =
2327 "android.intent.action.USER_BACKGROUND";
2328
2329 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002330 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USER_HANDLE that has the
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002331 * userHandle of the new user. It is sent to all running users. You must hold
2332 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002333 * @hide
2334 */
2335 public static final String ACTION_USER_ADDED =
2336 "android.intent.action.USER_ADDED";
2337
2338 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002339 * Broadcast sent to the system when a user is started. Carries an extra EXTRA_USER_HANDLE that has
2340 * the userHandle of the user. This is only sent to
2341 * registered receivers, not manifest receivers. It is sent to the user
2342 * that has been started.
2343 * @hide
2344 */
2345 public static final String ACTION_USER_STARTED =
2346 "android.intent.action.USER_STARTED";
2347
2348 /**
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002349 * Broadcast sent to the system when a user is stopped. Carries an extra EXTRA_USER_HANDLE that has
2350 * the userHandle of the user. This is similar to {@link #ACTION_PACKAGE_RESTARTED},
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002351 * but for an entire user instead of a specific package. This is only sent to
2352 * registered receivers, not manifest receivers. It is sent to all running
2353 * users <em>except</em> the one that has just been stopped (which is no
2354 * longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002355 * @hide
2356 */
2357 public static final String ACTION_USER_STOPPED =
2358 "android.intent.action.USER_STOPPED";
2359
2360 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002361 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002362 * the userHandle of the user. It is sent to all running users except the
2363 * one that has been removed. You must hold
2364 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002365 * @hide
2366 */
2367 public static final String ACTION_USER_REMOVED =
2368 "android.intent.action.USER_REMOVED";
2369
2370 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002371 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002372 * the userHandle of the user to become the current one. This is only sent to
2373 * registered receivers, not manifest receivers. It is sent to all running users.
2374 * You must hold
2375 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002376 * @hide
2377 */
2378 public static final String ACTION_USER_SWITCHED =
2379 "android.intent.action.USER_SWITCHED";
2380
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002381 // ---------------------------------------------------------------------
2382 // ---------------------------------------------------------------------
2383 // Standard intent categories (see addCategory()).
2384
2385 /**
2386 * Set if the activity should be an option for the default action
2387 * (center press) to perform on a piece of data. Setting this will
2388 * hide from the user any activities without it set when performing an
2389 * action on some data. Note that this is normal -not- set in the
2390 * Intent when initiating an action -- it is for use in intent filters
2391 * specified in packages.
2392 */
2393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2394 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2395 /**
2396 * Activities that can be safely invoked from a browser must support this
2397 * category. For example, if the user is viewing a web page or an e-mail
2398 * and clicks on a link in the text, the Intent generated execute that
2399 * link will require the BROWSABLE category, so that only activities
2400 * supporting this category will be considered as possible actions. By
2401 * supporting this category, you are promising that there is nothing
2402 * damaging (without user intervention) that can happen by invoking any
2403 * matching Intent.
2404 */
2405 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2406 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2407 /**
2408 * Set if the activity should be considered as an alternative action to
2409 * the data the user is currently viewing. See also
2410 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2411 * applies to the selection in a list of items.
2412 *
2413 * <p>Supporting this category means that you would like your activity to be
2414 * displayed in the set of alternative things the user can do, usually as
2415 * part of the current activity's options menu. You will usually want to
2416 * include a specific label in the &lt;intent-filter&gt; of this action
2417 * describing to the user what it does.
2418 *
2419 * <p>The action of IntentFilter with this category is important in that it
2420 * describes the specific action the target will perform. This generally
2421 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2422 * a specific name such as "com.android.camera.action.CROP. Only one
2423 * alternative of any particular action will be shown to the user, so using
2424 * a specific action like this makes sure that your alternative will be
2425 * displayed while also allowing other applications to provide their own
2426 * overrides of that particular action.
2427 */
2428 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2429 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2430 /**
2431 * Set if the activity should be considered as an alternative selection
2432 * action to the data the user has currently selected. This is like
2433 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2434 * of items from which the user can select, giving them alternatives to the
2435 * default action that will be performed on it.
2436 */
2437 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2438 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2439 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002440 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002441 */
2442 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2443 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2444 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002445 * Should be displayed in the top-level launcher.
2446 */
2447 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2448 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2449 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002450 * Provides information about the package it is in; typically used if
2451 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2452 * a front-door to the user without having to be shown in the all apps list.
2453 */
2454 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2455 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2456 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002457 * This is the home activity, that is the first activity that is displayed
2458 * when the device boots.
2459 */
2460 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2461 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2462 /**
2463 * This activity is a preference panel.
2464 */
2465 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2466 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2467 /**
2468 * This activity is a development preference panel.
2469 */
2470 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2471 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2472 /**
2473 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002474 */
2475 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2476 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2477 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002478 * This activity allows the user to browse and download new applications.
2479 */
2480 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2481 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2482 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002483 * This activity may be exercised by the monkey or other automated test tools.
2484 */
2485 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2486 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2487 /**
2488 * To be used as a test (not part of the normal user experience).
2489 */
2490 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2491 /**
2492 * To be used as a unit test (run through the Test Harness).
2493 */
2494 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2495 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002496 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002497 * experience).
2498 */
2499 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2500 /**
2501 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2502 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2503 * when queried, though it is allowable for those columns to be blank.
2504 */
2505 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2506 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2507
2508 /**
2509 * To be used as code under test for framework instrumentation tests.
2510 */
2511 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2512 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002513 /**
2514 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002515 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2516 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002517 */
2518 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2519 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2520 /**
2521 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002522 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2523 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002524 */
2525 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2526 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002527 /**
2528 * An activity to run when device is inserted into a analog (low end) dock.
2529 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2530 * information, see {@link android.app.UiModeManager}.
2531 */
2532 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2533 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2534
2535 /**
2536 * An activity to run when device is inserted into a digital (high end) dock.
2537 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2538 * information, see {@link android.app.UiModeManager}.
2539 */
2540 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2541 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002542
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002543 /**
2544 * Used to indicate that the activity can be used in a car environment.
2545 */
2546 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2547 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2548
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002549 // ---------------------------------------------------------------------
2550 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002551 // Application launch intent categories (see addCategory()).
2552
2553 /**
2554 * Used with {@link #ACTION_MAIN} to launch the browser application.
2555 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002556 * <p>NOTE: This should not be used as the primary key of an Intent,
2557 * since it will not result in the app launching with the correct
2558 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002559 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002560 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002561 */
2562 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2563 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2564
2565 /**
2566 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2567 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002568 * <p>NOTE: This should not be used as the primary key of an Intent,
2569 * since it will not result in the app launching with the correct
2570 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002571 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002572 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002573 */
2574 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2575 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2576
2577 /**
2578 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2579 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002580 * <p>NOTE: This should not be used as the primary key of an Intent,
2581 * since it will not result in the app launching with the correct
2582 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002583 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002584 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002585 */
2586 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2587 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2588
2589 /**
2590 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2591 * The activity should be able to view and manipulate address book entries.
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_CONTACTS = "android.intent.category.APP_CONTACTS";
2600
2601 /**
2602 * Used with {@link #ACTION_MAIN} to launch the email application.
2603 * The activity should be able to send and receive email.
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_EMAIL = "android.intent.category.APP_EMAIL";
2612
2613 /**
2614 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2615 * The activity should be able to view and manipulate image and video files
2616 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002617 * <p>NOTE: This should not be used as the primary key of an Intent,
2618 * since it will not result in the app launching with the correct
2619 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002620 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002621 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002622 */
2623 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2624 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2625
2626 /**
2627 * Used with {@link #ACTION_MAIN} to launch the maps application.
2628 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002629 * <p>NOTE: This should not be used as the primary key of an Intent,
2630 * since it will not result in the app launching with the correct
2631 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002632 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002633 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002634 */
2635 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2636 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2637
2638 /**
2639 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2640 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002641 * <p>NOTE: This should not be used as the primary key of an Intent,
2642 * since it will not result in the app launching with the correct
2643 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002644 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002645 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002646 */
2647 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2648 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2649
2650 /**
2651 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002652 * The activity should be able to play, browse, or manipulate music files
2653 * stored on the device.
2654 * <p>NOTE: This should not be used as the primary key of an Intent,
2655 * since it will not result in the app launching with the correct
2656 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002657 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002658 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002659 */
2660 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2661 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2662
2663 // ---------------------------------------------------------------------
2664 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002665 // Standard extra data keys.
2666
2667 /**
2668 * The initial data to place in a newly created record. Use with
2669 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2670 * fields as would be given to the underlying ContentProvider.insert()
2671 * call.
2672 */
2673 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2674
2675 /**
2676 * A constant CharSequence that is associated with the Intent, used with
2677 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2678 * this may be a styled CharSequence, so you must use
2679 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2680 * retrieve it.
2681 */
2682 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2683
2684 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002685 * A constant String that is associated with the Intent, used with
2686 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2687 * as HTML formatted text. Note that you <em>must</em> also supply
2688 * {@link #EXTRA_TEXT}.
2689 */
2690 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2691
2692 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002693 * A content: URI holding a stream of data associated with the Intent,
2694 * used with {@link #ACTION_SEND} to supply the data being sent.
2695 */
2696 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2697
2698 /**
2699 * A String[] holding e-mail addresses that should be delivered to.
2700 */
2701 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2702
2703 /**
2704 * A String[] holding e-mail addresses that should be carbon copied.
2705 */
2706 public static final String EXTRA_CC = "android.intent.extra.CC";
2707
2708 /**
2709 * A String[] holding e-mail addresses that should be blind carbon copied.
2710 */
2711 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2712
2713 /**
2714 * A constant string holding the desired subject line of a message.
2715 */
2716 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2717
2718 /**
2719 * An Intent describing the choices you would like shown with
2720 * {@link #ACTION_PICK_ACTIVITY}.
2721 */
2722 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2723
2724 /**
2725 * A CharSequence dialog title to provide to the user when used with a
2726 * {@link #ACTION_CHOOSER}.
2727 */
2728 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2729
2730 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002731 * A Parcelable[] of {@link Intent} or
2732 * {@link android.content.pm.LabeledIntent} objects as set with
2733 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2734 * a the front of the list of choices, when shown to the user with a
2735 * {@link #ACTION_CHOOSER}.
2736 */
2737 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2738
2739 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002740 * A {@link android.view.KeyEvent} object containing the event that
2741 * triggered the creation of the Intent it is in.
2742 */
2743 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2744
2745 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002746 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2747 * before shutting down.
2748 *
2749 * {@hide}
2750 */
2751 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2752
2753 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002754 * 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 -07002755 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2756 * of restarting the application.
2757 */
2758 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2759
2760 /**
2761 * A String holding the phone number originally entered in
2762 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2763 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2764 */
2765 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002766
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002767 /**
2768 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2769 * intents to supply the uid the package had been assigned. Also an optional
2770 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2771 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2772 * purpose.
2773 */
2774 public static final String EXTRA_UID = "android.intent.extra.UID";
2775
2776 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002777 * @hide String array of package names.
2778 */
2779 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2780
2781 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002782 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2783 * intents to indicate whether this represents a full uninstall (removing
2784 * both the code and its data) or a partial uninstall (leaving its data,
2785 * implying that this is an update).
2786 */
2787 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002788
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002789 /**
2790 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2791 * intents to indicate that this is a replacement of the package, so this
2792 * broadcast will immediately be followed by an add broadcast for a
2793 * different version of the same package.
2794 */
2795 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002796
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002797 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002798 * Used as an int extra field in {@link android.app.AlarmManager} intents
2799 * to tell the application being invoked how many pending alarms are being
2800 * delievered with the intent. For one-shot alarms this will always be 1.
2801 * For recurring alarms, this might be greater than 1 if the device was
2802 * asleep or powered off at the time an earlier alarm would have been
2803 * delivered.
2804 */
2805 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002806
Jacek Surazski86b6c532009-05-13 14:38:28 +02002807 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002808 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2809 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002810 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2811 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002812 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2813 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2814 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002815 */
2816 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2817
2818 /**
2819 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2820 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002821 */
2822 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2823
2824 /**
2825 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2826 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002827 */
2828 public static final int EXTRA_DOCK_STATE_DESK = 1;
2829
2830 /**
2831 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2832 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002833 */
2834 public static final int EXTRA_DOCK_STATE_CAR = 2;
2835
2836 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002837 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2838 * to represent that the phone is in a analog (low end) dock.
2839 */
2840 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2841
2842 /**
2843 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2844 * to represent that the phone is in a digital (high end) dock.
2845 */
2846 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2847
2848 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002849 * Boolean that can be supplied as meta-data with a dock activity, to
2850 * indicate that the dock should take over the home key when it is active.
2851 */
2852 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002853
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002854 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002855 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2856 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002857 */
2858 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2859
2860 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002861 * Used in the extra field in the remote intent. It's astring token passed with the
2862 * remote intent.
2863 */
2864 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2865 "android.intent.extra.remote_intent_token";
2866
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002867 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002868 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002869 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002870 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002871 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002872 "android.intent.extra.changed_component_name";
2873
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002874 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002875 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002876 * and contains a string array of all of the components that have changed.
2877 */
2878 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2879 "android.intent.extra.changed_component_name_list";
2880
2881 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002882 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002883 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2884 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002885 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002886 */
2887 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2888 "android.intent.extra.changed_package_list";
2889
2890 /**
2891 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002892 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2893 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002894 * and contains an integer array of uids of all of the components
2895 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002896 */
2897 public static final String EXTRA_CHANGED_UID_LIST =
2898 "android.intent.extra.changed_uid_list";
2899
2900 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002901 * @hide
2902 * Magic extra system code can use when binding, to give a label for
2903 * who it is that has bound to a service. This is an integer giving
2904 * a framework string resource that can be displayed to the user.
2905 */
2906 public static final String EXTRA_CLIENT_LABEL =
2907 "android.intent.extra.client_label";
2908
2909 /**
2910 * @hide
2911 * Magic extra system code can use when binding, to give a PendingIntent object
2912 * that can be launched for the user to disable the system's use of this
2913 * service.
2914 */
2915 public static final String EXTRA_CLIENT_INTENT =
2916 "android.intent.extra.client_intent";
2917
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002918 /**
2919 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2920 * data that is on the local device. This is a boolean extra; the default
2921 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2922 * the user to select media that is already on the device, not requiring it
2923 * be downloaded from a remote service when opened. Another way to look
2924 * at it is that such content should generally have a "_data" column to the
2925 * path of the content on local external storage.
2926 */
2927 public static final String EXTRA_LOCAL_ONLY =
2928 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002929
Amith Yamasani13593602012-03-22 16:16:17 -07002930 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002931 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07002932 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2933 * @hide
2934 */
Amith Yamasani2a003292012-08-14 18:25:45 -07002935 public static final String EXTRA_USER_HANDLE =
2936 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07002937
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002938 // ---------------------------------------------------------------------
2939 // ---------------------------------------------------------------------
2940 // Intent flags (see mFlags variable).
2941
2942 /**
2943 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002944 * perform read operations on the Uri in the Intent's data and any URIs
2945 * specified in its ClipData. When applying to an Intent's ClipData,
2946 * all URIs as well as recursive traversals through data or other ClipData
2947 * in Intent items will be granted; only the grant flags of the top-level
2948 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002949 */
2950 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2951 /**
2952 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002953 * perform write operations on the Uri in the Intent's data and any URIs
2954 * specified in its ClipData. When applying to an Intent's ClipData,
2955 * all URIs as well as recursive traversals through data or other ClipData
2956 * in Intent items will be granted; only the grant flags of the top-level
2957 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002958 */
2959 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2960 /**
2961 * Can be set by the caller to indicate that this Intent is coming from
2962 * a background operation, not from direct user interaction.
2963 */
2964 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2965 /**
2966 * A flag you can enable for debugging: when set, log messages will be
2967 * printed during the resolution of this intent to show you what has
2968 * been found to create the final resolved list.
2969 */
2970 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002971 /**
2972 * If set, this intent will not match any components in packages that
2973 * are currently stopped. If this is not set, then the default behavior
2974 * is to include such applications in the result.
2975 */
2976 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2977 /**
2978 * If set, this intent will always match any components in packages that
2979 * are currently stopped. This is the default behavior when
2980 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2981 * flags are set, this one wins (it allows overriding of exclude for
2982 * places where the framework may automatically set the exclude flag).
2983 */
2984 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002985
2986 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002987 * If set, the new activity is not kept in the history stack. As soon as
2988 * the user navigates away from it, the activity is finished. This may also
2989 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2990 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002991 */
2992 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2993 /**
2994 * If set, the activity will not be launched if it is already running
2995 * at the top of the history stack.
2996 */
2997 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2998 /**
2999 * If set, this activity will become the start of a new task on this
3000 * history stack. A task (from the activity that started it to the
3001 * next task activity) defines an atomic group of activities that the
3002 * user can move to. Tasks can be moved to the foreground and background;
3003 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003004 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003005 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3006 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003007 *
3008 * <p>This flag is generally used by activities that want
3009 * to present a "launcher" style behavior: they give the user a list of
3010 * separate things that can be done, which otherwise run completely
3011 * independently of the activity launching them.
3012 *
3013 * <p>When using this flag, if a task is already running for the activity
3014 * you are now starting, then a new activity will not be started; instead,
3015 * the current task will simply be brought to the front of the screen with
3016 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3017 * to disable this behavior.
3018 *
3019 * <p>This flag can not be used when the caller is requesting a result from
3020 * the activity being launched.
3021 */
3022 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3023 /**
3024 * <strong>Do not use this flag unless you are implementing your own
3025 * top-level application launcher.</strong> Used in conjunction with
3026 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3027 * behavior of bringing an existing task to the foreground. When set,
3028 * a new task is <em>always</em> started to host the Activity for the
3029 * Intent, regardless of whether there is already an existing task running
3030 * the same thing.
3031 *
3032 * <p><strong>Because the default system does not include graphical task management,
3033 * you should not use this flag unless you provide some way for a user to
3034 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003035 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003036 * <p>This flag is ignored if
3037 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3038 *
Scott Main7aee61f2011-02-08 11:25:01 -08003039 * <p>See
3040 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3041 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003042 */
3043 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3044 /**
3045 * If set, and the activity being launched is already running in the
3046 * current task, then instead of launching a new instance of that activity,
3047 * all of the other activities on top of it will be closed and this Intent
3048 * will be delivered to the (now on top) old activity as a new Intent.
3049 *
3050 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3051 * If D calls startActivity() with an Intent that resolves to the component
3052 * of activity B, then C and D will be finished and B receive the given
3053 * Intent, resulting in the stack now being: A, B.
3054 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003055 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003056 * either receive the new intent you are starting here in its
3057 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003058 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003059 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3060 * the same intent, then it will be finished and re-created; for all other
3061 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3062 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003063 *
3064 * <p>This launch mode can also be used to good effect in conjunction with
3065 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3066 * of a task, it will bring any currently running instance of that task
3067 * to the foreground, and then clear it to its root state. This is
3068 * especially useful, for example, when launching an activity from the
3069 * notification manager.
3070 *
Scott Main7aee61f2011-02-08 11:25:01 -08003071 * <p>See
3072 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3073 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003074 */
3075 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3076 /**
3077 * If set and this intent is being used to launch a new activity from an
3078 * existing one, then the reply target of the existing activity will be
3079 * transfered to the new activity. This way the new activity can call
3080 * {@link android.app.Activity#setResult} and have that result sent back to
3081 * the reply target of the original activity.
3082 */
3083 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3084 /**
3085 * If set and this intent is being used to launch a new activity from an
3086 * existing one, the current activity will not be counted as the top
3087 * activity for deciding whether the new intent should be delivered to
3088 * the top instead of starting a new one. The previous activity will
3089 * be used as the top, with the assumption being that the current activity
3090 * will finish itself immediately.
3091 */
3092 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3093 /**
3094 * If set, the new activity is not kept in the list of recently launched
3095 * activities.
3096 */
3097 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3098 /**
3099 * This flag is not normally set by application code, but set for you by
3100 * the system as described in the
3101 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3102 * launchMode} documentation for the singleTask mode.
3103 */
3104 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3105 /**
3106 * If set, and this activity is either being started in a new task or
3107 * bringing to the top an existing task, then it will be launched as
3108 * the front door of the task. This will result in the application of
3109 * any affinities needed to have that task in the proper state (either
3110 * moving activities to or from it), or simply resetting that task to
3111 * its initial state if needed.
3112 */
3113 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3114 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003115 * This flag is not normally set by application code, but set for you by
3116 * the system if this activity is being launched from history
3117 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003118 */
3119 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003120 /**
3121 * If set, this marks a point in the task's activity stack that should
3122 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003123 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003124 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3125 * the user re-launching it from home), this activity and all on top of
3126 * it will be finished so that the user does not return to them, but
3127 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003128 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003129 * <p>This is useful for cases where you have a logical break in your
3130 * application. For example, an e-mail application may have a command
3131 * to view an attachment, which launches an image view activity to
3132 * display it. This activity should be part of the e-mail application's
3133 * task, since it is a part of the task the user is involved in. However,
3134 * if the user leaves that task, and later selects the e-mail app from
3135 * home, we may like them to return to the conversation they were
3136 * viewing, not the picture attachment, since that is confusing. By
3137 * setting this flag when launching the image viewer, that viewer and
3138 * any activities it starts will be removed the next time the user returns
3139 * to mail.
3140 */
3141 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003142 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003143 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003144 * callback from occurring on the current frontmost activity before it is
3145 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003146 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003147 * <p>Typically, an activity can rely on that callback to indicate that an
3148 * explicit user action has caused their activity to be moved out of the
3149 * foreground. The callback marks an appropriate point in the activity's
3150 * lifecycle for it to dismiss any notifications that it intends to display
3151 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003152 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003153 * <p>If an activity is ever started via any non-user-driven events such as
3154 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3155 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003156 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003157 */
3158 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003159 /**
3160 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3161 * this flag will cause the launched activity to be brought to the front of its
3162 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003163 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003164 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3165 * If D calls startActivity() with an Intent that resolves to the component
3166 * of activity B, then B will be brought to the front of the history stack,
3167 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003168 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003169 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003170 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003171 */
3172 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003173 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003174 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3175 * this flag will prevent the system from applying an activity transition
3176 * animation to go to the next activity state. This doesn't mean an
3177 * animation will never run -- if another activity change happens that doesn't
3178 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003179 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003180 * when you are going to do a series of activity operations but the
3181 * animation seen by the user shouldn't be driven by the first activity
3182 * change but rather a later one.
3183 */
3184 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3185 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003186 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3187 * this flag will cause any existing task that would be associated with the
3188 * activity to be cleared before the activity is started. That is, the activity
3189 * becomes the new root of an otherwise empty task, and any old activities
3190 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3191 */
3192 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3193 /**
3194 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3195 * this flag will cause a newly launching task to be placed on top of the current
3196 * home activity task (if there is one). That is, pressing back from the task
3197 * will always return the user to home even if that was not the last activity they
3198 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3199 */
3200 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3201 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003202 * If set, when sending a broadcast only registered receivers will be
3203 * called -- no BroadcastReceiver components will be launched.
3204 */
3205 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003206 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003207 * If set, when sending a broadcast the new broadcast will replace
3208 * any existing pending broadcast that matches it. Matching is defined
3209 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3210 * true for the intents of the two broadcasts. When a match is found,
3211 * the new broadcast (and receivers associated with it) will replace the
3212 * existing one in the pending broadcast list, remaining at the same
3213 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003214 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003215 * <p>This flag is most typically used with sticky broadcasts, which
3216 * only care about delivering the most recent values of the broadcast
3217 * to their receivers.
3218 */
3219 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3220 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003221 * If set, when sending a broadcast the recipient is allowed to run at
3222 * foreground priority, with a shorter timeout interval. During normal
3223 * broadcasts the receivers are not automatically hoisted out of the
3224 * background priority class.
3225 */
3226 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3227 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003228 * If set, when sending a broadcast <i>before boot has completed</i> only
3229 * registered receivers will be called -- no BroadcastReceiver components
3230 * will be launched. Sticky intent state will be recorded properly even
3231 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3232 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003233 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003234 * <p>This flag is only for use by system sevices as a convenience to
3235 * avoid having to implement a more complex mechanism around detection
3236 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003237 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003238 * @hide
3239 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003240 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003241 /**
3242 * Set when this broadcast is for a boot upgrade, a special mode that
3243 * allows the broadcast to be sent before the system is ready and launches
3244 * the app process with no providers running in it.
3245 * @hide
3246 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003247 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003248
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003249 /**
3250 * @hide Flags that can't be changed with PendingIntent.
3251 */
3252 public static final int IMMUTABLE_FLAGS =
3253 FLAG_GRANT_READ_URI_PERMISSION
3254 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003255
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003256 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003257 // ---------------------------------------------------------------------
3258 // toUri() and parseUri() options.
3259
3260 /**
3261 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3262 * always has the "intent:" scheme. This syntax can be used when you want
3263 * to later disambiguate between URIs that are intended to describe an
3264 * Intent vs. all others that should be treated as raw URIs. When used
3265 * with {@link #parseUri}, any other scheme will result in a generic
3266 * VIEW action for that raw URI.
3267 */
3268 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003269
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003270 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003271
3272 private String mAction;
3273 private Uri mData;
3274 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003275 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003276 private ComponentName mComponent;
3277 private int mFlags;
3278 private HashSet<String> mCategories;
3279 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003280 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003281 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003282 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003283
3284 // ---------------------------------------------------------------------
3285
3286 /**
3287 * Create an empty intent.
3288 */
3289 public Intent() {
3290 }
3291
3292 /**
3293 * Copy constructor.
3294 */
3295 public Intent(Intent o) {
3296 this.mAction = o.mAction;
3297 this.mData = o.mData;
3298 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003299 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003300 this.mComponent = o.mComponent;
3301 this.mFlags = o.mFlags;
3302 if (o.mCategories != null) {
3303 this.mCategories = new HashSet<String>(o.mCategories);
3304 }
3305 if (o.mExtras != null) {
3306 this.mExtras = new Bundle(o.mExtras);
3307 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003308 if (o.mSourceBounds != null) {
3309 this.mSourceBounds = new Rect(o.mSourceBounds);
3310 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003311 if (o.mSelector != null) {
3312 this.mSelector = new Intent(o.mSelector);
3313 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003314 if (o.mClipData != null) {
3315 this.mClipData = new ClipData(o.mClipData);
3316 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003317 }
3318
3319 @Override
3320 public Object clone() {
3321 return new Intent(this);
3322 }
3323
3324 private Intent(Intent o, boolean all) {
3325 this.mAction = o.mAction;
3326 this.mData = o.mData;
3327 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003328 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003329 this.mComponent = o.mComponent;
3330 if (o.mCategories != null) {
3331 this.mCategories = new HashSet<String>(o.mCategories);
3332 }
3333 }
3334
3335 /**
3336 * Make a clone of only the parts of the Intent that are relevant for
3337 * filter matching: the action, data, type, component, and categories.
3338 */
3339 public Intent cloneFilter() {
3340 return new Intent(this, false);
3341 }
3342
3343 /**
3344 * Create an intent with a given action. All other fields (data, type,
3345 * class) are null. Note that the action <em>must</em> be in a
3346 * namespace because Intents are used globally in the system -- for
3347 * example the system VIEW action is android.intent.action.VIEW; an
3348 * application's custom action would be something like
3349 * com.google.app.myapp.CUSTOM_ACTION.
3350 *
3351 * @param action The Intent action, such as ACTION_VIEW.
3352 */
3353 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003354 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003355 }
3356
3357 /**
3358 * Create an intent with a given action and for a given data url. Note
3359 * that the action <em>must</em> be in a namespace because Intents are
3360 * used globally in the system -- for example the system VIEW action is
3361 * android.intent.action.VIEW; an application's custom action would be
3362 * something like com.google.app.myapp.CUSTOM_ACTION.
3363 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003364 * <p><em>Note: scheme and host name matching in the Android framework is
3365 * case-sensitive, unlike the formal RFC. As a result,
3366 * you should always ensure that you write your Uri with these elements
3367 * using lower case letters, and normalize any Uris you receive from
3368 * outside of Android to ensure the scheme and host is lower case.</em></p>
3369 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003370 * @param action The Intent action, such as ACTION_VIEW.
3371 * @param uri The Intent data URI.
3372 */
3373 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003374 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003375 mData = uri;
3376 }
3377
3378 /**
3379 * Create an intent for a specific component. All other fields (action, data,
3380 * type, class) are null, though they can be modified later with explicit
3381 * calls. This provides a convenient way to create an intent that is
3382 * intended to execute a hard-coded class name, rather than relying on the
3383 * system to find an appropriate class for you; see {@link #setComponent}
3384 * for more information on the repercussions of this.
3385 *
3386 * @param packageContext A Context of the application package implementing
3387 * this class.
3388 * @param cls The component class that is to be used for the intent.
3389 *
3390 * @see #setClass
3391 * @see #setComponent
3392 * @see #Intent(String, android.net.Uri , Context, Class)
3393 */
3394 public Intent(Context packageContext, Class<?> cls) {
3395 mComponent = new ComponentName(packageContext, cls);
3396 }
3397
3398 /**
3399 * Create an intent for a specific component with a specified action and data.
3400 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3401 * construct the Intent and then calling {@link #setClass} to set its
3402 * class.
3403 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003404 * <p><em>Note: scheme and host name matching in the Android framework is
3405 * case-sensitive, unlike the formal RFC. As a result,
3406 * you should always ensure that you write your Uri with these elements
3407 * using lower case letters, and normalize any Uris you receive from
3408 * outside of Android to ensure the scheme and host is lower case.</em></p>
3409 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003410 * @param action The Intent action, such as ACTION_VIEW.
3411 * @param uri The Intent data URI.
3412 * @param packageContext A Context of the application package implementing
3413 * this class.
3414 * @param cls The component class that is to be used for the intent.
3415 *
3416 * @see #Intent(String, android.net.Uri)
3417 * @see #Intent(Context, Class)
3418 * @see #setClass
3419 * @see #setComponent
3420 */
3421 public Intent(String action, Uri uri,
3422 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003423 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003424 mData = uri;
3425 mComponent = new ComponentName(packageContext, cls);
3426 }
3427
3428 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003429 * Create an intent to launch the main (root) activity of a task. This
3430 * is the Intent that is started when the application's is launched from
3431 * Home. For anything else that wants to launch an application in the
3432 * same way, it is important that they use an Intent structured the same
3433 * way, and can use this function to ensure this is the case.
3434 *
3435 * <p>The returned Intent has the given Activity component as its explicit
3436 * component, {@link #ACTION_MAIN} as its action, and includes the
3437 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3438 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3439 * to do that through {@link #addFlags(int)} on the returned Intent.
3440 *
3441 * @param mainActivity The main activity component that this Intent will
3442 * launch.
3443 * @return Returns a newly created Intent that can be used to launch the
3444 * activity as a main application entry.
3445 *
3446 * @see #setClass
3447 * @see #setComponent
3448 */
3449 public static Intent makeMainActivity(ComponentName mainActivity) {
3450 Intent intent = new Intent(ACTION_MAIN);
3451 intent.setComponent(mainActivity);
3452 intent.addCategory(CATEGORY_LAUNCHER);
3453 return intent;
3454 }
3455
3456 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003457 * Make an Intent for the main activity of an application, without
3458 * specifying a specific activity to run but giving a selector to find
3459 * the activity. This results in a final Intent that is structured
3460 * the same as when the application is launched from
3461 * Home. For anything else that wants to launch an application in the
3462 * same way, it is important that they use an Intent structured the same
3463 * way, and can use this function to ensure this is the case.
3464 *
3465 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3466 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3467 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3468 * to do that through {@link #addFlags(int)} on the returned Intent.
3469 *
3470 * @param selectorAction The action name of the Intent's selector.
3471 * @param selectorCategory The name of a category to add to the Intent's
3472 * selector.
3473 * @return Returns a newly created Intent that can be used to launch the
3474 * activity as a main application entry.
3475 *
3476 * @see #setSelector(Intent)
3477 */
3478 public static Intent makeMainSelectorActivity(String selectorAction,
3479 String selectorCategory) {
3480 Intent intent = new Intent(ACTION_MAIN);
3481 intent.addCategory(CATEGORY_LAUNCHER);
3482 Intent selector = new Intent();
3483 selector.setAction(selectorAction);
3484 selector.addCategory(selectorCategory);
3485 intent.setSelector(selector);
3486 return intent;
3487 }
3488
3489 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003490 * Make an Intent that can be used to re-launch an application's task
3491 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3492 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3493 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3494 *
3495 * @param mainActivity The activity component that is the root of the
3496 * task; this is the activity that has been published in the application's
3497 * manifest as the main launcher icon.
3498 *
3499 * @return Returns a newly created Intent that can be used to relaunch the
3500 * activity's task in its root state.
3501 */
3502 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3503 Intent intent = makeMainActivity(mainActivity);
3504 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3505 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3506 return intent;
3507 }
3508
3509 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003510 * Call {@link #parseUri} with 0 flags.
3511 * @deprecated Use {@link #parseUri} instead.
3512 */
3513 @Deprecated
3514 public static Intent getIntent(String uri) throws URISyntaxException {
3515 return parseUri(uri, 0);
3516 }
Tom Taylord4a47292009-12-21 13:59:18 -08003517
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003518 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003519 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003520 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003521 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003522 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003523 *
3524 * <p>The URI given here must not be relative -- that is, it must include
3525 * the scheme and full path.
3526 *
3527 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003528 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003529 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003530 *
3531 * @return Intent The newly created Intent object.
3532 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003533 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3534 * it bad (as parsed by the Uri class) or the Intent data within the
3535 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003536 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003537 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003538 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003539 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003540 int i = 0;
3541 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003542 // Validate intent scheme for if requested.
3543 if ((flags&URI_INTENT_SCHEME) != 0) {
3544 if (!uri.startsWith("intent:")) {
3545 Intent intent = new Intent(ACTION_VIEW);
3546 try {
3547 intent.setData(Uri.parse(uri));
3548 } catch (IllegalArgumentException e) {
3549 throw new URISyntaxException(uri, e.getMessage());
3550 }
3551 return intent;
3552 }
3553 }
Tom Taylord4a47292009-12-21 13:59:18 -08003554
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003555 // simple case
3556 i = uri.lastIndexOf("#");
3557 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3558
3559 // old format Intent URI
3560 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003561
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003562 // new format
3563 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003564 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003565
3566 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003567 String data = i >= 0 ? uri.substring(0, i) : null;
3568 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003569 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003570
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003571 // loop over contents of Intent, all name=value;
3572 while (!uri.startsWith("end", i)) {
3573 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003574 if (eq < 0) eq = i-1;
3575 int semi = uri.indexOf(';', i);
3576 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003577
3578 // action
3579 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003580 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003581 }
3582
3583 // categories
3584 else if (uri.startsWith("category=", i)) {
3585 intent.addCategory(value);
3586 }
3587
3588 // type
3589 else if (uri.startsWith("type=", i)) {
3590 intent.mType = value;
3591 }
3592
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003593 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003594 else if (uri.startsWith("launchFlags=", i)) {
3595 intent.mFlags = Integer.decode(value).intValue();
3596 }
3597
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003598 // package
3599 else if (uri.startsWith("package=", i)) {
3600 intent.mPackage = value;
3601 }
3602
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003603 // component
3604 else if (uri.startsWith("component=", i)) {
3605 intent.mComponent = ComponentName.unflattenFromString(value);
3606 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003607
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003608 // scheme
3609 else if (uri.startsWith("scheme=", i)) {
3610 scheme = value;
3611 }
3612
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003613 // source bounds
3614 else if (uri.startsWith("sourceBounds=", i)) {
3615 intent.mSourceBounds = Rect.unflattenFromString(value);
3616 }
3617
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003618 // selector
3619 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3620 intent = new Intent();
3621 }
3622
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003623 // extra
3624 else {
3625 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003626 // create Bundle if it doesn't already exist
3627 if (intent.mExtras == null) intent.mExtras = new Bundle();
3628 Bundle b = intent.mExtras;
3629 // add EXTRA
3630 if (uri.startsWith("S.", i)) b.putString(key, value);
3631 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3632 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3633 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3634 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3635 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3636 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3637 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3638 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3639 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3640 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003642 // move to the next item
3643 i = semi + 1;
3644 }
3645
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003646 if (intent != baseIntent) {
3647 // The Intent had a selector; fix it up.
3648 baseIntent.setSelector(intent);
3649 intent = baseIntent;
3650 }
3651
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003652 if (data != null) {
3653 if (data.startsWith("intent:")) {
3654 data = data.substring(7);
3655 if (scheme != null) {
3656 data = scheme + ':' + data;
3657 }
3658 }
Tom Taylord4a47292009-12-21 13:59:18 -08003659
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003660 if (data.length() > 0) {
3661 try {
3662 intent.mData = Uri.parse(data);
3663 } catch (IllegalArgumentException e) {
3664 throw new URISyntaxException(uri, e.getMessage());
3665 }
3666 }
3667 }
Tom Taylord4a47292009-12-21 13:59:18 -08003668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003669 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003670
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003671 } catch (IndexOutOfBoundsException e) {
3672 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3673 }
3674 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003675
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003676 public static Intent getIntentOld(String uri) throws URISyntaxException {
3677 Intent intent;
3678
3679 int i = uri.lastIndexOf('#');
3680 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003681 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003682 final int intentFragmentStart = i;
3683 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003684
3685 i++;
3686
3687 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003688 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003689 i += 7;
3690 int j = uri.indexOf(')', i);
3691 action = uri.substring(i, j);
3692 i = j + 1;
3693 }
3694
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003695 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003696
3697 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003698 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003699 i += 11;
3700 int j = uri.indexOf(')', i);
3701 while (i < j) {
3702 int sep = uri.indexOf('!', i);
3703 if (sep < 0) sep = j;
3704 if (i < sep) {
3705 intent.addCategory(uri.substring(i, sep));
3706 }
3707 i = sep + 1;
3708 }
3709 i = j + 1;
3710 }
3711
3712 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003713 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003714 i += 5;
3715 int j = uri.indexOf(')', i);
3716 intent.mType = uri.substring(i, j);
3717 i = j + 1;
3718 }
3719
3720 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003721 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003722 i += 12;
3723 int j = uri.indexOf(')', i);
3724 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3725 i = j + 1;
3726 }
3727
3728 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003729 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003730 i += 10;
3731 int j = uri.indexOf(')', i);
3732 int sep = uri.indexOf('!', i);
3733 if (sep >= 0 && sep < j) {
3734 String pkg = uri.substring(i, sep);
3735 String cls = uri.substring(sep + 1, j);
3736 intent.mComponent = new ComponentName(pkg, cls);
3737 }
3738 i = j + 1;
3739 }
3740
3741 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003742 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003743 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003744
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003745 final int closeParen = uri.indexOf(')', i);
3746 if (closeParen == -1) throw new URISyntaxException(uri,
3747 "EXTRA missing trailing ')'", i);
3748
3749 while (i < closeParen) {
3750 // fetch the key value
3751 int j = uri.indexOf('=', i);
3752 if (j <= i + 1 || i >= closeParen) {
3753 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3754 }
3755 char type = uri.charAt(i);
3756 i++;
3757 String key = uri.substring(i, j);
3758 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003759
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003760 // get type-value
3761 j = uri.indexOf('!', i);
3762 if (j == -1 || j >= closeParen) j = closeParen;
3763 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3764 String value = uri.substring(i, j);
3765 i = j;
3766
3767 // create Bundle if it doesn't already exist
3768 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003769
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003770 // add item to bundle
3771 try {
3772 switch (type) {
3773 case 'S':
3774 intent.mExtras.putString(key, Uri.decode(value));
3775 break;
3776 case 'B':
3777 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3778 break;
3779 case 'b':
3780 intent.mExtras.putByte(key, Byte.parseByte(value));
3781 break;
3782 case 'c':
3783 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3784 break;
3785 case 'd':
3786 intent.mExtras.putDouble(key, Double.parseDouble(value));
3787 break;
3788 case 'f':
3789 intent.mExtras.putFloat(key, Float.parseFloat(value));
3790 break;
3791 case 'i':
3792 intent.mExtras.putInt(key, Integer.parseInt(value));
3793 break;
3794 case 'l':
3795 intent.mExtras.putLong(key, Long.parseLong(value));
3796 break;
3797 case 's':
3798 intent.mExtras.putShort(key, Short.parseShort(value));
3799 break;
3800 default:
3801 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3802 }
3803 } catch (NumberFormatException e) {
3804 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3805 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003806
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003807 char ch = uri.charAt(i);
3808 if (ch == ')') break;
3809 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3810 i++;
3811 }
3812 }
3813
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003814 if (isIntentFragment) {
3815 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3816 } else {
3817 intent.mData = Uri.parse(uri);
3818 }
Tom Taylord4a47292009-12-21 13:59:18 -08003819
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003820 if (intent.mAction == null) {
3821 // By default, if no action is specified, then use VIEW.
3822 intent.mAction = ACTION_VIEW;
3823 }
3824
3825 } else {
3826 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3827 }
3828
3829 return intent;
3830 }
3831
3832 /**
3833 * Retrieve the general action to be performed, such as
3834 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3835 * the information in the intent should be interpreted -- most importantly,
3836 * what to do with the data returned by {@link #getData}.
3837 *
3838 * @return The action of this intent or null if none is specified.
3839 *
3840 * @see #setAction
3841 */
3842 public String getAction() {
3843 return mAction;
3844 }
3845
3846 /**
3847 * Retrieve data this intent is operating on. This URI specifies the name
3848 * of the data; often it uses the content: scheme, specifying data in a
3849 * content provider. Other schemes may be handled by specific activities,
3850 * such as http: by the web browser.
3851 *
3852 * @return The URI of the data this intent is targeting or null.
3853 *
3854 * @see #getScheme
3855 * @see #setData
3856 */
3857 public Uri getData() {
3858 return mData;
3859 }
3860
3861 /**
3862 * The same as {@link #getData()}, but returns the URI as an encoded
3863 * String.
3864 */
3865 public String getDataString() {
3866 return mData != null ? mData.toString() : null;
3867 }
3868
3869 /**
3870 * Return the scheme portion of the intent's data. If the data is null or
3871 * does not include a scheme, null is returned. Otherwise, the scheme
3872 * prefix without the final ':' is returned, i.e. "http".
3873 *
3874 * <p>This is the same as calling getData().getScheme() (and checking for
3875 * null data).
3876 *
3877 * @return The scheme of this intent.
3878 *
3879 * @see #getData
3880 */
3881 public String getScheme() {
3882 return mData != null ? mData.getScheme() : null;
3883 }
3884
3885 /**
3886 * Retrieve any explicit MIME type included in the intent. This is usually
3887 * null, as the type is determined by the intent data.
3888 *
3889 * @return If a type was manually set, it is returned; else null is
3890 * returned.
3891 *
3892 * @see #resolveType(ContentResolver)
3893 * @see #setType
3894 */
3895 public String getType() {
3896 return mType;
3897 }
3898
3899 /**
3900 * Return the MIME data type of this intent. If the type field is
3901 * explicitly set, that is simply returned. Otherwise, if the data is set,
3902 * the type of that data is returned. If neither fields are set, a null is
3903 * returned.
3904 *
3905 * @return The MIME type of this intent.
3906 *
3907 * @see #getType
3908 * @see #resolveType(ContentResolver)
3909 */
3910 public String resolveType(Context context) {
3911 return resolveType(context.getContentResolver());
3912 }
3913
3914 /**
3915 * Return the MIME data type of this intent. If the type field is
3916 * explicitly set, that is simply returned. Otherwise, if the data is set,
3917 * the type of that data is returned. If neither fields are set, a null is
3918 * returned.
3919 *
3920 * @param resolver A ContentResolver that can be used to determine the MIME
3921 * type of the intent's data.
3922 *
3923 * @return The MIME type of this intent.
3924 *
3925 * @see #getType
3926 * @see #resolveType(Context)
3927 */
3928 public String resolveType(ContentResolver resolver) {
3929 if (mType != null) {
3930 return mType;
3931 }
3932 if (mData != null) {
3933 if ("content".equals(mData.getScheme())) {
3934 return resolver.getType(mData);
3935 }
3936 }
3937 return null;
3938 }
3939
3940 /**
3941 * Return the MIME data type of this intent, only if it will be needed for
3942 * intent resolution. This is not generally useful for application code;
3943 * it is used by the frameworks for communicating with back-end system
3944 * services.
3945 *
3946 * @param resolver A ContentResolver that can be used to determine the MIME
3947 * type of the intent's data.
3948 *
3949 * @return The MIME type of this intent, or null if it is unknown or not
3950 * needed.
3951 */
3952 public String resolveTypeIfNeeded(ContentResolver resolver) {
3953 if (mComponent != null) {
3954 return mType;
3955 }
3956 return resolveType(resolver);
3957 }
3958
3959 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003960 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003961 *
3962 * @param category The category to check.
3963 *
3964 * @return boolean True if the intent contains the category, else false.
3965 *
3966 * @see #getCategories
3967 * @see #addCategory
3968 */
3969 public boolean hasCategory(String category) {
3970 return mCategories != null && mCategories.contains(category);
3971 }
3972
3973 /**
3974 * Return the set of all categories in the intent. If there are no categories,
3975 * returns NULL.
3976 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003977 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003978 *
3979 * @see #hasCategory
3980 * @see #addCategory
3981 */
3982 public Set<String> getCategories() {
3983 return mCategories;
3984 }
3985
3986 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003987 * Return the specific selector associated with this Intent. If there is
3988 * none, returns null. See {@link #setSelector} for more information.
3989 *
3990 * @see #setSelector
3991 */
3992 public Intent getSelector() {
3993 return mSelector;
3994 }
3995
3996 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003997 * Return the {@link ClipData} associated with this Intent. If there is
3998 * none, returns null. See {@link #setClipData} for more information.
3999 *
4000 * @see #setClipData;
4001 */
4002 public ClipData getClipData() {
4003 return mClipData;
4004 }
4005
4006 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004007 * Sets the ClassLoader that will be used when unmarshalling
4008 * any Parcelable values from the extras of this Intent.
4009 *
4010 * @param loader a ClassLoader, or null to use the default loader
4011 * at the time of unmarshalling.
4012 */
4013 public void setExtrasClassLoader(ClassLoader loader) {
4014 if (mExtras != null) {
4015 mExtras.setClassLoader(loader);
4016 }
4017 }
4018
4019 /**
4020 * Returns true if an extra value is associated with the given name.
4021 * @param name the extra's name
4022 * @return true if the given extra is present.
4023 */
4024 public boolean hasExtra(String name) {
4025 return mExtras != null && mExtras.containsKey(name);
4026 }
4027
4028 /**
4029 * Returns true if the Intent's extras contain a parcelled file descriptor.
4030 * @return true if the Intent contains a parcelled file descriptor.
4031 */
4032 public boolean hasFileDescriptors() {
4033 return mExtras != null && mExtras.hasFileDescriptors();
4034 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004035
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004036 /** @hide */
4037 public void setAllowFds(boolean allowFds) {
4038 if (mExtras != null) {
4039 mExtras.setAllowFds(allowFds);
4040 }
4041 }
4042
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004043 /**
4044 * Retrieve extended data from the intent.
4045 *
4046 * @param name The name of the desired item.
4047 *
4048 * @return the value of an item that previously added with putExtra()
4049 * or null if none was found.
4050 *
4051 * @deprecated
4052 * @hide
4053 */
4054 @Deprecated
4055 public Object getExtra(String name) {
4056 return getExtra(name, null);
4057 }
4058
4059 /**
4060 * Retrieve extended data from the intent.
4061 *
4062 * @param name The name of the desired item.
4063 * @param defaultValue the value to be returned if no value of the desired
4064 * type is stored with the given name.
4065 *
4066 * @return the value of an item that previously added with putExtra()
4067 * or the default value if none was found.
4068 *
4069 * @see #putExtra(String, boolean)
4070 */
4071 public boolean getBooleanExtra(String name, boolean defaultValue) {
4072 return mExtras == null ? defaultValue :
4073 mExtras.getBoolean(name, defaultValue);
4074 }
4075
4076 /**
4077 * Retrieve extended data from the intent.
4078 *
4079 * @param name The name of the desired item.
4080 * @param defaultValue the value to be returned if no value of the desired
4081 * type is stored with the given name.
4082 *
4083 * @return the value of an item that previously added with putExtra()
4084 * or the default value if none was found.
4085 *
4086 * @see #putExtra(String, byte)
4087 */
4088 public byte getByteExtra(String name, byte defaultValue) {
4089 return mExtras == null ? defaultValue :
4090 mExtras.getByte(name, defaultValue);
4091 }
4092
4093 /**
4094 * Retrieve extended data from the intent.
4095 *
4096 * @param name The name of the desired item.
4097 * @param defaultValue the value to be returned if no value of the desired
4098 * type is stored with the given name.
4099 *
4100 * @return the value of an item that previously added with putExtra()
4101 * or the default value if none was found.
4102 *
4103 * @see #putExtra(String, short)
4104 */
4105 public short getShortExtra(String name, short defaultValue) {
4106 return mExtras == null ? defaultValue :
4107 mExtras.getShort(name, defaultValue);
4108 }
4109
4110 /**
4111 * Retrieve extended data from the intent.
4112 *
4113 * @param name The name of the desired item.
4114 * @param defaultValue the value to be returned if no value of the desired
4115 * type is stored with the given name.
4116 *
4117 * @return the value of an item that previously added with putExtra()
4118 * or the default value if none was found.
4119 *
4120 * @see #putExtra(String, char)
4121 */
4122 public char getCharExtra(String name, char defaultValue) {
4123 return mExtras == null ? defaultValue :
4124 mExtras.getChar(name, defaultValue);
4125 }
4126
4127 /**
4128 * Retrieve extended data from the intent.
4129 *
4130 * @param name The name of the desired item.
4131 * @param defaultValue the value to be returned if no value of the desired
4132 * type is stored with the given name.
4133 *
4134 * @return the value of an item that previously added with putExtra()
4135 * or the default value if none was found.
4136 *
4137 * @see #putExtra(String, int)
4138 */
4139 public int getIntExtra(String name, int defaultValue) {
4140 return mExtras == null ? defaultValue :
4141 mExtras.getInt(name, defaultValue);
4142 }
4143
4144 /**
4145 * Retrieve extended data from the intent.
4146 *
4147 * @param name The name of the desired item.
4148 * @param defaultValue the value to be returned if no value of the desired
4149 * type is stored with the given name.
4150 *
4151 * @return the value of an item that previously added with putExtra()
4152 * or the default value if none was found.
4153 *
4154 * @see #putExtra(String, long)
4155 */
4156 public long getLongExtra(String name, long defaultValue) {
4157 return mExtras == null ? defaultValue :
4158 mExtras.getLong(name, defaultValue);
4159 }
4160
4161 /**
4162 * Retrieve extended data from the intent.
4163 *
4164 * @param name The name of the desired item.
4165 * @param defaultValue the value to be returned if no value of the desired
4166 * type is stored with the given name.
4167 *
4168 * @return the value of an item that previously added with putExtra(),
4169 * or the default value if no such item is present
4170 *
4171 * @see #putExtra(String, float)
4172 */
4173 public float getFloatExtra(String name, float defaultValue) {
4174 return mExtras == null ? defaultValue :
4175 mExtras.getFloat(name, defaultValue);
4176 }
4177
4178 /**
4179 * Retrieve extended data from the intent.
4180 *
4181 * @param name The name of the desired item.
4182 * @param defaultValue the value to be returned if no value of the desired
4183 * type is stored with the given name.
4184 *
4185 * @return the value of an item that previously added with putExtra()
4186 * or the default value if none was found.
4187 *
4188 * @see #putExtra(String, double)
4189 */
4190 public double getDoubleExtra(String name, double defaultValue) {
4191 return mExtras == null ? defaultValue :
4192 mExtras.getDouble(name, defaultValue);
4193 }
4194
4195 /**
4196 * Retrieve extended data from the intent.
4197 *
4198 * @param name The name of the desired item.
4199 *
4200 * @return the value of an item that previously added with putExtra()
4201 * or null if no String value was found.
4202 *
4203 * @see #putExtra(String, String)
4204 */
4205 public String getStringExtra(String name) {
4206 return mExtras == null ? null : mExtras.getString(name);
4207 }
4208
4209 /**
4210 * Retrieve extended data from the intent.
4211 *
4212 * @param name The name of the desired item.
4213 *
4214 * @return the value of an item that previously added with putExtra()
4215 * or null if no CharSequence value was found.
4216 *
4217 * @see #putExtra(String, CharSequence)
4218 */
4219 public CharSequence getCharSequenceExtra(String name) {
4220 return mExtras == null ? null : mExtras.getCharSequence(name);
4221 }
4222
4223 /**
4224 * Retrieve extended data from the intent.
4225 *
4226 * @param name The name of the desired item.
4227 *
4228 * @return the value of an item that previously added with putExtra()
4229 * or null if no Parcelable value was found.
4230 *
4231 * @see #putExtra(String, Parcelable)
4232 */
4233 public <T extends Parcelable> T getParcelableExtra(String name) {
4234 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4235 }
4236
4237 /**
4238 * Retrieve extended data from the intent.
4239 *
4240 * @param name The name of the desired item.
4241 *
4242 * @return the value of an item that previously added with putExtra()
4243 * or null if no Parcelable[] value was found.
4244 *
4245 * @see #putExtra(String, Parcelable[])
4246 */
4247 public Parcelable[] getParcelableArrayExtra(String name) {
4248 return mExtras == null ? null : mExtras.getParcelableArray(name);
4249 }
4250
4251 /**
4252 * Retrieve extended data from the intent.
4253 *
4254 * @param name The name of the desired item.
4255 *
4256 * @return the value of an item that previously added with putExtra()
4257 * or null if no ArrayList<Parcelable> value was found.
4258 *
4259 * @see #putParcelableArrayListExtra(String, ArrayList)
4260 */
4261 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4262 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4263 }
4264
4265 /**
4266 * Retrieve extended data from the intent.
4267 *
4268 * @param name The name of the desired item.
4269 *
4270 * @return the value of an item that previously added with putExtra()
4271 * or null if no Serializable value was found.
4272 *
4273 * @see #putExtra(String, Serializable)
4274 */
4275 public Serializable getSerializableExtra(String name) {
4276 return mExtras == null ? null : mExtras.getSerializable(name);
4277 }
4278
4279 /**
4280 * Retrieve extended data from the intent.
4281 *
4282 * @param name The name of the desired item.
4283 *
4284 * @return the value of an item that previously added with putExtra()
4285 * or null if no ArrayList<Integer> value was found.
4286 *
4287 * @see #putIntegerArrayListExtra(String, ArrayList)
4288 */
4289 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4290 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4291 }
4292
4293 /**
4294 * Retrieve extended data from the intent.
4295 *
4296 * @param name The name of the desired item.
4297 *
4298 * @return the value of an item that previously added with putExtra()
4299 * or null if no ArrayList<String> value was found.
4300 *
4301 * @see #putStringArrayListExtra(String, ArrayList)
4302 */
4303 public ArrayList<String> getStringArrayListExtra(String name) {
4304 return mExtras == null ? null : mExtras.getStringArrayList(name);
4305 }
4306
4307 /**
4308 * Retrieve extended data from the intent.
4309 *
4310 * @param name The name of the desired item.
4311 *
4312 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004313 * or null if no ArrayList<CharSequence> value was found.
4314 *
4315 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4316 */
4317 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4318 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4319 }
4320
4321 /**
4322 * Retrieve extended data from the intent.
4323 *
4324 * @param name The name of the desired item.
4325 *
4326 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004327 * or null if no boolean array value was found.
4328 *
4329 * @see #putExtra(String, boolean[])
4330 */
4331 public boolean[] getBooleanArrayExtra(String name) {
4332 return mExtras == null ? null : mExtras.getBooleanArray(name);
4333 }
4334
4335 /**
4336 * Retrieve extended data from the intent.
4337 *
4338 * @param name The name of the desired item.
4339 *
4340 * @return the value of an item that previously added with putExtra()
4341 * or null if no byte array value was found.
4342 *
4343 * @see #putExtra(String, byte[])
4344 */
4345 public byte[] getByteArrayExtra(String name) {
4346 return mExtras == null ? null : mExtras.getByteArray(name);
4347 }
4348
4349 /**
4350 * Retrieve extended data from the intent.
4351 *
4352 * @param name The name of the desired item.
4353 *
4354 * @return the value of an item that previously added with putExtra()
4355 * or null if no short array value was found.
4356 *
4357 * @see #putExtra(String, short[])
4358 */
4359 public short[] getShortArrayExtra(String name) {
4360 return mExtras == null ? null : mExtras.getShortArray(name);
4361 }
4362
4363 /**
4364 * Retrieve extended data from the intent.
4365 *
4366 * @param name The name of the desired item.
4367 *
4368 * @return the value of an item that previously added with putExtra()
4369 * or null if no char array value was found.
4370 *
4371 * @see #putExtra(String, char[])
4372 */
4373 public char[] getCharArrayExtra(String name) {
4374 return mExtras == null ? null : mExtras.getCharArray(name);
4375 }
4376
4377 /**
4378 * Retrieve extended data from the intent.
4379 *
4380 * @param name The name of the desired item.
4381 *
4382 * @return the value of an item that previously added with putExtra()
4383 * or null if no int array value was found.
4384 *
4385 * @see #putExtra(String, int[])
4386 */
4387 public int[] getIntArrayExtra(String name) {
4388 return mExtras == null ? null : mExtras.getIntArray(name);
4389 }
4390
4391 /**
4392 * Retrieve extended data from the intent.
4393 *
4394 * @param name The name of the desired item.
4395 *
4396 * @return the value of an item that previously added with putExtra()
4397 * or null if no long array value was found.
4398 *
4399 * @see #putExtra(String, long[])
4400 */
4401 public long[] getLongArrayExtra(String name) {
4402 return mExtras == null ? null : mExtras.getLongArray(name);
4403 }
4404
4405 /**
4406 * Retrieve extended data from the intent.
4407 *
4408 * @param name The name of the desired item.
4409 *
4410 * @return the value of an item that previously added with putExtra()
4411 * or null if no float array value was found.
4412 *
4413 * @see #putExtra(String, float[])
4414 */
4415 public float[] getFloatArrayExtra(String name) {
4416 return mExtras == null ? null : mExtras.getFloatArray(name);
4417 }
4418
4419 /**
4420 * Retrieve extended data from the intent.
4421 *
4422 * @param name The name of the desired item.
4423 *
4424 * @return the value of an item that previously added with putExtra()
4425 * or null if no double array value was found.
4426 *
4427 * @see #putExtra(String, double[])
4428 */
4429 public double[] getDoubleArrayExtra(String name) {
4430 return mExtras == null ? null : mExtras.getDoubleArray(name);
4431 }
4432
4433 /**
4434 * Retrieve extended data from the intent.
4435 *
4436 * @param name The name of the desired item.
4437 *
4438 * @return the value of an item that previously added with putExtra()
4439 * or null if no String array value was found.
4440 *
4441 * @see #putExtra(String, String[])
4442 */
4443 public String[] getStringArrayExtra(String name) {
4444 return mExtras == null ? null : mExtras.getStringArray(name);
4445 }
4446
4447 /**
4448 * Retrieve extended data from the intent.
4449 *
4450 * @param name The name of the desired item.
4451 *
4452 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004453 * or null if no CharSequence array value was found.
4454 *
4455 * @see #putExtra(String, CharSequence[])
4456 */
4457 public CharSequence[] getCharSequenceArrayExtra(String name) {
4458 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4459 }
4460
4461 /**
4462 * Retrieve extended data from the intent.
4463 *
4464 * @param name The name of the desired item.
4465 *
4466 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004467 * or null if no Bundle value was found.
4468 *
4469 * @see #putExtra(String, Bundle)
4470 */
4471 public Bundle getBundleExtra(String name) {
4472 return mExtras == null ? null : mExtras.getBundle(name);
4473 }
4474
4475 /**
4476 * Retrieve extended data from the intent.
4477 *
4478 * @param name The name of the desired item.
4479 *
4480 * @return the value of an item that previously added with putExtra()
4481 * or null if no IBinder value was found.
4482 *
4483 * @see #putExtra(String, IBinder)
4484 *
4485 * @deprecated
4486 * @hide
4487 */
4488 @Deprecated
4489 public IBinder getIBinderExtra(String name) {
4490 return mExtras == null ? null : mExtras.getIBinder(name);
4491 }
4492
4493 /**
4494 * Retrieve extended data from the intent.
4495 *
4496 * @param name The name of the desired item.
4497 * @param defaultValue The default value to return in case no item is
4498 * associated with the key 'name'
4499 *
4500 * @return the value of an item that previously added with putExtra()
4501 * or defaultValue if none was found.
4502 *
4503 * @see #putExtra
4504 *
4505 * @deprecated
4506 * @hide
4507 */
4508 @Deprecated
4509 public Object getExtra(String name, Object defaultValue) {
4510 Object result = defaultValue;
4511 if (mExtras != null) {
4512 Object result2 = mExtras.get(name);
4513 if (result2 != null) {
4514 result = result2;
4515 }
4516 }
4517
4518 return result;
4519 }
4520
4521 /**
4522 * Retrieves a map of extended data from the intent.
4523 *
4524 * @return the map of all extras previously added with putExtra(),
4525 * or null if none have been added.
4526 */
4527 public Bundle getExtras() {
4528 return (mExtras != null)
4529 ? new Bundle(mExtras)
4530 : null;
4531 }
4532
4533 /**
4534 * Retrieve any special flags associated with this intent. You will
4535 * normally just set them with {@link #setFlags} and let the system
4536 * take the appropriate action with them.
4537 *
4538 * @return int The currently set flags.
4539 *
4540 * @see #setFlags
4541 */
4542 public int getFlags() {
4543 return mFlags;
4544 }
4545
Dianne Hackborne7f97212011-02-24 14:40:20 -08004546 /** @hide */
4547 public boolean isExcludingStopped() {
4548 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4549 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4550 }
4551
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004552 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004553 * Retrieve the application package name this Intent is limited to. When
4554 * resolving an Intent, if non-null this limits the resolution to only
4555 * components in the given application package.
4556 *
4557 * @return The name of the application package for the Intent.
4558 *
4559 * @see #resolveActivity
4560 * @see #setPackage
4561 */
4562 public String getPackage() {
4563 return mPackage;
4564 }
4565
4566 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004567 * Retrieve the concrete component associated with the intent. When receiving
4568 * an intent, this is the component that was found to best handle it (that is,
4569 * yourself) and will always be non-null; in all other cases it will be
4570 * null unless explicitly set.
4571 *
4572 * @return The name of the application component to handle the intent.
4573 *
4574 * @see #resolveActivity
4575 * @see #setComponent
4576 */
4577 public ComponentName getComponent() {
4578 return mComponent;
4579 }
4580
4581 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004582 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4583 * used as a hint to the receiver for animations and the like. Null means that there
4584 * is no source bounds.
4585 */
4586 public Rect getSourceBounds() {
4587 return mSourceBounds;
4588 }
4589
4590 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004591 * Return the Activity component that should be used to handle this intent.
4592 * The appropriate component is determined based on the information in the
4593 * intent, evaluated as follows:
4594 *
4595 * <p>If {@link #getComponent} returns an explicit class, that is returned
4596 * without any further consideration.
4597 *
4598 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4599 * category to be considered.
4600 *
4601 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4602 * action.
4603 *
4604 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4605 * this type.
4606 *
4607 * <p>If {@link #addCategory} has added any categories, the activity must
4608 * handle ALL of the categories specified.
4609 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004610 * <p>If {@link #getPackage} is non-NULL, only activity components in
4611 * that application package will be considered.
4612 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004613 * <p>If there are no activities that satisfy all of these conditions, a
4614 * null string is returned.
4615 *
4616 * <p>If multiple activities are found to satisfy the intent, the one with
4617 * the highest priority will be used. If there are multiple activities
4618 * with the same priority, the system will either pick the best activity
4619 * based on user preference, or resolve to a system class that will allow
4620 * the user to pick an activity and forward from there.
4621 *
4622 * <p>This method is implemented simply by calling
4623 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4624 * true.</p>
4625 * <p> This API is called for you as part of starting an activity from an
4626 * intent. You do not normally need to call it yourself.</p>
4627 *
4628 * @param pm The package manager with which to resolve the Intent.
4629 *
4630 * @return Name of the component implementing an activity that can
4631 * display the intent.
4632 *
4633 * @see #setComponent
4634 * @see #getComponent
4635 * @see #resolveActivityInfo
4636 */
4637 public ComponentName resolveActivity(PackageManager pm) {
4638 if (mComponent != null) {
4639 return mComponent;
4640 }
4641
4642 ResolveInfo info = pm.resolveActivity(
4643 this, PackageManager.MATCH_DEFAULT_ONLY);
4644 if (info != null) {
4645 return new ComponentName(
4646 info.activityInfo.applicationInfo.packageName,
4647 info.activityInfo.name);
4648 }
4649
4650 return null;
4651 }
4652
4653 /**
4654 * Resolve the Intent into an {@link ActivityInfo}
4655 * describing the activity that should execute the intent. Resolution
4656 * follows the same rules as described for {@link #resolveActivity}, but
4657 * you get back the completely information about the resolved activity
4658 * instead of just its class name.
4659 *
4660 * @param pm The package manager with which to resolve the Intent.
4661 * @param flags Addition information to retrieve as per
4662 * {@link PackageManager#getActivityInfo(ComponentName, int)
4663 * PackageManager.getActivityInfo()}.
4664 *
4665 * @return PackageManager.ActivityInfo
4666 *
4667 * @see #resolveActivity
4668 */
4669 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4670 ActivityInfo ai = null;
4671 if (mComponent != null) {
4672 try {
4673 ai = pm.getActivityInfo(mComponent, flags);
4674 } catch (PackageManager.NameNotFoundException e) {
4675 // ignore
4676 }
4677 } else {
4678 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004679 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004680 if (info != null) {
4681 ai = info.activityInfo;
4682 }
4683 }
4684
4685 return ai;
4686 }
4687
4688 /**
4689 * Set the general action to be performed.
4690 *
4691 * @param action An action name, such as ACTION_VIEW. Application-specific
4692 * actions should be prefixed with the vendor's package name.
4693 *
4694 * @return Returns the same Intent object, for chaining multiple calls
4695 * into a single statement.
4696 *
4697 * @see #getAction
4698 */
4699 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004700 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004701 return this;
4702 }
4703
4704 /**
4705 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004706 * clears any type that was previously set by {@link #setType} or
4707 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004708 *
Nick Pellyccae4122012-01-09 14:12:58 -08004709 * <p><em>Note: scheme matching in the Android framework is
4710 * case-sensitive, unlike the formal RFC. As a result,
4711 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004712 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004713 * {@link #setDataAndNormalize}
4714 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004715 *
Nick Pellyccae4122012-01-09 14:12:58 -08004716 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004717 *
4718 * @return Returns the same Intent object, for chaining multiple calls
4719 * into a single statement.
4720 *
4721 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004722 * @see #setDataAndNormalize
4723 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004724 */
4725 public Intent setData(Uri data) {
4726 mData = data;
4727 mType = null;
4728 return this;
4729 }
4730
4731 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004732 * Normalize and set the data this intent is operating on.
4733 *
4734 * <p>This method automatically clears any type that was
4735 * previously set (for example, by {@link #setType}).
4736 *
4737 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004738 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004739 * so really this is just a convenience method for
4740 * <pre>
4741 * setData(data.normalize())
4742 * </pre>
4743 *
4744 * @param data The Uri of the data this intent is now targeting.
4745 *
4746 * @return Returns the same Intent object, for chaining multiple calls
4747 * into a single statement.
4748 *
4749 * @see #getData
4750 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004751 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004752 */
4753 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004754 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004755 }
4756
4757 /**
4758 * Set an explicit MIME data type.
4759 *
4760 * <p>This is used to create intents that only specify a type and not data,
4761 * for example to indicate the type of data to return.
4762 *
4763 * <p>This method automatically clears any data that was
4764 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004765 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004766 * <p><em>Note: MIME type matching in the Android framework is
4767 * case-sensitive, unlike formal RFC MIME types. As a result,
4768 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004769 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4770 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004771 *
4772 * @param type The MIME type of the data being handled by this intent.
4773 *
4774 * @return Returns the same Intent object, for chaining multiple calls
4775 * into a single statement.
4776 *
4777 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004778 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004779 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004780 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004781 */
4782 public Intent setType(String type) {
4783 mData = null;
4784 mType = type;
4785 return this;
4786 }
4787
4788 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004789 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004790 *
Nick Pellyccae4122012-01-09 14:12:58 -08004791 * <p>This is used to create intents that only specify a type and not data,
4792 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004793 *
Nick Pellyccae4122012-01-09 14:12:58 -08004794 * <p>This method automatically clears any data that was
4795 * previously set (for example by {@link #setData}).
4796 *
4797 * <p>The MIME type is normalized using
4798 * {@link #normalizeMimeType} before it is set,
4799 * so really this is just a convenience method for
4800 * <pre>
4801 * setType(Intent.normalizeMimeType(type))
4802 * </pre>
4803 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004804 * @param type The MIME type of the data being handled by this intent.
4805 *
4806 * @return Returns the same Intent object, for chaining multiple calls
4807 * into a single statement.
4808 *
Nick Pellyccae4122012-01-09 14:12:58 -08004809 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004810 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004811 * @see #normalizeMimeType
4812 */
4813 public Intent setTypeAndNormalize(String type) {
4814 return setType(normalizeMimeType(type));
4815 }
4816
4817 /**
4818 * (Usually optional) Set the data for the intent along with an explicit
4819 * MIME data type. This method should very rarely be used -- it allows you
4820 * to override the MIME type that would ordinarily be inferred from the
4821 * data with your own type given here.
4822 *
4823 * <p><em>Note: MIME type and Uri scheme matching in the
4824 * Android framework is case-sensitive, unlike the formal RFC definitions.
4825 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004826 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004827 * {@link #setDataAndTypeAndNormalize}
4828 * to ensure that they are converted to lower case.</em>
4829 *
4830 * @param data The Uri of the data this intent is now targeting.
4831 * @param type The MIME type of the data being handled by this intent.
4832 *
4833 * @return Returns the same Intent object, for chaining multiple calls
4834 * into a single statement.
4835 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004836 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004837 * @see #setData
4838 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004839 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004840 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004841 */
4842 public Intent setDataAndType(Uri data, String type) {
4843 mData = data;
4844 mType = type;
4845 return this;
4846 }
4847
4848 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004849 * (Usually optional) Normalize and set both the data Uri and an explicit
4850 * MIME data type. This method should very rarely be used -- it allows you
4851 * to override the MIME type that would ordinarily be inferred from the
4852 * data with your own type given here.
4853 *
4854 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004855 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004856 * before they are set, so really this is just a convenience method for
4857 * <pre>
4858 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4859 * </pre>
4860 *
4861 * @param data The Uri of the data this intent is now targeting.
4862 * @param type The MIME type of the data being handled by this intent.
4863 *
4864 * @return Returns the same Intent object, for chaining multiple calls
4865 * into a single statement.
4866 *
4867 * @see #setType
4868 * @see #setData
4869 * @see #setDataAndType
4870 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004871 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004872 */
4873 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004874 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004875 }
4876
4877 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004878 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004879 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004880 * activities that provide <em>all</em> of the requested categories will be
4881 * used.
4882 *
4883 * @param category The desired category. This can be either one of the
4884 * predefined Intent categories, or a custom category in your own
4885 * namespace.
4886 *
4887 * @return Returns the same Intent object, for chaining multiple calls
4888 * into a single statement.
4889 *
4890 * @see #hasCategory
4891 * @see #removeCategory
4892 */
4893 public Intent addCategory(String category) {
4894 if (mCategories == null) {
4895 mCategories = new HashSet<String>();
4896 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004897 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004898 return this;
4899 }
4900
4901 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004902 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004903 *
4904 * @param category The category to remove.
4905 *
4906 * @see #addCategory
4907 */
4908 public void removeCategory(String category) {
4909 if (mCategories != null) {
4910 mCategories.remove(category);
4911 if (mCategories.size() == 0) {
4912 mCategories = null;
4913 }
4914 }
4915 }
4916
4917 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004918 * Set a selector for this Intent. This is a modification to the kinds of
4919 * things the Intent will match. If the selector is set, it will be used
4920 * when trying to find entities that can handle the Intent, instead of the
4921 * main contents of the Intent. This allows you build an Intent containing
4922 * a generic protocol while targeting it more specifically.
4923 *
4924 * <p>An example of where this may be used is with things like
4925 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4926 * Intent that will launch the Browser application. However, the correct
4927 * main entry point of an application is actually {@link #ACTION_MAIN}
4928 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4929 * used to specify the actual Activity to launch. If you launch the browser
4930 * with something different, undesired behavior may happen if the user has
4931 * previously or later launches it the normal way, since they do not match.
4932 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4933 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4934 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4935 *
4936 * <p>Setting a selector does not impact the behavior of
4937 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4938 * desired behavior of a selector -- it does not impact the base meaning
4939 * of the Intent, just what kinds of things will be matched against it
4940 * when determining who can handle it.</p>
4941 *
4942 * <p>You can not use both a selector and {@link #setPackage(String)} on
4943 * the same base Intent.</p>
4944 *
4945 * @param selector The desired selector Intent; set to null to not use
4946 * a special selector.
4947 */
4948 public void setSelector(Intent selector) {
4949 if (selector == this) {
4950 throw new IllegalArgumentException(
4951 "Intent being set as a selector of itself");
4952 }
4953 if (selector != null && mPackage != null) {
4954 throw new IllegalArgumentException(
4955 "Can't set selector when package name is already set");
4956 }
4957 mSelector = selector;
4958 }
4959
4960 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004961 * Set a {@link ClipData} associated with this Intent. This replaces any
4962 * previously set ClipData.
4963 *
4964 * <p>The ClipData in an intent is not used for Intent matching or other
4965 * such operations. Semantically it is like extras, used to transmit
4966 * additional data with the Intent. The main feature of using this over
4967 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4968 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4969 * items included in the clip data. This is useful, in particular, if
4970 * you want to transmit an Intent containing multiple <code>content:</code>
4971 * URIs for which the recipient may not have global permission to access the
4972 * content provider.
4973 *
4974 * <p>If the ClipData contains items that are themselves Intents, any
4975 * grant flags in those Intents will be ignored. Only the top-level flags
4976 * of the main Intent are respected, and will be applied to all Uri or
4977 * Intent items in the clip (or sub-items of the clip).
4978 *
4979 * <p>The MIME type, label, and icon in the ClipData object are not
4980 * directly used by Intent. Applications should generally rely on the
4981 * MIME type of the Intent itself, not what it may find in the ClipData.
4982 * A common practice is to construct a ClipData for use with an Intent
4983 * with a MIME type of "*\/*".
4984 *
4985 * @param clip The new clip to set. May be null to clear the current clip.
4986 */
4987 public void setClipData(ClipData clip) {
4988 mClipData = clip;
4989 }
4990
4991 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004992 * Add extended data to the intent. The name must include a package
4993 * prefix, for example the app com.android.contacts would use names
4994 * like "com.android.contacts.ShowAll".
4995 *
4996 * @param name The name of the extra data, with package prefix.
4997 * @param value The boolean data value.
4998 *
4999 * @return Returns the same Intent object, for chaining multiple calls
5000 * into a single statement.
5001 *
5002 * @see #putExtras
5003 * @see #removeExtra
5004 * @see #getBooleanExtra(String, boolean)
5005 */
5006 public Intent putExtra(String name, boolean value) {
5007 if (mExtras == null) {
5008 mExtras = new Bundle();
5009 }
5010 mExtras.putBoolean(name, value);
5011 return this;
5012 }
5013
5014 /**
5015 * Add extended data to the intent. The name must include a package
5016 * prefix, for example the app com.android.contacts would use names
5017 * like "com.android.contacts.ShowAll".
5018 *
5019 * @param name The name of the extra data, with package prefix.
5020 * @param value The byte data value.
5021 *
5022 * @return Returns the same Intent object, for chaining multiple calls
5023 * into a single statement.
5024 *
5025 * @see #putExtras
5026 * @see #removeExtra
5027 * @see #getByteExtra(String, byte)
5028 */
5029 public Intent putExtra(String name, byte value) {
5030 if (mExtras == null) {
5031 mExtras = new Bundle();
5032 }
5033 mExtras.putByte(name, value);
5034 return this;
5035 }
5036
5037 /**
5038 * Add extended data to the intent. The name must include a package
5039 * prefix, for example the app com.android.contacts would use names
5040 * like "com.android.contacts.ShowAll".
5041 *
5042 * @param name The name of the extra data, with package prefix.
5043 * @param value The char data value.
5044 *
5045 * @return Returns the same Intent object, for chaining multiple calls
5046 * into a single statement.
5047 *
5048 * @see #putExtras
5049 * @see #removeExtra
5050 * @see #getCharExtra(String, char)
5051 */
5052 public Intent putExtra(String name, char value) {
5053 if (mExtras == null) {
5054 mExtras = new Bundle();
5055 }
5056 mExtras.putChar(name, value);
5057 return this;
5058 }
5059
5060 /**
5061 * Add extended data to the intent. The name must include a package
5062 * prefix, for example the app com.android.contacts would use names
5063 * like "com.android.contacts.ShowAll".
5064 *
5065 * @param name The name of the extra data, with package prefix.
5066 * @param value The short data value.
5067 *
5068 * @return Returns the same Intent object, for chaining multiple calls
5069 * into a single statement.
5070 *
5071 * @see #putExtras
5072 * @see #removeExtra
5073 * @see #getShortExtra(String, short)
5074 */
5075 public Intent putExtra(String name, short value) {
5076 if (mExtras == null) {
5077 mExtras = new Bundle();
5078 }
5079 mExtras.putShort(name, value);
5080 return this;
5081 }
5082
5083 /**
5084 * Add extended data to the intent. The name must include a package
5085 * prefix, for example the app com.android.contacts would use names
5086 * like "com.android.contacts.ShowAll".
5087 *
5088 * @param name The name of the extra data, with package prefix.
5089 * @param value The integer data value.
5090 *
5091 * @return Returns the same Intent object, for chaining multiple calls
5092 * into a single statement.
5093 *
5094 * @see #putExtras
5095 * @see #removeExtra
5096 * @see #getIntExtra(String, int)
5097 */
5098 public Intent putExtra(String name, int value) {
5099 if (mExtras == null) {
5100 mExtras = new Bundle();
5101 }
5102 mExtras.putInt(name, value);
5103 return this;
5104 }
5105
5106 /**
5107 * Add extended data to the intent. The name must include a package
5108 * prefix, for example the app com.android.contacts would use names
5109 * like "com.android.contacts.ShowAll".
5110 *
5111 * @param name The name of the extra data, with package prefix.
5112 * @param value The long data value.
5113 *
5114 * @return Returns the same Intent object, for chaining multiple calls
5115 * into a single statement.
5116 *
5117 * @see #putExtras
5118 * @see #removeExtra
5119 * @see #getLongExtra(String, long)
5120 */
5121 public Intent putExtra(String name, long value) {
5122 if (mExtras == null) {
5123 mExtras = new Bundle();
5124 }
5125 mExtras.putLong(name, value);
5126 return this;
5127 }
5128
5129 /**
5130 * Add extended data to the intent. The name must include a package
5131 * prefix, for example the app com.android.contacts would use names
5132 * like "com.android.contacts.ShowAll".
5133 *
5134 * @param name The name of the extra data, with package prefix.
5135 * @param value The float data value.
5136 *
5137 * @return Returns the same Intent object, for chaining multiple calls
5138 * into a single statement.
5139 *
5140 * @see #putExtras
5141 * @see #removeExtra
5142 * @see #getFloatExtra(String, float)
5143 */
5144 public Intent putExtra(String name, float value) {
5145 if (mExtras == null) {
5146 mExtras = new Bundle();
5147 }
5148 mExtras.putFloat(name, value);
5149 return this;
5150 }
5151
5152 /**
5153 * Add extended data to the intent. The name must include a package
5154 * prefix, for example the app com.android.contacts would use names
5155 * like "com.android.contacts.ShowAll".
5156 *
5157 * @param name The name of the extra data, with package prefix.
5158 * @param value The double data value.
5159 *
5160 * @return Returns the same Intent object, for chaining multiple calls
5161 * into a single statement.
5162 *
5163 * @see #putExtras
5164 * @see #removeExtra
5165 * @see #getDoubleExtra(String, double)
5166 */
5167 public Intent putExtra(String name, double value) {
5168 if (mExtras == null) {
5169 mExtras = new Bundle();
5170 }
5171 mExtras.putDouble(name, value);
5172 return this;
5173 }
5174
5175 /**
5176 * Add extended data to the intent. The name must include a package
5177 * prefix, for example the app com.android.contacts would use names
5178 * like "com.android.contacts.ShowAll".
5179 *
5180 * @param name The name of the extra data, with package prefix.
5181 * @param value The String data value.
5182 *
5183 * @return Returns the same Intent object, for chaining multiple calls
5184 * into a single statement.
5185 *
5186 * @see #putExtras
5187 * @see #removeExtra
5188 * @see #getStringExtra(String)
5189 */
5190 public Intent putExtra(String name, String value) {
5191 if (mExtras == null) {
5192 mExtras = new Bundle();
5193 }
5194 mExtras.putString(name, value);
5195 return this;
5196 }
5197
5198 /**
5199 * Add extended data to the intent. The name must include a package
5200 * prefix, for example the app com.android.contacts would use names
5201 * like "com.android.contacts.ShowAll".
5202 *
5203 * @param name The name of the extra data, with package prefix.
5204 * @param value The CharSequence data value.
5205 *
5206 * @return Returns the same Intent object, for chaining multiple calls
5207 * into a single statement.
5208 *
5209 * @see #putExtras
5210 * @see #removeExtra
5211 * @see #getCharSequenceExtra(String)
5212 */
5213 public Intent putExtra(String name, CharSequence value) {
5214 if (mExtras == null) {
5215 mExtras = new Bundle();
5216 }
5217 mExtras.putCharSequence(name, value);
5218 return this;
5219 }
5220
5221 /**
5222 * Add extended data to the intent. The name must include a package
5223 * prefix, for example the app com.android.contacts would use names
5224 * like "com.android.contacts.ShowAll".
5225 *
5226 * @param name The name of the extra data, with package prefix.
5227 * @param value The Parcelable data value.
5228 *
5229 * @return Returns the same Intent object, for chaining multiple calls
5230 * into a single statement.
5231 *
5232 * @see #putExtras
5233 * @see #removeExtra
5234 * @see #getParcelableExtra(String)
5235 */
5236 public Intent putExtra(String name, Parcelable value) {
5237 if (mExtras == null) {
5238 mExtras = new Bundle();
5239 }
5240 mExtras.putParcelable(name, value);
5241 return this;
5242 }
5243
5244 /**
5245 * Add extended data to the intent. The name must include a package
5246 * prefix, for example the app com.android.contacts would use names
5247 * like "com.android.contacts.ShowAll".
5248 *
5249 * @param name The name of the extra data, with package prefix.
5250 * @param value The Parcelable[] data value.
5251 *
5252 * @return Returns the same Intent object, for chaining multiple calls
5253 * into a single statement.
5254 *
5255 * @see #putExtras
5256 * @see #removeExtra
5257 * @see #getParcelableArrayExtra(String)
5258 */
5259 public Intent putExtra(String name, Parcelable[] value) {
5260 if (mExtras == null) {
5261 mExtras = new Bundle();
5262 }
5263 mExtras.putParcelableArray(name, value);
5264 return this;
5265 }
5266
5267 /**
5268 * Add extended data to the intent. The name must include a package
5269 * prefix, for example the app com.android.contacts would use names
5270 * like "com.android.contacts.ShowAll".
5271 *
5272 * @param name The name of the extra data, with package prefix.
5273 * @param value The ArrayList<Parcelable> data value.
5274 *
5275 * @return Returns the same Intent object, for chaining multiple calls
5276 * into a single statement.
5277 *
5278 * @see #putExtras
5279 * @see #removeExtra
5280 * @see #getParcelableArrayListExtra(String)
5281 */
5282 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5283 if (mExtras == null) {
5284 mExtras = new Bundle();
5285 }
5286 mExtras.putParcelableArrayList(name, value);
5287 return this;
5288 }
5289
5290 /**
5291 * Add extended data to the intent. The name must include a package
5292 * prefix, for example the app com.android.contacts would use names
5293 * like "com.android.contacts.ShowAll".
5294 *
5295 * @param name The name of the extra data, with package prefix.
5296 * @param value The ArrayList<Integer> data value.
5297 *
5298 * @return Returns the same Intent object, for chaining multiple calls
5299 * into a single statement.
5300 *
5301 * @see #putExtras
5302 * @see #removeExtra
5303 * @see #getIntegerArrayListExtra(String)
5304 */
5305 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5306 if (mExtras == null) {
5307 mExtras = new Bundle();
5308 }
5309 mExtras.putIntegerArrayList(name, value);
5310 return this;
5311 }
5312
5313 /**
5314 * Add extended data to the intent. The name must include a package
5315 * prefix, for example the app com.android.contacts would use names
5316 * like "com.android.contacts.ShowAll".
5317 *
5318 * @param name The name of the extra data, with package prefix.
5319 * @param value The ArrayList<String> data value.
5320 *
5321 * @return Returns the same Intent object, for chaining multiple calls
5322 * into a single statement.
5323 *
5324 * @see #putExtras
5325 * @see #removeExtra
5326 * @see #getStringArrayListExtra(String)
5327 */
5328 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5329 if (mExtras == null) {
5330 mExtras = new Bundle();
5331 }
5332 mExtras.putStringArrayList(name, value);
5333 return this;
5334 }
5335
5336 /**
5337 * Add extended data to the intent. The name must include a package
5338 * prefix, for example the app com.android.contacts would use names
5339 * like "com.android.contacts.ShowAll".
5340 *
5341 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005342 * @param value The ArrayList<CharSequence> data value.
5343 *
5344 * @return Returns the same Intent object, for chaining multiple calls
5345 * into a single statement.
5346 *
5347 * @see #putExtras
5348 * @see #removeExtra
5349 * @see #getCharSequenceArrayListExtra(String)
5350 */
5351 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5352 if (mExtras == null) {
5353 mExtras = new Bundle();
5354 }
5355 mExtras.putCharSequenceArrayList(name, value);
5356 return this;
5357 }
5358
5359 /**
5360 * Add extended data to the intent. The name must include a package
5361 * prefix, for example the app com.android.contacts would use names
5362 * like "com.android.contacts.ShowAll".
5363 *
5364 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005365 * @param value The Serializable data value.
5366 *
5367 * @return Returns the same Intent object, for chaining multiple calls
5368 * into a single statement.
5369 *
5370 * @see #putExtras
5371 * @see #removeExtra
5372 * @see #getSerializableExtra(String)
5373 */
5374 public Intent putExtra(String name, Serializable value) {
5375 if (mExtras == null) {
5376 mExtras = new Bundle();
5377 }
5378 mExtras.putSerializable(name, value);
5379 return this;
5380 }
5381
5382 /**
5383 * Add extended data to the intent. The name must include a package
5384 * prefix, for example the app com.android.contacts would use names
5385 * like "com.android.contacts.ShowAll".
5386 *
5387 * @param name The name of the extra data, with package prefix.
5388 * @param value The boolean array data value.
5389 *
5390 * @return Returns the same Intent object, for chaining multiple calls
5391 * into a single statement.
5392 *
5393 * @see #putExtras
5394 * @see #removeExtra
5395 * @see #getBooleanArrayExtra(String)
5396 */
5397 public Intent putExtra(String name, boolean[] value) {
5398 if (mExtras == null) {
5399 mExtras = new Bundle();
5400 }
5401 mExtras.putBooleanArray(name, value);
5402 return this;
5403 }
5404
5405 /**
5406 * Add extended data to the intent. The name must include a package
5407 * prefix, for example the app com.android.contacts would use names
5408 * like "com.android.contacts.ShowAll".
5409 *
5410 * @param name The name of the extra data, with package prefix.
5411 * @param value The byte array data value.
5412 *
5413 * @return Returns the same Intent object, for chaining multiple calls
5414 * into a single statement.
5415 *
5416 * @see #putExtras
5417 * @see #removeExtra
5418 * @see #getByteArrayExtra(String)
5419 */
5420 public Intent putExtra(String name, byte[] value) {
5421 if (mExtras == null) {
5422 mExtras = new Bundle();
5423 }
5424 mExtras.putByteArray(name, value);
5425 return this;
5426 }
5427
5428 /**
5429 * Add extended data to the intent. The name must include a package
5430 * prefix, for example the app com.android.contacts would use names
5431 * like "com.android.contacts.ShowAll".
5432 *
5433 * @param name The name of the extra data, with package prefix.
5434 * @param value The short array data value.
5435 *
5436 * @return Returns the same Intent object, for chaining multiple calls
5437 * into a single statement.
5438 *
5439 * @see #putExtras
5440 * @see #removeExtra
5441 * @see #getShortArrayExtra(String)
5442 */
5443 public Intent putExtra(String name, short[] value) {
5444 if (mExtras == null) {
5445 mExtras = new Bundle();
5446 }
5447 mExtras.putShortArray(name, value);
5448 return this;
5449 }
5450
5451 /**
5452 * Add extended data to the intent. The name must include a package
5453 * prefix, for example the app com.android.contacts would use names
5454 * like "com.android.contacts.ShowAll".
5455 *
5456 * @param name The name of the extra data, with package prefix.
5457 * @param value The char array data value.
5458 *
5459 * @return Returns the same Intent object, for chaining multiple calls
5460 * into a single statement.
5461 *
5462 * @see #putExtras
5463 * @see #removeExtra
5464 * @see #getCharArrayExtra(String)
5465 */
5466 public Intent putExtra(String name, char[] value) {
5467 if (mExtras == null) {
5468 mExtras = new Bundle();
5469 }
5470 mExtras.putCharArray(name, value);
5471 return this;
5472 }
5473
5474 /**
5475 * Add extended data to the intent. The name must include a package
5476 * prefix, for example the app com.android.contacts would use names
5477 * like "com.android.contacts.ShowAll".
5478 *
5479 * @param name The name of the extra data, with package prefix.
5480 * @param value The int array data value.
5481 *
5482 * @return Returns the same Intent object, for chaining multiple calls
5483 * into a single statement.
5484 *
5485 * @see #putExtras
5486 * @see #removeExtra
5487 * @see #getIntArrayExtra(String)
5488 */
5489 public Intent putExtra(String name, int[] value) {
5490 if (mExtras == null) {
5491 mExtras = new Bundle();
5492 }
5493 mExtras.putIntArray(name, value);
5494 return this;
5495 }
5496
5497 /**
5498 * Add extended data to the intent. The name must include a package
5499 * prefix, for example the app com.android.contacts would use names
5500 * like "com.android.contacts.ShowAll".
5501 *
5502 * @param name The name of the extra data, with package prefix.
5503 * @param value The byte array data value.
5504 *
5505 * @return Returns the same Intent object, for chaining multiple calls
5506 * into a single statement.
5507 *
5508 * @see #putExtras
5509 * @see #removeExtra
5510 * @see #getLongArrayExtra(String)
5511 */
5512 public Intent putExtra(String name, long[] value) {
5513 if (mExtras == null) {
5514 mExtras = new Bundle();
5515 }
5516 mExtras.putLongArray(name, value);
5517 return this;
5518 }
5519
5520 /**
5521 * Add extended data to the intent. The name must include a package
5522 * prefix, for example the app com.android.contacts would use names
5523 * like "com.android.contacts.ShowAll".
5524 *
5525 * @param name The name of the extra data, with package prefix.
5526 * @param value The float array data value.
5527 *
5528 * @return Returns the same Intent object, for chaining multiple calls
5529 * into a single statement.
5530 *
5531 * @see #putExtras
5532 * @see #removeExtra
5533 * @see #getFloatArrayExtra(String)
5534 */
5535 public Intent putExtra(String name, float[] value) {
5536 if (mExtras == null) {
5537 mExtras = new Bundle();
5538 }
5539 mExtras.putFloatArray(name, value);
5540 return this;
5541 }
5542
5543 /**
5544 * Add extended data to the intent. The name must include a package
5545 * prefix, for example the app com.android.contacts would use names
5546 * like "com.android.contacts.ShowAll".
5547 *
5548 * @param name The name of the extra data, with package prefix.
5549 * @param value The double array data value.
5550 *
5551 * @return Returns the same Intent object, for chaining multiple calls
5552 * into a single statement.
5553 *
5554 * @see #putExtras
5555 * @see #removeExtra
5556 * @see #getDoubleArrayExtra(String)
5557 */
5558 public Intent putExtra(String name, double[] value) {
5559 if (mExtras == null) {
5560 mExtras = new Bundle();
5561 }
5562 mExtras.putDoubleArray(name, value);
5563 return this;
5564 }
5565
5566 /**
5567 * Add extended data to the intent. The name must include a package
5568 * prefix, for example the app com.android.contacts would use names
5569 * like "com.android.contacts.ShowAll".
5570 *
5571 * @param name The name of the extra data, with package prefix.
5572 * @param value The String array data value.
5573 *
5574 * @return Returns the same Intent object, for chaining multiple calls
5575 * into a single statement.
5576 *
5577 * @see #putExtras
5578 * @see #removeExtra
5579 * @see #getStringArrayExtra(String)
5580 */
5581 public Intent putExtra(String name, String[] value) {
5582 if (mExtras == null) {
5583 mExtras = new Bundle();
5584 }
5585 mExtras.putStringArray(name, value);
5586 return this;
5587 }
5588
5589 /**
5590 * Add extended data to the intent. The name must include a package
5591 * prefix, for example the app com.android.contacts would use names
5592 * like "com.android.contacts.ShowAll".
5593 *
5594 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005595 * @param value The CharSequence array data value.
5596 *
5597 * @return Returns the same Intent object, for chaining multiple calls
5598 * into a single statement.
5599 *
5600 * @see #putExtras
5601 * @see #removeExtra
5602 * @see #getCharSequenceArrayExtra(String)
5603 */
5604 public Intent putExtra(String name, CharSequence[] value) {
5605 if (mExtras == null) {
5606 mExtras = new Bundle();
5607 }
5608 mExtras.putCharSequenceArray(name, value);
5609 return this;
5610 }
5611
5612 /**
5613 * Add extended data to the intent. The name must include a package
5614 * prefix, for example the app com.android.contacts would use names
5615 * like "com.android.contacts.ShowAll".
5616 *
5617 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005618 * @param value The Bundle data value.
5619 *
5620 * @return Returns the same Intent object, for chaining multiple calls
5621 * into a single statement.
5622 *
5623 * @see #putExtras
5624 * @see #removeExtra
5625 * @see #getBundleExtra(String)
5626 */
5627 public Intent putExtra(String name, Bundle value) {
5628 if (mExtras == null) {
5629 mExtras = new Bundle();
5630 }
5631 mExtras.putBundle(name, value);
5632 return this;
5633 }
5634
5635 /**
5636 * Add extended data to the intent. The name must include a package
5637 * prefix, for example the app com.android.contacts would use names
5638 * like "com.android.contacts.ShowAll".
5639 *
5640 * @param name The name of the extra data, with package prefix.
5641 * @param value The IBinder data value.
5642 *
5643 * @return Returns the same Intent object, for chaining multiple calls
5644 * into a single statement.
5645 *
5646 * @see #putExtras
5647 * @see #removeExtra
5648 * @see #getIBinderExtra(String)
5649 *
5650 * @deprecated
5651 * @hide
5652 */
5653 @Deprecated
5654 public Intent putExtra(String name, IBinder value) {
5655 if (mExtras == null) {
5656 mExtras = new Bundle();
5657 }
5658 mExtras.putIBinder(name, value);
5659 return this;
5660 }
5661
5662 /**
5663 * Copy all extras in 'src' in to this intent.
5664 *
5665 * @param src Contains the extras to copy.
5666 *
5667 * @see #putExtra
5668 */
5669 public Intent putExtras(Intent src) {
5670 if (src.mExtras != null) {
5671 if (mExtras == null) {
5672 mExtras = new Bundle(src.mExtras);
5673 } else {
5674 mExtras.putAll(src.mExtras);
5675 }
5676 }
5677 return this;
5678 }
5679
5680 /**
5681 * Add a set of extended data to the intent. The keys 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 extras The Bundle of extras to add to this intent.
5686 *
5687 * @see #putExtra
5688 * @see #removeExtra
5689 */
5690 public Intent putExtras(Bundle extras) {
5691 if (mExtras == null) {
5692 mExtras = new Bundle();
5693 }
5694 mExtras.putAll(extras);
5695 return this;
5696 }
5697
5698 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005699 * Completely replace the extras in the Intent with the extras in the
5700 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005701 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005702 * @param src The exact extras contained in this Intent are copied
5703 * into the target intent, replacing any that were previously there.
5704 */
5705 public Intent replaceExtras(Intent src) {
5706 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5707 return this;
5708 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005709
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005710 /**
5711 * Completely replace the extras in the Intent with the given Bundle of
5712 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005713 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005714 * @param extras The new set of extras in the Intent, or null to erase
5715 * all extras.
5716 */
5717 public Intent replaceExtras(Bundle extras) {
5718 mExtras = extras != null ? new Bundle(extras) : null;
5719 return this;
5720 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005721
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005722 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005723 * Remove extended data from the intent.
5724 *
5725 * @see #putExtra
5726 */
5727 public void removeExtra(String name) {
5728 if (mExtras != null) {
5729 mExtras.remove(name);
5730 if (mExtras.size() == 0) {
5731 mExtras = null;
5732 }
5733 }
5734 }
5735
5736 /**
5737 * Set special flags controlling how this intent is handled. Most values
5738 * here depend on the type of component being executed by the Intent,
5739 * specifically the FLAG_ACTIVITY_* flags are all for use with
5740 * {@link Context#startActivity Context.startActivity()} and the
5741 * FLAG_RECEIVER_* flags are all for use with
5742 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5743 *
Scott Main7aee61f2011-02-08 11:25:01 -08005744 * <p>See the
5745 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5746 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005747 * the behavior of your application.
5748 *
5749 * @param flags The desired flags.
5750 *
5751 * @return Returns the same Intent object, for chaining multiple calls
5752 * into a single statement.
5753 *
5754 * @see #getFlags
5755 * @see #addFlags
5756 *
5757 * @see #FLAG_GRANT_READ_URI_PERMISSION
5758 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5759 * @see #FLAG_DEBUG_LOG_RESOLUTION
5760 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005761 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005762 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005763 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005764 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005765 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5766 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005767 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005768 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5769 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005770 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005771 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005772 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005773 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5774 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005775 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005776 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005777 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005778 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5779 */
5780 public Intent setFlags(int flags) {
5781 mFlags = flags;
5782 return this;
5783 }
5784
5785 /**
5786 * Add additional flags to the intent (or with existing flags
5787 * value).
5788 *
5789 * @param flags The new flags to set.
5790 *
5791 * @return Returns the same Intent object, for chaining multiple calls
5792 * into a single statement.
5793 *
5794 * @see #setFlags
5795 */
5796 public Intent addFlags(int flags) {
5797 mFlags |= flags;
5798 return this;
5799 }
5800
5801 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005802 * (Usually optional) Set an explicit application package name that limits
5803 * the components this Intent will resolve to. If left to the default
5804 * value of null, all components in all applications will considered.
5805 * If non-null, the Intent can only match the components in the given
5806 * application package.
5807 *
5808 * @param packageName The name of the application package to handle the
5809 * intent, or null to allow any application package.
5810 *
5811 * @return Returns the same Intent object, for chaining multiple calls
5812 * into a single statement.
5813 *
5814 * @see #getPackage
5815 * @see #resolveActivity
5816 */
5817 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005818 if (packageName != null && mSelector != null) {
5819 throw new IllegalArgumentException(
5820 "Can't set package name when selector is already set");
5821 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005822 mPackage = packageName;
5823 return this;
5824 }
5825
5826 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005827 * (Usually optional) Explicitly set the component to handle the intent.
5828 * If left with the default value of null, the system will determine the
5829 * appropriate class to use based on the other fields (action, data,
5830 * type, categories) in the Intent. If this class is defined, the
5831 * specified class will always be used regardless of the other fields. You
5832 * should only set this value when you know you absolutely want a specific
5833 * class to be used; otherwise it is better to let the system find the
5834 * appropriate class so that you will respect the installed applications
5835 * and user preferences.
5836 *
5837 * @param component The name of the application component to handle the
5838 * intent, or null to let the system find one for you.
5839 *
5840 * @return Returns the same Intent object, for chaining multiple calls
5841 * into a single statement.
5842 *
5843 * @see #setClass
5844 * @see #setClassName(Context, String)
5845 * @see #setClassName(String, String)
5846 * @see #getComponent
5847 * @see #resolveActivity
5848 */
5849 public Intent setComponent(ComponentName component) {
5850 mComponent = component;
5851 return this;
5852 }
5853
5854 /**
5855 * Convenience for calling {@link #setComponent} with an
5856 * explicit class name.
5857 *
5858 * @param packageContext A Context of the application package implementing
5859 * this class.
5860 * @param className The name of a class inside of the application package
5861 * that will be used as the component for this Intent.
5862 *
5863 * @return Returns the same Intent object, for chaining multiple calls
5864 * into a single statement.
5865 *
5866 * @see #setComponent
5867 * @see #setClass
5868 */
5869 public Intent setClassName(Context packageContext, String className) {
5870 mComponent = new ComponentName(packageContext, className);
5871 return this;
5872 }
5873
5874 /**
5875 * Convenience for calling {@link #setComponent} with an
5876 * explicit application package name and class name.
5877 *
5878 * @param packageName The name of the package implementing the desired
5879 * component.
5880 * @param className The name of a class inside of the application package
5881 * that will be used as the component for this Intent.
5882 *
5883 * @return Returns the same Intent object, for chaining multiple calls
5884 * into a single statement.
5885 *
5886 * @see #setComponent
5887 * @see #setClass
5888 */
5889 public Intent setClassName(String packageName, String className) {
5890 mComponent = new ComponentName(packageName, className);
5891 return this;
5892 }
5893
5894 /**
5895 * Convenience for calling {@link #setComponent(ComponentName)} with the
5896 * name returned by a {@link Class} object.
5897 *
5898 * @param packageContext A Context of the application package implementing
5899 * this class.
5900 * @param cls The class name to set, equivalent to
5901 * <code>setClassName(context, cls.getName())</code>.
5902 *
5903 * @return Returns the same Intent object, for chaining multiple calls
5904 * into a single statement.
5905 *
5906 * @see #setComponent
5907 */
5908 public Intent setClass(Context packageContext, Class<?> cls) {
5909 mComponent = new ComponentName(packageContext, cls);
5910 return this;
5911 }
5912
5913 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005914 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5915 * used as a hint to the receiver for animations and the like. Null means that there
5916 * is no source bounds.
5917 */
5918 public void setSourceBounds(Rect r) {
5919 if (r != null) {
5920 mSourceBounds = new Rect(r);
5921 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005922 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005923 }
5924 }
5925
5926 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005927 * Use with {@link #fillIn} to allow the current action value to be
5928 * overwritten, even if it is already set.
5929 */
5930 public static final int FILL_IN_ACTION = 1<<0;
5931
5932 /**
5933 * Use with {@link #fillIn} to allow the current data or type value
5934 * overwritten, even if it is already set.
5935 */
5936 public static final int FILL_IN_DATA = 1<<1;
5937
5938 /**
5939 * Use with {@link #fillIn} to allow the current categories to be
5940 * overwritten, even if they are already set.
5941 */
5942 public static final int FILL_IN_CATEGORIES = 1<<2;
5943
5944 /**
5945 * Use with {@link #fillIn} to allow the current component value to be
5946 * overwritten, even if it is already set.
5947 */
5948 public static final int FILL_IN_COMPONENT = 1<<3;
5949
5950 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005951 * Use with {@link #fillIn} to allow the current package value to be
5952 * overwritten, even if it is already set.
5953 */
5954 public static final int FILL_IN_PACKAGE = 1<<4;
5955
5956 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005957 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005958 * overwritten, even if it is already set.
5959 */
5960 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5961
5962 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005963 * Use with {@link #fillIn} to allow the current selector to be
5964 * overwritten, even if it is already set.
5965 */
5966 public static final int FILL_IN_SELECTOR = 1<<6;
5967
5968 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005969 * Use with {@link #fillIn} to allow the current ClipData to be
5970 * overwritten, even if it is already set.
5971 */
5972 public static final int FILL_IN_CLIP_DATA = 1<<7;
5973
5974 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005975 * Copy the contents of <var>other</var> in to this object, but only
5976 * where fields are not defined by this object. For purposes of a field
5977 * being defined, the following pieces of data in the Intent are
5978 * considered to be separate fields:
5979 *
5980 * <ul>
5981 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005982 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005983 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5984 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005985 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005986 * <li> component, as set by {@link #setComponent(ComponentName)} or
5987 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005988 * <li> source bounds, as set by {@link #setSourceBounds}.
5989 * <li> selector, as set by {@link #setSelector(Intent)}.
5990 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005991 * <li> each top-level name in the associated extras.
5992 * </ul>
5993 *
5994 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005995 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005996 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5997 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5998 * the restriction where the corresponding field will not be replaced if
5999 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006000 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006001 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6002 * is explicitly specified. The selector will only be copied if
6003 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006004 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006005 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6006 * and Intent B with {action="gotit", data-type="some/thing",
6007 * categories="one","two"}.
6008 *
6009 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6010 * containing: {action="gotit", data-type="some/thing",
6011 * categories="bar"}.
6012 *
6013 * @param other Another Intent whose values are to be used to fill in
6014 * the current one.
6015 * @param flags Options to control which fields can be filled in.
6016 *
6017 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006018 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006019 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6020 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006021 */
6022 public int fillIn(Intent other, int flags) {
6023 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006024 if (other.mAction != null
6025 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006026 mAction = other.mAction;
6027 changes |= FILL_IN_ACTION;
6028 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006029 if ((other.mData != null || other.mType != null)
6030 && ((mData == null && mType == null)
6031 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006032 mData = other.mData;
6033 mType = other.mType;
6034 changes |= FILL_IN_DATA;
6035 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006036 if (other.mCategories != null
6037 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006038 if (other.mCategories != null) {
6039 mCategories = new HashSet<String>(other.mCategories);
6040 }
6041 changes |= FILL_IN_CATEGORIES;
6042 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006043 if (other.mPackage != null
6044 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006045 // Only do this if mSelector is not set.
6046 if (mSelector == null) {
6047 mPackage = other.mPackage;
6048 changes |= FILL_IN_PACKAGE;
6049 }
6050 }
6051 // Selector is special: it can only be set if explicitly allowed,
6052 // for the same reason as the component name.
6053 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6054 if (mPackage == null) {
6055 mSelector = new Intent(other.mSelector);
6056 mPackage = null;
6057 changes |= FILL_IN_SELECTOR;
6058 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006059 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006060 if (other.mClipData != null
6061 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6062 mClipData = other.mClipData;
6063 changes |= FILL_IN_CLIP_DATA;
6064 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006065 // Component is special: it can -only- be set if explicitly allowed,
6066 // since otherwise the sender could force the intent somewhere the
6067 // originator didn't intend.
6068 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006069 mComponent = other.mComponent;
6070 changes |= FILL_IN_COMPONENT;
6071 }
6072 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006073 if (other.mSourceBounds != null
6074 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6075 mSourceBounds = new Rect(other.mSourceBounds);
6076 changes |= FILL_IN_SOURCE_BOUNDS;
6077 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006078 if (mExtras == null) {
6079 if (other.mExtras != null) {
6080 mExtras = new Bundle(other.mExtras);
6081 }
6082 } else if (other.mExtras != null) {
6083 try {
6084 Bundle newb = new Bundle(other.mExtras);
6085 newb.putAll(mExtras);
6086 mExtras = newb;
6087 } catch (RuntimeException e) {
6088 // Modifying the extras can cause us to unparcel the contents
6089 // of the bundle, and if we do this in the system process that
6090 // may fail. We really should handle this (i.e., the Bundle
6091 // impl shouldn't be on top of a plain map), but for now just
6092 // ignore it and keep the original contents. :(
6093 Log.w("Intent", "Failure filling in extras", e);
6094 }
6095 }
6096 return changes;
6097 }
6098
6099 /**
6100 * Wrapper class holding an Intent and implementing comparisons on it for
6101 * the purpose of filtering. The class implements its
6102 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6103 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6104 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6105 * on the wrapped Intent.
6106 */
6107 public static final class FilterComparison {
6108 private final Intent mIntent;
6109 private final int mHashCode;
6110
6111 public FilterComparison(Intent intent) {
6112 mIntent = intent;
6113 mHashCode = intent.filterHashCode();
6114 }
6115
6116 /**
6117 * Return the Intent that this FilterComparison represents.
6118 * @return Returns the Intent held by the FilterComparison. Do
6119 * not modify!
6120 */
6121 public Intent getIntent() {
6122 return mIntent;
6123 }
6124
6125 @Override
6126 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006127 if (obj instanceof FilterComparison) {
6128 Intent other = ((FilterComparison)obj).mIntent;
6129 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006130 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006131 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006132 }
6133
6134 @Override
6135 public int hashCode() {
6136 return mHashCode;
6137 }
6138 }
6139
6140 /**
6141 * Determine if two intents are the same for the purposes of intent
6142 * resolution (filtering). That is, if their action, data, type,
6143 * class, and categories are the same. This does <em>not</em> compare
6144 * any extra data included in the intents.
6145 *
6146 * @param other The other Intent to compare against.
6147 *
6148 * @return Returns true if action, data, type, class, and categories
6149 * are the same.
6150 */
6151 public boolean filterEquals(Intent other) {
6152 if (other == null) {
6153 return false;
6154 }
6155 if (mAction != other.mAction) {
6156 if (mAction != null) {
6157 if (!mAction.equals(other.mAction)) {
6158 return false;
6159 }
6160 } else {
6161 if (!other.mAction.equals(mAction)) {
6162 return false;
6163 }
6164 }
6165 }
6166 if (mData != other.mData) {
6167 if (mData != null) {
6168 if (!mData.equals(other.mData)) {
6169 return false;
6170 }
6171 } else {
6172 if (!other.mData.equals(mData)) {
6173 return false;
6174 }
6175 }
6176 }
6177 if (mType != other.mType) {
6178 if (mType != null) {
6179 if (!mType.equals(other.mType)) {
6180 return false;
6181 }
6182 } else {
6183 if (!other.mType.equals(mType)) {
6184 return false;
6185 }
6186 }
6187 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006188 if (mPackage != other.mPackage) {
6189 if (mPackage != null) {
6190 if (!mPackage.equals(other.mPackage)) {
6191 return false;
6192 }
6193 } else {
6194 if (!other.mPackage.equals(mPackage)) {
6195 return false;
6196 }
6197 }
6198 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006199 if (mComponent != other.mComponent) {
6200 if (mComponent != null) {
6201 if (!mComponent.equals(other.mComponent)) {
6202 return false;
6203 }
6204 } else {
6205 if (!other.mComponent.equals(mComponent)) {
6206 return false;
6207 }
6208 }
6209 }
6210 if (mCategories != other.mCategories) {
6211 if (mCategories != null) {
6212 if (!mCategories.equals(other.mCategories)) {
6213 return false;
6214 }
6215 } else {
6216 if (!other.mCategories.equals(mCategories)) {
6217 return false;
6218 }
6219 }
6220 }
6221
6222 return true;
6223 }
6224
6225 /**
6226 * Generate hash code that matches semantics of filterEquals().
6227 *
6228 * @return Returns the hash value of the action, data, type, class, and
6229 * categories.
6230 *
6231 * @see #filterEquals
6232 */
6233 public int filterHashCode() {
6234 int code = 0;
6235 if (mAction != null) {
6236 code += mAction.hashCode();
6237 }
6238 if (mData != null) {
6239 code += mData.hashCode();
6240 }
6241 if (mType != null) {
6242 code += mType.hashCode();
6243 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006244 if (mPackage != null) {
6245 code += mPackage.hashCode();
6246 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006247 if (mComponent != null) {
6248 code += mComponent.hashCode();
6249 }
6250 if (mCategories != null) {
6251 code += mCategories.hashCode();
6252 }
6253 return code;
6254 }
6255
6256 @Override
6257 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006258 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006259
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006260 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006261 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006262 b.append(" }");
6263
6264 return b.toString();
6265 }
6266
6267 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006268 public String toInsecureString() {
6269 StringBuilder b = new StringBuilder(128);
6270
6271 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006272 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006273 b.append(" }");
6274
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006275 return b.toString();
6276 }
Romain Guy4969af72009-06-17 10:53:19 -07006277
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006278 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006279 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006280 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006281
6282 b.append("Intent { ");
6283 toShortString(b, false, true, true, true);
6284 b.append(" }");
6285
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006286 return b.toString();
6287 }
6288
6289 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006290 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6291 StringBuilder b = new StringBuilder(128);
6292 toShortString(b, secure, comp, extras, clip);
6293 return b.toString();
6294 }
6295
6296 /** @hide */
6297 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6298 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006299 boolean first = true;
6300 if (mAction != null) {
6301 b.append("act=").append(mAction);
6302 first = false;
6303 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006304 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006305 if (!first) {
6306 b.append(' ');
6307 }
6308 first = false;
6309 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006310 Iterator<String> i = mCategories.iterator();
6311 boolean didone = false;
6312 while (i.hasNext()) {
6313 if (didone) b.append(",");
6314 didone = true;
6315 b.append(i.next());
6316 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006317 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006318 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006319 if (mData != null) {
6320 if (!first) {
6321 b.append(' ');
6322 }
6323 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006324 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006325 if (secure) {
6326 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006327 } else {
6328 b.append(mData);
6329 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006330 }
6331 if (mType != null) {
6332 if (!first) {
6333 b.append(' ');
6334 }
6335 first = false;
6336 b.append("typ=").append(mType);
6337 }
6338 if (mFlags != 0) {
6339 if (!first) {
6340 b.append(' ');
6341 }
6342 first = false;
6343 b.append("flg=0x").append(Integer.toHexString(mFlags));
6344 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006345 if (mPackage != null) {
6346 if (!first) {
6347 b.append(' ');
6348 }
6349 first = false;
6350 b.append("pkg=").append(mPackage);
6351 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006352 if (comp && mComponent != null) {
6353 if (!first) {
6354 b.append(' ');
6355 }
6356 first = false;
6357 b.append("cmp=").append(mComponent.flattenToShortString());
6358 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006359 if (mSourceBounds != null) {
6360 if (!first) {
6361 b.append(' ');
6362 }
6363 first = false;
6364 b.append("bnds=").append(mSourceBounds.toShortString());
6365 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006366 if (mClipData != null) {
6367 if (!first) {
6368 b.append(' ');
6369 }
6370 first = false;
6371 if (clip) {
6372 b.append("clip={");
6373 mClipData.toShortString(b);
6374 b.append('}');
6375 } else {
6376 b.append("(has clip)");
6377 }
6378 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006379 if (extras && mExtras != null) {
6380 if (!first) {
6381 b.append(' ');
6382 }
6383 first = false;
6384 b.append("(has extras)");
6385 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006386 if (mSelector != null) {
6387 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006388 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006389 b.append("}");
6390 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006391 }
6392
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006393 /**
6394 * Call {@link #toUri} with 0 flags.
6395 * @deprecated Use {@link #toUri} instead.
6396 */
6397 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006398 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006399 return toUri(0);
6400 }
6401
6402 /**
6403 * Convert this Intent into a String holding a URI representation of it.
6404 * The returned URI string has been properly URI encoded, so it can be
6405 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6406 * Intent's data as the base URI, with an additional fragment describing
6407 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006408 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006409 * <p>You can convert the returned string back to an Intent with
6410 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006411 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006412 * @param flags Additional operating flags. Either 0 or
6413 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006414 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006415 * @return Returns a URI encoding URI string describing the entire contents
6416 * of the Intent.
6417 */
6418 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006419 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006420 String scheme = null;
6421 if (mData != null) {
6422 String data = mData.toString();
6423 if ((flags&URI_INTENT_SCHEME) != 0) {
6424 final int N = data.length();
6425 for (int i=0; i<N; i++) {
6426 char c = data.charAt(i);
6427 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6428 || c == '.' || c == '-') {
6429 continue;
6430 }
6431 if (c == ':' && i > 0) {
6432 // Valid scheme.
6433 scheme = data.substring(0, i);
6434 uri.append("intent:");
6435 data = data.substring(i+1);
6436 break;
6437 }
Tom Taylord4a47292009-12-21 13:59:18 -08006438
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006439 // No scheme.
6440 break;
6441 }
6442 }
6443 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006444
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006445 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6446 uri.append("intent:");
6447 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006448
6449 uri.append("#Intent;");
6450
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006451 toUriInner(uri, scheme, flags);
6452 if (mSelector != null) {
6453 uri.append("SEL;");
6454 // Note that for now we are not going to try to handle the
6455 // data part; not clear how to represent this as a URI, and
6456 // not much utility in it.
6457 mSelector.toUriInner(uri, null, flags);
6458 }
6459
6460 uri.append("end");
6461
6462 return uri.toString();
6463 }
6464
6465 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006466 if (scheme != null) {
6467 uri.append("scheme=").append(scheme).append(';');
6468 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006469 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006470 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006471 }
6472 if (mCategories != null) {
6473 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006474 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006475 }
6476 }
6477 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006478 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006479 }
6480 if (mFlags != 0) {
6481 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6482 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006483 if (mPackage != null) {
6484 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6485 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006486 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006487 uri.append("component=").append(Uri.encode(
6488 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006489 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006490 if (mSourceBounds != null) {
6491 uri.append("sourceBounds=")
6492 .append(Uri.encode(mSourceBounds.flattenToString()))
6493 .append(';');
6494 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006495 if (mExtras != null) {
6496 for (String key : mExtras.keySet()) {
6497 final Object value = mExtras.get(key);
6498 char entryType =
6499 value instanceof String ? 'S' :
6500 value instanceof Boolean ? 'B' :
6501 value instanceof Byte ? 'b' :
6502 value instanceof Character ? 'c' :
6503 value instanceof Double ? 'd' :
6504 value instanceof Float ? 'f' :
6505 value instanceof Integer ? 'i' :
6506 value instanceof Long ? 'l' :
6507 value instanceof Short ? 's' :
6508 '\0';
6509
6510 if (entryType != '\0') {
6511 uri.append(entryType);
6512 uri.append('.');
6513 uri.append(Uri.encode(key));
6514 uri.append('=');
6515 uri.append(Uri.encode(value.toString()));
6516 uri.append(';');
6517 }
6518 }
6519 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006520 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006521
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006522 public int describeContents() {
6523 return (mExtras != null) ? mExtras.describeContents() : 0;
6524 }
6525
6526 public void writeToParcel(Parcel out, int flags) {
6527 out.writeString(mAction);
6528 Uri.writeToParcel(out, mData);
6529 out.writeString(mType);
6530 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006531 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006532 ComponentName.writeToParcel(mComponent, out);
6533
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006534 if (mSourceBounds != null) {
6535 out.writeInt(1);
6536 mSourceBounds.writeToParcel(out, flags);
6537 } else {
6538 out.writeInt(0);
6539 }
6540
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006541 if (mCategories != null) {
6542 out.writeInt(mCategories.size());
6543 for (String category : mCategories) {
6544 out.writeString(category);
6545 }
6546 } else {
6547 out.writeInt(0);
6548 }
6549
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006550 if (mSelector != null) {
6551 out.writeInt(1);
6552 mSelector.writeToParcel(out, flags);
6553 } else {
6554 out.writeInt(0);
6555 }
6556
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006557 if (mClipData != null) {
6558 out.writeInt(1);
6559 mClipData.writeToParcel(out, flags);
6560 } else {
6561 out.writeInt(0);
6562 }
6563
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006564 out.writeBundle(mExtras);
6565 }
6566
6567 public static final Parcelable.Creator<Intent> CREATOR
6568 = new Parcelable.Creator<Intent>() {
6569 public Intent createFromParcel(Parcel in) {
6570 return new Intent(in);
6571 }
6572 public Intent[] newArray(int size) {
6573 return new Intent[size];
6574 }
6575 };
6576
Dianne Hackborneb034652009-09-07 00:49:58 -07006577 /** @hide */
6578 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006579 readFromParcel(in);
6580 }
6581
6582 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006583 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006584 mData = Uri.CREATOR.createFromParcel(in);
6585 mType = in.readString();
6586 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006587 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006588 mComponent = ComponentName.readFromParcel(in);
6589
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006590 if (in.readInt() != 0) {
6591 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6592 }
6593
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006594 int N = in.readInt();
6595 if (N > 0) {
6596 mCategories = new HashSet<String>();
6597 int i;
6598 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006599 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006600 }
6601 } else {
6602 mCategories = null;
6603 }
6604
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006605 if (in.readInt() != 0) {
6606 mSelector = new Intent(in);
6607 }
6608
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006609 if (in.readInt() != 0) {
6610 mClipData = new ClipData(in);
6611 }
6612
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006613 mExtras = in.readBundle();
6614 }
6615
6616 /**
6617 * Parses the "intent" element (and its children) from XML and instantiates
6618 * an Intent object. The given XML parser should be located at the tag
6619 * where parsing should start (often named "intent"), from which the
6620 * basic action, data, type, and package and class name will be
6621 * retrieved. The function will then parse in to any child elements,
6622 * looking for <category android:name="xxx"> tags to add categories and
6623 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6624 * to the intent.
6625 *
6626 * @param resources The Resources to use when inflating resources.
6627 * @param parser The XML parser pointing at an "intent" tag.
6628 * @param attrs The AttributeSet interface for retrieving extended
6629 * attribute data at the current <var>parser</var> location.
6630 * @return An Intent object matching the XML data.
6631 * @throws XmlPullParserException If there was an XML parsing error.
6632 * @throws IOException If there was an I/O error.
6633 */
6634 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6635 throws XmlPullParserException, IOException {
6636 Intent intent = new Intent();
6637
6638 TypedArray sa = resources.obtainAttributes(attrs,
6639 com.android.internal.R.styleable.Intent);
6640
6641 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6642
6643 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6644 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6645 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6646
6647 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6648 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6649 if (packageName != null && className != null) {
6650 intent.setComponent(new ComponentName(packageName, className));
6651 }
6652
6653 sa.recycle();
6654
6655 int outerDepth = parser.getDepth();
6656 int type;
6657 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6658 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6659 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6660 continue;
6661 }
6662
6663 String nodeName = parser.getName();
6664 if (nodeName.equals("category")) {
6665 sa = resources.obtainAttributes(attrs,
6666 com.android.internal.R.styleable.IntentCategory);
6667 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6668 sa.recycle();
6669
6670 if (cat != null) {
6671 intent.addCategory(cat);
6672 }
6673 XmlUtils.skipCurrentTag(parser);
6674
6675 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006676 if (intent.mExtras == null) {
6677 intent.mExtras = new Bundle();
6678 }
6679 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6680 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006681
6682 } else {
6683 XmlUtils.skipCurrentTag(parser);
6684 }
6685 }
6686
6687 return intent;
6688 }
Nick Pellyccae4122012-01-09 14:12:58 -08006689
6690 /**
6691 * Normalize a MIME data type.
6692 *
6693 * <p>A normalized MIME type has white-space trimmed,
6694 * content-type parameters removed, and is lower-case.
6695 * This aligns the type with Android best practices for
6696 * intent filtering.
6697 *
6698 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6699 * "text/x-vCard" becomes "text/x-vcard".
6700 *
6701 * <p>All MIME types received from outside Android (such as user input,
6702 * or external sources like Bluetooth, NFC, or the Internet) should
6703 * be normalized before they are used to create an Intent.
6704 *
6705 * @param type MIME data type to normalize
6706 * @return normalized MIME data type, or null if the input was null
6707 * @see {@link #setType}
6708 * @see {@link #setTypeAndNormalize}
6709 */
6710 public static String normalizeMimeType(String type) {
6711 if (type == null) {
6712 return null;
6713 }
6714
6715 type = type.trim().toLowerCase(Locale.US);
6716
6717 final int semicolonIndex = type.indexOf(';');
6718 if (semicolonIndex != -1) {
6719 type = type.substring(0, semicolonIndex);
6720 }
6721 return type;
6722 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006723
6724 /**
6725 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006726 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6727 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006728 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006729 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006730 * @hide
6731 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006732 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006733 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006734 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006735
6736 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006737 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006738
6739 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006740 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006741 try {
6742 // Inspect target intent to see if we need to migrate
6743 final Intent target = getParcelableExtra(EXTRA_INTENT);
6744 if (target != null && target.migrateExtraStreamToClipData()) {
6745 // Since we migrated in child, we need to promote ClipData
6746 // and flags to ourselves to grant.
6747 setClipData(target.getClipData());
6748 addFlags(target.getFlags()
6749 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6750 return true;
6751 } else {
6752 return false;
6753 }
6754 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006755 }
6756
6757 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006758 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006759 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6760 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6761 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6762 if (stream != null || text != null || htmlText != null) {
6763 final ClipData clipData = new ClipData(
6764 null, new String[] { getType() },
6765 new ClipData.Item(text, htmlText, null, stream));
6766 setClipData(clipData);
6767 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006768 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006769 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006770 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006771 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006772
6773 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006774 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006775 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6776 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6777 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6778 int num = -1;
6779 if (streams != null) {
6780 num = streams.size();
6781 }
6782 if (texts != null) {
6783 if (num >= 0 && num != texts.size()) {
6784 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006785 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006786 }
6787 num = texts.size();
6788 }
6789 if (htmlTexts != null) {
6790 if (num >= 0 && num != htmlTexts.size()) {
6791 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006792 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006793 }
6794 num = htmlTexts.size();
6795 }
6796 if (num > 0) {
6797 final ClipData clipData = new ClipData(
6798 null, new String[] { getType() },
6799 makeClipItem(streams, texts, htmlTexts, 0));
6800
6801 for (int i = 1; i < num; i++) {
6802 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6803 }
6804
6805 setClipData(clipData);
6806 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006807 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006808 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006809 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006810 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006811 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006812
6813 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006814 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006815
6816 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6817 ArrayList<String> htmlTexts, int which) {
6818 Uri uri = streams != null ? streams.get(which) : null;
6819 CharSequence text = texts != null ? texts.get(which) : null;
6820 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6821 return new ClipData.Item(text, htmlText, null, uri);
6822 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006823}