blob: 205ca6bd05d8b25a96ee55c396eb7799b114e660 [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 Hackborn221ea892013-08-04 16:50:16 -070019import android.content.pm.ApplicationInfo;
Dianne Hackbornadd005c2013-07-17 18:43:12 -070020import android.util.ArraySet;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070021import org.xmlpull.v1.XmlPullParser;
22import org.xmlpull.v1.XmlPullParserException;
23
24import android.annotation.SdkConstant;
25import android.annotation.SdkConstant.SdkConstantType;
26import android.content.pm.ActivityInfo;
27import android.content.pm.PackageManager;
28import android.content.pm.ResolveInfo;
29import android.content.res.Resources;
30import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080031import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070032import android.net.Uri;
33import android.os.Bundle;
34import android.os.IBinder;
35import android.os.Parcel;
36import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070037import android.os.StrictMode;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070038import android.util.AttributeSet;
39import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080040
41import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070042
43import java.io.IOException;
44import java.io.Serializable;
45import java.net.URISyntaxException;
46import java.util.ArrayList;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Iterator;
Dianne Hackborn221ea892013-08-04 16:50:16 -070048import java.util.List;
Nick Pellyccae4122012-01-09 14:12:58 -080049import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070050import java.util.Set;
51
52/**
53 * An intent is an abstract description of an operation to be performed. It
54 * can be used with {@link Context#startActivity(Intent) startActivity} to
55 * launch an {@link android.app.Activity},
56 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
57 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
58 * and {@link android.content.Context#startService} or
59 * {@link android.content.Context#bindService} to communicate with a
60 * background {@link android.app.Service}.
61 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070062 * <p>An Intent provides a facility for performing late runtime binding between the code in
63 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070064 * can be thought of as the glue between activities. It is basically a passive data structure
65 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070066 *
67 * <div class="special reference">
68 * <h3>Developer Guides</h3>
69 * <p>For information about how to create and resolve intents, read the
70 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
71 * developer guide.</p>
72 * </div>
73 *
74 * <a name="IntentStructure"></a>
75 * <h3>Intent Structure</h3>
76 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070077 *
78 * <ul>
79 * <li> <p><b>action</b> -- The general action to be performed, such as
80 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
81 * etc.</p>
82 * </li>
83 * <li> <p><b>data</b> -- The data to operate on, such as a person record
84 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
85 * </li>
86 * </ul>
87 *
88 *
89 * <p>Some examples of action/data pairs are:</p>
90 *
91 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * information about the person whose identifier is "1".</p>
94 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070095 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070096 * the phone dialer with the person filled in.</p>
97 * </li>
98 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
99 * the phone dialer with the given number filled in. Note how the
100 * VIEW action does what what is considered the most reasonable thing for
101 * a particular URI.</p>
102 * </li>
103 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
104 * the phone dialer with the given number filled in.</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * information about the person whose identifier is "1".</p>
108 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700109 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700110 * a list of people, which the user can browse through. This example is a
111 * typical top-level entry into the Contacts application, showing you the
112 * list of people. Selecting a particular person to view would result in a
113 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
114 * being used to start an activity to display that person.</p>
115 * </li>
116 * </ul>
117 *
118 * <p>In addition to these primary attributes, there are a number of secondary
119 * attributes that you can also include with an intent:</p>
120 *
121 * <ul>
122 * <li> <p><b>category</b> -- Gives additional information about the action
123 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
124 * appear in the Launcher as a top-level application, while
125 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
126 * of alternative actions the user can perform on a piece of data.</p>
127 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
128 * intent data. Normally the type is inferred from the data itself.
129 * By setting this attribute, you disable that evaluation and force
130 * an explicit type.</p>
131 * <li> <p><b>component</b> -- Specifies an explicit name of a component
132 * class to use for the intent. Normally this is determined by looking
133 * at the other information in the intent (the action, data/type, and
134 * categories) and matching that with a component that can handle it.
135 * If this attribute is set then none of the evaluation is performed,
136 * and this component is used exactly as is. By specifying this attribute,
137 * all of the other Intent attributes become optional.</p>
138 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
139 * This can be used to provide extended information to the component.
140 * For example, if we have a action to send an e-mail message, we could
141 * also include extra pieces of data here to supply a subject, body,
142 * etc.</p>
143 * </ul>
144 *
145 * <p>Here are some examples of other operations you can specify as intents
146 * using these additional parameters:</p>
147 *
148 * <ul>
149 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
150 * Launch the home screen.</p>
151 * </li>
152 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
153 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
154 * vnd.android.cursor.item/phone}</i></b>
155 * -- Display the list of people's phone numbers, allowing the user to
156 * browse through them and pick one and return it to the parent activity.</p>
157 * </li>
158 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
159 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
160 * -- Display all pickers for data that can be opened with
161 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
162 * allowing the user to pick one of them and then some data inside of it
163 * and returning the resulting URI to the caller. This can be used,
164 * for example, in an e-mail application to allow the user to pick some
165 * data to include as an attachment.</p>
166 * </li>
167 * </ul>
168 *
169 * <p>There are a variety of standard Intent action and category constants
170 * defined in the Intent class, but applications can also define their own.
171 * These strings use java style scoping, to ensure they are unique -- for
172 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700173 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700174 *
175 * <p>Put together, the set of actions, data types, categories, and extra data
176 * defines a language for the system allowing for the expression of phrases
177 * such as "call john smith's cell". As applications are added to the system,
178 * they can extend this language by adding new actions, types, and categories, or
179 * they can modify the behavior of existing phrases by supplying their own
180 * activities that handle them.</p>
181 *
182 * <a name="IntentResolution"></a>
183 * <h3>Intent Resolution</h3>
184 *
185 * <p>There are two primary forms of intents you will use.
186 *
187 * <ul>
188 * <li> <p><b>Explicit Intents</b> have specified a component (via
189 * {@link #setComponent} or {@link #setClass}), which provides the exact
190 * class to be run. Often these will not include any other information,
191 * simply being a way for an application to launch various internal
192 * activities it has as the user interacts with the application.
193 *
194 * <li> <p><b>Implicit Intents</b> have not specified a component;
195 * instead, they must include enough information for the system to
196 * determine which of the available components is best to run for that
197 * intent.
198 * </ul>
199 *
200 * <p>When using implicit intents, given such an arbitrary intent we need to
201 * know what to do with it. This is handled by the process of <em>Intent
202 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
203 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
204 * more activities/receivers) that can handle it.</p>
205 *
206 * <p>The intent resolution mechanism basically revolves around matching an
207 * Intent against all of the &lt;intent-filter&gt; descriptions in the
208 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
209 * objects explicitly registered with {@link Context#registerReceiver}.) More
210 * details on this can be found in the documentation on the {@link
211 * IntentFilter} class.</p>
212 *
213 * <p>There are three pieces of information in the Intent that are used for
214 * resolution: the action, type, and category. Using this information, a query
215 * is done on the {@link PackageManager} for a component that can handle the
216 * intent. The appropriate component is determined based on the intent
217 * information supplied in the <code>AndroidManifest.xml</code> file as
218 * follows:</p>
219 *
220 * <ul>
221 * <li> <p>The <b>action</b>, if given, must be listed by the component as
222 * one it handles.</p>
223 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
224 * already supplied in the Intent. Like the action, if a type is
225 * included in the intent (either explicitly or implicitly in its
226 * data), then this must be listed by the component as one it handles.</p>
227 * <li> For data that is not a <code>content:</code> URI and where no explicit
228 * type is included in the Intent, instead the <b>scheme</b> of the
229 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
230 * considered. Again like the action, if we are matching a scheme it
231 * must be listed by the component as one it can handle.
232 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
233 * by the activity as categories it handles. That is, if you include
234 * the categories {@link #CATEGORY_LAUNCHER} and
235 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
236 * with an intent that lists <em>both</em> of those categories.
237 * Activities will very often need to support the
238 * {@link #CATEGORY_DEFAULT} so that they can be found by
239 * {@link Context#startActivity Context.startActivity()}.</p>
240 * </ul>
241 *
242 * <p>For example, consider the Note Pad sample application that
243 * allows user to browse through a list of notes data and view details about
244 * individual items. Text in italics indicate places were you would replace a
245 * name with one specific to your own package.</p>
246 *
247 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
248 * package="<i>com.android.notepad</i>"&gt;
249 * &lt;application android:icon="@drawable/app_notes"
250 * android:label="@string/app_name"&gt;
251 *
252 * &lt;provider class=".NotePadProvider"
253 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
254 *
255 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
256 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700257 * &lt;action android:name="android.intent.action.MAIN" /&gt;
258 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700259 * &lt;/intent-filter&gt;
260 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700261 * &lt;action android:name="android.intent.action.VIEW" /&gt;
262 * &lt;action android:name="android.intent.action.EDIT" /&gt;
263 * &lt;action android:name="android.intent.action.PICK" /&gt;
264 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
265 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700266 * &lt;/intent-filter&gt;
267 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700268 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
269 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
270 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700271 * &lt;/intent-filter&gt;
272 * &lt;/activity&gt;
273 *
274 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
275 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700276 * &lt;action android:name="android.intent.action.VIEW" /&gt;
277 * &lt;action android:name="android.intent.action.EDIT" /&gt;
278 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
279 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700280 * &lt;/intent-filter&gt;
281 *
282 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700283 * &lt;action android:name="android.intent.action.INSERT" /&gt;
284 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
285 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700286 * &lt;/intent-filter&gt;
287 *
288 * &lt;/activity&gt;
289 *
290 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
291 * android:theme="@android:style/Theme.Dialog"&gt;
292 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700293 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
294 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
295 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
296 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
297 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700298 * &lt;/intent-filter&gt;
299 * &lt;/activity&gt;
300 *
301 * &lt;/application&gt;
302 * &lt;/manifest&gt;</pre>
303 *
304 * <p>The first activity,
305 * <code>com.android.notepad.NotesList</code>, serves as our main
306 * entry into the app. It can do three things as described by its three intent
307 * templates:
308 * <ol>
309 * <li><pre>
310 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700311 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
312 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700313 * &lt;/intent-filter&gt;</pre>
314 * <p>This provides a top-level entry into the NotePad application: the standard
315 * MAIN action is a main entry point (not requiring any other information in
316 * the Intent), and the LAUNCHER category says that this entry point should be
317 * listed in the application launcher.</p>
318 * <li><pre>
319 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700320 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
321 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
322 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
323 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
324 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700325 * &lt;/intent-filter&gt;</pre>
326 * <p>This declares the things that the activity can do on a directory of
327 * notes. The type being supported is given with the &lt;type&gt; tag, where
328 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
329 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
330 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
331 * The activity allows the user to view or edit the directory of data (via
332 * the VIEW and EDIT actions), or to pick a particular note and return it
333 * to the caller (via the PICK action). Note also the DEFAULT category
334 * supplied here: this is <em>required</em> for the
335 * {@link Context#startActivity Context.startActivity} method to resolve your
336 * activity when its component name is not explicitly specified.</p>
337 * <li><pre>
338 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700339 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
340 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
341 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700342 * &lt;/intent-filter&gt;</pre>
343 * <p>This filter describes the ability return to the caller a note selected by
344 * the user without needing to know where it came from. The data type
345 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
346 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
347 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
348 * The GET_CONTENT action is similar to the PICK action, where the activity
349 * will return to its caller a piece of data selected by the user. Here,
350 * however, the caller specifies the type of data they desire instead of
351 * the type of data the user will be picking from.</p>
352 * </ol>
353 *
354 * <p>Given these capabilities, the following intents will resolve to the
355 * NotesList activity:</p>
356 *
357 * <ul>
358 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
359 * activities that can be used as top-level entry points into an
360 * application.</p>
361 * <li> <p><b>{ action=android.app.action.MAIN,
362 * category=android.app.category.LAUNCHER }</b> is the actual intent
363 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700364 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700365 * data=content://com.google.provider.NotePad/notes }</b>
366 * displays a list of all the notes under
367 * "content://com.google.provider.NotePad/notes", which
368 * the user can browse through and see the details on.</p>
369 * <li> <p><b>{ action=android.app.action.PICK
370 * data=content://com.google.provider.NotePad/notes }</b>
371 * provides a list of the notes under
372 * "content://com.google.provider.NotePad/notes", from which
373 * the user can pick a note whose data URL is returned back to the caller.</p>
374 * <li> <p><b>{ action=android.app.action.GET_CONTENT
375 * type=vnd.android.cursor.item/vnd.google.note }</b>
376 * is similar to the pick action, but allows the caller to specify the
377 * kind of data they want back so that the system can find the appropriate
378 * activity to pick something of that data type.</p>
379 * </ul>
380 *
381 * <p>The second activity,
382 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
383 * note entry and allows them to edit it. It can do two things as described
384 * by its two intent templates:
385 * <ol>
386 * <li><pre>
387 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700388 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
389 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
390 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
391 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700392 * &lt;/intent-filter&gt;</pre>
393 * <p>The first, primary, purpose of this activity is to let the user interact
394 * with a single note, as decribed by the MIME type
395 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
396 * either VIEW a note or allow the user to EDIT it. Again we support the
397 * DEFAULT category to allow the activity to be launched without explicitly
398 * specifying its component.</p>
399 * <li><pre>
400 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700401 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
402 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
403 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700404 * &lt;/intent-filter&gt;</pre>
405 * <p>The secondary use of this activity is to insert a new note entry into
406 * an existing directory of notes. This is used when the user creates a new
407 * note: the INSERT action is executed on the directory of notes, causing
408 * this activity to run and have the user create the new note data which
409 * it then adds to the content provider.</p>
410 * </ol>
411 *
412 * <p>Given these capabilities, the following intents will resolve to the
413 * NoteEditor activity:</p>
414 *
415 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700416 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * shows the user the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.EDIT
420 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
421 * allows the user to edit the content of note <var>{ID}</var>.</p>
422 * <li> <p><b>{ action=android.app.action.INSERT
423 * data=content://com.google.provider.NotePad/notes }</b>
424 * creates a new, empty note in the notes list at
425 * "content://com.google.provider.NotePad/notes"
426 * and allows the user to edit it. If they keep their changes, the URI
427 * of the newly created note is returned to the caller.</p>
428 * </ul>
429 *
430 * <p>The last activity,
431 * <code>com.android.notepad.TitleEditor</code>, allows the user to
432 * edit the title of a note. This could be implemented as a class that the
433 * application directly invokes (by explicitly setting its component in
434 * the Intent), but here we show a way you can publish alternative
435 * operations on existing data:</p>
436 *
437 * <pre>
438 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700439 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
440 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
441 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
442 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
443 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700444 * &lt;/intent-filter&gt;</pre>
445 *
446 * <p>In the single intent template here, we
447 * have created our own private action called
448 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
449 * edit the title of a note. It must be invoked on a specific note
450 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
451 * view and edit actions, but here displays and edits the title contained
452 * in the note data.
453 *
454 * <p>In addition to supporting the default category as usual, our title editor
455 * also supports two other standard categories: ALTERNATIVE and
456 * SELECTED_ALTERNATIVE. Implementing
457 * these categories allows others to find the special action it provides
458 * without directly knowing about it, through the
459 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
460 * more often to build dynamic menu items with
461 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
462 * template here was also supply an explicit name for the template
463 * (via <code>android:label="@string/resolve_title"</code>) to better control
464 * what the user sees when presented with this activity as an alternative
465 * action to the data they are viewing.
466 *
467 * <p>Given these capabilities, the following intent will resolve to the
468 * TitleEditor activity:</p>
469 *
470 * <ul>
471 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
472 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
473 * displays and allows the user to edit the title associated
474 * with note <var>{ID}</var>.</p>
475 * </ul>
476 *
477 * <h3>Standard Activity Actions</h3>
478 *
479 * <p>These are the current standard actions that Intent defines for launching
480 * activities (usually through {@link Context#startActivity}. The most
481 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
482 * {@link #ACTION_EDIT}.
483 *
484 * <ul>
485 * <li> {@link #ACTION_MAIN}
486 * <li> {@link #ACTION_VIEW}
487 * <li> {@link #ACTION_ATTACH_DATA}
488 * <li> {@link #ACTION_EDIT}
489 * <li> {@link #ACTION_PICK}
490 * <li> {@link #ACTION_CHOOSER}
491 * <li> {@link #ACTION_GET_CONTENT}
492 * <li> {@link #ACTION_DIAL}
493 * <li> {@link #ACTION_CALL}
494 * <li> {@link #ACTION_SEND}
495 * <li> {@link #ACTION_SENDTO}
496 * <li> {@link #ACTION_ANSWER}
497 * <li> {@link #ACTION_INSERT}
498 * <li> {@link #ACTION_DELETE}
499 * <li> {@link #ACTION_RUN}
500 * <li> {@link #ACTION_SYNC}
501 * <li> {@link #ACTION_PICK_ACTIVITY}
502 * <li> {@link #ACTION_SEARCH}
503 * <li> {@link #ACTION_WEB_SEARCH}
504 * <li> {@link #ACTION_FACTORY_TEST}
505 * </ul>
506 *
507 * <h3>Standard Broadcast Actions</h3>
508 *
509 * <p>These are the current standard actions that Intent defines for receiving
510 * broadcasts (usually through {@link Context#registerReceiver} or a
511 * &lt;receiver&gt; tag in a manifest).
512 *
513 * <ul>
514 * <li> {@link #ACTION_TIME_TICK}
515 * <li> {@link #ACTION_TIME_CHANGED}
516 * <li> {@link #ACTION_TIMEZONE_CHANGED}
517 * <li> {@link #ACTION_BOOT_COMPLETED}
518 * <li> {@link #ACTION_PACKAGE_ADDED}
519 * <li> {@link #ACTION_PACKAGE_CHANGED}
520 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800521 * <li> {@link #ACTION_PACKAGE_RESTARTED}
522 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700523 * <li> {@link #ACTION_UID_REMOVED}
524 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700525 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700526 * <li> {@link #ACTION_POWER_DISCONNECTED}
527 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700528 * </ul>
529 *
530 * <h3>Standard Categories</h3>
531 *
532 * <p>These are the current standard categories that can be used to further
533 * clarify an Intent via {@link #addCategory}.
534 *
535 * <ul>
536 * <li> {@link #CATEGORY_DEFAULT}
537 * <li> {@link #CATEGORY_BROWSABLE}
538 * <li> {@link #CATEGORY_TAB}
539 * <li> {@link #CATEGORY_ALTERNATIVE}
540 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
541 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800542 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #CATEGORY_HOME}
544 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700545 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400546 * <li> {@link #CATEGORY_CAR_DOCK}
547 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500548 * <li> {@link #CATEGORY_LE_DESK_DOCK}
549 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200550 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700551 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700552 * </ul>
553 *
554 * <h3>Standard Extra Data</h3>
555 *
556 * <p>These are the current standard fields that can be used as extra data via
557 * {@link #putExtra}.
558 *
559 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800560 * <li> {@link #EXTRA_ALARM_COUNT}
561 * <li> {@link #EXTRA_BCC}
562 * <li> {@link #EXTRA_CC}
563 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
564 * <li> {@link #EXTRA_DATA_REMOVED}
565 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500566 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800568 * <li> {@link #EXTRA_DOCK_STATE_CAR}
569 * <li> {@link #EXTRA_DOCK_STATE_DESK}
570 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
571 * <li> {@link #EXTRA_DONT_KILL_APP}
572 * <li> {@link #EXTRA_EMAIL}
573 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700574 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700576 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800577 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700578 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800579 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
580 * <li> {@link #EXTRA_REPLACING}
581 * <li> {@link #EXTRA_SHORTCUT_ICON}
582 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
583 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700584 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800585 * <li> {@link #EXTRA_SHORTCUT_NAME}
586 * <li> {@link #EXTRA_SUBJECT}
587 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800589 * <li> {@link #EXTRA_TITLE}
590 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700591 * </ul>
592 *
593 * <h3>Flags</h3>
594 *
595 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800596 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
597 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700598 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800599public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700600 // ---------------------------------------------------------------------
601 // ---------------------------------------------------------------------
602 // Standard intent activity actions (see action variable).
603
604 /**
605 * Activity Action: Start as a main entry point, does not expect to
606 * receive data.
607 * <p>Input: nothing
608 * <p>Output: nothing
609 */
610 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
611 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800612
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700613 /**
614 * Activity Action: Display the data to the user. This is the most common
615 * action performed on data -- it is the generic action you can use on
616 * a piece of data to get the most reasonable thing to occur. For example,
617 * when used on a contacts entry it will view the entry; when used on a
618 * mailto: URI it will bring up a compose window filled with the information
619 * supplied by the URI; when used with a tel: URI it will invoke the
620 * dialer.
621 * <p>Input: {@link #getData} is URI from which to retrieve data.
622 * <p>Output: nothing.
623 */
624 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
625 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800626
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700627 /**
628 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
629 * performed on a piece of data.
630 */
631 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800632
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700633 /**
634 * Used to indicate that some piece of data should be attached to some other
635 * place. For example, image data could be attached to a contact. It is up
636 * to the recipient to decide where the data should be attached; the intent
637 * does not specify the ultimate destination.
638 * <p>Input: {@link #getData} is URI of data to be attached.
639 * <p>Output: nothing.
640 */
641 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
642 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800643
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700644 /**
645 * Activity Action: Provide explicit editable access to the given data.
646 * <p>Input: {@link #getData} is URI of data to be edited.
647 * <p>Output: nothing.
648 */
649 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
650 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800651
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700652 /**
653 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
654 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
655 * The extras can contain type specific data to pass through to the editing/creating
656 * activity.
657 * <p>Output: The URI of the item that was picked. This must be a content:
658 * URI so that any receiver can access it.
659 */
660 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
661 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800662
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700663 /**
664 * Activity Action: Pick an item from the data, returning what was selected.
665 * <p>Input: {@link #getData} is URI containing a directory of data
666 * (vnd.android.cursor.dir/*) from which to pick an item.
667 * <p>Output: The URI of the item that was picked.
668 */
669 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
670 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800671
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 /**
673 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800674 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700675 * <p>Output: An Intent representing the shortcut. The intent must contain three
676 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
677 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800678 * (value: ShortcutIconResource).</p>
679 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700680 * @see #EXTRA_SHORTCUT_INTENT
681 * @see #EXTRA_SHORTCUT_NAME
682 * @see #EXTRA_SHORTCUT_ICON
683 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
684 * @see android.content.Intent.ShortcutIconResource
685 */
686 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
687 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
688
689 /**
690 * The name of the extra used to define the Intent of a shortcut.
691 *
692 * @see #ACTION_CREATE_SHORTCUT
693 */
694 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
695 /**
696 * The name of the extra used to define the name of a shortcut.
697 *
698 * @see #ACTION_CREATE_SHORTCUT
699 */
700 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
701 /**
702 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
703 *
704 * @see #ACTION_CREATE_SHORTCUT
705 */
706 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
707 /**
708 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
709 *
710 * @see #ACTION_CREATE_SHORTCUT
711 * @see android.content.Intent.ShortcutIconResource
712 */
713 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
714 "android.intent.extra.shortcut.ICON_RESOURCE";
715
716 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800717 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700718 *
719 * @see Intent#ACTION_CREATE_SHORTCUT
720 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800721 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
722 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700723 */
724 public static class ShortcutIconResource implements Parcelable {
725 /**
726 * The package name of the application containing the icon.
727 */
728 public String packageName;
729
730 /**
731 * The resource name of the icon, including package, name and type.
732 */
733 public String resourceName;
734
735 /**
736 * Creates a new ShortcutIconResource for the specified context and resource
737 * identifier.
738 *
739 * @param context The context of the application.
740 * @param resourceId The resource idenfitier for the icon.
741 * @return A new ShortcutIconResource with the specified's context package name
742 * and icon resource idenfitier.
743 */
744 public static ShortcutIconResource fromContext(Context context, int resourceId) {
745 ShortcutIconResource icon = new ShortcutIconResource();
746 icon.packageName = context.getPackageName();
747 icon.resourceName = context.getResources().getResourceName(resourceId);
748 return icon;
749 }
750
751 /**
752 * Used to read a ShortcutIconResource from a Parcel.
753 */
754 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
755 new Parcelable.Creator<ShortcutIconResource>() {
756
757 public ShortcutIconResource createFromParcel(Parcel source) {
758 ShortcutIconResource icon = new ShortcutIconResource();
759 icon.packageName = source.readString();
760 icon.resourceName = source.readString();
761 return icon;
762 }
763
764 public ShortcutIconResource[] newArray(int size) {
765 return new ShortcutIconResource[size];
766 }
767 };
768
769 /**
770 * No special parcel contents.
771 */
772 public int describeContents() {
773 return 0;
774 }
775
776 public void writeToParcel(Parcel dest, int flags) {
777 dest.writeString(packageName);
778 dest.writeString(resourceName);
779 }
780
781 @Override
782 public String toString() {
783 return resourceName;
784 }
785 }
786
787 /**
788 * Activity Action: Display an activity chooser, allowing the user to pick
789 * what they want to before proceeding. This can be used as an alternative
790 * to the standard activity picker that is displayed by the system when
791 * you try to start an activity with multiple possible matches, with these
792 * differences in behavior:
793 * <ul>
794 * <li>You can specify the title that will appear in the activity chooser.
795 * <li>The user does not have the option to make one of the matching
796 * activities a preferred activity, and all possible activities will
797 * always be shown even if one of them is currently marked as the
798 * preferred activity.
799 * </ul>
800 * <p>
801 * This action should be used when the user will naturally expect to
802 * select an activity in order to proceed. An example if when not to use
803 * it is when the user clicks on a "mailto:" link. They would naturally
804 * expect to go directly to their mail app, so startActivity() should be
805 * called directly: it will
806 * either launch the current preferred app, or put up a dialog allowing the
807 * user to pick an app to use and optionally marking that as preferred.
808 * <p>
809 * In contrast, if the user is selecting a menu item to send a picture
810 * they are viewing to someone else, there are many different things they
811 * may want to do at this point: send it through e-mail, upload it to a
812 * web service, etc. In this case the CHOOSER action should be used, to
813 * always present to the user a list of the things they can do, with a
814 * nice title given by the caller such as "Send this photo with:".
815 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700816 * If you need to grant URI permissions through a chooser, you must specify
817 * the permissions to be granted on the ACTION_CHOOSER Intent
818 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
819 * {@link #setClipData} to specify the URIs to be granted as well as
820 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
821 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
822 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700823 * As a convenience, an Intent of this form can be created with the
824 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700825 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700826 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700827 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
828 * and can optionally have a {@link #EXTRA_TITLE} field containing the
829 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700830 * <p>
831 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700832 */
833 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
834 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
835
836 /**
837 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
838 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700839 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
840 * target intent, also optionally supplying a title. If the target
841 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
842 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
843 * set in the returned chooser intent, with its ClipData set appropriately:
844 * either a direct reflection of {@link #getClipData()} if that is non-null,
845 * or a new ClipData build from {@link #getData()}.
846 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700847 * @param target The Intent that the user will be selecting an activity
848 * to perform.
849 * @param title Optional title that will be displayed in the chooser.
850 * @return Return a new Intent object that you can hand to
851 * {@link Context#startActivity(Intent) Context.startActivity()} and
852 * related methods.
853 */
854 public static Intent createChooser(Intent target, CharSequence title) {
855 Intent intent = new Intent(ACTION_CHOOSER);
856 intent.putExtra(EXTRA_INTENT, target);
857 if (title != null) {
858 intent.putExtra(EXTRA_TITLE, title);
859 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700860
861 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700862 int permFlags = target.getFlags()
863 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
864 if (permFlags != 0) {
865 ClipData targetClipData = target.getClipData();
866 if (targetClipData == null && target.getData() != null) {
867 ClipData.Item item = new ClipData.Item(target.getData());
868 String[] mimeTypes;
869 if (target.getType() != null) {
870 mimeTypes = new String[] { target.getType() };
871 } else {
872 mimeTypes = new String[] { };
873 }
874 targetClipData = new ClipData(null, mimeTypes, item);
875 }
876 if (targetClipData != null) {
877 intent.setClipData(targetClipData);
878 intent.addFlags(permFlags);
879 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700880 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700882 return intent;
883 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700884
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700885 /**
886 * Activity Action: Allow the user to select a particular kind of data and
887 * return it. This is different than {@link #ACTION_PICK} in that here we
888 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800889 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700890 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900891 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700892 * etc.
893 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900894 * 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 -0700895 * of data, such as a person contact, you set the MIME type to the kind of
896 * data you want and launch it with {@link Context#startActivity(Intent)}.
897 * The system will then launch the best application to select that kind
898 * of data for you.
899 * <p>
900 * You may also be interested in any of a set of types of content the user
901 * can pick. For example, an e-mail application that wants to allow the
902 * user to add an attachment to an e-mail message can use this action to
903 * bring up a list of all of the types of content the user can attach.
904 * <p>
905 * In this case, you should wrap the GET_CONTENT intent with a chooser
906 * (through {@link #createChooser}), which will give the proper interface
907 * for the user to pick how to send your data and allow you to specify
908 * a prompt indicating what they are doing. You will usually specify a
909 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
910 * broad range of content types the user can select from.
911 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900912 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700913 * only pick from data that can be represented as a stream. This is
914 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
915 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800916 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900917 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800918 * is locally available on the device. For example, if this extra is set
919 * to true then an image picker should not show any pictures that are available
920 * from a remote server but not already on the local device (thus requiring
921 * they be downloaded when opened).
922 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800923 * If the caller can handle multiple returned items (the user performing
924 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
925 * to indicate this.
926 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700927 * Input: {@link #getType} is the desired MIME type to retrieve. Note
928 * that no URI is supplied in the intent, as there are no constraints on
929 * where the returned data originally comes from. You may also include the
930 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800931 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800932 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
933 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700934 * <p>
935 * Output: The URI of the item that was picked. This must be a content:
936 * URI so that any receiver can access it.
937 */
938 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
939 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
940 /**
941 * Activity Action: Dial a number as specified by the data. This shows a
942 * UI with the number being dialed, allowing the user to explicitly
943 * initiate the call.
944 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
945 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
946 * number.
947 * <p>Output: nothing.
948 */
949 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
950 public static final String ACTION_DIAL = "android.intent.action.DIAL";
951 /**
952 * Activity Action: Perform a call to someone specified by the data.
953 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
954 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
955 * number.
956 * <p>Output: nothing.
957 *
958 * <p>Note: there will be restrictions on which applications can initiate a
959 * call; most applications should use the {@link #ACTION_DIAL}.
960 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
961 * numbers. Applications can <strong>dial</strong> emergency numbers using
962 * {@link #ACTION_DIAL}, however.
963 */
964 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
965 public static final String ACTION_CALL = "android.intent.action.CALL";
966 /**
967 * Activity Action: Perform a call to an emergency number specified by the
968 * data.
969 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
970 * tel: URI of an explicit phone number.
971 * <p>Output: nothing.
972 * @hide
973 */
974 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
975 /**
976 * Activity action: Perform a call to any number (emergency or not)
977 * specified by the data.
978 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
979 * tel: URI of an explicit phone number.
980 * <p>Output: nothing.
981 * @hide
982 */
983 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
984 /**
985 * Activity Action: Send a message to someone specified by the data.
986 * <p>Input: {@link #getData} is URI describing the target.
987 * <p>Output: nothing.
988 */
989 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
990 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
991 /**
992 * Activity Action: Deliver some data to someone else. Who the data is
993 * being delivered to is not specified; it is up to the receiver of this
994 * action to ask the user where the data should be sent.
995 * <p>
996 * When launching a SEND intent, you should usually wrap it in a chooser
997 * (through {@link #createChooser}), which will give the proper interface
998 * for the user to pick how to send your data and allow you to specify
999 * a prompt indicating what they are doing.
1000 * <p>
1001 * Input: {@link #getType} is the MIME type of the data being sent.
1002 * get*Extra can have either a {@link #EXTRA_TEXT}
1003 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1004 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1005 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1006 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001007 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1008 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1009 * your text with HTML formatting.
1010 * <p>
1011 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1012 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1013 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1014 * content: URIs and other advanced features of {@link ClipData}. If
1015 * using this approach, you still must supply the same data through the
1016 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1017 * for compatibility with old applications. If you don't set a ClipData,
1018 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001019 * <p>
1020 * Optional standard extras, which may be interpreted by some recipients as
1021 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1022 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1023 * <p>
1024 * Output: nothing.
1025 */
1026 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1027 public static final String ACTION_SEND = "android.intent.action.SEND";
1028 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001029 * Activity Action: Deliver multiple data to someone else.
1030 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001031 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001032 * <p>
1033 * Input: {@link #getType} is the MIME type of the data being sent.
1034 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001035 * #EXTRA_STREAM} field, containing the data to be sent. If using
1036 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1037 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001038 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001039 * Multiple types are supported, and receivers should handle mixed types
1040 * whenever possible. The right way for the receiver to check them is to
1041 * use the content resolver on each URI. The intent sender should try to
1042 * put the most concrete mime type in the intent type, but it can fall
1043 * back to {@literal <type>/*} or {@literal *}/* as needed.
1044 * <p>
1045 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1046 * be image/jpg, but if you are sending image/jpg and image/png, then the
1047 * intent's type should be image/*.
1048 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001049 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1050 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1051 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1052 * content: URIs and other advanced features of {@link ClipData}. If
1053 * using this approach, you still must supply the same data through the
1054 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1055 * for compatibility with old applications. If you don't set a ClipData,
1056 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1057 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001058 * Optional standard extras, which may be interpreted by some recipients as
1059 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1060 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1061 * <p>
1062 * Output: nothing.
1063 */
1064 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1065 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1066 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001067 * Activity Action: Handle an incoming phone call.
1068 * <p>Input: nothing.
1069 * <p>Output: nothing.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1073 /**
1074 * Activity Action: Insert an empty item into the given container.
1075 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1076 * in which to place the data.
1077 * <p>Output: URI of the new data that was created.
1078 */
1079 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1080 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1081 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001082 * Activity Action: Create a new item in the given container, initializing it
1083 * from the current contents of the clipboard.
1084 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1085 * in which to place the data.
1086 * <p>Output: URI of the new data that was created.
1087 */
1088 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1089 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1090 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001091 * Activity Action: Delete the given data from its container.
1092 * <p>Input: {@link #getData} is URI of data to be deleted.
1093 * <p>Output: nothing.
1094 */
1095 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1096 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1097 /**
1098 * Activity Action: Run the data, whatever that means.
1099 * <p>Input: ? (Note: this is currently specific to the test harness.)
1100 * <p>Output: nothing.
1101 */
1102 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1103 public static final String ACTION_RUN = "android.intent.action.RUN";
1104 /**
1105 * Activity Action: Perform a data synchronization.
1106 * <p>Input: ?
1107 * <p>Output: ?
1108 */
1109 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1110 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1111 /**
1112 * Activity Action: Pick an activity given an intent, returning the class
1113 * selected.
1114 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1115 * used with {@link PackageManager#queryIntentActivities} to determine the
1116 * set of activities from which to pick.
1117 * <p>Output: Class name of the activity that was selected.
1118 */
1119 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1120 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1121 /**
1122 * Activity Action: Perform a search.
1123 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1124 * is the text to search for. If empty, simply
1125 * enter your search results Activity with the search UI activated.
1126 * <p>Output: nothing.
1127 */
1128 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1129 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1130 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001131 * Activity Action: Start the platform-defined tutorial
1132 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1133 * is the text to search for. If empty, simply
1134 * enter your search results Activity with the search UI activated.
1135 * <p>Output: nothing.
1136 */
1137 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1138 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1139 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001140 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001141 * <p>
1142 * Input: {@link android.app.SearchManager#QUERY
1143 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1144 * a url starts with http or https, the site will be opened. If it is plain
1145 * text, Google search will be applied.
1146 * <p>
1147 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001148 */
1149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1150 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001151
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 /**
Jim Miller07994402012-05-02 14:22:27 -07001153 * Activity Action: Perform assist action.
1154 * <p>
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001155 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1156 * additional optional contextual information about where the user was when they requested
1157 * the assist.
Jim Miller07994402012-05-02 14:22:27 -07001158 * Output: nothing.
1159 */
1160 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1161 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001162
1163 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001164 * Activity Action: Perform voice assist action.
1165 * <p>
1166 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1167 * additional optional contextual information about where the user was when they requested
1168 * the voice assist.
1169 * Output: nothing.
1170 */
1171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1172 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1173
1174 /**
1175 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1176 * containing the name of the current foreground application package at the time
1177 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001178 */
1179 public static final String EXTRA_ASSIST_PACKAGE
1180 = "android.intent.extra.ASSIST_PACKAGE";
1181
1182 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001183 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1184 * containing additional contextual information supplied by the current
1185 * foreground app at the time of the assist request. This is a {@link Bundle} of
1186 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001187 */
1188 public static final String EXTRA_ASSIST_CONTEXT
1189 = "android.intent.extra.ASSIST_CONTEXT";
1190
Jim Miller07994402012-05-02 14:22:27 -07001191 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001192 * Activity Action: List all available applications
1193 * <p>Input: Nothing.
1194 * <p>Output: nothing.
1195 */
1196 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1197 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1198 /**
1199 * Activity Action: Show settings for choosing wallpaper
1200 * <p>Input: Nothing.
1201 * <p>Output: Nothing.
1202 */
1203 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1204 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1205
1206 /**
1207 * Activity Action: Show activity for reporting a bug.
1208 * <p>Input: Nothing.
1209 * <p>Output: Nothing.
1210 */
1211 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1212 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1213
1214 /**
1215 * Activity Action: Main entry point for factory tests. Only used when
1216 * the device is booting in factory test node. The implementing package
1217 * must be installed in the system image.
1218 * <p>Input: nothing
1219 * <p>Output: nothing
1220 */
1221 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1222
1223 /**
1224 * Activity Action: The user pressed the "call" button to go to the dialer
1225 * or other appropriate UI for placing a call.
1226 * <p>Input: Nothing.
1227 * <p>Output: Nothing.
1228 */
1229 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1230 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1231
1232 /**
1233 * Activity Action: Start Voice Command.
1234 * <p>Input: Nothing.
1235 * <p>Output: Nothing.
1236 */
1237 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1238 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001239
1240 /**
1241 * Activity Action: Start action associated with long pressing on the
1242 * search key.
1243 * <p>Input: Nothing.
1244 * <p>Output: Nothing.
1245 */
1246 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1247 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001248
Jacek Surazski86b6c532009-05-13 14:38:28 +02001249 /**
1250 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1251 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001252 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001253 * <p>Input: No data is specified. The bug report is passed in using
1254 * an {@link #EXTRA_BUG_REPORT} field.
1255 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001256 *
1257 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001258 */
1259 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1260 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001261
1262 /**
1263 * Activity Action: Show power usage information to the user.
1264 * <p>Input: Nothing.
1265 * <p>Output: Nothing.
1266 */
1267 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1268 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001269
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001270 /**
1271 * Activity Action: Setup wizard to launch after a platform update. This
1272 * activity should have a string meta-data field associated with it,
1273 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1274 * the platform for setup. The activity will be launched only if
1275 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1276 * same value.
1277 * <p>Input: Nothing.
1278 * <p>Output: Nothing.
1279 * @hide
1280 */
1281 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1282 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001283
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001284 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001285 * Activity Action: Show settings for managing network data usage of a
1286 * specific application. Applications should define an activity that offers
1287 * options to control data usage.
1288 */
1289 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1290 public static final String ACTION_MANAGE_NETWORK_USAGE =
1291 "android.intent.action.MANAGE_NETWORK_USAGE";
1292
1293 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001294 * Activity Action: Launch application installer.
1295 * <p>
1296 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001297 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1298 * you can also use "package:<package-name>" to install an application for the
1299 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001300 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1301 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1302 * <p>
1303 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1304 * succeeded.
1305 *
1306 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1307 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1308 * @see #EXTRA_RETURN_RESULT
1309 */
1310 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1311 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1312
1313 /**
1314 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1315 * package. Specifies the installer package name; this package will receive the
1316 * {@link #ACTION_APP_ERROR} intent.
1317 */
1318 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1319 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1320
1321 /**
1322 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1323 * package. Specifies that the application being installed should not be
1324 * treated as coming from an unknown source, but as coming from the app
1325 * invoking the Intent. For this to work you must start the installer with
1326 * startActivityForResult().
1327 */
1328 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1329 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1330
1331 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001332 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1333 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001334 * data field originated from.
1335 */
rich cannings706e8ba2012-08-20 13:20:14 -07001336 public static final String EXTRA_ORIGINATING_URI
1337 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001338
1339 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001340 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1341 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1342 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001343 */
1344 public static final String EXTRA_REFERRER
1345 = "android.intent.extra.REFERRER";
1346
1347 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001348 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1349 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1350 * @hide
1351 */
1352 public static final String EXTRA_ORIGINATING_UID
1353 = "android.intent.extra.ORIGINATING_UID";
1354
1355 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001356 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1357 * package. Tells the installer UI to skip the confirmation with the user
1358 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001359 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1360 * will no longer show an interstitial message about updating existing
1361 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001362 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001363 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001364 public static final String EXTRA_ALLOW_REPLACE
1365 = "android.intent.extra.ALLOW_REPLACE";
1366
1367 /**
1368 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1369 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1370 * return to the application the result code of the install/uninstall. The returned result
1371 * code will be {@link android.app.Activity#RESULT_OK} on success or
1372 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1373 */
1374 public static final String EXTRA_RETURN_RESULT
1375 = "android.intent.extra.RETURN_RESULT";
1376
1377 /**
1378 * Package manager install result code. @hide because result codes are not
1379 * yet ready to be exposed.
1380 */
1381 public static final String EXTRA_INSTALL_RESULT
1382 = "android.intent.extra.INSTALL_RESULT";
1383
1384 /**
1385 * Activity Action: Launch application uninstaller.
1386 * <p>
1387 * Input: The data must be a package: URI whose scheme specific part is
1388 * the package name of the current installed package to be uninstalled.
1389 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1390 * <p>
1391 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1392 * succeeded.
1393 */
1394 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1395 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1396
1397 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001398 * Specify whether the package should be uninstalled for all users.
1399 * @hide because these should not be part of normal application flow.
1400 */
1401 public static final String EXTRA_UNINSTALL_ALL_USERS
1402 = "android.intent.extra.UNINSTALL_ALL_USERS";
1403
1404 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001405 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1406 * describing the last run version of the platform that was setup.
1407 * @hide
1408 */
1409 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1410
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001411 // ---------------------------------------------------------------------
1412 // ---------------------------------------------------------------------
1413 // Standard intent broadcast actions (see action variable).
1414
1415 /**
1416 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001417 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001418 * <p class="note">This is a protected intent that can only be sent
1419 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001420 */
1421 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1422 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1423 /**
1424 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001425 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001426 * <p class="note">This is a protected intent that can only be sent
1427 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001428 */
1429 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1430 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001431
1432 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001433 * Broadcast Action: Sent after the system stops dreaming.
1434 *
1435 * <p class="note">This is a protected intent that can only be sent by the system.
1436 * It is only sent to registered receivers.</p>
1437 */
1438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1439 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1440
1441 /**
1442 * Broadcast Action: Sent after the system starts dreaming.
1443 *
1444 * <p class="note">This is a protected intent that can only be sent by the system.
1445 * It is only sent to registered receivers.</p>
1446 */
1447 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1448 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1449
1450 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001451 * 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 -07001452 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001453 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001454 * <p class="note">This is a protected intent that can only be sent
1455 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001456 */
1457 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001458 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001459
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001460 /**
1461 * Broadcast Action: The current time has changed. Sent every
1462 * minute. You can <em>not</em> receive this through components declared
John Spurlock6098c5d2013-06-17 10:32:46 -04001463 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001464 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1465 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001466 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001467 * <p class="note">This is a protected intent that can only be sent
1468 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001469 */
1470 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1471 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1472 /**
1473 * Broadcast Action: The time was set.
1474 */
1475 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1476 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1477 /**
1478 * Broadcast Action: The date has changed.
1479 */
1480 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1481 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1482 /**
1483 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1484 * <ul>
1485 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1486 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001487 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001488 * <p class="note">This is a protected intent that can only be sent
1489 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001490 */
1491 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1492 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1493 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001494 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1495 * DNS entries should be tossed.
1496 * @hide
1497 */
1498 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1499 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1500 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001501 * Alarm Changed Action: This is broadcast when the AlarmClock
1502 * application's alarm is set or unset. It is used by the
1503 * AlarmClock application and the StatusBar service.
1504 * @hide
1505 */
1506 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1507 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1508 /**
1509 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1510 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1511 * @hide
1512 */
1513 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1514 public static final String ACTION_SYNC_STATE_CHANGED
1515 = "android.intent.action.SYNC_STATE_CHANGED";
1516 /**
1517 * Broadcast Action: This is broadcast once, after the system has finished
1518 * booting. It can be used to perform application-specific initialization,
1519 * such as installing alarms. You must hold the
1520 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1521 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001522 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001523 * <p class="note">This is a protected intent that can only be sent
1524 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001525 */
1526 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1527 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1528 /**
1529 * Broadcast Action: This is broadcast when a user action should request a
1530 * temporary system dialog to dismiss. Some examples of temporary system
1531 * dialogs are the notification window-shade and the recent tasks dialog.
1532 */
1533 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1534 /**
1535 * Broadcast Action: Trigger the download and eventual installation
1536 * of a package.
1537 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001538 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001539 * <p class="note">This is a protected intent that can only be sent
1540 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001541 *
1542 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001543 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001544 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001545 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1546 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1547 /**
1548 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001549 * device. The data contains the name of the package. Note that the
1550 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001551 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001552 * <ul>
1553 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1554 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1555 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1556 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001557 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001558 * <p class="note">This is a protected intent that can only be sent
1559 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001560 */
1561 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1562 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1563 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001564 * Broadcast Action: A new version of an application package has been
1565 * installed, replacing an existing version that was previously installed.
1566 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001567 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001568 * <ul>
1569 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1570 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001571 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001572 * <p class="note">This is a protected intent that can only be sent
1573 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001574 */
1575 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1576 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1577 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001578 * Broadcast Action: A new version of your application has been installed
1579 * over an existing one. This is only sent to the application that was
1580 * replaced. It does not contain any additional data; to receive it, just
1581 * use an intent filter for this action.
1582 *
1583 * <p class="note">This is a protected intent that can only be sent
1584 * by the system.
1585 */
1586 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1587 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1588 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001589 * Broadcast Action: An existing application package has been removed from
1590 * the device. The data contains the name of the package. The package
1591 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001592 * <ul>
1593 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1594 * to the package.
1595 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1596 * application -- data and code -- is being removed.
1597 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1598 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1599 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001600 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001601 * <p class="note">This is a protected intent that can only be sent
1602 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001603 */
1604 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1605 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1606 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001607 * Broadcast Action: An existing application package has been completely
1608 * removed from the device. The data contains the name of the package.
1609 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1610 * {@link #EXTRA_DATA_REMOVED} is true and
1611 * {@link #EXTRA_REPLACING} is false of that broadcast.
1612 *
1613 * <ul>
1614 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1615 * to the package.
1616 * </ul>
1617 *
1618 * <p class="note">This is a protected intent that can only be sent
1619 * by the system.
1620 */
1621 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1622 public static final String ACTION_PACKAGE_FULLY_REMOVED
1623 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1624 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001625 * Broadcast Action: An existing application package has been changed (e.g.
1626 * a component has been enabled or disabled). The data contains the name of
1627 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001628 * <ul>
1629 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001630 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001631 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001632 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1633 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001634 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001635 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001636 * <p class="note">This is a protected intent that can only be sent
1637 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001638 */
1639 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1640 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1641 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001642 * @hide
1643 * Broadcast Action: Ask system services if there is any reason to
1644 * restart the given package. The data contains the name of the
1645 * package.
1646 * <ul>
1647 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1648 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1649 * </ul>
1650 *
1651 * <p class="note">This is a protected intent that can only be sent
1652 * by the system.
1653 */
1654 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1655 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1656 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001657 * Broadcast Action: The user has restarted a package, and all of its
1658 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001659 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001660 * be removed. Note that the restarted package does <em>not</em>
1661 * receive this broadcast.
1662 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001663 * <ul>
1664 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1665 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001666 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001667 * <p class="note">This is a protected intent that can only be sent
1668 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001669 */
1670 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1671 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1672 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001673 * Broadcast Action: The user has cleared the data of a package. This should
1674 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001675 * its persistent data is erased and this broadcast sent.
1676 * Note that the cleared package does <em>not</em>
1677 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001678 * <ul>
1679 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1680 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001681 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001682 * <p class="note">This is a protected intent that can only be sent
1683 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001684 */
1685 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1686 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1687 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001688 * Broadcast Action: A user ID has been removed from the system. The user
1689 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001690 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001691 * <p class="note">This is a protected intent that can only be sent
1692 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001693 */
1694 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1695 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001696
1697 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001698 * Broadcast Action: Sent to the installer package of an application
1699 * when that application is first launched (that is the first time it
1700 * is moved out of the stopped state). The data contains the name of the package.
1701 *
1702 * <p class="note">This is a protected intent that can only be sent
1703 * by the system.
1704 */
1705 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1706 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1707
1708 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001709 * Broadcast Action: Sent to the system package verifier when a package
1710 * needs to be verified. The data contains the package URI.
1711 * <p class="note">
1712 * This is a protected intent that can only be sent by the system.
1713 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001714 */
1715 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1716 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1717
1718 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001719 * Broadcast Action: Sent to the system package verifier when a package is
1720 * verified. The data contains the package URI.
1721 * <p class="note">
1722 * This is a protected intent that can only be sent by the system.
1723 */
1724 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1725 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1726
1727 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001728 * Broadcast Action: Resources for a set of packages (which were
1729 * previously unavailable) are currently
1730 * available since the media on which they exist is available.
1731 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1732 * list of packages whose availability changed.
1733 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1734 * list of uids of packages whose availability changed.
1735 * Note that the
1736 * packages in this list do <em>not</em> receive this broadcast.
1737 * The specified set of packages are now available on the system.
1738 * <p>Includes the following extras:
1739 * <ul>
1740 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1741 * whose resources(were previously unavailable) are currently available.
1742 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1743 * packages whose resources(were previously unavailable)
1744 * are currently available.
1745 * </ul>
1746 *
1747 * <p class="note">This is a protected intent that can only be sent
1748 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001749 */
1750 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001751 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1752 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001753
1754 /**
1755 * Broadcast Action: Resources for a set of packages are currently
1756 * unavailable since the media on which they exist is unavailable.
1757 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1758 * list of packages whose availability changed.
1759 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1760 * list of uids of packages whose availability changed.
1761 * The specified set of packages can no longer be
1762 * launched and are practically unavailable on the system.
1763 * <p>Inclues the following extras:
1764 * <ul>
1765 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1766 * whose resources are no longer available.
1767 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1768 * whose resources are no longer available.
1769 * </ul>
1770 *
1771 * <p class="note">This is a protected intent that can only be sent
1772 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001773 */
1774 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001775 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001776 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001777
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001778 /**
1779 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001780 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001781 * This should <em>only</em> be used to determine when the wallpaper
1782 * has changed to show the new wallpaper to the user. You should certainly
1783 * never, in response to this, change the wallpaper or other attributes of
1784 * it such as the suggested size. That would be crazy, right? You'd cause
1785 * all kinds of loops, especially if other apps are doing similar things,
1786 * right? Of course. So please don't do this.
1787 *
1788 * @deprecated Modern applications should use
1789 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1790 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1791 * shown behind their UI, rather than watching for this broadcast and
1792 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001794 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001795 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1796 /**
1797 * Broadcast Action: The current device {@link android.content.res.Configuration}
1798 * (orientation, locale, etc) has changed. When such a change happens, the
1799 * UIs (view hierarchy) will need to be rebuilt based on this new
1800 * information; for the most part, applications don't need to worry about
1801 * this, because the system will take care of stopping and restarting the
1802 * application to make sure it sees the new changes. Some system code that
1803 * can not be restarted will need to watch for this action and handle it
1804 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001805 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001806 * <p class="note">
1807 * You can <em>not</em> receive this through components declared
1808 * in manifests, only by explicitly registering for it with
1809 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1810 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001811 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001812 * <p class="note">This is a protected intent that can only be sent
1813 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001814 *
1815 * @see android.content.res.Configuration
1816 */
1817 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1818 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1819 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001820 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001821 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001822 * <p class="note">This is a protected intent that can only be sent
1823 * by the system.
1824 */
1825 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1826 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1827 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001828 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1829 * charging state, level, and other information about the battery.
1830 * See {@link android.os.BatteryManager} for documentation on the
1831 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001832 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001833 * <p class="note">
1834 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001835 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001836 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001837 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1838 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1839 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1840 * broadcasts that are sent and can be received through manifest
1841 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1848 /**
1849 * Broadcast Action: Indicates low battery condition on the device.
1850 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001851 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001852 * <p class="note">This is a protected intent that can only be sent
1853 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001854 */
1855 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1856 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1857 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001858 * Broadcast Action: Indicates the battery is now okay after being low.
1859 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1860 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001861 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001862 * <p class="note">This is a protected intent that can only be sent
1863 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001864 */
1865 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1866 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1867 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001868 * Broadcast Action: External power has been connected to the device.
1869 * This is intended for applications that wish to register specifically to this notification.
1870 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1871 * stay active to receive this notification. This action can be used to implement actions
1872 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001873 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001874 * <p class="note">This is a protected intent that can only be sent
1875 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001876 */
1877 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001878 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001879 /**
1880 * Broadcast Action: External power has been removed from the device.
1881 * This is intended for applications that wish to register specifically to this notification.
1882 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1883 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001884 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001885 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001886 * <p class="note">This is a protected intent that can only be sent
1887 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001888 */
1889 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001890 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001891 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001892 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001893 * Broadcast Action: Device is shutting down.
1894 * This is broadcast when the device is being shut down (completely turned
1895 * off, not sleeping). Once the broadcast is complete, the final shutdown
1896 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001897 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001898 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001899 * <p class="note">This is a protected intent that can only be sent
1900 * by the system.
Dianne Hackborn57a7f592013-07-22 18:21:32 -07001901 * <p>May include the following extras:
1902 * <ul>
1903 * <li> {@link #EXTRA_SHUTDOWN_USERSPACE_ONLY} a boolean that is set to true if this
1904 * shutdown is only for userspace processes. If not set, assumed to be false.
1905 * </ul>
Dianne Hackborn55280a92009-05-07 15:53:46 -07001906 */
1907 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001908 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001909 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001910 * Activity Action: Start this activity to request system shutdown.
1911 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1912 * to request confirmation from the user before shutting down.
1913 *
1914 * <p class="note">This is a protected intent that can only be sent
1915 * by the system.
1916 *
1917 * {@hide}
1918 */
1919 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1920 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001921 * Broadcast Action: A sticky broadcast that indicates low memory
1922 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001923 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001924 * <p class="note">This is a protected intent that can only be sent
1925 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1929 /**
1930 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001931 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001932 * <p class="note">This is a protected intent that can only be sent
1933 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001934 */
1935 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1936 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1937 /**
Jake Hambybb371632010-08-23 18:16:48 -07001938 * Broadcast Action: A sticky broadcast that indicates a memory full
1939 * condition on the device. This is intended for activities that want
1940 * to be able to fill the data partition completely, leaving only
1941 * enough free space to prevent system-wide SQLite failures.
1942 *
1943 * <p class="note">This is a protected intent that can only be sent
1944 * by the system.
1945 *
1946 * {@hide}
1947 */
1948 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1949 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1950 /**
1951 * Broadcast Action: Indicates memory full condition on the device
1952 * no longer exists.
1953 *
1954 * <p class="note">This is a protected intent that can only be sent
1955 * by the system.
1956 *
1957 * {@hide}
1958 */
1959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1960 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1961 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001962 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1963 * and package management should be started.
1964 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1965 * notification.
1966 */
1967 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1968 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1969 /**
1970 * Broadcast Action: The device has entered USB Mass Storage mode.
1971 * This is used mainly for the USB Settings panel.
1972 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1973 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001974 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001975 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001976 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001977 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1978
1979 /**
1980 * Broadcast Action: The device has exited USB Mass Storage mode.
1981 * This is used mainly for the USB Settings panel.
1982 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1983 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001984 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001985 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001986 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001987 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1988
1989 /**
1990 * Broadcast Action: External media has been removed.
1991 * The path to the mount point for the removed media is contained in the Intent.mData field.
1992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1995
1996 /**
1997 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001998 * 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 -07001999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
2002
2003 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002004 * Broadcast Action: External media is present, and being disk-checked
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_CHECKING = "android.intent.action.MEDIA_CHECKING";
2009
2010 /**
2011 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2012 * 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 -08002013 */
2014 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2015 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2016
2017 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002018 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002019 * 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 -07002020 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2021 * media was mounted read only.
2022 */
2023 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2024 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2025
2026 /**
2027 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002028 * 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 -07002029 */
2030 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2031 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2032
2033 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002034 * Broadcast Action: External media is no longer being shared via USB mass storage.
2035 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2036 *
2037 * @hide
2038 */
2039 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2040
2041 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002042 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2043 * The path to the mount point for the removed media is contained in the Intent.mData field.
2044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2047
2048 /**
2049 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002050 * 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 -07002051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2054
2055 /**
2056 * Broadcast Action: User has expressed the desire to remove the external storage media.
2057 * Applications should close all files they have open within the mount point when they receive this intent.
2058 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2059 */
2060 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2061 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2062
2063 /**
2064 * Broadcast Action: The media scanner has started scanning a directory.
2065 * The path to the directory being scanned is contained in the Intent.mData field.
2066 */
2067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2068 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2069
2070 /**
2071 * Broadcast Action: The media scanner has finished scanning a directory.
2072 * The path to the scanned directory is contained in the Intent.mData field.
2073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2076
2077 /**
2078 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2079 * The path to the file is contained in the Intent.mData field.
2080 */
2081 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2082 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2083
2084 /**
2085 * Broadcast Action: The "Media Button" was pressed. Includes a single
2086 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2087 * caused the broadcast.
2088 */
2089 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2090 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2091
2092 /**
2093 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2094 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2095 * caused the broadcast.
2096 */
2097 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2098 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2099
2100 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2101 // location; they are not general-purpose actions.
2102
2103 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002104 * Broadcast Action: A GTalk connection has been established.
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_CONNECTED =
2108 "android.intent.action.GTALK_CONNECTED";
2109
2110 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002111 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002112 */
2113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2115 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002116
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002117 /**
2118 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002119 */
2120 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2121 public static final String ACTION_INPUT_METHOD_CHANGED =
2122 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002123
2124 /**
2125 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2126 * more radios have been turned off or on. The intent will have the following extra value:</p>
2127 * <ul>
2128 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2129 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2130 * turned off</li>
2131 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002132 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002133 * <p class="note">This is a protected intent that can only be sent
2134 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2138
2139 /**
2140 * Broadcast Action: Some content providers have parts of their namespace
2141 * where they publish new events or items that the user may be especially
2142 * interested in. For these things, they may broadcast this action when the
2143 * set of interesting items change.
2144 *
2145 * For example, GmailProvider sends this notification when the set of unread
2146 * mail in the inbox changes.
2147 *
2148 * <p>The data of the intent identifies which part of which provider
2149 * changed. When queried through the content resolver, the data URI will
2150 * return the data set in question.
2151 *
2152 * <p>The intent will have the following extra values:
2153 * <ul>
2154 * <li><em>count</em> - The number of items in the data set. This is the
2155 * same as the number of items in the cursor returned by querying the
2156 * data URI. </li>
2157 * </ul>
2158 *
2159 * This intent will be sent at boot (if the count is non-zero) and when the
2160 * data set changes. It is possible for the data set to change without the
2161 * count changing (for example, if a new unread message arrives in the same
2162 * sync operation in which a message is archived). The phone should still
2163 * ring/vibrate/etc as normal in this case.
2164 */
2165 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2166 public static final String ACTION_PROVIDER_CHANGED =
2167 "android.intent.action.PROVIDER_CHANGED";
2168
2169 /**
2170 * Broadcast Action: Wired Headset plugged in or unplugged.
2171 *
2172 * <p>The intent will have the following extra values:
2173 * <ul>
2174 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2175 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002176 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002177 * </ul>
2178 * </ul>
2179 */
2180 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2181 public static final String ACTION_HEADSET_PLUG =
2182 "android.intent.action.HEADSET_PLUG";
2183
2184 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002185 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2186 *
2187 * <p>The intent will have the following extra values:
2188 * <ul>
2189 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2190 * <li><em>name</em> - Headset type, human readable string </li>
2191 * </ul>
2192 * </ul>
2193 * @hide
2194 */
2195 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002196 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2197 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002198
2199 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002200 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002201 *
2202 * <p>The intent will have the following extra values:
2203 * <ul>
2204 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2205 * <li><em>name</em> - Headset type, human readable string </li>
2206 * </ul>
2207 * </ul>
2208 * @hide
2209 */
2210 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002211 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2212 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002213
2214 /**
2215 * Broadcast Action: A HMDI cable was plugged or unplugged
2216 *
2217 * <p>The intent will have the following extra values:
2218 * <ul>
2219 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2220 * <li><em>name</em> - HDMI cable, human readable string </li>
2221 * </ul>
2222 * </ul>
2223 * @hide
2224 */
2225 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2226 public static final String ACTION_HDMI_AUDIO_PLUG =
2227 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002228
2229 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002230 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2231 *
2232 * <p>The intent will have the following extra values:
2233 * <ul>
2234 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2235 * <li><em>card</em> - ALSA card number (integer) </li>
2236 * <li><em>device</em> - ALSA device number (integer) </li>
2237 * </ul>
2238 * </ul>
2239 * @hide
2240 */
2241 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2242 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2243 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2244
2245 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002246 * Broadcast Action: A USB audio device was plugged in or unplugged.
2247 *
2248 * <p>The intent will have the following extra values:
2249 * <ul>
2250 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2251 * <li><em>card</em> - ALSA card number (integer) </li>
2252 * <li><em>device</em> - ALSA device number (integer) </li>
2253 * </ul>
2254 * </ul>
2255 * @hide
2256 */
2257 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2258 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2259 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2260
2261 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002262 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2263 * <ul>
2264 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2265 * </ul>
2266 *
2267 * <p class="note">This is a protected intent that can only be sent
2268 * by the system.
2269 *
2270 * @hide
2271 */
2272 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2273 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2274 = "android.intent.action.ADVANCED_SETTINGS";
2275
2276 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002277 * Broadcast Action: An outgoing call is about to be placed.
2278 *
Dirk Dougherty367ce902013-05-28 17:37:12 -07002279 * <p>The Intent will have the following extra value:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002280 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002281 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002282 * the phone number originally intended to be dialed.</li>
2283 * </ul>
2284 * <p>Once the broadcast is finished, the resultData is used as the actual
2285 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002286 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002287 * outgoing call in turn: for example, a parental control application
2288 * might verify that the user is authorized to place the call at that
2289 * time, then a number-rewriting application might add an area code if
2290 * one was not specified.</p>
2291 * <p>For consistency, any receiver whose purpose is to prohibit phone
2292 * calls should have a priority of 0, to ensure it will see the final
2293 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002294 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002295 * should have a positive priority.
2296 * Negative priorities are reserved for the system for this broadcast;
2297 * using them may cause problems.</p>
Dirk Dougherty932fbcc2013-05-29 15:19:14 -07002298 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2299 * abort the broadcast.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002300 * <p>Emergency calls cannot be intercepted using this mechanism, and
2301 * other calls cannot be modified to call emergency numbers using this
2302 * mechanism.
Santos Cordonba701362013-05-17 14:48:54 -07002303 * <p>Some apps (such as VoIP apps) may want to redirect the outgoing
2304 * call to use their own service instead. Those apps should first prevent
2305 * the call from being placed by setting resultData to <code>null</code>
2306 * and then start their own app to make the call.
The Android Open Source Project10592532009-03-18 17:39:46 -07002307 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002308 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2309 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002310 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002311 * <p class="note">This is a protected intent that can only be sent
2312 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002313 */
2314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2315 public static final String ACTION_NEW_OUTGOING_CALL =
2316 "android.intent.action.NEW_OUTGOING_CALL";
2317
2318 /**
2319 * Broadcast Action: Have the device reboot. This is only for use by
2320 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002321 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002322 * <p class="note">This is a protected intent that can only be sent
2323 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002324 */
2325 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2326 public static final String ACTION_REBOOT =
2327 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002328
Wei Huang97ecc9c2009-05-11 17:44:20 -07002329 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002330 * Broadcast Action: A sticky broadcast for changes in the physical
2331 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002332 *
2333 * <p>The intent will have the following extra values:
2334 * <ul>
2335 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002336 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002337 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002338 * <p>This is intended for monitoring the current physical dock state.
2339 * See {@link android.app.UiModeManager} for the normal API dealing with
2340 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002341 */
2342 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2343 public static final String ACTION_DOCK_EVENT =
2344 "android.intent.action.DOCK_EVENT";
2345
2346 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002347 * Broadcast Action: A broadcast when idle maintenance can be started.
2348 * This means that the user is not interacting with the device and is
2349 * not expected to do so soon. Typical use of the idle maintenance is
2350 * to perform somehow expensive tasks that can be postponed at a moment
2351 * when they will not degrade user experience.
2352 * <p>
2353 * <p class="note">In order to keep the device responsive in case of an
2354 * unexpected user interaction, implementations of a maintenance task
2355 * should be interruptible. In such a scenario a broadcast with action
2356 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2357 * should not do the maintenance work in
2358 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2359 * maintenance service by {@link Context#startService(Intent)}. Also
2360 * you should hold a wake lock while your maintenance service is running
2361 * to prevent the device going to sleep.
2362 * </p>
2363 * <p>
2364 * <p class="note">This is a protected intent that can only be sent by
2365 * the system.
2366 * </p>
2367 *
2368 * @see #ACTION_IDLE_MAINTENANCE_END
Svetoslav6a08a122013-05-03 11:24:26 -07002369 *
2370 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002371 */
2372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2373 public static final String ACTION_IDLE_MAINTENANCE_START =
2374 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2375
2376 /**
2377 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2378 * This means that the user was not interacting with the device as a result
2379 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2380 * was sent and now the user started interacting with the device. Typical
2381 * use of the idle maintenance is to perform somehow expensive tasks that
2382 * can be postponed at a moment when they will not degrade user experience.
2383 * <p>
2384 * <p class="note">In order to keep the device responsive in case of an
2385 * unexpected user interaction, implementations of a maintenance task
2386 * should be interruptible. Hence, on receiving a broadcast with this
2387 * action, the maintenance task should be interrupted as soon as possible.
2388 * In other words, you should not do the maintenance work in
2389 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2390 * maintenance service that was started on receiving of
2391 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2392 * lock you acquired when your maintenance service started.
2393 * </p>
2394 * <p class="note">This is a protected intent that can only be sent
2395 * by the system.
2396 *
2397 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002398 *
2399 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002400 */
2401 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2402 public static final String ACTION_IDLE_MAINTENANCE_END =
2403 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2404
2405 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002406 * Broadcast Action: a remote intent is to be broadcasted.
2407 *
2408 * A remote intent is used for remote RPC between devices. The remote intent
2409 * is serialized and sent from one device to another device. The receiving
2410 * device parses the remote intent and broadcasts it. Note that anyone can
2411 * broadcast a remote intent. However, if the intent receiver of the remote intent
2412 * does not trust intent broadcasts from arbitrary intent senders, it should require
2413 * the sender to hold certain permissions so only trusted sender's broadcast will be
2414 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002415 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002416 */
2417 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002418 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002419
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002420 /**
2421 * Broadcast Action: hook for permforming cleanup after a system update.
2422 *
2423 * The broadcast is sent when the system is booting, before the
2424 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2425 * image. A receiver for this should do its work and then disable itself
2426 * so that it does not get run again at the next boot.
2427 * @hide
2428 */
2429 public static final String ACTION_PRE_BOOT_COMPLETED =
2430 "android.intent.action.PRE_BOOT_COMPLETED";
2431
Amith Yamasani13593602012-03-22 16:16:17 -07002432 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002433 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002434 * on restricted users. The broadcast intent contains an extra
2435 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2436 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2437 * String[] depending on the restriction type.<p/>
2438 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002439 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2440 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2441 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002442 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2443 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002444 * @see RestrictionEntry
2445 */
2446 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2447 "android.intent.action.GET_RESTRICTION_ENTRIES";
2448
2449 /**
Amith Yamasani655d0e22013-06-12 14:19:10 -07002450 * Activity to challenge the user for a PIN that was configured when setting up
2451 * restrictions. Launch the activity using
2452 * {@link android.app.Activity#startActivityForResult(Intent, int)} and check if the
2453 * result is {@link android.app.Activity#RESULT_OK} for a successful response to the
2454 * challenge.<p/>
2455 * Before launching this activity, make sure that there is a PIN in effect, by calling
2456 * {@link android.os.UserManager#hasRestrictionsPin()}.
2457 */
2458 public static final String ACTION_RESTRICTIONS_PIN_CHALLENGE =
2459 "android.intent.action.RESTRICTIONS_PIN_CHALLENGE";
2460
2461 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002462 * Sent the first time a user is starting, to allow system apps to
2463 * perform one time initialization. (This will not be seen by third
2464 * party applications because a newly initialized user does not have any
2465 * third party applications installed for it.) This is sent early in
2466 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002467 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2468 * broadcast, since it is part of a visible user interaction; be as quick
2469 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002470 */
2471 public static final String ACTION_USER_INITIALIZE =
2472 "android.intent.action.USER_INITIALIZE";
2473
2474 /**
2475 * Sent when a user switch is happening, causing the process's user to be
2476 * brought to the foreground. This is only sent to receivers registered
2477 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2478 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002479 * foreground. This is sent as a foreground
2480 * broadcast, since it is part of a visible user interaction; be as quick
2481 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002482 */
2483 public static final String ACTION_USER_FOREGROUND =
2484 "android.intent.action.USER_FOREGROUND";
2485
2486 /**
2487 * Sent when a user switch is happening, causing the process's user to be
2488 * sent to the background. This is only sent to receivers registered
2489 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2490 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002491 * background. This is sent as a foreground
2492 * broadcast, since it is part of a visible user interaction; be as quick
2493 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002494 */
2495 public static final String ACTION_USER_BACKGROUND =
2496 "android.intent.action.USER_BACKGROUND";
2497
2498 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002499 * Broadcast sent to the system when a user is added. Carries an extra
2500 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2501 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002502 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002503 * @hide
2504 */
2505 public static final String ACTION_USER_ADDED =
2506 "android.intent.action.USER_ADDED";
2507
2508 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002509 * Broadcast sent by the system when a user is started. Carries an extra
2510 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002511 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002512 * that has been started. This is sent as a foreground
2513 * broadcast, since it is part of a visible user interaction; be as quick
2514 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002515 * @hide
2516 */
2517 public static final String ACTION_USER_STARTED =
2518 "android.intent.action.USER_STARTED";
2519
2520 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002521 * Broadcast sent when a user is in the process of starting. Carries an extra
2522 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2523 * sent to registered receivers, not manifest receivers. It is sent to all
2524 * users (including the one that is being started). You must hold
2525 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2526 * this broadcast. This is sent as a background broadcast, since
2527 * its result is not part of the primary UX flow; to safely keep track of
2528 * started/stopped state of a user you can use this in conjunction with
2529 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2530 * other user state broadcasts since those are foreground broadcasts so can
2531 * execute in a different order.
2532 * @hide
2533 */
2534 public static final String ACTION_USER_STARTING =
2535 "android.intent.action.USER_STARTING";
2536
2537 /**
2538 * Broadcast sent when a user is going to be stopped. Carries an extra
2539 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2540 * sent to registered receivers, not manifest receivers. It is sent to all
2541 * users (including the one that is being stopped). You must hold
2542 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2543 * this broadcast. The user will not stop until all receivers have
2544 * handled the broadcast. This is sent as a background broadcast, since
2545 * its result is not part of the primary UX flow; to safely keep track of
2546 * started/stopped state of a user you can use this in conjunction with
2547 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2548 * other user state broadcasts since those are foreground broadcasts so can
2549 * execute in a different order.
2550 * @hide
2551 */
2552 public static final String ACTION_USER_STOPPING =
2553 "android.intent.action.USER_STOPPING";
2554
2555 /**
2556 * Broadcast sent to the system when a user is stopped. Carries an extra
2557 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2558 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2559 * specific package. This is only sent to registered receivers, not manifest
2560 * receivers. It is sent to all running users <em>except</em> the one that
2561 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002562 * @hide
2563 */
2564 public static final String ACTION_USER_STOPPED =
2565 "android.intent.action.USER_STOPPED";
2566
2567 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002568 * 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 -07002569 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002570 * one that has been removed. The user will not be completely removed until all receivers have
2571 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002572 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002573 * @hide
2574 */
2575 public static final String ACTION_USER_REMOVED =
2576 "android.intent.action.USER_REMOVED";
2577
2578 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002579 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002580 * the userHandle of the user to become the current one. This is only sent to
2581 * registered receivers, not manifest receivers. It is sent to all running users.
2582 * You must hold
2583 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002584 * @hide
2585 */
2586 public static final String ACTION_USER_SWITCHED =
2587 "android.intent.action.USER_SWITCHED";
2588
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002589 /**
2590 * Broadcast sent to the system when a user's information changes. Carries an extra
2591 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
Amith Yamasani6fc1d4e2013-05-08 16:43:58 -07002592 * This is only sent to registered receivers, not manifest receivers. It is sent to all users.
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002593 * @hide
2594 */
2595 public static final String ACTION_USER_INFO_CHANGED =
2596 "android.intent.action.USER_INFO_CHANGED";
2597
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002598 /**
2599 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2600 */
2601 public static final String ACTION_QUICK_CLOCK =
2602 "android.intent.action.QUICK_CLOCK";
2603
Michael Wright0087a142013-02-05 16:29:39 -08002604 /**
2605 * Broadcast Action: This is broadcast when a user action should request the
2606 * brightness setting dialog.
2607 * @hide
2608 */
2609 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2610 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2611
Justin Kohd378ad72013-04-01 12:18:26 -07002612 /**
2613 * Broadcast Action: A global button was pressed. Includes a single
2614 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2615 * caused the broadcast.
2616 * @hide
2617 */
2618 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2619
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002620 /**
2621 * Activity Action: Allow the user to select and open one or more existing
2622 * documents. Both read and write access to the documents will be granted
2623 * until explicitly revoked by the user.
2624 * <p>
2625 * Callers can restrict selection to a specific kind of data, such as
2626 * photos, by setting one or more MIME types in {@link #EXTRA_MIME_TYPES}.
2627 * <p>
2628 * If the caller can handle multiple returned items (the user performing
2629 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE} to
2630 * indicate this.
2631 * <p>
2632 * All returned URIs can be opened as a stream with
2633 * {@link ContentResolver#openInputStream(Uri)}.
2634 * <p>
2635 * Output: The URI of the item that was picked. This must be a content: URI
2636 * so that any receiver can access it.
2637 */
2638 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2639 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2640
2641 /**
2642 * Activity Action: Allow the user to create a new document. Both read and
2643 * write access to the document will be granted until explicitly revoked by
2644 * the user.
2645 * <p>
2646 * Callers can provide a hint document name by setting {@link #EXTRA_TITLE},
2647 * but the user may change this value before creating the file. Callers can
2648 * optionally hint at the MIME type being created by setting
2649 * {@link #setType(String)}.
2650 * <p>
2651 * All returned URIs can be opened as a stream with
2652 * {@link ContentResolver#openOutputStream(Uri)}.
2653 * <p>
2654 * Output: The URI of the item that was created. This must be a content: URI
2655 * so that any receiver can access it.
2656 */
2657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2658 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002660 // ---------------------------------------------------------------------
2661 // ---------------------------------------------------------------------
2662 // Standard intent categories (see addCategory()).
2663
2664 /**
2665 * Set if the activity should be an option for the default action
2666 * (center press) to perform on a piece of data. Setting this will
2667 * hide from the user any activities without it set when performing an
John Spurlock6098c5d2013-06-17 10:32:46 -04002668 * action on some data. Note that this is normally -not- set in the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002669 * Intent when initiating an action -- it is for use in intent filters
2670 * specified in packages.
2671 */
2672 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2673 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2674 /**
2675 * Activities that can be safely invoked from a browser must support this
2676 * category. For example, if the user is viewing a web page or an e-mail
2677 * and clicks on a link in the text, the Intent generated execute that
2678 * link will require the BROWSABLE category, so that only activities
2679 * supporting this category will be considered as possible actions. By
2680 * supporting this category, you are promising that there is nothing
2681 * damaging (without user intervention) that can happen by invoking any
2682 * matching Intent.
2683 */
2684 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2685 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2686 /**
2687 * Set if the activity should be considered as an alternative action to
2688 * the data the user is currently viewing. See also
2689 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2690 * applies to the selection in a list of items.
2691 *
2692 * <p>Supporting this category means that you would like your activity to be
2693 * displayed in the set of alternative things the user can do, usually as
2694 * part of the current activity's options menu. You will usually want to
2695 * include a specific label in the &lt;intent-filter&gt; of this action
2696 * describing to the user what it does.
2697 *
2698 * <p>The action of IntentFilter with this category is important in that it
2699 * describes the specific action the target will perform. This generally
2700 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2701 * a specific name such as "com.android.camera.action.CROP. Only one
2702 * alternative of any particular action will be shown to the user, so using
2703 * a specific action like this makes sure that your alternative will be
2704 * displayed while also allowing other applications to provide their own
2705 * overrides of that particular action.
2706 */
2707 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2708 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2709 /**
2710 * Set if the activity should be considered as an alternative selection
2711 * action to the data the user has currently selected. This is like
2712 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2713 * of items from which the user can select, giving them alternatives to the
2714 * default action that will be performed on it.
2715 */
2716 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2717 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2718 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002719 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002720 */
2721 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2722 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2723 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002724 * Should be displayed in the top-level launcher.
2725 */
2726 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2727 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2728 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002729 * Provides information about the package it is in; typically used if
2730 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2731 * a front-door to the user without having to be shown in the all apps list.
2732 */
2733 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2734 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2735 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002736 * This is the home activity, that is the first activity that is displayed
2737 * when the device boots.
2738 */
2739 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2740 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2741 /**
2742 * This activity is a preference panel.
2743 */
2744 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2745 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2746 /**
2747 * This activity is a development preference panel.
2748 */
2749 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2750 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2751 /**
2752 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002753 */
2754 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2755 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2756 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002757 * This activity allows the user to browse and download new applications.
2758 */
2759 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2760 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2761 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002762 * This activity may be exercised by the monkey or other automated test tools.
2763 */
2764 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2765 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2766 /**
2767 * To be used as a test (not part of the normal user experience).
2768 */
2769 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2770 /**
2771 * To be used as a unit test (run through the Test Harness).
2772 */
2773 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2774 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002775 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002776 * experience).
2777 */
2778 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2779 /**
2780 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002781 * ContentResolver.openInputStream. Openable URIs must support the columns in
2782 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002783 * when queried, though it is allowable for those columns to be blank.
2784 */
2785 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2786 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2787
2788 /**
2789 * To be used as code under test for framework instrumentation tests.
2790 */
2791 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2792 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002793 /**
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_CAR_DOCK = "android.intent.category.CAR_DOCK";
2800 /**
2801 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002802 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2803 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002804 */
2805 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2806 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002807 /**
2808 * An activity to run when device is inserted into a analog (low end) dock.
2809 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2810 * information, see {@link android.app.UiModeManager}.
2811 */
2812 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2813 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2814
2815 /**
2816 * An activity to run when device is inserted into a digital (high end) dock.
2817 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2818 * information, see {@link android.app.UiModeManager}.
2819 */
2820 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2821 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002822
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002823 /**
2824 * Used to indicate that the activity can be used in a car environment.
2825 */
2826 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2827 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2828
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002829 // ---------------------------------------------------------------------
2830 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002831 // Application launch intent categories (see addCategory()).
2832
2833 /**
2834 * Used with {@link #ACTION_MAIN} to launch the browser application.
2835 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002836 * <p>NOTE: This should not be used as the primary key of an Intent,
2837 * since it will not result in the app launching with the correct
2838 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002839 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002840 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002841 */
2842 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2843 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2844
2845 /**
2846 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2847 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002848 * <p>NOTE: This should not be used as the primary key of an Intent,
2849 * since it will not result in the app launching with the correct
2850 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002851 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002852 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002853 */
2854 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2855 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2856
2857 /**
2858 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2859 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002860 * <p>NOTE: This should not be used as the primary key of an Intent,
2861 * since it will not result in the app launching with the correct
2862 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002863 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002864 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002865 */
2866 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2867 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2868
2869 /**
2870 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2871 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002872 * <p>NOTE: This should not be used as the primary key of an Intent,
2873 * since it will not result in the app launching with the correct
2874 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002875 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002876 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002877 */
2878 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2879 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2880
2881 /**
2882 * Used with {@link #ACTION_MAIN} to launch the email application.
2883 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002884 * <p>NOTE: This should not be used as the primary key of an Intent,
2885 * since it will not result in the app launching with the correct
2886 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002887 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002888 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002889 */
2890 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2891 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2892
2893 /**
2894 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2895 * The activity should be able to view and manipulate image and video files
2896 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002897 * <p>NOTE: This should not be used as the primary key of an Intent,
2898 * since it will not result in the app launching with the correct
2899 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002900 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002901 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002902 */
2903 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2904 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2905
2906 /**
2907 * Used with {@link #ACTION_MAIN} to launch the maps application.
2908 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002909 * <p>NOTE: This should not be used as the primary key of an Intent,
2910 * since it will not result in the app launching with the correct
2911 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002912 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002913 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002914 */
2915 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2916 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2917
2918 /**
2919 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2920 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002921 * <p>NOTE: This should not be used as the primary key of an Intent,
2922 * since it will not result in the app launching with the correct
2923 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002924 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002925 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002926 */
2927 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2928 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2929
2930 /**
2931 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002932 * The activity should be able to play, browse, or manipulate music files
2933 * stored on the device.
2934 * <p>NOTE: This should not be used as the primary key of an Intent,
2935 * since it will not result in the app launching with the correct
2936 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002937 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002938 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002939 */
2940 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2941 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2942
2943 // ---------------------------------------------------------------------
2944 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002945 // Standard extra data keys.
2946
2947 /**
2948 * The initial data to place in a newly created record. Use with
2949 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2950 * fields as would be given to the underlying ContentProvider.insert()
2951 * call.
2952 */
2953 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2954
2955 /**
2956 * A constant CharSequence that is associated with the Intent, used with
2957 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2958 * this may be a styled CharSequence, so you must use
2959 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2960 * retrieve it.
2961 */
2962 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2963
2964 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002965 * A constant String that is associated with the Intent, used with
2966 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2967 * as HTML formatted text. Note that you <em>must</em> also supply
2968 * {@link #EXTRA_TEXT}.
2969 */
2970 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2971
2972 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002973 * A content: URI holding a stream of data associated with the Intent,
2974 * used with {@link #ACTION_SEND} to supply the data being sent.
2975 */
2976 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2977
2978 /**
2979 * A String[] holding e-mail addresses that should be delivered to.
2980 */
2981 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2982
2983 /**
2984 * A String[] holding e-mail addresses that should be carbon copied.
2985 */
2986 public static final String EXTRA_CC = "android.intent.extra.CC";
2987
2988 /**
2989 * A String[] holding e-mail addresses that should be blind carbon copied.
2990 */
2991 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2992
2993 /**
2994 * A constant string holding the desired subject line of a message.
2995 */
2996 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2997
2998 /**
2999 * An Intent describing the choices you would like shown with
3000 * {@link #ACTION_PICK_ACTIVITY}.
3001 */
3002 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
3003
3004 /**
3005 * A CharSequence dialog title to provide to the user when used with a
3006 * {@link #ACTION_CHOOSER}.
3007 */
3008 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
3009
3010 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07003011 * A Parcelable[] of {@link Intent} or
3012 * {@link android.content.pm.LabeledIntent} objects as set with
3013 * {@link #putExtra(String, Parcelable[])} of additional activities to place
3014 * a the front of the list of choices, when shown to the user with a
3015 * {@link #ACTION_CHOOSER}.
3016 */
3017 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
3018
3019 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003020 * A {@link android.view.KeyEvent} object containing the event that
3021 * triggered the creation of the Intent it is in.
3022 */
3023 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
3024
3025 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003026 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3027 * before shutting down.
3028 *
3029 * {@hide}
3030 */
3031 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3032
3033 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003034 * 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 -07003035 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3036 * of restarting the application.
3037 */
3038 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3039
3040 /**
3041 * A String holding the phone number originally entered in
3042 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3043 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3044 */
3045 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003046
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003047 /**
3048 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3049 * intents to supply the uid the package had been assigned. Also an optional
3050 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3051 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3052 * purpose.
3053 */
3054 public static final String EXTRA_UID = "android.intent.extra.UID";
3055
3056 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003057 * @hide String array of package names.
3058 */
3059 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3060
3061 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003062 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3063 * intents to indicate whether this represents a full uninstall (removing
3064 * both the code and its data) or a partial uninstall (leaving its data,
3065 * implying that this is an update).
3066 */
3067 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003068
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003069 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003070 * @hide
3071 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3072 * intents to indicate that at this point the package has been removed for
3073 * all users on the device.
3074 */
3075 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3076 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3077
3078 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003079 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3080 * intents to indicate that this is a replacement of the package, so this
3081 * broadcast will immediately be followed by an add broadcast for a
3082 * different version of the same package.
3083 */
3084 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003085
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003086 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003087 * Used as an int extra field in {@link android.app.AlarmManager} intents
3088 * to tell the application being invoked how many pending alarms are being
3089 * delievered with the intent. For one-shot alarms this will always be 1.
3090 * For recurring alarms, this might be greater than 1 if the device was
3091 * asleep or powered off at the time an earlier alarm would have been
3092 * delivered.
3093 */
3094 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003095
Jacek Surazski86b6c532009-05-13 14:38:28 +02003096 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003097 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3098 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003099 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3100 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003101 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3102 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3103 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003104 */
3105 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3106
3107 /**
3108 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3109 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003110 */
3111 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3112
3113 /**
3114 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3115 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003116 */
3117 public static final int EXTRA_DOCK_STATE_DESK = 1;
3118
3119 /**
3120 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3121 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003122 */
3123 public static final int EXTRA_DOCK_STATE_CAR = 2;
3124
3125 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003126 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3127 * to represent that the phone is in a analog (low end) dock.
3128 */
3129 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3130
3131 /**
3132 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3133 * to represent that the phone is in a digital (high end) dock.
3134 */
3135 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3136
3137 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003138 * Boolean that can be supplied as meta-data with a dock activity, to
3139 * indicate that the dock should take over the home key when it is active.
3140 */
3141 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003142
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003143 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003144 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3145 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003146 */
3147 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3148
3149 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003150 * Used in the extra field in the remote intent. It's astring token passed with the
3151 * remote intent.
3152 */
3153 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3154 "android.intent.extra.remote_intent_token";
3155
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003156 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003157 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003158 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003159 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003160 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003161 "android.intent.extra.changed_component_name";
3162
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003163 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003164 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003165 * and contains a string array of all of the components that have changed. If
3166 * the state of the overall package has changed, then it will contain an entry
3167 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003168 */
3169 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3170 "android.intent.extra.changed_component_name_list";
3171
3172 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003173 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003174 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3175 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003176 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003177 */
3178 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3179 "android.intent.extra.changed_package_list";
3180
3181 /**
3182 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003183 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3184 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003185 * and contains an integer array of uids of all of the components
3186 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003187 */
3188 public static final String EXTRA_CHANGED_UID_LIST =
3189 "android.intent.extra.changed_uid_list";
3190
3191 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003192 * @hide
3193 * Magic extra system code can use when binding, to give a label for
3194 * who it is that has bound to a service. This is an integer giving
3195 * a framework string resource that can be displayed to the user.
3196 */
3197 public static final String EXTRA_CLIENT_LABEL =
3198 "android.intent.extra.client_label";
3199
3200 /**
3201 * @hide
3202 * Magic extra system code can use when binding, to give a PendingIntent object
3203 * that can be launched for the user to disable the system's use of this
3204 * service.
3205 */
3206 public static final String EXTRA_CLIENT_INTENT =
3207 "android.intent.extra.client_intent";
3208
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003209 /**
3210 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3211 * data that is on the local device. This is a boolean extra; the default
3212 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3213 * the user to select media that is already on the device, not requiring it
3214 * be downloaded from a remote service when opened. Another way to look
3215 * at it is that such content should generally have a "_data" column to the
3216 * path of the content on local external storage.
3217 */
3218 public static final String EXTRA_LOCAL_ONLY =
3219 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003220
Amith Yamasani13593602012-03-22 16:16:17 -07003221 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003222 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3223 * user to select and return multiple items. This is a boolean extra; the default
3224 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3225 * present the user with a UI where they can pick multiple items that are all
3226 * returned to the caller. When this happens, they should be returned as
3227 * the {@link #getClipData()} part of the result Intent.
3228 */
3229 public static final String EXTRA_ALLOW_MULTIPLE =
3230 "android.intent.extra.ALLOW_MULTIPLE";
3231
3232 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003233 * The userHandle carried with broadcast intents related to addition, removal and switching of
3234 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003235 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3236 * @hide
3237 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003238 public static final String EXTRA_USER_HANDLE =
3239 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003240
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003241 /**
3242 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003243 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3244 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003245 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003246 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3247
3248 /**
3249 * Extra sent in the intent to the BroadcastReceiver that handles
3250 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3251 * the restrictions as key/value pairs.
3252 */
3253 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3254 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003255
Amith Yamasani86118ba2013-03-28 14:33:16 -07003256 /**
3257 * Extra used in the response from a BroadcastReceiver that handles
3258 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3259 */
3260 public static final String EXTRA_RESTRICTIONS_INTENT =
3261 "android.intent.extra.restrictions_intent";
3262
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003263 /**
3264 * Extra used to communicate set of acceptable MIME types for
Jeff Sharkey9ab3fd42013-05-01 18:12:12 -07003265 * {@link #ACTION_GET_CONTENT} or {@link #ACTION_OPEN_DOCUMENT}. The type of the
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003266 * extra is <code>ArrayList&lt;String&gt;</code>.
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003267 */
3268 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3269
Dianne Hackborn57a7f592013-07-22 18:21:32 -07003270 /**
3271 * Optional extra for {@link #ACTION_SHUTDOWN} that allows the sender to qualify that
3272 * this shutdown is only for the user space of the system, not a complete shutdown.
3273 * Hardware should not be shut down when this is true. The default if not supplied
3274 * is false.
3275 */
3276 public static final String EXTRA_SHUTDOWN_USERSPACE_ONLY
3277 = "android.intent.extra.SHUTDOWN_USERSPACE_ONLY";
3278
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003279 // ---------------------------------------------------------------------
3280 // ---------------------------------------------------------------------
3281 // Intent flags (see mFlags variable).
3282
3283 /**
3284 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003285 * perform read operations on the Uri in the Intent's data and any URIs
3286 * specified in its ClipData. When applying to an Intent's ClipData,
3287 * all URIs as well as recursive traversals through data or other ClipData
3288 * in Intent items will be granted; only the grant flags of the top-level
3289 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003290 */
3291 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3292 /**
3293 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003294 * perform write operations on the Uri in the Intent's data and any URIs
3295 * specified in its ClipData. When applying to an Intent's ClipData,
3296 * all URIs as well as recursive traversals through data or other ClipData
3297 * in Intent items will be granted; only the grant flags of the top-level
3298 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003299 */
3300 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3301 /**
3302 * Can be set by the caller to indicate that this Intent is coming from
3303 * a background operation, not from direct user interaction.
3304 */
3305 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3306 /**
3307 * A flag you can enable for debugging: when set, log messages will be
3308 * printed during the resolution of this intent to show you what has
3309 * been found to create the final resolved list.
3310 */
3311 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003312 /**
3313 * If set, this intent will not match any components in packages that
3314 * are currently stopped. If this is not set, then the default behavior
3315 * is to include such applications in the result.
3316 */
3317 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3318 /**
3319 * If set, this intent will always match any components in packages that
3320 * are currently stopped. This is the default behavior when
3321 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3322 * flags are set, this one wins (it allows overriding of exclude for
3323 * places where the framework may automatically set the exclude flag).
3324 */
3325 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003326
3327 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003328 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3329 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the grant will be remembered
3330 * until explicitly revoked with
3331 * {@link Context#revokeUriPermission(Uri, int)}. These grants persist
3332 * across device reboots.
3333 */
3334 public static final int FLAG_PERSIST_GRANT_URI_PERMISSION = 0x00000040;
3335
3336 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003337 * If set, the new activity is not kept in the history stack. As soon as
3338 * the user navigates away from it, the activity is finished. This may also
3339 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3340 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003341 */
3342 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3343 /**
3344 * If set, the activity will not be launched if it is already running
3345 * at the top of the history stack.
3346 */
3347 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3348 /**
3349 * If set, this activity will become the start of a new task on this
3350 * history stack. A task (from the activity that started it to the
3351 * next task activity) defines an atomic group of activities that the
3352 * user can move to. Tasks can be moved to the foreground and background;
3353 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003354 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003355 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3356 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003357 *
3358 * <p>This flag is generally used by activities that want
3359 * to present a "launcher" style behavior: they give the user a list of
3360 * separate things that can be done, which otherwise run completely
3361 * independently of the activity launching them.
3362 *
3363 * <p>When using this flag, if a task is already running for the activity
3364 * you are now starting, then a new activity will not be started; instead,
3365 * the current task will simply be brought to the front of the screen with
3366 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3367 * to disable this behavior.
3368 *
3369 * <p>This flag can not be used when the caller is requesting a result from
3370 * the activity being launched.
3371 */
3372 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3373 /**
3374 * <strong>Do not use this flag unless you are implementing your own
3375 * top-level application launcher.</strong> Used in conjunction with
3376 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3377 * behavior of bringing an existing task to the foreground. When set,
3378 * a new task is <em>always</em> started to host the Activity for the
3379 * Intent, regardless of whether there is already an existing task running
3380 * the same thing.
3381 *
3382 * <p><strong>Because the default system does not include graphical task management,
3383 * you should not use this flag unless you provide some way for a user to
3384 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003385 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003386 * <p>This flag is ignored if
3387 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3388 *
Scott Main7aee61f2011-02-08 11:25:01 -08003389 * <p>See
3390 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3391 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003392 */
3393 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3394 /**
3395 * If set, and the activity being launched is already running in the
3396 * current task, then instead of launching a new instance of that activity,
3397 * all of the other activities on top of it will be closed and this Intent
3398 * will be delivered to the (now on top) old activity as a new Intent.
3399 *
3400 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3401 * If D calls startActivity() with an Intent that resolves to the component
3402 * of activity B, then C and D will be finished and B receive the given
3403 * Intent, resulting in the stack now being: A, B.
3404 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003405 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003406 * either receive the new intent you are starting here in its
3407 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003408 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003409 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3410 * the same intent, then it will be finished and re-created; for all other
3411 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3412 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003413 *
3414 * <p>This launch mode can also be used to good effect in conjunction with
3415 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3416 * of a task, it will bring any currently running instance of that task
3417 * to the foreground, and then clear it to its root state. This is
3418 * especially useful, for example, when launching an activity from the
3419 * notification manager.
3420 *
Scott Main7aee61f2011-02-08 11:25:01 -08003421 * <p>See
3422 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3423 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003424 */
3425 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3426 /**
3427 * If set and this intent is being used to launch a new activity from an
3428 * existing one, then the reply target of the existing activity will be
3429 * transfered to the new activity. This way the new activity can call
3430 * {@link android.app.Activity#setResult} and have that result sent back to
3431 * the reply target of the original activity.
3432 */
3433 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3434 /**
3435 * If set and this intent is being used to launch a new activity from an
3436 * existing one, the current activity will not be counted as the top
3437 * activity for deciding whether the new intent should be delivered to
3438 * the top instead of starting a new one. The previous activity will
3439 * be used as the top, with the assumption being that the current activity
3440 * will finish itself immediately.
3441 */
3442 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3443 /**
3444 * If set, the new activity is not kept in the list of recently launched
3445 * activities.
3446 */
3447 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3448 /**
3449 * This flag is not normally set by application code, but set for you by
3450 * the system as described in the
3451 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3452 * launchMode} documentation for the singleTask mode.
3453 */
3454 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3455 /**
3456 * If set, and this activity is either being started in a new task or
3457 * bringing to the top an existing task, then it will be launched as
3458 * the front door of the task. This will result in the application of
3459 * any affinities needed to have that task in the proper state (either
3460 * moving activities to or from it), or simply resetting that task to
3461 * its initial state if needed.
3462 */
3463 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3464 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003465 * This flag is not normally set by application code, but set for you by
3466 * the system if this activity is being launched from history
3467 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003468 */
3469 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003470 /**
3471 * If set, this marks a point in the task's activity stack that should
3472 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003473 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003474 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3475 * the user re-launching it from home), this activity and all on top of
3476 * it will be finished so that the user does not return to them, but
3477 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003478 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003479 * <p>This is useful for cases where you have a logical break in your
3480 * application. For example, an e-mail application may have a command
3481 * to view an attachment, which launches an image view activity to
3482 * display it. This activity should be part of the e-mail application's
3483 * task, since it is a part of the task the user is involved in. However,
3484 * if the user leaves that task, and later selects the e-mail app from
3485 * home, we may like them to return to the conversation they were
3486 * viewing, not the picture attachment, since that is confusing. By
3487 * setting this flag when launching the image viewer, that viewer and
3488 * any activities it starts will be removed the next time the user returns
3489 * to mail.
3490 */
3491 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003492 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003493 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003494 * callback from occurring on the current frontmost activity before it is
3495 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003496 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003497 * <p>Typically, an activity can rely on that callback to indicate that an
3498 * explicit user action has caused their activity to be moved out of the
3499 * foreground. The callback marks an appropriate point in the activity's
3500 * lifecycle for it to dismiss any notifications that it intends to display
3501 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003502 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003503 * <p>If an activity is ever started via any non-user-driven events such as
3504 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3505 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003506 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003507 */
3508 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003509 /**
3510 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3511 * this flag will cause the launched activity to be brought to the front of its
3512 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003513 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003514 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3515 * If D calls startActivity() with an Intent that resolves to the component
3516 * of activity B, then B will be brought to the front of the history stack,
3517 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003518 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003519 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003520 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003521 */
3522 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003523 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003524 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3525 * this flag will prevent the system from applying an activity transition
3526 * animation to go to the next activity state. This doesn't mean an
3527 * animation will never run -- if another activity change happens that doesn't
3528 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003529 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003530 * when you are going to do a series of activity operations but the
3531 * animation seen by the user shouldn't be driven by the first activity
3532 * change but rather a later one.
3533 */
3534 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3535 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003536 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3537 * this flag will cause any existing task that would be associated with the
3538 * activity to be cleared before the activity is started. That is, the activity
3539 * becomes the new root of an otherwise empty task, and any old activities
3540 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3541 */
3542 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3543 /**
3544 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3545 * this flag will cause a newly launching task to be placed on top of the current
3546 * home activity task (if there is one). That is, pressing back from the task
3547 * will always return the user to home even if that was not the last activity they
3548 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3549 */
3550 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3551 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003552 * If set, when sending a broadcast only registered receivers will be
3553 * called -- no BroadcastReceiver components will be launched.
3554 */
3555 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003556 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003557 * If set, when sending a broadcast the new broadcast will replace
3558 * any existing pending broadcast that matches it. Matching is defined
3559 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3560 * true for the intents of the two broadcasts. When a match is found,
3561 * the new broadcast (and receivers associated with it) will replace the
3562 * existing one in the pending broadcast list, remaining at the same
3563 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003564 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003565 * <p>This flag is most typically used with sticky broadcasts, which
3566 * only care about delivering the most recent values of the broadcast
3567 * to their receivers.
3568 */
3569 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3570 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003571 * If set, when sending a broadcast the recipient is allowed to run at
3572 * foreground priority, with a shorter timeout interval. During normal
3573 * broadcasts the receivers are not automatically hoisted out of the
3574 * background priority class.
3575 */
3576 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3577 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003578 * If set, when sending a broadcast <i>before boot has completed</i> only
3579 * registered receivers will be called -- no BroadcastReceiver components
3580 * will be launched. Sticky intent state will be recorded properly even
3581 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3582 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003583 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003584 * <p>This flag is only for use by system sevices as a convenience to
3585 * avoid having to implement a more complex mechanism around detection
3586 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003587 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003588 * @hide
3589 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003590 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003591 /**
3592 * Set when this broadcast is for a boot upgrade, a special mode that
3593 * allows the broadcast to be sent before the system is ready and launches
3594 * the app process with no providers running in it.
3595 * @hide
3596 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003597 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003598
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003599 /**
3600 * @hide Flags that can't be changed with PendingIntent.
3601 */
3602 public static final int IMMUTABLE_FLAGS =
3603 FLAG_GRANT_READ_URI_PERMISSION
3604 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003605
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003606 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003607 // ---------------------------------------------------------------------
3608 // toUri() and parseUri() options.
3609
3610 /**
3611 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3612 * always has the "intent:" scheme. This syntax can be used when you want
3613 * to later disambiguate between URIs that are intended to describe an
3614 * Intent vs. all others that should be treated as raw URIs. When used
3615 * with {@link #parseUri}, any other scheme will result in a generic
3616 * VIEW action for that raw URI.
3617 */
3618 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003619
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003620 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003621
3622 private String mAction;
3623 private Uri mData;
3624 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003625 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003626 private ComponentName mComponent;
3627 private int mFlags;
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003628 private ArraySet<String> mCategories;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003629 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003630 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003631 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003632 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003633
3634 // ---------------------------------------------------------------------
3635
3636 /**
3637 * Create an empty intent.
3638 */
3639 public Intent() {
3640 }
3641
3642 /**
3643 * Copy constructor.
3644 */
3645 public Intent(Intent o) {
3646 this.mAction = o.mAction;
3647 this.mData = o.mData;
3648 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003649 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003650 this.mComponent = o.mComponent;
3651 this.mFlags = o.mFlags;
3652 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003653 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003654 }
3655 if (o.mExtras != null) {
3656 this.mExtras = new Bundle(o.mExtras);
3657 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003658 if (o.mSourceBounds != null) {
3659 this.mSourceBounds = new Rect(o.mSourceBounds);
3660 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003661 if (o.mSelector != null) {
3662 this.mSelector = new Intent(o.mSelector);
3663 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003664 if (o.mClipData != null) {
3665 this.mClipData = new ClipData(o.mClipData);
3666 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003667 }
3668
3669 @Override
3670 public Object clone() {
3671 return new Intent(this);
3672 }
3673
3674 private Intent(Intent o, boolean all) {
3675 this.mAction = o.mAction;
3676 this.mData = o.mData;
3677 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003678 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003679 this.mComponent = o.mComponent;
3680 if (o.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07003681 this.mCategories = new ArraySet<String>(o.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003682 }
3683 }
3684
3685 /**
3686 * Make a clone of only the parts of the Intent that are relevant for
3687 * filter matching: the action, data, type, component, and categories.
3688 */
3689 public Intent cloneFilter() {
3690 return new Intent(this, false);
3691 }
3692
3693 /**
3694 * Create an intent with a given action. All other fields (data, type,
3695 * class) are null. Note that the action <em>must</em> be in a
3696 * namespace because Intents are used globally in the system -- for
3697 * example the system VIEW action is android.intent.action.VIEW; an
3698 * application's custom action would be something like
3699 * com.google.app.myapp.CUSTOM_ACTION.
3700 *
3701 * @param action The Intent action, such as ACTION_VIEW.
3702 */
3703 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003704 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003705 }
3706
3707 /**
3708 * Create an intent with a given action and for a given data url. Note
3709 * that the action <em>must</em> be in a namespace because Intents are
3710 * used globally in the system -- for example the system VIEW action is
3711 * android.intent.action.VIEW; an application's custom action would be
3712 * something like com.google.app.myapp.CUSTOM_ACTION.
3713 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003714 * <p><em>Note: scheme and host name matching in the Android framework is
3715 * case-sensitive, unlike the formal RFC. As a result,
3716 * you should always ensure that you write your Uri with these elements
3717 * using lower case letters, and normalize any Uris you receive from
3718 * outside of Android to ensure the scheme and host is lower case.</em></p>
3719 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003720 * @param action The Intent action, such as ACTION_VIEW.
3721 * @param uri The Intent data URI.
3722 */
3723 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003724 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003725 mData = uri;
3726 }
3727
3728 /**
3729 * Create an intent for a specific component. All other fields (action, data,
3730 * type, class) are null, though they can be modified later with explicit
3731 * calls. This provides a convenient way to create an intent that is
3732 * intended to execute a hard-coded class name, rather than relying on the
3733 * system to find an appropriate class for you; see {@link #setComponent}
3734 * for more information on the repercussions of this.
3735 *
3736 * @param packageContext A Context of the application package implementing
3737 * this class.
3738 * @param cls The component class that is to be used for the intent.
3739 *
3740 * @see #setClass
3741 * @see #setComponent
3742 * @see #Intent(String, android.net.Uri , Context, Class)
3743 */
3744 public Intent(Context packageContext, Class<?> cls) {
3745 mComponent = new ComponentName(packageContext, cls);
3746 }
3747
3748 /**
3749 * Create an intent for a specific component with a specified action and data.
3750 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3751 * construct the Intent and then calling {@link #setClass} to set its
3752 * class.
3753 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003754 * <p><em>Note: scheme and host name matching in the Android framework is
3755 * case-sensitive, unlike the formal RFC. As a result,
3756 * you should always ensure that you write your Uri with these elements
3757 * using lower case letters, and normalize any Uris you receive from
3758 * outside of Android to ensure the scheme and host is lower case.</em></p>
3759 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003760 * @param action The Intent action, such as ACTION_VIEW.
3761 * @param uri The Intent data URI.
3762 * @param packageContext A Context of the application package implementing
3763 * this class.
3764 * @param cls The component class that is to be used for the intent.
3765 *
3766 * @see #Intent(String, android.net.Uri)
3767 * @see #Intent(Context, Class)
3768 * @see #setClass
3769 * @see #setComponent
3770 */
3771 public Intent(String action, Uri uri,
3772 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003773 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003774 mData = uri;
3775 mComponent = new ComponentName(packageContext, cls);
3776 }
3777
3778 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003779 * Create an intent to launch the main (root) activity of a task. This
3780 * is the Intent that is started when the application's is launched from
3781 * Home. For anything else that wants to launch an application in the
3782 * same way, it is important that they use an Intent structured the same
3783 * way, and can use this function to ensure this is the case.
3784 *
3785 * <p>The returned Intent has the given Activity component as its explicit
3786 * component, {@link #ACTION_MAIN} as its action, and includes the
3787 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3788 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3789 * to do that through {@link #addFlags(int)} on the returned Intent.
3790 *
3791 * @param mainActivity The main activity component that this Intent will
3792 * launch.
3793 * @return Returns a newly created Intent that can be used to launch the
3794 * activity as a main application entry.
3795 *
3796 * @see #setClass
3797 * @see #setComponent
3798 */
3799 public static Intent makeMainActivity(ComponentName mainActivity) {
3800 Intent intent = new Intent(ACTION_MAIN);
3801 intent.setComponent(mainActivity);
3802 intent.addCategory(CATEGORY_LAUNCHER);
3803 return intent;
3804 }
3805
3806 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003807 * Make an Intent for the main activity of an application, without
3808 * specifying a specific activity to run but giving a selector to find
3809 * the activity. This results in a final Intent that is structured
3810 * the same as when the application is launched from
3811 * Home. For anything else that wants to launch an application in the
3812 * same way, it is important that they use an Intent structured the same
3813 * way, and can use this function to ensure this is the case.
3814 *
3815 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3816 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3817 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3818 * to do that through {@link #addFlags(int)} on the returned Intent.
3819 *
3820 * @param selectorAction The action name of the Intent's selector.
3821 * @param selectorCategory The name of a category to add to the Intent's
3822 * selector.
3823 * @return Returns a newly created Intent that can be used to launch the
3824 * activity as a main application entry.
3825 *
3826 * @see #setSelector(Intent)
3827 */
3828 public static Intent makeMainSelectorActivity(String selectorAction,
3829 String selectorCategory) {
3830 Intent intent = new Intent(ACTION_MAIN);
3831 intent.addCategory(CATEGORY_LAUNCHER);
3832 Intent selector = new Intent();
3833 selector.setAction(selectorAction);
3834 selector.addCategory(selectorCategory);
3835 intent.setSelector(selector);
3836 return intent;
3837 }
3838
3839 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003840 * Make an Intent that can be used to re-launch an application's task
3841 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3842 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3843 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3844 *
3845 * @param mainActivity The activity component that is the root of the
3846 * task; this is the activity that has been published in the application's
3847 * manifest as the main launcher icon.
3848 *
3849 * @return Returns a newly created Intent that can be used to relaunch the
3850 * activity's task in its root state.
3851 */
3852 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3853 Intent intent = makeMainActivity(mainActivity);
3854 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3855 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3856 return intent;
3857 }
3858
3859 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003860 * Call {@link #parseUri} with 0 flags.
3861 * @deprecated Use {@link #parseUri} instead.
3862 */
3863 @Deprecated
3864 public static Intent getIntent(String uri) throws URISyntaxException {
3865 return parseUri(uri, 0);
3866 }
Tom Taylord4a47292009-12-21 13:59:18 -08003867
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003868 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003869 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003870 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003871 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003872 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003873 *
3874 * <p>The URI given here must not be relative -- that is, it must include
3875 * the scheme and full path.
3876 *
3877 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003878 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003879 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003880 *
3881 * @return Intent The newly created Intent object.
3882 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003883 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3884 * it bad (as parsed by the Uri class) or the Intent data within the
3885 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003886 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003887 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003888 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003889 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003890 int i = 0;
3891 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003892 // Validate intent scheme for if requested.
3893 if ((flags&URI_INTENT_SCHEME) != 0) {
3894 if (!uri.startsWith("intent:")) {
3895 Intent intent = new Intent(ACTION_VIEW);
3896 try {
3897 intent.setData(Uri.parse(uri));
3898 } catch (IllegalArgumentException e) {
3899 throw new URISyntaxException(uri, e.getMessage());
3900 }
3901 return intent;
3902 }
3903 }
Tom Taylord4a47292009-12-21 13:59:18 -08003904
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003905 // simple case
3906 i = uri.lastIndexOf("#");
3907 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3908
3909 // old format Intent URI
3910 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003911
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003912 // new format
3913 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003914 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003915
3916 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003917 String data = i >= 0 ? uri.substring(0, i) : null;
3918 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003919 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003920
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003921 // loop over contents of Intent, all name=value;
3922 while (!uri.startsWith("end", i)) {
3923 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003924 if (eq < 0) eq = i-1;
3925 int semi = uri.indexOf(';', i);
3926 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003927
3928 // action
3929 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003930 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003931 }
3932
3933 // categories
3934 else if (uri.startsWith("category=", i)) {
3935 intent.addCategory(value);
3936 }
3937
3938 // type
3939 else if (uri.startsWith("type=", i)) {
3940 intent.mType = value;
3941 }
3942
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003943 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003944 else if (uri.startsWith("launchFlags=", i)) {
3945 intent.mFlags = Integer.decode(value).intValue();
3946 }
3947
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003948 // package
3949 else if (uri.startsWith("package=", i)) {
3950 intent.mPackage = value;
3951 }
3952
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003953 // component
3954 else if (uri.startsWith("component=", i)) {
3955 intent.mComponent = ComponentName.unflattenFromString(value);
3956 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003957
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003958 // scheme
3959 else if (uri.startsWith("scheme=", i)) {
3960 scheme = value;
3961 }
3962
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003963 // source bounds
3964 else if (uri.startsWith("sourceBounds=", i)) {
3965 intent.mSourceBounds = Rect.unflattenFromString(value);
3966 }
3967
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003968 // selector
3969 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3970 intent = new Intent();
3971 }
3972
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003973 // extra
3974 else {
3975 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003976 // create Bundle if it doesn't already exist
3977 if (intent.mExtras == null) intent.mExtras = new Bundle();
3978 Bundle b = intent.mExtras;
3979 // add EXTRA
3980 if (uri.startsWith("S.", i)) b.putString(key, value);
3981 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3982 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3983 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3984 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3985 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3986 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3987 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3988 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3989 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3990 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003991
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003992 // move to the next item
3993 i = semi + 1;
3994 }
3995
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003996 if (intent != baseIntent) {
3997 // The Intent had a selector; fix it up.
3998 baseIntent.setSelector(intent);
3999 intent = baseIntent;
4000 }
4001
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004002 if (data != null) {
4003 if (data.startsWith("intent:")) {
4004 data = data.substring(7);
4005 if (scheme != null) {
4006 data = scheme + ':' + data;
4007 }
4008 }
Tom Taylord4a47292009-12-21 13:59:18 -08004009
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004010 if (data.length() > 0) {
4011 try {
4012 intent.mData = Uri.parse(data);
4013 } catch (IllegalArgumentException e) {
4014 throw new URISyntaxException(uri, e.getMessage());
4015 }
4016 }
4017 }
Tom Taylord4a47292009-12-21 13:59:18 -08004018
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004019 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07004020
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004021 } catch (IndexOutOfBoundsException e) {
4022 throw new URISyntaxException(uri, "illegal Intent URI format", i);
4023 }
4024 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004025
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004026 public static Intent getIntentOld(String uri) throws URISyntaxException {
4027 Intent intent;
4028
4029 int i = uri.lastIndexOf('#');
4030 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004031 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004032 final int intentFragmentStart = i;
4033 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004034
4035 i++;
4036
4037 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004038 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004039 i += 7;
4040 int j = uri.indexOf(')', i);
4041 action = uri.substring(i, j);
4042 i = j + 1;
4043 }
4044
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004045 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004046
4047 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004048 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004049 i += 11;
4050 int j = uri.indexOf(')', i);
4051 while (i < j) {
4052 int sep = uri.indexOf('!', i);
4053 if (sep < 0) sep = j;
4054 if (i < sep) {
4055 intent.addCategory(uri.substring(i, sep));
4056 }
4057 i = sep + 1;
4058 }
4059 i = j + 1;
4060 }
4061
4062 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004063 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004064 i += 5;
4065 int j = uri.indexOf(')', i);
4066 intent.mType = uri.substring(i, j);
4067 i = j + 1;
4068 }
4069
4070 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004071 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004072 i += 12;
4073 int j = uri.indexOf(')', i);
4074 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4075 i = j + 1;
4076 }
4077
4078 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004079 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004080 i += 10;
4081 int j = uri.indexOf(')', i);
4082 int sep = uri.indexOf('!', i);
4083 if (sep >= 0 && sep < j) {
4084 String pkg = uri.substring(i, sep);
4085 String cls = uri.substring(sep + 1, j);
4086 intent.mComponent = new ComponentName(pkg, cls);
4087 }
4088 i = j + 1;
4089 }
4090
4091 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004092 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004093 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004094
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004095 final int closeParen = uri.indexOf(')', i);
4096 if (closeParen == -1) throw new URISyntaxException(uri,
4097 "EXTRA missing trailing ')'", i);
4098
4099 while (i < closeParen) {
4100 // fetch the key value
4101 int j = uri.indexOf('=', i);
4102 if (j <= i + 1 || i >= closeParen) {
4103 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4104 }
4105 char type = uri.charAt(i);
4106 i++;
4107 String key = uri.substring(i, j);
4108 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004109
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004110 // get type-value
4111 j = uri.indexOf('!', i);
4112 if (j == -1 || j >= closeParen) j = closeParen;
4113 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4114 String value = uri.substring(i, j);
4115 i = j;
4116
4117 // create Bundle if it doesn't already exist
4118 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004119
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004120 // add item to bundle
4121 try {
4122 switch (type) {
4123 case 'S':
4124 intent.mExtras.putString(key, Uri.decode(value));
4125 break;
4126 case 'B':
4127 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4128 break;
4129 case 'b':
4130 intent.mExtras.putByte(key, Byte.parseByte(value));
4131 break;
4132 case 'c':
4133 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4134 break;
4135 case 'd':
4136 intent.mExtras.putDouble(key, Double.parseDouble(value));
4137 break;
4138 case 'f':
4139 intent.mExtras.putFloat(key, Float.parseFloat(value));
4140 break;
4141 case 'i':
4142 intent.mExtras.putInt(key, Integer.parseInt(value));
4143 break;
4144 case 'l':
4145 intent.mExtras.putLong(key, Long.parseLong(value));
4146 break;
4147 case 's':
4148 intent.mExtras.putShort(key, Short.parseShort(value));
4149 break;
4150 default:
4151 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4152 }
4153 } catch (NumberFormatException e) {
4154 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4155 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004156
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004157 char ch = uri.charAt(i);
4158 if (ch == ')') break;
4159 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4160 i++;
4161 }
4162 }
4163
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004164 if (isIntentFragment) {
4165 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4166 } else {
4167 intent.mData = Uri.parse(uri);
4168 }
Tom Taylord4a47292009-12-21 13:59:18 -08004169
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004170 if (intent.mAction == null) {
4171 // By default, if no action is specified, then use VIEW.
4172 intent.mAction = ACTION_VIEW;
4173 }
4174
4175 } else {
4176 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4177 }
4178
4179 return intent;
4180 }
4181
4182 /**
4183 * Retrieve the general action to be performed, such as
4184 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4185 * the information in the intent should be interpreted -- most importantly,
4186 * what to do with the data returned by {@link #getData}.
4187 *
4188 * @return The action of this intent or null if none is specified.
4189 *
4190 * @see #setAction
4191 */
4192 public String getAction() {
4193 return mAction;
4194 }
4195
4196 /**
4197 * Retrieve data this intent is operating on. This URI specifies the name
4198 * of the data; often it uses the content: scheme, specifying data in a
4199 * content provider. Other schemes may be handled by specific activities,
4200 * such as http: by the web browser.
4201 *
4202 * @return The URI of the data this intent is targeting or null.
4203 *
4204 * @see #getScheme
4205 * @see #setData
4206 */
4207 public Uri getData() {
4208 return mData;
4209 }
4210
4211 /**
4212 * The same as {@link #getData()}, but returns the URI as an encoded
4213 * String.
4214 */
4215 public String getDataString() {
4216 return mData != null ? mData.toString() : null;
4217 }
4218
4219 /**
4220 * Return the scheme portion of the intent's data. If the data is null or
4221 * does not include a scheme, null is returned. Otherwise, the scheme
4222 * prefix without the final ':' is returned, i.e. "http".
4223 *
4224 * <p>This is the same as calling getData().getScheme() (and checking for
4225 * null data).
4226 *
4227 * @return The scheme of this intent.
4228 *
4229 * @see #getData
4230 */
4231 public String getScheme() {
4232 return mData != null ? mData.getScheme() : null;
4233 }
4234
4235 /**
4236 * Retrieve any explicit MIME type included in the intent. This is usually
4237 * null, as the type is determined by the intent data.
4238 *
4239 * @return If a type was manually set, it is returned; else null is
4240 * returned.
4241 *
4242 * @see #resolveType(ContentResolver)
4243 * @see #setType
4244 */
4245 public String getType() {
4246 return mType;
4247 }
4248
4249 /**
4250 * Return the MIME data type of this intent. If the type field is
4251 * explicitly set, that is simply returned. Otherwise, if the data is set,
4252 * the type of that data is returned. If neither fields are set, a null is
4253 * returned.
4254 *
4255 * @return The MIME type of this intent.
4256 *
4257 * @see #getType
4258 * @see #resolveType(ContentResolver)
4259 */
4260 public String resolveType(Context context) {
4261 return resolveType(context.getContentResolver());
4262 }
4263
4264 /**
4265 * Return the MIME data type of this intent. If the type field is
4266 * explicitly set, that is simply returned. Otherwise, if the data is set,
4267 * the type of that data is returned. If neither fields are set, a null is
4268 * returned.
4269 *
4270 * @param resolver A ContentResolver that can be used to determine the MIME
4271 * type of the intent's data.
4272 *
4273 * @return The MIME type of this intent.
4274 *
4275 * @see #getType
4276 * @see #resolveType(Context)
4277 */
4278 public String resolveType(ContentResolver resolver) {
4279 if (mType != null) {
4280 return mType;
4281 }
4282 if (mData != null) {
4283 if ("content".equals(mData.getScheme())) {
4284 return resolver.getType(mData);
4285 }
4286 }
4287 return null;
4288 }
4289
4290 /**
4291 * Return the MIME data type of this intent, only if it will be needed for
4292 * intent resolution. This is not generally useful for application code;
4293 * it is used by the frameworks for communicating with back-end system
4294 * services.
4295 *
4296 * @param resolver A ContentResolver that can be used to determine the MIME
4297 * type of the intent's data.
4298 *
4299 * @return The MIME type of this intent, or null if it is unknown or not
4300 * needed.
4301 */
4302 public String resolveTypeIfNeeded(ContentResolver resolver) {
4303 if (mComponent != null) {
4304 return mType;
4305 }
4306 return resolveType(resolver);
4307 }
4308
4309 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004310 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004311 *
4312 * @param category The category to check.
4313 *
4314 * @return boolean True if the intent contains the category, else false.
4315 *
4316 * @see #getCategories
4317 * @see #addCategory
4318 */
4319 public boolean hasCategory(String category) {
4320 return mCategories != null && mCategories.contains(category);
4321 }
4322
4323 /**
4324 * Return the set of all categories in the intent. If there are no categories,
4325 * returns NULL.
4326 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004327 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004328 *
4329 * @see #hasCategory
4330 * @see #addCategory
4331 */
4332 public Set<String> getCategories() {
4333 return mCategories;
4334 }
4335
4336 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004337 * Return the specific selector associated with this Intent. If there is
4338 * none, returns null. See {@link #setSelector} for more information.
4339 *
4340 * @see #setSelector
4341 */
4342 public Intent getSelector() {
4343 return mSelector;
4344 }
4345
4346 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004347 * Return the {@link ClipData} associated with this Intent. If there is
4348 * none, returns null. See {@link #setClipData} for more information.
4349 *
4350 * @see #setClipData;
4351 */
4352 public ClipData getClipData() {
4353 return mClipData;
4354 }
4355
4356 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004357 * Sets the ClassLoader that will be used when unmarshalling
4358 * any Parcelable values from the extras of this Intent.
4359 *
4360 * @param loader a ClassLoader, or null to use the default loader
4361 * at the time of unmarshalling.
4362 */
4363 public void setExtrasClassLoader(ClassLoader loader) {
4364 if (mExtras != null) {
4365 mExtras.setClassLoader(loader);
4366 }
4367 }
4368
4369 /**
4370 * Returns true if an extra value is associated with the given name.
4371 * @param name the extra's name
4372 * @return true if the given extra is present.
4373 */
4374 public boolean hasExtra(String name) {
4375 return mExtras != null && mExtras.containsKey(name);
4376 }
4377
4378 /**
4379 * Returns true if the Intent's extras contain a parcelled file descriptor.
4380 * @return true if the Intent contains a parcelled file descriptor.
4381 */
4382 public boolean hasFileDescriptors() {
4383 return mExtras != null && mExtras.hasFileDescriptors();
4384 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004385
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004386 /** @hide */
4387 public void setAllowFds(boolean allowFds) {
4388 if (mExtras != null) {
4389 mExtras.setAllowFds(allowFds);
4390 }
4391 }
4392
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004393 /**
4394 * Retrieve extended data from the intent.
4395 *
4396 * @param name The name of the desired item.
4397 *
4398 * @return the value of an item that previously added with putExtra()
4399 * or null if none was found.
4400 *
4401 * @deprecated
4402 * @hide
4403 */
4404 @Deprecated
4405 public Object getExtra(String name) {
4406 return getExtra(name, null);
4407 }
4408
4409 /**
4410 * Retrieve extended data from the intent.
4411 *
4412 * @param name The name of the desired item.
4413 * @param defaultValue the value to be returned if no value of the desired
4414 * type is stored with the given name.
4415 *
4416 * @return the value of an item that previously added with putExtra()
4417 * or the default value if none was found.
4418 *
4419 * @see #putExtra(String, boolean)
4420 */
4421 public boolean getBooleanExtra(String name, boolean defaultValue) {
4422 return mExtras == null ? defaultValue :
4423 mExtras.getBoolean(name, defaultValue);
4424 }
4425
4426 /**
4427 * Retrieve extended data from the intent.
4428 *
4429 * @param name The name of the desired item.
4430 * @param defaultValue the value to be returned if no value of the desired
4431 * type is stored with the given name.
4432 *
4433 * @return the value of an item that previously added with putExtra()
4434 * or the default value if none was found.
4435 *
4436 * @see #putExtra(String, byte)
4437 */
4438 public byte getByteExtra(String name, byte defaultValue) {
4439 return mExtras == null ? defaultValue :
4440 mExtras.getByte(name, defaultValue);
4441 }
4442
4443 /**
4444 * Retrieve extended data from the intent.
4445 *
4446 * @param name The name of the desired item.
4447 * @param defaultValue the value to be returned if no value of the desired
4448 * type is stored with the given name.
4449 *
4450 * @return the value of an item that previously added with putExtra()
4451 * or the default value if none was found.
4452 *
4453 * @see #putExtra(String, short)
4454 */
4455 public short getShortExtra(String name, short defaultValue) {
4456 return mExtras == null ? defaultValue :
4457 mExtras.getShort(name, defaultValue);
4458 }
4459
4460 /**
4461 * Retrieve extended data from the intent.
4462 *
4463 * @param name The name of the desired item.
4464 * @param defaultValue the value to be returned if no value of the desired
4465 * type is stored with the given name.
4466 *
4467 * @return the value of an item that previously added with putExtra()
4468 * or the default value if none was found.
4469 *
4470 * @see #putExtra(String, char)
4471 */
4472 public char getCharExtra(String name, char defaultValue) {
4473 return mExtras == null ? defaultValue :
4474 mExtras.getChar(name, defaultValue);
4475 }
4476
4477 /**
4478 * Retrieve extended data from the intent.
4479 *
4480 * @param name The name of the desired item.
4481 * @param defaultValue the value to be returned if no value of the desired
4482 * type is stored with the given name.
4483 *
4484 * @return the value of an item that previously added with putExtra()
4485 * or the default value if none was found.
4486 *
4487 * @see #putExtra(String, int)
4488 */
4489 public int getIntExtra(String name, int defaultValue) {
4490 return mExtras == null ? defaultValue :
4491 mExtras.getInt(name, defaultValue);
4492 }
4493
4494 /**
4495 * Retrieve extended data from the intent.
4496 *
4497 * @param name The name of the desired item.
4498 * @param defaultValue the value to be returned if no value of the desired
4499 * type is stored with the given name.
4500 *
4501 * @return the value of an item that previously added with putExtra()
4502 * or the default value if none was found.
4503 *
4504 * @see #putExtra(String, long)
4505 */
4506 public long getLongExtra(String name, long defaultValue) {
4507 return mExtras == null ? defaultValue :
4508 mExtras.getLong(name, defaultValue);
4509 }
4510
4511 /**
4512 * Retrieve extended data from the intent.
4513 *
4514 * @param name The name of the desired item.
4515 * @param defaultValue the value to be returned if no value of the desired
4516 * type is stored with the given name.
4517 *
4518 * @return the value of an item that previously added with putExtra(),
4519 * or the default value if no such item is present
4520 *
4521 * @see #putExtra(String, float)
4522 */
4523 public float getFloatExtra(String name, float defaultValue) {
4524 return mExtras == null ? defaultValue :
4525 mExtras.getFloat(name, defaultValue);
4526 }
4527
4528 /**
4529 * Retrieve extended data from the intent.
4530 *
4531 * @param name The name of the desired item.
4532 * @param defaultValue the value to be returned if no value of the desired
4533 * type is stored with the given name.
4534 *
4535 * @return the value of an item that previously added with putExtra()
4536 * or the default value if none was found.
4537 *
4538 * @see #putExtra(String, double)
4539 */
4540 public double getDoubleExtra(String name, double defaultValue) {
4541 return mExtras == null ? defaultValue :
4542 mExtras.getDouble(name, defaultValue);
4543 }
4544
4545 /**
4546 * Retrieve extended data from the intent.
4547 *
4548 * @param name The name of the desired item.
4549 *
4550 * @return the value of an item that previously added with putExtra()
4551 * or null if no String value was found.
4552 *
4553 * @see #putExtra(String, String)
4554 */
4555 public String getStringExtra(String name) {
4556 return mExtras == null ? null : mExtras.getString(name);
4557 }
4558
4559 /**
4560 * Retrieve extended data from the intent.
4561 *
4562 * @param name The name of the desired item.
4563 *
4564 * @return the value of an item that previously added with putExtra()
4565 * or null if no CharSequence value was found.
4566 *
4567 * @see #putExtra(String, CharSequence)
4568 */
4569 public CharSequence getCharSequenceExtra(String name) {
4570 return mExtras == null ? null : mExtras.getCharSequence(name);
4571 }
4572
4573 /**
4574 * Retrieve extended data from the intent.
4575 *
4576 * @param name The name of the desired item.
4577 *
4578 * @return the value of an item that previously added with putExtra()
4579 * or null if no Parcelable value was found.
4580 *
4581 * @see #putExtra(String, Parcelable)
4582 */
4583 public <T extends Parcelable> T getParcelableExtra(String name) {
4584 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4585 }
4586
4587 /**
4588 * Retrieve extended data from the intent.
4589 *
4590 * @param name The name of the desired item.
4591 *
4592 * @return the value of an item that previously added with putExtra()
4593 * or null if no Parcelable[] value was found.
4594 *
4595 * @see #putExtra(String, Parcelable[])
4596 */
4597 public Parcelable[] getParcelableArrayExtra(String name) {
4598 return mExtras == null ? null : mExtras.getParcelableArray(name);
4599 }
4600
4601 /**
4602 * Retrieve extended data from the intent.
4603 *
4604 * @param name The name of the desired item.
4605 *
4606 * @return the value of an item that previously added with putExtra()
4607 * or null if no ArrayList<Parcelable> value was found.
4608 *
4609 * @see #putParcelableArrayListExtra(String, ArrayList)
4610 */
4611 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4612 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4613 }
4614
4615 /**
4616 * Retrieve extended data from the intent.
4617 *
4618 * @param name The name of the desired item.
4619 *
4620 * @return the value of an item that previously added with putExtra()
4621 * or null if no Serializable value was found.
4622 *
4623 * @see #putExtra(String, Serializable)
4624 */
4625 public Serializable getSerializableExtra(String name) {
4626 return mExtras == null ? null : mExtras.getSerializable(name);
4627 }
4628
4629 /**
4630 * Retrieve extended data from the intent.
4631 *
4632 * @param name The name of the desired item.
4633 *
4634 * @return the value of an item that previously added with putExtra()
4635 * or null if no ArrayList<Integer> value was found.
4636 *
4637 * @see #putIntegerArrayListExtra(String, ArrayList)
4638 */
4639 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4640 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4641 }
4642
4643 /**
4644 * Retrieve extended data from the intent.
4645 *
4646 * @param name The name of the desired item.
4647 *
4648 * @return the value of an item that previously added with putExtra()
4649 * or null if no ArrayList<String> value was found.
4650 *
4651 * @see #putStringArrayListExtra(String, ArrayList)
4652 */
4653 public ArrayList<String> getStringArrayListExtra(String name) {
4654 return mExtras == null ? null : mExtras.getStringArrayList(name);
4655 }
4656
4657 /**
4658 * Retrieve extended data from the intent.
4659 *
4660 * @param name The name of the desired item.
4661 *
4662 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004663 * or null if no ArrayList<CharSequence> value was found.
4664 *
4665 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4666 */
4667 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4668 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4669 }
4670
4671 /**
4672 * Retrieve extended data from the intent.
4673 *
4674 * @param name The name of the desired item.
4675 *
4676 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004677 * or null if no boolean array value was found.
4678 *
4679 * @see #putExtra(String, boolean[])
4680 */
4681 public boolean[] getBooleanArrayExtra(String name) {
4682 return mExtras == null ? null : mExtras.getBooleanArray(name);
4683 }
4684
4685 /**
4686 * Retrieve extended data from the intent.
4687 *
4688 * @param name The name of the desired item.
4689 *
4690 * @return the value of an item that previously added with putExtra()
4691 * or null if no byte array value was found.
4692 *
4693 * @see #putExtra(String, byte[])
4694 */
4695 public byte[] getByteArrayExtra(String name) {
4696 return mExtras == null ? null : mExtras.getByteArray(name);
4697 }
4698
4699 /**
4700 * Retrieve extended data from the intent.
4701 *
4702 * @param name The name of the desired item.
4703 *
4704 * @return the value of an item that previously added with putExtra()
4705 * or null if no short array value was found.
4706 *
4707 * @see #putExtra(String, short[])
4708 */
4709 public short[] getShortArrayExtra(String name) {
4710 return mExtras == null ? null : mExtras.getShortArray(name);
4711 }
4712
4713 /**
4714 * Retrieve extended data from the intent.
4715 *
4716 * @param name The name of the desired item.
4717 *
4718 * @return the value of an item that previously added with putExtra()
4719 * or null if no char array value was found.
4720 *
4721 * @see #putExtra(String, char[])
4722 */
4723 public char[] getCharArrayExtra(String name) {
4724 return mExtras == null ? null : mExtras.getCharArray(name);
4725 }
4726
4727 /**
4728 * Retrieve extended data from the intent.
4729 *
4730 * @param name The name of the desired item.
4731 *
4732 * @return the value of an item that previously added with putExtra()
4733 * or null if no int array value was found.
4734 *
4735 * @see #putExtra(String, int[])
4736 */
4737 public int[] getIntArrayExtra(String name) {
4738 return mExtras == null ? null : mExtras.getIntArray(name);
4739 }
4740
4741 /**
4742 * Retrieve extended data from the intent.
4743 *
4744 * @param name The name of the desired item.
4745 *
4746 * @return the value of an item that previously added with putExtra()
4747 * or null if no long array value was found.
4748 *
4749 * @see #putExtra(String, long[])
4750 */
4751 public long[] getLongArrayExtra(String name) {
4752 return mExtras == null ? null : mExtras.getLongArray(name);
4753 }
4754
4755 /**
4756 * Retrieve extended data from the intent.
4757 *
4758 * @param name The name of the desired item.
4759 *
4760 * @return the value of an item that previously added with putExtra()
4761 * or null if no float array value was found.
4762 *
4763 * @see #putExtra(String, float[])
4764 */
4765 public float[] getFloatArrayExtra(String name) {
4766 return mExtras == null ? null : mExtras.getFloatArray(name);
4767 }
4768
4769 /**
4770 * Retrieve extended data from the intent.
4771 *
4772 * @param name The name of the desired item.
4773 *
4774 * @return the value of an item that previously added with putExtra()
4775 * or null if no double array value was found.
4776 *
4777 * @see #putExtra(String, double[])
4778 */
4779 public double[] getDoubleArrayExtra(String name) {
4780 return mExtras == null ? null : mExtras.getDoubleArray(name);
4781 }
4782
4783 /**
4784 * Retrieve extended data from the intent.
4785 *
4786 * @param name The name of the desired item.
4787 *
4788 * @return the value of an item that previously added with putExtra()
4789 * or null if no String array value was found.
4790 *
4791 * @see #putExtra(String, String[])
4792 */
4793 public String[] getStringArrayExtra(String name) {
4794 return mExtras == null ? null : mExtras.getStringArray(name);
4795 }
4796
4797 /**
4798 * Retrieve extended data from the intent.
4799 *
4800 * @param name The name of the desired item.
4801 *
4802 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004803 * or null if no CharSequence array value was found.
4804 *
4805 * @see #putExtra(String, CharSequence[])
4806 */
4807 public CharSequence[] getCharSequenceArrayExtra(String name) {
4808 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4809 }
4810
4811 /**
4812 * Retrieve extended data from the intent.
4813 *
4814 * @param name The name of the desired item.
4815 *
4816 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004817 * or null if no Bundle value was found.
4818 *
4819 * @see #putExtra(String, Bundle)
4820 */
4821 public Bundle getBundleExtra(String name) {
4822 return mExtras == null ? null : mExtras.getBundle(name);
4823 }
4824
4825 /**
4826 * Retrieve extended data from the intent.
4827 *
4828 * @param name The name of the desired item.
4829 *
4830 * @return the value of an item that previously added with putExtra()
4831 * or null if no IBinder value was found.
4832 *
4833 * @see #putExtra(String, IBinder)
4834 *
4835 * @deprecated
4836 * @hide
4837 */
4838 @Deprecated
4839 public IBinder getIBinderExtra(String name) {
4840 return mExtras == null ? null : mExtras.getIBinder(name);
4841 }
4842
4843 /**
4844 * Retrieve extended data from the intent.
4845 *
4846 * @param name The name of the desired item.
4847 * @param defaultValue The default value to return in case no item is
4848 * associated with the key 'name'
4849 *
4850 * @return the value of an item that previously added with putExtra()
4851 * or defaultValue if none was found.
4852 *
4853 * @see #putExtra
4854 *
4855 * @deprecated
4856 * @hide
4857 */
4858 @Deprecated
4859 public Object getExtra(String name, Object defaultValue) {
4860 Object result = defaultValue;
4861 if (mExtras != null) {
4862 Object result2 = mExtras.get(name);
4863 if (result2 != null) {
4864 result = result2;
4865 }
4866 }
4867
4868 return result;
4869 }
4870
4871 /**
4872 * Retrieves a map of extended data from the intent.
4873 *
4874 * @return the map of all extras previously added with putExtra(),
4875 * or null if none have been added.
4876 */
4877 public Bundle getExtras() {
4878 return (mExtras != null)
4879 ? new Bundle(mExtras)
4880 : null;
4881 }
4882
4883 /**
4884 * Retrieve any special flags associated with this intent. You will
4885 * normally just set them with {@link #setFlags} and let the system
4886 * take the appropriate action with them.
4887 *
4888 * @return int The currently set flags.
4889 *
4890 * @see #setFlags
4891 */
4892 public int getFlags() {
4893 return mFlags;
4894 }
4895
Dianne Hackborne7f97212011-02-24 14:40:20 -08004896 /** @hide */
4897 public boolean isExcludingStopped() {
4898 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4899 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4900 }
4901
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004902 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004903 * Retrieve the application package name this Intent is limited to. When
4904 * resolving an Intent, if non-null this limits the resolution to only
4905 * components in the given application package.
4906 *
4907 * @return The name of the application package for the Intent.
4908 *
4909 * @see #resolveActivity
4910 * @see #setPackage
4911 */
4912 public String getPackage() {
4913 return mPackage;
4914 }
4915
4916 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004917 * Retrieve the concrete component associated with the intent. When receiving
4918 * an intent, this is the component that was found to best handle it (that is,
4919 * yourself) and will always be non-null; in all other cases it will be
4920 * null unless explicitly set.
4921 *
4922 * @return The name of the application component to handle the intent.
4923 *
4924 * @see #resolveActivity
4925 * @see #setComponent
4926 */
4927 public ComponentName getComponent() {
4928 return mComponent;
4929 }
4930
4931 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004932 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4933 * used as a hint to the receiver for animations and the like. Null means that there
4934 * is no source bounds.
4935 */
4936 public Rect getSourceBounds() {
4937 return mSourceBounds;
4938 }
4939
4940 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004941 * Return the Activity component that should be used to handle this intent.
4942 * The appropriate component is determined based on the information in the
4943 * intent, evaluated as follows:
4944 *
4945 * <p>If {@link #getComponent} returns an explicit class, that is returned
4946 * without any further consideration.
4947 *
4948 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4949 * category to be considered.
4950 *
4951 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4952 * action.
4953 *
4954 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4955 * this type.
4956 *
4957 * <p>If {@link #addCategory} has added any categories, the activity must
4958 * handle ALL of the categories specified.
4959 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004960 * <p>If {@link #getPackage} is non-NULL, only activity components in
4961 * that application package will be considered.
4962 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004963 * <p>If there are no activities that satisfy all of these conditions, a
4964 * null string is returned.
4965 *
4966 * <p>If multiple activities are found to satisfy the intent, the one with
4967 * the highest priority will be used. If there are multiple activities
4968 * with the same priority, the system will either pick the best activity
4969 * based on user preference, or resolve to a system class that will allow
4970 * the user to pick an activity and forward from there.
4971 *
4972 * <p>This method is implemented simply by calling
4973 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4974 * true.</p>
4975 * <p> This API is called for you as part of starting an activity from an
4976 * intent. You do not normally need to call it yourself.</p>
4977 *
4978 * @param pm The package manager with which to resolve the Intent.
4979 *
4980 * @return Name of the component implementing an activity that can
4981 * display the intent.
4982 *
4983 * @see #setComponent
4984 * @see #getComponent
4985 * @see #resolveActivityInfo
4986 */
4987 public ComponentName resolveActivity(PackageManager pm) {
4988 if (mComponent != null) {
4989 return mComponent;
4990 }
4991
4992 ResolveInfo info = pm.resolveActivity(
4993 this, PackageManager.MATCH_DEFAULT_ONLY);
4994 if (info != null) {
4995 return new ComponentName(
4996 info.activityInfo.applicationInfo.packageName,
4997 info.activityInfo.name);
4998 }
4999
5000 return null;
5001 }
5002
5003 /**
5004 * Resolve the Intent into an {@link ActivityInfo}
5005 * describing the activity that should execute the intent. Resolution
5006 * follows the same rules as described for {@link #resolveActivity}, but
5007 * you get back the completely information about the resolved activity
5008 * instead of just its class name.
5009 *
5010 * @param pm The package manager with which to resolve the Intent.
5011 * @param flags Addition information to retrieve as per
5012 * {@link PackageManager#getActivityInfo(ComponentName, int)
5013 * PackageManager.getActivityInfo()}.
5014 *
5015 * @return PackageManager.ActivityInfo
5016 *
5017 * @see #resolveActivity
5018 */
5019 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
5020 ActivityInfo ai = null;
5021 if (mComponent != null) {
5022 try {
5023 ai = pm.getActivityInfo(mComponent, flags);
5024 } catch (PackageManager.NameNotFoundException e) {
5025 // ignore
5026 }
5027 } else {
5028 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07005029 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005030 if (info != null) {
5031 ai = info.activityInfo;
5032 }
5033 }
5034
5035 return ai;
5036 }
5037
5038 /**
Dianne Hackborn221ea892013-08-04 16:50:16 -07005039 * Special function for use by the system to resolve service
5040 * intents to system apps. Throws an exception if there are
5041 * multiple potential matches to the Intent. Returns null if
5042 * there are no matches.
5043 * @hide
5044 */
5045 public ComponentName resolveSystemService(PackageManager pm, int flags) {
5046 if (mComponent != null) {
5047 return mComponent;
5048 }
5049
5050 List<ResolveInfo> results = pm.queryIntentServices(this, flags);
5051 if (results == null) {
5052 return null;
5053 }
5054 ComponentName comp = null;
5055 for (int i=0; i<results.size(); i++) {
5056 ResolveInfo ri = results.get(i);
5057 if ((ri.serviceInfo.applicationInfo.flags&ApplicationInfo.FLAG_SYSTEM) == 0) {
5058 continue;
5059 }
5060 ComponentName foundComp = new ComponentName(ri.serviceInfo.applicationInfo.packageName,
5061 ri.serviceInfo.name);
5062 if (comp != null) {
5063 throw new IllegalStateException("Multiple system services handle " + this
5064 + ": " + comp + ", " + foundComp);
5065 }
5066 comp = foundComp;
5067 }
5068 return comp;
5069 }
5070
5071 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005072 * Set the general action to be performed.
5073 *
5074 * @param action An action name, such as ACTION_VIEW. Application-specific
5075 * actions should be prefixed with the vendor's package name.
5076 *
5077 * @return Returns the same Intent object, for chaining multiple calls
5078 * into a single statement.
5079 *
5080 * @see #getAction
5081 */
5082 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005083 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005084 return this;
5085 }
5086
5087 /**
5088 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005089 * clears any type that was previously set by {@link #setType} or
5090 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005091 *
Nick Pellyccae4122012-01-09 14:12:58 -08005092 * <p><em>Note: scheme matching in the Android framework is
5093 * case-sensitive, unlike the formal RFC. As a result,
5094 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005095 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005096 * {@link #setDataAndNormalize}
5097 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005098 *
Nick Pellyccae4122012-01-09 14:12:58 -08005099 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005100 *
5101 * @return Returns the same Intent object, for chaining multiple calls
5102 * into a single statement.
5103 *
5104 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005105 * @see #setDataAndNormalize
Dianne Hackborn221ea892013-08-04 16:50:16 -07005106 * @see android.net.Uri#normalizeScheme()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005107 */
5108 public Intent setData(Uri data) {
5109 mData = data;
5110 mType = null;
5111 return this;
5112 }
5113
5114 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005115 * Normalize and set the data this intent is operating on.
5116 *
5117 * <p>This method automatically clears any type that was
5118 * previously set (for example, by {@link #setType}).
5119 *
5120 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005121 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005122 * so really this is just a convenience method for
5123 * <pre>
5124 * setData(data.normalize())
5125 * </pre>
5126 *
5127 * @param data The Uri of the data this intent is now targeting.
5128 *
5129 * @return Returns the same Intent object, for chaining multiple calls
5130 * into a single statement.
5131 *
5132 * @see #getData
5133 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005134 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005135 */
5136 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005137 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005138 }
5139
5140 /**
5141 * Set an explicit MIME data type.
5142 *
5143 * <p>This is used to create intents that only specify a type and not data,
5144 * for example to indicate the type of data to return.
5145 *
5146 * <p>This method automatically clears any data that was
5147 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005148 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005149 * <p><em>Note: MIME type matching in the Android framework is
5150 * case-sensitive, unlike formal RFC MIME types. As a result,
5151 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005152 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5153 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005154 *
5155 * @param type The MIME type of the data being handled by this intent.
5156 *
5157 * @return Returns the same Intent object, for chaining multiple calls
5158 * into a single statement.
5159 *
5160 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005161 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005162 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005163 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005164 */
5165 public Intent setType(String type) {
5166 mData = null;
5167 mType = type;
5168 return this;
5169 }
5170
5171 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005172 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005173 *
Nick Pellyccae4122012-01-09 14:12:58 -08005174 * <p>This is used to create intents that only specify a type and not data,
5175 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005176 *
Nick Pellyccae4122012-01-09 14:12:58 -08005177 * <p>This method automatically clears any data that was
5178 * previously set (for example by {@link #setData}).
5179 *
5180 * <p>The MIME type is normalized using
5181 * {@link #normalizeMimeType} before it is set,
5182 * so really this is just a convenience method for
5183 * <pre>
5184 * setType(Intent.normalizeMimeType(type))
5185 * </pre>
5186 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005187 * @param type The MIME type of the data being handled by this intent.
5188 *
5189 * @return Returns the same Intent object, for chaining multiple calls
5190 * into a single statement.
5191 *
Nick Pellyccae4122012-01-09 14:12:58 -08005192 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005193 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005194 * @see #normalizeMimeType
5195 */
5196 public Intent setTypeAndNormalize(String type) {
5197 return setType(normalizeMimeType(type));
5198 }
5199
5200 /**
5201 * (Usually optional) Set the data for the intent along with an explicit
5202 * MIME data type. This method should very rarely be used -- it allows you
5203 * to override the MIME type that would ordinarily be inferred from the
5204 * data with your own type given here.
5205 *
5206 * <p><em>Note: MIME type and Uri scheme matching in the
5207 * Android framework is case-sensitive, unlike the formal RFC definitions.
5208 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005209 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005210 * {@link #setDataAndTypeAndNormalize}
5211 * to ensure that they are converted to lower case.</em>
5212 *
5213 * @param data The Uri of the data this intent is now targeting.
5214 * @param type The MIME type of the data being handled by this intent.
5215 *
5216 * @return Returns the same Intent object, for chaining multiple calls
5217 * into a single statement.
5218 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005219 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005220 * @see #setData
5221 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005222 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005223 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005224 */
5225 public Intent setDataAndType(Uri data, String type) {
5226 mData = data;
5227 mType = type;
5228 return this;
5229 }
5230
5231 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005232 * (Usually optional) Normalize and set both the data Uri and an explicit
5233 * MIME data type. This method should very rarely be used -- it allows you
5234 * to override the MIME type that would ordinarily be inferred from the
5235 * data with your own type given here.
5236 *
5237 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005238 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005239 * before they are set, so really this is just a convenience method for
5240 * <pre>
5241 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5242 * </pre>
5243 *
5244 * @param data The Uri of the data this intent is now targeting.
5245 * @param type The MIME type of the data being handled by this intent.
5246 *
5247 * @return Returns the same Intent object, for chaining multiple calls
5248 * into a single statement.
5249 *
5250 * @see #setType
5251 * @see #setData
5252 * @see #setDataAndType
5253 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005254 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005255 */
5256 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005257 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005258 }
5259
5260 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005261 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005262 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005263 * activities that provide <em>all</em> of the requested categories will be
5264 * used.
5265 *
5266 * @param category The desired category. This can be either one of the
5267 * predefined Intent categories, or a custom category in your own
5268 * namespace.
5269 *
5270 * @return Returns the same Intent object, for chaining multiple calls
5271 * into a single statement.
5272 *
5273 * @see #hasCategory
5274 * @see #removeCategory
5275 */
5276 public Intent addCategory(String category) {
5277 if (mCategories == null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07005278 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005279 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005280 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005281 return this;
5282 }
5283
5284 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005285 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005286 *
5287 * @param category The category to remove.
5288 *
5289 * @see #addCategory
5290 */
5291 public void removeCategory(String category) {
5292 if (mCategories != null) {
5293 mCategories.remove(category);
5294 if (mCategories.size() == 0) {
5295 mCategories = null;
5296 }
5297 }
5298 }
5299
5300 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005301 * Set a selector for this Intent. This is a modification to the kinds of
5302 * things the Intent will match. If the selector is set, it will be used
5303 * when trying to find entities that can handle the Intent, instead of the
5304 * main contents of the Intent. This allows you build an Intent containing
5305 * a generic protocol while targeting it more specifically.
5306 *
5307 * <p>An example of where this may be used is with things like
5308 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5309 * Intent that will launch the Browser application. However, the correct
5310 * main entry point of an application is actually {@link #ACTION_MAIN}
5311 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5312 * used to specify the actual Activity to launch. If you launch the browser
5313 * with something different, undesired behavior may happen if the user has
5314 * previously or later launches it the normal way, since they do not match.
5315 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5316 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5317 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5318 *
5319 * <p>Setting a selector does not impact the behavior of
5320 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5321 * desired behavior of a selector -- it does not impact the base meaning
5322 * of the Intent, just what kinds of things will be matched against it
5323 * when determining who can handle it.</p>
5324 *
5325 * <p>You can not use both a selector and {@link #setPackage(String)} on
5326 * the same base Intent.</p>
5327 *
5328 * @param selector The desired selector Intent; set to null to not use
5329 * a special selector.
5330 */
5331 public void setSelector(Intent selector) {
5332 if (selector == this) {
5333 throw new IllegalArgumentException(
5334 "Intent being set as a selector of itself");
5335 }
5336 if (selector != null && mPackage != null) {
5337 throw new IllegalArgumentException(
5338 "Can't set selector when package name is already set");
5339 }
5340 mSelector = selector;
5341 }
5342
5343 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005344 * Set a {@link ClipData} associated with this Intent. This replaces any
5345 * previously set ClipData.
5346 *
5347 * <p>The ClipData in an intent is not used for Intent matching or other
5348 * such operations. Semantically it is like extras, used to transmit
5349 * additional data with the Intent. The main feature of using this over
5350 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5351 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5352 * items included in the clip data. This is useful, in particular, if
5353 * you want to transmit an Intent containing multiple <code>content:</code>
5354 * URIs for which the recipient may not have global permission to access the
5355 * content provider.
5356 *
5357 * <p>If the ClipData contains items that are themselves Intents, any
5358 * grant flags in those Intents will be ignored. Only the top-level flags
5359 * of the main Intent are respected, and will be applied to all Uri or
5360 * Intent items in the clip (or sub-items of the clip).
5361 *
5362 * <p>The MIME type, label, and icon in the ClipData object are not
5363 * directly used by Intent. Applications should generally rely on the
5364 * MIME type of the Intent itself, not what it may find in the ClipData.
5365 * A common practice is to construct a ClipData for use with an Intent
5366 * with a MIME type of "*\/*".
5367 *
5368 * @param clip The new clip to set. May be null to clear the current clip.
5369 */
5370 public void setClipData(ClipData clip) {
5371 mClipData = clip;
5372 }
5373
5374 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005375 * Add extended data to the intent. The name must include a package
5376 * prefix, for example the app com.android.contacts would use names
5377 * like "com.android.contacts.ShowAll".
5378 *
5379 * @param name The name of the extra data, with package prefix.
5380 * @param value The boolean data value.
5381 *
5382 * @return Returns the same Intent object, for chaining multiple calls
5383 * into a single statement.
5384 *
5385 * @see #putExtras
5386 * @see #removeExtra
5387 * @see #getBooleanExtra(String, boolean)
5388 */
5389 public Intent putExtra(String name, boolean value) {
5390 if (mExtras == null) {
5391 mExtras = new Bundle();
5392 }
5393 mExtras.putBoolean(name, value);
5394 return this;
5395 }
5396
5397 /**
5398 * Add extended data to the intent. The name must include a package
5399 * prefix, for example the app com.android.contacts would use names
5400 * like "com.android.contacts.ShowAll".
5401 *
5402 * @param name The name of the extra data, with package prefix.
5403 * @param value The byte data value.
5404 *
5405 * @return Returns the same Intent object, for chaining multiple calls
5406 * into a single statement.
5407 *
5408 * @see #putExtras
5409 * @see #removeExtra
5410 * @see #getByteExtra(String, byte)
5411 */
5412 public Intent putExtra(String name, byte value) {
5413 if (mExtras == null) {
5414 mExtras = new Bundle();
5415 }
5416 mExtras.putByte(name, value);
5417 return this;
5418 }
5419
5420 /**
5421 * Add extended data to the intent. The name must include a package
5422 * prefix, for example the app com.android.contacts would use names
5423 * like "com.android.contacts.ShowAll".
5424 *
5425 * @param name The name of the extra data, with package prefix.
5426 * @param value The char data value.
5427 *
5428 * @return Returns the same Intent object, for chaining multiple calls
5429 * into a single statement.
5430 *
5431 * @see #putExtras
5432 * @see #removeExtra
5433 * @see #getCharExtra(String, char)
5434 */
5435 public Intent putExtra(String name, char value) {
5436 if (mExtras == null) {
5437 mExtras = new Bundle();
5438 }
5439 mExtras.putChar(name, value);
5440 return this;
5441 }
5442
5443 /**
5444 * Add extended data to the intent. The name must include a package
5445 * prefix, for example the app com.android.contacts would use names
5446 * like "com.android.contacts.ShowAll".
5447 *
5448 * @param name The name of the extra data, with package prefix.
5449 * @param value The short data value.
5450 *
5451 * @return Returns the same Intent object, for chaining multiple calls
5452 * into a single statement.
5453 *
5454 * @see #putExtras
5455 * @see #removeExtra
5456 * @see #getShortExtra(String, short)
5457 */
5458 public Intent putExtra(String name, short value) {
5459 if (mExtras == null) {
5460 mExtras = new Bundle();
5461 }
5462 mExtras.putShort(name, value);
5463 return this;
5464 }
5465
5466 /**
5467 * Add extended data to the intent. The name must include a package
5468 * prefix, for example the app com.android.contacts would use names
5469 * like "com.android.contacts.ShowAll".
5470 *
5471 * @param name The name of the extra data, with package prefix.
5472 * @param value The integer data value.
5473 *
5474 * @return Returns the same Intent object, for chaining multiple calls
5475 * into a single statement.
5476 *
5477 * @see #putExtras
5478 * @see #removeExtra
5479 * @see #getIntExtra(String, int)
5480 */
5481 public Intent putExtra(String name, int value) {
5482 if (mExtras == null) {
5483 mExtras = new Bundle();
5484 }
5485 mExtras.putInt(name, value);
5486 return this;
5487 }
5488
5489 /**
5490 * Add extended data to the intent. The name must include a package
5491 * prefix, for example the app com.android.contacts would use names
5492 * like "com.android.contacts.ShowAll".
5493 *
5494 * @param name The name of the extra data, with package prefix.
5495 * @param value The long data value.
5496 *
5497 * @return Returns the same Intent object, for chaining multiple calls
5498 * into a single statement.
5499 *
5500 * @see #putExtras
5501 * @see #removeExtra
5502 * @see #getLongExtra(String, long)
5503 */
5504 public Intent putExtra(String name, long value) {
5505 if (mExtras == null) {
5506 mExtras = new Bundle();
5507 }
5508 mExtras.putLong(name, value);
5509 return this;
5510 }
5511
5512 /**
5513 * Add extended data to the intent. The name must include a package
5514 * prefix, for example the app com.android.contacts would use names
5515 * like "com.android.contacts.ShowAll".
5516 *
5517 * @param name The name of the extra data, with package prefix.
5518 * @param value The float data value.
5519 *
5520 * @return Returns the same Intent object, for chaining multiple calls
5521 * into a single statement.
5522 *
5523 * @see #putExtras
5524 * @see #removeExtra
5525 * @see #getFloatExtra(String, float)
5526 */
5527 public Intent putExtra(String name, float value) {
5528 if (mExtras == null) {
5529 mExtras = new Bundle();
5530 }
5531 mExtras.putFloat(name, value);
5532 return this;
5533 }
5534
5535 /**
5536 * Add extended data to the intent. The name must include a package
5537 * prefix, for example the app com.android.contacts would use names
5538 * like "com.android.contacts.ShowAll".
5539 *
5540 * @param name The name of the extra data, with package prefix.
5541 * @param value The double data value.
5542 *
5543 * @return Returns the same Intent object, for chaining multiple calls
5544 * into a single statement.
5545 *
5546 * @see #putExtras
5547 * @see #removeExtra
5548 * @see #getDoubleExtra(String, double)
5549 */
5550 public Intent putExtra(String name, double value) {
5551 if (mExtras == null) {
5552 mExtras = new Bundle();
5553 }
5554 mExtras.putDouble(name, value);
5555 return this;
5556 }
5557
5558 /**
5559 * Add extended data to the intent. The name must include a package
5560 * prefix, for example the app com.android.contacts would use names
5561 * like "com.android.contacts.ShowAll".
5562 *
5563 * @param name The name of the extra data, with package prefix.
5564 * @param value The String data value.
5565 *
5566 * @return Returns the same Intent object, for chaining multiple calls
5567 * into a single statement.
5568 *
5569 * @see #putExtras
5570 * @see #removeExtra
5571 * @see #getStringExtra(String)
5572 */
5573 public Intent putExtra(String name, String value) {
5574 if (mExtras == null) {
5575 mExtras = new Bundle();
5576 }
5577 mExtras.putString(name, value);
5578 return this;
5579 }
5580
5581 /**
5582 * Add extended data to the intent. The name must include a package
5583 * prefix, for example the app com.android.contacts would use names
5584 * like "com.android.contacts.ShowAll".
5585 *
5586 * @param name The name of the extra data, with package prefix.
5587 * @param value The CharSequence data value.
5588 *
5589 * @return Returns the same Intent object, for chaining multiple calls
5590 * into a single statement.
5591 *
5592 * @see #putExtras
5593 * @see #removeExtra
5594 * @see #getCharSequenceExtra(String)
5595 */
5596 public Intent putExtra(String name, CharSequence value) {
5597 if (mExtras == null) {
5598 mExtras = new Bundle();
5599 }
5600 mExtras.putCharSequence(name, value);
5601 return this;
5602 }
5603
5604 /**
5605 * Add extended data to the intent. The name must include a package
5606 * prefix, for example the app com.android.contacts would use names
5607 * like "com.android.contacts.ShowAll".
5608 *
5609 * @param name The name of the extra data, with package prefix.
5610 * @param value The Parcelable data value.
5611 *
5612 * @return Returns the same Intent object, for chaining multiple calls
5613 * into a single statement.
5614 *
5615 * @see #putExtras
5616 * @see #removeExtra
5617 * @see #getParcelableExtra(String)
5618 */
5619 public Intent putExtra(String name, Parcelable value) {
5620 if (mExtras == null) {
5621 mExtras = new Bundle();
5622 }
5623 mExtras.putParcelable(name, value);
5624 return this;
5625 }
5626
5627 /**
5628 * Add extended data to the intent. The name must include a package
5629 * prefix, for example the app com.android.contacts would use names
5630 * like "com.android.contacts.ShowAll".
5631 *
5632 * @param name The name of the extra data, with package prefix.
5633 * @param value The Parcelable[] data value.
5634 *
5635 * @return Returns the same Intent object, for chaining multiple calls
5636 * into a single statement.
5637 *
5638 * @see #putExtras
5639 * @see #removeExtra
5640 * @see #getParcelableArrayExtra(String)
5641 */
5642 public Intent putExtra(String name, Parcelable[] value) {
5643 if (mExtras == null) {
5644 mExtras = new Bundle();
5645 }
5646 mExtras.putParcelableArray(name, value);
5647 return this;
5648 }
5649
5650 /**
5651 * Add extended data to the intent. The name must include a package
5652 * prefix, for example the app com.android.contacts would use names
5653 * like "com.android.contacts.ShowAll".
5654 *
5655 * @param name The name of the extra data, with package prefix.
5656 * @param value The ArrayList<Parcelable> data value.
5657 *
5658 * @return Returns the same Intent object, for chaining multiple calls
5659 * into a single statement.
5660 *
5661 * @see #putExtras
5662 * @see #removeExtra
5663 * @see #getParcelableArrayListExtra(String)
5664 */
5665 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5666 if (mExtras == null) {
5667 mExtras = new Bundle();
5668 }
5669 mExtras.putParcelableArrayList(name, value);
5670 return this;
5671 }
5672
5673 /**
5674 * Add extended data to the intent. The name must include a package
5675 * prefix, for example the app com.android.contacts would use names
5676 * like "com.android.contacts.ShowAll".
5677 *
5678 * @param name The name of the extra data, with package prefix.
5679 * @param value The ArrayList<Integer> data value.
5680 *
5681 * @return Returns the same Intent object, for chaining multiple calls
5682 * into a single statement.
5683 *
5684 * @see #putExtras
5685 * @see #removeExtra
5686 * @see #getIntegerArrayListExtra(String)
5687 */
5688 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5689 if (mExtras == null) {
5690 mExtras = new Bundle();
5691 }
5692 mExtras.putIntegerArrayList(name, value);
5693 return this;
5694 }
5695
5696 /**
5697 * Add extended data to the intent. The name must include a package
5698 * prefix, for example the app com.android.contacts would use names
5699 * like "com.android.contacts.ShowAll".
5700 *
5701 * @param name The name of the extra data, with package prefix.
5702 * @param value The ArrayList<String> data value.
5703 *
5704 * @return Returns the same Intent object, for chaining multiple calls
5705 * into a single statement.
5706 *
5707 * @see #putExtras
5708 * @see #removeExtra
5709 * @see #getStringArrayListExtra(String)
5710 */
5711 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5712 if (mExtras == null) {
5713 mExtras = new Bundle();
5714 }
5715 mExtras.putStringArrayList(name, value);
5716 return this;
5717 }
5718
5719 /**
5720 * Add extended data to the intent. The name must include a package
5721 * prefix, for example the app com.android.contacts would use names
5722 * like "com.android.contacts.ShowAll".
5723 *
5724 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005725 * @param value The ArrayList<CharSequence> data value.
5726 *
5727 * @return Returns the same Intent object, for chaining multiple calls
5728 * into a single statement.
5729 *
5730 * @see #putExtras
5731 * @see #removeExtra
5732 * @see #getCharSequenceArrayListExtra(String)
5733 */
5734 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5735 if (mExtras == null) {
5736 mExtras = new Bundle();
5737 }
5738 mExtras.putCharSequenceArrayList(name, value);
5739 return this;
5740 }
5741
5742 /**
5743 * Add extended data to the intent. The name must include a package
5744 * prefix, for example the app com.android.contacts would use names
5745 * like "com.android.contacts.ShowAll".
5746 *
5747 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005748 * @param value The Serializable data value.
5749 *
5750 * @return Returns the same Intent object, for chaining multiple calls
5751 * into a single statement.
5752 *
5753 * @see #putExtras
5754 * @see #removeExtra
5755 * @see #getSerializableExtra(String)
5756 */
5757 public Intent putExtra(String name, Serializable value) {
5758 if (mExtras == null) {
5759 mExtras = new Bundle();
5760 }
5761 mExtras.putSerializable(name, value);
5762 return this;
5763 }
5764
5765 /**
5766 * Add extended data to the intent. The name must include a package
5767 * prefix, for example the app com.android.contacts would use names
5768 * like "com.android.contacts.ShowAll".
5769 *
5770 * @param name The name of the extra data, with package prefix.
5771 * @param value The boolean array data value.
5772 *
5773 * @return Returns the same Intent object, for chaining multiple calls
5774 * into a single statement.
5775 *
5776 * @see #putExtras
5777 * @see #removeExtra
5778 * @see #getBooleanArrayExtra(String)
5779 */
5780 public Intent putExtra(String name, boolean[] value) {
5781 if (mExtras == null) {
5782 mExtras = new Bundle();
5783 }
5784 mExtras.putBooleanArray(name, value);
5785 return this;
5786 }
5787
5788 /**
5789 * Add extended data to the intent. The name must include a package
5790 * prefix, for example the app com.android.contacts would use names
5791 * like "com.android.contacts.ShowAll".
5792 *
5793 * @param name The name of the extra data, with package prefix.
5794 * @param value The byte array data value.
5795 *
5796 * @return Returns the same Intent object, for chaining multiple calls
5797 * into a single statement.
5798 *
5799 * @see #putExtras
5800 * @see #removeExtra
5801 * @see #getByteArrayExtra(String)
5802 */
5803 public Intent putExtra(String name, byte[] value) {
5804 if (mExtras == null) {
5805 mExtras = new Bundle();
5806 }
5807 mExtras.putByteArray(name, value);
5808 return this;
5809 }
5810
5811 /**
5812 * Add extended data to the intent. The name must include a package
5813 * prefix, for example the app com.android.contacts would use names
5814 * like "com.android.contacts.ShowAll".
5815 *
5816 * @param name The name of the extra data, with package prefix.
5817 * @param value The short array data value.
5818 *
5819 * @return Returns the same Intent object, for chaining multiple calls
5820 * into a single statement.
5821 *
5822 * @see #putExtras
5823 * @see #removeExtra
5824 * @see #getShortArrayExtra(String)
5825 */
5826 public Intent putExtra(String name, short[] value) {
5827 if (mExtras == null) {
5828 mExtras = new Bundle();
5829 }
5830 mExtras.putShortArray(name, value);
5831 return this;
5832 }
5833
5834 /**
5835 * Add extended data to the intent. The name must include a package
5836 * prefix, for example the app com.android.contacts would use names
5837 * like "com.android.contacts.ShowAll".
5838 *
5839 * @param name The name of the extra data, with package prefix.
5840 * @param value The char array data value.
5841 *
5842 * @return Returns the same Intent object, for chaining multiple calls
5843 * into a single statement.
5844 *
5845 * @see #putExtras
5846 * @see #removeExtra
5847 * @see #getCharArrayExtra(String)
5848 */
5849 public Intent putExtra(String name, char[] value) {
5850 if (mExtras == null) {
5851 mExtras = new Bundle();
5852 }
5853 mExtras.putCharArray(name, value);
5854 return this;
5855 }
5856
5857 /**
5858 * Add extended data to the intent. The name must include a package
5859 * prefix, for example the app com.android.contacts would use names
5860 * like "com.android.contacts.ShowAll".
5861 *
5862 * @param name The name of the extra data, with package prefix.
5863 * @param value The int array data value.
5864 *
5865 * @return Returns the same Intent object, for chaining multiple calls
5866 * into a single statement.
5867 *
5868 * @see #putExtras
5869 * @see #removeExtra
5870 * @see #getIntArrayExtra(String)
5871 */
5872 public Intent putExtra(String name, int[] value) {
5873 if (mExtras == null) {
5874 mExtras = new Bundle();
5875 }
5876 mExtras.putIntArray(name, value);
5877 return this;
5878 }
5879
5880 /**
5881 * Add extended data to the intent. The name must include a package
5882 * prefix, for example the app com.android.contacts would use names
5883 * like "com.android.contacts.ShowAll".
5884 *
5885 * @param name The name of the extra data, with package prefix.
5886 * @param value The byte array data value.
5887 *
5888 * @return Returns the same Intent object, for chaining multiple calls
5889 * into a single statement.
5890 *
5891 * @see #putExtras
5892 * @see #removeExtra
5893 * @see #getLongArrayExtra(String)
5894 */
5895 public Intent putExtra(String name, long[] value) {
5896 if (mExtras == null) {
5897 mExtras = new Bundle();
5898 }
5899 mExtras.putLongArray(name, value);
5900 return this;
5901 }
5902
5903 /**
5904 * Add extended data to the intent. The name must include a package
5905 * prefix, for example the app com.android.contacts would use names
5906 * like "com.android.contacts.ShowAll".
5907 *
5908 * @param name The name of the extra data, with package prefix.
5909 * @param value The float array data value.
5910 *
5911 * @return Returns the same Intent object, for chaining multiple calls
5912 * into a single statement.
5913 *
5914 * @see #putExtras
5915 * @see #removeExtra
5916 * @see #getFloatArrayExtra(String)
5917 */
5918 public Intent putExtra(String name, float[] value) {
5919 if (mExtras == null) {
5920 mExtras = new Bundle();
5921 }
5922 mExtras.putFloatArray(name, value);
5923 return this;
5924 }
5925
5926 /**
5927 * Add extended data to the intent. The name must include a package
5928 * prefix, for example the app com.android.contacts would use names
5929 * like "com.android.contacts.ShowAll".
5930 *
5931 * @param name The name of the extra data, with package prefix.
5932 * @param value The double array data value.
5933 *
5934 * @return Returns the same Intent object, for chaining multiple calls
5935 * into a single statement.
5936 *
5937 * @see #putExtras
5938 * @see #removeExtra
5939 * @see #getDoubleArrayExtra(String)
5940 */
5941 public Intent putExtra(String name, double[] value) {
5942 if (mExtras == null) {
5943 mExtras = new Bundle();
5944 }
5945 mExtras.putDoubleArray(name, value);
5946 return this;
5947 }
5948
5949 /**
5950 * Add extended data to the intent. The name must include a package
5951 * prefix, for example the app com.android.contacts would use names
5952 * like "com.android.contacts.ShowAll".
5953 *
5954 * @param name The name of the extra data, with package prefix.
5955 * @param value The String array data value.
5956 *
5957 * @return Returns the same Intent object, for chaining multiple calls
5958 * into a single statement.
5959 *
5960 * @see #putExtras
5961 * @see #removeExtra
5962 * @see #getStringArrayExtra(String)
5963 */
5964 public Intent putExtra(String name, String[] value) {
5965 if (mExtras == null) {
5966 mExtras = new Bundle();
5967 }
5968 mExtras.putStringArray(name, value);
5969 return this;
5970 }
5971
5972 /**
5973 * Add extended data to the intent. The name must include a package
5974 * prefix, for example the app com.android.contacts would use names
5975 * like "com.android.contacts.ShowAll".
5976 *
5977 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005978 * @param value The CharSequence array data value.
5979 *
5980 * @return Returns the same Intent object, for chaining multiple calls
5981 * into a single statement.
5982 *
5983 * @see #putExtras
5984 * @see #removeExtra
5985 * @see #getCharSequenceArrayExtra(String)
5986 */
5987 public Intent putExtra(String name, CharSequence[] value) {
5988 if (mExtras == null) {
5989 mExtras = new Bundle();
5990 }
5991 mExtras.putCharSequenceArray(name, value);
5992 return this;
5993 }
5994
5995 /**
5996 * Add extended data to the intent. The name must include a package
5997 * prefix, for example the app com.android.contacts would use names
5998 * like "com.android.contacts.ShowAll".
5999 *
6000 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006001 * @param value The Bundle data value.
6002 *
6003 * @return Returns the same Intent object, for chaining multiple calls
6004 * into a single statement.
6005 *
6006 * @see #putExtras
6007 * @see #removeExtra
6008 * @see #getBundleExtra(String)
6009 */
6010 public Intent putExtra(String name, Bundle value) {
6011 if (mExtras == null) {
6012 mExtras = new Bundle();
6013 }
6014 mExtras.putBundle(name, value);
6015 return this;
6016 }
6017
6018 /**
6019 * Add extended data to the intent. The name must include a package
6020 * prefix, for example the app com.android.contacts would use names
6021 * like "com.android.contacts.ShowAll".
6022 *
6023 * @param name The name of the extra data, with package prefix.
6024 * @param value The IBinder data value.
6025 *
6026 * @return Returns the same Intent object, for chaining multiple calls
6027 * into a single statement.
6028 *
6029 * @see #putExtras
6030 * @see #removeExtra
6031 * @see #getIBinderExtra(String)
6032 *
6033 * @deprecated
6034 * @hide
6035 */
6036 @Deprecated
6037 public Intent putExtra(String name, IBinder value) {
6038 if (mExtras == null) {
6039 mExtras = new Bundle();
6040 }
6041 mExtras.putIBinder(name, value);
6042 return this;
6043 }
6044
6045 /**
6046 * Copy all extras in 'src' in to this intent.
6047 *
6048 * @param src Contains the extras to copy.
6049 *
6050 * @see #putExtra
6051 */
6052 public Intent putExtras(Intent src) {
6053 if (src.mExtras != null) {
6054 if (mExtras == null) {
6055 mExtras = new Bundle(src.mExtras);
6056 } else {
6057 mExtras.putAll(src.mExtras);
6058 }
6059 }
6060 return this;
6061 }
6062
6063 /**
6064 * Add a set of extended data to the intent. The keys must include a package
6065 * prefix, for example the app com.android.contacts would use names
6066 * like "com.android.contacts.ShowAll".
6067 *
6068 * @param extras The Bundle of extras to add to this intent.
6069 *
6070 * @see #putExtra
6071 * @see #removeExtra
6072 */
6073 public Intent putExtras(Bundle extras) {
6074 if (mExtras == null) {
6075 mExtras = new Bundle();
6076 }
6077 mExtras.putAll(extras);
6078 return this;
6079 }
6080
6081 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006082 * Completely replace the extras in the Intent with the extras in the
6083 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006084 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006085 * @param src The exact extras contained in this Intent are copied
6086 * into the target intent, replacing any that were previously there.
6087 */
6088 public Intent replaceExtras(Intent src) {
6089 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6090 return this;
6091 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006092
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006093 /**
6094 * Completely replace the extras in the Intent with the given Bundle of
6095 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006096 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006097 * @param extras The new set of extras in the Intent, or null to erase
6098 * all extras.
6099 */
6100 public Intent replaceExtras(Bundle extras) {
6101 mExtras = extras != null ? new Bundle(extras) : null;
6102 return this;
6103 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006104
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006105 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006106 * Remove extended data from the intent.
6107 *
6108 * @see #putExtra
6109 */
6110 public void removeExtra(String name) {
6111 if (mExtras != null) {
6112 mExtras.remove(name);
6113 if (mExtras.size() == 0) {
6114 mExtras = null;
6115 }
6116 }
6117 }
6118
6119 /**
6120 * Set special flags controlling how this intent is handled. Most values
6121 * here depend on the type of component being executed by the Intent,
6122 * specifically the FLAG_ACTIVITY_* flags are all for use with
6123 * {@link Context#startActivity Context.startActivity()} and the
6124 * FLAG_RECEIVER_* flags are all for use with
6125 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6126 *
Scott Main7aee61f2011-02-08 11:25:01 -08006127 * <p>See the
6128 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6129 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006130 * the behavior of your application.
6131 *
6132 * @param flags The desired flags.
6133 *
6134 * @return Returns the same Intent object, for chaining multiple calls
6135 * into a single statement.
6136 *
6137 * @see #getFlags
6138 * @see #addFlags
6139 *
6140 * @see #FLAG_GRANT_READ_URI_PERMISSION
6141 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6142 * @see #FLAG_DEBUG_LOG_RESOLUTION
6143 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006144 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006145 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006146 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006147 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006148 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6149 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006150 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006151 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6152 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006153 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006154 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006155 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006156 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6157 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006158 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006159 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006160 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006161 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6162 */
6163 public Intent setFlags(int flags) {
6164 mFlags = flags;
6165 return this;
6166 }
6167
6168 /**
6169 * Add additional flags to the intent (or with existing flags
6170 * value).
6171 *
6172 * @param flags The new flags to set.
6173 *
6174 * @return Returns the same Intent object, for chaining multiple calls
6175 * into a single statement.
6176 *
6177 * @see #setFlags
6178 */
6179 public Intent addFlags(int flags) {
6180 mFlags |= flags;
6181 return this;
6182 }
6183
6184 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006185 * (Usually optional) Set an explicit application package name that limits
6186 * the components this Intent will resolve to. If left to the default
6187 * value of null, all components in all applications will considered.
6188 * If non-null, the Intent can only match the components in the given
6189 * application package.
6190 *
6191 * @param packageName The name of the application package to handle the
6192 * intent, or null to allow any application package.
6193 *
6194 * @return Returns the same Intent object, for chaining multiple calls
6195 * into a single statement.
6196 *
6197 * @see #getPackage
6198 * @see #resolveActivity
6199 */
6200 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006201 if (packageName != null && mSelector != null) {
6202 throw new IllegalArgumentException(
6203 "Can't set package name when selector is already set");
6204 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006205 mPackage = packageName;
6206 return this;
6207 }
6208
6209 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006210 * (Usually optional) Explicitly set the component to handle the intent.
6211 * If left with the default value of null, the system will determine the
6212 * appropriate class to use based on the other fields (action, data,
6213 * type, categories) in the Intent. If this class is defined, the
6214 * specified class will always be used regardless of the other fields. You
6215 * should only set this value when you know you absolutely want a specific
6216 * class to be used; otherwise it is better to let the system find the
6217 * appropriate class so that you will respect the installed applications
6218 * and user preferences.
6219 *
6220 * @param component The name of the application component to handle the
6221 * intent, or null to let the system find one for you.
6222 *
6223 * @return Returns the same Intent object, for chaining multiple calls
6224 * into a single statement.
6225 *
6226 * @see #setClass
6227 * @see #setClassName(Context, String)
6228 * @see #setClassName(String, String)
6229 * @see #getComponent
6230 * @see #resolveActivity
6231 */
6232 public Intent setComponent(ComponentName component) {
6233 mComponent = component;
6234 return this;
6235 }
6236
6237 /**
6238 * Convenience for calling {@link #setComponent} with an
6239 * explicit class name.
6240 *
6241 * @param packageContext A Context of the application package implementing
6242 * this class.
6243 * @param className The name of a class inside of the application package
6244 * that will be used as the component for this Intent.
6245 *
6246 * @return Returns the same Intent object, for chaining multiple calls
6247 * into a single statement.
6248 *
6249 * @see #setComponent
6250 * @see #setClass
6251 */
6252 public Intent setClassName(Context packageContext, String className) {
6253 mComponent = new ComponentName(packageContext, className);
6254 return this;
6255 }
6256
6257 /**
6258 * Convenience for calling {@link #setComponent} with an
6259 * explicit application package name and class name.
6260 *
6261 * @param packageName The name of the package implementing the desired
6262 * component.
6263 * @param className The name of a class inside of the application package
6264 * that will be used as the component for this Intent.
6265 *
6266 * @return Returns the same Intent object, for chaining multiple calls
6267 * into a single statement.
6268 *
6269 * @see #setComponent
6270 * @see #setClass
6271 */
6272 public Intent setClassName(String packageName, String className) {
6273 mComponent = new ComponentName(packageName, className);
6274 return this;
6275 }
6276
6277 /**
6278 * Convenience for calling {@link #setComponent(ComponentName)} with the
6279 * name returned by a {@link Class} object.
6280 *
6281 * @param packageContext A Context of the application package implementing
6282 * this class.
6283 * @param cls The class name to set, equivalent to
6284 * <code>setClassName(context, cls.getName())</code>.
6285 *
6286 * @return Returns the same Intent object, for chaining multiple calls
6287 * into a single statement.
6288 *
6289 * @see #setComponent
6290 */
6291 public Intent setClass(Context packageContext, Class<?> cls) {
6292 mComponent = new ComponentName(packageContext, cls);
6293 return this;
6294 }
6295
6296 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006297 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6298 * used as a hint to the receiver for animations and the like. Null means that there
6299 * is no source bounds.
6300 */
6301 public void setSourceBounds(Rect r) {
6302 if (r != null) {
6303 mSourceBounds = new Rect(r);
6304 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006305 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006306 }
6307 }
6308
6309 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006310 * Use with {@link #fillIn} to allow the current action value to be
6311 * overwritten, even if it is already set.
6312 */
6313 public static final int FILL_IN_ACTION = 1<<0;
6314
6315 /**
6316 * Use with {@link #fillIn} to allow the current data or type value
6317 * overwritten, even if it is already set.
6318 */
6319 public static final int FILL_IN_DATA = 1<<1;
6320
6321 /**
6322 * Use with {@link #fillIn} to allow the current categories to be
6323 * overwritten, even if they are already set.
6324 */
6325 public static final int FILL_IN_CATEGORIES = 1<<2;
6326
6327 /**
6328 * Use with {@link #fillIn} to allow the current component value to be
6329 * overwritten, even if it is already set.
6330 */
6331 public static final int FILL_IN_COMPONENT = 1<<3;
6332
6333 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006334 * Use with {@link #fillIn} to allow the current package value to be
6335 * overwritten, even if it is already set.
6336 */
6337 public static final int FILL_IN_PACKAGE = 1<<4;
6338
6339 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006340 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006341 * overwritten, even if it is already set.
6342 */
6343 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6344
6345 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006346 * Use with {@link #fillIn} to allow the current selector to be
6347 * overwritten, even if it is already set.
6348 */
6349 public static final int FILL_IN_SELECTOR = 1<<6;
6350
6351 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006352 * Use with {@link #fillIn} to allow the current ClipData to be
6353 * overwritten, even if it is already set.
6354 */
6355 public static final int FILL_IN_CLIP_DATA = 1<<7;
6356
6357 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006358 * Copy the contents of <var>other</var> in to this object, but only
6359 * where fields are not defined by this object. For purposes of a field
6360 * being defined, the following pieces of data in the Intent are
6361 * considered to be separate fields:
6362 *
6363 * <ul>
6364 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006365 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006366 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6367 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006368 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006369 * <li> component, as set by {@link #setComponent(ComponentName)} or
6370 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006371 * <li> source bounds, as set by {@link #setSourceBounds}.
6372 * <li> selector, as set by {@link #setSelector(Intent)}.
6373 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006374 * <li> each top-level name in the associated extras.
6375 * </ul>
6376 *
6377 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006378 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006379 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6380 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6381 * the restriction where the corresponding field will not be replaced if
6382 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006383 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006384 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6385 * is explicitly specified. The selector will only be copied if
6386 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006387 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006388 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6389 * and Intent B with {action="gotit", data-type="some/thing",
6390 * categories="one","two"}.
6391 *
6392 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6393 * containing: {action="gotit", data-type="some/thing",
6394 * categories="bar"}.
6395 *
6396 * @param other Another Intent whose values are to be used to fill in
6397 * the current one.
6398 * @param flags Options to control which fields can be filled in.
6399 *
6400 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006401 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006402 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6403 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 */
6405 public int fillIn(Intent other, int flags) {
6406 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006407 if (other.mAction != null
6408 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006409 mAction = other.mAction;
6410 changes |= FILL_IN_ACTION;
6411 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006412 if ((other.mData != null || other.mType != null)
6413 && ((mData == null && mType == null)
6414 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006415 mData = other.mData;
6416 mType = other.mType;
6417 changes |= FILL_IN_DATA;
6418 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006419 if (other.mCategories != null
6420 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006421 if (other.mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006422 mCategories = new ArraySet<String>(other.mCategories);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006423 }
6424 changes |= FILL_IN_CATEGORIES;
6425 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006426 if (other.mPackage != null
6427 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006428 // Only do this if mSelector is not set.
6429 if (mSelector == null) {
6430 mPackage = other.mPackage;
6431 changes |= FILL_IN_PACKAGE;
6432 }
6433 }
6434 // Selector is special: it can only be set if explicitly allowed,
6435 // for the same reason as the component name.
6436 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6437 if (mPackage == null) {
6438 mSelector = new Intent(other.mSelector);
6439 mPackage = null;
6440 changes |= FILL_IN_SELECTOR;
6441 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006442 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006443 if (other.mClipData != null
6444 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6445 mClipData = other.mClipData;
6446 changes |= FILL_IN_CLIP_DATA;
6447 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006448 // Component is special: it can -only- be set if explicitly allowed,
6449 // since otherwise the sender could force the intent somewhere the
6450 // originator didn't intend.
6451 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006452 mComponent = other.mComponent;
6453 changes |= FILL_IN_COMPONENT;
6454 }
6455 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006456 if (other.mSourceBounds != null
6457 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6458 mSourceBounds = new Rect(other.mSourceBounds);
6459 changes |= FILL_IN_SOURCE_BOUNDS;
6460 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006461 if (mExtras == null) {
6462 if (other.mExtras != null) {
6463 mExtras = new Bundle(other.mExtras);
6464 }
6465 } else if (other.mExtras != null) {
6466 try {
6467 Bundle newb = new Bundle(other.mExtras);
6468 newb.putAll(mExtras);
6469 mExtras = newb;
6470 } catch (RuntimeException e) {
6471 // Modifying the extras can cause us to unparcel the contents
6472 // of the bundle, and if we do this in the system process that
6473 // may fail. We really should handle this (i.e., the Bundle
6474 // impl shouldn't be on top of a plain map), but for now just
6475 // ignore it and keep the original contents. :(
6476 Log.w("Intent", "Failure filling in extras", e);
6477 }
6478 }
6479 return changes;
6480 }
6481
6482 /**
6483 * Wrapper class holding an Intent and implementing comparisons on it for
6484 * the purpose of filtering. The class implements its
6485 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6486 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6487 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6488 * on the wrapped Intent.
6489 */
6490 public static final class FilterComparison {
6491 private final Intent mIntent;
6492 private final int mHashCode;
6493
6494 public FilterComparison(Intent intent) {
6495 mIntent = intent;
6496 mHashCode = intent.filterHashCode();
6497 }
6498
6499 /**
6500 * Return the Intent that this FilterComparison represents.
6501 * @return Returns the Intent held by the FilterComparison. Do
6502 * not modify!
6503 */
6504 public Intent getIntent() {
6505 return mIntent;
6506 }
6507
6508 @Override
6509 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006510 if (obj instanceof FilterComparison) {
6511 Intent other = ((FilterComparison)obj).mIntent;
6512 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006513 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006514 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006515 }
6516
6517 @Override
6518 public int hashCode() {
6519 return mHashCode;
6520 }
6521 }
6522
6523 /**
6524 * Determine if two intents are the same for the purposes of intent
6525 * resolution (filtering). That is, if their action, data, type,
6526 * class, and categories are the same. This does <em>not</em> compare
6527 * any extra data included in the intents.
6528 *
6529 * @param other The other Intent to compare against.
6530 *
6531 * @return Returns true if action, data, type, class, and categories
6532 * are the same.
6533 */
6534 public boolean filterEquals(Intent other) {
6535 if (other == null) {
6536 return false;
6537 }
6538 if (mAction != other.mAction) {
6539 if (mAction != null) {
6540 if (!mAction.equals(other.mAction)) {
6541 return false;
6542 }
6543 } else {
6544 if (!other.mAction.equals(mAction)) {
6545 return false;
6546 }
6547 }
6548 }
6549 if (mData != other.mData) {
6550 if (mData != null) {
6551 if (!mData.equals(other.mData)) {
6552 return false;
6553 }
6554 } else {
6555 if (!other.mData.equals(mData)) {
6556 return false;
6557 }
6558 }
6559 }
6560 if (mType != other.mType) {
6561 if (mType != null) {
6562 if (!mType.equals(other.mType)) {
6563 return false;
6564 }
6565 } else {
6566 if (!other.mType.equals(mType)) {
6567 return false;
6568 }
6569 }
6570 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006571 if (mPackage != other.mPackage) {
6572 if (mPackage != null) {
6573 if (!mPackage.equals(other.mPackage)) {
6574 return false;
6575 }
6576 } else {
6577 if (!other.mPackage.equals(mPackage)) {
6578 return false;
6579 }
6580 }
6581 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006582 if (mComponent != other.mComponent) {
6583 if (mComponent != null) {
6584 if (!mComponent.equals(other.mComponent)) {
6585 return false;
6586 }
6587 } else {
6588 if (!other.mComponent.equals(mComponent)) {
6589 return false;
6590 }
6591 }
6592 }
6593 if (mCategories != other.mCategories) {
6594 if (mCategories != null) {
6595 if (!mCategories.equals(other.mCategories)) {
6596 return false;
6597 }
6598 } else {
6599 if (!other.mCategories.equals(mCategories)) {
6600 return false;
6601 }
6602 }
6603 }
6604
6605 return true;
6606 }
6607
6608 /**
6609 * Generate hash code that matches semantics of filterEquals().
6610 *
6611 * @return Returns the hash value of the action, data, type, class, and
6612 * categories.
6613 *
6614 * @see #filterEquals
6615 */
6616 public int filterHashCode() {
6617 int code = 0;
6618 if (mAction != null) {
6619 code += mAction.hashCode();
6620 }
6621 if (mData != null) {
6622 code += mData.hashCode();
6623 }
6624 if (mType != null) {
6625 code += mType.hashCode();
6626 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006627 if (mPackage != null) {
6628 code += mPackage.hashCode();
6629 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006630 if (mComponent != null) {
6631 code += mComponent.hashCode();
6632 }
6633 if (mCategories != null) {
6634 code += mCategories.hashCode();
6635 }
6636 return code;
6637 }
6638
6639 @Override
6640 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006641 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006642
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006643 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006644 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006645 b.append(" }");
6646
6647 return b.toString();
6648 }
6649
6650 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006651 public String toInsecureString() {
6652 StringBuilder b = new StringBuilder(128);
6653
6654 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006655 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006656 b.append(" }");
6657
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006658 return b.toString();
6659 }
Romain Guy4969af72009-06-17 10:53:19 -07006660
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006661 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006662 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006663 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006664
6665 b.append("Intent { ");
6666 toShortString(b, false, true, true, true);
6667 b.append(" }");
6668
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006669 return b.toString();
6670 }
6671
6672 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006673 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6674 StringBuilder b = new StringBuilder(128);
6675 toShortString(b, secure, comp, extras, clip);
6676 return b.toString();
6677 }
6678
6679 /** @hide */
6680 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6681 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006682 boolean first = true;
6683 if (mAction != null) {
6684 b.append("act=").append(mAction);
6685 first = false;
6686 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006687 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006688 if (!first) {
6689 b.append(' ');
6690 }
6691 first = false;
6692 b.append("cat=[");
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006693 for (int i=0; i<mCategories.size(); i++) {
6694 if (i > 0) b.append(',');
6695 b.append(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006696 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006697 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006698 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006699 if (mData != null) {
6700 if (!first) {
6701 b.append(' ');
6702 }
6703 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006704 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006705 if (secure) {
6706 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006707 } else {
6708 b.append(mData);
6709 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006710 }
6711 if (mType != null) {
6712 if (!first) {
6713 b.append(' ');
6714 }
6715 first = false;
6716 b.append("typ=").append(mType);
6717 }
6718 if (mFlags != 0) {
6719 if (!first) {
6720 b.append(' ');
6721 }
6722 first = false;
6723 b.append("flg=0x").append(Integer.toHexString(mFlags));
6724 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006725 if (mPackage != null) {
6726 if (!first) {
6727 b.append(' ');
6728 }
6729 first = false;
6730 b.append("pkg=").append(mPackage);
6731 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006732 if (comp && mComponent != null) {
6733 if (!first) {
6734 b.append(' ');
6735 }
6736 first = false;
6737 b.append("cmp=").append(mComponent.flattenToShortString());
6738 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006739 if (mSourceBounds != null) {
6740 if (!first) {
6741 b.append(' ');
6742 }
6743 first = false;
6744 b.append("bnds=").append(mSourceBounds.toShortString());
6745 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006746 if (mClipData != null) {
6747 if (!first) {
6748 b.append(' ');
6749 }
6750 first = false;
6751 if (clip) {
6752 b.append("clip={");
6753 mClipData.toShortString(b);
6754 b.append('}');
6755 } else {
6756 b.append("(has clip)");
6757 }
6758 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006759 if (extras && mExtras != null) {
6760 if (!first) {
6761 b.append(' ');
6762 }
6763 first = false;
6764 b.append("(has extras)");
6765 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006766 if (mSelector != null) {
6767 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006768 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006769 b.append("}");
6770 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006771 }
6772
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006773 /**
6774 * Call {@link #toUri} with 0 flags.
6775 * @deprecated Use {@link #toUri} instead.
6776 */
6777 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006778 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006779 return toUri(0);
6780 }
6781
6782 /**
6783 * Convert this Intent into a String holding a URI representation of it.
6784 * The returned URI string has been properly URI encoded, so it can be
6785 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6786 * Intent's data as the base URI, with an additional fragment describing
6787 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006788 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006789 * <p>You can convert the returned string back to an Intent with
6790 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006791 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006792 * @param flags Additional operating flags. Either 0 or
6793 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006794 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006795 * @return Returns a URI encoding URI string describing the entire contents
6796 * of the Intent.
6797 */
6798 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006799 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006800 String scheme = null;
6801 if (mData != null) {
6802 String data = mData.toString();
6803 if ((flags&URI_INTENT_SCHEME) != 0) {
6804 final int N = data.length();
6805 for (int i=0; i<N; i++) {
6806 char c = data.charAt(i);
6807 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6808 || c == '.' || c == '-') {
6809 continue;
6810 }
6811 if (c == ':' && i > 0) {
6812 // Valid scheme.
6813 scheme = data.substring(0, i);
6814 uri.append("intent:");
6815 data = data.substring(i+1);
6816 break;
6817 }
Tom Taylord4a47292009-12-21 13:59:18 -08006818
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006819 // No scheme.
6820 break;
6821 }
6822 }
6823 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006824
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006825 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6826 uri.append("intent:");
6827 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006828
6829 uri.append("#Intent;");
6830
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006831 toUriInner(uri, scheme, flags);
6832 if (mSelector != null) {
6833 uri.append("SEL;");
6834 // Note that for now we are not going to try to handle the
6835 // data part; not clear how to represent this as a URI, and
6836 // not much utility in it.
6837 mSelector.toUriInner(uri, null, flags);
6838 }
6839
6840 uri.append("end");
6841
6842 return uri.toString();
6843 }
6844
6845 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006846 if (scheme != null) {
6847 uri.append("scheme=").append(scheme).append(';');
6848 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006849 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006850 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006851 }
6852 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006853 for (int i=0; i<mCategories.size(); i++) {
6854 uri.append("category=").append(Uri.encode(mCategories.valueAt(i))).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006855 }
6856 }
6857 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006858 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006859 }
6860 if (mFlags != 0) {
6861 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6862 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006863 if (mPackage != null) {
6864 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6865 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006866 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006867 uri.append("component=").append(Uri.encode(
6868 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006869 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006870 if (mSourceBounds != null) {
6871 uri.append("sourceBounds=")
6872 .append(Uri.encode(mSourceBounds.flattenToString()))
6873 .append(';');
6874 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006875 if (mExtras != null) {
6876 for (String key : mExtras.keySet()) {
6877 final Object value = mExtras.get(key);
6878 char entryType =
6879 value instanceof String ? 'S' :
6880 value instanceof Boolean ? 'B' :
6881 value instanceof Byte ? 'b' :
6882 value instanceof Character ? 'c' :
6883 value instanceof Double ? 'd' :
6884 value instanceof Float ? 'f' :
6885 value instanceof Integer ? 'i' :
6886 value instanceof Long ? 'l' :
6887 value instanceof Short ? 's' :
6888 '\0';
6889
6890 if (entryType != '\0') {
6891 uri.append(entryType);
6892 uri.append('.');
6893 uri.append(Uri.encode(key));
6894 uri.append('=');
6895 uri.append(Uri.encode(value.toString()));
6896 uri.append(';');
6897 }
6898 }
6899 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006900 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006901
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006902 public int describeContents() {
6903 return (mExtras != null) ? mExtras.describeContents() : 0;
6904 }
6905
6906 public void writeToParcel(Parcel out, int flags) {
6907 out.writeString(mAction);
6908 Uri.writeToParcel(out, mData);
6909 out.writeString(mType);
6910 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006911 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006912 ComponentName.writeToParcel(mComponent, out);
6913
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006914 if (mSourceBounds != null) {
6915 out.writeInt(1);
6916 mSourceBounds.writeToParcel(out, flags);
6917 } else {
6918 out.writeInt(0);
6919 }
6920
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006921 if (mCategories != null) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006922 final int N = mCategories.size();
6923 out.writeInt(N);
6924 for (int i=0; i<N; i++) {
6925 out.writeString(mCategories.valueAt(i));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006926 }
6927 } else {
6928 out.writeInt(0);
6929 }
6930
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006931 if (mSelector != null) {
6932 out.writeInt(1);
6933 mSelector.writeToParcel(out, flags);
6934 } else {
6935 out.writeInt(0);
6936 }
6937
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006938 if (mClipData != null) {
6939 out.writeInt(1);
6940 mClipData.writeToParcel(out, flags);
6941 } else {
6942 out.writeInt(0);
6943 }
6944
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006945 out.writeBundle(mExtras);
6946 }
6947
6948 public static final Parcelable.Creator<Intent> CREATOR
6949 = new Parcelable.Creator<Intent>() {
6950 public Intent createFromParcel(Parcel in) {
6951 return new Intent(in);
6952 }
6953 public Intent[] newArray(int size) {
6954 return new Intent[size];
6955 }
6956 };
6957
Dianne Hackborneb034652009-09-07 00:49:58 -07006958 /** @hide */
6959 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006960 readFromParcel(in);
6961 }
6962
6963 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006964 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006965 mData = Uri.CREATOR.createFromParcel(in);
6966 mType = in.readString();
6967 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006968 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006969 mComponent = ComponentName.readFromParcel(in);
6970
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006971 if (in.readInt() != 0) {
6972 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6973 }
6974
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006975 int N = in.readInt();
6976 if (N > 0) {
Dianne Hackbornadd005c2013-07-17 18:43:12 -07006977 mCategories = new ArraySet<String>();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006978 int i;
6979 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006980 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006981 }
6982 } else {
6983 mCategories = null;
6984 }
6985
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006986 if (in.readInt() != 0) {
6987 mSelector = new Intent(in);
6988 }
6989
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006990 if (in.readInt() != 0) {
6991 mClipData = new ClipData(in);
6992 }
6993
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006994 mExtras = in.readBundle();
6995 }
6996
6997 /**
6998 * Parses the "intent" element (and its children) from XML and instantiates
6999 * an Intent object. The given XML parser should be located at the tag
7000 * where parsing should start (often named "intent"), from which the
7001 * basic action, data, type, and package and class name will be
7002 * retrieved. The function will then parse in to any child elements,
7003 * looking for <category android:name="xxx"> tags to add categories and
7004 * <extra android:name="xxx" android:value="yyy"> to attach extra data
7005 * to the intent.
7006 *
7007 * @param resources The Resources to use when inflating resources.
7008 * @param parser The XML parser pointing at an "intent" tag.
7009 * @param attrs The AttributeSet interface for retrieving extended
7010 * attribute data at the current <var>parser</var> location.
7011 * @return An Intent object matching the XML data.
7012 * @throws XmlPullParserException If there was an XML parsing error.
7013 * @throws IOException If there was an I/O error.
7014 */
7015 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
7016 throws XmlPullParserException, IOException {
7017 Intent intent = new Intent();
7018
7019 TypedArray sa = resources.obtainAttributes(attrs,
7020 com.android.internal.R.styleable.Intent);
7021
7022 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
7023
7024 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
7025 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
7026 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
7027
7028 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
7029 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
7030 if (packageName != null && className != null) {
7031 intent.setComponent(new ComponentName(packageName, className));
7032 }
7033
7034 sa.recycle();
7035
7036 int outerDepth = parser.getDepth();
7037 int type;
7038 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
7039 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
7040 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
7041 continue;
7042 }
7043
7044 String nodeName = parser.getName();
7045 if (nodeName.equals("category")) {
7046 sa = resources.obtainAttributes(attrs,
7047 com.android.internal.R.styleable.IntentCategory);
7048 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
7049 sa.recycle();
7050
7051 if (cat != null) {
7052 intent.addCategory(cat);
7053 }
7054 XmlUtils.skipCurrentTag(parser);
7055
7056 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08007057 if (intent.mExtras == null) {
7058 intent.mExtras = new Bundle();
7059 }
7060 resources.parseBundleExtra("extra", attrs, intent.mExtras);
7061 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007062
7063 } else {
7064 XmlUtils.skipCurrentTag(parser);
7065 }
7066 }
7067
7068 return intent;
7069 }
Nick Pellyccae4122012-01-09 14:12:58 -08007070
7071 /**
7072 * Normalize a MIME data type.
7073 *
7074 * <p>A normalized MIME type has white-space trimmed,
7075 * content-type parameters removed, and is lower-case.
7076 * This aligns the type with Android best practices for
7077 * intent filtering.
7078 *
7079 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7080 * "text/x-vCard" becomes "text/x-vcard".
7081 *
7082 * <p>All MIME types received from outside Android (such as user input,
7083 * or external sources like Bluetooth, NFC, or the Internet) should
7084 * be normalized before they are used to create an Intent.
7085 *
7086 * @param type MIME data type to normalize
7087 * @return normalized MIME data type, or null if the input was null
7088 * @see {@link #setType}
7089 * @see {@link #setTypeAndNormalize}
7090 */
7091 public static String normalizeMimeType(String type) {
7092 if (type == null) {
7093 return null;
7094 }
7095
Elliott Hughescb64d432013-08-02 10:00:44 -07007096 type = type.trim().toLowerCase(Locale.ROOT);
Nick Pellyccae4122012-01-09 14:12:58 -08007097
7098 final int semicolonIndex = type.indexOf(';');
7099 if (semicolonIndex != -1) {
7100 type = type.substring(0, semicolonIndex);
7101 }
7102 return type;
7103 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007104
7105 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007106 * Prepare this {@link Intent} to leave an app process.
7107 *
7108 * @hide
7109 */
7110 public void prepareToLeaveProcess() {
7111 setAllowFds(false);
7112
7113 if (mSelector != null) {
7114 mSelector.prepareToLeaveProcess();
7115 }
7116 if (mClipData != null) {
7117 mClipData.prepareToLeaveProcess();
7118 }
7119
7120 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7121 // There are several ACTION_MEDIA_* broadcasts that send file://
7122 // Uris, so only check common actions.
7123 if (ACTION_VIEW.equals(mAction) ||
7124 ACTION_EDIT.equals(mAction) ||
7125 ACTION_ATTACH_DATA.equals(mAction)) {
7126 mData.checkFileUriExposed("Intent.getData()");
7127 }
7128 }
7129 }
7130
7131 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007132 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007133 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7134 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007135 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007136 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007137 * @hide
7138 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007139 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007140 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007141 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007142
7143 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007144 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007145
7146 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007147 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007148 try {
7149 // Inspect target intent to see if we need to migrate
7150 final Intent target = getParcelableExtra(EXTRA_INTENT);
7151 if (target != null && target.migrateExtraStreamToClipData()) {
7152 // Since we migrated in child, we need to promote ClipData
7153 // and flags to ourselves to grant.
7154 setClipData(target.getClipData());
7155 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007156 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
7157 | FLAG_PERSIST_GRANT_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007158 return true;
7159 } else {
7160 return false;
7161 }
7162 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007163 }
7164
7165 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007166 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007167 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7168 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7169 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7170 if (stream != null || text != null || htmlText != null) {
7171 final ClipData clipData = new ClipData(
7172 null, new String[] { getType() },
7173 new ClipData.Item(text, htmlText, null, stream));
7174 setClipData(clipData);
7175 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007176 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007177 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007178 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007179 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007180
7181 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007182 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007183 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7184 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7185 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7186 int num = -1;
7187 if (streams != null) {
7188 num = streams.size();
7189 }
7190 if (texts != null) {
7191 if (num >= 0 && num != texts.size()) {
7192 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007193 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007194 }
7195 num = texts.size();
7196 }
7197 if (htmlTexts != null) {
7198 if (num >= 0 && num != htmlTexts.size()) {
7199 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007200 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007201 }
7202 num = htmlTexts.size();
7203 }
7204 if (num > 0) {
7205 final ClipData clipData = new ClipData(
7206 null, new String[] { getType() },
7207 makeClipItem(streams, texts, htmlTexts, 0));
7208
7209 for (int i = 1; i < num; i++) {
7210 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7211 }
7212
7213 setClipData(clipData);
7214 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007215 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007216 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007217 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007218 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007219 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007220
7221 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007222 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007223
7224 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7225 ArrayList<String> htmlTexts, int which) {
7226 Uri uri = streams != null ? streams.get(which) : null;
7227 CharSequence text = texts != null ? texts.get(which) : null;
7228 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7229 return new ClipData.Item(text, htmlText, null, uri);
7230 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007231}