blob: 23c56fb0bea5e706ddcf287b570f91c69c3cf8ef [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
Jeff Sharkeya14acd22013-04-02 18:27:45 -070035import android.os.StrictMode;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070036import android.util.AttributeSet;
37import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080038
39import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070040
41import java.io.IOException;
42import java.io.Serializable;
43import java.net.URISyntaxException;
44import java.util.ArrayList;
45import java.util.HashSet;
46import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080047import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070048import java.util.Set;
49
50/**
51 * An intent is an abstract description of an operation to be performed. It
52 * can be used with {@link Context#startActivity(Intent) startActivity} to
53 * launch an {@link android.app.Activity},
54 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
55 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
56 * and {@link android.content.Context#startService} or
57 * {@link android.content.Context#bindService} to communicate with a
58 * background {@link android.app.Service}.
59 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070060 * <p>An Intent provides a facility for performing late runtime binding between the code in
61 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070062 * can be thought of as the glue between activities. It is basically a passive data structure
63 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070064 *
65 * <div class="special reference">
66 * <h3>Developer Guides</h3>
67 * <p>For information about how to create and resolve intents, read the
68 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
69 * developer guide.</p>
70 * </div>
71 *
72 * <a name="IntentStructure"></a>
73 * <h3>Intent Structure</h3>
74 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070075 *
76 * <ul>
77 * <li> <p><b>action</b> -- The general action to be performed, such as
78 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
79 * etc.</p>
80 * </li>
81 * <li> <p><b>data</b> -- The data to operate on, such as a person record
82 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
83 * </li>
84 * </ul>
85 *
86 *
87 * <p>Some examples of action/data pairs are:</p>
88 *
89 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070090 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070091 * information about the person whose identifier is "1".</p>
92 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070093 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070094 * the phone dialer with the person filled in.</p>
95 * </li>
96 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
97 * the phone dialer with the given number filled in. Note how the
98 * VIEW action does what what is considered the most reasonable thing for
99 * a particular URI.</p>
100 * </li>
101 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
102 * the phone dialer with the given number filled in.</p>
103 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700104 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700105 * information about the person whose identifier is "1".</p>
106 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700107 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700108 * a list of people, which the user can browse through. This example is a
109 * typical top-level entry into the Contacts application, showing you the
110 * list of people. Selecting a particular person to view would result in a
111 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
112 * being used to start an activity to display that person.</p>
113 * </li>
114 * </ul>
115 *
116 * <p>In addition to these primary attributes, there are a number of secondary
117 * attributes that you can also include with an intent:</p>
118 *
119 * <ul>
120 * <li> <p><b>category</b> -- Gives additional information about the action
121 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
122 * appear in the Launcher as a top-level application, while
123 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
124 * of alternative actions the user can perform on a piece of data.</p>
125 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
126 * intent data. Normally the type is inferred from the data itself.
127 * By setting this attribute, you disable that evaluation and force
128 * an explicit type.</p>
129 * <li> <p><b>component</b> -- Specifies an explicit name of a component
130 * class to use for the intent. Normally this is determined by looking
131 * at the other information in the intent (the action, data/type, and
132 * categories) and matching that with a component that can handle it.
133 * If this attribute is set then none of the evaluation is performed,
134 * and this component is used exactly as is. By specifying this attribute,
135 * all of the other Intent attributes become optional.</p>
136 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
137 * This can be used to provide extended information to the component.
138 * For example, if we have a action to send an e-mail message, we could
139 * also include extra pieces of data here to supply a subject, body,
140 * etc.</p>
141 * </ul>
142 *
143 * <p>Here are some examples of other operations you can specify as intents
144 * using these additional parameters:</p>
145 *
146 * <ul>
147 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
148 * Launch the home screen.</p>
149 * </li>
150 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
151 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
152 * vnd.android.cursor.item/phone}</i></b>
153 * -- Display the list of people's phone numbers, allowing the user to
154 * browse through them and pick one and return it to the parent activity.</p>
155 * </li>
156 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
157 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
158 * -- Display all pickers for data that can be opened with
159 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
160 * allowing the user to pick one of them and then some data inside of it
161 * and returning the resulting URI to the caller. This can be used,
162 * for example, in an e-mail application to allow the user to pick some
163 * data to include as an attachment.</p>
164 * </li>
165 * </ul>
166 *
167 * <p>There are a variety of standard Intent action and category constants
168 * defined in the Intent class, but applications can also define their own.
169 * These strings use java style scoping, to ensure they are unique -- for
170 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700171 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700172 *
173 * <p>Put together, the set of actions, data types, categories, and extra data
174 * defines a language for the system allowing for the expression of phrases
175 * such as "call john smith's cell". As applications are added to the system,
176 * they can extend this language by adding new actions, types, and categories, or
177 * they can modify the behavior of existing phrases by supplying their own
178 * activities that handle them.</p>
179 *
180 * <a name="IntentResolution"></a>
181 * <h3>Intent Resolution</h3>
182 *
183 * <p>There are two primary forms of intents you will use.
184 *
185 * <ul>
186 * <li> <p><b>Explicit Intents</b> have specified a component (via
187 * {@link #setComponent} or {@link #setClass}), which provides the exact
188 * class to be run. Often these will not include any other information,
189 * simply being a way for an application to launch various internal
190 * activities it has as the user interacts with the application.
191 *
192 * <li> <p><b>Implicit Intents</b> have not specified a component;
193 * instead, they must include enough information for the system to
194 * determine which of the available components is best to run for that
195 * intent.
196 * </ul>
197 *
198 * <p>When using implicit intents, given such an arbitrary intent we need to
199 * know what to do with it. This is handled by the process of <em>Intent
200 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
201 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
202 * more activities/receivers) that can handle it.</p>
203 *
204 * <p>The intent resolution mechanism basically revolves around matching an
205 * Intent against all of the &lt;intent-filter&gt; descriptions in the
206 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
207 * objects explicitly registered with {@link Context#registerReceiver}.) More
208 * details on this can be found in the documentation on the {@link
209 * IntentFilter} class.</p>
210 *
211 * <p>There are three pieces of information in the Intent that are used for
212 * resolution: the action, type, and category. Using this information, a query
213 * is done on the {@link PackageManager} for a component that can handle the
214 * intent. The appropriate component is determined based on the intent
215 * information supplied in the <code>AndroidManifest.xml</code> file as
216 * follows:</p>
217 *
218 * <ul>
219 * <li> <p>The <b>action</b>, if given, must be listed by the component as
220 * one it handles.</p>
221 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
222 * already supplied in the Intent. Like the action, if a type is
223 * included in the intent (either explicitly or implicitly in its
224 * data), then this must be listed by the component as one it handles.</p>
225 * <li> For data that is not a <code>content:</code> URI and where no explicit
226 * type is included in the Intent, instead the <b>scheme</b> of the
227 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
228 * considered. Again like the action, if we are matching a scheme it
229 * must be listed by the component as one it can handle.
230 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
231 * by the activity as categories it handles. That is, if you include
232 * the categories {@link #CATEGORY_LAUNCHER} and
233 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
234 * with an intent that lists <em>both</em> of those categories.
235 * Activities will very often need to support the
236 * {@link #CATEGORY_DEFAULT} so that they can be found by
237 * {@link Context#startActivity Context.startActivity()}.</p>
238 * </ul>
239 *
240 * <p>For example, consider the Note Pad sample application that
241 * allows user to browse through a list of notes data and view details about
242 * individual items. Text in italics indicate places were you would replace a
243 * name with one specific to your own package.</p>
244 *
245 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
246 * package="<i>com.android.notepad</i>"&gt;
247 * &lt;application android:icon="@drawable/app_notes"
248 * android:label="@string/app_name"&gt;
249 *
250 * &lt;provider class=".NotePadProvider"
251 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
252 *
253 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
254 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700255 * &lt;action android:name="android.intent.action.MAIN" /&gt;
256 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700257 * &lt;/intent-filter&gt;
258 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700259 * &lt;action android:name="android.intent.action.VIEW" /&gt;
260 * &lt;action android:name="android.intent.action.EDIT" /&gt;
261 * &lt;action android:name="android.intent.action.PICK" /&gt;
262 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
263 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700264 * &lt;/intent-filter&gt;
265 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700266 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
267 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
268 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700269 * &lt;/intent-filter&gt;
270 * &lt;/activity&gt;
271 *
272 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
273 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700274 * &lt;action android:name="android.intent.action.VIEW" /&gt;
275 * &lt;action android:name="android.intent.action.EDIT" /&gt;
276 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
277 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700278 * &lt;/intent-filter&gt;
279 *
280 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700281 * &lt;action android:name="android.intent.action.INSERT" /&gt;
282 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
283 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700284 * &lt;/intent-filter&gt;
285 *
286 * &lt;/activity&gt;
287 *
288 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
289 * android:theme="@android:style/Theme.Dialog"&gt;
290 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700291 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
292 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
293 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
294 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
295 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700296 * &lt;/intent-filter&gt;
297 * &lt;/activity&gt;
298 *
299 * &lt;/application&gt;
300 * &lt;/manifest&gt;</pre>
301 *
302 * <p>The first activity,
303 * <code>com.android.notepad.NotesList</code>, serves as our main
304 * entry into the app. It can do three things as described by its three intent
305 * templates:
306 * <ol>
307 * <li><pre>
308 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700309 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
310 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700311 * &lt;/intent-filter&gt;</pre>
312 * <p>This provides a top-level entry into the NotePad application: the standard
313 * MAIN action is a main entry point (not requiring any other information in
314 * the Intent), and the LAUNCHER category says that this entry point should be
315 * listed in the application launcher.</p>
316 * <li><pre>
317 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700318 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
319 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
320 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
321 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
322 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700323 * &lt;/intent-filter&gt;</pre>
324 * <p>This declares the things that the activity can do on a directory of
325 * notes. The type being supported is given with the &lt;type&gt; tag, where
326 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
327 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
328 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
329 * The activity allows the user to view or edit the directory of data (via
330 * the VIEW and EDIT actions), or to pick a particular note and return it
331 * to the caller (via the PICK action). Note also the DEFAULT category
332 * supplied here: this is <em>required</em> for the
333 * {@link Context#startActivity Context.startActivity} method to resolve your
334 * activity when its component name is not explicitly specified.</p>
335 * <li><pre>
336 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700337 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
338 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
339 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700340 * &lt;/intent-filter&gt;</pre>
341 * <p>This filter describes the ability return to the caller a note selected by
342 * the user without needing to know where it came from. The data type
343 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
344 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
345 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
346 * The GET_CONTENT action is similar to the PICK action, where the activity
347 * will return to its caller a piece of data selected by the user. Here,
348 * however, the caller specifies the type of data they desire instead of
349 * the type of data the user will be picking from.</p>
350 * </ol>
351 *
352 * <p>Given these capabilities, the following intents will resolve to the
353 * NotesList activity:</p>
354 *
355 * <ul>
356 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
357 * activities that can be used as top-level entry points into an
358 * application.</p>
359 * <li> <p><b>{ action=android.app.action.MAIN,
360 * category=android.app.category.LAUNCHER }</b> is the actual intent
361 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700362 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700363 * data=content://com.google.provider.NotePad/notes }</b>
364 * displays a list of all the notes under
365 * "content://com.google.provider.NotePad/notes", which
366 * the user can browse through and see the details on.</p>
367 * <li> <p><b>{ action=android.app.action.PICK
368 * data=content://com.google.provider.NotePad/notes }</b>
369 * provides a list of the notes under
370 * "content://com.google.provider.NotePad/notes", from which
371 * the user can pick a note whose data URL is returned back to the caller.</p>
372 * <li> <p><b>{ action=android.app.action.GET_CONTENT
373 * type=vnd.android.cursor.item/vnd.google.note }</b>
374 * is similar to the pick action, but allows the caller to specify the
375 * kind of data they want back so that the system can find the appropriate
376 * activity to pick something of that data type.</p>
377 * </ul>
378 *
379 * <p>The second activity,
380 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
381 * note entry and allows them to edit it. It can do two things as described
382 * by its two intent templates:
383 * <ol>
384 * <li><pre>
385 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700386 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
387 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
388 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
389 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700390 * &lt;/intent-filter&gt;</pre>
391 * <p>The first, primary, purpose of this activity is to let the user interact
392 * with a single note, as decribed by the MIME type
393 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
394 * either VIEW a note or allow the user to EDIT it. Again we support the
395 * DEFAULT category to allow the activity to be launched without explicitly
396 * specifying its component.</p>
397 * <li><pre>
398 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700399 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
400 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
401 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700402 * &lt;/intent-filter&gt;</pre>
403 * <p>The secondary use of this activity is to insert a new note entry into
404 * an existing directory of notes. This is used when the user creates a new
405 * note: the INSERT action is executed on the directory of notes, causing
406 * this activity to run and have the user create the new note data which
407 * it then adds to the content provider.</p>
408 * </ol>
409 *
410 * <p>Given these capabilities, the following intents will resolve to the
411 * NoteEditor activity:</p>
412 *
413 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700414 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700415 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
416 * shows the user the content of note <var>{ID}</var>.</p>
417 * <li> <p><b>{ action=android.app.action.EDIT
418 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
419 * allows the user to edit the content of note <var>{ID}</var>.</p>
420 * <li> <p><b>{ action=android.app.action.INSERT
421 * data=content://com.google.provider.NotePad/notes }</b>
422 * creates a new, empty note in the notes list at
423 * "content://com.google.provider.NotePad/notes"
424 * and allows the user to edit it. If they keep their changes, the URI
425 * of the newly created note is returned to the caller.</p>
426 * </ul>
427 *
428 * <p>The last activity,
429 * <code>com.android.notepad.TitleEditor</code>, allows the user to
430 * edit the title of a note. This could be implemented as a class that the
431 * application directly invokes (by explicitly setting its component in
432 * the Intent), but here we show a way you can publish alternative
433 * operations on existing data:</p>
434 *
435 * <pre>
436 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700437 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
440 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
441 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700442 * &lt;/intent-filter&gt;</pre>
443 *
444 * <p>In the single intent template here, we
445 * have created our own private action called
446 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
447 * edit the title of a note. It must be invoked on a specific note
448 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
449 * view and edit actions, but here displays and edits the title contained
450 * in the note data.
451 *
452 * <p>In addition to supporting the default category as usual, our title editor
453 * also supports two other standard categories: ALTERNATIVE and
454 * SELECTED_ALTERNATIVE. Implementing
455 * these categories allows others to find the special action it provides
456 * without directly knowing about it, through the
457 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
458 * more often to build dynamic menu items with
459 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
460 * template here was also supply an explicit name for the template
461 * (via <code>android:label="@string/resolve_title"</code>) to better control
462 * what the user sees when presented with this activity as an alternative
463 * action to the data they are viewing.
464 *
465 * <p>Given these capabilities, the following intent will resolve to the
466 * TitleEditor activity:</p>
467 *
468 * <ul>
469 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
470 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
471 * displays and allows the user to edit the title associated
472 * with note <var>{ID}</var>.</p>
473 * </ul>
474 *
475 * <h3>Standard Activity Actions</h3>
476 *
477 * <p>These are the current standard actions that Intent defines for launching
478 * activities (usually through {@link Context#startActivity}. The most
479 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
480 * {@link #ACTION_EDIT}.
481 *
482 * <ul>
483 * <li> {@link #ACTION_MAIN}
484 * <li> {@link #ACTION_VIEW}
485 * <li> {@link #ACTION_ATTACH_DATA}
486 * <li> {@link #ACTION_EDIT}
487 * <li> {@link #ACTION_PICK}
488 * <li> {@link #ACTION_CHOOSER}
489 * <li> {@link #ACTION_GET_CONTENT}
490 * <li> {@link #ACTION_DIAL}
491 * <li> {@link #ACTION_CALL}
492 * <li> {@link #ACTION_SEND}
493 * <li> {@link #ACTION_SENDTO}
494 * <li> {@link #ACTION_ANSWER}
495 * <li> {@link #ACTION_INSERT}
496 * <li> {@link #ACTION_DELETE}
497 * <li> {@link #ACTION_RUN}
498 * <li> {@link #ACTION_SYNC}
499 * <li> {@link #ACTION_PICK_ACTIVITY}
500 * <li> {@link #ACTION_SEARCH}
501 * <li> {@link #ACTION_WEB_SEARCH}
502 * <li> {@link #ACTION_FACTORY_TEST}
503 * </ul>
504 *
505 * <h3>Standard Broadcast Actions</h3>
506 *
507 * <p>These are the current standard actions that Intent defines for receiving
508 * broadcasts (usually through {@link Context#registerReceiver} or a
509 * &lt;receiver&gt; tag in a manifest).
510 *
511 * <ul>
512 * <li> {@link #ACTION_TIME_TICK}
513 * <li> {@link #ACTION_TIME_CHANGED}
514 * <li> {@link #ACTION_TIMEZONE_CHANGED}
515 * <li> {@link #ACTION_BOOT_COMPLETED}
516 * <li> {@link #ACTION_PACKAGE_ADDED}
517 * <li> {@link #ACTION_PACKAGE_CHANGED}
518 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800519 * <li> {@link #ACTION_PACKAGE_RESTARTED}
520 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700521 * <li> {@link #ACTION_UID_REMOVED}
522 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700523 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700524 * <li> {@link #ACTION_POWER_DISCONNECTED}
525 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700526 * </ul>
527 *
528 * <h3>Standard Categories</h3>
529 *
530 * <p>These are the current standard categories that can be used to further
531 * clarify an Intent via {@link #addCategory}.
532 *
533 * <ul>
534 * <li> {@link #CATEGORY_DEFAULT}
535 * <li> {@link #CATEGORY_BROWSABLE}
536 * <li> {@link #CATEGORY_TAB}
537 * <li> {@link #CATEGORY_ALTERNATIVE}
538 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
539 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800540 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700541 * <li> {@link #CATEGORY_HOME}
542 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700543 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400544 * <li> {@link #CATEGORY_CAR_DOCK}
545 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500546 * <li> {@link #CATEGORY_LE_DESK_DOCK}
547 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200548 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700549 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700550 * </ul>
551 *
552 * <h3>Standard Extra Data</h3>
553 *
554 * <p>These are the current standard fields that can be used as extra data via
555 * {@link #putExtra}.
556 *
557 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800558 * <li> {@link #EXTRA_ALARM_COUNT}
559 * <li> {@link #EXTRA_BCC}
560 * <li> {@link #EXTRA_CC}
561 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
562 * <li> {@link #EXTRA_DATA_REMOVED}
563 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500564 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
565 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800566 * <li> {@link #EXTRA_DOCK_STATE_CAR}
567 * <li> {@link #EXTRA_DOCK_STATE_DESK}
568 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
569 * <li> {@link #EXTRA_DONT_KILL_APP}
570 * <li> {@link #EXTRA_EMAIL}
571 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700572 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800573 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700574 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800575 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700576 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800577 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
578 * <li> {@link #EXTRA_REPLACING}
579 * <li> {@link #EXTRA_SHORTCUT_ICON}
580 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
581 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700582 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800583 * <li> {@link #EXTRA_SHORTCUT_NAME}
584 * <li> {@link #EXTRA_SUBJECT}
585 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700586 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800587 * <li> {@link #EXTRA_TITLE}
588 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700589 * </ul>
590 *
591 * <h3>Flags</h3>
592 *
593 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800594 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
595 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700596 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800597public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700598 // ---------------------------------------------------------------------
599 // ---------------------------------------------------------------------
600 // Standard intent activity actions (see action variable).
601
602 /**
603 * Activity Action: Start as a main entry point, does not expect to
604 * receive data.
605 * <p>Input: nothing
606 * <p>Output: nothing
607 */
608 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
609 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800610
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700611 /**
612 * Activity Action: Display the data to the user. This is the most common
613 * action performed on data -- it is the generic action you can use on
614 * a piece of data to get the most reasonable thing to occur. For example,
615 * when used on a contacts entry it will view the entry; when used on a
616 * mailto: URI it will bring up a compose window filled with the information
617 * supplied by the URI; when used with a tel: URI it will invoke the
618 * dialer.
619 * <p>Input: {@link #getData} is URI from which to retrieve data.
620 * <p>Output: nothing.
621 */
622 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
623 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800624
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700625 /**
626 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
627 * performed on a piece of data.
628 */
629 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800630
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700631 /**
632 * Used to indicate that some piece of data should be attached to some other
633 * place. For example, image data could be attached to a contact. It is up
634 * to the recipient to decide where the data should be attached; the intent
635 * does not specify the ultimate destination.
636 * <p>Input: {@link #getData} is URI of data to be attached.
637 * <p>Output: nothing.
638 */
639 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
640 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800641
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700642 /**
643 * Activity Action: Provide explicit editable access to the given data.
644 * <p>Input: {@link #getData} is URI of data to be edited.
645 * <p>Output: nothing.
646 */
647 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
648 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800649
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700650 /**
651 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
652 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
653 * The extras can contain type specific data to pass through to the editing/creating
654 * activity.
655 * <p>Output: The URI of the item that was picked. This must be a content:
656 * URI so that any receiver can access it.
657 */
658 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
659 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800660
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700661 /**
662 * Activity Action: Pick an item from the data, returning what was selected.
663 * <p>Input: {@link #getData} is URI containing a directory of data
664 * (vnd.android.cursor.dir/*) from which to pick an item.
665 * <p>Output: The URI of the item that was picked.
666 */
667 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
668 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800669
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700670 /**
671 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800672 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700673 * <p>Output: An Intent representing the shortcut. The intent must contain three
674 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
675 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800676 * (value: ShortcutIconResource).</p>
677 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700678 * @see #EXTRA_SHORTCUT_INTENT
679 * @see #EXTRA_SHORTCUT_NAME
680 * @see #EXTRA_SHORTCUT_ICON
681 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
682 * @see android.content.Intent.ShortcutIconResource
683 */
684 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
685 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
686
687 /**
688 * The name of the extra used to define the Intent of a shortcut.
689 *
690 * @see #ACTION_CREATE_SHORTCUT
691 */
692 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
693 /**
694 * The name of the extra used to define the name of a shortcut.
695 *
696 * @see #ACTION_CREATE_SHORTCUT
697 */
698 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
699 /**
700 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
701 *
702 * @see #ACTION_CREATE_SHORTCUT
703 */
704 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
705 /**
706 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
707 *
708 * @see #ACTION_CREATE_SHORTCUT
709 * @see android.content.Intent.ShortcutIconResource
710 */
711 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
712 "android.intent.extra.shortcut.ICON_RESOURCE";
713
714 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800715 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700716 *
717 * @see Intent#ACTION_CREATE_SHORTCUT
718 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800719 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
720 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700721 */
722 public static class ShortcutIconResource implements Parcelable {
723 /**
724 * The package name of the application containing the icon.
725 */
726 public String packageName;
727
728 /**
729 * The resource name of the icon, including package, name and type.
730 */
731 public String resourceName;
732
733 /**
734 * Creates a new ShortcutIconResource for the specified context and resource
735 * identifier.
736 *
737 * @param context The context of the application.
738 * @param resourceId The resource idenfitier for the icon.
739 * @return A new ShortcutIconResource with the specified's context package name
740 * and icon resource idenfitier.
741 */
742 public static ShortcutIconResource fromContext(Context context, int resourceId) {
743 ShortcutIconResource icon = new ShortcutIconResource();
744 icon.packageName = context.getPackageName();
745 icon.resourceName = context.getResources().getResourceName(resourceId);
746 return icon;
747 }
748
749 /**
750 * Used to read a ShortcutIconResource from a Parcel.
751 */
752 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
753 new Parcelable.Creator<ShortcutIconResource>() {
754
755 public ShortcutIconResource createFromParcel(Parcel source) {
756 ShortcutIconResource icon = new ShortcutIconResource();
757 icon.packageName = source.readString();
758 icon.resourceName = source.readString();
759 return icon;
760 }
761
762 public ShortcutIconResource[] newArray(int size) {
763 return new ShortcutIconResource[size];
764 }
765 };
766
767 /**
768 * No special parcel contents.
769 */
770 public int describeContents() {
771 return 0;
772 }
773
774 public void writeToParcel(Parcel dest, int flags) {
775 dest.writeString(packageName);
776 dest.writeString(resourceName);
777 }
778
779 @Override
780 public String toString() {
781 return resourceName;
782 }
783 }
784
785 /**
786 * Activity Action: Display an activity chooser, allowing the user to pick
787 * what they want to before proceeding. This can be used as an alternative
788 * to the standard activity picker that is displayed by the system when
789 * you try to start an activity with multiple possible matches, with these
790 * differences in behavior:
791 * <ul>
792 * <li>You can specify the title that will appear in the activity chooser.
793 * <li>The user does not have the option to make one of the matching
794 * activities a preferred activity, and all possible activities will
795 * always be shown even if one of them is currently marked as the
796 * preferred activity.
797 * </ul>
798 * <p>
799 * This action should be used when the user will naturally expect to
800 * select an activity in order to proceed. An example if when not to use
801 * it is when the user clicks on a "mailto:" link. They would naturally
802 * expect to go directly to their mail app, so startActivity() should be
803 * called directly: it will
804 * either launch the current preferred app, or put up a dialog allowing the
805 * user to pick an app to use and optionally marking that as preferred.
806 * <p>
807 * In contrast, if the user is selecting a menu item to send a picture
808 * they are viewing to someone else, there are many different things they
809 * may want to do at this point: send it through e-mail, upload it to a
810 * web service, etc. In this case the CHOOSER action should be used, to
811 * always present to the user a list of the things they can do, with a
812 * nice title given by the caller such as "Send this photo with:".
813 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700814 * If you need to grant URI permissions through a chooser, you must specify
815 * the permissions to be granted on the ACTION_CHOOSER Intent
816 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
817 * {@link #setClipData} to specify the URIs to be granted as well as
818 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
819 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
820 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700821 * As a convenience, an Intent of this form can be created with the
822 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700824 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700825 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
826 * and can optionally have a {@link #EXTRA_TITLE} field containing the
827 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700828 * <p>
829 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700830 */
831 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
832 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
833
834 /**
835 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
836 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700837 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
838 * target intent, also optionally supplying a title. If the target
839 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
840 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
841 * set in the returned chooser intent, with its ClipData set appropriately:
842 * either a direct reflection of {@link #getClipData()} if that is non-null,
843 * or a new ClipData build from {@link #getData()}.
844 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700845 * @param target The Intent that the user will be selecting an activity
846 * to perform.
847 * @param title Optional title that will be displayed in the chooser.
848 * @return Return a new Intent object that you can hand to
849 * {@link Context#startActivity(Intent) Context.startActivity()} and
850 * related methods.
851 */
852 public static Intent createChooser(Intent target, CharSequence title) {
853 Intent intent = new Intent(ACTION_CHOOSER);
854 intent.putExtra(EXTRA_INTENT, target);
855 if (title != null) {
856 intent.putExtra(EXTRA_TITLE, title);
857 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700858
859 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700860 int permFlags = target.getFlags()
861 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
862 if (permFlags != 0) {
863 ClipData targetClipData = target.getClipData();
864 if (targetClipData == null && target.getData() != null) {
865 ClipData.Item item = new ClipData.Item(target.getData());
866 String[] mimeTypes;
867 if (target.getType() != null) {
868 mimeTypes = new String[] { target.getType() };
869 } else {
870 mimeTypes = new String[] { };
871 }
872 targetClipData = new ClipData(null, mimeTypes, item);
873 }
874 if (targetClipData != null) {
875 intent.setClipData(targetClipData);
876 intent.addFlags(permFlags);
877 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700878 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700879
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700880 return intent;
881 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700882
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700883 /**
884 * Activity Action: Allow the user to select a particular kind of data and
885 * return it. This is different than {@link #ACTION_PICK} in that here we
886 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800887 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700888 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900889 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700890 * etc.
891 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900892 * There are two main ways to use this action: if you want a specific kind
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700893 * of data, such as a person contact, you set the MIME type to the kind of
894 * data you want and launch it with {@link Context#startActivity(Intent)}.
895 * The system will then launch the best application to select that kind
896 * of data for you.
897 * <p>
898 * You may also be interested in any of a set of types of content the user
899 * can pick. For example, an e-mail application that wants to allow the
900 * user to add an attachment to an e-mail message can use this action to
901 * bring up a list of all of the types of content the user can attach.
902 * <p>
903 * In this case, you should wrap the GET_CONTENT intent with a chooser
904 * (through {@link #createChooser}), which will give the proper interface
905 * for the user to pick how to send your data and allow you to specify
906 * a prompt indicating what they are doing. You will usually specify a
907 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
908 * broad range of content types the user can select from.
909 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900910 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700911 * only pick from data that can be represented as a stream. This is
912 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
913 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800914 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900915 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800916 * is locally available on the device. For example, if this extra is set
917 * to true then an image picker should not show any pictures that are available
918 * from a remote server but not already on the local device (thus requiring
919 * they be downloaded when opened).
920 * <p>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800921 * If the caller can handle multiple returned items (the user performing
922 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
923 * to indicate this.
924 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700925 * Input: {@link #getType} is the desired MIME type to retrieve. Note
926 * that no URI is supplied in the intent, as there are no constraints on
927 * where the returned data originally comes from. You may also include the
928 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800929 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800930 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
931 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700932 * <p>
933 * Output: The URI of the item that was picked. This must be a content:
934 * URI so that any receiver can access it.
935 */
936 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
937 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
938 /**
939 * Activity Action: Dial a number as specified by the data. This shows a
940 * UI with the number being dialed, allowing the user to explicitly
941 * initiate the call.
942 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
943 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
944 * number.
945 * <p>Output: nothing.
946 */
947 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
948 public static final String ACTION_DIAL = "android.intent.action.DIAL";
949 /**
950 * Activity Action: Perform a call to someone specified by the data.
951 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
952 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
953 * number.
954 * <p>Output: nothing.
955 *
956 * <p>Note: there will be restrictions on which applications can initiate a
957 * call; most applications should use the {@link #ACTION_DIAL}.
958 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
959 * numbers. Applications can <strong>dial</strong> emergency numbers using
960 * {@link #ACTION_DIAL}, however.
961 */
962 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
963 public static final String ACTION_CALL = "android.intent.action.CALL";
964 /**
965 * Activity Action: Perform a call to an emergency number specified by the
966 * data.
967 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
968 * tel: URI of an explicit phone number.
969 * <p>Output: nothing.
970 * @hide
971 */
972 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
973 /**
974 * Activity action: Perform a call to any number (emergency or not)
975 * specified by the data.
976 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
977 * tel: URI of an explicit phone number.
978 * <p>Output: nothing.
979 * @hide
980 */
981 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
982 /**
983 * Activity Action: Send a message to someone specified by the data.
984 * <p>Input: {@link #getData} is URI describing the target.
985 * <p>Output: nothing.
986 */
987 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
988 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
989 /**
990 * Activity Action: Deliver some data to someone else. Who the data is
991 * being delivered to is not specified; it is up to the receiver of this
992 * action to ask the user where the data should be sent.
993 * <p>
994 * When launching a SEND intent, you should usually wrap it in a chooser
995 * (through {@link #createChooser}), which will give the proper interface
996 * for the user to pick how to send your data and allow you to specify
997 * a prompt indicating what they are doing.
998 * <p>
999 * Input: {@link #getType} is the MIME type of the data being sent.
1000 * get*Extra can have either a {@link #EXTRA_TEXT}
1001 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1002 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1003 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1004 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001005 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1006 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1007 * your text with HTML formatting.
1008 * <p>
1009 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1010 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1011 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1012 * content: URIs and other advanced features of {@link ClipData}. If
1013 * using this approach, you still must supply the same data through the
1014 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1015 * for compatibility with old applications. If you don't set a ClipData,
1016 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001017 * <p>
1018 * Optional standard extras, which may be interpreted by some recipients as
1019 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1020 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1021 * <p>
1022 * Output: nothing.
1023 */
1024 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1025 public static final String ACTION_SEND = "android.intent.action.SEND";
1026 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001027 * Activity Action: Deliver multiple data to someone else.
1028 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001029 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * <p>
1031 * Input: {@link #getType} is the MIME type of the data being sent.
1032 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001033 * #EXTRA_STREAM} field, containing the data to be sent. If using
1034 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1035 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001036 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001037 * Multiple types are supported, and receivers should handle mixed types
1038 * whenever possible. The right way for the receiver to check them is to
1039 * use the content resolver on each URI. The intent sender should try to
1040 * put the most concrete mime type in the intent type, but it can fall
1041 * back to {@literal <type>/*} or {@literal *}/* as needed.
1042 * <p>
1043 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1044 * be image/jpg, but if you are sending image/jpg and image/png, then the
1045 * intent's type should be image/*.
1046 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001047 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1048 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1049 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1050 * content: URIs and other advanced features of {@link ClipData}. If
1051 * using this approach, you still must supply the same data through the
1052 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1053 * for compatibility with old applications. If you don't set a ClipData,
1054 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1055 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001056 * Optional standard extras, which may be interpreted by some recipients as
1057 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1058 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1059 * <p>
1060 * Output: nothing.
1061 */
1062 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1063 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1064 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001065 * Activity Action: Handle an incoming phone call.
1066 * <p>Input: nothing.
1067 * <p>Output: nothing.
1068 */
1069 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1070 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1071 /**
1072 * Activity Action: Insert an empty item into the given container.
1073 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1074 * in which to place the data.
1075 * <p>Output: URI of the new data that was created.
1076 */
1077 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1078 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1079 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001080 * Activity Action: Create a new item in the given container, initializing it
1081 * from the current contents of the clipboard.
1082 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1083 * in which to place the data.
1084 * <p>Output: URI of the new data that was created.
1085 */
1086 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1087 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1088 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001089 * Activity Action: Delete the given data from its container.
1090 * <p>Input: {@link #getData} is URI of data to be deleted.
1091 * <p>Output: nothing.
1092 */
1093 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1094 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1095 /**
1096 * Activity Action: Run the data, whatever that means.
1097 * <p>Input: ? (Note: this is currently specific to the test harness.)
1098 * <p>Output: nothing.
1099 */
1100 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1101 public static final String ACTION_RUN = "android.intent.action.RUN";
1102 /**
1103 * Activity Action: Perform a data synchronization.
1104 * <p>Input: ?
1105 * <p>Output: ?
1106 */
1107 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1108 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1109 /**
1110 * Activity Action: Pick an activity given an intent, returning the class
1111 * selected.
1112 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1113 * used with {@link PackageManager#queryIntentActivities} to determine the
1114 * set of activities from which to pick.
1115 * <p>Output: Class name of the activity that was selected.
1116 */
1117 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1118 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1119 /**
1120 * Activity Action: Perform a search.
1121 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1122 * is the text to search for. If empty, simply
1123 * enter your search results Activity with the search UI activated.
1124 * <p>Output: nothing.
1125 */
1126 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1127 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1128 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001129 * Activity Action: Start the platform-defined tutorial
1130 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1131 * is the text to search for. If empty, simply
1132 * enter your search results Activity with the search UI activated.
1133 * <p>Output: nothing.
1134 */
1135 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1136 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1137 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001138 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001139 * <p>
1140 * Input: {@link android.app.SearchManager#QUERY
1141 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1142 * a url starts with http or https, the site will be opened. If it is plain
1143 * text, Google search will be applied.
1144 * <p>
1145 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001146 */
1147 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1148 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001149
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001150 /**
Jim Miller07994402012-05-02 14:22:27 -07001151 * Activity Action: Perform assist action.
1152 * <p>
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001153 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1154 * additional optional contextual information about where the user was when they requested
1155 * the assist.
Jim Miller07994402012-05-02 14:22:27 -07001156 * Output: nothing.
1157 */
1158 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1159 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001160
1161 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001162 * Activity Action: Perform voice assist action.
1163 * <p>
1164 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1165 * additional optional contextual information about where the user was when they requested
1166 * the voice assist.
1167 * Output: nothing.
Bjorn Bringert964e7d22013-03-12 19:35:57 +00001168 * @hide
Bjorn Bringertbc086862013-03-01 12:59:24 +00001169 */
1170 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1171 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1172
1173 /**
Bjorn Bringert964e7d22013-03-12 19:35:57 +00001174 * An optional field on {@link #ACTION_ASSIST}
Bjorn Bringertbc086862013-03-01 12:59:24 +00001175 * containing the name of the current foreground application package at the time
1176 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001177 */
1178 public static final String EXTRA_ASSIST_PACKAGE
1179 = "android.intent.extra.ASSIST_PACKAGE";
1180
1181 /**
Bjorn Bringert964e7d22013-03-12 19:35:57 +00001182 * An optional field on {@link #ACTION_ASSIST}
Bjorn Bringertbc086862013-03-01 12:59:24 +00001183 * containing additional contextual information supplied by the current
1184 * foreground app at the time of the assist request. This is a {@link Bundle} of
1185 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001186 */
1187 public static final String EXTRA_ASSIST_CONTEXT
1188 = "android.intent.extra.ASSIST_CONTEXT";
1189
Jim Miller07994402012-05-02 14:22:27 -07001190 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001191 * Activity Action: List all available applications
1192 * <p>Input: Nothing.
1193 * <p>Output: nothing.
1194 */
1195 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1196 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1197 /**
1198 * Activity Action: Show settings for choosing wallpaper
1199 * <p>Input: Nothing.
1200 * <p>Output: Nothing.
1201 */
1202 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1203 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1204
1205 /**
1206 * Activity Action: Show activity for reporting a bug.
1207 * <p>Input: Nothing.
1208 * <p>Output: Nothing.
1209 */
1210 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1211 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1212
1213 /**
1214 * Activity Action: Main entry point for factory tests. Only used when
1215 * the device is booting in factory test node. The implementing package
1216 * must be installed in the system image.
1217 * <p>Input: nothing
1218 * <p>Output: nothing
1219 */
1220 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1221
1222 /**
1223 * Activity Action: The user pressed the "call" button to go to the dialer
1224 * or other appropriate UI for placing a call.
1225 * <p>Input: Nothing.
1226 * <p>Output: Nothing.
1227 */
1228 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1229 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1230
1231 /**
1232 * Activity Action: Start Voice Command.
1233 * <p>Input: Nothing.
1234 * <p>Output: Nothing.
1235 */
1236 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1237 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001238
1239 /**
1240 * Activity Action: Start action associated with long pressing on the
1241 * search key.
1242 * <p>Input: Nothing.
1243 * <p>Output: Nothing.
1244 */
1245 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1246 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001247
Jacek Surazski86b6c532009-05-13 14:38:28 +02001248 /**
1249 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1250 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001251 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001252 * <p>Input: No data is specified. The bug report is passed in using
1253 * an {@link #EXTRA_BUG_REPORT} field.
1254 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001255 *
1256 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001257 */
1258 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1259 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001260
1261 /**
1262 * Activity Action: Show power usage information to the user.
1263 * <p>Input: Nothing.
1264 * <p>Output: Nothing.
1265 */
1266 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1267 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001268
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001269 /**
1270 * Activity Action: Setup wizard to launch after a platform update. This
1271 * activity should have a string meta-data field associated with it,
1272 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1273 * the platform for setup. The activity will be launched only if
1274 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1275 * same value.
1276 * <p>Input: Nothing.
1277 * <p>Output: Nothing.
1278 * @hide
1279 */
1280 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1281 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001282
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001283 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001284 * Activity Action: Show settings for managing network data usage of a
1285 * specific application. Applications should define an activity that offers
1286 * options to control data usage.
1287 */
1288 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1289 public static final String ACTION_MANAGE_NETWORK_USAGE =
1290 "android.intent.action.MANAGE_NETWORK_USAGE";
1291
1292 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001293 * Activity Action: Launch application installer.
1294 * <p>
1295 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001296 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1297 * you can also use "package:<package-name>" to install an application for the
1298 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001299 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1300 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1301 * <p>
1302 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1303 * succeeded.
1304 *
1305 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1306 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1307 * @see #EXTRA_RETURN_RESULT
1308 */
1309 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1310 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1311
1312 /**
1313 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1314 * package. Specifies the installer package name; this package will receive the
1315 * {@link #ACTION_APP_ERROR} intent.
1316 */
1317 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1318 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1319
1320 /**
1321 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1322 * package. Specifies that the application being installed should not be
1323 * treated as coming from an unknown source, but as coming from the app
1324 * invoking the Intent. For this to work you must start the installer with
1325 * startActivityForResult().
1326 */
1327 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1328 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1329
1330 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001331 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1332 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001333 * data field originated from.
1334 */
rich cannings706e8ba2012-08-20 13:20:14 -07001335 public static final String EXTRA_ORIGINATING_URI
1336 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001337
1338 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001339 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1340 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1341 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001342 */
1343 public static final String EXTRA_REFERRER
1344 = "android.intent.extra.REFERRER";
1345
1346 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001347 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1348 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1349 * @hide
1350 */
1351 public static final String EXTRA_ORIGINATING_UID
1352 = "android.intent.extra.ORIGINATING_UID";
1353
1354 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001355 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1356 * package. Tells the installer UI to skip the confirmation with the user
1357 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001358 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1359 * will no longer show an interstitial message about updating existing
1360 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001361 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001362 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001363 public static final String EXTRA_ALLOW_REPLACE
1364 = "android.intent.extra.ALLOW_REPLACE";
1365
1366 /**
1367 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1368 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1369 * return to the application the result code of the install/uninstall. The returned result
1370 * code will be {@link android.app.Activity#RESULT_OK} on success or
1371 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1372 */
1373 public static final String EXTRA_RETURN_RESULT
1374 = "android.intent.extra.RETURN_RESULT";
1375
1376 /**
1377 * Package manager install result code. @hide because result codes are not
1378 * yet ready to be exposed.
1379 */
1380 public static final String EXTRA_INSTALL_RESULT
1381 = "android.intent.extra.INSTALL_RESULT";
1382
1383 /**
1384 * Activity Action: Launch application uninstaller.
1385 * <p>
1386 * Input: The data must be a package: URI whose scheme specific part is
1387 * the package name of the current installed package to be uninstalled.
1388 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1389 * <p>
1390 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1391 * succeeded.
1392 */
1393 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1394 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1395
1396 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001397 * Specify whether the package should be uninstalled for all users.
1398 * @hide because these should not be part of normal application flow.
1399 */
1400 public static final String EXTRA_UNINSTALL_ALL_USERS
1401 = "android.intent.extra.UNINSTALL_ALL_USERS";
1402
1403 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001404 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1405 * describing the last run version of the platform that was setup.
1406 * @hide
1407 */
1408 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1409
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001410 // ---------------------------------------------------------------------
1411 // ---------------------------------------------------------------------
1412 // Standard intent broadcast actions (see action variable).
1413
1414 /**
1415 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001416 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001417 * <p class="note">This is a protected intent that can only be sent
1418 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001419 */
1420 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1421 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1422 /**
1423 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001424 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001425 * <p class="note">This is a protected intent that can only be sent
1426 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001427 */
1428 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1429 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001430
1431 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001432 * Broadcast Action: Sent after the system stops dreaming.
1433 *
1434 * <p class="note">This is a protected intent that can only be sent by the system.
1435 * It is only sent to registered receivers.</p>
1436 */
1437 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1438 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1439
1440 /**
1441 * Broadcast Action: Sent after the system starts dreaming.
1442 *
1443 * <p class="note">This is a protected intent that can only be sent by the system.
1444 * It is only sent to registered receivers.</p>
1445 */
1446 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1447 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1448
1449 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001450 * 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 -07001451 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001452 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001453 * <p class="note">This is a protected intent that can only be sent
1454 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001455 */
1456 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001457 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001458
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001459 /**
1460 * Broadcast Action: The current time has changed. Sent every
1461 * minute. You can <em>not</em> receive this through components declared
1462 * in manifests, only by exlicitly registering for it with
1463 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1464 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001465 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001466 * <p class="note">This is a protected intent that can only be sent
1467 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001468 */
1469 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1470 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1471 /**
1472 * Broadcast Action: The time was set.
1473 */
1474 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1475 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1476 /**
1477 * Broadcast Action: The date has changed.
1478 */
1479 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1480 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1481 /**
1482 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1483 * <ul>
1484 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1485 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001486 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001487 * <p class="note">This is a protected intent that can only be sent
1488 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001489 */
1490 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1491 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1492 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001493 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1494 * DNS entries should be tossed.
1495 * @hide
1496 */
1497 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1498 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1499 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001500 * Alarm Changed Action: This is broadcast when the AlarmClock
1501 * application's alarm is set or unset. It is used by the
1502 * AlarmClock application and the StatusBar service.
1503 * @hide
1504 */
1505 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1506 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1507 /**
1508 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1509 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1510 * @hide
1511 */
1512 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1513 public static final String ACTION_SYNC_STATE_CHANGED
1514 = "android.intent.action.SYNC_STATE_CHANGED";
1515 /**
1516 * Broadcast Action: This is broadcast once, after the system has finished
1517 * booting. It can be used to perform application-specific initialization,
1518 * such as installing alarms. You must hold the
1519 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1520 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001521 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001522 * <p class="note">This is a protected intent that can only be sent
1523 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001524 */
1525 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1526 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1527 /**
1528 * Broadcast Action: This is broadcast when a user action should request a
1529 * temporary system dialog to dismiss. Some examples of temporary system
1530 * dialogs are the notification window-shade and the recent tasks dialog.
1531 */
1532 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1533 /**
1534 * Broadcast Action: Trigger the download and eventual installation
1535 * of a package.
1536 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001537 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001538 * <p class="note">This is a protected intent that can only be sent
1539 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001540 *
1541 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001542 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001543 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001544 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1545 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1546 /**
1547 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001548 * device. The data contains the name of the package. Note that the
1549 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001550 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001551 * <ul>
1552 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1553 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1554 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1555 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001556 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001557 * <p class="note">This is a protected intent that can only be sent
1558 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001559 */
1560 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1561 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1562 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001563 * Broadcast Action: A new version of an application package has been
1564 * installed, replacing an existing version that was previously installed.
1565 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001566 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001567 * <ul>
1568 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1569 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001570 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001571 * <p class="note">This is a protected intent that can only be sent
1572 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001573 */
1574 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1575 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1576 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001577 * Broadcast Action: A new version of your application has been installed
1578 * over an existing one. This is only sent to the application that was
1579 * replaced. It does not contain any additional data; to receive it, just
1580 * use an intent filter for this action.
1581 *
1582 * <p class="note">This is a protected intent that can only be sent
1583 * by the system.
1584 */
1585 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1586 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1587 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001588 * Broadcast Action: An existing application package has been removed from
1589 * the device. The data contains the name of the package. The package
1590 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001591 * <ul>
1592 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1593 * to the package.
1594 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1595 * application -- data and code -- is being removed.
1596 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1597 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1598 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001599 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001600 * <p class="note">This is a protected intent that can only be sent
1601 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001602 */
1603 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1604 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1605 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001606 * Broadcast Action: An existing application package has been completely
1607 * removed from the device. The data contains the name of the package.
1608 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1609 * {@link #EXTRA_DATA_REMOVED} is true and
1610 * {@link #EXTRA_REPLACING} is false of that broadcast.
1611 *
1612 * <ul>
1613 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1614 * to the package.
1615 * </ul>
1616 *
1617 * <p class="note">This is a protected intent that can only be sent
1618 * by the system.
1619 */
1620 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1621 public static final String ACTION_PACKAGE_FULLY_REMOVED
1622 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1623 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001624 * Broadcast Action: An existing application package has been changed (e.g.
1625 * a component has been enabled or disabled). The data contains the name of
1626 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001627 * <ul>
1628 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001629 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001630 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001631 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1632 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001633 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001634 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001635 * <p class="note">This is a protected intent that can only be sent
1636 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001637 */
1638 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1639 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1640 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001641 * @hide
1642 * Broadcast Action: Ask system services if there is any reason to
1643 * restart the given package. The data contains the name of the
1644 * package.
1645 * <ul>
1646 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1647 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1648 * </ul>
1649 *
1650 * <p class="note">This is a protected intent that can only be sent
1651 * by the system.
1652 */
1653 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1654 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1655 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001656 * Broadcast Action: The user has restarted a package, and all of its
1657 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001658 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001659 * be removed. Note that the restarted package does <em>not</em>
1660 * receive this broadcast.
1661 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001662 * <ul>
1663 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1664 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001665 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001666 * <p class="note">This is a protected intent that can only be sent
1667 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001668 */
1669 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1670 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1671 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001672 * Broadcast Action: The user has cleared the data of a package. This should
1673 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001674 * its persistent data is erased and this broadcast sent.
1675 * Note that the cleared package does <em>not</em>
1676 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001677 * <ul>
1678 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1679 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001680 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001681 * <p class="note">This is a protected intent that can only be sent
1682 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001683 */
1684 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1685 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1686 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001687 * Broadcast Action: A user ID has been removed from the system. The user
1688 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001689 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001690 * <p class="note">This is a protected intent that can only be sent
1691 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001692 */
1693 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1694 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001695
1696 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001697 * Broadcast Action: Sent to the installer package of an application
1698 * when that application is first launched (that is the first time it
1699 * is moved out of the stopped state). The data contains the name of the package.
1700 *
1701 * <p class="note">This is a protected intent that can only be sent
1702 * by the system.
1703 */
1704 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1705 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1706
1707 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001708 * Broadcast Action: Sent to the system package verifier when a package
1709 * needs to be verified. The data contains the package URI.
1710 * <p class="note">
1711 * This is a protected intent that can only be sent by the system.
1712 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001713 */
1714 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1715 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1716
1717 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001718 * Broadcast Action: Sent to the system package verifier when a package is
1719 * verified. The data contains the package URI.
1720 * <p class="note">
1721 * This is a protected intent that can only be sent by the system.
1722 */
1723 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1724 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1725
1726 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001727 * Broadcast Action: Resources for a set of packages (which were
1728 * previously unavailable) are currently
1729 * available since the media on which they exist is available.
1730 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1731 * list of packages whose availability changed.
1732 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1733 * list of uids of packages whose availability changed.
1734 * Note that the
1735 * packages in this list do <em>not</em> receive this broadcast.
1736 * The specified set of packages are now available on the system.
1737 * <p>Includes the following extras:
1738 * <ul>
1739 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1740 * whose resources(were previously unavailable) are currently available.
1741 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1742 * packages whose resources(were previously unavailable)
1743 * are currently available.
1744 * </ul>
1745 *
1746 * <p class="note">This is a protected intent that can only be sent
1747 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001748 */
1749 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001750 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1751 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001752
1753 /**
1754 * Broadcast Action: Resources for a set of packages are currently
1755 * unavailable since the media on which they exist is unavailable.
1756 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1757 * list of packages whose availability changed.
1758 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1759 * list of uids of packages whose availability changed.
1760 * The specified set of packages can no longer be
1761 * launched and are practically unavailable on the system.
1762 * <p>Inclues the following extras:
1763 * <ul>
1764 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1765 * whose resources are no longer available.
1766 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1767 * whose resources are no longer available.
1768 * </ul>
1769 *
1770 * <p class="note">This is a protected intent that can only be sent
1771 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001772 */
1773 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001774 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001775 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001776
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001777 /**
1778 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001779 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001780 * This should <em>only</em> be used to determine when the wallpaper
1781 * has changed to show the new wallpaper to the user. You should certainly
1782 * never, in response to this, change the wallpaper or other attributes of
1783 * it such as the suggested size. That would be crazy, right? You'd cause
1784 * all kinds of loops, especially if other apps are doing similar things,
1785 * right? Of course. So please don't do this.
1786 *
1787 * @deprecated Modern applications should use
1788 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1789 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1790 * shown behind their UI, rather than watching for this broadcast and
1791 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001792 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001793 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001794 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1795 /**
1796 * Broadcast Action: The current device {@link android.content.res.Configuration}
1797 * (orientation, locale, etc) has changed. When such a change happens, the
1798 * UIs (view hierarchy) will need to be rebuilt based on this new
1799 * information; for the most part, applications don't need to worry about
1800 * this, because the system will take care of stopping and restarting the
1801 * application to make sure it sees the new changes. Some system code that
1802 * can not be restarted will need to watch for this action and handle it
1803 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001804 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001805 * <p class="note">
1806 * You can <em>not</em> receive this through components declared
1807 * in manifests, only by explicitly registering for it with
1808 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1809 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001810 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001811 * <p class="note">This is a protected intent that can only be sent
1812 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001813 *
1814 * @see android.content.res.Configuration
1815 */
1816 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1817 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1818 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001819 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001820 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001821 * <p class="note">This is a protected intent that can only be sent
1822 * by the system.
1823 */
1824 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1825 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1826 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001827 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1828 * charging state, level, and other information about the battery.
1829 * See {@link android.os.BatteryManager} for documentation on the
1830 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001831 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001832 * <p class="note">
1833 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001834 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001835 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001836 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1837 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1838 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1839 * broadcasts that are sent and can be received through manifest
1840 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001841 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001842 * <p class="note">This is a protected intent that can only be sent
1843 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001844 */
1845 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1846 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1847 /**
1848 * Broadcast Action: Indicates low battery condition on the device.
1849 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001850 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001851 * <p class="note">This is a protected intent that can only be sent
1852 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001853 */
1854 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1855 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1856 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001857 * Broadcast Action: Indicates the battery is now okay after being low.
1858 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1859 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001860 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001861 * <p class="note">This is a protected intent that can only be sent
1862 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001863 */
1864 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1865 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1866 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001867 * Broadcast Action: External power has been connected to the device.
1868 * This is intended for applications that wish to register specifically to this notification.
1869 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1870 * stay active to receive this notification. This action can be used to implement actions
1871 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001872 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001873 * <p class="note">This is a protected intent that can only be sent
1874 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001875 */
1876 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001877 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001878 /**
1879 * Broadcast Action: External power has been removed from the device.
1880 * This is intended for applications that wish to register specifically to this notification.
1881 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1882 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001883 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001884 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001885 * <p class="note">This is a protected intent that can only be sent
1886 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001887 */
1888 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001889 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001890 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001891 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001892 * Broadcast Action: Device is shutting down.
1893 * This is broadcast when the device is being shut down (completely turned
1894 * off, not sleeping). Once the broadcast is complete, the final shutdown
1895 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001896 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001897 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001898 * <p class="note">This is a protected intent that can only be sent
1899 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001900 */
1901 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001902 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001903 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001904 * Activity Action: Start this activity to request system shutdown.
1905 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1906 * to request confirmation from the user before shutting down.
1907 *
1908 * <p class="note">This is a protected intent that can only be sent
1909 * by the system.
1910 *
1911 * {@hide}
1912 */
1913 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1914 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001915 * Broadcast Action: A sticky broadcast that indicates low memory
1916 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001917 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001918 * <p class="note">This is a protected intent that can only be sent
1919 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001920 */
1921 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1922 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1923 /**
1924 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001925 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001926 * <p class="note">This is a protected intent that can only be sent
1927 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001928 */
1929 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1930 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1931 /**
Jake Hambybb371632010-08-23 18:16:48 -07001932 * Broadcast Action: A sticky broadcast that indicates a memory full
1933 * condition on the device. This is intended for activities that want
1934 * to be able to fill the data partition completely, leaving only
1935 * enough free space to prevent system-wide SQLite failures.
1936 *
1937 * <p class="note">This is a protected intent that can only be sent
1938 * by the system.
1939 *
1940 * {@hide}
1941 */
1942 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1943 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1944 /**
1945 * Broadcast Action: Indicates memory full condition on the device
1946 * no longer exists.
1947 *
1948 * <p class="note">This is a protected intent that can only be sent
1949 * by the system.
1950 *
1951 * {@hide}
1952 */
1953 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1954 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1955 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001956 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1957 * and package management should be started.
1958 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1959 * notification.
1960 */
1961 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1962 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1963 /**
1964 * Broadcast Action: The device has entered USB Mass Storage mode.
1965 * This is used mainly for the USB Settings panel.
1966 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1967 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001968 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001969 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001970 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001971 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1972
1973 /**
1974 * Broadcast Action: The device has exited USB Mass Storage mode.
1975 * This is used mainly for the USB Settings panel.
1976 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1977 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001978 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001980 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001981 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1982
1983 /**
1984 * Broadcast Action: External media has been removed.
1985 * The path to the mount point for the removed media is contained in the Intent.mData field.
1986 */
1987 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1988 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1989
1990 /**
1991 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001992 * 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 -07001993 */
1994 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1995 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1996
1997 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001998 * Broadcast Action: External media is present, and being disk-checked
1999 * 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 -08002000 */
2001 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2002 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2003
2004 /**
2005 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2006 * 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 -08002007 */
2008 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2009 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2010
2011 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002013 * 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 -07002014 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2015 * media was mounted read only.
2016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2019
2020 /**
2021 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002022 * 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 -07002023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2026
2027 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002028 * Broadcast Action: External media is no longer being shared via USB mass storage.
2029 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2030 *
2031 * @hide
2032 */
2033 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2034
2035 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002036 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2037 * The path to the mount point for the removed media is contained in the Intent.mData field.
2038 */
2039 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2040 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2041
2042 /**
2043 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002044 * 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 -07002045 */
2046 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2047 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2048
2049 /**
2050 * Broadcast Action: User has expressed the desire to remove the external storage media.
2051 * Applications should close all files they have open within the mount point when they receive this intent.
2052 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2053 */
2054 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2055 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2056
2057 /**
2058 * Broadcast Action: The media scanner has started scanning a directory.
2059 * The path to the directory being scanned is contained in the Intent.mData field.
2060 */
2061 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2062 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2063
2064 /**
2065 * Broadcast Action: The media scanner has finished scanning a directory.
2066 * The path to the scanned directory is contained in the Intent.mData field.
2067 */
2068 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2069 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2070
2071 /**
2072 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2073 * The path to the file is contained in the Intent.mData field.
2074 */
2075 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2076 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2077
2078 /**
2079 * Broadcast Action: The "Media Button" was pressed. Includes a single
2080 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2081 * caused the broadcast.
2082 */
2083 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2084 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2085
2086 /**
2087 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2088 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2089 * caused the broadcast.
2090 */
2091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2092 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2093
2094 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2095 // location; they are not general-purpose actions.
2096
2097 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002098 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002099 */
2100 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2101 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2102 "android.intent.action.GTALK_CONNECTED";
2103
2104 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002105 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002106 */
2107 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2108 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2109 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002110
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002111 /**
2112 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002113 */
2114 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2115 public static final String ACTION_INPUT_METHOD_CHANGED =
2116 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002117
2118 /**
2119 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2120 * more radios have been turned off or on. The intent will have the following extra value:</p>
2121 * <ul>
2122 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2123 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2124 * turned off</li>
2125 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002126 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002127 * <p class="note">This is a protected intent that can only be sent
2128 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002129 */
2130 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2131 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2132
2133 /**
2134 * Broadcast Action: Some content providers have parts of their namespace
2135 * where they publish new events or items that the user may be especially
2136 * interested in. For these things, they may broadcast this action when the
2137 * set of interesting items change.
2138 *
2139 * For example, GmailProvider sends this notification when the set of unread
2140 * mail in the inbox changes.
2141 *
2142 * <p>The data of the intent identifies which part of which provider
2143 * changed. When queried through the content resolver, the data URI will
2144 * return the data set in question.
2145 *
2146 * <p>The intent will have the following extra values:
2147 * <ul>
2148 * <li><em>count</em> - The number of items in the data set. This is the
2149 * same as the number of items in the cursor returned by querying the
2150 * data URI. </li>
2151 * </ul>
2152 *
2153 * This intent will be sent at boot (if the count is non-zero) and when the
2154 * data set changes. It is possible for the data set to change without the
2155 * count changing (for example, if a new unread message arrives in the same
2156 * sync operation in which a message is archived). The phone should still
2157 * ring/vibrate/etc as normal in this case.
2158 */
2159 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2160 public static final String ACTION_PROVIDER_CHANGED =
2161 "android.intent.action.PROVIDER_CHANGED";
2162
2163 /**
2164 * Broadcast Action: Wired Headset plugged in or unplugged.
2165 *
2166 * <p>The intent will have the following extra values:
2167 * <ul>
2168 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2169 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002170 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002171 * </ul>
2172 * </ul>
2173 */
2174 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2175 public static final String ACTION_HEADSET_PLUG =
2176 "android.intent.action.HEADSET_PLUG";
2177
2178 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002179 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2180 *
2181 * <p>The intent will have the following extra values:
2182 * <ul>
2183 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2184 * <li><em>name</em> - Headset type, human readable string </li>
2185 * </ul>
2186 * </ul>
2187 * @hide
2188 */
2189 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002190 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2191 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002192
2193 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002194 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002195 *
2196 * <p>The intent will have the following extra values:
2197 * <ul>
2198 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2199 * <li><em>name</em> - Headset type, human readable string </li>
2200 * </ul>
2201 * </ul>
2202 * @hide
2203 */
2204 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002205 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2206 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002207
2208 /**
2209 * Broadcast Action: A HMDI cable was plugged or unplugged
2210 *
2211 * <p>The intent will have the following extra values:
2212 * <ul>
2213 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2214 * <li><em>name</em> - HDMI cable, human readable string </li>
2215 * </ul>
2216 * </ul>
2217 * @hide
2218 */
2219 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2220 public static final String ACTION_HDMI_AUDIO_PLUG =
2221 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002222
2223 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002224 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2225 *
2226 * <p>The intent will have the following extra values:
2227 * <ul>
2228 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2229 * <li><em>card</em> - ALSA card number (integer) </li>
2230 * <li><em>device</em> - ALSA device number (integer) </li>
2231 * </ul>
2232 * </ul>
2233 * @hide
2234 */
2235 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2236 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2237 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2238
2239 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002240 * Broadcast Action: A USB audio device was plugged in or unplugged.
2241 *
2242 * <p>The intent will have the following extra values:
2243 * <ul>
2244 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2245 * <li><em>card</em> - ALSA card number (integer) </li>
2246 * <li><em>device</em> - ALSA device number (integer) </li>
2247 * </ul>
2248 * </ul>
2249 * @hide
2250 */
2251 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2252 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2253 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2254
2255 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002256 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2257 * <ul>
2258 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2259 * </ul>
2260 *
2261 * <p class="note">This is a protected intent that can only be sent
2262 * by the system.
2263 *
2264 * @hide
2265 */
2266 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2267 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2268 = "android.intent.action.ADVANCED_SETTINGS";
2269
2270 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002271 * Broadcast Action: An outgoing call is about to be placed.
2272 *
2273 * <p>The Intent will have the following extra value:
2274 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002275 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002276 * the phone number originally intended to be dialed.</li>
2277 * </ul>
2278 * <p>Once the broadcast is finished, the resultData is used as the actual
2279 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002280 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002281 * outgoing call in turn: for example, a parental control application
2282 * might verify that the user is authorized to place the call at that
2283 * time, then a number-rewriting application might add an area code if
2284 * one was not specified.</p>
2285 * <p>For consistency, any receiver whose purpose is to prohibit phone
2286 * calls should have a priority of 0, to ensure it will see the final
2287 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002288 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002289 * should have a positive priority.
2290 * Negative priorities are reserved for the system for this broadcast;
2291 * using them may cause problems.</p>
2292 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2293 * abort the broadcast.</p>
2294 * <p>Emergency calls cannot be intercepted using this mechanism, and
2295 * other calls cannot be modified to call emergency numbers using this
2296 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002297 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002298 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2299 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002300 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002301 * <p class="note">This is a protected intent that can only be sent
2302 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002303 */
2304 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2305 public static final String ACTION_NEW_OUTGOING_CALL =
2306 "android.intent.action.NEW_OUTGOING_CALL";
2307
2308 /**
2309 * Broadcast Action: Have the device reboot. This is only for use by
2310 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002311 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002312 * <p class="note">This is a protected intent that can only be sent
2313 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002314 */
2315 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2316 public static final String ACTION_REBOOT =
2317 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002318
Wei Huang97ecc9c2009-05-11 17:44:20 -07002319 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002320 * Broadcast Action: A sticky broadcast for changes in the physical
2321 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002322 *
2323 * <p>The intent will have the following extra values:
2324 * <ul>
2325 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002326 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002327 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002328 * <p>This is intended for monitoring the current physical dock state.
2329 * See {@link android.app.UiModeManager} for the normal API dealing with
2330 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002331 */
2332 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2333 public static final String ACTION_DOCK_EVENT =
2334 "android.intent.action.DOCK_EVENT";
2335
2336 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002337 * Broadcast Action: A broadcast when idle maintenance can be started.
2338 * This means that the user is not interacting with the device and is
2339 * not expected to do so soon. Typical use of the idle maintenance is
2340 * to perform somehow expensive tasks that can be postponed at a moment
2341 * when they will not degrade user experience.
2342 * <p>
2343 * <p class="note">In order to keep the device responsive in case of an
2344 * unexpected user interaction, implementations of a maintenance task
2345 * should be interruptible. In such a scenario a broadcast with action
2346 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2347 * should not do the maintenance work in
2348 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2349 * maintenance service by {@link Context#startService(Intent)}. Also
2350 * you should hold a wake lock while your maintenance service is running
2351 * to prevent the device going to sleep.
2352 * </p>
2353 * <p>
2354 * <p class="note">This is a protected intent that can only be sent by
2355 * the system.
2356 * </p>
2357 *
2358 * @see #ACTION_IDLE_MAINTENANCE_END
2359 */
2360 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2361 public static final String ACTION_IDLE_MAINTENANCE_START =
2362 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2363
2364 /**
2365 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2366 * This means that the user was not interacting with the device as a result
2367 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2368 * was sent and now the user started interacting with the device. Typical
2369 * use of the idle maintenance is to perform somehow expensive tasks that
2370 * can be postponed at a moment when they will not degrade user experience.
2371 * <p>
2372 * <p class="note">In order to keep the device responsive in case of an
2373 * unexpected user interaction, implementations of a maintenance task
2374 * should be interruptible. Hence, on receiving a broadcast with this
2375 * action, the maintenance task should be interrupted as soon as possible.
2376 * In other words, you should not do the maintenance work in
2377 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2378 * maintenance service that was started on receiving of
2379 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2380 * lock you acquired when your maintenance service started.
2381 * </p>
2382 * <p class="note">This is a protected intent that can only be sent
2383 * by the system.
2384 *
2385 * @see #ACTION_IDLE_MAINTENANCE_START
2386 */
2387 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2388 public static final String ACTION_IDLE_MAINTENANCE_END =
2389 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2390
2391 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002392 * Broadcast Action: a remote intent is to be broadcasted.
2393 *
2394 * A remote intent is used for remote RPC between devices. The remote intent
2395 * is serialized and sent from one device to another device. The receiving
2396 * device parses the remote intent and broadcasts it. Note that anyone can
2397 * broadcast a remote intent. However, if the intent receiver of the remote intent
2398 * does not trust intent broadcasts from arbitrary intent senders, it should require
2399 * the sender to hold certain permissions so only trusted sender's broadcast will be
2400 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002401 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002402 */
2403 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002404 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002405
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002406 /**
2407 * Broadcast Action: hook for permforming cleanup after a system update.
2408 *
2409 * The broadcast is sent when the system is booting, before the
2410 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2411 * image. A receiver for this should do its work and then disable itself
2412 * so that it does not get run again at the next boot.
2413 * @hide
2414 */
2415 public static final String ACTION_PRE_BOOT_COMPLETED =
2416 "android.intent.action.PRE_BOOT_COMPLETED";
2417
Amith Yamasani13593602012-03-22 16:16:17 -07002418 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002419 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani86118ba2013-03-28 14:33:16 -07002420 * on restricted users. The response should contain an extra {@link #EXTRA_RESTRICTIONS},
2421 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2422 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2423 * The activity specified by that intent will be launched for a result which must contain
2424 * the extra {@link #EXTRA_RESTRICTIONS}. The returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002425 * @see RestrictionEntry
2426 */
2427 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2428 "android.intent.action.GET_RESTRICTION_ENTRIES";
2429
2430 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002431 * Sent the first time a user is starting, to allow system apps to
2432 * perform one time initialization. (This will not be seen by third
2433 * party applications because a newly initialized user does not have any
2434 * third party applications installed for it.) This is sent early in
2435 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002436 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2437 * broadcast, since it is part of a visible user interaction; be as quick
2438 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002439 */
2440 public static final String ACTION_USER_INITIALIZE =
2441 "android.intent.action.USER_INITIALIZE";
2442
2443 /**
2444 * Sent when a user switch is happening, causing the process's user to be
2445 * brought to the foreground. This is only sent to receivers registered
2446 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2447 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002448 * foreground. This is sent as a foreground
2449 * broadcast, since it is part of a visible user interaction; be as quick
2450 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002451 */
2452 public static final String ACTION_USER_FOREGROUND =
2453 "android.intent.action.USER_FOREGROUND";
2454
2455 /**
2456 * Sent when a user switch is happening, causing the process's user to be
2457 * sent to the background. This is only sent to receivers registered
2458 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2459 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002460 * background. This is sent as a foreground
2461 * broadcast, since it is part of a visible user interaction; be as quick
2462 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002463 */
2464 public static final String ACTION_USER_BACKGROUND =
2465 "android.intent.action.USER_BACKGROUND";
2466
2467 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002468 * Broadcast sent to the system when a user is added. Carries an extra
2469 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2470 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002471 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002472 * @hide
2473 */
2474 public static final String ACTION_USER_ADDED =
2475 "android.intent.action.USER_ADDED";
2476
2477 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002478 * Broadcast sent by the system when a user is started. Carries an extra
2479 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002480 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002481 * that has been started. This is sent as a foreground
2482 * broadcast, since it is part of a visible user interaction; be as quick
2483 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002484 * @hide
2485 */
2486 public static final String ACTION_USER_STARTED =
2487 "android.intent.action.USER_STARTED";
2488
2489 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002490 * Broadcast sent when a user is in the process of starting. Carries an extra
2491 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2492 * sent to registered receivers, not manifest receivers. It is sent to all
2493 * users (including the one that is being started). You must hold
2494 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2495 * this broadcast. This is sent as a background broadcast, since
2496 * its result is not part of the primary UX flow; to safely keep track of
2497 * started/stopped state of a user you can use this in conjunction with
2498 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2499 * other user state broadcasts since those are foreground broadcasts so can
2500 * execute in a different order.
2501 * @hide
2502 */
2503 public static final String ACTION_USER_STARTING =
2504 "android.intent.action.USER_STARTING";
2505
2506 /**
2507 * Broadcast sent when a user is going to be stopped. Carries an extra
2508 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2509 * sent to registered receivers, not manifest receivers. It is sent to all
2510 * users (including the one that is being stopped). You must hold
2511 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2512 * this broadcast. The user will not stop until all receivers have
2513 * handled the broadcast. This is sent as a background broadcast, since
2514 * its result is not part of the primary UX flow; to safely keep track of
2515 * started/stopped state of a user you can use this in conjunction with
2516 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2517 * other user state broadcasts since those are foreground broadcasts so can
2518 * execute in a different order.
2519 * @hide
2520 */
2521 public static final String ACTION_USER_STOPPING =
2522 "android.intent.action.USER_STOPPING";
2523
2524 /**
2525 * Broadcast sent to the system when a user is stopped. Carries an extra
2526 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2527 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2528 * specific package. This is only sent to registered receivers, not manifest
2529 * receivers. It is sent to all running users <em>except</em> the one that
2530 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002531 * @hide
2532 */
2533 public static final String ACTION_USER_STOPPED =
2534 "android.intent.action.USER_STOPPED";
2535
2536 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002537 * 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 -07002538 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002539 * one that has been removed. The user will not be completely removed until all receivers have
2540 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002541 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002542 * @hide
2543 */
2544 public static final String ACTION_USER_REMOVED =
2545 "android.intent.action.USER_REMOVED";
2546
2547 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002548 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002549 * the userHandle of the user to become the current one. This is only sent to
2550 * registered receivers, not manifest receivers. It is sent to all running users.
2551 * You must hold
2552 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002553 * @hide
2554 */
2555 public static final String ACTION_USER_SWITCHED =
2556 "android.intent.action.USER_SWITCHED";
2557
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002558 /**
2559 * Broadcast sent to the system when a user's information changes. Carries an extra
2560 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2561 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2562 * whose information has changed.
2563 * @hide
2564 */
2565 public static final String ACTION_USER_INFO_CHANGED =
2566 "android.intent.action.USER_INFO_CHANGED";
2567
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002568 /**
2569 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2570 */
2571 public static final String ACTION_QUICK_CLOCK =
2572 "android.intent.action.QUICK_CLOCK";
2573
Michael Wright0087a142013-02-05 16:29:39 -08002574 /**
2575 * Broadcast Action: This is broadcast when a user action should request the
2576 * brightness setting dialog.
2577 * @hide
2578 */
2579 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2580 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2581
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002582 // ---------------------------------------------------------------------
2583 // ---------------------------------------------------------------------
2584 // Standard intent categories (see addCategory()).
2585
2586 /**
2587 * Set if the activity should be an option for the default action
2588 * (center press) to perform on a piece of data. Setting this will
2589 * hide from the user any activities without it set when performing an
2590 * action on some data. Note that this is normal -not- set in the
2591 * Intent when initiating an action -- it is for use in intent filters
2592 * specified in packages.
2593 */
2594 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2595 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2596 /**
2597 * Activities that can be safely invoked from a browser must support this
2598 * category. For example, if the user is viewing a web page or an e-mail
2599 * and clicks on a link in the text, the Intent generated execute that
2600 * link will require the BROWSABLE category, so that only activities
2601 * supporting this category will be considered as possible actions. By
2602 * supporting this category, you are promising that there is nothing
2603 * damaging (without user intervention) that can happen by invoking any
2604 * matching Intent.
2605 */
2606 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2607 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2608 /**
2609 * Set if the activity should be considered as an alternative action to
2610 * the data the user is currently viewing. See also
2611 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2612 * applies to the selection in a list of items.
2613 *
2614 * <p>Supporting this category means that you would like your activity to be
2615 * displayed in the set of alternative things the user can do, usually as
2616 * part of the current activity's options menu. You will usually want to
2617 * include a specific label in the &lt;intent-filter&gt; of this action
2618 * describing to the user what it does.
2619 *
2620 * <p>The action of IntentFilter with this category is important in that it
2621 * describes the specific action the target will perform. This generally
2622 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2623 * a specific name such as "com.android.camera.action.CROP. Only one
2624 * alternative of any particular action will be shown to the user, so using
2625 * a specific action like this makes sure that your alternative will be
2626 * displayed while also allowing other applications to provide their own
2627 * overrides of that particular action.
2628 */
2629 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2630 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2631 /**
2632 * Set if the activity should be considered as an alternative selection
2633 * action to the data the user has currently selected. This is like
2634 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2635 * of items from which the user can select, giving them alternatives to the
2636 * default action that will be performed on it.
2637 */
2638 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2639 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2640 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002641 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002642 */
2643 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2644 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2645 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002646 * Should be displayed in the top-level launcher.
2647 */
2648 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2649 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2650 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002651 * Provides information about the package it is in; typically used if
2652 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2653 * a front-door to the user without having to be shown in the all apps list.
2654 */
2655 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2656 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2657 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002658 * This is the home activity, that is the first activity that is displayed
2659 * when the device boots.
2660 */
2661 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2662 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2663 /**
2664 * This activity is a preference panel.
2665 */
2666 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2667 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2668 /**
2669 * This activity is a development preference panel.
2670 */
2671 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2672 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2673 /**
2674 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002675 */
2676 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2677 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2678 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002679 * This activity allows the user to browse and download new applications.
2680 */
2681 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2682 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2683 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002684 * This activity may be exercised by the monkey or other automated test tools.
2685 */
2686 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2687 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2688 /**
2689 * To be used as a test (not part of the normal user experience).
2690 */
2691 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2692 /**
2693 * To be used as a unit test (run through the Test Harness).
2694 */
2695 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2696 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002697 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002698 * experience).
2699 */
2700 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2701 /**
2702 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002703 * ContentResolver.openInputStream. Openable URIs must support the columns in
2704 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002705 * when queried, though it is allowable for those columns to be blank.
2706 */
2707 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2708 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2709
2710 /**
2711 * To be used as code under test for framework instrumentation tests.
2712 */
2713 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2714 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002715 /**
2716 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002717 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2718 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002719 */
2720 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2721 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2722 /**
2723 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002724 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2725 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002726 */
2727 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2728 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002729 /**
2730 * An activity to run when device is inserted into a analog (low end) dock.
2731 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2732 * information, see {@link android.app.UiModeManager}.
2733 */
2734 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2735 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2736
2737 /**
2738 * An activity to run when device is inserted into a digital (high end) dock.
2739 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2740 * information, see {@link android.app.UiModeManager}.
2741 */
2742 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2743 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002744
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002745 /**
2746 * Used to indicate that the activity can be used in a car environment.
2747 */
2748 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2749 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2750
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002751 // ---------------------------------------------------------------------
2752 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002753 // Application launch intent categories (see addCategory()).
2754
2755 /**
2756 * Used with {@link #ACTION_MAIN} to launch the browser application.
2757 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002758 * <p>NOTE: This should not be used as the primary key of an Intent,
2759 * since it will not result in the app launching with the correct
2760 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002761 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002762 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002763 */
2764 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2765 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2766
2767 /**
2768 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2769 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002770 * <p>NOTE: This should not be used as the primary key of an Intent,
2771 * since it will not result in the app launching with the correct
2772 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002773 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002774 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002775 */
2776 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2777 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2778
2779 /**
2780 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2781 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002782 * <p>NOTE: This should not be used as the primary key of an Intent,
2783 * since it will not result in the app launching with the correct
2784 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002785 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002786 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002787 */
2788 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2789 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2790
2791 /**
2792 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2793 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002794 * <p>NOTE: This should not be used as the primary key of an Intent,
2795 * since it will not result in the app launching with the correct
2796 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002797 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002798 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002799 */
2800 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2801 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2802
2803 /**
2804 * Used with {@link #ACTION_MAIN} to launch the email application.
2805 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002806 * <p>NOTE: This should not be used as the primary key of an Intent,
2807 * since it will not result in the app launching with the correct
2808 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002809 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002810 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002811 */
2812 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2813 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2814
2815 /**
2816 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2817 * The activity should be able to view and manipulate image and video files
2818 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002819 * <p>NOTE: This should not be used as the primary key of an Intent,
2820 * since it will not result in the app launching with the correct
2821 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002822 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002823 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002824 */
2825 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2826 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2827
2828 /**
2829 * Used with {@link #ACTION_MAIN} to launch the maps application.
2830 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002831 * <p>NOTE: This should not be used as the primary key of an Intent,
2832 * since it will not result in the app launching with the correct
2833 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002834 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002835 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002836 */
2837 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2838 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2839
2840 /**
2841 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2842 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002843 * <p>NOTE: This should not be used as the primary key of an Intent,
2844 * since it will not result in the app launching with the correct
2845 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002846 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002847 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002848 */
2849 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2850 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2851
2852 /**
2853 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002854 * The activity should be able to play, browse, or manipulate music files
2855 * stored on the device.
2856 * <p>NOTE: This should not be used as the primary key of an Intent,
2857 * since it will not result in the app launching with the correct
2858 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002859 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002860 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002861 */
2862 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2863 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2864
2865 // ---------------------------------------------------------------------
2866 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002867 // Standard extra data keys.
2868
2869 /**
2870 * The initial data to place in a newly created record. Use with
2871 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2872 * fields as would be given to the underlying ContentProvider.insert()
2873 * call.
2874 */
2875 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2876
2877 /**
2878 * A constant CharSequence that is associated with the Intent, used with
2879 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2880 * this may be a styled CharSequence, so you must use
2881 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2882 * retrieve it.
2883 */
2884 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2885
2886 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002887 * A constant String that is associated with the Intent, used with
2888 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2889 * as HTML formatted text. Note that you <em>must</em> also supply
2890 * {@link #EXTRA_TEXT}.
2891 */
2892 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2893
2894 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002895 * A content: URI holding a stream of data associated with the Intent,
2896 * used with {@link #ACTION_SEND} to supply the data being sent.
2897 */
2898 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2899
2900 /**
2901 * A String[] holding e-mail addresses that should be delivered to.
2902 */
2903 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2904
2905 /**
2906 * A String[] holding e-mail addresses that should be carbon copied.
2907 */
2908 public static final String EXTRA_CC = "android.intent.extra.CC";
2909
2910 /**
2911 * A String[] holding e-mail addresses that should be blind carbon copied.
2912 */
2913 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2914
2915 /**
2916 * A constant string holding the desired subject line of a message.
2917 */
2918 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2919
2920 /**
2921 * An Intent describing the choices you would like shown with
2922 * {@link #ACTION_PICK_ACTIVITY}.
2923 */
2924 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2925
2926 /**
2927 * A CharSequence dialog title to provide to the user when used with a
2928 * {@link #ACTION_CHOOSER}.
2929 */
2930 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2931
2932 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002933 * A Parcelable[] of {@link Intent} or
2934 * {@link android.content.pm.LabeledIntent} objects as set with
2935 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2936 * a the front of the list of choices, when shown to the user with a
2937 * {@link #ACTION_CHOOSER}.
2938 */
2939 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2940
2941 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002942 * A {@link android.view.KeyEvent} object containing the event that
2943 * triggered the creation of the Intent it is in.
2944 */
2945 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2946
2947 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002948 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2949 * before shutting down.
2950 *
2951 * {@hide}
2952 */
2953 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2954
2955 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002956 * 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 -07002957 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2958 * of restarting the application.
2959 */
2960 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2961
2962 /**
2963 * A String holding the phone number originally entered in
2964 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2965 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2966 */
2967 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002968
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002969 /**
2970 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2971 * intents to supply the uid the package had been assigned. Also an optional
2972 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2973 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2974 * purpose.
2975 */
2976 public static final String EXTRA_UID = "android.intent.extra.UID";
2977
2978 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002979 * @hide String array of package names.
2980 */
2981 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2982
2983 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002984 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2985 * intents to indicate whether this represents a full uninstall (removing
2986 * both the code and its data) or a partial uninstall (leaving its data,
2987 * implying that this is an update).
2988 */
2989 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002990
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002991 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002992 * @hide
2993 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2994 * intents to indicate that at this point the package has been removed for
2995 * all users on the device.
2996 */
2997 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2998 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2999
3000 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003001 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3002 * intents to indicate that this is a replacement of the package, so this
3003 * broadcast will immediately be followed by an add broadcast for a
3004 * different version of the same package.
3005 */
3006 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003007
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003008 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003009 * Used as an int extra field in {@link android.app.AlarmManager} intents
3010 * to tell the application being invoked how many pending alarms are being
3011 * delievered with the intent. For one-shot alarms this will always be 1.
3012 * For recurring alarms, this might be greater than 1 if the device was
3013 * asleep or powered off at the time an earlier alarm would have been
3014 * delivered.
3015 */
3016 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003017
Jacek Surazski86b6c532009-05-13 14:38:28 +02003018 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003019 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3020 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003021 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3022 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003023 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3024 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3025 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003026 */
3027 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3028
3029 /**
3030 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3031 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003032 */
3033 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3034
3035 /**
3036 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3037 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003038 */
3039 public static final int EXTRA_DOCK_STATE_DESK = 1;
3040
3041 /**
3042 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3043 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003044 */
3045 public static final int EXTRA_DOCK_STATE_CAR = 2;
3046
3047 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003048 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3049 * to represent that the phone is in a analog (low end) dock.
3050 */
3051 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3052
3053 /**
3054 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3055 * to represent that the phone is in a digital (high end) dock.
3056 */
3057 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3058
3059 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003060 * Boolean that can be supplied as meta-data with a dock activity, to
3061 * indicate that the dock should take over the home key when it is active.
3062 */
3063 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003064
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003065 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003066 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3067 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003068 */
3069 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3070
3071 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003072 * Used in the extra field in the remote intent. It's astring token passed with the
3073 * remote intent.
3074 */
3075 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3076 "android.intent.extra.remote_intent_token";
3077
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003078 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003079 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003080 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003081 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003082 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003083 "android.intent.extra.changed_component_name";
3084
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003085 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003086 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003087 * and contains a string array of all of the components that have changed. If
3088 * the state of the overall package has changed, then it will contain an entry
3089 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003090 */
3091 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3092 "android.intent.extra.changed_component_name_list";
3093
3094 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003095 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003096 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3097 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003098 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003099 */
3100 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3101 "android.intent.extra.changed_package_list";
3102
3103 /**
3104 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003105 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3106 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003107 * and contains an integer array of uids of all of the components
3108 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003109 */
3110 public static final String EXTRA_CHANGED_UID_LIST =
3111 "android.intent.extra.changed_uid_list";
3112
3113 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003114 * @hide
3115 * Magic extra system code can use when binding, to give a label for
3116 * who it is that has bound to a service. This is an integer giving
3117 * a framework string resource that can be displayed to the user.
3118 */
3119 public static final String EXTRA_CLIENT_LABEL =
3120 "android.intent.extra.client_label";
3121
3122 /**
3123 * @hide
3124 * Magic extra system code can use when binding, to give a PendingIntent object
3125 * that can be launched for the user to disable the system's use of this
3126 * service.
3127 */
3128 public static final String EXTRA_CLIENT_INTENT =
3129 "android.intent.extra.client_intent";
3130
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003131 /**
3132 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3133 * data that is on the local device. This is a boolean extra; the default
3134 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3135 * the user to select media that is already on the device, not requiring it
3136 * be downloaded from a remote service when opened. Another way to look
3137 * at it is that such content should generally have a "_data" column to the
3138 * path of the content on local external storage.
3139 */
3140 public static final String EXTRA_LOCAL_ONLY =
3141 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003142
Amith Yamasani13593602012-03-22 16:16:17 -07003143 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003144 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3145 * user to select and return multiple items. This is a boolean extra; the default
3146 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3147 * present the user with a UI where they can pick multiple items that are all
3148 * returned to the caller. When this happens, they should be returned as
3149 * the {@link #getClipData()} part of the result Intent.
3150 */
3151 public static final String EXTRA_ALLOW_MULTIPLE =
3152 "android.intent.extra.ALLOW_MULTIPLE";
3153
3154 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003155 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003156 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3157 * @hide
3158 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003159 public static final String EXTRA_USER_HANDLE =
3160 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003161
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003162 /**
3163 * Extra used in the response from a BroadcastReceiver that handles
3164 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3165 */
3166 public static final String EXTRA_RESTRICTIONS = "android.intent.extra.restrictions";
3167
Amith Yamasani86118ba2013-03-28 14:33:16 -07003168 /**
3169 * Extra used in the response from a BroadcastReceiver that handles
3170 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3171 */
3172 public static final String EXTRA_RESTRICTIONS_INTENT =
3173 "android.intent.extra.restrictions_intent";
3174
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003175 // ---------------------------------------------------------------------
3176 // ---------------------------------------------------------------------
3177 // Intent flags (see mFlags variable).
3178
3179 /**
3180 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003181 * perform read operations on the Uri in the Intent's data and any URIs
3182 * specified in its ClipData. When applying to an Intent's ClipData,
3183 * all URIs as well as recursive traversals through data or other ClipData
3184 * in Intent items will be granted; only the grant flags of the top-level
3185 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003186 */
3187 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3188 /**
3189 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003190 * perform write operations on the Uri in the Intent's data and any URIs
3191 * specified in its ClipData. When applying to an Intent's ClipData,
3192 * all URIs as well as recursive traversals through data or other ClipData
3193 * in Intent items will be granted; only the grant flags of the top-level
3194 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003195 */
3196 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3197 /**
3198 * Can be set by the caller to indicate that this Intent is coming from
3199 * a background operation, not from direct user interaction.
3200 */
3201 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3202 /**
3203 * A flag you can enable for debugging: when set, log messages will be
3204 * printed during the resolution of this intent to show you what has
3205 * been found to create the final resolved list.
3206 */
3207 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003208 /**
3209 * If set, this intent will not match any components in packages that
3210 * are currently stopped. If this is not set, then the default behavior
3211 * is to include such applications in the result.
3212 */
3213 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3214 /**
3215 * If set, this intent will always match any components in packages that
3216 * are currently stopped. This is the default behavior when
3217 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3218 * flags are set, this one wins (it allows overriding of exclude for
3219 * places where the framework may automatically set the exclude flag).
3220 */
3221 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003222
3223 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003224 * If set, the new activity is not kept in the history stack. As soon as
3225 * the user navigates away from it, the activity is finished. This may also
3226 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3227 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003228 */
3229 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3230 /**
3231 * If set, the activity will not be launched if it is already running
3232 * at the top of the history stack.
3233 */
3234 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3235 /**
3236 * If set, this activity will become the start of a new task on this
3237 * history stack. A task (from the activity that started it to the
3238 * next task activity) defines an atomic group of activities that the
3239 * user can move to. Tasks can be moved to the foreground and background;
3240 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003241 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003242 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3243 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003244 *
3245 * <p>This flag is generally used by activities that want
3246 * to present a "launcher" style behavior: they give the user a list of
3247 * separate things that can be done, which otherwise run completely
3248 * independently of the activity launching them.
3249 *
3250 * <p>When using this flag, if a task is already running for the activity
3251 * you are now starting, then a new activity will not be started; instead,
3252 * the current task will simply be brought to the front of the screen with
3253 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3254 * to disable this behavior.
3255 *
3256 * <p>This flag can not be used when the caller is requesting a result from
3257 * the activity being launched.
3258 */
3259 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3260 /**
3261 * <strong>Do not use this flag unless you are implementing your own
3262 * top-level application launcher.</strong> Used in conjunction with
3263 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3264 * behavior of bringing an existing task to the foreground. When set,
3265 * a new task is <em>always</em> started to host the Activity for the
3266 * Intent, regardless of whether there is already an existing task running
3267 * the same thing.
3268 *
3269 * <p><strong>Because the default system does not include graphical task management,
3270 * you should not use this flag unless you provide some way for a user to
3271 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003272 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003273 * <p>This flag is ignored if
3274 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3275 *
Scott Main7aee61f2011-02-08 11:25:01 -08003276 * <p>See
3277 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3278 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003279 */
3280 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3281 /**
3282 * If set, and the activity being launched is already running in the
3283 * current task, then instead of launching a new instance of that activity,
3284 * all of the other activities on top of it will be closed and this Intent
3285 * will be delivered to the (now on top) old activity as a new Intent.
3286 *
3287 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3288 * If D calls startActivity() with an Intent that resolves to the component
3289 * of activity B, then C and D will be finished and B receive the given
3290 * Intent, resulting in the stack now being: A, B.
3291 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003292 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003293 * either receive the new intent you are starting here in its
3294 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003295 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003296 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3297 * the same intent, then it will be finished and re-created; for all other
3298 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3299 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003300 *
3301 * <p>This launch mode can also be used to good effect in conjunction with
3302 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3303 * of a task, it will bring any currently running instance of that task
3304 * to the foreground, and then clear it to its root state. This is
3305 * especially useful, for example, when launching an activity from the
3306 * notification manager.
3307 *
Scott Main7aee61f2011-02-08 11:25:01 -08003308 * <p>See
3309 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3310 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003311 */
3312 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3313 /**
3314 * If set and this intent is being used to launch a new activity from an
3315 * existing one, then the reply target of the existing activity will be
3316 * transfered to the new activity. This way the new activity can call
3317 * {@link android.app.Activity#setResult} and have that result sent back to
3318 * the reply target of the original activity.
3319 */
3320 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3321 /**
3322 * If set and this intent is being used to launch a new activity from an
3323 * existing one, the current activity will not be counted as the top
3324 * activity for deciding whether the new intent should be delivered to
3325 * the top instead of starting a new one. The previous activity will
3326 * be used as the top, with the assumption being that the current activity
3327 * will finish itself immediately.
3328 */
3329 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3330 /**
3331 * If set, the new activity is not kept in the list of recently launched
3332 * activities.
3333 */
3334 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3335 /**
3336 * This flag is not normally set by application code, but set for you by
3337 * the system as described in the
3338 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3339 * launchMode} documentation for the singleTask mode.
3340 */
3341 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3342 /**
3343 * If set, and this activity is either being started in a new task or
3344 * bringing to the top an existing task, then it will be launched as
3345 * the front door of the task. This will result in the application of
3346 * any affinities needed to have that task in the proper state (either
3347 * moving activities to or from it), or simply resetting that task to
3348 * its initial state if needed.
3349 */
3350 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3351 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003352 * This flag is not normally set by application code, but set for you by
3353 * the system if this activity is being launched from history
3354 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003355 */
3356 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003357 /**
3358 * If set, this marks a point in the task's activity stack that should
3359 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003360 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003361 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3362 * the user re-launching it from home), this activity and all on top of
3363 * it will be finished so that the user does not return to them, but
3364 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003365 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003366 * <p>This is useful for cases where you have a logical break in your
3367 * application. For example, an e-mail application may have a command
3368 * to view an attachment, which launches an image view activity to
3369 * display it. This activity should be part of the e-mail application's
3370 * task, since it is a part of the task the user is involved in. However,
3371 * if the user leaves that task, and later selects the e-mail app from
3372 * home, we may like them to return to the conversation they were
3373 * viewing, not the picture attachment, since that is confusing. By
3374 * setting this flag when launching the image viewer, that viewer and
3375 * any activities it starts will be removed the next time the user returns
3376 * to mail.
3377 */
3378 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003379 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003380 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003381 * callback from occurring on the current frontmost activity before it is
3382 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003383 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003384 * <p>Typically, an activity can rely on that callback to indicate that an
3385 * explicit user action has caused their activity to be moved out of the
3386 * foreground. The callback marks an appropriate point in the activity's
3387 * lifecycle for it to dismiss any notifications that it intends to display
3388 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003389 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003390 * <p>If an activity is ever started via any non-user-driven events such as
3391 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3392 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003393 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003394 */
3395 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003396 /**
3397 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3398 * this flag will cause the launched activity to be brought to the front of its
3399 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003400 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003401 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3402 * If D calls startActivity() with an Intent that resolves to the component
3403 * of activity B, then B will be brought to the front of the history stack,
3404 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003405 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003406 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003407 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003408 */
3409 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003410 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003411 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3412 * this flag will prevent the system from applying an activity transition
3413 * animation to go to the next activity state. This doesn't mean an
3414 * animation will never run -- if another activity change happens that doesn't
3415 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003416 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003417 * when you are going to do a series of activity operations but the
3418 * animation seen by the user shouldn't be driven by the first activity
3419 * change but rather a later one.
3420 */
3421 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3422 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003423 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3424 * this flag will cause any existing task that would be associated with the
3425 * activity to be cleared before the activity is started. That is, the activity
3426 * becomes the new root of an otherwise empty task, and any old activities
3427 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3428 */
3429 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3430 /**
3431 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3432 * this flag will cause a newly launching task to be placed on top of the current
3433 * home activity task (if there is one). That is, pressing back from the task
3434 * will always return the user to home even if that was not the last activity they
3435 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3436 */
3437 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3438 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003439 * If set, when sending a broadcast only registered receivers will be
3440 * called -- no BroadcastReceiver components will be launched.
3441 */
3442 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003443 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003444 * If set, when sending a broadcast the new broadcast will replace
3445 * any existing pending broadcast that matches it. Matching is defined
3446 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3447 * true for the intents of the two broadcasts. When a match is found,
3448 * the new broadcast (and receivers associated with it) will replace the
3449 * existing one in the pending broadcast list, remaining at the same
3450 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003451 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003452 * <p>This flag is most typically used with sticky broadcasts, which
3453 * only care about delivering the most recent values of the broadcast
3454 * to their receivers.
3455 */
3456 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3457 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003458 * If set, when sending a broadcast the recipient is allowed to run at
3459 * foreground priority, with a shorter timeout interval. During normal
3460 * broadcasts the receivers are not automatically hoisted out of the
3461 * background priority class.
3462 */
3463 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3464 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003465 * If set, when sending a broadcast <i>before boot has completed</i> only
3466 * registered receivers will be called -- no BroadcastReceiver components
3467 * will be launched. Sticky intent state will be recorded properly even
3468 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3469 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003470 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003471 * <p>This flag is only for use by system sevices as a convenience to
3472 * avoid having to implement a more complex mechanism around detection
3473 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003474 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003475 * @hide
3476 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003477 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003478 /**
3479 * Set when this broadcast is for a boot upgrade, a special mode that
3480 * allows the broadcast to be sent before the system is ready and launches
3481 * the app process with no providers running in it.
3482 * @hide
3483 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003484 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003485
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003486 /**
3487 * @hide Flags that can't be changed with PendingIntent.
3488 */
3489 public static final int IMMUTABLE_FLAGS =
3490 FLAG_GRANT_READ_URI_PERMISSION
3491 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003492
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003493 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003494 // ---------------------------------------------------------------------
3495 // toUri() and parseUri() options.
3496
3497 /**
3498 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3499 * always has the "intent:" scheme. This syntax can be used when you want
3500 * to later disambiguate between URIs that are intended to describe an
3501 * Intent vs. all others that should be treated as raw URIs. When used
3502 * with {@link #parseUri}, any other scheme will result in a generic
3503 * VIEW action for that raw URI.
3504 */
3505 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003506
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003507 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003508
3509 private String mAction;
3510 private Uri mData;
3511 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003512 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003513 private ComponentName mComponent;
3514 private int mFlags;
3515 private HashSet<String> mCategories;
3516 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003517 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003518 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003519 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003520
3521 // ---------------------------------------------------------------------
3522
3523 /**
3524 * Create an empty intent.
3525 */
3526 public Intent() {
3527 }
3528
3529 /**
3530 * Copy constructor.
3531 */
3532 public Intent(Intent o) {
3533 this.mAction = o.mAction;
3534 this.mData = o.mData;
3535 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003536 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003537 this.mComponent = o.mComponent;
3538 this.mFlags = o.mFlags;
3539 if (o.mCategories != null) {
3540 this.mCategories = new HashSet<String>(o.mCategories);
3541 }
3542 if (o.mExtras != null) {
3543 this.mExtras = new Bundle(o.mExtras);
3544 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003545 if (o.mSourceBounds != null) {
3546 this.mSourceBounds = new Rect(o.mSourceBounds);
3547 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003548 if (o.mSelector != null) {
3549 this.mSelector = new Intent(o.mSelector);
3550 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003551 if (o.mClipData != null) {
3552 this.mClipData = new ClipData(o.mClipData);
3553 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003554 }
3555
3556 @Override
3557 public Object clone() {
3558 return new Intent(this);
3559 }
3560
3561 private Intent(Intent o, boolean all) {
3562 this.mAction = o.mAction;
3563 this.mData = o.mData;
3564 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003565 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003566 this.mComponent = o.mComponent;
3567 if (o.mCategories != null) {
3568 this.mCategories = new HashSet<String>(o.mCategories);
3569 }
3570 }
3571
3572 /**
3573 * Make a clone of only the parts of the Intent that are relevant for
3574 * filter matching: the action, data, type, component, and categories.
3575 */
3576 public Intent cloneFilter() {
3577 return new Intent(this, false);
3578 }
3579
3580 /**
3581 * Create an intent with a given action. All other fields (data, type,
3582 * class) are null. Note that the action <em>must</em> be in a
3583 * namespace because Intents are used globally in the system -- for
3584 * example the system VIEW action is android.intent.action.VIEW; an
3585 * application's custom action would be something like
3586 * com.google.app.myapp.CUSTOM_ACTION.
3587 *
3588 * @param action The Intent action, such as ACTION_VIEW.
3589 */
3590 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003591 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003592 }
3593
3594 /**
3595 * Create an intent with a given action and for a given data url. Note
3596 * that the action <em>must</em> be in a namespace because Intents are
3597 * used globally in the system -- for example the system VIEW action is
3598 * android.intent.action.VIEW; an application's custom action would be
3599 * something like com.google.app.myapp.CUSTOM_ACTION.
3600 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003601 * <p><em>Note: scheme and host name matching in the Android framework is
3602 * case-sensitive, unlike the formal RFC. As a result,
3603 * you should always ensure that you write your Uri with these elements
3604 * using lower case letters, and normalize any Uris you receive from
3605 * outside of Android to ensure the scheme and host is lower case.</em></p>
3606 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003607 * @param action The Intent action, such as ACTION_VIEW.
3608 * @param uri The Intent data URI.
3609 */
3610 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003611 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003612 mData = uri;
3613 }
3614
3615 /**
3616 * Create an intent for a specific component. All other fields (action, data,
3617 * type, class) are null, though they can be modified later with explicit
3618 * calls. This provides a convenient way to create an intent that is
3619 * intended to execute a hard-coded class name, rather than relying on the
3620 * system to find an appropriate class for you; see {@link #setComponent}
3621 * for more information on the repercussions of this.
3622 *
3623 * @param packageContext A Context of the application package implementing
3624 * this class.
3625 * @param cls The component class that is to be used for the intent.
3626 *
3627 * @see #setClass
3628 * @see #setComponent
3629 * @see #Intent(String, android.net.Uri , Context, Class)
3630 */
3631 public Intent(Context packageContext, Class<?> cls) {
3632 mComponent = new ComponentName(packageContext, cls);
3633 }
3634
3635 /**
3636 * Create an intent for a specific component with a specified action and data.
3637 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3638 * construct the Intent and then calling {@link #setClass} to set its
3639 * class.
3640 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003641 * <p><em>Note: scheme and host name matching in the Android framework is
3642 * case-sensitive, unlike the formal RFC. As a result,
3643 * you should always ensure that you write your Uri with these elements
3644 * using lower case letters, and normalize any Uris you receive from
3645 * outside of Android to ensure the scheme and host is lower case.</em></p>
3646 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003647 * @param action The Intent action, such as ACTION_VIEW.
3648 * @param uri The Intent data URI.
3649 * @param packageContext A Context of the application package implementing
3650 * this class.
3651 * @param cls The component class that is to be used for the intent.
3652 *
3653 * @see #Intent(String, android.net.Uri)
3654 * @see #Intent(Context, Class)
3655 * @see #setClass
3656 * @see #setComponent
3657 */
3658 public Intent(String action, Uri uri,
3659 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003660 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003661 mData = uri;
3662 mComponent = new ComponentName(packageContext, cls);
3663 }
3664
3665 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003666 * Create an intent to launch the main (root) activity of a task. This
3667 * is the Intent that is started when the application's is launched from
3668 * Home. For anything else that wants to launch an application in the
3669 * same way, it is important that they use an Intent structured the same
3670 * way, and can use this function to ensure this is the case.
3671 *
3672 * <p>The returned Intent has the given Activity component as its explicit
3673 * component, {@link #ACTION_MAIN} as its action, and includes the
3674 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3675 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3676 * to do that through {@link #addFlags(int)} on the returned Intent.
3677 *
3678 * @param mainActivity The main activity component that this Intent will
3679 * launch.
3680 * @return Returns a newly created Intent that can be used to launch the
3681 * activity as a main application entry.
3682 *
3683 * @see #setClass
3684 * @see #setComponent
3685 */
3686 public static Intent makeMainActivity(ComponentName mainActivity) {
3687 Intent intent = new Intent(ACTION_MAIN);
3688 intent.setComponent(mainActivity);
3689 intent.addCategory(CATEGORY_LAUNCHER);
3690 return intent;
3691 }
3692
3693 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003694 * Make an Intent for the main activity of an application, without
3695 * specifying a specific activity to run but giving a selector to find
3696 * the activity. This results in a final Intent that is structured
3697 * the same as when the application is launched from
3698 * Home. For anything else that wants to launch an application in the
3699 * same way, it is important that they use an Intent structured the same
3700 * way, and can use this function to ensure this is the case.
3701 *
3702 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3703 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3704 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3705 * to do that through {@link #addFlags(int)} on the returned Intent.
3706 *
3707 * @param selectorAction The action name of the Intent's selector.
3708 * @param selectorCategory The name of a category to add to the Intent's
3709 * selector.
3710 * @return Returns a newly created Intent that can be used to launch the
3711 * activity as a main application entry.
3712 *
3713 * @see #setSelector(Intent)
3714 */
3715 public static Intent makeMainSelectorActivity(String selectorAction,
3716 String selectorCategory) {
3717 Intent intent = new Intent(ACTION_MAIN);
3718 intent.addCategory(CATEGORY_LAUNCHER);
3719 Intent selector = new Intent();
3720 selector.setAction(selectorAction);
3721 selector.addCategory(selectorCategory);
3722 intent.setSelector(selector);
3723 return intent;
3724 }
3725
3726 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003727 * Make an Intent that can be used to re-launch an application's task
3728 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3729 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3730 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3731 *
3732 * @param mainActivity The activity component that is the root of the
3733 * task; this is the activity that has been published in the application's
3734 * manifest as the main launcher icon.
3735 *
3736 * @return Returns a newly created Intent that can be used to relaunch the
3737 * activity's task in its root state.
3738 */
3739 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3740 Intent intent = makeMainActivity(mainActivity);
3741 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3742 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3743 return intent;
3744 }
3745
3746 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003747 * Call {@link #parseUri} with 0 flags.
3748 * @deprecated Use {@link #parseUri} instead.
3749 */
3750 @Deprecated
3751 public static Intent getIntent(String uri) throws URISyntaxException {
3752 return parseUri(uri, 0);
3753 }
Tom Taylord4a47292009-12-21 13:59:18 -08003754
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003755 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003756 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003757 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003758 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003759 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003760 *
3761 * <p>The URI given here must not be relative -- that is, it must include
3762 * the scheme and full path.
3763 *
3764 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003765 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003766 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003767 *
3768 * @return Intent The newly created Intent object.
3769 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003770 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3771 * it bad (as parsed by the Uri class) or the Intent data within the
3772 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003773 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003774 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003775 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003776 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003777 int i = 0;
3778 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003779 // Validate intent scheme for if requested.
3780 if ((flags&URI_INTENT_SCHEME) != 0) {
3781 if (!uri.startsWith("intent:")) {
3782 Intent intent = new Intent(ACTION_VIEW);
3783 try {
3784 intent.setData(Uri.parse(uri));
3785 } catch (IllegalArgumentException e) {
3786 throw new URISyntaxException(uri, e.getMessage());
3787 }
3788 return intent;
3789 }
3790 }
Tom Taylord4a47292009-12-21 13:59:18 -08003791
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003792 // simple case
3793 i = uri.lastIndexOf("#");
3794 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3795
3796 // old format Intent URI
3797 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003798
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003799 // new format
3800 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003801 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003802
3803 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003804 String data = i >= 0 ? uri.substring(0, i) : null;
3805 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003806 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003807
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003808 // loop over contents of Intent, all name=value;
3809 while (!uri.startsWith("end", i)) {
3810 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003811 if (eq < 0) eq = i-1;
3812 int semi = uri.indexOf(';', i);
3813 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003814
3815 // action
3816 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003817 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003818 }
3819
3820 // categories
3821 else if (uri.startsWith("category=", i)) {
3822 intent.addCategory(value);
3823 }
3824
3825 // type
3826 else if (uri.startsWith("type=", i)) {
3827 intent.mType = value;
3828 }
3829
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003830 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003831 else if (uri.startsWith("launchFlags=", i)) {
3832 intent.mFlags = Integer.decode(value).intValue();
3833 }
3834
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003835 // package
3836 else if (uri.startsWith("package=", i)) {
3837 intent.mPackage = value;
3838 }
3839
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003840 // component
3841 else if (uri.startsWith("component=", i)) {
3842 intent.mComponent = ComponentName.unflattenFromString(value);
3843 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003844
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003845 // scheme
3846 else if (uri.startsWith("scheme=", i)) {
3847 scheme = value;
3848 }
3849
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003850 // source bounds
3851 else if (uri.startsWith("sourceBounds=", i)) {
3852 intent.mSourceBounds = Rect.unflattenFromString(value);
3853 }
3854
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003855 // selector
3856 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3857 intent = new Intent();
3858 }
3859
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003860 // extra
3861 else {
3862 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003863 // create Bundle if it doesn't already exist
3864 if (intent.mExtras == null) intent.mExtras = new Bundle();
3865 Bundle b = intent.mExtras;
3866 // add EXTRA
3867 if (uri.startsWith("S.", i)) b.putString(key, value);
3868 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3869 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3870 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3871 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3872 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3873 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3874 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3875 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3876 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3877 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003879 // move to the next item
3880 i = semi + 1;
3881 }
3882
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003883 if (intent != baseIntent) {
3884 // The Intent had a selector; fix it up.
3885 baseIntent.setSelector(intent);
3886 intent = baseIntent;
3887 }
3888
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003889 if (data != null) {
3890 if (data.startsWith("intent:")) {
3891 data = data.substring(7);
3892 if (scheme != null) {
3893 data = scheme + ':' + data;
3894 }
3895 }
Tom Taylord4a47292009-12-21 13:59:18 -08003896
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003897 if (data.length() > 0) {
3898 try {
3899 intent.mData = Uri.parse(data);
3900 } catch (IllegalArgumentException e) {
3901 throw new URISyntaxException(uri, e.getMessage());
3902 }
3903 }
3904 }
Tom Taylord4a47292009-12-21 13:59:18 -08003905
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003906 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003907
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003908 } catch (IndexOutOfBoundsException e) {
3909 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3910 }
3911 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003912
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003913 public static Intent getIntentOld(String uri) throws URISyntaxException {
3914 Intent intent;
3915
3916 int i = uri.lastIndexOf('#');
3917 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003918 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003919 final int intentFragmentStart = i;
3920 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003921
3922 i++;
3923
3924 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003925 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003926 i += 7;
3927 int j = uri.indexOf(')', i);
3928 action = uri.substring(i, j);
3929 i = j + 1;
3930 }
3931
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003932 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003933
3934 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003935 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003936 i += 11;
3937 int j = uri.indexOf(')', i);
3938 while (i < j) {
3939 int sep = uri.indexOf('!', i);
3940 if (sep < 0) sep = j;
3941 if (i < sep) {
3942 intent.addCategory(uri.substring(i, sep));
3943 }
3944 i = sep + 1;
3945 }
3946 i = j + 1;
3947 }
3948
3949 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003950 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003951 i += 5;
3952 int j = uri.indexOf(')', i);
3953 intent.mType = uri.substring(i, j);
3954 i = j + 1;
3955 }
3956
3957 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003958 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003959 i += 12;
3960 int j = uri.indexOf(')', i);
3961 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3962 i = j + 1;
3963 }
3964
3965 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003966 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003967 i += 10;
3968 int j = uri.indexOf(')', i);
3969 int sep = uri.indexOf('!', i);
3970 if (sep >= 0 && sep < j) {
3971 String pkg = uri.substring(i, sep);
3972 String cls = uri.substring(sep + 1, j);
3973 intent.mComponent = new ComponentName(pkg, cls);
3974 }
3975 i = j + 1;
3976 }
3977
3978 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003979 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003980 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003981
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003982 final int closeParen = uri.indexOf(')', i);
3983 if (closeParen == -1) throw new URISyntaxException(uri,
3984 "EXTRA missing trailing ')'", i);
3985
3986 while (i < closeParen) {
3987 // fetch the key value
3988 int j = uri.indexOf('=', i);
3989 if (j <= i + 1 || i >= closeParen) {
3990 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3991 }
3992 char type = uri.charAt(i);
3993 i++;
3994 String key = uri.substring(i, j);
3995 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003996
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003997 // get type-value
3998 j = uri.indexOf('!', i);
3999 if (j == -1 || j >= closeParen) j = closeParen;
4000 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4001 String value = uri.substring(i, j);
4002 i = j;
4003
4004 // create Bundle if it doesn't already exist
4005 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004006
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004007 // add item to bundle
4008 try {
4009 switch (type) {
4010 case 'S':
4011 intent.mExtras.putString(key, Uri.decode(value));
4012 break;
4013 case 'B':
4014 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4015 break;
4016 case 'b':
4017 intent.mExtras.putByte(key, Byte.parseByte(value));
4018 break;
4019 case 'c':
4020 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4021 break;
4022 case 'd':
4023 intent.mExtras.putDouble(key, Double.parseDouble(value));
4024 break;
4025 case 'f':
4026 intent.mExtras.putFloat(key, Float.parseFloat(value));
4027 break;
4028 case 'i':
4029 intent.mExtras.putInt(key, Integer.parseInt(value));
4030 break;
4031 case 'l':
4032 intent.mExtras.putLong(key, Long.parseLong(value));
4033 break;
4034 case 's':
4035 intent.mExtras.putShort(key, Short.parseShort(value));
4036 break;
4037 default:
4038 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4039 }
4040 } catch (NumberFormatException e) {
4041 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4042 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004043
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004044 char ch = uri.charAt(i);
4045 if (ch == ')') break;
4046 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4047 i++;
4048 }
4049 }
4050
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004051 if (isIntentFragment) {
4052 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4053 } else {
4054 intent.mData = Uri.parse(uri);
4055 }
Tom Taylord4a47292009-12-21 13:59:18 -08004056
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004057 if (intent.mAction == null) {
4058 // By default, if no action is specified, then use VIEW.
4059 intent.mAction = ACTION_VIEW;
4060 }
4061
4062 } else {
4063 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4064 }
4065
4066 return intent;
4067 }
4068
4069 /**
4070 * Retrieve the general action to be performed, such as
4071 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4072 * the information in the intent should be interpreted -- most importantly,
4073 * what to do with the data returned by {@link #getData}.
4074 *
4075 * @return The action of this intent or null if none is specified.
4076 *
4077 * @see #setAction
4078 */
4079 public String getAction() {
4080 return mAction;
4081 }
4082
4083 /**
4084 * Retrieve data this intent is operating on. This URI specifies the name
4085 * of the data; often it uses the content: scheme, specifying data in a
4086 * content provider. Other schemes may be handled by specific activities,
4087 * such as http: by the web browser.
4088 *
4089 * @return The URI of the data this intent is targeting or null.
4090 *
4091 * @see #getScheme
4092 * @see #setData
4093 */
4094 public Uri getData() {
4095 return mData;
4096 }
4097
4098 /**
4099 * The same as {@link #getData()}, but returns the URI as an encoded
4100 * String.
4101 */
4102 public String getDataString() {
4103 return mData != null ? mData.toString() : null;
4104 }
4105
4106 /**
4107 * Return the scheme portion of the intent's data. If the data is null or
4108 * does not include a scheme, null is returned. Otherwise, the scheme
4109 * prefix without the final ':' is returned, i.e. "http".
4110 *
4111 * <p>This is the same as calling getData().getScheme() (and checking for
4112 * null data).
4113 *
4114 * @return The scheme of this intent.
4115 *
4116 * @see #getData
4117 */
4118 public String getScheme() {
4119 return mData != null ? mData.getScheme() : null;
4120 }
4121
4122 /**
4123 * Retrieve any explicit MIME type included in the intent. This is usually
4124 * null, as the type is determined by the intent data.
4125 *
4126 * @return If a type was manually set, it is returned; else null is
4127 * returned.
4128 *
4129 * @see #resolveType(ContentResolver)
4130 * @see #setType
4131 */
4132 public String getType() {
4133 return mType;
4134 }
4135
4136 /**
4137 * Return the MIME data type of this intent. If the type field is
4138 * explicitly set, that is simply returned. Otherwise, if the data is set,
4139 * the type of that data is returned. If neither fields are set, a null is
4140 * returned.
4141 *
4142 * @return The MIME type of this intent.
4143 *
4144 * @see #getType
4145 * @see #resolveType(ContentResolver)
4146 */
4147 public String resolveType(Context context) {
4148 return resolveType(context.getContentResolver());
4149 }
4150
4151 /**
4152 * Return the MIME data type of this intent. If the type field is
4153 * explicitly set, that is simply returned. Otherwise, if the data is set,
4154 * the type of that data is returned. If neither fields are set, a null is
4155 * returned.
4156 *
4157 * @param resolver A ContentResolver that can be used to determine the MIME
4158 * type of the intent's data.
4159 *
4160 * @return The MIME type of this intent.
4161 *
4162 * @see #getType
4163 * @see #resolveType(Context)
4164 */
4165 public String resolveType(ContentResolver resolver) {
4166 if (mType != null) {
4167 return mType;
4168 }
4169 if (mData != null) {
4170 if ("content".equals(mData.getScheme())) {
4171 return resolver.getType(mData);
4172 }
4173 }
4174 return null;
4175 }
4176
4177 /**
4178 * Return the MIME data type of this intent, only if it will be needed for
4179 * intent resolution. This is not generally useful for application code;
4180 * it is used by the frameworks for communicating with back-end system
4181 * services.
4182 *
4183 * @param resolver A ContentResolver that can be used to determine the MIME
4184 * type of the intent's data.
4185 *
4186 * @return The MIME type of this intent, or null if it is unknown or not
4187 * needed.
4188 */
4189 public String resolveTypeIfNeeded(ContentResolver resolver) {
4190 if (mComponent != null) {
4191 return mType;
4192 }
4193 return resolveType(resolver);
4194 }
4195
4196 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004197 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004198 *
4199 * @param category The category to check.
4200 *
4201 * @return boolean True if the intent contains the category, else false.
4202 *
4203 * @see #getCategories
4204 * @see #addCategory
4205 */
4206 public boolean hasCategory(String category) {
4207 return mCategories != null && mCategories.contains(category);
4208 }
4209
4210 /**
4211 * Return the set of all categories in the intent. If there are no categories,
4212 * returns NULL.
4213 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004214 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004215 *
4216 * @see #hasCategory
4217 * @see #addCategory
4218 */
4219 public Set<String> getCategories() {
4220 return mCategories;
4221 }
4222
4223 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004224 * Return the specific selector associated with this Intent. If there is
4225 * none, returns null. See {@link #setSelector} for more information.
4226 *
4227 * @see #setSelector
4228 */
4229 public Intent getSelector() {
4230 return mSelector;
4231 }
4232
4233 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004234 * Return the {@link ClipData} associated with this Intent. If there is
4235 * none, returns null. See {@link #setClipData} for more information.
4236 *
4237 * @see #setClipData;
4238 */
4239 public ClipData getClipData() {
4240 return mClipData;
4241 }
4242
4243 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004244 * Sets the ClassLoader that will be used when unmarshalling
4245 * any Parcelable values from the extras of this Intent.
4246 *
4247 * @param loader a ClassLoader, or null to use the default loader
4248 * at the time of unmarshalling.
4249 */
4250 public void setExtrasClassLoader(ClassLoader loader) {
4251 if (mExtras != null) {
4252 mExtras.setClassLoader(loader);
4253 }
4254 }
4255
4256 /**
4257 * Returns true if an extra value is associated with the given name.
4258 * @param name the extra's name
4259 * @return true if the given extra is present.
4260 */
4261 public boolean hasExtra(String name) {
4262 return mExtras != null && mExtras.containsKey(name);
4263 }
4264
4265 /**
4266 * Returns true if the Intent's extras contain a parcelled file descriptor.
4267 * @return true if the Intent contains a parcelled file descriptor.
4268 */
4269 public boolean hasFileDescriptors() {
4270 return mExtras != null && mExtras.hasFileDescriptors();
4271 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004272
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004273 /** @hide */
4274 public void setAllowFds(boolean allowFds) {
4275 if (mExtras != null) {
4276 mExtras.setAllowFds(allowFds);
4277 }
4278 }
4279
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004280 /**
4281 * Retrieve extended data from the intent.
4282 *
4283 * @param name The name of the desired item.
4284 *
4285 * @return the value of an item that previously added with putExtra()
4286 * or null if none was found.
4287 *
4288 * @deprecated
4289 * @hide
4290 */
4291 @Deprecated
4292 public Object getExtra(String name) {
4293 return getExtra(name, null);
4294 }
4295
4296 /**
4297 * Retrieve extended data from the intent.
4298 *
4299 * @param name The name of the desired item.
4300 * @param defaultValue the value to be returned if no value of the desired
4301 * type is stored with the given name.
4302 *
4303 * @return the value of an item that previously added with putExtra()
4304 * or the default value if none was found.
4305 *
4306 * @see #putExtra(String, boolean)
4307 */
4308 public boolean getBooleanExtra(String name, boolean defaultValue) {
4309 return mExtras == null ? defaultValue :
4310 mExtras.getBoolean(name, defaultValue);
4311 }
4312
4313 /**
4314 * Retrieve extended data from the intent.
4315 *
4316 * @param name The name of the desired item.
4317 * @param defaultValue the value to be returned if no value of the desired
4318 * type is stored with the given name.
4319 *
4320 * @return the value of an item that previously added with putExtra()
4321 * or the default value if none was found.
4322 *
4323 * @see #putExtra(String, byte)
4324 */
4325 public byte getByteExtra(String name, byte defaultValue) {
4326 return mExtras == null ? defaultValue :
4327 mExtras.getByte(name, defaultValue);
4328 }
4329
4330 /**
4331 * Retrieve extended data from the intent.
4332 *
4333 * @param name The name of the desired item.
4334 * @param defaultValue the value to be returned if no value of the desired
4335 * type is stored with the given name.
4336 *
4337 * @return the value of an item that previously added with putExtra()
4338 * or the default value if none was found.
4339 *
4340 * @see #putExtra(String, short)
4341 */
4342 public short getShortExtra(String name, short defaultValue) {
4343 return mExtras == null ? defaultValue :
4344 mExtras.getShort(name, defaultValue);
4345 }
4346
4347 /**
4348 * Retrieve extended data from the intent.
4349 *
4350 * @param name The name of the desired item.
4351 * @param defaultValue the value to be returned if no value of the desired
4352 * type is stored with the given name.
4353 *
4354 * @return the value of an item that previously added with putExtra()
4355 * or the default value if none was found.
4356 *
4357 * @see #putExtra(String, char)
4358 */
4359 public char getCharExtra(String name, char defaultValue) {
4360 return mExtras == null ? defaultValue :
4361 mExtras.getChar(name, defaultValue);
4362 }
4363
4364 /**
4365 * Retrieve extended data from the intent.
4366 *
4367 * @param name The name of the desired item.
4368 * @param defaultValue the value to be returned if no value of the desired
4369 * type is stored with the given name.
4370 *
4371 * @return the value of an item that previously added with putExtra()
4372 * or the default value if none was found.
4373 *
4374 * @see #putExtra(String, int)
4375 */
4376 public int getIntExtra(String name, int defaultValue) {
4377 return mExtras == null ? defaultValue :
4378 mExtras.getInt(name, defaultValue);
4379 }
4380
4381 /**
4382 * Retrieve extended data from the intent.
4383 *
4384 * @param name The name of the desired item.
4385 * @param defaultValue the value to be returned if no value of the desired
4386 * type is stored with the given name.
4387 *
4388 * @return the value of an item that previously added with putExtra()
4389 * or the default value if none was found.
4390 *
4391 * @see #putExtra(String, long)
4392 */
4393 public long getLongExtra(String name, long defaultValue) {
4394 return mExtras == null ? defaultValue :
4395 mExtras.getLong(name, defaultValue);
4396 }
4397
4398 /**
4399 * Retrieve extended data from the intent.
4400 *
4401 * @param name The name of the desired item.
4402 * @param defaultValue the value to be returned if no value of the desired
4403 * type is stored with the given name.
4404 *
4405 * @return the value of an item that previously added with putExtra(),
4406 * or the default value if no such item is present
4407 *
4408 * @see #putExtra(String, float)
4409 */
4410 public float getFloatExtra(String name, float defaultValue) {
4411 return mExtras == null ? defaultValue :
4412 mExtras.getFloat(name, defaultValue);
4413 }
4414
4415 /**
4416 * Retrieve extended data from the intent.
4417 *
4418 * @param name The name of the desired item.
4419 * @param defaultValue the value to be returned if no value of the desired
4420 * type is stored with the given name.
4421 *
4422 * @return the value of an item that previously added with putExtra()
4423 * or the default value if none was found.
4424 *
4425 * @see #putExtra(String, double)
4426 */
4427 public double getDoubleExtra(String name, double defaultValue) {
4428 return mExtras == null ? defaultValue :
4429 mExtras.getDouble(name, defaultValue);
4430 }
4431
4432 /**
4433 * Retrieve extended data from the intent.
4434 *
4435 * @param name The name of the desired item.
4436 *
4437 * @return the value of an item that previously added with putExtra()
4438 * or null if no String value was found.
4439 *
4440 * @see #putExtra(String, String)
4441 */
4442 public String getStringExtra(String name) {
4443 return mExtras == null ? null : mExtras.getString(name);
4444 }
4445
4446 /**
4447 * Retrieve extended data from the intent.
4448 *
4449 * @param name The name of the desired item.
4450 *
4451 * @return the value of an item that previously added with putExtra()
4452 * or null if no CharSequence value was found.
4453 *
4454 * @see #putExtra(String, CharSequence)
4455 */
4456 public CharSequence getCharSequenceExtra(String name) {
4457 return mExtras == null ? null : mExtras.getCharSequence(name);
4458 }
4459
4460 /**
4461 * Retrieve extended data from the intent.
4462 *
4463 * @param name The name of the desired item.
4464 *
4465 * @return the value of an item that previously added with putExtra()
4466 * or null if no Parcelable value was found.
4467 *
4468 * @see #putExtra(String, Parcelable)
4469 */
4470 public <T extends Parcelable> T getParcelableExtra(String name) {
4471 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4472 }
4473
4474 /**
4475 * Retrieve extended data from the intent.
4476 *
4477 * @param name The name of the desired item.
4478 *
4479 * @return the value of an item that previously added with putExtra()
4480 * or null if no Parcelable[] value was found.
4481 *
4482 * @see #putExtra(String, Parcelable[])
4483 */
4484 public Parcelable[] getParcelableArrayExtra(String name) {
4485 return mExtras == null ? null : mExtras.getParcelableArray(name);
4486 }
4487
4488 /**
4489 * Retrieve extended data from the intent.
4490 *
4491 * @param name The name of the desired item.
4492 *
4493 * @return the value of an item that previously added with putExtra()
4494 * or null if no ArrayList<Parcelable> value was found.
4495 *
4496 * @see #putParcelableArrayListExtra(String, ArrayList)
4497 */
4498 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4499 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4500 }
4501
4502 /**
4503 * Retrieve extended data from the intent.
4504 *
4505 * @param name The name of the desired item.
4506 *
4507 * @return the value of an item that previously added with putExtra()
4508 * or null if no Serializable value was found.
4509 *
4510 * @see #putExtra(String, Serializable)
4511 */
4512 public Serializable getSerializableExtra(String name) {
4513 return mExtras == null ? null : mExtras.getSerializable(name);
4514 }
4515
4516 /**
4517 * Retrieve extended data from the intent.
4518 *
4519 * @param name The name of the desired item.
4520 *
4521 * @return the value of an item that previously added with putExtra()
4522 * or null if no ArrayList<Integer> value was found.
4523 *
4524 * @see #putIntegerArrayListExtra(String, ArrayList)
4525 */
4526 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4527 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4528 }
4529
4530 /**
4531 * Retrieve extended data from the intent.
4532 *
4533 * @param name The name of the desired item.
4534 *
4535 * @return the value of an item that previously added with putExtra()
4536 * or null if no ArrayList<String> value was found.
4537 *
4538 * @see #putStringArrayListExtra(String, ArrayList)
4539 */
4540 public ArrayList<String> getStringArrayListExtra(String name) {
4541 return mExtras == null ? null : mExtras.getStringArrayList(name);
4542 }
4543
4544 /**
4545 * Retrieve extended data from the intent.
4546 *
4547 * @param name The name of the desired item.
4548 *
4549 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004550 * or null if no ArrayList<CharSequence> value was found.
4551 *
4552 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4553 */
4554 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4555 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4556 }
4557
4558 /**
4559 * Retrieve extended data from the intent.
4560 *
4561 * @param name The name of the desired item.
4562 *
4563 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004564 * or null if no boolean array value was found.
4565 *
4566 * @see #putExtra(String, boolean[])
4567 */
4568 public boolean[] getBooleanArrayExtra(String name) {
4569 return mExtras == null ? null : mExtras.getBooleanArray(name);
4570 }
4571
4572 /**
4573 * Retrieve extended data from the intent.
4574 *
4575 * @param name The name of the desired item.
4576 *
4577 * @return the value of an item that previously added with putExtra()
4578 * or null if no byte array value was found.
4579 *
4580 * @see #putExtra(String, byte[])
4581 */
4582 public byte[] getByteArrayExtra(String name) {
4583 return mExtras == null ? null : mExtras.getByteArray(name);
4584 }
4585
4586 /**
4587 * Retrieve extended data from the intent.
4588 *
4589 * @param name The name of the desired item.
4590 *
4591 * @return the value of an item that previously added with putExtra()
4592 * or null if no short array value was found.
4593 *
4594 * @see #putExtra(String, short[])
4595 */
4596 public short[] getShortArrayExtra(String name) {
4597 return mExtras == null ? null : mExtras.getShortArray(name);
4598 }
4599
4600 /**
4601 * Retrieve extended data from the intent.
4602 *
4603 * @param name The name of the desired item.
4604 *
4605 * @return the value of an item that previously added with putExtra()
4606 * or null if no char array value was found.
4607 *
4608 * @see #putExtra(String, char[])
4609 */
4610 public char[] getCharArrayExtra(String name) {
4611 return mExtras == null ? null : mExtras.getCharArray(name);
4612 }
4613
4614 /**
4615 * Retrieve extended data from the intent.
4616 *
4617 * @param name The name of the desired item.
4618 *
4619 * @return the value of an item that previously added with putExtra()
4620 * or null if no int array value was found.
4621 *
4622 * @see #putExtra(String, int[])
4623 */
4624 public int[] getIntArrayExtra(String name) {
4625 return mExtras == null ? null : mExtras.getIntArray(name);
4626 }
4627
4628 /**
4629 * Retrieve extended data from the intent.
4630 *
4631 * @param name The name of the desired item.
4632 *
4633 * @return the value of an item that previously added with putExtra()
4634 * or null if no long array value was found.
4635 *
4636 * @see #putExtra(String, long[])
4637 */
4638 public long[] getLongArrayExtra(String name) {
4639 return mExtras == null ? null : mExtras.getLongArray(name);
4640 }
4641
4642 /**
4643 * Retrieve extended data from the intent.
4644 *
4645 * @param name The name of the desired item.
4646 *
4647 * @return the value of an item that previously added with putExtra()
4648 * or null if no float array value was found.
4649 *
4650 * @see #putExtra(String, float[])
4651 */
4652 public float[] getFloatArrayExtra(String name) {
4653 return mExtras == null ? null : mExtras.getFloatArray(name);
4654 }
4655
4656 /**
4657 * Retrieve extended data from the intent.
4658 *
4659 * @param name The name of the desired item.
4660 *
4661 * @return the value of an item that previously added with putExtra()
4662 * or null if no double array value was found.
4663 *
4664 * @see #putExtra(String, double[])
4665 */
4666 public double[] getDoubleArrayExtra(String name) {
4667 return mExtras == null ? null : mExtras.getDoubleArray(name);
4668 }
4669
4670 /**
4671 * Retrieve extended data from the intent.
4672 *
4673 * @param name The name of the desired item.
4674 *
4675 * @return the value of an item that previously added with putExtra()
4676 * or null if no String array value was found.
4677 *
4678 * @see #putExtra(String, String[])
4679 */
4680 public String[] getStringArrayExtra(String name) {
4681 return mExtras == null ? null : mExtras.getStringArray(name);
4682 }
4683
4684 /**
4685 * Retrieve extended data from the intent.
4686 *
4687 * @param name The name of the desired item.
4688 *
4689 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004690 * or null if no CharSequence array value was found.
4691 *
4692 * @see #putExtra(String, CharSequence[])
4693 */
4694 public CharSequence[] getCharSequenceArrayExtra(String name) {
4695 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4696 }
4697
4698 /**
4699 * Retrieve extended data from the intent.
4700 *
4701 * @param name The name of the desired item.
4702 *
4703 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004704 * or null if no Bundle value was found.
4705 *
4706 * @see #putExtra(String, Bundle)
4707 */
4708 public Bundle getBundleExtra(String name) {
4709 return mExtras == null ? null : mExtras.getBundle(name);
4710 }
4711
4712 /**
4713 * Retrieve extended data from the intent.
4714 *
4715 * @param name The name of the desired item.
4716 *
4717 * @return the value of an item that previously added with putExtra()
4718 * or null if no IBinder value was found.
4719 *
4720 * @see #putExtra(String, IBinder)
4721 *
4722 * @deprecated
4723 * @hide
4724 */
4725 @Deprecated
4726 public IBinder getIBinderExtra(String name) {
4727 return mExtras == null ? null : mExtras.getIBinder(name);
4728 }
4729
4730 /**
4731 * Retrieve extended data from the intent.
4732 *
4733 * @param name The name of the desired item.
4734 * @param defaultValue The default value to return in case no item is
4735 * associated with the key 'name'
4736 *
4737 * @return the value of an item that previously added with putExtra()
4738 * or defaultValue if none was found.
4739 *
4740 * @see #putExtra
4741 *
4742 * @deprecated
4743 * @hide
4744 */
4745 @Deprecated
4746 public Object getExtra(String name, Object defaultValue) {
4747 Object result = defaultValue;
4748 if (mExtras != null) {
4749 Object result2 = mExtras.get(name);
4750 if (result2 != null) {
4751 result = result2;
4752 }
4753 }
4754
4755 return result;
4756 }
4757
4758 /**
4759 * Retrieves a map of extended data from the intent.
4760 *
4761 * @return the map of all extras previously added with putExtra(),
4762 * or null if none have been added.
4763 */
4764 public Bundle getExtras() {
4765 return (mExtras != null)
4766 ? new Bundle(mExtras)
4767 : null;
4768 }
4769
4770 /**
4771 * Retrieve any special flags associated with this intent. You will
4772 * normally just set them with {@link #setFlags} and let the system
4773 * take the appropriate action with them.
4774 *
4775 * @return int The currently set flags.
4776 *
4777 * @see #setFlags
4778 */
4779 public int getFlags() {
4780 return mFlags;
4781 }
4782
Dianne Hackborne7f97212011-02-24 14:40:20 -08004783 /** @hide */
4784 public boolean isExcludingStopped() {
4785 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4786 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4787 }
4788
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004789 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004790 * Retrieve the application package name this Intent is limited to. When
4791 * resolving an Intent, if non-null this limits the resolution to only
4792 * components in the given application package.
4793 *
4794 * @return The name of the application package for the Intent.
4795 *
4796 * @see #resolveActivity
4797 * @see #setPackage
4798 */
4799 public String getPackage() {
4800 return mPackage;
4801 }
4802
4803 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004804 * Retrieve the concrete component associated with the intent. When receiving
4805 * an intent, this is the component that was found to best handle it (that is,
4806 * yourself) and will always be non-null; in all other cases it will be
4807 * null unless explicitly set.
4808 *
4809 * @return The name of the application component to handle the intent.
4810 *
4811 * @see #resolveActivity
4812 * @see #setComponent
4813 */
4814 public ComponentName getComponent() {
4815 return mComponent;
4816 }
4817
4818 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004819 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4820 * used as a hint to the receiver for animations and the like. Null means that there
4821 * is no source bounds.
4822 */
4823 public Rect getSourceBounds() {
4824 return mSourceBounds;
4825 }
4826
4827 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004828 * Return the Activity component that should be used to handle this intent.
4829 * The appropriate component is determined based on the information in the
4830 * intent, evaluated as follows:
4831 *
4832 * <p>If {@link #getComponent} returns an explicit class, that is returned
4833 * without any further consideration.
4834 *
4835 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4836 * category to be considered.
4837 *
4838 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4839 * action.
4840 *
4841 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4842 * this type.
4843 *
4844 * <p>If {@link #addCategory} has added any categories, the activity must
4845 * handle ALL of the categories specified.
4846 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004847 * <p>If {@link #getPackage} is non-NULL, only activity components in
4848 * that application package will be considered.
4849 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004850 * <p>If there are no activities that satisfy all of these conditions, a
4851 * null string is returned.
4852 *
4853 * <p>If multiple activities are found to satisfy the intent, the one with
4854 * the highest priority will be used. If there are multiple activities
4855 * with the same priority, the system will either pick the best activity
4856 * based on user preference, or resolve to a system class that will allow
4857 * the user to pick an activity and forward from there.
4858 *
4859 * <p>This method is implemented simply by calling
4860 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4861 * true.</p>
4862 * <p> This API is called for you as part of starting an activity from an
4863 * intent. You do not normally need to call it yourself.</p>
4864 *
4865 * @param pm The package manager with which to resolve the Intent.
4866 *
4867 * @return Name of the component implementing an activity that can
4868 * display the intent.
4869 *
4870 * @see #setComponent
4871 * @see #getComponent
4872 * @see #resolveActivityInfo
4873 */
4874 public ComponentName resolveActivity(PackageManager pm) {
4875 if (mComponent != null) {
4876 return mComponent;
4877 }
4878
4879 ResolveInfo info = pm.resolveActivity(
4880 this, PackageManager.MATCH_DEFAULT_ONLY);
4881 if (info != null) {
4882 return new ComponentName(
4883 info.activityInfo.applicationInfo.packageName,
4884 info.activityInfo.name);
4885 }
4886
4887 return null;
4888 }
4889
4890 /**
4891 * Resolve the Intent into an {@link ActivityInfo}
4892 * describing the activity that should execute the intent. Resolution
4893 * follows the same rules as described for {@link #resolveActivity}, but
4894 * you get back the completely information about the resolved activity
4895 * instead of just its class name.
4896 *
4897 * @param pm The package manager with which to resolve the Intent.
4898 * @param flags Addition information to retrieve as per
4899 * {@link PackageManager#getActivityInfo(ComponentName, int)
4900 * PackageManager.getActivityInfo()}.
4901 *
4902 * @return PackageManager.ActivityInfo
4903 *
4904 * @see #resolveActivity
4905 */
4906 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4907 ActivityInfo ai = null;
4908 if (mComponent != null) {
4909 try {
4910 ai = pm.getActivityInfo(mComponent, flags);
4911 } catch (PackageManager.NameNotFoundException e) {
4912 // ignore
4913 }
4914 } else {
4915 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004916 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004917 if (info != null) {
4918 ai = info.activityInfo;
4919 }
4920 }
4921
4922 return ai;
4923 }
4924
4925 /**
4926 * Set the general action to be performed.
4927 *
4928 * @param action An action name, such as ACTION_VIEW. Application-specific
4929 * actions should be prefixed with the vendor's package name.
4930 *
4931 * @return Returns the same Intent object, for chaining multiple calls
4932 * into a single statement.
4933 *
4934 * @see #getAction
4935 */
4936 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004937 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004938 return this;
4939 }
4940
4941 /**
4942 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004943 * clears any type that was previously set by {@link #setType} or
4944 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004945 *
Nick Pellyccae4122012-01-09 14:12:58 -08004946 * <p><em>Note: scheme matching in the Android framework is
4947 * case-sensitive, unlike the formal RFC. As a result,
4948 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004949 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004950 * {@link #setDataAndNormalize}
4951 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004952 *
Nick Pellyccae4122012-01-09 14:12:58 -08004953 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004954 *
4955 * @return Returns the same Intent object, for chaining multiple calls
4956 * into a single statement.
4957 *
4958 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004959 * @see #setDataAndNormalize
4960 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004961 */
4962 public Intent setData(Uri data) {
4963 mData = data;
4964 mType = null;
4965 return this;
4966 }
4967
4968 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004969 * Normalize and set the data this intent is operating on.
4970 *
4971 * <p>This method automatically clears any type that was
4972 * previously set (for example, by {@link #setType}).
4973 *
4974 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004975 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004976 * so really this is just a convenience method for
4977 * <pre>
4978 * setData(data.normalize())
4979 * </pre>
4980 *
4981 * @param data The Uri of the data this intent is now targeting.
4982 *
4983 * @return Returns the same Intent object, for chaining multiple calls
4984 * into a single statement.
4985 *
4986 * @see #getData
4987 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004988 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004989 */
4990 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004991 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004992 }
4993
4994 /**
4995 * Set an explicit MIME data type.
4996 *
4997 * <p>This is used to create intents that only specify a type and not data,
4998 * for example to indicate the type of data to return.
4999 *
5000 * <p>This method automatically clears any data that was
5001 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005002 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005003 * <p><em>Note: MIME type matching in the Android framework is
5004 * case-sensitive, unlike formal RFC MIME types. As a result,
5005 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005006 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5007 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005008 *
5009 * @param type The MIME type of the data being handled by this intent.
5010 *
5011 * @return Returns the same Intent object, for chaining multiple calls
5012 * into a single statement.
5013 *
5014 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005015 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005016 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005017 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005018 */
5019 public Intent setType(String type) {
5020 mData = null;
5021 mType = type;
5022 return this;
5023 }
5024
5025 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005026 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005027 *
Nick Pellyccae4122012-01-09 14:12:58 -08005028 * <p>This is used to create intents that only specify a type and not data,
5029 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005030 *
Nick Pellyccae4122012-01-09 14:12:58 -08005031 * <p>This method automatically clears any data that was
5032 * previously set (for example by {@link #setData}).
5033 *
5034 * <p>The MIME type is normalized using
5035 * {@link #normalizeMimeType} before it is set,
5036 * so really this is just a convenience method for
5037 * <pre>
5038 * setType(Intent.normalizeMimeType(type))
5039 * </pre>
5040 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005041 * @param type The MIME type of the data being handled by this intent.
5042 *
5043 * @return Returns the same Intent object, for chaining multiple calls
5044 * into a single statement.
5045 *
Nick Pellyccae4122012-01-09 14:12:58 -08005046 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005047 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005048 * @see #normalizeMimeType
5049 */
5050 public Intent setTypeAndNormalize(String type) {
5051 return setType(normalizeMimeType(type));
5052 }
5053
5054 /**
5055 * (Usually optional) Set the data for the intent along with an explicit
5056 * MIME data type. This method should very rarely be used -- it allows you
5057 * to override the MIME type that would ordinarily be inferred from the
5058 * data with your own type given here.
5059 *
5060 * <p><em>Note: MIME type and Uri scheme matching in the
5061 * Android framework is case-sensitive, unlike the formal RFC definitions.
5062 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005063 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005064 * {@link #setDataAndTypeAndNormalize}
5065 * to ensure that they are converted to lower case.</em>
5066 *
5067 * @param data The Uri of the data this intent is now targeting.
5068 * @param type The MIME type of the data being handled by this intent.
5069 *
5070 * @return Returns the same Intent object, for chaining multiple calls
5071 * into a single statement.
5072 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005073 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005074 * @see #setData
5075 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005076 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005077 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005078 */
5079 public Intent setDataAndType(Uri data, String type) {
5080 mData = data;
5081 mType = type;
5082 return this;
5083 }
5084
5085 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005086 * (Usually optional) Normalize and set both the data Uri and an explicit
5087 * MIME data type. This method should very rarely be used -- it allows you
5088 * to override the MIME type that would ordinarily be inferred from the
5089 * data with your own type given here.
5090 *
5091 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005092 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005093 * before they are set, so really this is just a convenience method for
5094 * <pre>
5095 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5096 * </pre>
5097 *
5098 * @param data The Uri of the data this intent is now targeting.
5099 * @param type The MIME type of the data being handled by this intent.
5100 *
5101 * @return Returns the same Intent object, for chaining multiple calls
5102 * into a single statement.
5103 *
5104 * @see #setType
5105 * @see #setData
5106 * @see #setDataAndType
5107 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005108 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005109 */
5110 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005111 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005112 }
5113
5114 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005115 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005116 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005117 * activities that provide <em>all</em> of the requested categories will be
5118 * used.
5119 *
5120 * @param category The desired category. This can be either one of the
5121 * predefined Intent categories, or a custom category in your own
5122 * namespace.
5123 *
5124 * @return Returns the same Intent object, for chaining multiple calls
5125 * into a single statement.
5126 *
5127 * @see #hasCategory
5128 * @see #removeCategory
5129 */
5130 public Intent addCategory(String category) {
5131 if (mCategories == null) {
5132 mCategories = new HashSet<String>();
5133 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005134 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005135 return this;
5136 }
5137
5138 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005139 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005140 *
5141 * @param category The category to remove.
5142 *
5143 * @see #addCategory
5144 */
5145 public void removeCategory(String category) {
5146 if (mCategories != null) {
5147 mCategories.remove(category);
5148 if (mCategories.size() == 0) {
5149 mCategories = null;
5150 }
5151 }
5152 }
5153
5154 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005155 * Set a selector for this Intent. This is a modification to the kinds of
5156 * things the Intent will match. If the selector is set, it will be used
5157 * when trying to find entities that can handle the Intent, instead of the
5158 * main contents of the Intent. This allows you build an Intent containing
5159 * a generic protocol while targeting it more specifically.
5160 *
5161 * <p>An example of where this may be used is with things like
5162 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5163 * Intent that will launch the Browser application. However, the correct
5164 * main entry point of an application is actually {@link #ACTION_MAIN}
5165 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5166 * used to specify the actual Activity to launch. If you launch the browser
5167 * with something different, undesired behavior may happen if the user has
5168 * previously or later launches it the normal way, since they do not match.
5169 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5170 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5171 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5172 *
5173 * <p>Setting a selector does not impact the behavior of
5174 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5175 * desired behavior of a selector -- it does not impact the base meaning
5176 * of the Intent, just what kinds of things will be matched against it
5177 * when determining who can handle it.</p>
5178 *
5179 * <p>You can not use both a selector and {@link #setPackage(String)} on
5180 * the same base Intent.</p>
5181 *
5182 * @param selector The desired selector Intent; set to null to not use
5183 * a special selector.
5184 */
5185 public void setSelector(Intent selector) {
5186 if (selector == this) {
5187 throw new IllegalArgumentException(
5188 "Intent being set as a selector of itself");
5189 }
5190 if (selector != null && mPackage != null) {
5191 throw new IllegalArgumentException(
5192 "Can't set selector when package name is already set");
5193 }
5194 mSelector = selector;
5195 }
5196
5197 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005198 * Set a {@link ClipData} associated with this Intent. This replaces any
5199 * previously set ClipData.
5200 *
5201 * <p>The ClipData in an intent is not used for Intent matching or other
5202 * such operations. Semantically it is like extras, used to transmit
5203 * additional data with the Intent. The main feature of using this over
5204 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5205 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5206 * items included in the clip data. This is useful, in particular, if
5207 * you want to transmit an Intent containing multiple <code>content:</code>
5208 * URIs for which the recipient may not have global permission to access the
5209 * content provider.
5210 *
5211 * <p>If the ClipData contains items that are themselves Intents, any
5212 * grant flags in those Intents will be ignored. Only the top-level flags
5213 * of the main Intent are respected, and will be applied to all Uri or
5214 * Intent items in the clip (or sub-items of the clip).
5215 *
5216 * <p>The MIME type, label, and icon in the ClipData object are not
5217 * directly used by Intent. Applications should generally rely on the
5218 * MIME type of the Intent itself, not what it may find in the ClipData.
5219 * A common practice is to construct a ClipData for use with an Intent
5220 * with a MIME type of "*\/*".
5221 *
5222 * @param clip The new clip to set. May be null to clear the current clip.
5223 */
5224 public void setClipData(ClipData clip) {
5225 mClipData = clip;
5226 }
5227
5228 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005229 * Add extended data to the intent. The name must include a package
5230 * prefix, for example the app com.android.contacts would use names
5231 * like "com.android.contacts.ShowAll".
5232 *
5233 * @param name The name of the extra data, with package prefix.
5234 * @param value The boolean data value.
5235 *
5236 * @return Returns the same Intent object, for chaining multiple calls
5237 * into a single statement.
5238 *
5239 * @see #putExtras
5240 * @see #removeExtra
5241 * @see #getBooleanExtra(String, boolean)
5242 */
5243 public Intent putExtra(String name, boolean value) {
5244 if (mExtras == null) {
5245 mExtras = new Bundle();
5246 }
5247 mExtras.putBoolean(name, value);
5248 return this;
5249 }
5250
5251 /**
5252 * Add extended data to the intent. The name must include a package
5253 * prefix, for example the app com.android.contacts would use names
5254 * like "com.android.contacts.ShowAll".
5255 *
5256 * @param name The name of the extra data, with package prefix.
5257 * @param value The byte data value.
5258 *
5259 * @return Returns the same Intent object, for chaining multiple calls
5260 * into a single statement.
5261 *
5262 * @see #putExtras
5263 * @see #removeExtra
5264 * @see #getByteExtra(String, byte)
5265 */
5266 public Intent putExtra(String name, byte value) {
5267 if (mExtras == null) {
5268 mExtras = new Bundle();
5269 }
5270 mExtras.putByte(name, value);
5271 return this;
5272 }
5273
5274 /**
5275 * Add extended data to the intent. The name must include a package
5276 * prefix, for example the app com.android.contacts would use names
5277 * like "com.android.contacts.ShowAll".
5278 *
5279 * @param name The name of the extra data, with package prefix.
5280 * @param value The char data value.
5281 *
5282 * @return Returns the same Intent object, for chaining multiple calls
5283 * into a single statement.
5284 *
5285 * @see #putExtras
5286 * @see #removeExtra
5287 * @see #getCharExtra(String, char)
5288 */
5289 public Intent putExtra(String name, char value) {
5290 if (mExtras == null) {
5291 mExtras = new Bundle();
5292 }
5293 mExtras.putChar(name, value);
5294 return this;
5295 }
5296
5297 /**
5298 * Add extended data to the intent. The name must include a package
5299 * prefix, for example the app com.android.contacts would use names
5300 * like "com.android.contacts.ShowAll".
5301 *
5302 * @param name The name of the extra data, with package prefix.
5303 * @param value The short data value.
5304 *
5305 * @return Returns the same Intent object, for chaining multiple calls
5306 * into a single statement.
5307 *
5308 * @see #putExtras
5309 * @see #removeExtra
5310 * @see #getShortExtra(String, short)
5311 */
5312 public Intent putExtra(String name, short value) {
5313 if (mExtras == null) {
5314 mExtras = new Bundle();
5315 }
5316 mExtras.putShort(name, value);
5317 return this;
5318 }
5319
5320 /**
5321 * Add extended data to the intent. The name must include a package
5322 * prefix, for example the app com.android.contacts would use names
5323 * like "com.android.contacts.ShowAll".
5324 *
5325 * @param name The name of the extra data, with package prefix.
5326 * @param value The integer data value.
5327 *
5328 * @return Returns the same Intent object, for chaining multiple calls
5329 * into a single statement.
5330 *
5331 * @see #putExtras
5332 * @see #removeExtra
5333 * @see #getIntExtra(String, int)
5334 */
5335 public Intent putExtra(String name, int value) {
5336 if (mExtras == null) {
5337 mExtras = new Bundle();
5338 }
5339 mExtras.putInt(name, value);
5340 return this;
5341 }
5342
5343 /**
5344 * Add extended data to the intent. The name must include a package
5345 * prefix, for example the app com.android.contacts would use names
5346 * like "com.android.contacts.ShowAll".
5347 *
5348 * @param name The name of the extra data, with package prefix.
5349 * @param value The long data value.
5350 *
5351 * @return Returns the same Intent object, for chaining multiple calls
5352 * into a single statement.
5353 *
5354 * @see #putExtras
5355 * @see #removeExtra
5356 * @see #getLongExtra(String, long)
5357 */
5358 public Intent putExtra(String name, long value) {
5359 if (mExtras == null) {
5360 mExtras = new Bundle();
5361 }
5362 mExtras.putLong(name, value);
5363 return this;
5364 }
5365
5366 /**
5367 * Add extended data to the intent. The name must include a package
5368 * prefix, for example the app com.android.contacts would use names
5369 * like "com.android.contacts.ShowAll".
5370 *
5371 * @param name The name of the extra data, with package prefix.
5372 * @param value The float data value.
5373 *
5374 * @return Returns the same Intent object, for chaining multiple calls
5375 * into a single statement.
5376 *
5377 * @see #putExtras
5378 * @see #removeExtra
5379 * @see #getFloatExtra(String, float)
5380 */
5381 public Intent putExtra(String name, float value) {
5382 if (mExtras == null) {
5383 mExtras = new Bundle();
5384 }
5385 mExtras.putFloat(name, value);
5386 return this;
5387 }
5388
5389 /**
5390 * Add extended data to the intent. The name must include a package
5391 * prefix, for example the app com.android.contacts would use names
5392 * like "com.android.contacts.ShowAll".
5393 *
5394 * @param name The name of the extra data, with package prefix.
5395 * @param value The double data value.
5396 *
5397 * @return Returns the same Intent object, for chaining multiple calls
5398 * into a single statement.
5399 *
5400 * @see #putExtras
5401 * @see #removeExtra
5402 * @see #getDoubleExtra(String, double)
5403 */
5404 public Intent putExtra(String name, double value) {
5405 if (mExtras == null) {
5406 mExtras = new Bundle();
5407 }
5408 mExtras.putDouble(name, value);
5409 return this;
5410 }
5411
5412 /**
5413 * Add extended data to the intent. The name must include a package
5414 * prefix, for example the app com.android.contacts would use names
5415 * like "com.android.contacts.ShowAll".
5416 *
5417 * @param name The name of the extra data, with package prefix.
5418 * @param value The String data value.
5419 *
5420 * @return Returns the same Intent object, for chaining multiple calls
5421 * into a single statement.
5422 *
5423 * @see #putExtras
5424 * @see #removeExtra
5425 * @see #getStringExtra(String)
5426 */
5427 public Intent putExtra(String name, String value) {
5428 if (mExtras == null) {
5429 mExtras = new Bundle();
5430 }
5431 mExtras.putString(name, value);
5432 return this;
5433 }
5434
5435 /**
5436 * Add extended data to the intent. The name must include a package
5437 * prefix, for example the app com.android.contacts would use names
5438 * like "com.android.contacts.ShowAll".
5439 *
5440 * @param name The name of the extra data, with package prefix.
5441 * @param value The CharSequence data value.
5442 *
5443 * @return Returns the same Intent object, for chaining multiple calls
5444 * into a single statement.
5445 *
5446 * @see #putExtras
5447 * @see #removeExtra
5448 * @see #getCharSequenceExtra(String)
5449 */
5450 public Intent putExtra(String name, CharSequence value) {
5451 if (mExtras == null) {
5452 mExtras = new Bundle();
5453 }
5454 mExtras.putCharSequence(name, value);
5455 return this;
5456 }
5457
5458 /**
5459 * Add extended data to the intent. The name must include a package
5460 * prefix, for example the app com.android.contacts would use names
5461 * like "com.android.contacts.ShowAll".
5462 *
5463 * @param name The name of the extra data, with package prefix.
5464 * @param value The Parcelable data value.
5465 *
5466 * @return Returns the same Intent object, for chaining multiple calls
5467 * into a single statement.
5468 *
5469 * @see #putExtras
5470 * @see #removeExtra
5471 * @see #getParcelableExtra(String)
5472 */
5473 public Intent putExtra(String name, Parcelable value) {
5474 if (mExtras == null) {
5475 mExtras = new Bundle();
5476 }
5477 mExtras.putParcelable(name, value);
5478 return this;
5479 }
5480
5481 /**
5482 * Add extended data to the intent. The name must include a package
5483 * prefix, for example the app com.android.contacts would use names
5484 * like "com.android.contacts.ShowAll".
5485 *
5486 * @param name The name of the extra data, with package prefix.
5487 * @param value The Parcelable[] data value.
5488 *
5489 * @return Returns the same Intent object, for chaining multiple calls
5490 * into a single statement.
5491 *
5492 * @see #putExtras
5493 * @see #removeExtra
5494 * @see #getParcelableArrayExtra(String)
5495 */
5496 public Intent putExtra(String name, Parcelable[] value) {
5497 if (mExtras == null) {
5498 mExtras = new Bundle();
5499 }
5500 mExtras.putParcelableArray(name, value);
5501 return this;
5502 }
5503
5504 /**
5505 * Add extended data to the intent. The name must include a package
5506 * prefix, for example the app com.android.contacts would use names
5507 * like "com.android.contacts.ShowAll".
5508 *
5509 * @param name The name of the extra data, with package prefix.
5510 * @param value The ArrayList<Parcelable> data value.
5511 *
5512 * @return Returns the same Intent object, for chaining multiple calls
5513 * into a single statement.
5514 *
5515 * @see #putExtras
5516 * @see #removeExtra
5517 * @see #getParcelableArrayListExtra(String)
5518 */
5519 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5520 if (mExtras == null) {
5521 mExtras = new Bundle();
5522 }
5523 mExtras.putParcelableArrayList(name, value);
5524 return this;
5525 }
5526
5527 /**
5528 * Add extended data to the intent. The name must include a package
5529 * prefix, for example the app com.android.contacts would use names
5530 * like "com.android.contacts.ShowAll".
5531 *
5532 * @param name The name of the extra data, with package prefix.
5533 * @param value The ArrayList<Integer> data value.
5534 *
5535 * @return Returns the same Intent object, for chaining multiple calls
5536 * into a single statement.
5537 *
5538 * @see #putExtras
5539 * @see #removeExtra
5540 * @see #getIntegerArrayListExtra(String)
5541 */
5542 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5543 if (mExtras == null) {
5544 mExtras = new Bundle();
5545 }
5546 mExtras.putIntegerArrayList(name, value);
5547 return this;
5548 }
5549
5550 /**
5551 * Add extended data to the intent. The name must include a package
5552 * prefix, for example the app com.android.contacts would use names
5553 * like "com.android.contacts.ShowAll".
5554 *
5555 * @param name The name of the extra data, with package prefix.
5556 * @param value The ArrayList<String> data value.
5557 *
5558 * @return Returns the same Intent object, for chaining multiple calls
5559 * into a single statement.
5560 *
5561 * @see #putExtras
5562 * @see #removeExtra
5563 * @see #getStringArrayListExtra(String)
5564 */
5565 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5566 if (mExtras == null) {
5567 mExtras = new Bundle();
5568 }
5569 mExtras.putStringArrayList(name, value);
5570 return this;
5571 }
5572
5573 /**
5574 * Add extended data to the intent. The name must include a package
5575 * prefix, for example the app com.android.contacts would use names
5576 * like "com.android.contacts.ShowAll".
5577 *
5578 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005579 * @param value The ArrayList<CharSequence> data value.
5580 *
5581 * @return Returns the same Intent object, for chaining multiple calls
5582 * into a single statement.
5583 *
5584 * @see #putExtras
5585 * @see #removeExtra
5586 * @see #getCharSequenceArrayListExtra(String)
5587 */
5588 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5589 if (mExtras == null) {
5590 mExtras = new Bundle();
5591 }
5592 mExtras.putCharSequenceArrayList(name, value);
5593 return this;
5594 }
5595
5596 /**
5597 * Add extended data to the intent. The name must include a package
5598 * prefix, for example the app com.android.contacts would use names
5599 * like "com.android.contacts.ShowAll".
5600 *
5601 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005602 * @param value The Serializable data value.
5603 *
5604 * @return Returns the same Intent object, for chaining multiple calls
5605 * into a single statement.
5606 *
5607 * @see #putExtras
5608 * @see #removeExtra
5609 * @see #getSerializableExtra(String)
5610 */
5611 public Intent putExtra(String name, Serializable value) {
5612 if (mExtras == null) {
5613 mExtras = new Bundle();
5614 }
5615 mExtras.putSerializable(name, value);
5616 return this;
5617 }
5618
5619 /**
5620 * Add extended data to the intent. The name must include a package
5621 * prefix, for example the app com.android.contacts would use names
5622 * like "com.android.contacts.ShowAll".
5623 *
5624 * @param name The name of the extra data, with package prefix.
5625 * @param value The boolean array data value.
5626 *
5627 * @return Returns the same Intent object, for chaining multiple calls
5628 * into a single statement.
5629 *
5630 * @see #putExtras
5631 * @see #removeExtra
5632 * @see #getBooleanArrayExtra(String)
5633 */
5634 public Intent putExtra(String name, boolean[] value) {
5635 if (mExtras == null) {
5636 mExtras = new Bundle();
5637 }
5638 mExtras.putBooleanArray(name, value);
5639 return this;
5640 }
5641
5642 /**
5643 * Add extended data to the intent. The name must include a package
5644 * prefix, for example the app com.android.contacts would use names
5645 * like "com.android.contacts.ShowAll".
5646 *
5647 * @param name The name of the extra data, with package prefix.
5648 * @param value The byte array data value.
5649 *
5650 * @return Returns the same Intent object, for chaining multiple calls
5651 * into a single statement.
5652 *
5653 * @see #putExtras
5654 * @see #removeExtra
5655 * @see #getByteArrayExtra(String)
5656 */
5657 public Intent putExtra(String name, byte[] value) {
5658 if (mExtras == null) {
5659 mExtras = new Bundle();
5660 }
5661 mExtras.putByteArray(name, value);
5662 return this;
5663 }
5664
5665 /**
5666 * Add extended data to the intent. The name must include a package
5667 * prefix, for example the app com.android.contacts would use names
5668 * like "com.android.contacts.ShowAll".
5669 *
5670 * @param name The name of the extra data, with package prefix.
5671 * @param value The short array data value.
5672 *
5673 * @return Returns the same Intent object, for chaining multiple calls
5674 * into a single statement.
5675 *
5676 * @see #putExtras
5677 * @see #removeExtra
5678 * @see #getShortArrayExtra(String)
5679 */
5680 public Intent putExtra(String name, short[] value) {
5681 if (mExtras == null) {
5682 mExtras = new Bundle();
5683 }
5684 mExtras.putShortArray(name, value);
5685 return this;
5686 }
5687
5688 /**
5689 * Add extended data to the intent. The name must include a package
5690 * prefix, for example the app com.android.contacts would use names
5691 * like "com.android.contacts.ShowAll".
5692 *
5693 * @param name The name of the extra data, with package prefix.
5694 * @param value The char array data value.
5695 *
5696 * @return Returns the same Intent object, for chaining multiple calls
5697 * into a single statement.
5698 *
5699 * @see #putExtras
5700 * @see #removeExtra
5701 * @see #getCharArrayExtra(String)
5702 */
5703 public Intent putExtra(String name, char[] value) {
5704 if (mExtras == null) {
5705 mExtras = new Bundle();
5706 }
5707 mExtras.putCharArray(name, value);
5708 return this;
5709 }
5710
5711 /**
5712 * Add extended data to the intent. The name must include a package
5713 * prefix, for example the app com.android.contacts would use names
5714 * like "com.android.contacts.ShowAll".
5715 *
5716 * @param name The name of the extra data, with package prefix.
5717 * @param value The int array data value.
5718 *
5719 * @return Returns the same Intent object, for chaining multiple calls
5720 * into a single statement.
5721 *
5722 * @see #putExtras
5723 * @see #removeExtra
5724 * @see #getIntArrayExtra(String)
5725 */
5726 public Intent putExtra(String name, int[] value) {
5727 if (mExtras == null) {
5728 mExtras = new Bundle();
5729 }
5730 mExtras.putIntArray(name, value);
5731 return this;
5732 }
5733
5734 /**
5735 * Add extended data to the intent. The name must include a package
5736 * prefix, for example the app com.android.contacts would use names
5737 * like "com.android.contacts.ShowAll".
5738 *
5739 * @param name The name of the extra data, with package prefix.
5740 * @param value The byte array data value.
5741 *
5742 * @return Returns the same Intent object, for chaining multiple calls
5743 * into a single statement.
5744 *
5745 * @see #putExtras
5746 * @see #removeExtra
5747 * @see #getLongArrayExtra(String)
5748 */
5749 public Intent putExtra(String name, long[] value) {
5750 if (mExtras == null) {
5751 mExtras = new Bundle();
5752 }
5753 mExtras.putLongArray(name, value);
5754 return this;
5755 }
5756
5757 /**
5758 * Add extended data to the intent. The name must include a package
5759 * prefix, for example the app com.android.contacts would use names
5760 * like "com.android.contacts.ShowAll".
5761 *
5762 * @param name The name of the extra data, with package prefix.
5763 * @param value The float array data value.
5764 *
5765 * @return Returns the same Intent object, for chaining multiple calls
5766 * into a single statement.
5767 *
5768 * @see #putExtras
5769 * @see #removeExtra
5770 * @see #getFloatArrayExtra(String)
5771 */
5772 public Intent putExtra(String name, float[] value) {
5773 if (mExtras == null) {
5774 mExtras = new Bundle();
5775 }
5776 mExtras.putFloatArray(name, value);
5777 return this;
5778 }
5779
5780 /**
5781 * Add extended data to the intent. The name must include a package
5782 * prefix, for example the app com.android.contacts would use names
5783 * like "com.android.contacts.ShowAll".
5784 *
5785 * @param name The name of the extra data, with package prefix.
5786 * @param value The double array data value.
5787 *
5788 * @return Returns the same Intent object, for chaining multiple calls
5789 * into a single statement.
5790 *
5791 * @see #putExtras
5792 * @see #removeExtra
5793 * @see #getDoubleArrayExtra(String)
5794 */
5795 public Intent putExtra(String name, double[] value) {
5796 if (mExtras == null) {
5797 mExtras = new Bundle();
5798 }
5799 mExtras.putDoubleArray(name, value);
5800 return this;
5801 }
5802
5803 /**
5804 * Add extended data to the intent. The name must include a package
5805 * prefix, for example the app com.android.contacts would use names
5806 * like "com.android.contacts.ShowAll".
5807 *
5808 * @param name The name of the extra data, with package prefix.
5809 * @param value The String array data value.
5810 *
5811 * @return Returns the same Intent object, for chaining multiple calls
5812 * into a single statement.
5813 *
5814 * @see #putExtras
5815 * @see #removeExtra
5816 * @see #getStringArrayExtra(String)
5817 */
5818 public Intent putExtra(String name, String[] value) {
5819 if (mExtras == null) {
5820 mExtras = new Bundle();
5821 }
5822 mExtras.putStringArray(name, value);
5823 return this;
5824 }
5825
5826 /**
5827 * Add extended data to the intent. The name must include a package
5828 * prefix, for example the app com.android.contacts would use names
5829 * like "com.android.contacts.ShowAll".
5830 *
5831 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005832 * @param value The CharSequence array data value.
5833 *
5834 * @return Returns the same Intent object, for chaining multiple calls
5835 * into a single statement.
5836 *
5837 * @see #putExtras
5838 * @see #removeExtra
5839 * @see #getCharSequenceArrayExtra(String)
5840 */
5841 public Intent putExtra(String name, CharSequence[] value) {
5842 if (mExtras == null) {
5843 mExtras = new Bundle();
5844 }
5845 mExtras.putCharSequenceArray(name, value);
5846 return this;
5847 }
5848
5849 /**
5850 * Add extended data to the intent. The name must include a package
5851 * prefix, for example the app com.android.contacts would use names
5852 * like "com.android.contacts.ShowAll".
5853 *
5854 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005855 * @param value The Bundle data value.
5856 *
5857 * @return Returns the same Intent object, for chaining multiple calls
5858 * into a single statement.
5859 *
5860 * @see #putExtras
5861 * @see #removeExtra
5862 * @see #getBundleExtra(String)
5863 */
5864 public Intent putExtra(String name, Bundle value) {
5865 if (mExtras == null) {
5866 mExtras = new Bundle();
5867 }
5868 mExtras.putBundle(name, value);
5869 return this;
5870 }
5871
5872 /**
5873 * Add extended data to the intent. The name must include a package
5874 * prefix, for example the app com.android.contacts would use names
5875 * like "com.android.contacts.ShowAll".
5876 *
5877 * @param name The name of the extra data, with package prefix.
5878 * @param value The IBinder data value.
5879 *
5880 * @return Returns the same Intent object, for chaining multiple calls
5881 * into a single statement.
5882 *
5883 * @see #putExtras
5884 * @see #removeExtra
5885 * @see #getIBinderExtra(String)
5886 *
5887 * @deprecated
5888 * @hide
5889 */
5890 @Deprecated
5891 public Intent putExtra(String name, IBinder value) {
5892 if (mExtras == null) {
5893 mExtras = new Bundle();
5894 }
5895 mExtras.putIBinder(name, value);
5896 return this;
5897 }
5898
5899 /**
5900 * Copy all extras in 'src' in to this intent.
5901 *
5902 * @param src Contains the extras to copy.
5903 *
5904 * @see #putExtra
5905 */
5906 public Intent putExtras(Intent src) {
5907 if (src.mExtras != null) {
5908 if (mExtras == null) {
5909 mExtras = new Bundle(src.mExtras);
5910 } else {
5911 mExtras.putAll(src.mExtras);
5912 }
5913 }
5914 return this;
5915 }
5916
5917 /**
5918 * Add a set of extended data to the intent. The keys must include a package
5919 * prefix, for example the app com.android.contacts would use names
5920 * like "com.android.contacts.ShowAll".
5921 *
5922 * @param extras The Bundle of extras to add to this intent.
5923 *
5924 * @see #putExtra
5925 * @see #removeExtra
5926 */
5927 public Intent putExtras(Bundle extras) {
5928 if (mExtras == null) {
5929 mExtras = new Bundle();
5930 }
5931 mExtras.putAll(extras);
5932 return this;
5933 }
5934
5935 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005936 * Completely replace the extras in the Intent with the extras in the
5937 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005938 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005939 * @param src The exact extras contained in this Intent are copied
5940 * into the target intent, replacing any that were previously there.
5941 */
5942 public Intent replaceExtras(Intent src) {
5943 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5944 return this;
5945 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005946
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005947 /**
5948 * Completely replace the extras in the Intent with the given Bundle of
5949 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005950 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005951 * @param extras The new set of extras in the Intent, or null to erase
5952 * all extras.
5953 */
5954 public Intent replaceExtras(Bundle extras) {
5955 mExtras = extras != null ? new Bundle(extras) : null;
5956 return this;
5957 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005958
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005959 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005960 * Remove extended data from the intent.
5961 *
5962 * @see #putExtra
5963 */
5964 public void removeExtra(String name) {
5965 if (mExtras != null) {
5966 mExtras.remove(name);
5967 if (mExtras.size() == 0) {
5968 mExtras = null;
5969 }
5970 }
5971 }
5972
5973 /**
5974 * Set special flags controlling how this intent is handled. Most values
5975 * here depend on the type of component being executed by the Intent,
5976 * specifically the FLAG_ACTIVITY_* flags are all for use with
5977 * {@link Context#startActivity Context.startActivity()} and the
5978 * FLAG_RECEIVER_* flags are all for use with
5979 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5980 *
Scott Main7aee61f2011-02-08 11:25:01 -08005981 * <p>See the
5982 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5983 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005984 * the behavior of your application.
5985 *
5986 * @param flags The desired flags.
5987 *
5988 * @return Returns the same Intent object, for chaining multiple calls
5989 * into a single statement.
5990 *
5991 * @see #getFlags
5992 * @see #addFlags
5993 *
5994 * @see #FLAG_GRANT_READ_URI_PERMISSION
5995 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5996 * @see #FLAG_DEBUG_LOG_RESOLUTION
5997 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005998 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005999 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006000 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006001 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006002 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6003 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006004 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006005 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6006 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006007 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006008 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006009 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006010 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6011 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006012 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006013 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006014 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006015 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6016 */
6017 public Intent setFlags(int flags) {
6018 mFlags = flags;
6019 return this;
6020 }
6021
6022 /**
6023 * Add additional flags to the intent (or with existing flags
6024 * value).
6025 *
6026 * @param flags The new flags to set.
6027 *
6028 * @return Returns the same Intent object, for chaining multiple calls
6029 * into a single statement.
6030 *
6031 * @see #setFlags
6032 */
6033 public Intent addFlags(int flags) {
6034 mFlags |= flags;
6035 return this;
6036 }
6037
6038 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006039 * (Usually optional) Set an explicit application package name that limits
6040 * the components this Intent will resolve to. If left to the default
6041 * value of null, all components in all applications will considered.
6042 * If non-null, the Intent can only match the components in the given
6043 * application package.
6044 *
6045 * @param packageName The name of the application package to handle the
6046 * intent, or null to allow any application package.
6047 *
6048 * @return Returns the same Intent object, for chaining multiple calls
6049 * into a single statement.
6050 *
6051 * @see #getPackage
6052 * @see #resolveActivity
6053 */
6054 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006055 if (packageName != null && mSelector != null) {
6056 throw new IllegalArgumentException(
6057 "Can't set package name when selector is already set");
6058 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006059 mPackage = packageName;
6060 return this;
6061 }
6062
6063 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006064 * (Usually optional) Explicitly set the component to handle the intent.
6065 * If left with the default value of null, the system will determine the
6066 * appropriate class to use based on the other fields (action, data,
6067 * type, categories) in the Intent. If this class is defined, the
6068 * specified class will always be used regardless of the other fields. You
6069 * should only set this value when you know you absolutely want a specific
6070 * class to be used; otherwise it is better to let the system find the
6071 * appropriate class so that you will respect the installed applications
6072 * and user preferences.
6073 *
6074 * @param component The name of the application component to handle the
6075 * intent, or null to let the system find one for you.
6076 *
6077 * @return Returns the same Intent object, for chaining multiple calls
6078 * into a single statement.
6079 *
6080 * @see #setClass
6081 * @see #setClassName(Context, String)
6082 * @see #setClassName(String, String)
6083 * @see #getComponent
6084 * @see #resolveActivity
6085 */
6086 public Intent setComponent(ComponentName component) {
6087 mComponent = component;
6088 return this;
6089 }
6090
6091 /**
6092 * Convenience for calling {@link #setComponent} with an
6093 * explicit class name.
6094 *
6095 * @param packageContext A Context of the application package implementing
6096 * this class.
6097 * @param className The name of a class inside of the application package
6098 * that will be used as the component for this Intent.
6099 *
6100 * @return Returns the same Intent object, for chaining multiple calls
6101 * into a single statement.
6102 *
6103 * @see #setComponent
6104 * @see #setClass
6105 */
6106 public Intent setClassName(Context packageContext, String className) {
6107 mComponent = new ComponentName(packageContext, className);
6108 return this;
6109 }
6110
6111 /**
6112 * Convenience for calling {@link #setComponent} with an
6113 * explicit application package name and class name.
6114 *
6115 * @param packageName The name of the package implementing the desired
6116 * component.
6117 * @param className The name of a class inside of the application package
6118 * that will be used as the component for this Intent.
6119 *
6120 * @return Returns the same Intent object, for chaining multiple calls
6121 * into a single statement.
6122 *
6123 * @see #setComponent
6124 * @see #setClass
6125 */
6126 public Intent setClassName(String packageName, String className) {
6127 mComponent = new ComponentName(packageName, className);
6128 return this;
6129 }
6130
6131 /**
6132 * Convenience for calling {@link #setComponent(ComponentName)} with the
6133 * name returned by a {@link Class} object.
6134 *
6135 * @param packageContext A Context of the application package implementing
6136 * this class.
6137 * @param cls The class name to set, equivalent to
6138 * <code>setClassName(context, cls.getName())</code>.
6139 *
6140 * @return Returns the same Intent object, for chaining multiple calls
6141 * into a single statement.
6142 *
6143 * @see #setComponent
6144 */
6145 public Intent setClass(Context packageContext, Class<?> cls) {
6146 mComponent = new ComponentName(packageContext, cls);
6147 return this;
6148 }
6149
6150 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006151 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6152 * used as a hint to the receiver for animations and the like. Null means that there
6153 * is no source bounds.
6154 */
6155 public void setSourceBounds(Rect r) {
6156 if (r != null) {
6157 mSourceBounds = new Rect(r);
6158 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006159 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006160 }
6161 }
6162
6163 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006164 * Use with {@link #fillIn} to allow the current action value to be
6165 * overwritten, even if it is already set.
6166 */
6167 public static final int FILL_IN_ACTION = 1<<0;
6168
6169 /**
6170 * Use with {@link #fillIn} to allow the current data or type value
6171 * overwritten, even if it is already set.
6172 */
6173 public static final int FILL_IN_DATA = 1<<1;
6174
6175 /**
6176 * Use with {@link #fillIn} to allow the current categories to be
6177 * overwritten, even if they are already set.
6178 */
6179 public static final int FILL_IN_CATEGORIES = 1<<2;
6180
6181 /**
6182 * Use with {@link #fillIn} to allow the current component value to be
6183 * overwritten, even if it is already set.
6184 */
6185 public static final int FILL_IN_COMPONENT = 1<<3;
6186
6187 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006188 * Use with {@link #fillIn} to allow the current package value to be
6189 * overwritten, even if it is already set.
6190 */
6191 public static final int FILL_IN_PACKAGE = 1<<4;
6192
6193 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006194 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006195 * overwritten, even if it is already set.
6196 */
6197 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6198
6199 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006200 * Use with {@link #fillIn} to allow the current selector to be
6201 * overwritten, even if it is already set.
6202 */
6203 public static final int FILL_IN_SELECTOR = 1<<6;
6204
6205 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006206 * Use with {@link #fillIn} to allow the current ClipData to be
6207 * overwritten, even if it is already set.
6208 */
6209 public static final int FILL_IN_CLIP_DATA = 1<<7;
6210
6211 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006212 * Copy the contents of <var>other</var> in to this object, but only
6213 * where fields are not defined by this object. For purposes of a field
6214 * being defined, the following pieces of data in the Intent are
6215 * considered to be separate fields:
6216 *
6217 * <ul>
6218 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006219 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006220 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6221 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006222 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006223 * <li> component, as set by {@link #setComponent(ComponentName)} or
6224 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006225 * <li> source bounds, as set by {@link #setSourceBounds}.
6226 * <li> selector, as set by {@link #setSelector(Intent)}.
6227 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006228 * <li> each top-level name in the associated extras.
6229 * </ul>
6230 *
6231 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006232 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006233 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6234 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6235 * the restriction where the corresponding field will not be replaced if
6236 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006237 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006238 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6239 * is explicitly specified. The selector will only be copied if
6240 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006241 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006242 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6243 * and Intent B with {action="gotit", data-type="some/thing",
6244 * categories="one","two"}.
6245 *
6246 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6247 * containing: {action="gotit", data-type="some/thing",
6248 * categories="bar"}.
6249 *
6250 * @param other Another Intent whose values are to be used to fill in
6251 * the current one.
6252 * @param flags Options to control which fields can be filled in.
6253 *
6254 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006255 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006256 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6257 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006258 */
6259 public int fillIn(Intent other, int flags) {
6260 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006261 if (other.mAction != null
6262 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006263 mAction = other.mAction;
6264 changes |= FILL_IN_ACTION;
6265 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006266 if ((other.mData != null || other.mType != null)
6267 && ((mData == null && mType == null)
6268 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006269 mData = other.mData;
6270 mType = other.mType;
6271 changes |= FILL_IN_DATA;
6272 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006273 if (other.mCategories != null
6274 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006275 if (other.mCategories != null) {
6276 mCategories = new HashSet<String>(other.mCategories);
6277 }
6278 changes |= FILL_IN_CATEGORIES;
6279 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006280 if (other.mPackage != null
6281 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006282 // Only do this if mSelector is not set.
6283 if (mSelector == null) {
6284 mPackage = other.mPackage;
6285 changes |= FILL_IN_PACKAGE;
6286 }
6287 }
6288 // Selector is special: it can only be set if explicitly allowed,
6289 // for the same reason as the component name.
6290 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6291 if (mPackage == null) {
6292 mSelector = new Intent(other.mSelector);
6293 mPackage = null;
6294 changes |= FILL_IN_SELECTOR;
6295 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006296 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006297 if (other.mClipData != null
6298 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6299 mClipData = other.mClipData;
6300 changes |= FILL_IN_CLIP_DATA;
6301 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006302 // Component is special: it can -only- be set if explicitly allowed,
6303 // since otherwise the sender could force the intent somewhere the
6304 // originator didn't intend.
6305 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006306 mComponent = other.mComponent;
6307 changes |= FILL_IN_COMPONENT;
6308 }
6309 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006310 if (other.mSourceBounds != null
6311 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6312 mSourceBounds = new Rect(other.mSourceBounds);
6313 changes |= FILL_IN_SOURCE_BOUNDS;
6314 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006315 if (mExtras == null) {
6316 if (other.mExtras != null) {
6317 mExtras = new Bundle(other.mExtras);
6318 }
6319 } else if (other.mExtras != null) {
6320 try {
6321 Bundle newb = new Bundle(other.mExtras);
6322 newb.putAll(mExtras);
6323 mExtras = newb;
6324 } catch (RuntimeException e) {
6325 // Modifying the extras can cause us to unparcel the contents
6326 // of the bundle, and if we do this in the system process that
6327 // may fail. We really should handle this (i.e., the Bundle
6328 // impl shouldn't be on top of a plain map), but for now just
6329 // ignore it and keep the original contents. :(
6330 Log.w("Intent", "Failure filling in extras", e);
6331 }
6332 }
6333 return changes;
6334 }
6335
6336 /**
6337 * Wrapper class holding an Intent and implementing comparisons on it for
6338 * the purpose of filtering. The class implements its
6339 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6340 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6341 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6342 * on the wrapped Intent.
6343 */
6344 public static final class FilterComparison {
6345 private final Intent mIntent;
6346 private final int mHashCode;
6347
6348 public FilterComparison(Intent intent) {
6349 mIntent = intent;
6350 mHashCode = intent.filterHashCode();
6351 }
6352
6353 /**
6354 * Return the Intent that this FilterComparison represents.
6355 * @return Returns the Intent held by the FilterComparison. Do
6356 * not modify!
6357 */
6358 public Intent getIntent() {
6359 return mIntent;
6360 }
6361
6362 @Override
6363 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006364 if (obj instanceof FilterComparison) {
6365 Intent other = ((FilterComparison)obj).mIntent;
6366 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006367 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006368 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006369 }
6370
6371 @Override
6372 public int hashCode() {
6373 return mHashCode;
6374 }
6375 }
6376
6377 /**
6378 * Determine if two intents are the same for the purposes of intent
6379 * resolution (filtering). That is, if their action, data, type,
6380 * class, and categories are the same. This does <em>not</em> compare
6381 * any extra data included in the intents.
6382 *
6383 * @param other The other Intent to compare against.
6384 *
6385 * @return Returns true if action, data, type, class, and categories
6386 * are the same.
6387 */
6388 public boolean filterEquals(Intent other) {
6389 if (other == null) {
6390 return false;
6391 }
6392 if (mAction != other.mAction) {
6393 if (mAction != null) {
6394 if (!mAction.equals(other.mAction)) {
6395 return false;
6396 }
6397 } else {
6398 if (!other.mAction.equals(mAction)) {
6399 return false;
6400 }
6401 }
6402 }
6403 if (mData != other.mData) {
6404 if (mData != null) {
6405 if (!mData.equals(other.mData)) {
6406 return false;
6407 }
6408 } else {
6409 if (!other.mData.equals(mData)) {
6410 return false;
6411 }
6412 }
6413 }
6414 if (mType != other.mType) {
6415 if (mType != null) {
6416 if (!mType.equals(other.mType)) {
6417 return false;
6418 }
6419 } else {
6420 if (!other.mType.equals(mType)) {
6421 return false;
6422 }
6423 }
6424 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006425 if (mPackage != other.mPackage) {
6426 if (mPackage != null) {
6427 if (!mPackage.equals(other.mPackage)) {
6428 return false;
6429 }
6430 } else {
6431 if (!other.mPackage.equals(mPackage)) {
6432 return false;
6433 }
6434 }
6435 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006436 if (mComponent != other.mComponent) {
6437 if (mComponent != null) {
6438 if (!mComponent.equals(other.mComponent)) {
6439 return false;
6440 }
6441 } else {
6442 if (!other.mComponent.equals(mComponent)) {
6443 return false;
6444 }
6445 }
6446 }
6447 if (mCategories != other.mCategories) {
6448 if (mCategories != null) {
6449 if (!mCategories.equals(other.mCategories)) {
6450 return false;
6451 }
6452 } else {
6453 if (!other.mCategories.equals(mCategories)) {
6454 return false;
6455 }
6456 }
6457 }
6458
6459 return true;
6460 }
6461
6462 /**
6463 * Generate hash code that matches semantics of filterEquals().
6464 *
6465 * @return Returns the hash value of the action, data, type, class, and
6466 * categories.
6467 *
6468 * @see #filterEquals
6469 */
6470 public int filterHashCode() {
6471 int code = 0;
6472 if (mAction != null) {
6473 code += mAction.hashCode();
6474 }
6475 if (mData != null) {
6476 code += mData.hashCode();
6477 }
6478 if (mType != null) {
6479 code += mType.hashCode();
6480 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006481 if (mPackage != null) {
6482 code += mPackage.hashCode();
6483 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006484 if (mComponent != null) {
6485 code += mComponent.hashCode();
6486 }
6487 if (mCategories != null) {
6488 code += mCategories.hashCode();
6489 }
6490 return code;
6491 }
6492
6493 @Override
6494 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006495 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006496
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006497 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006498 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006499 b.append(" }");
6500
6501 return b.toString();
6502 }
6503
6504 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006505 public String toInsecureString() {
6506 StringBuilder b = new StringBuilder(128);
6507
6508 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006509 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006510 b.append(" }");
6511
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006512 return b.toString();
6513 }
Romain Guy4969af72009-06-17 10:53:19 -07006514
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006515 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006516 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006517 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006518
6519 b.append("Intent { ");
6520 toShortString(b, false, true, true, true);
6521 b.append(" }");
6522
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006523 return b.toString();
6524 }
6525
6526 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006527 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6528 StringBuilder b = new StringBuilder(128);
6529 toShortString(b, secure, comp, extras, clip);
6530 return b.toString();
6531 }
6532
6533 /** @hide */
6534 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6535 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006536 boolean first = true;
6537 if (mAction != null) {
6538 b.append("act=").append(mAction);
6539 first = false;
6540 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006541 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006542 if (!first) {
6543 b.append(' ');
6544 }
6545 first = false;
6546 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006547 Iterator<String> i = mCategories.iterator();
6548 boolean didone = false;
6549 while (i.hasNext()) {
6550 if (didone) b.append(",");
6551 didone = true;
6552 b.append(i.next());
6553 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006554 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006555 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006556 if (mData != null) {
6557 if (!first) {
6558 b.append(' ');
6559 }
6560 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006561 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006562 if (secure) {
6563 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006564 } else {
6565 b.append(mData);
6566 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006567 }
6568 if (mType != null) {
6569 if (!first) {
6570 b.append(' ');
6571 }
6572 first = false;
6573 b.append("typ=").append(mType);
6574 }
6575 if (mFlags != 0) {
6576 if (!first) {
6577 b.append(' ');
6578 }
6579 first = false;
6580 b.append("flg=0x").append(Integer.toHexString(mFlags));
6581 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006582 if (mPackage != null) {
6583 if (!first) {
6584 b.append(' ');
6585 }
6586 first = false;
6587 b.append("pkg=").append(mPackage);
6588 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006589 if (comp && mComponent != null) {
6590 if (!first) {
6591 b.append(' ');
6592 }
6593 first = false;
6594 b.append("cmp=").append(mComponent.flattenToShortString());
6595 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006596 if (mSourceBounds != null) {
6597 if (!first) {
6598 b.append(' ');
6599 }
6600 first = false;
6601 b.append("bnds=").append(mSourceBounds.toShortString());
6602 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006603 if (mClipData != null) {
6604 if (!first) {
6605 b.append(' ');
6606 }
6607 first = false;
6608 if (clip) {
6609 b.append("clip={");
6610 mClipData.toShortString(b);
6611 b.append('}');
6612 } else {
6613 b.append("(has clip)");
6614 }
6615 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006616 if (extras && mExtras != null) {
6617 if (!first) {
6618 b.append(' ');
6619 }
6620 first = false;
6621 b.append("(has extras)");
6622 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006623 if (mSelector != null) {
6624 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006625 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006626 b.append("}");
6627 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006628 }
6629
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006630 /**
6631 * Call {@link #toUri} with 0 flags.
6632 * @deprecated Use {@link #toUri} instead.
6633 */
6634 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006635 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006636 return toUri(0);
6637 }
6638
6639 /**
6640 * Convert this Intent into a String holding a URI representation of it.
6641 * The returned URI string has been properly URI encoded, so it can be
6642 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6643 * Intent's data as the base URI, with an additional fragment describing
6644 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006645 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006646 * <p>You can convert the returned string back to an Intent with
6647 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006648 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006649 * @param flags Additional operating flags. Either 0 or
6650 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006651 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006652 * @return Returns a URI encoding URI string describing the entire contents
6653 * of the Intent.
6654 */
6655 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006656 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006657 String scheme = null;
6658 if (mData != null) {
6659 String data = mData.toString();
6660 if ((flags&URI_INTENT_SCHEME) != 0) {
6661 final int N = data.length();
6662 for (int i=0; i<N; i++) {
6663 char c = data.charAt(i);
6664 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6665 || c == '.' || c == '-') {
6666 continue;
6667 }
6668 if (c == ':' && i > 0) {
6669 // Valid scheme.
6670 scheme = data.substring(0, i);
6671 uri.append("intent:");
6672 data = data.substring(i+1);
6673 break;
6674 }
Tom Taylord4a47292009-12-21 13:59:18 -08006675
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006676 // No scheme.
6677 break;
6678 }
6679 }
6680 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006681
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006682 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6683 uri.append("intent:");
6684 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006685
6686 uri.append("#Intent;");
6687
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006688 toUriInner(uri, scheme, flags);
6689 if (mSelector != null) {
6690 uri.append("SEL;");
6691 // Note that for now we are not going to try to handle the
6692 // data part; not clear how to represent this as a URI, and
6693 // not much utility in it.
6694 mSelector.toUriInner(uri, null, flags);
6695 }
6696
6697 uri.append("end");
6698
6699 return uri.toString();
6700 }
6701
6702 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006703 if (scheme != null) {
6704 uri.append("scheme=").append(scheme).append(';');
6705 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006706 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006707 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006708 }
6709 if (mCategories != null) {
6710 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006711 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006712 }
6713 }
6714 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006715 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006716 }
6717 if (mFlags != 0) {
6718 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6719 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006720 if (mPackage != null) {
6721 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6722 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006723 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006724 uri.append("component=").append(Uri.encode(
6725 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006726 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006727 if (mSourceBounds != null) {
6728 uri.append("sourceBounds=")
6729 .append(Uri.encode(mSourceBounds.flattenToString()))
6730 .append(';');
6731 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006732 if (mExtras != null) {
6733 for (String key : mExtras.keySet()) {
6734 final Object value = mExtras.get(key);
6735 char entryType =
6736 value instanceof String ? 'S' :
6737 value instanceof Boolean ? 'B' :
6738 value instanceof Byte ? 'b' :
6739 value instanceof Character ? 'c' :
6740 value instanceof Double ? 'd' :
6741 value instanceof Float ? 'f' :
6742 value instanceof Integer ? 'i' :
6743 value instanceof Long ? 'l' :
6744 value instanceof Short ? 's' :
6745 '\0';
6746
6747 if (entryType != '\0') {
6748 uri.append(entryType);
6749 uri.append('.');
6750 uri.append(Uri.encode(key));
6751 uri.append('=');
6752 uri.append(Uri.encode(value.toString()));
6753 uri.append(';');
6754 }
6755 }
6756 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006757 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006758
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006759 public int describeContents() {
6760 return (mExtras != null) ? mExtras.describeContents() : 0;
6761 }
6762
6763 public void writeToParcel(Parcel out, int flags) {
6764 out.writeString(mAction);
6765 Uri.writeToParcel(out, mData);
6766 out.writeString(mType);
6767 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006768 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006769 ComponentName.writeToParcel(mComponent, out);
6770
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006771 if (mSourceBounds != null) {
6772 out.writeInt(1);
6773 mSourceBounds.writeToParcel(out, flags);
6774 } else {
6775 out.writeInt(0);
6776 }
6777
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006778 if (mCategories != null) {
6779 out.writeInt(mCategories.size());
6780 for (String category : mCategories) {
6781 out.writeString(category);
6782 }
6783 } else {
6784 out.writeInt(0);
6785 }
6786
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006787 if (mSelector != null) {
6788 out.writeInt(1);
6789 mSelector.writeToParcel(out, flags);
6790 } else {
6791 out.writeInt(0);
6792 }
6793
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006794 if (mClipData != null) {
6795 out.writeInt(1);
6796 mClipData.writeToParcel(out, flags);
6797 } else {
6798 out.writeInt(0);
6799 }
6800
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006801 out.writeBundle(mExtras);
6802 }
6803
6804 public static final Parcelable.Creator<Intent> CREATOR
6805 = new Parcelable.Creator<Intent>() {
6806 public Intent createFromParcel(Parcel in) {
6807 return new Intent(in);
6808 }
6809 public Intent[] newArray(int size) {
6810 return new Intent[size];
6811 }
6812 };
6813
Dianne Hackborneb034652009-09-07 00:49:58 -07006814 /** @hide */
6815 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006816 readFromParcel(in);
6817 }
6818
6819 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006820 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006821 mData = Uri.CREATOR.createFromParcel(in);
6822 mType = in.readString();
6823 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006824 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006825 mComponent = ComponentName.readFromParcel(in);
6826
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006827 if (in.readInt() != 0) {
6828 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6829 }
6830
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006831 int N = in.readInt();
6832 if (N > 0) {
6833 mCategories = new HashSet<String>();
6834 int i;
6835 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006836 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006837 }
6838 } else {
6839 mCategories = null;
6840 }
6841
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006842 if (in.readInt() != 0) {
6843 mSelector = new Intent(in);
6844 }
6845
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006846 if (in.readInt() != 0) {
6847 mClipData = new ClipData(in);
6848 }
6849
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006850 mExtras = in.readBundle();
6851 }
6852
6853 /**
6854 * Parses the "intent" element (and its children) from XML and instantiates
6855 * an Intent object. The given XML parser should be located at the tag
6856 * where parsing should start (often named "intent"), from which the
6857 * basic action, data, type, and package and class name will be
6858 * retrieved. The function will then parse in to any child elements,
6859 * looking for <category android:name="xxx"> tags to add categories and
6860 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6861 * to the intent.
6862 *
6863 * @param resources The Resources to use when inflating resources.
6864 * @param parser The XML parser pointing at an "intent" tag.
6865 * @param attrs The AttributeSet interface for retrieving extended
6866 * attribute data at the current <var>parser</var> location.
6867 * @return An Intent object matching the XML data.
6868 * @throws XmlPullParserException If there was an XML parsing error.
6869 * @throws IOException If there was an I/O error.
6870 */
6871 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6872 throws XmlPullParserException, IOException {
6873 Intent intent = new Intent();
6874
6875 TypedArray sa = resources.obtainAttributes(attrs,
6876 com.android.internal.R.styleable.Intent);
6877
6878 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6879
6880 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6881 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6882 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6883
6884 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6885 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6886 if (packageName != null && className != null) {
6887 intent.setComponent(new ComponentName(packageName, className));
6888 }
6889
6890 sa.recycle();
6891
6892 int outerDepth = parser.getDepth();
6893 int type;
6894 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6895 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6896 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6897 continue;
6898 }
6899
6900 String nodeName = parser.getName();
6901 if (nodeName.equals("category")) {
6902 sa = resources.obtainAttributes(attrs,
6903 com.android.internal.R.styleable.IntentCategory);
6904 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6905 sa.recycle();
6906
6907 if (cat != null) {
6908 intent.addCategory(cat);
6909 }
6910 XmlUtils.skipCurrentTag(parser);
6911
6912 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006913 if (intent.mExtras == null) {
6914 intent.mExtras = new Bundle();
6915 }
6916 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6917 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006918
6919 } else {
6920 XmlUtils.skipCurrentTag(parser);
6921 }
6922 }
6923
6924 return intent;
6925 }
Nick Pellyccae4122012-01-09 14:12:58 -08006926
6927 /**
6928 * Normalize a MIME data type.
6929 *
6930 * <p>A normalized MIME type has white-space trimmed,
6931 * content-type parameters removed, and is lower-case.
6932 * This aligns the type with Android best practices for
6933 * intent filtering.
6934 *
6935 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6936 * "text/x-vCard" becomes "text/x-vcard".
6937 *
6938 * <p>All MIME types received from outside Android (such as user input,
6939 * or external sources like Bluetooth, NFC, or the Internet) should
6940 * be normalized before they are used to create an Intent.
6941 *
6942 * @param type MIME data type to normalize
6943 * @return normalized MIME data type, or null if the input was null
6944 * @see {@link #setType}
6945 * @see {@link #setTypeAndNormalize}
6946 */
6947 public static String normalizeMimeType(String type) {
6948 if (type == null) {
6949 return null;
6950 }
6951
6952 type = type.trim().toLowerCase(Locale.US);
6953
6954 final int semicolonIndex = type.indexOf(';');
6955 if (semicolonIndex != -1) {
6956 type = type.substring(0, semicolonIndex);
6957 }
6958 return type;
6959 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006960
6961 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07006962 * Prepare this {@link Intent} to leave an app process.
6963 *
6964 * @hide
6965 */
6966 public void prepareToLeaveProcess() {
6967 setAllowFds(false);
6968
6969 if (mSelector != null) {
6970 mSelector.prepareToLeaveProcess();
6971 }
6972 if (mClipData != null) {
6973 mClipData.prepareToLeaveProcess();
6974 }
6975
6976 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
6977 // There are several ACTION_MEDIA_* broadcasts that send file://
6978 // Uris, so only check common actions.
6979 if (ACTION_VIEW.equals(mAction) ||
6980 ACTION_EDIT.equals(mAction) ||
6981 ACTION_ATTACH_DATA.equals(mAction)) {
6982 mData.checkFileUriExposed("Intent.getData()");
6983 }
6984 }
6985 }
6986
6987 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006988 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006989 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6990 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006991 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006992 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006993 * @hide
6994 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006995 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006996 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006997 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006998
6999 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007000 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007001
7002 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007003 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007004 try {
7005 // Inspect target intent to see if we need to migrate
7006 final Intent target = getParcelableExtra(EXTRA_INTENT);
7007 if (target != null && target.migrateExtraStreamToClipData()) {
7008 // Since we migrated in child, we need to promote ClipData
7009 // and flags to ourselves to grant.
7010 setClipData(target.getClipData());
7011 addFlags(target.getFlags()
7012 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
7013 return true;
7014 } else {
7015 return false;
7016 }
7017 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007018 }
7019
7020 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007021 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007022 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7023 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7024 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7025 if (stream != null || text != null || htmlText != null) {
7026 final ClipData clipData = new ClipData(
7027 null, new String[] { getType() },
7028 new ClipData.Item(text, htmlText, null, stream));
7029 setClipData(clipData);
7030 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007031 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007032 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007033 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007034 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007035
7036 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007037 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007038 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7039 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7040 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7041 int num = -1;
7042 if (streams != null) {
7043 num = streams.size();
7044 }
7045 if (texts != null) {
7046 if (num >= 0 && num != texts.size()) {
7047 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007048 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007049 }
7050 num = texts.size();
7051 }
7052 if (htmlTexts != null) {
7053 if (num >= 0 && num != htmlTexts.size()) {
7054 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007055 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007056 }
7057 num = htmlTexts.size();
7058 }
7059 if (num > 0) {
7060 final ClipData clipData = new ClipData(
7061 null, new String[] { getType() },
7062 makeClipItem(streams, texts, htmlTexts, 0));
7063
7064 for (int i = 1; i < num; i++) {
7065 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7066 }
7067
7068 setClipData(clipData);
7069 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007070 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007071 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007072 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007073 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007074 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007075
7076 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007077 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007078
7079 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7080 ArrayList<String> htmlTexts, int which) {
7081 Uri uri = streams != null ? streams.get(which) : null;
7082 CharSequence text = texts != null ? texts.get(which) : null;
7083 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7084 return new ClipData.Item(text, htmlText, null, uri);
7085 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007086}