blob: a954f59720d6f5a74d438877dfe6563e82f15b7d [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
Dianne Hackbornadd005c2013-07-17 18:43:12 -070019import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070020import org.xmlpull.v1.XmlPullParser;
21import org.xmlpull.v1.XmlPullParserException;
22
23import android.annotation.SdkConstant;
24import android.annotation.SdkConstant.SdkConstantType;
25import android.content.pm.ActivityInfo;
26import android.content.pm.PackageManager;
27import android.content.pm.ResolveInfo;
28import android.content.res.Resources;
29import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080030import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070031import android.net.Uri;
32import android.os.Bundle;
33import android.os.IBinder;
34import android.os.Parcel;
35import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070036import android.os.StrictMode;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070037import android.util.AttributeSet;
38import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080039
40import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070041
42import java.io.IOException;
43import java.io.Serializable;
44import java.net.URISyntaxException;
45import java.util.ArrayList;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070046import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080047import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import java.util.Set;
49
50/**
51 * An intent is an abstract description of an operation to be performed. It
52 * can be used with {@link Context#startActivity(Intent) startActivity} to
53 * launch an {@link android.app.Activity},
54 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
55 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
56 * and {@link android.content.Context#startService} or
57 * {@link android.content.Context#bindService} to communicate with a
58 * background {@link android.app.Service}.
59 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070060 * <p>An Intent provides a facility for performing late runtime binding between the code in
61 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070062 * can be thought of as the glue between activities. It is basically a passive data structure
63 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070064 *
65 * <div class="special reference">
66 * <h3>Developer Guides</h3>
67 * <p>For information about how to create and resolve intents, read the
68 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
69 * developer guide.</p>
70 * </div>
71 *
72 * <a name="IntentStructure"></a>
73 * <h3>Intent Structure</h3>
74 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070075 *
76 * <ul>
77 * <li> <p><b>action</b> -- The general action to be performed, such as
78 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
79 * etc.</p>
80 * </li>
81 * <li> <p><b>data</b> -- The data to operate on, such as a person record
82 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
83 * </li>
84 * </ul>
85 *
86 *
87 * <p>Some examples of action/data pairs are:</p>
88 *
89 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070090 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070091 * information about the person whose identifier is "1".</p>
92 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070093 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070094 * the phone dialer with the person filled in.</p>
95 * </li>
96 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
97 * the phone dialer with the given number filled in. Note how the
98 * VIEW action does what what is considered the most reasonable thing for
99 * a particular URI.</p>
100 * </li>
101 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
102 * the phone dialer with the given number filled in.</p>
103 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700104 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700105 * information about the person whose identifier is "1".</p>
106 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700107 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700108 * a list of people, which the user can browse through. This example is a
109 * typical top-level entry into the Contacts application, showing you the
110 * list of people. Selecting a particular person to view would result in a
111 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
112 * being used to start an activity to display that person.</p>
113 * </li>
114 * </ul>
115 *
116 * <p>In addition to these primary attributes, there are a number of secondary
117 * attributes that you can also include with an intent:</p>
118 *
119 * <ul>
120 * <li> <p><b>category</b> -- Gives additional information about the action
121 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
122 * appear in the Launcher as a top-level application, while
123 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
124 * of alternative actions the user can perform on a piece of data.</p>
125 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
126 * intent data. Normally the type is inferred from the data itself.
127 * By setting this attribute, you disable that evaluation and force
128 * an explicit type.</p>
129 * <li> <p><b>component</b> -- Specifies an explicit name of a component
130 * class to use for the intent. Normally this is determined by looking
131 * at the other information in the intent (the action, data/type, and
132 * categories) and matching that with a component that can handle it.
133 * If this attribute is set then none of the evaluation is performed,
134 * and this component is used exactly as is. By specifying this attribute,
135 * all of the other Intent attributes become optional.</p>
136 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
137 * This can be used to provide extended information to the component.
138 * For example, if we have a action to send an e-mail message, we could
139 * also include extra pieces of data here to supply a subject, body,
140 * etc.</p>
141 * </ul>
142 *
143 * <p>Here are some examples of other operations you can specify as intents
144 * using these additional parameters:</p>
145 *
146 * <ul>
147 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
148 * Launch the home screen.</p>
149 * </li>
150 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
151 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
152 * vnd.android.cursor.item/phone}</i></b>
153 * -- Display the list of people's phone numbers, allowing the user to
154 * browse through them and pick one and return it to the parent activity.</p>
155 * </li>
156 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
157 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
158 * -- Display all pickers for data that can be opened with
159 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
160 * allowing the user to pick one of them and then some data inside of it
161 * and returning the resulting URI to the caller. This can be used,
162 * for example, in an e-mail application to allow the user to pick some
163 * data to include as an attachment.</p>
164 * </li>
165 * </ul>
166 *
167 * <p>There are a variety of standard Intent action and category constants
168 * defined in the Intent class, but applications can also define their own.
169 * These strings use java style scoping, to ensure they are unique -- for
170 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700171 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700172 *
173 * <p>Put together, the set of actions, data types, categories, and extra data
174 * defines a language for the system allowing for the expression of phrases
175 * such as "call john smith's cell". As applications are added to the system,
176 * they can extend this language by adding new actions, types, and categories, or
177 * they can modify the behavior of existing phrases by supplying their own
178 * activities that handle them.</p>
179 *
180 * <a name="IntentResolution"></a>
181 * <h3>Intent Resolution</h3>
182 *
183 * <p>There are two primary forms of intents you will use.
184 *
185 * <ul>
186 * <li> <p><b>Explicit Intents</b> have specified a component (via
187 * {@link #setComponent} or {@link #setClass}), which provides the exact
188 * class to be run. Often these will not include any other information,
189 * simply being a way for an application to launch various internal
190 * activities it has as the user interacts with the application.
191 *
192 * <li> <p><b>Implicit Intents</b> have not specified a component;
193 * instead, they must include enough information for the system to
194 * determine which of the available components is best to run for that
195 * intent.
196 * </ul>
197 *
198 * <p>When using implicit intents, given such an arbitrary intent we need to
199 * know what to do with it. This is handled by the process of <em>Intent
200 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
201 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
202 * more activities/receivers) that can handle it.</p>
203 *
204 * <p>The intent resolution mechanism basically revolves around matching an
205 * Intent against all of the &lt;intent-filter&gt; descriptions in the
206 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
207 * objects explicitly registered with {@link Context#registerReceiver}.) More
208 * details on this can be found in the documentation on the {@link
209 * IntentFilter} class.</p>
210 *
211 * <p>There are three pieces of information in the Intent that are used for
212 * resolution: the action, type, and category. Using this information, a query
213 * is done on the {@link PackageManager} for a component that can handle the
214 * intent. The appropriate component is determined based on the intent
215 * information supplied in the <code>AndroidManifest.xml</code> file as
216 * follows:</p>
217 *
218 * <ul>
219 * <li> <p>The <b>action</b>, if given, must be listed by the component as
220 * one it handles.</p>
221 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
222 * already supplied in the Intent. Like the action, if a type is
223 * included in the intent (either explicitly or implicitly in its
224 * data), then this must be listed by the component as one it handles.</p>
225 * <li> For data that is not a <code>content:</code> URI and where no explicit
226 * type is included in the Intent, instead the <b>scheme</b> of the
227 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
228 * considered. Again like the action, if we are matching a scheme it
229 * must be listed by the component as one it can handle.
230 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
231 * by the activity as categories it handles. That is, if you include
232 * the categories {@link #CATEGORY_LAUNCHER} and
233 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
234 * with an intent that lists <em>both</em> of those categories.
235 * Activities will very often need to support the
236 * {@link #CATEGORY_DEFAULT} so that they can be found by
237 * {@link Context#startActivity Context.startActivity()}.</p>
238 * </ul>
239 *
240 * <p>For example, consider the Note Pad sample application that
241 * allows user to browse through a list of notes data and view details about
242 * individual items. Text in italics indicate places were you would replace a
243 * name with one specific to your own package.</p>
244 *
245 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
246 * package="<i>com.android.notepad</i>"&gt;
247 * &lt;application android:icon="@drawable/app_notes"
248 * android:label="@string/app_name"&gt;
249 *
250 * &lt;provider class=".NotePadProvider"
251 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
252 *
253 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
254 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700255 * &lt;action android:name="android.intent.action.MAIN" /&gt;
256 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700257 * &lt;/intent-filter&gt;
258 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700259 * &lt;action android:name="android.intent.action.VIEW" /&gt;
260 * &lt;action android:name="android.intent.action.EDIT" /&gt;
261 * &lt;action android:name="android.intent.action.PICK" /&gt;
262 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
263 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700264 * &lt;/intent-filter&gt;
265 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700266 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
267 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
268 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700269 * &lt;/intent-filter&gt;
270 * &lt;/activity&gt;
271 *
272 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
273 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700274 * &lt;action android:name="android.intent.action.VIEW" /&gt;
275 * &lt;action android:name="android.intent.action.EDIT" /&gt;
276 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
277 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700278 * &lt;/intent-filter&gt;
279 *
280 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="android.intent.action.INSERT" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 *
286 * &lt;/activity&gt;
287 *
288 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
289 * android:theme="@android:style/Theme.Dialog"&gt;
290 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700291 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
292 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
293 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
294 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
295 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700296 * &lt;/intent-filter&gt;
297 * &lt;/activity&gt;
298 *
299 * &lt;/application&gt;
300 * &lt;/manifest&gt;</pre>
301 *
302 * <p>The first activity,
303 * <code>com.android.notepad.NotesList</code>, serves as our main
304 * entry into the app. It can do three things as described by its three intent
305 * templates:
306 * <ol>
307 * <li><pre>
308 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700309 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
310 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700311 * &lt;/intent-filter&gt;</pre>
312 * <p>This provides a top-level entry into the NotePad application: the standard
313 * MAIN action is a main entry point (not requiring any other information in
314 * the Intent), and the LAUNCHER category says that this entry point should be
315 * listed in the application launcher.</p>
316 * <li><pre>
317 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700318 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
319 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
320 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
321 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
322 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700323 * &lt;/intent-filter&gt;</pre>
324 * <p>This declares the things that the activity can do on a directory of
325 * notes. The type being supported is given with the &lt;type&gt; tag, where
326 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
327 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
328 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
329 * The activity allows the user to view or edit the directory of data (via
330 * the VIEW and EDIT actions), or to pick a particular note and return it
331 * to the caller (via the PICK action). Note also the DEFAULT category
332 * supplied here: this is <em>required</em> for the
333 * {@link Context#startActivity Context.startActivity} method to resolve your
334 * activity when its component name is not explicitly specified.</p>
335 * <li><pre>
336 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700337 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
338 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
339 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700340 * &lt;/intent-filter&gt;</pre>
341 * <p>This filter describes the ability return to the caller a note selected by
342 * the user without needing to know where it came from. The data type
343 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
344 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
345 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
346 * The GET_CONTENT action is similar to the PICK action, where the activity
347 * will return to its caller a piece of data selected by the user. Here,
348 * however, the caller specifies the type of data they desire instead of
349 * the type of data the user will be picking from.</p>
350 * </ol>
351 *
352 * <p>Given these capabilities, the following intents will resolve to the
353 * NotesList activity:</p>
354 *
355 * <ul>
356 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
357 * activities that can be used as top-level entry points into an
358 * application.</p>
359 * <li> <p><b>{ action=android.app.action.MAIN,
360 * category=android.app.category.LAUNCHER }</b> is the actual intent
361 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700362 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700363 * data=content://com.google.provider.NotePad/notes }</b>
364 * displays a list of all the notes under
365 * "content://com.google.provider.NotePad/notes", which
366 * the user can browse through and see the details on.</p>
367 * <li> <p><b>{ action=android.app.action.PICK
368 * data=content://com.google.provider.NotePad/notes }</b>
369 * provides a list of the notes under
370 * "content://com.google.provider.NotePad/notes", from which
371 * the user can pick a note whose data URL is returned back to the caller.</p>
372 * <li> <p><b>{ action=android.app.action.GET_CONTENT
373 * type=vnd.android.cursor.item/vnd.google.note }</b>
374 * is similar to the pick action, but allows the caller to specify the
375 * kind of data they want back so that the system can find the appropriate
376 * activity to pick something of that data type.</p>
377 * </ul>
378 *
379 * <p>The second activity,
380 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
381 * note entry and allows them to edit it. It can do two things as described
382 * by its two intent templates:
383 * <ol>
384 * <li><pre>
385 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700386 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
387 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
388 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
389 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700390 * &lt;/intent-filter&gt;</pre>
391 * <p>The first, primary, purpose of this activity is to let the user interact
392 * with a single note, as decribed by the MIME type
393 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
394 * either VIEW a note or allow the user to EDIT it. Again we support the
395 * DEFAULT category to allow the activity to be launched without explicitly
396 * specifying its component.</p>
397 * <li><pre>
398 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700399 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
400 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
401 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700402 * &lt;/intent-filter&gt;</pre>
403 * <p>The secondary use of this activity is to insert a new note entry into
404 * an existing directory of notes. This is used when the user creates a new
405 * note: the INSERT action is executed on the directory of notes, causing
406 * this activity to run and have the user create the new note data which
407 * it then adds to the content provider.</p>
408 * </ol>
409 *
410 * <p>Given these capabilities, the following intents will resolve to the
411 * NoteEditor activity:</p>
412 *
413 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700414 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700415 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
416 * shows the user the content of note <var>{ID}</var>.</p>
417 * <li> <p><b>{ action=android.app.action.EDIT
418 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
419 * allows the user to edit the content of note <var>{ID}</var>.</p>
420 * <li> <p><b>{ action=android.app.action.INSERT
421 * data=content://com.google.provider.NotePad/notes }</b>
422 * creates a new, empty note in the notes list at
423 * "content://com.google.provider.NotePad/notes"
424 * and allows the user to edit it. If they keep their changes, the URI
425 * of the newly created note is returned to the caller.</p>
426 * </ul>
427 *
428 * <p>The last activity,
429 * <code>com.android.notepad.TitleEditor</code>, allows the user to
430 * edit the title of a note. This could be implemented as a class that the
431 * application directly invokes (by explicitly setting its component in
432 * the Intent), but here we show a way you can publish alternative
433 * operations on existing data:</p>
434 *
435 * <pre>
436 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700437 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
440 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
441 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700442 * &lt;/intent-filter&gt;</pre>
443 *
444 * <p>In the single intent template here, we
445 * have created our own private action called
446 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
447 * edit the title of a note. It must be invoked on a specific note
448 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
449 * view and edit actions, but here displays and edits the title contained
450 * in the note data.
451 *
452 * <p>In addition to supporting the default category as usual, our title editor
453 * also supports two other standard categories: ALTERNATIVE and
454 * SELECTED_ALTERNATIVE. Implementing
455 * these categories allows others to find the special action it provides
456 * without directly knowing about it, through the
457 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
458 * more often to build dynamic menu items with
459 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
460 * template here was also supply an explicit name for the template
461 * (via <code>android:label="@string/resolve_title"</code>) to better control
462 * what the user sees when presented with this activity as an alternative
463 * action to the data they are viewing.
464 *
465 * <p>Given these capabilities, the following intent will resolve to the
466 * TitleEditor activity:</p>
467 *
468 * <ul>
469 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
470 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
471 * displays and allows the user to edit the title associated
472 * with note <var>{ID}</var>.</p>
473 * </ul>
474 *
475 * <h3>Standard Activity Actions</h3>
476 *
477 * <p>These are the current standard actions that Intent defines for launching
478 * activities (usually through {@link Context#startActivity}. The most
479 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
480 * {@link #ACTION_EDIT}.
481 *
482 * <ul>
483 * <li> {@link #ACTION_MAIN}
484 * <li> {@link #ACTION_VIEW}
485 * <li> {@link #ACTION_ATTACH_DATA}
486 * <li> {@link #ACTION_EDIT}
487 * <li> {@link #ACTION_PICK}
488 * <li> {@link #ACTION_CHOOSER}
489 * <li> {@link #ACTION_GET_CONTENT}
490 * <li> {@link #ACTION_DIAL}
491 * <li> {@link #ACTION_CALL}
492 * <li> {@link #ACTION_SEND}
493 * <li> {@link #ACTION_SENDTO}
494 * <li> {@link #ACTION_ANSWER}
495 * <li> {@link #ACTION_INSERT}
496 * <li> {@link #ACTION_DELETE}
497 * <li> {@link #ACTION_RUN}
498 * <li> {@link #ACTION_SYNC}
499 * <li> {@link #ACTION_PICK_ACTIVITY}
500 * <li> {@link #ACTION_SEARCH}
501 * <li> {@link #ACTION_WEB_SEARCH}
502 * <li> {@link #ACTION_FACTORY_TEST}
503 * </ul>
504 *
505 * <h3>Standard Broadcast Actions</h3>
506 *
507 * <p>These are the current standard actions that Intent defines for receiving
508 * broadcasts (usually through {@link Context#registerReceiver} or a
509 * &lt;receiver&gt; tag in a manifest).
510 *
511 * <ul>
512 * <li> {@link #ACTION_TIME_TICK}
513 * <li> {@link #ACTION_TIME_CHANGED}
514 * <li> {@link #ACTION_TIMEZONE_CHANGED}
515 * <li> {@link #ACTION_BOOT_COMPLETED}
516 * <li> {@link #ACTION_PACKAGE_ADDED}
517 * <li> {@link #ACTION_PACKAGE_CHANGED}
518 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800519 * <li> {@link #ACTION_PACKAGE_RESTARTED}
520 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700521 * <li> {@link #ACTION_UID_REMOVED}
522 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700523 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700524 * <li> {@link #ACTION_POWER_DISCONNECTED}
525 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700526 * </ul>
527 *
528 * <h3>Standard Categories</h3>
529 *
530 * <p>These are the current standard categories that can be used to further
531 * clarify an Intent via {@link #addCategory}.
532 *
533 * <ul>
534 * <li> {@link #CATEGORY_DEFAULT}
535 * <li> {@link #CATEGORY_BROWSABLE}
536 * <li> {@link #CATEGORY_TAB}
537 * <li> {@link #CATEGORY_ALTERNATIVE}
538 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
539 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800540 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700541 * <li> {@link #CATEGORY_HOME}
542 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400544 * <li> {@link #CATEGORY_CAR_DOCK}
545 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500546 * <li> {@link #CATEGORY_LE_DESK_DOCK}
547 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200548 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700549 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700550 * </ul>
551 *
552 * <h3>Standard Extra Data</h3>
553 *
554 * <p>These are the current standard fields that can be used as extra data via
555 * {@link #putExtra}.
556 *
557 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800558 * <li> {@link #EXTRA_ALARM_COUNT}
559 * <li> {@link #EXTRA_BCC}
560 * <li> {@link #EXTRA_CC}
561 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
562 * <li> {@link #EXTRA_DATA_REMOVED}
563 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500564 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
565 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800566 * <li> {@link #EXTRA_DOCK_STATE_CAR}
567 * <li> {@link #EXTRA_DOCK_STATE_DESK}
568 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
569 * <li> {@link #EXTRA_DONT_KILL_APP}
570 * <li> {@link #EXTRA_EMAIL}
571 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800573 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700574 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700576 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800577 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
578 * <li> {@link #EXTRA_REPLACING}
579 * <li> {@link #EXTRA_SHORTCUT_ICON}
580 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
581 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700582 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_SHORTCUT_NAME}
584 * <li> {@link #EXTRA_SUBJECT}
585 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800587 * <li> {@link #EXTRA_TITLE}
588 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700589 * </ul>
590 *
591 * <h3>Flags</h3>
592 *
593 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800594 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
595 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700596 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800597public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700598 // ---------------------------------------------------------------------
599 // ---------------------------------------------------------------------
600 // Standard intent activity actions (see action variable).
601
602 /**
603 * Activity Action: Start as a main entry point, does not expect to
604 * receive data.
605 * <p>Input: nothing
606 * <p>Output: nothing
607 */
608 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
609 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800610
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 /**
612 * Activity Action: Display the data to the user. This is the most common
613 * action performed on data -- it is the generic action you can use on
614 * a piece of data to get the most reasonable thing to occur. For example,
615 * when used on a contacts entry it will view the entry; when used on a
616 * mailto: URI it will bring up a compose window filled with the information
617 * supplied by the URI; when used with a tel: URI it will invoke the
618 * dialer.
619 * <p>Input: {@link #getData} is URI from which to retrieve data.
620 * <p>Output: nothing.
621 */
622 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
623 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700625 /**
626 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
627 * performed on a piece of data.
628 */
629 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800630
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700631 /**
632 * Used to indicate that some piece of data should be attached to some other
633 * place. For example, image data could be attached to a contact. It is up
634 * to the recipient to decide where the data should be attached; the intent
635 * does not specify the ultimate destination.
636 * <p>Input: {@link #getData} is URI of data to be attached.
637 * <p>Output: nothing.
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Provide explicit editable access to the given data.
644 * <p>Input: {@link #getData} is URI of data to be edited.
645 * <p>Output: nothing.
646 */
647 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
648 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700650 /**
651 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
652 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
653 * The extras can contain type specific data to pass through to the editing/creating
654 * activity.
655 * <p>Output: The URI of the item that was picked. This must be a content:
656 * URI so that any receiver can access it.
657 */
658 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
659 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700661 /**
662 * Activity Action: Pick an item from the data, returning what was selected.
663 * <p>Input: {@link #getData} is URI containing a directory of data
664 * (vnd.android.cursor.dir/*) from which to pick an item.
665 * <p>Output: The URI of the item that was picked.
666 */
667 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
668 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800669
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 /**
671 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800672 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700673 * <p>Output: An Intent representing the shortcut. The intent must contain three
674 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
675 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676 * (value: ShortcutIconResource).</p>
677 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700678 * @see #EXTRA_SHORTCUT_INTENT
679 * @see #EXTRA_SHORTCUT_NAME
680 * @see #EXTRA_SHORTCUT_ICON
681 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
682 * @see android.content.Intent.ShortcutIconResource
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
686
687 /**
688 * The name of the extra used to define the Intent of a shortcut.
689 *
690 * @see #ACTION_CREATE_SHORTCUT
691 */
692 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
693 /**
694 * The name of the extra used to define the name of a shortcut.
695 *
696 * @see #ACTION_CREATE_SHORTCUT
697 */
698 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
699 /**
700 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
701 *
702 * @see #ACTION_CREATE_SHORTCUT
703 */
704 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
705 /**
706 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
707 *
708 * @see #ACTION_CREATE_SHORTCUT
709 * @see android.content.Intent.ShortcutIconResource
710 */
711 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
712 "android.intent.extra.shortcut.ICON_RESOURCE";
713
714 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800715 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700716 *
717 * @see Intent#ACTION_CREATE_SHORTCUT
718 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800719 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
720 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700721 */
722 public static class ShortcutIconResource implements Parcelable {
723 /**
724 * The package name of the application containing the icon.
725 */
726 public String packageName;
727
728 /**
729 * The resource name of the icon, including package, name and type.
730 */
731 public String resourceName;
732
733 /**
734 * Creates a new ShortcutIconResource for the specified context and resource
735 * identifier.
736 *
737 * @param context The context of the application.
738 * @param resourceId The resource idenfitier for the icon.
739 * @return A new ShortcutIconResource with the specified's context package name
740 * and icon resource idenfitier.
741 */
742 public static ShortcutIconResource fromContext(Context context, int resourceId) {
743 ShortcutIconResource icon = new ShortcutIconResource();
744 icon.packageName = context.getPackageName();
745 icon.resourceName = context.getResources().getResourceName(resourceId);
746 return icon;
747 }
748
749 /**
750 * Used to read a ShortcutIconResource from a Parcel.
751 */
752 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
753 new Parcelable.Creator<ShortcutIconResource>() {
754
755 public ShortcutIconResource createFromParcel(Parcel source) {
756 ShortcutIconResource icon = new ShortcutIconResource();
757 icon.packageName = source.readString();
758 icon.resourceName = source.readString();
759 return icon;
760 }
761
762 public ShortcutIconResource[] newArray(int size) {
763 return new ShortcutIconResource[size];
764 }
765 };
766
767 /**
768 * No special parcel contents.
769 */
770 public int describeContents() {
771 return 0;
772 }
773
774 public void writeToParcel(Parcel dest, int flags) {
775 dest.writeString(packageName);
776 dest.writeString(resourceName);
777 }
778
779 @Override
780 public String toString() {
781 return resourceName;
782 }
783 }
784
785 /**
786 * Activity Action: Display an activity chooser, allowing the user to pick
787 * what they want to before proceeding. This can be used as an alternative
788 * to the standard activity picker that is displayed by the system when
789 * you try to start an activity with multiple possible matches, with these
790 * differences in behavior:
791 * <ul>
792 * <li>You can specify the title that will appear in the activity chooser.
793 * <li>The user does not have the option to make one of the matching
794 * activities a preferred activity, and all possible activities will
795 * always be shown even if one of them is currently marked as the
796 * preferred activity.
797 * </ul>
798 * <p>
799 * This action should be used when the user will naturally expect to
800 * select an activity in order to proceed. An example if when not to use
801 * it is when the user clicks on a "mailto:" link. They would naturally
802 * expect to go directly to their mail app, so startActivity() should be
803 * called directly: it will
804 * either launch the current preferred app, or put up a dialog allowing the
805 * user to pick an app to use and optionally marking that as preferred.
806 * <p>
807 * In contrast, if the user is selecting a menu item to send a picture
808 * they are viewing to someone else, there are many different things they
809 * may want to do at this point: send it through e-mail, upload it to a
810 * web service, etc. In this case the CHOOSER action should be used, to
811 * always present to the user a list of the things they can do, with a
812 * nice title given by the caller such as "Send this photo with:".
813 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700814 * If you need to grant URI permissions through a chooser, you must specify
815 * the permissions to be granted on the ACTION_CHOOSER Intent
816 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
817 * {@link #setClipData} to specify the URIs to be granted as well as
818 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
819 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
820 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700821 * As a convenience, an Intent of this form can be created with the
822 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700824 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700825 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
826 * and can optionally have a {@link #EXTRA_TITLE} field containing the
827 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700828 * <p>
829 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700830 */
831 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
832 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
833
834 /**
835 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
836 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700837 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
838 * target intent, also optionally supplying a title. If the target
839 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
840 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
841 * set in the returned chooser intent, with its ClipData set appropriately:
842 * either a direct reflection of {@link #getClipData()} if that is non-null,
843 * or a new ClipData build from {@link #getData()}.
844 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700845 * @param target The Intent that the user will be selecting an activity
846 * to perform.
847 * @param title Optional title that will be displayed in the chooser.
848 * @return Return a new Intent object that you can hand to
849 * {@link Context#startActivity(Intent) Context.startActivity()} and
850 * related methods.
851 */
852 public static Intent createChooser(Intent target, CharSequence title) {
853 Intent intent = new Intent(ACTION_CHOOSER);
854 intent.putExtra(EXTRA_INTENT, target);
855 if (title != null) {
856 intent.putExtra(EXTRA_TITLE, title);
857 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700858
859 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700860 int permFlags = target.getFlags()
861 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
862 if (permFlags != 0) {
863 ClipData targetClipData = target.getClipData();
864 if (targetClipData == null && target.getData() != null) {
865 ClipData.Item item = new ClipData.Item(target.getData());
866 String[] mimeTypes;
867 if (target.getType() != null) {
868 mimeTypes = new String[] { target.getType() };
869 } else {
870 mimeTypes = new String[] { };
871 }
872 targetClipData = new ClipData(null, mimeTypes, item);
873 }
874 if (targetClipData != null) {
875 intent.setClipData(targetClipData);
876 intent.addFlags(permFlags);
877 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700878 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700879
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700880 return intent;
881 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700882
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 /**
884 * Activity Action: Allow the user to select a particular kind of data and
885 * return it. This is different than {@link #ACTION_PICK} in that here we
886 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800887 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700888 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900889 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700890 * etc.
891 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900892 * 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 -0700893 * of data, such as a person contact, you set the MIME type to the kind of
894 * data you want and launch it with {@link Context#startActivity(Intent)}.
895 * The system will then launch the best application to select that kind
896 * of data for you.
897 * <p>
898 * You may also be interested in any of a set of types of content the user
899 * can pick. For example, an e-mail application that wants to allow the
900 * user to add an attachment to an e-mail message can use this action to
901 * bring up a list of all of the types of content the user can attach.
902 * <p>
903 * In this case, you should wrap the GET_CONTENT intent with a chooser
904 * (through {@link #createChooser}), which will give the proper interface
905 * for the user to pick how to send your data and allow you to specify
906 * a prompt indicating what they are doing. You will usually specify a
907 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
908 * broad range of content types the user can select from.
909 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900910 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700911 * only pick from data that can be represented as a stream. This is
912 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
913 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800914 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900915 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800916 * is locally available on the device. For example, if this extra is set
917 * to true then an image picker should not show any pictures that are available
918 * from a remote server but not already on the local device (thus requiring
919 * they be downloaded when opened).
920 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800921 * If the caller can handle multiple returned items (the user performing
922 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
923 * to indicate this.
924 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700925 * Input: {@link #getType} is the desired MIME type to retrieve. Note
926 * that no URI is supplied in the intent, as there are no constraints on
927 * where the returned data originally comes from. You may also include the
928 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800929 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800930 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
931 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700932 * <p>
933 * Output: The URI of the item that was picked. This must be a content:
934 * URI so that any receiver can access it.
935 */
936 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
937 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
938 /**
939 * Activity Action: Dial a number as specified by the data. This shows a
940 * UI with the number being dialed, allowing the user to explicitly
941 * initiate the call.
942 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
943 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
944 * number.
945 * <p>Output: nothing.
946 */
947 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
948 public static final String ACTION_DIAL = "android.intent.action.DIAL";
949 /**
950 * Activity Action: Perform a call to someone specified by the data.
951 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
952 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
953 * number.
954 * <p>Output: nothing.
955 *
956 * <p>Note: there will be restrictions on which applications can initiate a
957 * call; most applications should use the {@link #ACTION_DIAL}.
958 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
959 * numbers. Applications can <strong>dial</strong> emergency numbers using
960 * {@link #ACTION_DIAL}, however.
961 */
962 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
963 public static final String ACTION_CALL = "android.intent.action.CALL";
964 /**
965 * Activity Action: Perform a call to an emergency number specified by the
966 * data.
967 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
968 * tel: URI of an explicit phone number.
969 * <p>Output: nothing.
970 * @hide
971 */
972 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
973 /**
974 * Activity action: Perform a call to any number (emergency or not)
975 * specified by the data.
976 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
977 * tel: URI of an explicit phone number.
978 * <p>Output: nothing.
979 * @hide
980 */
981 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
982 /**
983 * Activity Action: Send a message to someone specified by the data.
984 * <p>Input: {@link #getData} is URI describing the target.
985 * <p>Output: nothing.
986 */
987 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
988 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
989 /**
990 * Activity Action: Deliver some data to someone else. Who the data is
991 * being delivered to is not specified; it is up to the receiver of this
992 * action to ask the user where the data should be sent.
993 * <p>
994 * When launching a SEND intent, you should usually wrap it in a chooser
995 * (through {@link #createChooser}), which will give the proper interface
996 * for the user to pick how to send your data and allow you to specify
997 * a prompt indicating what they are doing.
998 * <p>
999 * Input: {@link #getType} is the MIME type of the data being sent.
1000 * get*Extra can have either a {@link #EXTRA_TEXT}
1001 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1002 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1003 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1004 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001005 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1006 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1007 * your text with HTML formatting.
1008 * <p>
1009 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1010 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1011 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1012 * content: URIs and other advanced features of {@link ClipData}. If
1013 * using this approach, you still must supply the same data through the
1014 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1015 * for compatibility with old applications. If you don't set a ClipData,
1016 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 * <p>
1018 * Optional standard extras, which may be interpreted by some recipients as
1019 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1020 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1021 * <p>
1022 * Output: nothing.
1023 */
1024 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1025 public static final String ACTION_SEND = "android.intent.action.SEND";
1026 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001027 * Activity Action: Deliver multiple data to someone else.
1028 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001029 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * <p>
1031 * Input: {@link #getType} is the MIME type of the data being sent.
1032 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001033 * #EXTRA_STREAM} field, containing the data to be sent. If using
1034 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1035 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001036 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001037 * Multiple types are supported, and receivers should handle mixed types
1038 * whenever possible. The right way for the receiver to check them is to
1039 * use the content resolver on each URI. The intent sender should try to
1040 * put the most concrete mime type in the intent type, but it can fall
1041 * back to {@literal <type>/*} or {@literal *}/* as needed.
1042 * <p>
1043 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1044 * be image/jpg, but if you are sending image/jpg and image/png, then the
1045 * intent's type should be image/*.
1046 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001047 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1048 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1049 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1050 * content: URIs and other advanced features of {@link ClipData}. If
1051 * using this approach, you still must supply the same data through the
1052 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1053 * for compatibility with old applications. If you don't set a ClipData,
1054 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1055 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001056 * Optional standard extras, which may be interpreted by some recipients as
1057 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1058 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1059 * <p>
1060 * Output: nothing.
1061 */
1062 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1063 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1064 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001065 * Activity Action: Handle an incoming phone call.
1066 * <p>Input: nothing.
1067 * <p>Output: nothing.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1071 /**
1072 * Activity Action: Insert an empty item into the given container.
1073 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1074 * in which to place the data.
1075 * <p>Output: URI of the new data that was created.
1076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1079 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001080 * Activity Action: Create a new item in the given container, initializing it
1081 * from the current contents of the clipboard.
1082 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1083 * in which to place the data.
1084 * <p>Output: URI of the new data that was created.
1085 */
1086 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1087 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1088 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001089 * Activity Action: Delete the given data from its container.
1090 * <p>Input: {@link #getData} is URI of data to be deleted.
1091 * <p>Output: nothing.
1092 */
1093 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1094 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1095 /**
1096 * Activity Action: Run the data, whatever that means.
1097 * <p>Input: ? (Note: this is currently specific to the test harness.)
1098 * <p>Output: nothing.
1099 */
1100 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1101 public static final String ACTION_RUN = "android.intent.action.RUN";
1102 /**
1103 * Activity Action: Perform a data synchronization.
1104 * <p>Input: ?
1105 * <p>Output: ?
1106 */
1107 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1108 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1109 /**
1110 * Activity Action: Pick an activity given an intent, returning the class
1111 * selected.
1112 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1113 * used with {@link PackageManager#queryIntentActivities} to determine the
1114 * set of activities from which to pick.
1115 * <p>Output: Class name of the activity that was selected.
1116 */
1117 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1118 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1119 /**
1120 * Activity Action: Perform a search.
1121 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1122 * is the text to search for. If empty, simply
1123 * enter your search results Activity with the search UI activated.
1124 * <p>Output: nothing.
1125 */
1126 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1127 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1128 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001129 * Activity Action: Start the platform-defined tutorial
1130 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1131 * is the text to search for. If empty, simply
1132 * enter your search results Activity with the search UI activated.
1133 * <p>Output: nothing.
1134 */
1135 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1136 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1137 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001138 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001139 * <p>
1140 * Input: {@link android.app.SearchManager#QUERY
1141 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1142 * a url starts with http or https, the site will be opened. If it is plain
1143 * text, Google search will be applied.
1144 * <p>
1145 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001149
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001150 /**
Jim Miller07994402012-05-02 14:22:27 -07001151 * Activity Action: Perform assist action.
1152 * <p>
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001153 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1154 * additional optional contextual information about where the user was when they requested
1155 * the assist.
Jim Miller07994402012-05-02 14:22:27 -07001156 * Output: nothing.
1157 */
1158 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1159 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001160
1161 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001162 * Activity Action: Perform voice assist action.
1163 * <p>
1164 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1165 * additional optional contextual information about where the user was when they requested
1166 * the voice assist.
1167 * Output: nothing.
1168 */
1169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1170 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1171
1172 /**
1173 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1174 * containing the name of the current foreground application package at the time
1175 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001176 */
1177 public static final String EXTRA_ASSIST_PACKAGE
1178 = "android.intent.extra.ASSIST_PACKAGE";
1179
1180 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001181 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1182 * containing additional contextual information supplied by the current
1183 * foreground app at the time of the assist request. This is a {@link Bundle} of
1184 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001185 */
1186 public static final String EXTRA_ASSIST_CONTEXT
1187 = "android.intent.extra.ASSIST_CONTEXT";
1188
Jim Miller07994402012-05-02 14:22:27 -07001189 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001190 * Activity Action: List all available applications
1191 * <p>Input: Nothing.
1192 * <p>Output: nothing.
1193 */
1194 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1195 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1196 /**
1197 * Activity Action: Show settings for choosing wallpaper
1198 * <p>Input: Nothing.
1199 * <p>Output: Nothing.
1200 */
1201 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1202 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1203
1204 /**
1205 * Activity Action: Show activity for reporting a bug.
1206 * <p>Input: Nothing.
1207 * <p>Output: Nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1211
1212 /**
1213 * Activity Action: Main entry point for factory tests. Only used when
1214 * the device is booting in factory test node. The implementing package
1215 * must be installed in the system image.
1216 * <p>Input: nothing
1217 * <p>Output: nothing
1218 */
1219 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1220
1221 /**
1222 * Activity Action: The user pressed the "call" button to go to the dialer
1223 * or other appropriate UI for placing a call.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1229
1230 /**
1231 * Activity Action: Start Voice Command.
1232 * <p>Input: Nothing.
1233 * <p>Output: Nothing.
1234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001237
1238 /**
1239 * Activity Action: Start action associated with long pressing on the
1240 * search key.
1241 * <p>Input: Nothing.
1242 * <p>Output: Nothing.
1243 */
1244 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1245 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001246
Jacek Surazski86b6c532009-05-13 14:38:28 +02001247 /**
1248 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1249 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001250 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001251 * <p>Input: No data is specified. The bug report is passed in using
1252 * an {@link #EXTRA_BUG_REPORT} field.
1253 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 *
1255 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001256 */
1257 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1258 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001259
1260 /**
1261 * Activity Action: Show power usage information to the user.
1262 * <p>Input: Nothing.
1263 * <p>Output: Nothing.
1264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001267
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001268 /**
1269 * Activity Action: Setup wizard to launch after a platform update. This
1270 * activity should have a string meta-data field associated with it,
1271 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1272 * the platform for setup. The activity will be launched only if
1273 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1274 * same value.
1275 * <p>Input: Nothing.
1276 * <p>Output: Nothing.
1277 * @hide
1278 */
1279 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1280 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001281
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001282 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001283 * Activity Action: Show settings for managing network data usage of a
1284 * specific application. Applications should define an activity that offers
1285 * options to control data usage.
1286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_MANAGE_NETWORK_USAGE =
1289 "android.intent.action.MANAGE_NETWORK_USAGE";
1290
1291 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001292 * Activity Action: Launch application installer.
1293 * <p>
1294 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001295 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1296 * you can also use "package:<package-name>" to install an application for the
1297 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001298 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1299 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1300 * <p>
1301 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1302 * succeeded.
1303 *
1304 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1305 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1306 * @see #EXTRA_RETURN_RESULT
1307 */
1308 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1309 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1310
1311 /**
1312 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1313 * package. Specifies the installer package name; this package will receive the
1314 * {@link #ACTION_APP_ERROR} intent.
1315 */
1316 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1317 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1318
1319 /**
1320 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1321 * package. Specifies that the application being installed should not be
1322 * treated as coming from an unknown source, but as coming from the app
1323 * invoking the Intent. For this to work you must start the installer with
1324 * startActivityForResult().
1325 */
1326 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1327 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1328
1329 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001330 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1331 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001332 * data field originated from.
1333 */
rich cannings706e8ba2012-08-20 13:20:14 -07001334 public static final String EXTRA_ORIGINATING_URI
1335 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001336
1337 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001338 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1339 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1340 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001341 */
1342 public static final String EXTRA_REFERRER
1343 = "android.intent.extra.REFERRER";
1344
1345 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001346 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1347 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1348 * @hide
1349 */
1350 public static final String EXTRA_ORIGINATING_UID
1351 = "android.intent.extra.ORIGINATING_UID";
1352
1353 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001354 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1355 * package. Tells the installer UI to skip the confirmation with the user
1356 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001357 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1358 * will no longer show an interstitial message about updating existing
1359 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001360 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001361 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001362 public static final String EXTRA_ALLOW_REPLACE
1363 = "android.intent.extra.ALLOW_REPLACE";
1364
1365 /**
1366 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1367 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1368 * return to the application the result code of the install/uninstall. The returned result
1369 * code will be {@link android.app.Activity#RESULT_OK} on success or
1370 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1371 */
1372 public static final String EXTRA_RETURN_RESULT
1373 = "android.intent.extra.RETURN_RESULT";
1374
1375 /**
1376 * Package manager install result code. @hide because result codes are not
1377 * yet ready to be exposed.
1378 */
1379 public static final String EXTRA_INSTALL_RESULT
1380 = "android.intent.extra.INSTALL_RESULT";
1381
1382 /**
1383 * Activity Action: Launch application uninstaller.
1384 * <p>
1385 * Input: The data must be a package: URI whose scheme specific part is
1386 * the package name of the current installed package to be uninstalled.
1387 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1388 * <p>
1389 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1390 * succeeded.
1391 */
1392 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1393 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1394
1395 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001396 * Specify whether the package should be uninstalled for all users.
1397 * @hide because these should not be part of normal application flow.
1398 */
1399 public static final String EXTRA_UNINSTALL_ALL_USERS
1400 = "android.intent.extra.UNINSTALL_ALL_USERS";
1401
1402 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001403 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1404 * describing the last run version of the platform that was setup.
1405 * @hide
1406 */
1407 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1408
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001409 // ---------------------------------------------------------------------
1410 // ---------------------------------------------------------------------
1411 // Standard intent broadcast actions (see action variable).
1412
1413 /**
1414 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001415 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001416 * <p class="note">This is a protected intent that can only be sent
1417 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001418 */
1419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1420 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1421 /**
1422 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001423 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001424 * <p class="note">This is a protected intent that can only be sent
1425 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001426 */
1427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1428 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001429
1430 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001431 * Broadcast Action: Sent after the system stops dreaming.
1432 *
1433 * <p class="note">This is a protected intent that can only be sent by the system.
1434 * It is only sent to registered receivers.</p>
1435 */
1436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1437 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1438
1439 /**
1440 * Broadcast Action: Sent after the system starts dreaming.
1441 *
1442 * <p class="note">This is a protected intent that can only be sent by the system.
1443 * It is only sent to registered receivers.</p>
1444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1446 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1447
1448 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001449 * 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 -07001450 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001451 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001452 * <p class="note">This is a protected intent that can only be sent
1453 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001454 */
1455 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001456 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001457
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001458 /**
1459 * Broadcast Action: The current time has changed. Sent every
1460 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001461 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001462 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1463 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001464 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001465 * <p class="note">This is a protected intent that can only be sent
1466 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001467 */
1468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1469 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1470 /**
1471 * Broadcast Action: The time was set.
1472 */
1473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1474 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1475 /**
1476 * Broadcast Action: The date has changed.
1477 */
1478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1479 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1480 /**
1481 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1482 * <ul>
1483 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1484 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001485 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001486 * <p class="note">This is a protected intent that can only be sent
1487 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001488 */
1489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1490 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1491 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001492 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1493 * DNS entries should be tossed.
1494 * @hide
1495 */
1496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1497 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1498 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001499 * Alarm Changed Action: This is broadcast when the AlarmClock
1500 * application's alarm is set or unset. It is used by the
1501 * AlarmClock application and the StatusBar service.
1502 * @hide
1503 */
1504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1505 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1506 /**
1507 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1508 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1509 * @hide
1510 */
1511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1512 public static final String ACTION_SYNC_STATE_CHANGED
1513 = "android.intent.action.SYNC_STATE_CHANGED";
1514 /**
1515 * Broadcast Action: This is broadcast once, after the system has finished
1516 * booting. It can be used to perform application-specific initialization,
1517 * such as installing alarms. You must hold the
1518 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1519 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001520 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001521 * <p class="note">This is a protected intent that can only be sent
1522 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001523 */
1524 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1525 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1526 /**
1527 * Broadcast Action: This is broadcast when a user action should request a
1528 * temporary system dialog to dismiss. Some examples of temporary system
1529 * dialogs are the notification window-shade and the recent tasks dialog.
1530 */
1531 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1532 /**
1533 * Broadcast Action: Trigger the download and eventual installation
1534 * of a package.
1535 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001536 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001537 * <p class="note">This is a protected intent that can only be sent
1538 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001539 *
1540 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001541 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001542 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001543 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1544 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1545 /**
1546 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001547 * device. The data contains the name of the package. Note that the
1548 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001549 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001550 * <ul>
1551 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1552 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1553 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1554 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001555 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001556 * <p class="note">This is a protected intent that can only be sent
1557 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001558 */
1559 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1560 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1561 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001562 * Broadcast Action: A new version of an application package has been
1563 * installed, replacing an existing version that was previously installed.
1564 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001565 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001566 * <ul>
1567 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1568 * </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 Projectc2ad2412009-03-19 23:08:54 -07001572 */
1573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1574 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1575 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001576 * Broadcast Action: A new version of your application has been installed
1577 * over an existing one. This is only sent to the application that was
1578 * replaced. It does not contain any additional data; to receive it, just
1579 * use an intent filter for this action.
1580 *
1581 * <p class="note">This is a protected intent that can only be sent
1582 * by the system.
1583 */
1584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1585 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1586 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001587 * Broadcast Action: An existing application package has been removed from
1588 * the device. The data contains the name of the package. The package
1589 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001590 * <ul>
1591 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1592 * to the package.
1593 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1594 * application -- data and code -- is being removed.
1595 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1596 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1597 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001598 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001599 * <p class="note">This is a protected intent that can only be sent
1600 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001601 */
1602 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1603 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1604 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001605 * Broadcast Action: An existing application package has been completely
1606 * removed from the device. The data contains the name of the package.
1607 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1608 * {@link #EXTRA_DATA_REMOVED} is true and
1609 * {@link #EXTRA_REPLACING} is false of that broadcast.
1610 *
1611 * <ul>
1612 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1613 * to the package.
1614 * </ul>
1615 *
1616 * <p class="note">This is a protected intent that can only be sent
1617 * by the system.
1618 */
1619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1620 public static final String ACTION_PACKAGE_FULLY_REMOVED
1621 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1622 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001623 * Broadcast Action: An existing application package has been changed (e.g.
1624 * a component has been enabled or disabled). The data contains the name of
1625 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001626 * <ul>
1627 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001628 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001629 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001630 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1631 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001632 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001633 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001634 * <p class="note">This is a protected intent that can only be sent
1635 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1639 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001640 * @hide
1641 * Broadcast Action: Ask system services if there is any reason to
1642 * restart the given package. The data contains the name of the
1643 * package.
1644 * <ul>
1645 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1646 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1647 * </ul>
1648 *
1649 * <p class="note">This is a protected intent that can only be sent
1650 * by the system.
1651 */
1652 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1653 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1654 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001655 * Broadcast Action: The user has restarted a package, and all of its
1656 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001657 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001658 * be removed. Note that the restarted package does <em>not</em>
1659 * receive this broadcast.
1660 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001661 * <ul>
1662 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1663 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001664 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001665 * <p class="note">This is a protected intent that can only be sent
1666 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001667 */
1668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1669 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1670 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001671 * Broadcast Action: The user has cleared the data of a package. This should
1672 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001673 * its persistent data is erased and this broadcast sent.
1674 * Note that the cleared package does <em>not</em>
1675 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001676 * <ul>
1677 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1678 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001679 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001680 * <p class="note">This is a protected intent that can only be sent
1681 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 */
1683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1684 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001686 * Broadcast Action: A user ID has been removed from the system. The user
1687 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001688 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001689 * <p class="note">This is a protected intent that can only be sent
1690 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001691 */
1692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1693 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001694
1695 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001696 * Broadcast Action: Sent to the installer package of an application
1697 * when that application is first launched (that is the first time it
1698 * is moved out of the stopped state). The data contains the name of the package.
1699 *
1700 * <p class="note">This is a protected intent that can only be sent
1701 * by the system.
1702 */
1703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1704 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1705
1706 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001707 * Broadcast Action: Sent to the system package verifier when a package
1708 * needs to be verified. The data contains the package URI.
1709 * <p class="note">
1710 * This is a protected intent that can only be sent by the system.
1711 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001712 */
1713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1714 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1715
1716 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001717 * Broadcast Action: Sent to the system package verifier when a package is
1718 * verified. The data contains the package URI.
1719 * <p class="note">
1720 * This is a protected intent that can only be sent by the system.
1721 */
1722 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1723 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1724
1725 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001726 * Broadcast Action: Resources for a set of packages (which were
1727 * previously unavailable) are currently
1728 * available since the media on which they exist is available.
1729 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1730 * list of packages whose availability changed.
1731 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1732 * list of uids of packages whose availability changed.
1733 * Note that the
1734 * packages in this list do <em>not</em> receive this broadcast.
1735 * The specified set of packages are now available on the system.
1736 * <p>Includes the following extras:
1737 * <ul>
1738 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1739 * whose resources(were previously unavailable) are currently available.
1740 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1741 * packages whose resources(were previously unavailable)
1742 * are currently available.
1743 * </ul>
1744 *
1745 * <p class="note">This is a protected intent that can only be sent
1746 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001749 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1750 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001751
1752 /**
1753 * Broadcast Action: Resources for a set of packages are currently
1754 * unavailable since the media on which they exist is unavailable.
1755 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1756 * list of packages whose availability changed.
1757 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1758 * list of uids of packages whose availability changed.
1759 * The specified set of packages can no longer be
1760 * launched and are practically unavailable on the system.
1761 * <p>Inclues the following extras:
1762 * <ul>
1763 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1764 * whose resources are no longer available.
1765 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1766 * whose resources are no longer available.
1767 * </ul>
1768 *
1769 * <p class="note">This is a protected intent that can only be sent
1770 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001773 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001774 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001775
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001776 /**
1777 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001778 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001779 * This should <em>only</em> be used to determine when the wallpaper
1780 * has changed to show the new wallpaper to the user. You should certainly
1781 * never, in response to this, change the wallpaper or other attributes of
1782 * it such as the suggested size. That would be crazy, right? You'd cause
1783 * all kinds of loops, especially if other apps are doing similar things,
1784 * right? Of course. So please don't do this.
1785 *
1786 * @deprecated Modern applications should use
1787 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1788 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1789 * shown behind their UI, rather than watching for this broadcast and
1790 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001791 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001792 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1794 /**
1795 * Broadcast Action: The current device {@link android.content.res.Configuration}
1796 * (orientation, locale, etc) has changed. When such a change happens, the
1797 * UIs (view hierarchy) will need to be rebuilt based on this new
1798 * information; for the most part, applications don't need to worry about
1799 * this, because the system will take care of stopping and restarting the
1800 * application to make sure it sees the new changes. Some system code that
1801 * can not be restarted will need to watch for this action and handle it
1802 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001803 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001804 * <p class="note">
1805 * You can <em>not</em> receive this through components declared
1806 * in manifests, only by explicitly registering for it with
1807 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1808 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001809 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001810 * <p class="note">This is a protected intent that can only be sent
1811 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001812 *
1813 * @see android.content.res.Configuration
1814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1817 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001818 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001819 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001820 * <p class="note">This is a protected intent that can only be sent
1821 * by the system.
1822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1824 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1825 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001826 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1827 * charging state, level, and other information about the battery.
1828 * See {@link android.os.BatteryManager} for documentation on the
1829 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001830 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001831 * <p class="note">
1832 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001833 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001834 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001835 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1836 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1837 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1838 * broadcasts that are sent and can be received through manifest
1839 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001840 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001841 * <p class="note">This is a protected intent that can only be sent
1842 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001843 */
1844 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1845 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1846 /**
1847 * Broadcast Action: Indicates low battery condition on the device.
1848 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001849 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001850 * <p class="note">This is a protected intent that can only be sent
1851 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001852 */
1853 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1854 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1855 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001856 * Broadcast Action: Indicates the battery is now okay after being low.
1857 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1858 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001859 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001860 * <p class="note">This is a protected intent that can only be sent
1861 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001862 */
1863 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1864 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1865 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001866 * Broadcast Action: External power has been connected to the device.
1867 * This is intended for applications that wish to register specifically to this notification.
1868 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1869 * stay active to receive this notification. This action can be used to implement actions
1870 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001871 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001872 * <p class="note">This is a protected intent that can only be sent
1873 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001876 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001877 /**
1878 * Broadcast Action: External power has been removed from the device.
1879 * This is intended for applications that wish to register specifically to this notification.
1880 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1881 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001882 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001883 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001884 * <p class="note">This is a protected intent that can only be sent
1885 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001886 */
1887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001888 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001889 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001890 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001891 * Broadcast Action: Device is shutting down.
1892 * This is broadcast when the device is being shut down (completely turned
1893 * off, not sleeping). Once the broadcast is complete, the final shutdown
1894 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001895 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001896 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001897 * <p class="note">This is a protected intent that can only be sent
1898 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001899 */
1900 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001901 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001902 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001903 * Activity Action: Start this activity to request system shutdown.
1904 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1905 * to request confirmation from the user before shutting down.
1906 *
1907 * <p class="note">This is a protected intent that can only be sent
1908 * by the system.
1909 *
1910 * {@hide}
1911 */
1912 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1913 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001914 * Broadcast Action: A sticky broadcast that indicates low memory
1915 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001916 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001917 * <p class="note">This is a protected intent that can only be sent
1918 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1922 /**
1923 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001924 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001925 * <p class="note">This is a protected intent that can only be sent
1926 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001927 */
1928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1929 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1930 /**
Jake Hambybb371632010-08-23 18:16:48 -07001931 * Broadcast Action: A sticky broadcast that indicates a memory full
1932 * condition on the device. This is intended for activities that want
1933 * to be able to fill the data partition completely, leaving only
1934 * enough free space to prevent system-wide SQLite failures.
1935 *
1936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
1938 *
1939 * {@hide}
1940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1943 /**
1944 * Broadcast Action: Indicates memory full condition on the device
1945 * no longer exists.
1946 *
1947 * <p class="note">This is a protected intent that can only be sent
1948 * by the system.
1949 *
1950 * {@hide}
1951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1954 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001955 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1956 * and package management should be started.
1957 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1958 * notification.
1959 */
1960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1961 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1962 /**
1963 * Broadcast Action: The device has entered USB Mass Storage mode.
1964 * This is used mainly for the USB Settings panel.
1965 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1966 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001967 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001968 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001969 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001970 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1971
1972 /**
1973 * Broadcast Action: The device has exited USB Mass Storage mode.
1974 * This is used mainly for the USB Settings panel.
1975 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1976 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001977 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001978 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001979 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1981
1982 /**
1983 * Broadcast Action: External media has been removed.
1984 * The path to the mount point for the removed media is contained in the Intent.mData field.
1985 */
1986 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1987 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1988
1989 /**
1990 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001991 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1995
1996 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001997 * Broadcast Action: External media is present, and being disk-checked
1998 * 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 -08001999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2002
2003 /**
2004 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2005 * 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 -08002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2009
2010 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002011 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002012 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002013 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2014 * media was mounted read only.
2015 */
2016 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2017 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2018
2019 /**
2020 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002021 * 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 -07002022 */
2023 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2024 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2025
2026 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002027 * Broadcast Action: External media is no longer being shared via USB mass storage.
2028 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2029 *
2030 * @hide
2031 */
2032 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2033
2034 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2036 * The path to the mount point for the removed media is contained in the Intent.mData field.
2037 */
2038 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2039 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2040
2041 /**
2042 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002043 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2047
2048 /**
2049 * Broadcast Action: User has expressed the desire to remove the external storage media.
2050 * Applications should close all files they have open within the mount point when they receive this intent.
2051 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2055
2056 /**
2057 * Broadcast Action: The media scanner has started scanning a directory.
2058 * The path to the directory being scanned is contained in the Intent.mData field.
2059 */
2060 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2061 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2062
2063 /**
2064 * Broadcast Action: The media scanner has finished scanning a directory.
2065 * The path to the scanned directory is contained in the Intent.mData field.
2066 */
2067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2068 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2069
2070 /**
2071 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2072 * The path to the file is contained in the Intent.mData field.
2073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2076
2077 /**
2078 * Broadcast Action: The "Media Button" was pressed. Includes a single
2079 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2080 * caused the broadcast.
2081 */
2082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2083 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2084
2085 /**
2086 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2087 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2088 * caused the broadcast.
2089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2092
2093 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2094 // location; they are not general-purpose actions.
2095
2096 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002097 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2101 "android.intent.action.GTALK_CONNECTED";
2102
2103 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002104 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2108 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002109
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002110 /**
2111 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002112 */
2113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_INPUT_METHOD_CHANGED =
2115 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116
2117 /**
2118 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2119 * more radios have been turned off or on. The intent will have the following extra value:</p>
2120 * <ul>
2121 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2122 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2123 * turned off</li>
2124 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002125 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002126 * <p class="note">This is a protected intent that can only be sent
2127 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2131
2132 /**
2133 * Broadcast Action: Some content providers have parts of their namespace
2134 * where they publish new events or items that the user may be especially
2135 * interested in. For these things, they may broadcast this action when the
2136 * set of interesting items change.
2137 *
2138 * For example, GmailProvider sends this notification when the set of unread
2139 * mail in the inbox changes.
2140 *
2141 * <p>The data of the intent identifies which part of which provider
2142 * changed. When queried through the content resolver, the data URI will
2143 * return the data set in question.
2144 *
2145 * <p>The intent will have the following extra values:
2146 * <ul>
2147 * <li><em>count</em> - The number of items in the data set. This is the
2148 * same as the number of items in the cursor returned by querying the
2149 * data URI. </li>
2150 * </ul>
2151 *
2152 * This intent will be sent at boot (if the count is non-zero) and when the
2153 * data set changes. It is possible for the data set to change without the
2154 * count changing (for example, if a new unread message arrives in the same
2155 * sync operation in which a message is archived). The phone should still
2156 * ring/vibrate/etc as normal in this case.
2157 */
2158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2159 public static final String ACTION_PROVIDER_CHANGED =
2160 "android.intent.action.PROVIDER_CHANGED";
2161
2162 /**
2163 * Broadcast Action: Wired Headset plugged in or unplugged.
2164 *
2165 * <p>The intent will have the following extra values:
2166 * <ul>
2167 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2168 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002169 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002170 * </ul>
2171 * </ul>
2172 */
2173 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2174 public static final String ACTION_HEADSET_PLUG =
2175 "android.intent.action.HEADSET_PLUG";
2176
2177 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002178 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2179 *
2180 * <p>The intent will have the following extra values:
2181 * <ul>
2182 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2183 * <li><em>name</em> - Headset type, human readable string </li>
2184 * </ul>
2185 * </ul>
2186 * @hide
2187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002189 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2190 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002191
2192 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002193 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002194 *
2195 * <p>The intent will have the following extra values:
2196 * <ul>
2197 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2198 * <li><em>name</em> - Headset type, human readable string </li>
2199 * </ul>
2200 * </ul>
2201 * @hide
2202 */
2203 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002204 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2205 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002206
2207 /**
2208 * Broadcast Action: A HMDI cable was plugged or unplugged
2209 *
2210 * <p>The intent will have the following extra values:
2211 * <ul>
2212 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2213 * <li><em>name</em> - HDMI cable, human readable string </li>
2214 * </ul>
2215 * </ul>
2216 * @hide
2217 */
2218 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2219 public static final String ACTION_HDMI_AUDIO_PLUG =
2220 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002221
2222 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002223 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2224 *
2225 * <p>The intent will have the following extra values:
2226 * <ul>
2227 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2228 * <li><em>card</em> - ALSA card number (integer) </li>
2229 * <li><em>device</em> - ALSA device number (integer) </li>
2230 * </ul>
2231 * </ul>
2232 * @hide
2233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2236 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2237
2238 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002239 * Broadcast Action: A USB audio device was plugged in or unplugged.
2240 *
2241 * <p>The intent will have the following extra values:
2242 * <ul>
2243 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2244 * <li><em>card</em> - ALSA card number (integer) </li>
2245 * <li><em>device</em> - ALSA device number (integer) </li>
2246 * </ul>
2247 * </ul>
2248 * @hide
2249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2251 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2252 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2253
2254 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002255 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2256 * <ul>
2257 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2258 * </ul>
2259 *
2260 * <p class="note">This is a protected intent that can only be sent
2261 * by the system.
2262 *
2263 * @hide
2264 */
2265 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2267 = "android.intent.action.ADVANCED_SETTINGS";
2268
2269 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002270 * Broadcast Action: An outgoing call is about to be placed.
2271 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002272 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002273 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002274 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 * the phone number originally intended to be dialed.</li>
2276 * </ul>
2277 * <p>Once the broadcast is finished, the resultData is used as the actual
2278 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002279 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002280 * outgoing call in turn: for example, a parental control application
2281 * might verify that the user is authorized to place the call at that
2282 * time, then a number-rewriting application might add an area code if
2283 * one was not specified.</p>
2284 * <p>For consistency, any receiver whose purpose is to prohibit phone
2285 * calls should have a priority of 0, to ensure it will see the final
2286 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002287 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288 * should have a positive priority.
2289 * Negative priorities are reserved for the system for this broadcast;
2290 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002291 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2292 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002293 * <p>Emergency calls cannot be intercepted using this mechanism, and
2294 * other calls cannot be modified to call emergency numbers using this
2295 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002296 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2297 * call to use their own service instead. Those apps should first prevent
2298 * the call from being placed by setting resultData to <code>null</code>
2299 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002300 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002301 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2302 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002303 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002304 * <p class="note">This is a protected intent that can only be sent
2305 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002306 */
2307 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2308 public static final String ACTION_NEW_OUTGOING_CALL =
2309 "android.intent.action.NEW_OUTGOING_CALL";
2310
2311 /**
2312 * Broadcast Action: Have the device reboot. This is only for use by
2313 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002314 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002315 * <p class="note">This is a protected intent that can only be sent
2316 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002317 */
2318 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2319 public static final String ACTION_REBOOT =
2320 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002321
Wei Huang97ecc9c2009-05-11 17:44:20 -07002322 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002323 * Broadcast Action: A sticky broadcast for changes in the physical
2324 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002325 *
2326 * <p>The intent will have the following extra values:
2327 * <ul>
2328 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002329 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002330 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002331 * <p>This is intended for monitoring the current physical dock state.
2332 * See {@link android.app.UiModeManager} for the normal API dealing with
2333 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002334 */
2335 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2336 public static final String ACTION_DOCK_EVENT =
2337 "android.intent.action.DOCK_EVENT";
2338
2339 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002340 * Broadcast Action: A broadcast when idle maintenance can be started.
2341 * This means that the user is not interacting with the device and is
2342 * not expected to do so soon. Typical use of the idle maintenance is
2343 * to perform somehow expensive tasks that can be postponed at a moment
2344 * when they will not degrade user experience.
2345 * <p>
2346 * <p class="note">In order to keep the device responsive in case of an
2347 * unexpected user interaction, implementations of a maintenance task
2348 * should be interruptible. In such a scenario a broadcast with action
2349 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2350 * should not do the maintenance work in
2351 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2352 * maintenance service by {@link Context#startService(Intent)}. Also
2353 * you should hold a wake lock while your maintenance service is running
2354 * to prevent the device going to sleep.
2355 * </p>
2356 * <p>
2357 * <p class="note">This is a protected intent that can only be sent by
2358 * the system.
2359 * </p>
2360 *
2361 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002362 *
2363 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002364 */
2365 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2366 public static final String ACTION_IDLE_MAINTENANCE_START =
2367 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2368
2369 /**
2370 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2371 * This means that the user was not interacting with the device as a result
2372 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2373 * was sent and now the user started interacting with the device. Typical
2374 * use of the idle maintenance is to perform somehow expensive tasks that
2375 * can be postponed at a moment when they will not degrade user experience.
2376 * <p>
2377 * <p class="note">In order to keep the device responsive in case of an
2378 * unexpected user interaction, implementations of a maintenance task
2379 * should be interruptible. Hence, on receiving a broadcast with this
2380 * action, the maintenance task should be interrupted as soon as possible.
2381 * In other words, you should not do the maintenance work in
2382 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2383 * maintenance service that was started on receiving of
2384 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2385 * lock you acquired when your maintenance service started.
2386 * </p>
2387 * <p class="note">This is a protected intent that can only be sent
2388 * by the system.
2389 *
2390 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002391 *
2392 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002393 */
2394 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2395 public static final String ACTION_IDLE_MAINTENANCE_END =
2396 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2397
2398 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002399 * Broadcast Action: a remote intent is to be broadcasted.
2400 *
2401 * A remote intent is used for remote RPC between devices. The remote intent
2402 * is serialized and sent from one device to another device. The receiving
2403 * device parses the remote intent and broadcasts it. Note that anyone can
2404 * broadcast a remote intent. However, if the intent receiver of the remote intent
2405 * does not trust intent broadcasts from arbitrary intent senders, it should require
2406 * the sender to hold certain permissions so only trusted sender's broadcast will be
2407 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002408 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002409 */
2410 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002411 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002412
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002413 /**
2414 * Broadcast Action: hook for permforming cleanup after a system update.
2415 *
2416 * The broadcast is sent when the system is booting, before the
2417 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2418 * image. A receiver for this should do its work and then disable itself
2419 * so that it does not get run again at the next boot.
2420 * @hide
2421 */
2422 public static final String ACTION_PRE_BOOT_COMPLETED =
2423 "android.intent.action.PRE_BOOT_COMPLETED";
2424
Amith Yamasani13593602012-03-22 16:16:17 -07002425 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002426 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002427 * on restricted users. The broadcast intent contains an extra
2428 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2429 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2430 * String[] depending on the restriction type.<p/>
2431 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002432 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2433 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2434 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002435 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2436 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002437 * @see RestrictionEntry
2438 */
2439 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2440 "android.intent.action.GET_RESTRICTION_ENTRIES";
2441
2442 /**
Amith Yamasani655d0e22013-06-12 14:19:10 -07002443 * Activity to challenge the user for a PIN that was configured when setting up
2444 * restrictions. Launch the activity using
2445 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2446 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2447 * challenge.<p/>
2448 * Before launching this activity, make sure that there is a PIN in effect, by calling
2449 * {@link android.os.UserManager#hasRestrictionsPin()}.
2450 */
2451 public static final String ACTION_RESTRICTIONS_PIN_CHALLENGE =
2452 "android.intent.action.RESTRICTIONS_PIN_CHALLENGE";
2453
2454 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002455 * Sent the first time a user is starting, to allow system apps to
2456 * perform one time initialization. (This will not be seen by third
2457 * party applications because a newly initialized user does not have any
2458 * third party applications installed for it.) This is sent early in
2459 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002460 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2461 * broadcast, since it is part of a visible user interaction; be as quick
2462 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002463 */
2464 public static final String ACTION_USER_INITIALIZE =
2465 "android.intent.action.USER_INITIALIZE";
2466
2467 /**
2468 * Sent when a user switch is happening, causing the process's user to be
2469 * brought to the foreground. This is only sent to receivers registered
2470 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2471 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002472 * foreground. This is sent as a foreground
2473 * broadcast, since it is part of a visible user interaction; be as quick
2474 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002475 */
2476 public static final String ACTION_USER_FOREGROUND =
2477 "android.intent.action.USER_FOREGROUND";
2478
2479 /**
2480 * Sent when a user switch is happening, causing the process's user to be
2481 * sent to the background. This is only sent to receivers registered
2482 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2483 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002484 * background. This is sent as a foreground
2485 * broadcast, since it is part of a visible user interaction; be as quick
2486 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002487 */
2488 public static final String ACTION_USER_BACKGROUND =
2489 "android.intent.action.USER_BACKGROUND";
2490
2491 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002492 * Broadcast sent to the system when a user is added. Carries an extra
2493 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2494 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002495 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002496 * @hide
2497 */
2498 public static final String ACTION_USER_ADDED =
2499 "android.intent.action.USER_ADDED";
2500
2501 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002502 * Broadcast sent by the system when a user is started. Carries an extra
2503 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002504 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002505 * that has been started. This is sent as a foreground
2506 * broadcast, since it is part of a visible user interaction; be as quick
2507 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002508 * @hide
2509 */
2510 public static final String ACTION_USER_STARTED =
2511 "android.intent.action.USER_STARTED";
2512
2513 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002514 * Broadcast sent when a user is in the process of starting. Carries an extra
2515 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2516 * sent to registered receivers, not manifest receivers. It is sent to all
2517 * users (including the one that is being started). You must hold
2518 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2519 * this broadcast. This is sent as a background broadcast, since
2520 * its result is not part of the primary UX flow; to safely keep track of
2521 * started/stopped state of a user you can use this in conjunction with
2522 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2523 * other user state broadcasts since those are foreground broadcasts so can
2524 * execute in a different order.
2525 * @hide
2526 */
2527 public static final String ACTION_USER_STARTING =
2528 "android.intent.action.USER_STARTING";
2529
2530 /**
2531 * Broadcast sent when a user is going to be stopped. Carries an extra
2532 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2533 * sent to registered receivers, not manifest receivers. It is sent to all
2534 * users (including the one that is being stopped). You must hold
2535 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2536 * this broadcast. The user will not stop until all receivers have
2537 * handled the broadcast. This is sent as a background broadcast, since
2538 * its result is not part of the primary UX flow; to safely keep track of
2539 * started/stopped state of a user you can use this in conjunction with
2540 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2541 * other user state broadcasts since those are foreground broadcasts so can
2542 * execute in a different order.
2543 * @hide
2544 */
2545 public static final String ACTION_USER_STOPPING =
2546 "android.intent.action.USER_STOPPING";
2547
2548 /**
2549 * Broadcast sent to the system when a user is stopped. Carries an extra
2550 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2551 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2552 * specific package. This is only sent to registered receivers, not manifest
2553 * receivers. It is sent to all running users <em>except</em> the one that
2554 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002555 * @hide
2556 */
2557 public static final String ACTION_USER_STOPPED =
2558 "android.intent.action.USER_STOPPED";
2559
2560 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002561 * 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 -07002562 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002563 * one that has been removed. The user will not be completely removed until all receivers have
2564 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002565 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002566 * @hide
2567 */
2568 public static final String ACTION_USER_REMOVED =
2569 "android.intent.action.USER_REMOVED";
2570
2571 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002572 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002573 * the userHandle of the user to become the current one. This is only sent to
2574 * registered receivers, not manifest receivers. It is sent to all running users.
2575 * You must hold
2576 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002577 * @hide
2578 */
2579 public static final String ACTION_USER_SWITCHED =
2580 "android.intent.action.USER_SWITCHED";
2581
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002582 /**
2583 * Broadcast sent to the system when a user's information changes. Carries an extra
2584 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002585 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002586 * @hide
2587 */
2588 public static final String ACTION_USER_INFO_CHANGED =
2589 "android.intent.action.USER_INFO_CHANGED";
2590
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002591 /**
2592 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2593 */
2594 public static final String ACTION_QUICK_CLOCK =
2595 "android.intent.action.QUICK_CLOCK";
2596
Michael Wright0087a142013-02-05 16:29:39 -08002597 /**
2598 * Broadcast Action: This is broadcast when a user action should request the
2599 * brightness setting dialog.
2600 * @hide
2601 */
2602 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2603 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2604
Justin Kohd378ad72013-04-01 12:18:26 -07002605 /**
2606 * Broadcast Action: A global button was pressed. Includes a single
2607 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2608 * caused the broadcast.
2609 * @hide
2610 */
2611 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2612
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002613 /**
2614 * Activity Action: Allow the user to select and open one or more existing
2615 * documents. Both read and write access to the documents will be granted
2616 * until explicitly revoked by the user.
2617 * <p>
2618 * Callers can restrict selection to a specific kind of data, such as
2619 * photos, by setting one or more MIME types in {@link #EXTRA_MIME_TYPES}.
2620 * <p>
2621 * If the caller can handle multiple returned items (the user performing
2622 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE} to
2623 * indicate this.
2624 * <p>
2625 * All returned URIs can be opened as a stream with
2626 * {@link ContentResolver#openInputStream(Uri)}.
2627 * <p>
2628 * Output: The URI of the item that was picked. This must be a content: URI
2629 * so that any receiver can access it.
2630 */
2631 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2632 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2633
2634 /**
2635 * Activity Action: Allow the user to create a new document. Both read and
2636 * write access to the document will be granted until explicitly revoked by
2637 * the user.
2638 * <p>
2639 * Callers can provide a hint document name by setting {@link #EXTRA_TITLE},
2640 * but the user may change this value before creating the file. Callers can
2641 * optionally hint at the MIME type being created by setting
2642 * {@link #setType(String)}.
2643 * <p>
2644 * All returned URIs can be opened as a stream with
2645 * {@link ContentResolver#openOutputStream(Uri)}.
2646 * <p>
2647 * Output: The URI of the item that was created. This must be a content: URI
2648 * so that any receiver can access it.
2649 */
2650 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2651 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2652
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002653 // ---------------------------------------------------------------------
2654 // ---------------------------------------------------------------------
2655 // Standard intent categories (see addCategory()).
2656
2657 /**
2658 * Set if the activity should be an option for the default action
2659 * (center press) to perform on a piece of data. Setting this will
2660 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002661 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002662 * Intent when initiating an action -- it is for use in intent filters
2663 * specified in packages.
2664 */
2665 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2666 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2667 /**
2668 * Activities that can be safely invoked from a browser must support this
2669 * category. For example, if the user is viewing a web page or an e-mail
2670 * and clicks on a link in the text, the Intent generated execute that
2671 * link will require the BROWSABLE category, so that only activities
2672 * supporting this category will be considered as possible actions. By
2673 * supporting this category, you are promising that there is nothing
2674 * damaging (without user intervention) that can happen by invoking any
2675 * matching Intent.
2676 */
2677 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2678 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2679 /**
2680 * Set if the activity should be considered as an alternative action to
2681 * the data the user is currently viewing. See also
2682 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2683 * applies to the selection in a list of items.
2684 *
2685 * <p>Supporting this category means that you would like your activity to be
2686 * displayed in the set of alternative things the user can do, usually as
2687 * part of the current activity's options menu. You will usually want to
2688 * include a specific label in the &lt;intent-filter&gt; of this action
2689 * describing to the user what it does.
2690 *
2691 * <p>The action of IntentFilter with this category is important in that it
2692 * describes the specific action the target will perform. This generally
2693 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2694 * a specific name such as "com.android.camera.action.CROP. Only one
2695 * alternative of any particular action will be shown to the user, so using
2696 * a specific action like this makes sure that your alternative will be
2697 * displayed while also allowing other applications to provide their own
2698 * overrides of that particular action.
2699 */
2700 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2701 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2702 /**
2703 * Set if the activity should be considered as an alternative selection
2704 * action to the data the user has currently selected. This is like
2705 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2706 * of items from which the user can select, giving them alternatives to the
2707 * default action that will be performed on it.
2708 */
2709 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2710 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2711 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002712 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002713 */
2714 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2715 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2716 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002717 * Should be displayed in the top-level launcher.
2718 */
2719 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2720 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2721 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002722 * Provides information about the package it is in; typically used if
2723 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2724 * a front-door to the user without having to be shown in the all apps list.
2725 */
2726 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2727 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2728 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002729 * This is the home activity, that is the first activity that is displayed
2730 * when the device boots.
2731 */
2732 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2733 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2734 /**
2735 * This activity is a preference panel.
2736 */
2737 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2738 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2739 /**
2740 * This activity is a development preference panel.
2741 */
2742 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2743 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2744 /**
2745 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002746 */
2747 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2748 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2749 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002750 * This activity allows the user to browse and download new applications.
2751 */
2752 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2753 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2754 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002755 * This activity may be exercised by the monkey or other automated test tools.
2756 */
2757 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2758 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2759 /**
2760 * To be used as a test (not part of the normal user experience).
2761 */
2762 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2763 /**
2764 * To be used as a unit test (run through the Test Harness).
2765 */
2766 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2767 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002768 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002769 * experience).
2770 */
2771 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2772 /**
2773 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002774 * ContentResolver.openInputStream. Openable URIs must support the columns in
2775 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002776 * when queried, though it is allowable for those columns to be blank.
2777 */
2778 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2779 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2780
2781 /**
2782 * To be used as code under test for framework instrumentation tests.
2783 */
2784 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2785 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002786 /**
2787 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002788 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2789 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002790 */
2791 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2792 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2793 /**
2794 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002795 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2796 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002797 */
2798 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2799 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002800 /**
2801 * An activity to run when device is inserted into a analog (low end) dock.
2802 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2803 * information, see {@link android.app.UiModeManager}.
2804 */
2805 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2806 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2807
2808 /**
2809 * An activity to run when device is inserted into a digital (high end) dock.
2810 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2811 * information, see {@link android.app.UiModeManager}.
2812 */
2813 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2814 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002815
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002816 /**
2817 * Used to indicate that the activity can be used in a car environment.
2818 */
2819 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2820 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2821
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002822 // ---------------------------------------------------------------------
2823 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002824 // Application launch intent categories (see addCategory()).
2825
2826 /**
2827 * Used with {@link #ACTION_MAIN} to launch the browser application.
2828 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002829 * <p>NOTE: This should not be used as the primary key of an Intent,
2830 * since it will not result in the app launching with the correct
2831 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002832 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002833 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002834 */
2835 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2836 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2837
2838 /**
2839 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2840 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002841 * <p>NOTE: This should not be used as the primary key of an Intent,
2842 * since it will not result in the app launching with the correct
2843 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002844 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002845 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002846 */
2847 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2848 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2849
2850 /**
2851 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2852 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002853 * <p>NOTE: This should not be used as the primary key of an Intent,
2854 * since it will not result in the app launching with the correct
2855 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002856 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002857 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002858 */
2859 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2860 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2861
2862 /**
2863 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2864 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002865 * <p>NOTE: This should not be used as the primary key of an Intent,
2866 * since it will not result in the app launching with the correct
2867 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002868 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002869 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002870 */
2871 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2872 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2873
2874 /**
2875 * Used with {@link #ACTION_MAIN} to launch the email application.
2876 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002877 * <p>NOTE: This should not be used as the primary key of an Intent,
2878 * since it will not result in the app launching with the correct
2879 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002880 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002881 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002882 */
2883 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2884 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2885
2886 /**
2887 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2888 * The activity should be able to view and manipulate image and video files
2889 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002890 * <p>NOTE: This should not be used as the primary key of an Intent,
2891 * since it will not result in the app launching with the correct
2892 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002893 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002894 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002895 */
2896 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2897 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2898
2899 /**
2900 * Used with {@link #ACTION_MAIN} to launch the maps application.
2901 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002902 * <p>NOTE: This should not be used as the primary key of an Intent,
2903 * since it will not result in the app launching with the correct
2904 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002905 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002906 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002907 */
2908 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2909 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2910
2911 /**
2912 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2913 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002914 * <p>NOTE: This should not be used as the primary key of an Intent,
2915 * since it will not result in the app launching with the correct
2916 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002917 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002918 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002919 */
2920 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2921 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2922
2923 /**
2924 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002925 * The activity should be able to play, browse, or manipulate music files
2926 * stored on the device.
2927 * <p>NOTE: This should not be used as the primary key of an Intent,
2928 * since it will not result in the app launching with the correct
2929 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002930 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002931 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002932 */
2933 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2934 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2935
2936 // ---------------------------------------------------------------------
2937 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002938 // Standard extra data keys.
2939
2940 /**
2941 * The initial data to place in a newly created record. Use with
2942 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2943 * fields as would be given to the underlying ContentProvider.insert()
2944 * call.
2945 */
2946 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2947
2948 /**
2949 * A constant CharSequence that is associated with the Intent, used with
2950 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2951 * this may be a styled CharSequence, so you must use
2952 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2953 * retrieve it.
2954 */
2955 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2956
2957 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002958 * A constant String that is associated with the Intent, used with
2959 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2960 * as HTML formatted text. Note that you <em>must</em> also supply
2961 * {@link #EXTRA_TEXT}.
2962 */
2963 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2964
2965 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002966 * A content: URI holding a stream of data associated with the Intent,
2967 * used with {@link #ACTION_SEND} to supply the data being sent.
2968 */
2969 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2970
2971 /**
2972 * A String[] holding e-mail addresses that should be delivered to.
2973 */
2974 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2975
2976 /**
2977 * A String[] holding e-mail addresses that should be carbon copied.
2978 */
2979 public static final String EXTRA_CC = "android.intent.extra.CC";
2980
2981 /**
2982 * A String[] holding e-mail addresses that should be blind carbon copied.
2983 */
2984 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2985
2986 /**
2987 * A constant string holding the desired subject line of a message.
2988 */
2989 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2990
2991 /**
2992 * An Intent describing the choices you would like shown with
2993 * {@link #ACTION_PICK_ACTIVITY}.
2994 */
2995 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2996
2997 /**
2998 * A CharSequence dialog title to provide to the user when used with a
2999 * {@link #ACTION_CHOOSER}.
3000 */
3001 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3002
3003 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003004 * A Parcelable[] of {@link Intent} or
3005 * {@link android.content.pm.LabeledIntent} objects as set with
3006 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3007 * a the front of the list of choices, when shown to the user with a
3008 * {@link #ACTION_CHOOSER}.
3009 */
3010 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3011
3012 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003013 * A {@link android.view.KeyEvent} object containing the event that
3014 * triggered the creation of the Intent it is in.
3015 */
3016 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3017
3018 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003019 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3020 * before shutting down.
3021 *
3022 * {@hide}
3023 */
3024 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3025
3026 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003027 * 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 -07003028 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3029 * of restarting the application.
3030 */
3031 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3032
3033 /**
3034 * A String holding the phone number originally entered in
3035 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3036 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3037 */
3038 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003039
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003040 /**
3041 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3042 * intents to supply the uid the package had been assigned. Also an optional
3043 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3044 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3045 * purpose.
3046 */
3047 public static final String EXTRA_UID = "android.intent.extra.UID";
3048
3049 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003050 * @hide String array of package names.
3051 */
3052 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3053
3054 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003055 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3056 * intents to indicate whether this represents a full uninstall (removing
3057 * both the code and its data) or a partial uninstall (leaving its data,
3058 * implying that this is an update).
3059 */
3060 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003061
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003062 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003063 * @hide
3064 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3065 * intents to indicate that at this point the package has been removed for
3066 * all users on the device.
3067 */
3068 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3069 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3070
3071 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003072 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3073 * intents to indicate that this is a replacement of the package, so this
3074 * broadcast will immediately be followed by an add broadcast for a
3075 * different version of the same package.
3076 */
3077 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003078
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003079 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003080 * Used as an int extra field in {@link android.app.AlarmManager} intents
3081 * to tell the application being invoked how many pending alarms are being
3082 * delievered with the intent. For one-shot alarms this will always be 1.
3083 * For recurring alarms, this might be greater than 1 if the device was
3084 * asleep or powered off at the time an earlier alarm would have been
3085 * delivered.
3086 */
3087 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003088
Jacek Surazski86b6c532009-05-13 14:38:28 +02003089 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003090 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3091 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003092 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3093 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003094 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3095 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3096 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003097 */
3098 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3099
3100 /**
3101 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3102 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003103 */
3104 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3105
3106 /**
3107 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3108 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003109 */
3110 public static final int EXTRA_DOCK_STATE_DESK = 1;
3111
3112 /**
3113 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3114 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003115 */
3116 public static final int EXTRA_DOCK_STATE_CAR = 2;
3117
3118 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003119 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3120 * to represent that the phone is in a analog (low end) dock.
3121 */
3122 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3123
3124 /**
3125 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3126 * to represent that the phone is in a digital (high end) dock.
3127 */
3128 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3129
3130 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003131 * Boolean that can be supplied as meta-data with a dock activity, to
3132 * indicate that the dock should take over the home key when it is active.
3133 */
3134 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003135
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003136 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003137 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3138 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003139 */
3140 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3141
3142 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003143 * Used in the extra field in the remote intent. It's astring token passed with the
3144 * remote intent.
3145 */
3146 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3147 "android.intent.extra.remote_intent_token";
3148
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003149 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003150 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003151 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003152 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003153 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003154 "android.intent.extra.changed_component_name";
3155
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003156 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003157 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003158 * and contains a string array of all of the components that have changed. If
3159 * the state of the overall package has changed, then it will contain an entry
3160 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003161 */
3162 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3163 "android.intent.extra.changed_component_name_list";
3164
3165 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003166 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003167 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3168 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003169 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003170 */
3171 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3172 "android.intent.extra.changed_package_list";
3173
3174 /**
3175 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003176 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3177 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003178 * and contains an integer array of uids of all of the components
3179 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003180 */
3181 public static final String EXTRA_CHANGED_UID_LIST =
3182 "android.intent.extra.changed_uid_list";
3183
3184 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003185 * @hide
3186 * Magic extra system code can use when binding, to give a label for
3187 * who it is that has bound to a service. This is an integer giving
3188 * a framework string resource that can be displayed to the user.
3189 */
3190 public static final String EXTRA_CLIENT_LABEL =
3191 "android.intent.extra.client_label";
3192
3193 /**
3194 * @hide
3195 * Magic extra system code can use when binding, to give a PendingIntent object
3196 * that can be launched for the user to disable the system's use of this
3197 * service.
3198 */
3199 public static final String EXTRA_CLIENT_INTENT =
3200 "android.intent.extra.client_intent";
3201
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003202 /**
3203 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3204 * data that is on the local device. This is a boolean extra; the default
3205 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3206 * the user to select media that is already on the device, not requiring it
3207 * be downloaded from a remote service when opened. Another way to look
3208 * at it is that such content should generally have a "_data" column to the
3209 * path of the content on local external storage.
3210 */
3211 public static final String EXTRA_LOCAL_ONLY =
3212 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003213
Amith Yamasani13593602012-03-22 16:16:17 -07003214 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003215 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3216 * user to select and return multiple items. This is a boolean extra; the default
3217 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3218 * present the user with a UI where they can pick multiple items that are all
3219 * returned to the caller. When this happens, they should be returned as
3220 * the {@link #getClipData()} part of the result Intent.
3221 */
3222 public static final String EXTRA_ALLOW_MULTIPLE =
3223 "android.intent.extra.ALLOW_MULTIPLE";
3224
3225 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003226 * The userHandle carried with broadcast intents related to addition, removal and switching of
3227 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003228 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3229 * @hide
3230 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003231 public static final String EXTRA_USER_HANDLE =
3232 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003233
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003234 /**
3235 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003236 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3237 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003238 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003239 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3240
3241 /**
3242 * Extra sent in the intent to the BroadcastReceiver that handles
3243 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3244 * the restrictions as key/value pairs.
3245 */
3246 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3247 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003248
Amith Yamasani86118ba2013-03-28 14:33:16 -07003249 /**
3250 * Extra used in the response from a BroadcastReceiver that handles
3251 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3252 */
3253 public static final String EXTRA_RESTRICTIONS_INTENT =
3254 "android.intent.extra.restrictions_intent";
3255
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003256 /**
3257 * Extra used to communicate set of acceptable MIME types for
Jeff Sharkey9ab3fd42013-05-01 18:12:12 -07003258 * {@link #ACTION_GET_CONTENT} or {@link #ACTION_OPEN_DOCUMENT}. The type of the
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003259 * extra is <code>ArrayList&lt;String&gt;</code>.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003260 */
3261 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3262
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003263 // ---------------------------------------------------------------------
3264 // ---------------------------------------------------------------------
3265 // Intent flags (see mFlags variable).
3266
3267 /**
3268 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003269 * perform read operations on the Uri in the Intent's data and any URIs
3270 * specified in its ClipData. When applying to an Intent's ClipData,
3271 * all URIs as well as recursive traversals through data or other ClipData
3272 * in Intent items will be granted; only the grant flags of the top-level
3273 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003274 */
3275 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3276 /**
3277 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003278 * perform write operations on the Uri in the Intent's data and any URIs
3279 * specified in its ClipData. When applying to an Intent's ClipData,
3280 * all URIs as well as recursive traversals through data or other ClipData
3281 * in Intent items will be granted; only the grant flags of the top-level
3282 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003283 */
3284 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3285 /**
3286 * Can be set by the caller to indicate that this Intent is coming from
3287 * a background operation, not from direct user interaction.
3288 */
3289 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3290 /**
3291 * A flag you can enable for debugging: when set, log messages will be
3292 * printed during the resolution of this intent to show you what has
3293 * been found to create the final resolved list.
3294 */
3295 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003296 /**
3297 * If set, this intent will not match any components in packages that
3298 * are currently stopped. If this is not set, then the default behavior
3299 * is to include such applications in the result.
3300 */
3301 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3302 /**
3303 * If set, this intent will always match any components in packages that
3304 * are currently stopped. This is the default behavior when
3305 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3306 * flags are set, this one wins (it allows overriding of exclude for
3307 * places where the framework may automatically set the exclude flag).
3308 */
3309 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003310
3311 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003312 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3313 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the grant will be remembered
3314 * until explicitly revoked with
3315 * {@link Context#revokeUriPermission(Uri, int)}. These grants persist
3316 * across device reboots.
3317 */
3318 public static final int FLAG_PERSIST_GRANT_URI_PERMISSION = 0x00000040;
3319
3320 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003321 * If set, the new activity is not kept in the history stack. As soon as
3322 * the user navigates away from it, the activity is finished. This may also
3323 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3324 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003325 */
3326 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3327 /**
3328 * If set, the activity will not be launched if it is already running
3329 * at the top of the history stack.
3330 */
3331 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3332 /**
3333 * If set, this activity will become the start of a new task on this
3334 * history stack. A task (from the activity that started it to the
3335 * next task activity) defines an atomic group of activities that the
3336 * user can move to. Tasks can be moved to the foreground and background;
3337 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003338 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003339 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3340 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003341 *
3342 * <p>This flag is generally used by activities that want
3343 * to present a "launcher" style behavior: they give the user a list of
3344 * separate things that can be done, which otherwise run completely
3345 * independently of the activity launching them.
3346 *
3347 * <p>When using this flag, if a task is already running for the activity
3348 * you are now starting, then a new activity will not be started; instead,
3349 * the current task will simply be brought to the front of the screen with
3350 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3351 * to disable this behavior.
3352 *
3353 * <p>This flag can not be used when the caller is requesting a result from
3354 * the activity being launched.
3355 */
3356 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3357 /**
3358 * <strong>Do not use this flag unless you are implementing your own
3359 * top-level application launcher.</strong> Used in conjunction with
3360 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3361 * behavior of bringing an existing task to the foreground. When set,
3362 * a new task is <em>always</em> started to host the Activity for the
3363 * Intent, regardless of whether there is already an existing task running
3364 * the same thing.
3365 *
3366 * <p><strong>Because the default system does not include graphical task management,
3367 * you should not use this flag unless you provide some way for a user to
3368 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003369 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003370 * <p>This flag is ignored if
3371 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3372 *
Scott Main7aee61f2011-02-08 11:25:01 -08003373 * <p>See
3374 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3375 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003376 */
3377 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3378 /**
3379 * If set, and the activity being launched is already running in the
3380 * current task, then instead of launching a new instance of that activity,
3381 * all of the other activities on top of it will be closed and this Intent
3382 * will be delivered to the (now on top) old activity as a new Intent.
3383 *
3384 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3385 * If D calls startActivity() with an Intent that resolves to the component
3386 * of activity B, then C and D will be finished and B receive the given
3387 * Intent, resulting in the stack now being: A, B.
3388 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003389 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003390 * either receive the new intent you are starting here in its
3391 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003392 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003393 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3394 * the same intent, then it will be finished and re-created; for all other
3395 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3396 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003397 *
3398 * <p>This launch mode can also be used to good effect in conjunction with
3399 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3400 * of a task, it will bring any currently running instance of that task
3401 * to the foreground, and then clear it to its root state. This is
3402 * especially useful, for example, when launching an activity from the
3403 * notification manager.
3404 *
Scott Main7aee61f2011-02-08 11:25:01 -08003405 * <p>See
3406 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3407 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003408 */
3409 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3410 /**
3411 * If set and this intent is being used to launch a new activity from an
3412 * existing one, then the reply target of the existing activity will be
3413 * transfered to the new activity. This way the new activity can call
3414 * {@link android.app.Activity#setResult} and have that result sent back to
3415 * the reply target of the original activity.
3416 */
3417 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3418 /**
3419 * If set and this intent is being used to launch a new activity from an
3420 * existing one, the current activity will not be counted as the top
3421 * activity for deciding whether the new intent should be delivered to
3422 * the top instead of starting a new one. The previous activity will
3423 * be used as the top, with the assumption being that the current activity
3424 * will finish itself immediately.
3425 */
3426 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3427 /**
3428 * If set, the new activity is not kept in the list of recently launched
3429 * activities.
3430 */
3431 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3432 /**
3433 * This flag is not normally set by application code, but set for you by
3434 * the system as described in the
3435 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3436 * launchMode} documentation for the singleTask mode.
3437 */
3438 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3439 /**
3440 * If set, and this activity is either being started in a new task or
3441 * bringing to the top an existing task, then it will be launched as
3442 * the front door of the task. This will result in the application of
3443 * any affinities needed to have that task in the proper state (either
3444 * moving activities to or from it), or simply resetting that task to
3445 * its initial state if needed.
3446 */
3447 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3448 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003449 * This flag is not normally set by application code, but set for you by
3450 * the system if this activity is being launched from history
3451 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003452 */
3453 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003454 /**
3455 * If set, this marks a point in the task's activity stack that should
3456 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003457 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003458 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3459 * the user re-launching it from home), this activity and all on top of
3460 * it will be finished so that the user does not return to them, but
3461 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003462 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003463 * <p>This is useful for cases where you have a logical break in your
3464 * application. For example, an e-mail application may have a command
3465 * to view an attachment, which launches an image view activity to
3466 * display it. This activity should be part of the e-mail application's
3467 * task, since it is a part of the task the user is involved in. However,
3468 * if the user leaves that task, and later selects the e-mail app from
3469 * home, we may like them to return to the conversation they were
3470 * viewing, not the picture attachment, since that is confusing. By
3471 * setting this flag when launching the image viewer, that viewer and
3472 * any activities it starts will be removed the next time the user returns
3473 * to mail.
3474 */
3475 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003476 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003477 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003478 * callback from occurring on the current frontmost activity before it is
3479 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003480 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003481 * <p>Typically, an activity can rely on that callback to indicate that an
3482 * explicit user action has caused their activity to be moved out of the
3483 * foreground. The callback marks an appropriate point in the activity's
3484 * lifecycle for it to dismiss any notifications that it intends to display
3485 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003486 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003487 * <p>If an activity is ever started via any non-user-driven events such as
3488 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3489 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003490 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003491 */
3492 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003493 /**
3494 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3495 * this flag will cause the launched activity to be brought to the front of its
3496 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003497 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003498 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3499 * If D calls startActivity() with an Intent that resolves to the component
3500 * of activity B, then B will be brought to the front of the history stack,
3501 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003502 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003503 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003504 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003505 */
3506 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003507 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003508 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3509 * this flag will prevent the system from applying an activity transition
3510 * animation to go to the next activity state. This doesn't mean an
3511 * animation will never run -- if another activity change happens that doesn't
3512 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003513 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003514 * when you are going to do a series of activity operations but the
3515 * animation seen by the user shouldn't be driven by the first activity
3516 * change but rather a later one.
3517 */
3518 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3519 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003520 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3521 * this flag will cause any existing task that would be associated with the
3522 * activity to be cleared before the activity is started. That is, the activity
3523 * becomes the new root of an otherwise empty task, and any old activities
3524 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3525 */
3526 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3527 /**
3528 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3529 * this flag will cause a newly launching task to be placed on top of the current
3530 * home activity task (if there is one). That is, pressing back from the task
3531 * will always return the user to home even if that was not the last activity they
3532 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3533 */
3534 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3535 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003536 * If set, when sending a broadcast only registered receivers will be
3537 * called -- no BroadcastReceiver components will be launched.
3538 */
3539 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003540 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003541 * If set, when sending a broadcast the new broadcast will replace
3542 * any existing pending broadcast that matches it. Matching is defined
3543 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3544 * true for the intents of the two broadcasts. When a match is found,
3545 * the new broadcast (and receivers associated with it) will replace the
3546 * existing one in the pending broadcast list, remaining at the same
3547 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003548 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003549 * <p>This flag is most typically used with sticky broadcasts, which
3550 * only care about delivering the most recent values of the broadcast
3551 * to their receivers.
3552 */
3553 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3554 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003555 * If set, when sending a broadcast the recipient is allowed to run at
3556 * foreground priority, with a shorter timeout interval. During normal
3557 * broadcasts the receivers are not automatically hoisted out of the
3558 * background priority class.
3559 */
3560 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3561 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003562 * If set, when sending a broadcast <i>before boot has completed</i> only
3563 * registered receivers will be called -- no BroadcastReceiver components
3564 * will be launched. Sticky intent state will be recorded properly even
3565 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3566 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003567 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003568 * <p>This flag is only for use by system sevices as a convenience to
3569 * avoid having to implement a more complex mechanism around detection
3570 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003571 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003572 * @hide
3573 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003574 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003575 /**
3576 * Set when this broadcast is for a boot upgrade, a special mode that
3577 * allows the broadcast to be sent before the system is ready and launches
3578 * the app process with no providers running in it.
3579 * @hide
3580 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003581 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003582
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003583 /**
3584 * @hide Flags that can't be changed with PendingIntent.
3585 */
3586 public static final int IMMUTABLE_FLAGS =
3587 FLAG_GRANT_READ_URI_PERMISSION
3588 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003589
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003590 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003591 // ---------------------------------------------------------------------
3592 // toUri() and parseUri() options.
3593
3594 /**
3595 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3596 * always has the "intent:" scheme. This syntax can be used when you want
3597 * to later disambiguate between URIs that are intended to describe an
3598 * Intent vs. all others that should be treated as raw URIs. When used
3599 * with {@link #parseUri}, any other scheme will result in a generic
3600 * VIEW action for that raw URI.
3601 */
3602 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003603
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003604 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003605
3606 private String mAction;
3607 private Uri mData;
3608 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003609 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003610 private ComponentName mComponent;
3611 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003612 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003614 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003615 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003616 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003617
3618 // ---------------------------------------------------------------------
3619
3620 /**
3621 * Create an empty intent.
3622 */
3623 public Intent() {
3624 }
3625
3626 /**
3627 * Copy constructor.
3628 */
3629 public Intent(Intent o) {
3630 this.mAction = o.mAction;
3631 this.mData = o.mData;
3632 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003633 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 this.mComponent = o.mComponent;
3635 this.mFlags = o.mFlags;
3636 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003637 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003638 }
3639 if (o.mExtras != null) {
3640 this.mExtras = new Bundle(o.mExtras);
3641 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003642 if (o.mSourceBounds != null) {
3643 this.mSourceBounds = new Rect(o.mSourceBounds);
3644 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003645 if (o.mSelector != null) {
3646 this.mSelector = new Intent(o.mSelector);
3647 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003648 if (o.mClipData != null) {
3649 this.mClipData = new ClipData(o.mClipData);
3650 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003651 }
3652
3653 @Override
3654 public Object clone() {
3655 return new Intent(this);
3656 }
3657
3658 private Intent(Intent o, boolean all) {
3659 this.mAction = o.mAction;
3660 this.mData = o.mData;
3661 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003662 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663 this.mComponent = o.mComponent;
3664 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003665 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003666 }
3667 }
3668
3669 /**
3670 * Make a clone of only the parts of the Intent that are relevant for
3671 * filter matching: the action, data, type, component, and categories.
3672 */
3673 public Intent cloneFilter() {
3674 return new Intent(this, false);
3675 }
3676
3677 /**
3678 * Create an intent with a given action. All other fields (data, type,
3679 * class) are null. Note that the action <em>must</em> be in a
3680 * namespace because Intents are used globally in the system -- for
3681 * example the system VIEW action is android.intent.action.VIEW; an
3682 * application's custom action would be something like
3683 * com.google.app.myapp.CUSTOM_ACTION.
3684 *
3685 * @param action The Intent action, such as ACTION_VIEW.
3686 */
3687 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003688 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003689 }
3690
3691 /**
3692 * Create an intent with a given action and for a given data url. Note
3693 * that the action <em>must</em> be in a namespace because Intents are
3694 * used globally in the system -- for example the system VIEW action is
3695 * android.intent.action.VIEW; an application's custom action would be
3696 * something like com.google.app.myapp.CUSTOM_ACTION.
3697 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003698 * <p><em>Note: scheme and host name matching in the Android framework is
3699 * case-sensitive, unlike the formal RFC. As a result,
3700 * you should always ensure that you write your Uri with these elements
3701 * using lower case letters, and normalize any Uris you receive from
3702 * outside of Android to ensure the scheme and host is lower case.</em></p>
3703 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003704 * @param action The Intent action, such as ACTION_VIEW.
3705 * @param uri The Intent data URI.
3706 */
3707 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003708 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003709 mData = uri;
3710 }
3711
3712 /**
3713 * Create an intent for a specific component. All other fields (action, data,
3714 * type, class) are null, though they can be modified later with explicit
3715 * calls. This provides a convenient way to create an intent that is
3716 * intended to execute a hard-coded class name, rather than relying on the
3717 * system to find an appropriate class for you; see {@link #setComponent}
3718 * for more information on the repercussions of this.
3719 *
3720 * @param packageContext A Context of the application package implementing
3721 * this class.
3722 * @param cls The component class that is to be used for the intent.
3723 *
3724 * @see #setClass
3725 * @see #setComponent
3726 * @see #Intent(String, android.net.Uri , Context, Class)
3727 */
3728 public Intent(Context packageContext, Class<?> cls) {
3729 mComponent = new ComponentName(packageContext, cls);
3730 }
3731
3732 /**
3733 * Create an intent for a specific component with a specified action and data.
3734 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3735 * construct the Intent and then calling {@link #setClass} to set its
3736 * class.
3737 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003738 * <p><em>Note: scheme and host name matching in the Android framework is
3739 * case-sensitive, unlike the formal RFC. As a result,
3740 * you should always ensure that you write your Uri with these elements
3741 * using lower case letters, and normalize any Uris you receive from
3742 * outside of Android to ensure the scheme and host is lower case.</em></p>
3743 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003744 * @param action The Intent action, such as ACTION_VIEW.
3745 * @param uri The Intent data URI.
3746 * @param packageContext A Context of the application package implementing
3747 * this class.
3748 * @param cls The component class that is to be used for the intent.
3749 *
3750 * @see #Intent(String, android.net.Uri)
3751 * @see #Intent(Context, Class)
3752 * @see #setClass
3753 * @see #setComponent
3754 */
3755 public Intent(String action, Uri uri,
3756 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003757 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003758 mData = uri;
3759 mComponent = new ComponentName(packageContext, cls);
3760 }
3761
3762 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003763 * Create an intent to launch the main (root) activity of a task. This
3764 * is the Intent that is started when the application's is launched from
3765 * Home. For anything else that wants to launch an application in the
3766 * same way, it is important that they use an Intent structured the same
3767 * way, and can use this function to ensure this is the case.
3768 *
3769 * <p>The returned Intent has the given Activity component as its explicit
3770 * component, {@link #ACTION_MAIN} as its action, and includes the
3771 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3772 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3773 * to do that through {@link #addFlags(int)} on the returned Intent.
3774 *
3775 * @param mainActivity The main activity component that this Intent will
3776 * launch.
3777 * @return Returns a newly created Intent that can be used to launch the
3778 * activity as a main application entry.
3779 *
3780 * @see #setClass
3781 * @see #setComponent
3782 */
3783 public static Intent makeMainActivity(ComponentName mainActivity) {
3784 Intent intent = new Intent(ACTION_MAIN);
3785 intent.setComponent(mainActivity);
3786 intent.addCategory(CATEGORY_LAUNCHER);
3787 return intent;
3788 }
3789
3790 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003791 * Make an Intent for the main activity of an application, without
3792 * specifying a specific activity to run but giving a selector to find
3793 * the activity. This results in a final Intent that is structured
3794 * the same as when the application is launched from
3795 * Home. For anything else that wants to launch an application in the
3796 * same way, it is important that they use an Intent structured the same
3797 * way, and can use this function to ensure this is the case.
3798 *
3799 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3800 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3801 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3802 * to do that through {@link #addFlags(int)} on the returned Intent.
3803 *
3804 * @param selectorAction The action name of the Intent's selector.
3805 * @param selectorCategory The name of a category to add to the Intent's
3806 * selector.
3807 * @return Returns a newly created Intent that can be used to launch the
3808 * activity as a main application entry.
3809 *
3810 * @see #setSelector(Intent)
3811 */
3812 public static Intent makeMainSelectorActivity(String selectorAction,
3813 String selectorCategory) {
3814 Intent intent = new Intent(ACTION_MAIN);
3815 intent.addCategory(CATEGORY_LAUNCHER);
3816 Intent selector = new Intent();
3817 selector.setAction(selectorAction);
3818 selector.addCategory(selectorCategory);
3819 intent.setSelector(selector);
3820 return intent;
3821 }
3822
3823 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003824 * Make an Intent that can be used to re-launch an application's task
3825 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3826 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3827 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3828 *
3829 * @param mainActivity The activity component that is the root of the
3830 * task; this is the activity that has been published in the application's
3831 * manifest as the main launcher icon.
3832 *
3833 * @return Returns a newly created Intent that can be used to relaunch the
3834 * activity's task in its root state.
3835 */
3836 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3837 Intent intent = makeMainActivity(mainActivity);
3838 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3839 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3840 return intent;
3841 }
3842
3843 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003844 * Call {@link #parseUri} with 0 flags.
3845 * @deprecated Use {@link #parseUri} instead.
3846 */
3847 @Deprecated
3848 public static Intent getIntent(String uri) throws URISyntaxException {
3849 return parseUri(uri, 0);
3850 }
Tom Taylord4a47292009-12-21 13:59:18 -08003851
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003852 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003853 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003854 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003855 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003856 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003857 *
3858 * <p>The URI given here must not be relative -- that is, it must include
3859 * the scheme and full path.
3860 *
3861 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003862 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003863 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003864 *
3865 * @return Intent The newly created Intent object.
3866 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003867 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3868 * it bad (as parsed by the Uri class) or the Intent data within the
3869 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003870 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003871 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003872 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003873 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003874 int i = 0;
3875 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003876 // Validate intent scheme for if requested.
3877 if ((flags&URI_INTENT_SCHEME) != 0) {
3878 if (!uri.startsWith("intent:")) {
3879 Intent intent = new Intent(ACTION_VIEW);
3880 try {
3881 intent.setData(Uri.parse(uri));
3882 } catch (IllegalArgumentException e) {
3883 throw new URISyntaxException(uri, e.getMessage());
3884 }
3885 return intent;
3886 }
3887 }
Tom Taylord4a47292009-12-21 13:59:18 -08003888
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003889 // simple case
3890 i = uri.lastIndexOf("#");
3891 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3892
3893 // old format Intent URI
3894 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003895
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003896 // new format
3897 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003898 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003899
3900 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003901 String data = i >= 0 ? uri.substring(0, i) : null;
3902 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003903 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003904
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003905 // loop over contents of Intent, all name=value;
3906 while (!uri.startsWith("end", i)) {
3907 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003908 if (eq < 0) eq = i-1;
3909 int semi = uri.indexOf(';', i);
3910 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003911
3912 // action
3913 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003914 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003915 }
3916
3917 // categories
3918 else if (uri.startsWith("category=", i)) {
3919 intent.addCategory(value);
3920 }
3921
3922 // type
3923 else if (uri.startsWith("type=", i)) {
3924 intent.mType = value;
3925 }
3926
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003927 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003928 else if (uri.startsWith("launchFlags=", i)) {
3929 intent.mFlags = Integer.decode(value).intValue();
3930 }
3931
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003932 // package
3933 else if (uri.startsWith("package=", i)) {
3934 intent.mPackage = value;
3935 }
3936
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003937 // component
3938 else if (uri.startsWith("component=", i)) {
3939 intent.mComponent = ComponentName.unflattenFromString(value);
3940 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003941
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003942 // scheme
3943 else if (uri.startsWith("scheme=", i)) {
3944 scheme = value;
3945 }
3946
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003947 // source bounds
3948 else if (uri.startsWith("sourceBounds=", i)) {
3949 intent.mSourceBounds = Rect.unflattenFromString(value);
3950 }
3951
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003952 // selector
3953 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3954 intent = new Intent();
3955 }
3956
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003957 // extra
3958 else {
3959 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003960 // create Bundle if it doesn't already exist
3961 if (intent.mExtras == null) intent.mExtras = new Bundle();
3962 Bundle b = intent.mExtras;
3963 // add EXTRA
3964 if (uri.startsWith("S.", i)) b.putString(key, value);
3965 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3966 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3967 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3968 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3969 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3970 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3971 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3972 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3973 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3974 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003976 // move to the next item
3977 i = semi + 1;
3978 }
3979
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003980 if (intent != baseIntent) {
3981 // The Intent had a selector; fix it up.
3982 baseIntent.setSelector(intent);
3983 intent = baseIntent;
3984 }
3985
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003986 if (data != null) {
3987 if (data.startsWith("intent:")) {
3988 data = data.substring(7);
3989 if (scheme != null) {
3990 data = scheme + ':' + data;
3991 }
3992 }
Tom Taylord4a47292009-12-21 13:59:18 -08003993
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003994 if (data.length() > 0) {
3995 try {
3996 intent.mData = Uri.parse(data);
3997 } catch (IllegalArgumentException e) {
3998 throw new URISyntaxException(uri, e.getMessage());
3999 }
4000 }
4001 }
Tom Taylord4a47292009-12-21 13:59:18 -08004002
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004003 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004004
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004005 } catch (IndexOutOfBoundsException e) {
4006 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4007 }
4008 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004009
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004010 public static Intent getIntentOld(String uri) throws URISyntaxException {
4011 Intent intent;
4012
4013 int i = uri.lastIndexOf('#');
4014 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004015 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004016 final int intentFragmentStart = i;
4017 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004018
4019 i++;
4020
4021 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004022 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004023 i += 7;
4024 int j = uri.indexOf(')', i);
4025 action = uri.substring(i, j);
4026 i = j + 1;
4027 }
4028
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004029 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004030
4031 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004032 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004033 i += 11;
4034 int j = uri.indexOf(')', i);
4035 while (i < j) {
4036 int sep = uri.indexOf('!', i);
4037 if (sep < 0) sep = j;
4038 if (i < sep) {
4039 intent.addCategory(uri.substring(i, sep));
4040 }
4041 i = sep + 1;
4042 }
4043 i = j + 1;
4044 }
4045
4046 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004047 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004048 i += 5;
4049 int j = uri.indexOf(')', i);
4050 intent.mType = uri.substring(i, j);
4051 i = j + 1;
4052 }
4053
4054 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004055 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004056 i += 12;
4057 int j = uri.indexOf(')', i);
4058 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4059 i = j + 1;
4060 }
4061
4062 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004063 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004064 i += 10;
4065 int j = uri.indexOf(')', i);
4066 int sep = uri.indexOf('!', i);
4067 if (sep >= 0 && sep < j) {
4068 String pkg = uri.substring(i, sep);
4069 String cls = uri.substring(sep + 1, j);
4070 intent.mComponent = new ComponentName(pkg, cls);
4071 }
4072 i = j + 1;
4073 }
4074
4075 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004076 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004077 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004078
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004079 final int closeParen = uri.indexOf(')', i);
4080 if (closeParen == -1) throw new URISyntaxException(uri,
4081 "EXTRA missing trailing ')'", i);
4082
4083 while (i < closeParen) {
4084 // fetch the key value
4085 int j = uri.indexOf('=', i);
4086 if (j <= i + 1 || i >= closeParen) {
4087 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4088 }
4089 char type = uri.charAt(i);
4090 i++;
4091 String key = uri.substring(i, j);
4092 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004093
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004094 // get type-value
4095 j = uri.indexOf('!', i);
4096 if (j == -1 || j >= closeParen) j = closeParen;
4097 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4098 String value = uri.substring(i, j);
4099 i = j;
4100
4101 // create Bundle if it doesn't already exist
4102 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004103
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004104 // add item to bundle
4105 try {
4106 switch (type) {
4107 case 'S':
4108 intent.mExtras.putString(key, Uri.decode(value));
4109 break;
4110 case 'B':
4111 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4112 break;
4113 case 'b':
4114 intent.mExtras.putByte(key, Byte.parseByte(value));
4115 break;
4116 case 'c':
4117 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4118 break;
4119 case 'd':
4120 intent.mExtras.putDouble(key, Double.parseDouble(value));
4121 break;
4122 case 'f':
4123 intent.mExtras.putFloat(key, Float.parseFloat(value));
4124 break;
4125 case 'i':
4126 intent.mExtras.putInt(key, Integer.parseInt(value));
4127 break;
4128 case 'l':
4129 intent.mExtras.putLong(key, Long.parseLong(value));
4130 break;
4131 case 's':
4132 intent.mExtras.putShort(key, Short.parseShort(value));
4133 break;
4134 default:
4135 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4136 }
4137 } catch (NumberFormatException e) {
4138 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4139 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004140
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004141 char ch = uri.charAt(i);
4142 if (ch == ')') break;
4143 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4144 i++;
4145 }
4146 }
4147
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004148 if (isIntentFragment) {
4149 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4150 } else {
4151 intent.mData = Uri.parse(uri);
4152 }
Tom Taylord4a47292009-12-21 13:59:18 -08004153
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004154 if (intent.mAction == null) {
4155 // By default, if no action is specified, then use VIEW.
4156 intent.mAction = ACTION_VIEW;
4157 }
4158
4159 } else {
4160 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4161 }
4162
4163 return intent;
4164 }
4165
4166 /**
4167 * Retrieve the general action to be performed, such as
4168 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4169 * the information in the intent should be interpreted -- most importantly,
4170 * what to do with the data returned by {@link #getData}.
4171 *
4172 * @return The action of this intent or null if none is specified.
4173 *
4174 * @see #setAction
4175 */
4176 public String getAction() {
4177 return mAction;
4178 }
4179
4180 /**
4181 * Retrieve data this intent is operating on. This URI specifies the name
4182 * of the data; often it uses the content: scheme, specifying data in a
4183 * content provider. Other schemes may be handled by specific activities,
4184 * such as http: by the web browser.
4185 *
4186 * @return The URI of the data this intent is targeting or null.
4187 *
4188 * @see #getScheme
4189 * @see #setData
4190 */
4191 public Uri getData() {
4192 return mData;
4193 }
4194
4195 /**
4196 * The same as {@link #getData()}, but returns the URI as an encoded
4197 * String.
4198 */
4199 public String getDataString() {
4200 return mData != null ? mData.toString() : null;
4201 }
4202
4203 /**
4204 * Return the scheme portion of the intent's data. If the data is null or
4205 * does not include a scheme, null is returned. Otherwise, the scheme
4206 * prefix without the final ':' is returned, i.e. "http".
4207 *
4208 * <p>This is the same as calling getData().getScheme() (and checking for
4209 * null data).
4210 *
4211 * @return The scheme of this intent.
4212 *
4213 * @see #getData
4214 */
4215 public String getScheme() {
4216 return mData != null ? mData.getScheme() : null;
4217 }
4218
4219 /**
4220 * Retrieve any explicit MIME type included in the intent. This is usually
4221 * null, as the type is determined by the intent data.
4222 *
4223 * @return If a type was manually set, it is returned; else null is
4224 * returned.
4225 *
4226 * @see #resolveType(ContentResolver)
4227 * @see #setType
4228 */
4229 public String getType() {
4230 return mType;
4231 }
4232
4233 /**
4234 * Return the MIME data type of this intent. If the type field is
4235 * explicitly set, that is simply returned. Otherwise, if the data is set,
4236 * the type of that data is returned. If neither fields are set, a null is
4237 * returned.
4238 *
4239 * @return The MIME type of this intent.
4240 *
4241 * @see #getType
4242 * @see #resolveType(ContentResolver)
4243 */
4244 public String resolveType(Context context) {
4245 return resolveType(context.getContentResolver());
4246 }
4247
4248 /**
4249 * Return the MIME data type of this intent. If the type field is
4250 * explicitly set, that is simply returned. Otherwise, if the data is set,
4251 * the type of that data is returned. If neither fields are set, a null is
4252 * returned.
4253 *
4254 * @param resolver A ContentResolver that can be used to determine the MIME
4255 * type of the intent's data.
4256 *
4257 * @return The MIME type of this intent.
4258 *
4259 * @see #getType
4260 * @see #resolveType(Context)
4261 */
4262 public String resolveType(ContentResolver resolver) {
4263 if (mType != null) {
4264 return mType;
4265 }
4266 if (mData != null) {
4267 if ("content".equals(mData.getScheme())) {
4268 return resolver.getType(mData);
4269 }
4270 }
4271 return null;
4272 }
4273
4274 /**
4275 * Return the MIME data type of this intent, only if it will be needed for
4276 * intent resolution. This is not generally useful for application code;
4277 * it is used by the frameworks for communicating with back-end system
4278 * services.
4279 *
4280 * @param resolver A ContentResolver that can be used to determine the MIME
4281 * type of the intent's data.
4282 *
4283 * @return The MIME type of this intent, or null if it is unknown or not
4284 * needed.
4285 */
4286 public String resolveTypeIfNeeded(ContentResolver resolver) {
4287 if (mComponent != null) {
4288 return mType;
4289 }
4290 return resolveType(resolver);
4291 }
4292
4293 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004294 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004295 *
4296 * @param category The category to check.
4297 *
4298 * @return boolean True if the intent contains the category, else false.
4299 *
4300 * @see #getCategories
4301 * @see #addCategory
4302 */
4303 public boolean hasCategory(String category) {
4304 return mCategories != null && mCategories.contains(category);
4305 }
4306
4307 /**
4308 * Return the set of all categories in the intent. If there are no categories,
4309 * returns NULL.
4310 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004311 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004312 *
4313 * @see #hasCategory
4314 * @see #addCategory
4315 */
4316 public Set<String> getCategories() {
4317 return mCategories;
4318 }
4319
4320 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004321 * Return the specific selector associated with this Intent. If there is
4322 * none, returns null. See {@link #setSelector} for more information.
4323 *
4324 * @see #setSelector
4325 */
4326 public Intent getSelector() {
4327 return mSelector;
4328 }
4329
4330 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004331 * Return the {@link ClipData} associated with this Intent. If there is
4332 * none, returns null. See {@link #setClipData} for more information.
4333 *
4334 * @see #setClipData;
4335 */
4336 public ClipData getClipData() {
4337 return mClipData;
4338 }
4339
4340 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004341 * Sets the ClassLoader that will be used when unmarshalling
4342 * any Parcelable values from the extras of this Intent.
4343 *
4344 * @param loader a ClassLoader, or null to use the default loader
4345 * at the time of unmarshalling.
4346 */
4347 public void setExtrasClassLoader(ClassLoader loader) {
4348 if (mExtras != null) {
4349 mExtras.setClassLoader(loader);
4350 }
4351 }
4352
4353 /**
4354 * Returns true if an extra value is associated with the given name.
4355 * @param name the extra's name
4356 * @return true if the given extra is present.
4357 */
4358 public boolean hasExtra(String name) {
4359 return mExtras != null && mExtras.containsKey(name);
4360 }
4361
4362 /**
4363 * Returns true if the Intent's extras contain a parcelled file descriptor.
4364 * @return true if the Intent contains a parcelled file descriptor.
4365 */
4366 public boolean hasFileDescriptors() {
4367 return mExtras != null && mExtras.hasFileDescriptors();
4368 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004369
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004370 /** @hide */
4371 public void setAllowFds(boolean allowFds) {
4372 if (mExtras != null) {
4373 mExtras.setAllowFds(allowFds);
4374 }
4375 }
4376
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004377 /**
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 none was found.
4384 *
4385 * @deprecated
4386 * @hide
4387 */
4388 @Deprecated
4389 public Object getExtra(String name) {
4390 return getExtra(name, null);
4391 }
4392
4393 /**
4394 * Retrieve extended data from the intent.
4395 *
4396 * @param name The name of the desired item.
4397 * @param defaultValue the value to be returned if no value of the desired
4398 * type is stored with the given name.
4399 *
4400 * @return the value of an item that previously added with putExtra()
4401 * or the default value if none was found.
4402 *
4403 * @see #putExtra(String, boolean)
4404 */
4405 public boolean getBooleanExtra(String name, boolean defaultValue) {
4406 return mExtras == null ? defaultValue :
4407 mExtras.getBoolean(name, defaultValue);
4408 }
4409
4410 /**
4411 * Retrieve extended data from the intent.
4412 *
4413 * @param name The name of the desired item.
4414 * @param defaultValue the value to be returned if no value of the desired
4415 * type is stored with the given name.
4416 *
4417 * @return the value of an item that previously added with putExtra()
4418 * or the default value if none was found.
4419 *
4420 * @see #putExtra(String, byte)
4421 */
4422 public byte getByteExtra(String name, byte defaultValue) {
4423 return mExtras == null ? defaultValue :
4424 mExtras.getByte(name, defaultValue);
4425 }
4426
4427 /**
4428 * Retrieve extended data from the intent.
4429 *
4430 * @param name The name of the desired item.
4431 * @param defaultValue the value to be returned if no value of the desired
4432 * type is stored with the given name.
4433 *
4434 * @return the value of an item that previously added with putExtra()
4435 * or the default value if none was found.
4436 *
4437 * @see #putExtra(String, short)
4438 */
4439 public short getShortExtra(String name, short defaultValue) {
4440 return mExtras == null ? defaultValue :
4441 mExtras.getShort(name, defaultValue);
4442 }
4443
4444 /**
4445 * Retrieve extended data from the intent.
4446 *
4447 * @param name The name of the desired item.
4448 * @param defaultValue the value to be returned if no value of the desired
4449 * type is stored with the given name.
4450 *
4451 * @return the value of an item that previously added with putExtra()
4452 * or the default value if none was found.
4453 *
4454 * @see #putExtra(String, char)
4455 */
4456 public char getCharExtra(String name, char defaultValue) {
4457 return mExtras == null ? defaultValue :
4458 mExtras.getChar(name, defaultValue);
4459 }
4460
4461 /**
4462 * Retrieve extended data from the intent.
4463 *
4464 * @param name The name of the desired item.
4465 * @param defaultValue the value to be returned if no value of the desired
4466 * type is stored with the given name.
4467 *
4468 * @return the value of an item that previously added with putExtra()
4469 * or the default value if none was found.
4470 *
4471 * @see #putExtra(String, int)
4472 */
4473 public int getIntExtra(String name, int defaultValue) {
4474 return mExtras == null ? defaultValue :
4475 mExtras.getInt(name, defaultValue);
4476 }
4477
4478 /**
4479 * Retrieve extended data from the intent.
4480 *
4481 * @param name The name of the desired item.
4482 * @param defaultValue the value to be returned if no value of the desired
4483 * type is stored with the given name.
4484 *
4485 * @return the value of an item that previously added with putExtra()
4486 * or the default value if none was found.
4487 *
4488 * @see #putExtra(String, long)
4489 */
4490 public long getLongExtra(String name, long defaultValue) {
4491 return mExtras == null ? defaultValue :
4492 mExtras.getLong(name, defaultValue);
4493 }
4494
4495 /**
4496 * Retrieve extended data from the intent.
4497 *
4498 * @param name The name of the desired item.
4499 * @param defaultValue the value to be returned if no value of the desired
4500 * type is stored with the given name.
4501 *
4502 * @return the value of an item that previously added with putExtra(),
4503 * or the default value if no such item is present
4504 *
4505 * @see #putExtra(String, float)
4506 */
4507 public float getFloatExtra(String name, float defaultValue) {
4508 return mExtras == null ? defaultValue :
4509 mExtras.getFloat(name, defaultValue);
4510 }
4511
4512 /**
4513 * Retrieve extended data from the intent.
4514 *
4515 * @param name The name of the desired item.
4516 * @param defaultValue the value to be returned if no value of the desired
4517 * type is stored with the given name.
4518 *
4519 * @return the value of an item that previously added with putExtra()
4520 * or the default value if none was found.
4521 *
4522 * @see #putExtra(String, double)
4523 */
4524 public double getDoubleExtra(String name, double defaultValue) {
4525 return mExtras == null ? defaultValue :
4526 mExtras.getDouble(name, defaultValue);
4527 }
4528
4529 /**
4530 * Retrieve extended data from the intent.
4531 *
4532 * @param name The name of the desired item.
4533 *
4534 * @return the value of an item that previously added with putExtra()
4535 * or null if no String value was found.
4536 *
4537 * @see #putExtra(String, String)
4538 */
4539 public String getStringExtra(String name) {
4540 return mExtras == null ? null : mExtras.getString(name);
4541 }
4542
4543 /**
4544 * Retrieve extended data from the intent.
4545 *
4546 * @param name The name of the desired item.
4547 *
4548 * @return the value of an item that previously added with putExtra()
4549 * or null if no CharSequence value was found.
4550 *
4551 * @see #putExtra(String, CharSequence)
4552 */
4553 public CharSequence getCharSequenceExtra(String name) {
4554 return mExtras == null ? null : mExtras.getCharSequence(name);
4555 }
4556
4557 /**
4558 * Retrieve extended data from the intent.
4559 *
4560 * @param name The name of the desired item.
4561 *
4562 * @return the value of an item that previously added with putExtra()
4563 * or null if no Parcelable value was found.
4564 *
4565 * @see #putExtra(String, Parcelable)
4566 */
4567 public <T extends Parcelable> T getParcelableExtra(String name) {
4568 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4569 }
4570
4571 /**
4572 * Retrieve extended data from the intent.
4573 *
4574 * @param name The name of the desired item.
4575 *
4576 * @return the value of an item that previously added with putExtra()
4577 * or null if no Parcelable[] value was found.
4578 *
4579 * @see #putExtra(String, Parcelable[])
4580 */
4581 public Parcelable[] getParcelableArrayExtra(String name) {
4582 return mExtras == null ? null : mExtras.getParcelableArray(name);
4583 }
4584
4585 /**
4586 * Retrieve extended data from the intent.
4587 *
4588 * @param name The name of the desired item.
4589 *
4590 * @return the value of an item that previously added with putExtra()
4591 * or null if no ArrayList<Parcelable> value was found.
4592 *
4593 * @see #putParcelableArrayListExtra(String, ArrayList)
4594 */
4595 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4596 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4597 }
4598
4599 /**
4600 * Retrieve extended data from the intent.
4601 *
4602 * @param name The name of the desired item.
4603 *
4604 * @return the value of an item that previously added with putExtra()
4605 * or null if no Serializable value was found.
4606 *
4607 * @see #putExtra(String, Serializable)
4608 */
4609 public Serializable getSerializableExtra(String name) {
4610 return mExtras == null ? null : mExtras.getSerializable(name);
4611 }
4612
4613 /**
4614 * Retrieve extended data from the intent.
4615 *
4616 * @param name The name of the desired item.
4617 *
4618 * @return the value of an item that previously added with putExtra()
4619 * or null if no ArrayList<Integer> value was found.
4620 *
4621 * @see #putIntegerArrayListExtra(String, ArrayList)
4622 */
4623 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4624 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4625 }
4626
4627 /**
4628 * Retrieve extended data from the intent.
4629 *
4630 * @param name The name of the desired item.
4631 *
4632 * @return the value of an item that previously added with putExtra()
4633 * or null if no ArrayList<String> value was found.
4634 *
4635 * @see #putStringArrayListExtra(String, ArrayList)
4636 */
4637 public ArrayList<String> getStringArrayListExtra(String name) {
4638 return mExtras == null ? null : mExtras.getStringArrayList(name);
4639 }
4640
4641 /**
4642 * Retrieve extended data from the intent.
4643 *
4644 * @param name The name of the desired item.
4645 *
4646 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004647 * or null if no ArrayList<CharSequence> value was found.
4648 *
4649 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4650 */
4651 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4652 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4653 }
4654
4655 /**
4656 * Retrieve extended data from the intent.
4657 *
4658 * @param name The name of the desired item.
4659 *
4660 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004661 * or null if no boolean array value was found.
4662 *
4663 * @see #putExtra(String, boolean[])
4664 */
4665 public boolean[] getBooleanArrayExtra(String name) {
4666 return mExtras == null ? null : mExtras.getBooleanArray(name);
4667 }
4668
4669 /**
4670 * Retrieve extended data from the intent.
4671 *
4672 * @param name The name of the desired item.
4673 *
4674 * @return the value of an item that previously added with putExtra()
4675 * or null if no byte array value was found.
4676 *
4677 * @see #putExtra(String, byte[])
4678 */
4679 public byte[] getByteArrayExtra(String name) {
4680 return mExtras == null ? null : mExtras.getByteArray(name);
4681 }
4682
4683 /**
4684 * Retrieve extended data from the intent.
4685 *
4686 * @param name The name of the desired item.
4687 *
4688 * @return the value of an item that previously added with putExtra()
4689 * or null if no short array value was found.
4690 *
4691 * @see #putExtra(String, short[])
4692 */
4693 public short[] getShortArrayExtra(String name) {
4694 return mExtras == null ? null : mExtras.getShortArray(name);
4695 }
4696
4697 /**
4698 * Retrieve extended data from the intent.
4699 *
4700 * @param name The name of the desired item.
4701 *
4702 * @return the value of an item that previously added with putExtra()
4703 * or null if no char array value was found.
4704 *
4705 * @see #putExtra(String, char[])
4706 */
4707 public char[] getCharArrayExtra(String name) {
4708 return mExtras == null ? null : mExtras.getCharArray(name);
4709 }
4710
4711 /**
4712 * Retrieve extended data from the intent.
4713 *
4714 * @param name The name of the desired item.
4715 *
4716 * @return the value of an item that previously added with putExtra()
4717 * or null if no int array value was found.
4718 *
4719 * @see #putExtra(String, int[])
4720 */
4721 public int[] getIntArrayExtra(String name) {
4722 return mExtras == null ? null : mExtras.getIntArray(name);
4723 }
4724
4725 /**
4726 * Retrieve extended data from the intent.
4727 *
4728 * @param name The name of the desired item.
4729 *
4730 * @return the value of an item that previously added with putExtra()
4731 * or null if no long array value was found.
4732 *
4733 * @see #putExtra(String, long[])
4734 */
4735 public long[] getLongArrayExtra(String name) {
4736 return mExtras == null ? null : mExtras.getLongArray(name);
4737 }
4738
4739 /**
4740 * Retrieve extended data from the intent.
4741 *
4742 * @param name The name of the desired item.
4743 *
4744 * @return the value of an item that previously added with putExtra()
4745 * or null if no float array value was found.
4746 *
4747 * @see #putExtra(String, float[])
4748 */
4749 public float[] getFloatArrayExtra(String name) {
4750 return mExtras == null ? null : mExtras.getFloatArray(name);
4751 }
4752
4753 /**
4754 * Retrieve extended data from the intent.
4755 *
4756 * @param name The name of the desired item.
4757 *
4758 * @return the value of an item that previously added with putExtra()
4759 * or null if no double array value was found.
4760 *
4761 * @see #putExtra(String, double[])
4762 */
4763 public double[] getDoubleArrayExtra(String name) {
4764 return mExtras == null ? null : mExtras.getDoubleArray(name);
4765 }
4766
4767 /**
4768 * Retrieve extended data from the intent.
4769 *
4770 * @param name The name of the desired item.
4771 *
4772 * @return the value of an item that previously added with putExtra()
4773 * or null if no String array value was found.
4774 *
4775 * @see #putExtra(String, String[])
4776 */
4777 public String[] getStringArrayExtra(String name) {
4778 return mExtras == null ? null : mExtras.getStringArray(name);
4779 }
4780
4781 /**
4782 * Retrieve extended data from the intent.
4783 *
4784 * @param name The name of the desired item.
4785 *
4786 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004787 * or null if no CharSequence array value was found.
4788 *
4789 * @see #putExtra(String, CharSequence[])
4790 */
4791 public CharSequence[] getCharSequenceArrayExtra(String name) {
4792 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4793 }
4794
4795 /**
4796 * Retrieve extended data from the intent.
4797 *
4798 * @param name The name of the desired item.
4799 *
4800 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004801 * or null if no Bundle value was found.
4802 *
4803 * @see #putExtra(String, Bundle)
4804 */
4805 public Bundle getBundleExtra(String name) {
4806 return mExtras == null ? null : mExtras.getBundle(name);
4807 }
4808
4809 /**
4810 * Retrieve extended data from the intent.
4811 *
4812 * @param name The name of the desired item.
4813 *
4814 * @return the value of an item that previously added with putExtra()
4815 * or null if no IBinder value was found.
4816 *
4817 * @see #putExtra(String, IBinder)
4818 *
4819 * @deprecated
4820 * @hide
4821 */
4822 @Deprecated
4823 public IBinder getIBinderExtra(String name) {
4824 return mExtras == null ? null : mExtras.getIBinder(name);
4825 }
4826
4827 /**
4828 * Retrieve extended data from the intent.
4829 *
4830 * @param name The name of the desired item.
4831 * @param defaultValue The default value to return in case no item is
4832 * associated with the key 'name'
4833 *
4834 * @return the value of an item that previously added with putExtra()
4835 * or defaultValue if none was found.
4836 *
4837 * @see #putExtra
4838 *
4839 * @deprecated
4840 * @hide
4841 */
4842 @Deprecated
4843 public Object getExtra(String name, Object defaultValue) {
4844 Object result = defaultValue;
4845 if (mExtras != null) {
4846 Object result2 = mExtras.get(name);
4847 if (result2 != null) {
4848 result = result2;
4849 }
4850 }
4851
4852 return result;
4853 }
4854
4855 /**
4856 * Retrieves a map of extended data from the intent.
4857 *
4858 * @return the map of all extras previously added with putExtra(),
4859 * or null if none have been added.
4860 */
4861 public Bundle getExtras() {
4862 return (mExtras != null)
4863 ? new Bundle(mExtras)
4864 : null;
4865 }
4866
4867 /**
4868 * Retrieve any special flags associated with this intent. You will
4869 * normally just set them with {@link #setFlags} and let the system
4870 * take the appropriate action with them.
4871 *
4872 * @return int The currently set flags.
4873 *
4874 * @see #setFlags
4875 */
4876 public int getFlags() {
4877 return mFlags;
4878 }
4879
Dianne Hackborne7f97212011-02-24 14:40:20 -08004880 /** @hide */
4881 public boolean isExcludingStopped() {
4882 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4883 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4884 }
4885
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004886 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004887 * Retrieve the application package name this Intent is limited to. When
4888 * resolving an Intent, if non-null this limits the resolution to only
4889 * components in the given application package.
4890 *
4891 * @return The name of the application package for the Intent.
4892 *
4893 * @see #resolveActivity
4894 * @see #setPackage
4895 */
4896 public String getPackage() {
4897 return mPackage;
4898 }
4899
4900 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004901 * Retrieve the concrete component associated with the intent. When receiving
4902 * an intent, this is the component that was found to best handle it (that is,
4903 * yourself) and will always be non-null; in all other cases it will be
4904 * null unless explicitly set.
4905 *
4906 * @return The name of the application component to handle the intent.
4907 *
4908 * @see #resolveActivity
4909 * @see #setComponent
4910 */
4911 public ComponentName getComponent() {
4912 return mComponent;
4913 }
4914
4915 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004916 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4917 * used as a hint to the receiver for animations and the like. Null means that there
4918 * is no source bounds.
4919 */
4920 public Rect getSourceBounds() {
4921 return mSourceBounds;
4922 }
4923
4924 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004925 * Return the Activity component that should be used to handle this intent.
4926 * The appropriate component is determined based on the information in the
4927 * intent, evaluated as follows:
4928 *
4929 * <p>If {@link #getComponent} returns an explicit class, that is returned
4930 * without any further consideration.
4931 *
4932 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4933 * category to be considered.
4934 *
4935 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4936 * action.
4937 *
4938 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4939 * this type.
4940 *
4941 * <p>If {@link #addCategory} has added any categories, the activity must
4942 * handle ALL of the categories specified.
4943 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004944 * <p>If {@link #getPackage} is non-NULL, only activity components in
4945 * that application package will be considered.
4946 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004947 * <p>If there are no activities that satisfy all of these conditions, a
4948 * null string is returned.
4949 *
4950 * <p>If multiple activities are found to satisfy the intent, the one with
4951 * the highest priority will be used. If there are multiple activities
4952 * with the same priority, the system will either pick the best activity
4953 * based on user preference, or resolve to a system class that will allow
4954 * the user to pick an activity and forward from there.
4955 *
4956 * <p>This method is implemented simply by calling
4957 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4958 * true.</p>
4959 * <p> This API is called for you as part of starting an activity from an
4960 * intent. You do not normally need to call it yourself.</p>
4961 *
4962 * @param pm The package manager with which to resolve the Intent.
4963 *
4964 * @return Name of the component implementing an activity that can
4965 * display the intent.
4966 *
4967 * @see #setComponent
4968 * @see #getComponent
4969 * @see #resolveActivityInfo
4970 */
4971 public ComponentName resolveActivity(PackageManager pm) {
4972 if (mComponent != null) {
4973 return mComponent;
4974 }
4975
4976 ResolveInfo info = pm.resolveActivity(
4977 this, PackageManager.MATCH_DEFAULT_ONLY);
4978 if (info != null) {
4979 return new ComponentName(
4980 info.activityInfo.applicationInfo.packageName,
4981 info.activityInfo.name);
4982 }
4983
4984 return null;
4985 }
4986
4987 /**
4988 * Resolve the Intent into an {@link ActivityInfo}
4989 * describing the activity that should execute the intent. Resolution
4990 * follows the same rules as described for {@link #resolveActivity}, but
4991 * you get back the completely information about the resolved activity
4992 * instead of just its class name.
4993 *
4994 * @param pm The package manager with which to resolve the Intent.
4995 * @param flags Addition information to retrieve as per
4996 * {@link PackageManager#getActivityInfo(ComponentName, int)
4997 * PackageManager.getActivityInfo()}.
4998 *
4999 * @return PackageManager.ActivityInfo
5000 *
5001 * @see #resolveActivity
5002 */
5003 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5004 ActivityInfo ai = null;
5005 if (mComponent != null) {
5006 try {
5007 ai = pm.getActivityInfo(mComponent, flags);
5008 } catch (PackageManager.NameNotFoundException e) {
5009 // ignore
5010 }
5011 } else {
5012 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005013 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005014 if (info != null) {
5015 ai = info.activityInfo;
5016 }
5017 }
5018
5019 return ai;
5020 }
5021
5022 /**
5023 * Set the general action to be performed.
5024 *
5025 * @param action An action name, such as ACTION_VIEW. Application-specific
5026 * actions should be prefixed with the vendor's package name.
5027 *
5028 * @return Returns the same Intent object, for chaining multiple calls
5029 * into a single statement.
5030 *
5031 * @see #getAction
5032 */
5033 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005034 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005035 return this;
5036 }
5037
5038 /**
5039 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005040 * clears any type that was previously set by {@link #setType} or
5041 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005042 *
Nick Pellyccae4122012-01-09 14:12:58 -08005043 * <p><em>Note: scheme matching in the Android framework is
5044 * case-sensitive, unlike the formal RFC. As a result,
5045 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005046 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005047 * {@link #setDataAndNormalize}
5048 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005049 *
Nick Pellyccae4122012-01-09 14:12:58 -08005050 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005051 *
5052 * @return Returns the same Intent object, for chaining multiple calls
5053 * into a single statement.
5054 *
5055 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005056 * @see #setDataAndNormalize
5057 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005058 */
5059 public Intent setData(Uri data) {
5060 mData = data;
5061 mType = null;
5062 return this;
5063 }
5064
5065 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005066 * Normalize and set the data this intent is operating on.
5067 *
5068 * <p>This method automatically clears any type that was
5069 * previously set (for example, by {@link #setType}).
5070 *
5071 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005072 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005073 * so really this is just a convenience method for
5074 * <pre>
5075 * setData(data.normalize())
5076 * </pre>
5077 *
5078 * @param data The Uri of the data this intent is now targeting.
5079 *
5080 * @return Returns the same Intent object, for chaining multiple calls
5081 * into a single statement.
5082 *
5083 * @see #getData
5084 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005085 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005086 */
5087 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005088 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005089 }
5090
5091 /**
5092 * Set an explicit MIME data type.
5093 *
5094 * <p>This is used to create intents that only specify a type and not data,
5095 * for example to indicate the type of data to return.
5096 *
5097 * <p>This method automatically clears any data that was
5098 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005099 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005100 * <p><em>Note: MIME type matching in the Android framework is
5101 * case-sensitive, unlike formal RFC MIME types. As a result,
5102 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005103 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5104 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005105 *
5106 * @param type The MIME type of the data being handled by this intent.
5107 *
5108 * @return Returns the same Intent object, for chaining multiple calls
5109 * into a single statement.
5110 *
5111 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005112 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005113 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005114 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005115 */
5116 public Intent setType(String type) {
5117 mData = null;
5118 mType = type;
5119 return this;
5120 }
5121
5122 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005123 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005124 *
Nick Pellyccae4122012-01-09 14:12:58 -08005125 * <p>This is used to create intents that only specify a type and not data,
5126 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005127 *
Nick Pellyccae4122012-01-09 14:12:58 -08005128 * <p>This method automatically clears any data that was
5129 * previously set (for example by {@link #setData}).
5130 *
5131 * <p>The MIME type is normalized using
5132 * {@link #normalizeMimeType} before it is set,
5133 * so really this is just a convenience method for
5134 * <pre>
5135 * setType(Intent.normalizeMimeType(type))
5136 * </pre>
5137 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005138 * @param type The MIME type of the data being handled by this intent.
5139 *
5140 * @return Returns the same Intent object, for chaining multiple calls
5141 * into a single statement.
5142 *
Nick Pellyccae4122012-01-09 14:12:58 -08005143 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005144 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005145 * @see #normalizeMimeType
5146 */
5147 public Intent setTypeAndNormalize(String type) {
5148 return setType(normalizeMimeType(type));
5149 }
5150
5151 /**
5152 * (Usually optional) Set the data for the intent along with an explicit
5153 * MIME data type. This method should very rarely be used -- it allows you
5154 * to override the MIME type that would ordinarily be inferred from the
5155 * data with your own type given here.
5156 *
5157 * <p><em>Note: MIME type and Uri scheme matching in the
5158 * Android framework is case-sensitive, unlike the formal RFC definitions.
5159 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005160 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005161 * {@link #setDataAndTypeAndNormalize}
5162 * to ensure that they are converted to lower case.</em>
5163 *
5164 * @param data The Uri of the data this intent is now targeting.
5165 * @param type The MIME type of the data being handled by this intent.
5166 *
5167 * @return Returns the same Intent object, for chaining multiple calls
5168 * into a single statement.
5169 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005170 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005171 * @see #setData
5172 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005173 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005174 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005175 */
5176 public Intent setDataAndType(Uri data, String type) {
5177 mData = data;
5178 mType = type;
5179 return this;
5180 }
5181
5182 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005183 * (Usually optional) Normalize and set both the data Uri and an explicit
5184 * MIME data type. This method should very rarely be used -- it allows you
5185 * to override the MIME type that would ordinarily be inferred from the
5186 * data with your own type given here.
5187 *
5188 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005189 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005190 * before they are set, so really this is just a convenience method for
5191 * <pre>
5192 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5193 * </pre>
5194 *
5195 * @param data The Uri of the data this intent is now targeting.
5196 * @param type The MIME type of the data being handled by this intent.
5197 *
5198 * @return Returns the same Intent object, for chaining multiple calls
5199 * into a single statement.
5200 *
5201 * @see #setType
5202 * @see #setData
5203 * @see #setDataAndType
5204 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005205 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005206 */
5207 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005208 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005209 }
5210
5211 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005212 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005213 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005214 * activities that provide <em>all</em> of the requested categories will be
5215 * used.
5216 *
5217 * @param category The desired category. This can be either one of the
5218 * predefined Intent categories, or a custom category in your own
5219 * namespace.
5220 *
5221 * @return Returns the same Intent object, for chaining multiple calls
5222 * into a single statement.
5223 *
5224 * @see #hasCategory
5225 * @see #removeCategory
5226 */
5227 public Intent addCategory(String category) {
5228 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005229 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005230 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005231 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005232 return this;
5233 }
5234
5235 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005236 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005237 *
5238 * @param category The category to remove.
5239 *
5240 * @see #addCategory
5241 */
5242 public void removeCategory(String category) {
5243 if (mCategories != null) {
5244 mCategories.remove(category);
5245 if (mCategories.size() == 0) {
5246 mCategories = null;
5247 }
5248 }
5249 }
5250
5251 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005252 * Set a selector for this Intent. This is a modification to the kinds of
5253 * things the Intent will match. If the selector is set, it will be used
5254 * when trying to find entities that can handle the Intent, instead of the
5255 * main contents of the Intent. This allows you build an Intent containing
5256 * a generic protocol while targeting it more specifically.
5257 *
5258 * <p>An example of where this may be used is with things like
5259 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5260 * Intent that will launch the Browser application. However, the correct
5261 * main entry point of an application is actually {@link #ACTION_MAIN}
5262 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5263 * used to specify the actual Activity to launch. If you launch the browser
5264 * with something different, undesired behavior may happen if the user has
5265 * previously or later launches it the normal way, since they do not match.
5266 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5267 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5268 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5269 *
5270 * <p>Setting a selector does not impact the behavior of
5271 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5272 * desired behavior of a selector -- it does not impact the base meaning
5273 * of the Intent, just what kinds of things will be matched against it
5274 * when determining who can handle it.</p>
5275 *
5276 * <p>You can not use both a selector and {@link #setPackage(String)} on
5277 * the same base Intent.</p>
5278 *
5279 * @param selector The desired selector Intent; set to null to not use
5280 * a special selector.
5281 */
5282 public void setSelector(Intent selector) {
5283 if (selector == this) {
5284 throw new IllegalArgumentException(
5285 "Intent being set as a selector of itself");
5286 }
5287 if (selector != null && mPackage != null) {
5288 throw new IllegalArgumentException(
5289 "Can't set selector when package name is already set");
5290 }
5291 mSelector = selector;
5292 }
5293
5294 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005295 * Set a {@link ClipData} associated with this Intent. This replaces any
5296 * previously set ClipData.
5297 *
5298 * <p>The ClipData in an intent is not used for Intent matching or other
5299 * such operations. Semantically it is like extras, used to transmit
5300 * additional data with the Intent. The main feature of using this over
5301 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5302 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5303 * items included in the clip data. This is useful, in particular, if
5304 * you want to transmit an Intent containing multiple <code>content:</code>
5305 * URIs for which the recipient may not have global permission to access the
5306 * content provider.
5307 *
5308 * <p>If the ClipData contains items that are themselves Intents, any
5309 * grant flags in those Intents will be ignored. Only the top-level flags
5310 * of the main Intent are respected, and will be applied to all Uri or
5311 * Intent items in the clip (or sub-items of the clip).
5312 *
5313 * <p>The MIME type, label, and icon in the ClipData object are not
5314 * directly used by Intent. Applications should generally rely on the
5315 * MIME type of the Intent itself, not what it may find in the ClipData.
5316 * A common practice is to construct a ClipData for use with an Intent
5317 * with a MIME type of "*\/*".
5318 *
5319 * @param clip The new clip to set. May be null to clear the current clip.
5320 */
5321 public void setClipData(ClipData clip) {
5322 mClipData = clip;
5323 }
5324
5325 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005326 * Add extended data to the intent. The name must include a package
5327 * prefix, for example the app com.android.contacts would use names
5328 * like "com.android.contacts.ShowAll".
5329 *
5330 * @param name The name of the extra data, with package prefix.
5331 * @param value The boolean data value.
5332 *
5333 * @return Returns the same Intent object, for chaining multiple calls
5334 * into a single statement.
5335 *
5336 * @see #putExtras
5337 * @see #removeExtra
5338 * @see #getBooleanExtra(String, boolean)
5339 */
5340 public Intent putExtra(String name, boolean value) {
5341 if (mExtras == null) {
5342 mExtras = new Bundle();
5343 }
5344 mExtras.putBoolean(name, value);
5345 return this;
5346 }
5347
5348 /**
5349 * Add extended data to the intent. The name must include a package
5350 * prefix, for example the app com.android.contacts would use names
5351 * like "com.android.contacts.ShowAll".
5352 *
5353 * @param name The name of the extra data, with package prefix.
5354 * @param value The byte data value.
5355 *
5356 * @return Returns the same Intent object, for chaining multiple calls
5357 * into a single statement.
5358 *
5359 * @see #putExtras
5360 * @see #removeExtra
5361 * @see #getByteExtra(String, byte)
5362 */
5363 public Intent putExtra(String name, byte value) {
5364 if (mExtras == null) {
5365 mExtras = new Bundle();
5366 }
5367 mExtras.putByte(name, value);
5368 return this;
5369 }
5370
5371 /**
5372 * Add extended data to the intent. The name must include a package
5373 * prefix, for example the app com.android.contacts would use names
5374 * like "com.android.contacts.ShowAll".
5375 *
5376 * @param name The name of the extra data, with package prefix.
5377 * @param value The char data value.
5378 *
5379 * @return Returns the same Intent object, for chaining multiple calls
5380 * into a single statement.
5381 *
5382 * @see #putExtras
5383 * @see #removeExtra
5384 * @see #getCharExtra(String, char)
5385 */
5386 public Intent putExtra(String name, char value) {
5387 if (mExtras == null) {
5388 mExtras = new Bundle();
5389 }
5390 mExtras.putChar(name, value);
5391 return this;
5392 }
5393
5394 /**
5395 * Add extended data to the intent. The name must include a package
5396 * prefix, for example the app com.android.contacts would use names
5397 * like "com.android.contacts.ShowAll".
5398 *
5399 * @param name The name of the extra data, with package prefix.
5400 * @param value The short data value.
5401 *
5402 * @return Returns the same Intent object, for chaining multiple calls
5403 * into a single statement.
5404 *
5405 * @see #putExtras
5406 * @see #removeExtra
5407 * @see #getShortExtra(String, short)
5408 */
5409 public Intent putExtra(String name, short value) {
5410 if (mExtras == null) {
5411 mExtras = new Bundle();
5412 }
5413 mExtras.putShort(name, value);
5414 return this;
5415 }
5416
5417 /**
5418 * Add extended data to the intent. The name must include a package
5419 * prefix, for example the app com.android.contacts would use names
5420 * like "com.android.contacts.ShowAll".
5421 *
5422 * @param name The name of the extra data, with package prefix.
5423 * @param value The integer data value.
5424 *
5425 * @return Returns the same Intent object, for chaining multiple calls
5426 * into a single statement.
5427 *
5428 * @see #putExtras
5429 * @see #removeExtra
5430 * @see #getIntExtra(String, int)
5431 */
5432 public Intent putExtra(String name, int value) {
5433 if (mExtras == null) {
5434 mExtras = new Bundle();
5435 }
5436 mExtras.putInt(name, value);
5437 return this;
5438 }
5439
5440 /**
5441 * Add extended data to the intent. The name must include a package
5442 * prefix, for example the app com.android.contacts would use names
5443 * like "com.android.contacts.ShowAll".
5444 *
5445 * @param name The name of the extra data, with package prefix.
5446 * @param value The long data value.
5447 *
5448 * @return Returns the same Intent object, for chaining multiple calls
5449 * into a single statement.
5450 *
5451 * @see #putExtras
5452 * @see #removeExtra
5453 * @see #getLongExtra(String, long)
5454 */
5455 public Intent putExtra(String name, long value) {
5456 if (mExtras == null) {
5457 mExtras = new Bundle();
5458 }
5459 mExtras.putLong(name, value);
5460 return this;
5461 }
5462
5463 /**
5464 * Add extended data to the intent. The name must include a package
5465 * prefix, for example the app com.android.contacts would use names
5466 * like "com.android.contacts.ShowAll".
5467 *
5468 * @param name The name of the extra data, with package prefix.
5469 * @param value The float data value.
5470 *
5471 * @return Returns the same Intent object, for chaining multiple calls
5472 * into a single statement.
5473 *
5474 * @see #putExtras
5475 * @see #removeExtra
5476 * @see #getFloatExtra(String, float)
5477 */
5478 public Intent putExtra(String name, float value) {
5479 if (mExtras == null) {
5480 mExtras = new Bundle();
5481 }
5482 mExtras.putFloat(name, value);
5483 return this;
5484 }
5485
5486 /**
5487 * Add extended data to the intent. The name must include a package
5488 * prefix, for example the app com.android.contacts would use names
5489 * like "com.android.contacts.ShowAll".
5490 *
5491 * @param name The name of the extra data, with package prefix.
5492 * @param value The double data value.
5493 *
5494 * @return Returns the same Intent object, for chaining multiple calls
5495 * into a single statement.
5496 *
5497 * @see #putExtras
5498 * @see #removeExtra
5499 * @see #getDoubleExtra(String, double)
5500 */
5501 public Intent putExtra(String name, double value) {
5502 if (mExtras == null) {
5503 mExtras = new Bundle();
5504 }
5505 mExtras.putDouble(name, value);
5506 return this;
5507 }
5508
5509 /**
5510 * Add extended data to the intent. The name must include a package
5511 * prefix, for example the app com.android.contacts would use names
5512 * like "com.android.contacts.ShowAll".
5513 *
5514 * @param name The name of the extra data, with package prefix.
5515 * @param value The String data value.
5516 *
5517 * @return Returns the same Intent object, for chaining multiple calls
5518 * into a single statement.
5519 *
5520 * @see #putExtras
5521 * @see #removeExtra
5522 * @see #getStringExtra(String)
5523 */
5524 public Intent putExtra(String name, String value) {
5525 if (mExtras == null) {
5526 mExtras = new Bundle();
5527 }
5528 mExtras.putString(name, value);
5529 return this;
5530 }
5531
5532 /**
5533 * Add extended data to the intent. The name must include a package
5534 * prefix, for example the app com.android.contacts would use names
5535 * like "com.android.contacts.ShowAll".
5536 *
5537 * @param name The name of the extra data, with package prefix.
5538 * @param value The CharSequence data value.
5539 *
5540 * @return Returns the same Intent object, for chaining multiple calls
5541 * into a single statement.
5542 *
5543 * @see #putExtras
5544 * @see #removeExtra
5545 * @see #getCharSequenceExtra(String)
5546 */
5547 public Intent putExtra(String name, CharSequence value) {
5548 if (mExtras == null) {
5549 mExtras = new Bundle();
5550 }
5551 mExtras.putCharSequence(name, value);
5552 return this;
5553 }
5554
5555 /**
5556 * Add extended data to the intent. The name must include a package
5557 * prefix, for example the app com.android.contacts would use names
5558 * like "com.android.contacts.ShowAll".
5559 *
5560 * @param name The name of the extra data, with package prefix.
5561 * @param value The Parcelable data value.
5562 *
5563 * @return Returns the same Intent object, for chaining multiple calls
5564 * into a single statement.
5565 *
5566 * @see #putExtras
5567 * @see #removeExtra
5568 * @see #getParcelableExtra(String)
5569 */
5570 public Intent putExtra(String name, Parcelable value) {
5571 if (mExtras == null) {
5572 mExtras = new Bundle();
5573 }
5574 mExtras.putParcelable(name, value);
5575 return this;
5576 }
5577
5578 /**
5579 * Add extended data to the intent. The name must include a package
5580 * prefix, for example the app com.android.contacts would use names
5581 * like "com.android.contacts.ShowAll".
5582 *
5583 * @param name The name of the extra data, with package prefix.
5584 * @param value The Parcelable[] data value.
5585 *
5586 * @return Returns the same Intent object, for chaining multiple calls
5587 * into a single statement.
5588 *
5589 * @see #putExtras
5590 * @see #removeExtra
5591 * @see #getParcelableArrayExtra(String)
5592 */
5593 public Intent putExtra(String name, Parcelable[] value) {
5594 if (mExtras == null) {
5595 mExtras = new Bundle();
5596 }
5597 mExtras.putParcelableArray(name, value);
5598 return this;
5599 }
5600
5601 /**
5602 * Add extended data to the intent. The name must include a package
5603 * prefix, for example the app com.android.contacts would use names
5604 * like "com.android.contacts.ShowAll".
5605 *
5606 * @param name The name of the extra data, with package prefix.
5607 * @param value The ArrayList<Parcelable> data value.
5608 *
5609 * @return Returns the same Intent object, for chaining multiple calls
5610 * into a single statement.
5611 *
5612 * @see #putExtras
5613 * @see #removeExtra
5614 * @see #getParcelableArrayListExtra(String)
5615 */
5616 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5617 if (mExtras == null) {
5618 mExtras = new Bundle();
5619 }
5620 mExtras.putParcelableArrayList(name, value);
5621 return this;
5622 }
5623
5624 /**
5625 * Add extended data to the intent. The name must include a package
5626 * prefix, for example the app com.android.contacts would use names
5627 * like "com.android.contacts.ShowAll".
5628 *
5629 * @param name The name of the extra data, with package prefix.
5630 * @param value The ArrayList<Integer> data value.
5631 *
5632 * @return Returns the same Intent object, for chaining multiple calls
5633 * into a single statement.
5634 *
5635 * @see #putExtras
5636 * @see #removeExtra
5637 * @see #getIntegerArrayListExtra(String)
5638 */
5639 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5640 if (mExtras == null) {
5641 mExtras = new Bundle();
5642 }
5643 mExtras.putIntegerArrayList(name, value);
5644 return this;
5645 }
5646
5647 /**
5648 * Add extended data to the intent. The name must include a package
5649 * prefix, for example the app com.android.contacts would use names
5650 * like "com.android.contacts.ShowAll".
5651 *
5652 * @param name The name of the extra data, with package prefix.
5653 * @param value The ArrayList<String> data value.
5654 *
5655 * @return Returns the same Intent object, for chaining multiple calls
5656 * into a single statement.
5657 *
5658 * @see #putExtras
5659 * @see #removeExtra
5660 * @see #getStringArrayListExtra(String)
5661 */
5662 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5663 if (mExtras == null) {
5664 mExtras = new Bundle();
5665 }
5666 mExtras.putStringArrayList(name, value);
5667 return this;
5668 }
5669
5670 /**
5671 * Add extended data to the intent. The name must include a package
5672 * prefix, for example the app com.android.contacts would use names
5673 * like "com.android.contacts.ShowAll".
5674 *
5675 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005676 * @param value The ArrayList<CharSequence> data value.
5677 *
5678 * @return Returns the same Intent object, for chaining multiple calls
5679 * into a single statement.
5680 *
5681 * @see #putExtras
5682 * @see #removeExtra
5683 * @see #getCharSequenceArrayListExtra(String)
5684 */
5685 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5686 if (mExtras == null) {
5687 mExtras = new Bundle();
5688 }
5689 mExtras.putCharSequenceArrayList(name, value);
5690 return this;
5691 }
5692
5693 /**
5694 * Add extended data to the intent. The name must include a package
5695 * prefix, for example the app com.android.contacts would use names
5696 * like "com.android.contacts.ShowAll".
5697 *
5698 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005699 * @param value The Serializable data value.
5700 *
5701 * @return Returns the same Intent object, for chaining multiple calls
5702 * into a single statement.
5703 *
5704 * @see #putExtras
5705 * @see #removeExtra
5706 * @see #getSerializableExtra(String)
5707 */
5708 public Intent putExtra(String name, Serializable value) {
5709 if (mExtras == null) {
5710 mExtras = new Bundle();
5711 }
5712 mExtras.putSerializable(name, value);
5713 return this;
5714 }
5715
5716 /**
5717 * Add extended data to the intent. The name must include a package
5718 * prefix, for example the app com.android.contacts would use names
5719 * like "com.android.contacts.ShowAll".
5720 *
5721 * @param name The name of the extra data, with package prefix.
5722 * @param value The boolean array data value.
5723 *
5724 * @return Returns the same Intent object, for chaining multiple calls
5725 * into a single statement.
5726 *
5727 * @see #putExtras
5728 * @see #removeExtra
5729 * @see #getBooleanArrayExtra(String)
5730 */
5731 public Intent putExtra(String name, boolean[] value) {
5732 if (mExtras == null) {
5733 mExtras = new Bundle();
5734 }
5735 mExtras.putBooleanArray(name, value);
5736 return this;
5737 }
5738
5739 /**
5740 * Add extended data to the intent. The name must include a package
5741 * prefix, for example the app com.android.contacts would use names
5742 * like "com.android.contacts.ShowAll".
5743 *
5744 * @param name The name of the extra data, with package prefix.
5745 * @param value The byte array data value.
5746 *
5747 * @return Returns the same Intent object, for chaining multiple calls
5748 * into a single statement.
5749 *
5750 * @see #putExtras
5751 * @see #removeExtra
5752 * @see #getByteArrayExtra(String)
5753 */
5754 public Intent putExtra(String name, byte[] value) {
5755 if (mExtras == null) {
5756 mExtras = new Bundle();
5757 }
5758 mExtras.putByteArray(name, value);
5759 return this;
5760 }
5761
5762 /**
5763 * Add extended data to the intent. The name must include a package
5764 * prefix, for example the app com.android.contacts would use names
5765 * like "com.android.contacts.ShowAll".
5766 *
5767 * @param name The name of the extra data, with package prefix.
5768 * @param value The short array data value.
5769 *
5770 * @return Returns the same Intent object, for chaining multiple calls
5771 * into a single statement.
5772 *
5773 * @see #putExtras
5774 * @see #removeExtra
5775 * @see #getShortArrayExtra(String)
5776 */
5777 public Intent putExtra(String name, short[] value) {
5778 if (mExtras == null) {
5779 mExtras = new Bundle();
5780 }
5781 mExtras.putShortArray(name, value);
5782 return this;
5783 }
5784
5785 /**
5786 * Add extended data to the intent. The name must include a package
5787 * prefix, for example the app com.android.contacts would use names
5788 * like "com.android.contacts.ShowAll".
5789 *
5790 * @param name The name of the extra data, with package prefix.
5791 * @param value The char array data value.
5792 *
5793 * @return Returns the same Intent object, for chaining multiple calls
5794 * into a single statement.
5795 *
5796 * @see #putExtras
5797 * @see #removeExtra
5798 * @see #getCharArrayExtra(String)
5799 */
5800 public Intent putExtra(String name, char[] value) {
5801 if (mExtras == null) {
5802 mExtras = new Bundle();
5803 }
5804 mExtras.putCharArray(name, value);
5805 return this;
5806 }
5807
5808 /**
5809 * Add extended data to the intent. The name must include a package
5810 * prefix, for example the app com.android.contacts would use names
5811 * like "com.android.contacts.ShowAll".
5812 *
5813 * @param name The name of the extra data, with package prefix.
5814 * @param value The int array data value.
5815 *
5816 * @return Returns the same Intent object, for chaining multiple calls
5817 * into a single statement.
5818 *
5819 * @see #putExtras
5820 * @see #removeExtra
5821 * @see #getIntArrayExtra(String)
5822 */
5823 public Intent putExtra(String name, int[] value) {
5824 if (mExtras == null) {
5825 mExtras = new Bundle();
5826 }
5827 mExtras.putIntArray(name, value);
5828 return this;
5829 }
5830
5831 /**
5832 * Add extended data to the intent. The name must include a package
5833 * prefix, for example the app com.android.contacts would use names
5834 * like "com.android.contacts.ShowAll".
5835 *
5836 * @param name The name of the extra data, with package prefix.
5837 * @param value The byte array data value.
5838 *
5839 * @return Returns the same Intent object, for chaining multiple calls
5840 * into a single statement.
5841 *
5842 * @see #putExtras
5843 * @see #removeExtra
5844 * @see #getLongArrayExtra(String)
5845 */
5846 public Intent putExtra(String name, long[] value) {
5847 if (mExtras == null) {
5848 mExtras = new Bundle();
5849 }
5850 mExtras.putLongArray(name, value);
5851 return this;
5852 }
5853
5854 /**
5855 * Add extended data to the intent. The name must include a package
5856 * prefix, for example the app com.android.contacts would use names
5857 * like "com.android.contacts.ShowAll".
5858 *
5859 * @param name The name of the extra data, with package prefix.
5860 * @param value The float array data value.
5861 *
5862 * @return Returns the same Intent object, for chaining multiple calls
5863 * into a single statement.
5864 *
5865 * @see #putExtras
5866 * @see #removeExtra
5867 * @see #getFloatArrayExtra(String)
5868 */
5869 public Intent putExtra(String name, float[] value) {
5870 if (mExtras == null) {
5871 mExtras = new Bundle();
5872 }
5873 mExtras.putFloatArray(name, value);
5874 return this;
5875 }
5876
5877 /**
5878 * Add extended data to the intent. The name must include a package
5879 * prefix, for example the app com.android.contacts would use names
5880 * like "com.android.contacts.ShowAll".
5881 *
5882 * @param name The name of the extra data, with package prefix.
5883 * @param value The double array data value.
5884 *
5885 * @return Returns the same Intent object, for chaining multiple calls
5886 * into a single statement.
5887 *
5888 * @see #putExtras
5889 * @see #removeExtra
5890 * @see #getDoubleArrayExtra(String)
5891 */
5892 public Intent putExtra(String name, double[] value) {
5893 if (mExtras == null) {
5894 mExtras = new Bundle();
5895 }
5896 mExtras.putDoubleArray(name, value);
5897 return this;
5898 }
5899
5900 /**
5901 * Add extended data to the intent. The name must include a package
5902 * prefix, for example the app com.android.contacts would use names
5903 * like "com.android.contacts.ShowAll".
5904 *
5905 * @param name The name of the extra data, with package prefix.
5906 * @param value The String array data value.
5907 *
5908 * @return Returns the same Intent object, for chaining multiple calls
5909 * into a single statement.
5910 *
5911 * @see #putExtras
5912 * @see #removeExtra
5913 * @see #getStringArrayExtra(String)
5914 */
5915 public Intent putExtra(String name, String[] value) {
5916 if (mExtras == null) {
5917 mExtras = new Bundle();
5918 }
5919 mExtras.putStringArray(name, value);
5920 return this;
5921 }
5922
5923 /**
5924 * Add extended data to the intent. The name must include a package
5925 * prefix, for example the app com.android.contacts would use names
5926 * like "com.android.contacts.ShowAll".
5927 *
5928 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005929 * @param value The CharSequence array data value.
5930 *
5931 * @return Returns the same Intent object, for chaining multiple calls
5932 * into a single statement.
5933 *
5934 * @see #putExtras
5935 * @see #removeExtra
5936 * @see #getCharSequenceArrayExtra(String)
5937 */
5938 public Intent putExtra(String name, CharSequence[] value) {
5939 if (mExtras == null) {
5940 mExtras = new Bundle();
5941 }
5942 mExtras.putCharSequenceArray(name, value);
5943 return this;
5944 }
5945
5946 /**
5947 * Add extended data to the intent. The name must include a package
5948 * prefix, for example the app com.android.contacts would use names
5949 * like "com.android.contacts.ShowAll".
5950 *
5951 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005952 * @param value The Bundle data value.
5953 *
5954 * @return Returns the same Intent object, for chaining multiple calls
5955 * into a single statement.
5956 *
5957 * @see #putExtras
5958 * @see #removeExtra
5959 * @see #getBundleExtra(String)
5960 */
5961 public Intent putExtra(String name, Bundle value) {
5962 if (mExtras == null) {
5963 mExtras = new Bundle();
5964 }
5965 mExtras.putBundle(name, value);
5966 return this;
5967 }
5968
5969 /**
5970 * Add extended data to the intent. The name must include a package
5971 * prefix, for example the app com.android.contacts would use names
5972 * like "com.android.contacts.ShowAll".
5973 *
5974 * @param name The name of the extra data, with package prefix.
5975 * @param value The IBinder data value.
5976 *
5977 * @return Returns the same Intent object, for chaining multiple calls
5978 * into a single statement.
5979 *
5980 * @see #putExtras
5981 * @see #removeExtra
5982 * @see #getIBinderExtra(String)
5983 *
5984 * @deprecated
5985 * @hide
5986 */
5987 @Deprecated
5988 public Intent putExtra(String name, IBinder value) {
5989 if (mExtras == null) {
5990 mExtras = new Bundle();
5991 }
5992 mExtras.putIBinder(name, value);
5993 return this;
5994 }
5995
5996 /**
5997 * Copy all extras in 'src' in to this intent.
5998 *
5999 * @param src Contains the extras to copy.
6000 *
6001 * @see #putExtra
6002 */
6003 public Intent putExtras(Intent src) {
6004 if (src.mExtras != null) {
6005 if (mExtras == null) {
6006 mExtras = new Bundle(src.mExtras);
6007 } else {
6008 mExtras.putAll(src.mExtras);
6009 }
6010 }
6011 return this;
6012 }
6013
6014 /**
6015 * Add a set of extended data to the intent. The keys must include a package
6016 * prefix, for example the app com.android.contacts would use names
6017 * like "com.android.contacts.ShowAll".
6018 *
6019 * @param extras The Bundle of extras to add to this intent.
6020 *
6021 * @see #putExtra
6022 * @see #removeExtra
6023 */
6024 public Intent putExtras(Bundle extras) {
6025 if (mExtras == null) {
6026 mExtras = new Bundle();
6027 }
6028 mExtras.putAll(extras);
6029 return this;
6030 }
6031
6032 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006033 * Completely replace the extras in the Intent with the extras in the
6034 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006035 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006036 * @param src The exact extras contained in this Intent are copied
6037 * into the target intent, replacing any that were previously there.
6038 */
6039 public Intent replaceExtras(Intent src) {
6040 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6041 return this;
6042 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006043
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006044 /**
6045 * Completely replace the extras in the Intent with the given Bundle of
6046 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006047 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006048 * @param extras The new set of extras in the Intent, or null to erase
6049 * all extras.
6050 */
6051 public Intent replaceExtras(Bundle extras) {
6052 mExtras = extras != null ? new Bundle(extras) : null;
6053 return this;
6054 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006055
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006056 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006057 * Remove extended data from the intent.
6058 *
6059 * @see #putExtra
6060 */
6061 public void removeExtra(String name) {
6062 if (mExtras != null) {
6063 mExtras.remove(name);
6064 if (mExtras.size() == 0) {
6065 mExtras = null;
6066 }
6067 }
6068 }
6069
6070 /**
6071 * Set special flags controlling how this intent is handled. Most values
6072 * here depend on the type of component being executed by the Intent,
6073 * specifically the FLAG_ACTIVITY_* flags are all for use with
6074 * {@link Context#startActivity Context.startActivity()} and the
6075 * FLAG_RECEIVER_* flags are all for use with
6076 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6077 *
Scott Main7aee61f2011-02-08 11:25:01 -08006078 * <p>See the
6079 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6080 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006081 * the behavior of your application.
6082 *
6083 * @param flags The desired flags.
6084 *
6085 * @return Returns the same Intent object, for chaining multiple calls
6086 * into a single statement.
6087 *
6088 * @see #getFlags
6089 * @see #addFlags
6090 *
6091 * @see #FLAG_GRANT_READ_URI_PERMISSION
6092 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6093 * @see #FLAG_DEBUG_LOG_RESOLUTION
6094 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006095 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006096 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006097 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006098 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006099 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6100 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006101 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006102 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6103 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006104 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006105 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006106 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006107 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6108 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006109 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006110 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006111 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006112 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6113 */
6114 public Intent setFlags(int flags) {
6115 mFlags = flags;
6116 return this;
6117 }
6118
6119 /**
6120 * Add additional flags to the intent (or with existing flags
6121 * value).
6122 *
6123 * @param flags The new flags to set.
6124 *
6125 * @return Returns the same Intent object, for chaining multiple calls
6126 * into a single statement.
6127 *
6128 * @see #setFlags
6129 */
6130 public Intent addFlags(int flags) {
6131 mFlags |= flags;
6132 return this;
6133 }
6134
6135 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006136 * (Usually optional) Set an explicit application package name that limits
6137 * the components this Intent will resolve to. If left to the default
6138 * value of null, all components in all applications will considered.
6139 * If non-null, the Intent can only match the components in the given
6140 * application package.
6141 *
6142 * @param packageName The name of the application package to handle the
6143 * intent, or null to allow any application package.
6144 *
6145 * @return Returns the same Intent object, for chaining multiple calls
6146 * into a single statement.
6147 *
6148 * @see #getPackage
6149 * @see #resolveActivity
6150 */
6151 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006152 if (packageName != null && mSelector != null) {
6153 throw new IllegalArgumentException(
6154 "Can't set package name when selector is already set");
6155 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006156 mPackage = packageName;
6157 return this;
6158 }
6159
6160 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006161 * (Usually optional) Explicitly set the component to handle the intent.
6162 * If left with the default value of null, the system will determine the
6163 * appropriate class to use based on the other fields (action, data,
6164 * type, categories) in the Intent. If this class is defined, the
6165 * specified class will always be used regardless of the other fields. You
6166 * should only set this value when you know you absolutely want a specific
6167 * class to be used; otherwise it is better to let the system find the
6168 * appropriate class so that you will respect the installed applications
6169 * and user preferences.
6170 *
6171 * @param component The name of the application component to handle the
6172 * intent, or null to let the system find one for you.
6173 *
6174 * @return Returns the same Intent object, for chaining multiple calls
6175 * into a single statement.
6176 *
6177 * @see #setClass
6178 * @see #setClassName(Context, String)
6179 * @see #setClassName(String, String)
6180 * @see #getComponent
6181 * @see #resolveActivity
6182 */
6183 public Intent setComponent(ComponentName component) {
6184 mComponent = component;
6185 return this;
6186 }
6187
6188 /**
6189 * Convenience for calling {@link #setComponent} with an
6190 * explicit class name.
6191 *
6192 * @param packageContext A Context of the application package implementing
6193 * this class.
6194 * @param className The name of a class inside of the application package
6195 * that will be used as the component for this Intent.
6196 *
6197 * @return Returns the same Intent object, for chaining multiple calls
6198 * into a single statement.
6199 *
6200 * @see #setComponent
6201 * @see #setClass
6202 */
6203 public Intent setClassName(Context packageContext, String className) {
6204 mComponent = new ComponentName(packageContext, className);
6205 return this;
6206 }
6207
6208 /**
6209 * Convenience for calling {@link #setComponent} with an
6210 * explicit application package name and class name.
6211 *
6212 * @param packageName The name of the package implementing the desired
6213 * component.
6214 * @param className The name of a class inside of the application package
6215 * that will be used as the component for this Intent.
6216 *
6217 * @return Returns the same Intent object, for chaining multiple calls
6218 * into a single statement.
6219 *
6220 * @see #setComponent
6221 * @see #setClass
6222 */
6223 public Intent setClassName(String packageName, String className) {
6224 mComponent = new ComponentName(packageName, className);
6225 return this;
6226 }
6227
6228 /**
6229 * Convenience for calling {@link #setComponent(ComponentName)} with the
6230 * name returned by a {@link Class} object.
6231 *
6232 * @param packageContext A Context of the application package implementing
6233 * this class.
6234 * @param cls The class name to set, equivalent to
6235 * <code>setClassName(context, cls.getName())</code>.
6236 *
6237 * @return Returns the same Intent object, for chaining multiple calls
6238 * into a single statement.
6239 *
6240 * @see #setComponent
6241 */
6242 public Intent setClass(Context packageContext, Class<?> cls) {
6243 mComponent = new ComponentName(packageContext, cls);
6244 return this;
6245 }
6246
6247 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006248 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6249 * used as a hint to the receiver for animations and the like. Null means that there
6250 * is no source bounds.
6251 */
6252 public void setSourceBounds(Rect r) {
6253 if (r != null) {
6254 mSourceBounds = new Rect(r);
6255 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006256 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006257 }
6258 }
6259
6260 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006261 * Use with {@link #fillIn} to allow the current action value to be
6262 * overwritten, even if it is already set.
6263 */
6264 public static final int FILL_IN_ACTION = 1<<0;
6265
6266 /**
6267 * Use with {@link #fillIn} to allow the current data or type value
6268 * overwritten, even if it is already set.
6269 */
6270 public static final int FILL_IN_DATA = 1<<1;
6271
6272 /**
6273 * Use with {@link #fillIn} to allow the current categories to be
6274 * overwritten, even if they are already set.
6275 */
6276 public static final int FILL_IN_CATEGORIES = 1<<2;
6277
6278 /**
6279 * Use with {@link #fillIn} to allow the current component value to be
6280 * overwritten, even if it is already set.
6281 */
6282 public static final int FILL_IN_COMPONENT = 1<<3;
6283
6284 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006285 * Use with {@link #fillIn} to allow the current package value to be
6286 * overwritten, even if it is already set.
6287 */
6288 public static final int FILL_IN_PACKAGE = 1<<4;
6289
6290 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006291 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006292 * overwritten, even if it is already set.
6293 */
6294 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6295
6296 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006297 * Use with {@link #fillIn} to allow the current selector to be
6298 * overwritten, even if it is already set.
6299 */
6300 public static final int FILL_IN_SELECTOR = 1<<6;
6301
6302 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006303 * Use with {@link #fillIn} to allow the current ClipData to be
6304 * overwritten, even if it is already set.
6305 */
6306 public static final int FILL_IN_CLIP_DATA = 1<<7;
6307
6308 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006309 * Copy the contents of <var>other</var> in to this object, but only
6310 * where fields are not defined by this object. For purposes of a field
6311 * being defined, the following pieces of data in the Intent are
6312 * considered to be separate fields:
6313 *
6314 * <ul>
6315 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006316 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006317 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6318 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006319 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006320 * <li> component, as set by {@link #setComponent(ComponentName)} or
6321 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006322 * <li> source bounds, as set by {@link #setSourceBounds}.
6323 * <li> selector, as set by {@link #setSelector(Intent)}.
6324 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006325 * <li> each top-level name in the associated extras.
6326 * </ul>
6327 *
6328 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006329 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006330 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6331 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6332 * the restriction where the corresponding field will not be replaced if
6333 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006334 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006335 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6336 * is explicitly specified. The selector will only be copied if
6337 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006338 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006339 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6340 * and Intent B with {action="gotit", data-type="some/thing",
6341 * categories="one","two"}.
6342 *
6343 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6344 * containing: {action="gotit", data-type="some/thing",
6345 * categories="bar"}.
6346 *
6347 * @param other Another Intent whose values are to be used to fill in
6348 * the current one.
6349 * @param flags Options to control which fields can be filled in.
6350 *
6351 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006352 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006353 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6354 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006355 */
6356 public int fillIn(Intent other, int flags) {
6357 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006358 if (other.mAction != null
6359 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006360 mAction = other.mAction;
6361 changes |= FILL_IN_ACTION;
6362 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006363 if ((other.mData != null || other.mType != null)
6364 && ((mData == null && mType == null)
6365 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006366 mData = other.mData;
6367 mType = other.mType;
6368 changes |= FILL_IN_DATA;
6369 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006370 if (other.mCategories != null
6371 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006372 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006373 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006374 }
6375 changes |= FILL_IN_CATEGORIES;
6376 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006377 if (other.mPackage != null
6378 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006379 // Only do this if mSelector is not set.
6380 if (mSelector == null) {
6381 mPackage = other.mPackage;
6382 changes |= FILL_IN_PACKAGE;
6383 }
6384 }
6385 // Selector is special: it can only be set if explicitly allowed,
6386 // for the same reason as the component name.
6387 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6388 if (mPackage == null) {
6389 mSelector = new Intent(other.mSelector);
6390 mPackage = null;
6391 changes |= FILL_IN_SELECTOR;
6392 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006393 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006394 if (other.mClipData != null
6395 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6396 mClipData = other.mClipData;
6397 changes |= FILL_IN_CLIP_DATA;
6398 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006399 // Component is special: it can -only- be set if explicitly allowed,
6400 // since otherwise the sender could force the intent somewhere the
6401 // originator didn't intend.
6402 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006403 mComponent = other.mComponent;
6404 changes |= FILL_IN_COMPONENT;
6405 }
6406 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006407 if (other.mSourceBounds != null
6408 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6409 mSourceBounds = new Rect(other.mSourceBounds);
6410 changes |= FILL_IN_SOURCE_BOUNDS;
6411 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006412 if (mExtras == null) {
6413 if (other.mExtras != null) {
6414 mExtras = new Bundle(other.mExtras);
6415 }
6416 } else if (other.mExtras != null) {
6417 try {
6418 Bundle newb = new Bundle(other.mExtras);
6419 newb.putAll(mExtras);
6420 mExtras = newb;
6421 } catch (RuntimeException e) {
6422 // Modifying the extras can cause us to unparcel the contents
6423 // of the bundle, and if we do this in the system process that
6424 // may fail. We really should handle this (i.e., the Bundle
6425 // impl shouldn't be on top of a plain map), but for now just
6426 // ignore it and keep the original contents. :(
6427 Log.w("Intent", "Failure filling in extras", e);
6428 }
6429 }
6430 return changes;
6431 }
6432
6433 /**
6434 * Wrapper class holding an Intent and implementing comparisons on it for
6435 * the purpose of filtering. The class implements its
6436 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6437 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6438 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6439 * on the wrapped Intent.
6440 */
6441 public static final class FilterComparison {
6442 private final Intent mIntent;
6443 private final int mHashCode;
6444
6445 public FilterComparison(Intent intent) {
6446 mIntent = intent;
6447 mHashCode = intent.filterHashCode();
6448 }
6449
6450 /**
6451 * Return the Intent that this FilterComparison represents.
6452 * @return Returns the Intent held by the FilterComparison. Do
6453 * not modify!
6454 */
6455 public Intent getIntent() {
6456 return mIntent;
6457 }
6458
6459 @Override
6460 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006461 if (obj instanceof FilterComparison) {
6462 Intent other = ((FilterComparison)obj).mIntent;
6463 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006464 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006465 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006466 }
6467
6468 @Override
6469 public int hashCode() {
6470 return mHashCode;
6471 }
6472 }
6473
6474 /**
6475 * Determine if two intents are the same for the purposes of intent
6476 * resolution (filtering). That is, if their action, data, type,
6477 * class, and categories are the same. This does <em>not</em> compare
6478 * any extra data included in the intents.
6479 *
6480 * @param other The other Intent to compare against.
6481 *
6482 * @return Returns true if action, data, type, class, and categories
6483 * are the same.
6484 */
6485 public boolean filterEquals(Intent other) {
6486 if (other == null) {
6487 return false;
6488 }
6489 if (mAction != other.mAction) {
6490 if (mAction != null) {
6491 if (!mAction.equals(other.mAction)) {
6492 return false;
6493 }
6494 } else {
6495 if (!other.mAction.equals(mAction)) {
6496 return false;
6497 }
6498 }
6499 }
6500 if (mData != other.mData) {
6501 if (mData != null) {
6502 if (!mData.equals(other.mData)) {
6503 return false;
6504 }
6505 } else {
6506 if (!other.mData.equals(mData)) {
6507 return false;
6508 }
6509 }
6510 }
6511 if (mType != other.mType) {
6512 if (mType != null) {
6513 if (!mType.equals(other.mType)) {
6514 return false;
6515 }
6516 } else {
6517 if (!other.mType.equals(mType)) {
6518 return false;
6519 }
6520 }
6521 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006522 if (mPackage != other.mPackage) {
6523 if (mPackage != null) {
6524 if (!mPackage.equals(other.mPackage)) {
6525 return false;
6526 }
6527 } else {
6528 if (!other.mPackage.equals(mPackage)) {
6529 return false;
6530 }
6531 }
6532 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006533 if (mComponent != other.mComponent) {
6534 if (mComponent != null) {
6535 if (!mComponent.equals(other.mComponent)) {
6536 return false;
6537 }
6538 } else {
6539 if (!other.mComponent.equals(mComponent)) {
6540 return false;
6541 }
6542 }
6543 }
6544 if (mCategories != other.mCategories) {
6545 if (mCategories != null) {
6546 if (!mCategories.equals(other.mCategories)) {
6547 return false;
6548 }
6549 } else {
6550 if (!other.mCategories.equals(mCategories)) {
6551 return false;
6552 }
6553 }
6554 }
6555
6556 return true;
6557 }
6558
6559 /**
6560 * Generate hash code that matches semantics of filterEquals().
6561 *
6562 * @return Returns the hash value of the action, data, type, class, and
6563 * categories.
6564 *
6565 * @see #filterEquals
6566 */
6567 public int filterHashCode() {
6568 int code = 0;
6569 if (mAction != null) {
6570 code += mAction.hashCode();
6571 }
6572 if (mData != null) {
6573 code += mData.hashCode();
6574 }
6575 if (mType != null) {
6576 code += mType.hashCode();
6577 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006578 if (mPackage != null) {
6579 code += mPackage.hashCode();
6580 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006581 if (mComponent != null) {
6582 code += mComponent.hashCode();
6583 }
6584 if (mCategories != null) {
6585 code += mCategories.hashCode();
6586 }
6587 return code;
6588 }
6589
6590 @Override
6591 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006592 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006593
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006594 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006595 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006596 b.append(" }");
6597
6598 return b.toString();
6599 }
6600
6601 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006602 public String toInsecureString() {
6603 StringBuilder b = new StringBuilder(128);
6604
6605 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006606 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006607 b.append(" }");
6608
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006609 return b.toString();
6610 }
Romain Guy4969af72009-06-17 10:53:19 -07006611
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006612 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006613 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006614 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006615
6616 b.append("Intent { ");
6617 toShortString(b, false, true, true, true);
6618 b.append(" }");
6619
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006620 return b.toString();
6621 }
6622
6623 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006624 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6625 StringBuilder b = new StringBuilder(128);
6626 toShortString(b, secure, comp, extras, clip);
6627 return b.toString();
6628 }
6629
6630 /** @hide */
6631 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6632 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006633 boolean first = true;
6634 if (mAction != null) {
6635 b.append("act=").append(mAction);
6636 first = false;
6637 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006638 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006639 if (!first) {
6640 b.append(' ');
6641 }
6642 first = false;
6643 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006644 for (int i=0; i<mCategories.size(); i++) {
6645 if (i > 0) b.append(',');
6646 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006647 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006648 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006649 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006650 if (mData != null) {
6651 if (!first) {
6652 b.append(' ');
6653 }
6654 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006655 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006656 if (secure) {
6657 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006658 } else {
6659 b.append(mData);
6660 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006661 }
6662 if (mType != null) {
6663 if (!first) {
6664 b.append(' ');
6665 }
6666 first = false;
6667 b.append("typ=").append(mType);
6668 }
6669 if (mFlags != 0) {
6670 if (!first) {
6671 b.append(' ');
6672 }
6673 first = false;
6674 b.append("flg=0x").append(Integer.toHexString(mFlags));
6675 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006676 if (mPackage != null) {
6677 if (!first) {
6678 b.append(' ');
6679 }
6680 first = false;
6681 b.append("pkg=").append(mPackage);
6682 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006683 if (comp && mComponent != null) {
6684 if (!first) {
6685 b.append(' ');
6686 }
6687 first = false;
6688 b.append("cmp=").append(mComponent.flattenToShortString());
6689 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006690 if (mSourceBounds != null) {
6691 if (!first) {
6692 b.append(' ');
6693 }
6694 first = false;
6695 b.append("bnds=").append(mSourceBounds.toShortString());
6696 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006697 if (mClipData != null) {
6698 if (!first) {
6699 b.append(' ');
6700 }
6701 first = false;
6702 if (clip) {
6703 b.append("clip={");
6704 mClipData.toShortString(b);
6705 b.append('}');
6706 } else {
6707 b.append("(has clip)");
6708 }
6709 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006710 if (extras && mExtras != null) {
6711 if (!first) {
6712 b.append(' ');
6713 }
6714 first = false;
6715 b.append("(has extras)");
6716 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006717 if (mSelector != null) {
6718 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006719 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006720 b.append("}");
6721 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006722 }
6723
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006724 /**
6725 * Call {@link #toUri} with 0 flags.
6726 * @deprecated Use {@link #toUri} instead.
6727 */
6728 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006729 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006730 return toUri(0);
6731 }
6732
6733 /**
6734 * Convert this Intent into a String holding a URI representation of it.
6735 * The returned URI string has been properly URI encoded, so it can be
6736 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6737 * Intent's data as the base URI, with an additional fragment describing
6738 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006739 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006740 * <p>You can convert the returned string back to an Intent with
6741 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006742 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006743 * @param flags Additional operating flags. Either 0 or
6744 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006745 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006746 * @return Returns a URI encoding URI string describing the entire contents
6747 * of the Intent.
6748 */
6749 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006750 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006751 String scheme = null;
6752 if (mData != null) {
6753 String data = mData.toString();
6754 if ((flags&URI_INTENT_SCHEME) != 0) {
6755 final int N = data.length();
6756 for (int i=0; i<N; i++) {
6757 char c = data.charAt(i);
6758 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6759 || c == '.' || c == '-') {
6760 continue;
6761 }
6762 if (c == ':' && i > 0) {
6763 // Valid scheme.
6764 scheme = data.substring(0, i);
6765 uri.append("intent:");
6766 data = data.substring(i+1);
6767 break;
6768 }
Tom Taylord4a47292009-12-21 13:59:18 -08006769
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006770 // No scheme.
6771 break;
6772 }
6773 }
6774 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006775
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006776 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6777 uri.append("intent:");
6778 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006779
6780 uri.append("#Intent;");
6781
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006782 toUriInner(uri, scheme, flags);
6783 if (mSelector != null) {
6784 uri.append("SEL;");
6785 // Note that for now we are not going to try to handle the
6786 // data part; not clear how to represent this as a URI, and
6787 // not much utility in it.
6788 mSelector.toUriInner(uri, null, flags);
6789 }
6790
6791 uri.append("end");
6792
6793 return uri.toString();
6794 }
6795
6796 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006797 if (scheme != null) {
6798 uri.append("scheme=").append(scheme).append(';');
6799 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006800 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006801 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006802 }
6803 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006804 for (int i=0; i<mCategories.size(); i++) {
6805 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006806 }
6807 }
6808 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006809 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006810 }
6811 if (mFlags != 0) {
6812 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6813 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006814 if (mPackage != null) {
6815 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6816 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006817 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006818 uri.append("component=").append(Uri.encode(
6819 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006820 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006821 if (mSourceBounds != null) {
6822 uri.append("sourceBounds=")
6823 .append(Uri.encode(mSourceBounds.flattenToString()))
6824 .append(';');
6825 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006826 if (mExtras != null) {
6827 for (String key : mExtras.keySet()) {
6828 final Object value = mExtras.get(key);
6829 char entryType =
6830 value instanceof String ? 'S' :
6831 value instanceof Boolean ? 'B' :
6832 value instanceof Byte ? 'b' :
6833 value instanceof Character ? 'c' :
6834 value instanceof Double ? 'd' :
6835 value instanceof Float ? 'f' :
6836 value instanceof Integer ? 'i' :
6837 value instanceof Long ? 'l' :
6838 value instanceof Short ? 's' :
6839 '\0';
6840
6841 if (entryType != '\0') {
6842 uri.append(entryType);
6843 uri.append('.');
6844 uri.append(Uri.encode(key));
6845 uri.append('=');
6846 uri.append(Uri.encode(value.toString()));
6847 uri.append(';');
6848 }
6849 }
6850 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006851 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006852
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006853 public int describeContents() {
6854 return (mExtras != null) ? mExtras.describeContents() : 0;
6855 }
6856
6857 public void writeToParcel(Parcel out, int flags) {
6858 out.writeString(mAction);
6859 Uri.writeToParcel(out, mData);
6860 out.writeString(mType);
6861 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006862 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006863 ComponentName.writeToParcel(mComponent, out);
6864
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006865 if (mSourceBounds != null) {
6866 out.writeInt(1);
6867 mSourceBounds.writeToParcel(out, flags);
6868 } else {
6869 out.writeInt(0);
6870 }
6871
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006872 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006873 final int N = mCategories.size();
6874 out.writeInt(N);
6875 for (int i=0; i<N; i++) {
6876 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006877 }
6878 } else {
6879 out.writeInt(0);
6880 }
6881
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006882 if (mSelector != null) {
6883 out.writeInt(1);
6884 mSelector.writeToParcel(out, flags);
6885 } else {
6886 out.writeInt(0);
6887 }
6888
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006889 if (mClipData != null) {
6890 out.writeInt(1);
6891 mClipData.writeToParcel(out, flags);
6892 } else {
6893 out.writeInt(0);
6894 }
6895
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006896 out.writeBundle(mExtras);
6897 }
6898
6899 public static final Parcelable.Creator<Intent> CREATOR
6900 = new Parcelable.Creator<Intent>() {
6901 public Intent createFromParcel(Parcel in) {
6902 return new Intent(in);
6903 }
6904 public Intent[] newArray(int size) {
6905 return new Intent[size];
6906 }
6907 };
6908
Dianne Hackborneb034652009-09-07 00:49:58 -07006909 /** @hide */
6910 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006911 readFromParcel(in);
6912 }
6913
6914 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006915 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006916 mData = Uri.CREATOR.createFromParcel(in);
6917 mType = in.readString();
6918 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006919 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006920 mComponent = ComponentName.readFromParcel(in);
6921
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006922 if (in.readInt() != 0) {
6923 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6924 }
6925
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006926 int N = in.readInt();
6927 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006928 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006929 int i;
6930 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006931 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006932 }
6933 } else {
6934 mCategories = null;
6935 }
6936
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006937 if (in.readInt() != 0) {
6938 mSelector = new Intent(in);
6939 }
6940
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006941 if (in.readInt() != 0) {
6942 mClipData = new ClipData(in);
6943 }
6944
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006945 mExtras = in.readBundle();
6946 }
6947
6948 /**
6949 * Parses the "intent" element (and its children) from XML and instantiates
6950 * an Intent object. The given XML parser should be located at the tag
6951 * where parsing should start (often named "intent"), from which the
6952 * basic action, data, type, and package and class name will be
6953 * retrieved. The function will then parse in to any child elements,
6954 * looking for <category android:name="xxx"> tags to add categories and
6955 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6956 * to the intent.
6957 *
6958 * @param resources The Resources to use when inflating resources.
6959 * @param parser The XML parser pointing at an "intent" tag.
6960 * @param attrs The AttributeSet interface for retrieving extended
6961 * attribute data at the current <var>parser</var> location.
6962 * @return An Intent object matching the XML data.
6963 * @throws XmlPullParserException If there was an XML parsing error.
6964 * @throws IOException If there was an I/O error.
6965 */
6966 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6967 throws XmlPullParserException, IOException {
6968 Intent intent = new Intent();
6969
6970 TypedArray sa = resources.obtainAttributes(attrs,
6971 com.android.internal.R.styleable.Intent);
6972
6973 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6974
6975 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6976 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6977 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6978
6979 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6980 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6981 if (packageName != null && className != null) {
6982 intent.setComponent(new ComponentName(packageName, className));
6983 }
6984
6985 sa.recycle();
6986
6987 int outerDepth = parser.getDepth();
6988 int type;
6989 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6990 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6991 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6992 continue;
6993 }
6994
6995 String nodeName = parser.getName();
6996 if (nodeName.equals("category")) {
6997 sa = resources.obtainAttributes(attrs,
6998 com.android.internal.R.styleable.IntentCategory);
6999 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7000 sa.recycle();
7001
7002 if (cat != null) {
7003 intent.addCategory(cat);
7004 }
7005 XmlUtils.skipCurrentTag(parser);
7006
7007 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007008 if (intent.mExtras == null) {
7009 intent.mExtras = new Bundle();
7010 }
7011 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7012 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007013
7014 } else {
7015 XmlUtils.skipCurrentTag(parser);
7016 }
7017 }
7018
7019 return intent;
7020 }
Nick Pellyccae4122012-01-09 14:12:58 -08007021
7022 /**
7023 * Normalize a MIME data type.
7024 *
7025 * <p>A normalized MIME type has white-space trimmed,
7026 * content-type parameters removed, and is lower-case.
7027 * This aligns the type with Android best practices for
7028 * intent filtering.
7029 *
7030 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7031 * "text/x-vCard" becomes "text/x-vcard".
7032 *
7033 * <p>All MIME types received from outside Android (such as user input,
7034 * or external sources like Bluetooth, NFC, or the Internet) should
7035 * be normalized before they are used to create an Intent.
7036 *
7037 * @param type MIME data type to normalize
7038 * @return normalized MIME data type, or null if the input was null
7039 * @see {@link #setType}
7040 * @see {@link #setTypeAndNormalize}
7041 */
7042 public static String normalizeMimeType(String type) {
7043 if (type == null) {
7044 return null;
7045 }
7046
7047 type = type.trim().toLowerCase(Locale.US);
7048
7049 final int semicolonIndex = type.indexOf(';');
7050 if (semicolonIndex != -1) {
7051 type = type.substring(0, semicolonIndex);
7052 }
7053 return type;
7054 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007055
7056 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007057 * Prepare this {@link Intent} to leave an app process.
7058 *
7059 * @hide
7060 */
7061 public void prepareToLeaveProcess() {
7062 setAllowFds(false);
7063
7064 if (mSelector != null) {
7065 mSelector.prepareToLeaveProcess();
7066 }
7067 if (mClipData != null) {
7068 mClipData.prepareToLeaveProcess();
7069 }
7070
7071 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7072 // There are several ACTION_MEDIA_* broadcasts that send file://
7073 // Uris, so only check common actions.
7074 if (ACTION_VIEW.equals(mAction) ||
7075 ACTION_EDIT.equals(mAction) ||
7076 ACTION_ATTACH_DATA.equals(mAction)) {
7077 mData.checkFileUriExposed("Intent.getData()");
7078 }
7079 }
7080 }
7081
7082 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007083 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007084 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7085 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007086 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007087 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007088 * @hide
7089 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007090 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007091 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007092 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007093
7094 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007095 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007096
7097 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007098 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007099 try {
7100 // Inspect target intent to see if we need to migrate
7101 final Intent target = getParcelableExtra(EXTRA_INTENT);
7102 if (target != null && target.migrateExtraStreamToClipData()) {
7103 // Since we migrated in child, we need to promote ClipData
7104 // and flags to ourselves to grant.
7105 setClipData(target.getClipData());
7106 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007107 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
7108 | FLAG_PERSIST_GRANT_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007109 return true;
7110 } else {
7111 return false;
7112 }
7113 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007114 }
7115
7116 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007117 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007118 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7119 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7120 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7121 if (stream != null || text != null || htmlText != null) {
7122 final ClipData clipData = new ClipData(
7123 null, new String[] { getType() },
7124 new ClipData.Item(text, htmlText, null, stream));
7125 setClipData(clipData);
7126 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007127 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007128 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007129 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007130 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007131
7132 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007133 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007134 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7135 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7136 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7137 int num = -1;
7138 if (streams != null) {
7139 num = streams.size();
7140 }
7141 if (texts != null) {
7142 if (num >= 0 && num != texts.size()) {
7143 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007144 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007145 }
7146 num = texts.size();
7147 }
7148 if (htmlTexts != null) {
7149 if (num >= 0 && num != htmlTexts.size()) {
7150 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007151 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007152 }
7153 num = htmlTexts.size();
7154 }
7155 if (num > 0) {
7156 final ClipData clipData = new ClipData(
7157 null, new String[] { getType() },
7158 makeClipItem(streams, texts, htmlTexts, 0));
7159
7160 for (int i = 1; i < num; i++) {
7161 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7162 }
7163
7164 setClipData(clipData);
7165 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007166 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007167 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007168 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007169 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007170 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007171
7172 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007173 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007174
7175 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7176 ArrayList<String> htmlTexts, int which) {
7177 Uri uri = streams != null ? streams.get(which) : null;
7178 CharSequence text = texts != null ? texts.get(which) : null;
7179 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7180 return new ClipData.Item(text, htmlText, null, uri);
7181 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007182}