blob: bfc7bf5dff850ffebd268ca08d14125a029e9558 [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
Svetoslav6a08a122013-05-03 11:24:26 -07002359 *
2360 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002361 */
2362 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2363 public static final String ACTION_IDLE_MAINTENANCE_START =
2364 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2365
2366 /**
2367 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2368 * This means that the user was not interacting with the device as a result
2369 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2370 * was sent and now the user started interacting with the device. Typical
2371 * use of the idle maintenance is to perform somehow expensive tasks that
2372 * can be postponed at a moment when they will not degrade user experience.
2373 * <p>
2374 * <p class="note">In order to keep the device responsive in case of an
2375 * unexpected user interaction, implementations of a maintenance task
2376 * should be interruptible. Hence, on receiving a broadcast with this
2377 * action, the maintenance task should be interrupted as soon as possible.
2378 * In other words, you should not do the maintenance work in
2379 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2380 * maintenance service that was started on receiving of
2381 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2382 * lock you acquired when your maintenance service started.
2383 * </p>
2384 * <p class="note">This is a protected intent that can only be sent
2385 * by the system.
2386 *
2387 * @see #ACTION_IDLE_MAINTENANCE_START
Svetoslav6a08a122013-05-03 11:24:26 -07002388 *
2389 * @hide
Svetoslavb3038ec2013-02-13 14:39:30 -08002390 */
2391 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2392 public static final String ACTION_IDLE_MAINTENANCE_END =
2393 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2394
2395 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002396 * Broadcast Action: a remote intent is to be broadcasted.
2397 *
2398 * A remote intent is used for remote RPC between devices. The remote intent
2399 * is serialized and sent from one device to another device. The receiving
2400 * device parses the remote intent and broadcasts it. Note that anyone can
2401 * broadcast a remote intent. However, if the intent receiver of the remote intent
2402 * does not trust intent broadcasts from arbitrary intent senders, it should require
2403 * the sender to hold certain permissions so only trusted sender's broadcast will be
2404 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002405 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002406 */
2407 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002408 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002409
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002410 /**
2411 * Broadcast Action: hook for permforming cleanup after a system update.
2412 *
2413 * The broadcast is sent when the system is booting, before the
2414 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2415 * image. A receiver for this should do its work and then disable itself
2416 * so that it does not get run again at the next boot.
2417 * @hide
2418 */
2419 public static final String ACTION_PRE_BOOT_COMPLETED =
2420 "android.intent.action.PRE_BOOT_COMPLETED";
2421
Amith Yamasani13593602012-03-22 16:16:17 -07002422 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002423 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002424 * on restricted users. The broadcast intent contains an extra
2425 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2426 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2427 * String[] depending on the restriction type.<p/>
2428 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002429 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2430 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2431 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002432 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2433 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002434 * @see RestrictionEntry
2435 */
2436 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2437 "android.intent.action.GET_RESTRICTION_ENTRIES";
2438
2439 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002440 * Sent the first time a user is starting, to allow system apps to
2441 * perform one time initialization. (This will not be seen by third
2442 * party applications because a newly initialized user does not have any
2443 * third party applications installed for it.) This is sent early in
2444 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002445 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2446 * broadcast, since it is part of a visible user interaction; be as quick
2447 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002448 */
2449 public static final String ACTION_USER_INITIALIZE =
2450 "android.intent.action.USER_INITIALIZE";
2451
2452 /**
2453 * Sent when a user switch is happening, causing the process's user to be
2454 * brought to the foreground. This is only sent to receivers registered
2455 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2456 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002457 * foreground. This is sent as a foreground
2458 * broadcast, since it is part of a visible user interaction; be as quick
2459 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002460 */
2461 public static final String ACTION_USER_FOREGROUND =
2462 "android.intent.action.USER_FOREGROUND";
2463
2464 /**
2465 * Sent when a user switch is happening, causing the process's user to be
2466 * sent to the background. This is only sent to receivers registered
2467 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2468 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002469 * background. This is sent as a foreground
2470 * broadcast, since it is part of a visible user interaction; be as quick
2471 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002472 */
2473 public static final String ACTION_USER_BACKGROUND =
2474 "android.intent.action.USER_BACKGROUND";
2475
2476 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002477 * Broadcast sent to the system when a user is added. Carries an extra
2478 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2479 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002480 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002481 * @hide
2482 */
2483 public static final String ACTION_USER_ADDED =
2484 "android.intent.action.USER_ADDED";
2485
2486 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002487 * Broadcast sent by the system when a user is started. Carries an extra
2488 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002489 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002490 * that has been started. This is sent as a foreground
2491 * broadcast, since it is part of a visible user interaction; be as quick
2492 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002493 * @hide
2494 */
2495 public static final String ACTION_USER_STARTED =
2496 "android.intent.action.USER_STARTED";
2497
2498 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002499 * Broadcast sent when a user is in the process of starting. Carries an extra
2500 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2501 * sent to registered receivers, not manifest receivers. It is sent to all
2502 * users (including the one that is being started). You must hold
2503 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2504 * this broadcast. This is sent as a background broadcast, since
2505 * its result is not part of the primary UX flow; to safely keep track of
2506 * started/stopped state of a user you can use this in conjunction with
2507 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2508 * other user state broadcasts since those are foreground broadcasts so can
2509 * execute in a different order.
2510 * @hide
2511 */
2512 public static final String ACTION_USER_STARTING =
2513 "android.intent.action.USER_STARTING";
2514
2515 /**
2516 * Broadcast sent when a user is going to be stopped. Carries an extra
2517 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2518 * sent to registered receivers, not manifest receivers. It is sent to all
2519 * users (including the one that is being stopped). You must hold
2520 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2521 * this broadcast. The user will not stop until all receivers have
2522 * handled the broadcast. This is sent as a background broadcast, since
2523 * its result is not part of the primary UX flow; to safely keep track of
2524 * started/stopped state of a user you can use this in conjunction with
2525 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2526 * other user state broadcasts since those are foreground broadcasts so can
2527 * execute in a different order.
2528 * @hide
2529 */
2530 public static final String ACTION_USER_STOPPING =
2531 "android.intent.action.USER_STOPPING";
2532
2533 /**
2534 * Broadcast sent to the system when a user is stopped. Carries an extra
2535 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2536 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2537 * specific package. This is only sent to registered receivers, not manifest
2538 * receivers. It is sent to all running users <em>except</em> the one that
2539 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002540 * @hide
2541 */
2542 public static final String ACTION_USER_STOPPED =
2543 "android.intent.action.USER_STOPPED";
2544
2545 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002546 * 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 -07002547 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002548 * one that has been removed. The user will not be completely removed until all receivers have
2549 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002550 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002551 * @hide
2552 */
2553 public static final String ACTION_USER_REMOVED =
2554 "android.intent.action.USER_REMOVED";
2555
2556 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002557 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002558 * the userHandle of the user to become the current one. This is only sent to
2559 * registered receivers, not manifest receivers. It is sent to all running users.
2560 * You must hold
2561 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002562 * @hide
2563 */
2564 public static final String ACTION_USER_SWITCHED =
2565 "android.intent.action.USER_SWITCHED";
2566
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002567 /**
2568 * Broadcast sent to the system when a user's information changes. Carries an extra
2569 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2570 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2571 * whose information has changed.
2572 * @hide
2573 */
2574 public static final String ACTION_USER_INFO_CHANGED =
2575 "android.intent.action.USER_INFO_CHANGED";
2576
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002577 /**
2578 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2579 */
2580 public static final String ACTION_QUICK_CLOCK =
2581 "android.intent.action.QUICK_CLOCK";
2582
Michael Wright0087a142013-02-05 16:29:39 -08002583 /**
2584 * Broadcast Action: This is broadcast when a user action should request the
2585 * brightness setting dialog.
2586 * @hide
2587 */
2588 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2589 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2590
Justin Kohd378ad72013-04-01 12:18:26 -07002591 /**
2592 * Broadcast Action: A global button was pressed. Includes a single
2593 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2594 * caused the broadcast.
2595 * @hide
2596 */
2597 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2598
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002599 // ---------------------------------------------------------------------
2600 // ---------------------------------------------------------------------
2601 // Standard intent categories (see addCategory()).
2602
2603 /**
2604 * Set if the activity should be an option for the default action
2605 * (center press) to perform on a piece of data. Setting this will
2606 * hide from the user any activities without it set when performing an
2607 * action on some data. Note that this is normal -not- set in the
2608 * Intent when initiating an action -- it is for use in intent filters
2609 * specified in packages.
2610 */
2611 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2612 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2613 /**
2614 * Activities that can be safely invoked from a browser must support this
2615 * category. For example, if the user is viewing a web page or an e-mail
2616 * and clicks on a link in the text, the Intent generated execute that
2617 * link will require the BROWSABLE category, so that only activities
2618 * supporting this category will be considered as possible actions. By
2619 * supporting this category, you are promising that there is nothing
2620 * damaging (without user intervention) that can happen by invoking any
2621 * matching Intent.
2622 */
2623 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2624 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2625 /**
2626 * Set if the activity should be considered as an alternative action to
2627 * the data the user is currently viewing. See also
2628 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2629 * applies to the selection in a list of items.
2630 *
2631 * <p>Supporting this category means that you would like your activity to be
2632 * displayed in the set of alternative things the user can do, usually as
2633 * part of the current activity's options menu. You will usually want to
2634 * include a specific label in the &lt;intent-filter&gt; of this action
2635 * describing to the user what it does.
2636 *
2637 * <p>The action of IntentFilter with this category is important in that it
2638 * describes the specific action the target will perform. This generally
2639 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2640 * a specific name such as "com.android.camera.action.CROP. Only one
2641 * alternative of any particular action will be shown to the user, so using
2642 * a specific action like this makes sure that your alternative will be
2643 * displayed while also allowing other applications to provide their own
2644 * overrides of that particular action.
2645 */
2646 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2647 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2648 /**
2649 * Set if the activity should be considered as an alternative selection
2650 * action to the data the user has currently selected. This is like
2651 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2652 * of items from which the user can select, giving them alternatives to the
2653 * default action that will be performed on it.
2654 */
2655 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2656 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2657 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002658 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002659 */
2660 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2661 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2662 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002663 * Should be displayed in the top-level launcher.
2664 */
2665 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2666 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2667 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002668 * Provides information about the package it is in; typically used if
2669 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2670 * a front-door to the user without having to be shown in the all apps list.
2671 */
2672 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2673 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2674 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002675 * This is the home activity, that is the first activity that is displayed
2676 * when the device boots.
2677 */
2678 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2679 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2680 /**
2681 * This activity is a preference panel.
2682 */
2683 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2684 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2685 /**
2686 * This activity is a development preference panel.
2687 */
2688 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2689 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2690 /**
2691 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002692 */
2693 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2694 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2695 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002696 * This activity allows the user to browse and download new applications.
2697 */
2698 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2699 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2700 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002701 * This activity may be exercised by the monkey or other automated test tools.
2702 */
2703 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2704 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2705 /**
2706 * To be used as a test (not part of the normal user experience).
2707 */
2708 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2709 /**
2710 * To be used as a unit test (run through the Test Harness).
2711 */
2712 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2713 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002714 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002715 * experience).
2716 */
2717 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2718 /**
2719 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002720 * ContentResolver.openInputStream. Openable URIs must support the columns in
2721 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002722 * when queried, though it is allowable for those columns to be blank.
2723 */
2724 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2725 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2726
2727 /**
2728 * To be used as code under test for framework instrumentation tests.
2729 */
2730 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2731 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002732 /**
2733 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002734 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2735 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002736 */
2737 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2738 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2739 /**
2740 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002741 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2742 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002743 */
2744 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2745 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002746 /**
2747 * An activity to run when device is inserted into a analog (low end) dock.
2748 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2749 * information, see {@link android.app.UiModeManager}.
2750 */
2751 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2752 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2753
2754 /**
2755 * An activity to run when device is inserted into a digital (high end) dock.
2756 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2757 * information, see {@link android.app.UiModeManager}.
2758 */
2759 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2760 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002761
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002762 /**
2763 * Used to indicate that the activity can be used in a car environment.
2764 */
2765 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2766 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2767
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002768 // ---------------------------------------------------------------------
2769 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002770 // Application launch intent categories (see addCategory()).
2771
2772 /**
2773 * Used with {@link #ACTION_MAIN} to launch the browser application.
2774 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002775 * <p>NOTE: This should not be used as the primary key of an Intent,
2776 * since it will not result in the app launching with the correct
2777 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002778 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002779 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002780 */
2781 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2782 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2783
2784 /**
2785 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2786 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002787 * <p>NOTE: This should not be used as the primary key of an Intent,
2788 * since it will not result in the app launching with the correct
2789 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002790 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002791 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002792 */
2793 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2794 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2795
2796 /**
2797 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2798 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002799 * <p>NOTE: This should not be used as the primary key of an Intent,
2800 * since it will not result in the app launching with the correct
2801 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002802 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002803 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002804 */
2805 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2806 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2807
2808 /**
2809 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2810 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002811 * <p>NOTE: This should not be used as the primary key of an Intent,
2812 * since it will not result in the app launching with the correct
2813 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002814 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002815 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002816 */
2817 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2818 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2819
2820 /**
2821 * Used with {@link #ACTION_MAIN} to launch the email application.
2822 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002823 * <p>NOTE: This should not be used as the primary key of an Intent,
2824 * since it will not result in the app launching with the correct
2825 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002826 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002827 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002828 */
2829 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2830 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2831
2832 /**
2833 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2834 * The activity should be able to view and manipulate image and video files
2835 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002836 * <p>NOTE: This should not be used as the primary key of an Intent,
2837 * since it will not result in the app launching with the correct
2838 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002839 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002840 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002841 */
2842 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2843 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2844
2845 /**
2846 * Used with {@link #ACTION_MAIN} to launch the maps application.
2847 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002848 * <p>NOTE: This should not be used as the primary key of an Intent,
2849 * since it will not result in the app launching with the correct
2850 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002851 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002852 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002853 */
2854 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2855 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2856
2857 /**
2858 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2859 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002860 * <p>NOTE: This should not be used as the primary key of an Intent,
2861 * since it will not result in the app launching with the correct
2862 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002863 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002864 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002865 */
2866 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2867 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2868
2869 /**
2870 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002871 * The activity should be able to play, browse, or manipulate music files
2872 * stored on the device.
2873 * <p>NOTE: This should not be used as the primary key of an Intent,
2874 * since it will not result in the app launching with the correct
2875 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002876 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002877 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002878 */
2879 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2880 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2881
2882 // ---------------------------------------------------------------------
2883 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002884 // Standard extra data keys.
2885
2886 /**
2887 * The initial data to place in a newly created record. Use with
2888 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2889 * fields as would be given to the underlying ContentProvider.insert()
2890 * call.
2891 */
2892 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2893
2894 /**
2895 * A constant CharSequence that is associated with the Intent, used with
2896 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2897 * this may be a styled CharSequence, so you must use
2898 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2899 * retrieve it.
2900 */
2901 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2902
2903 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002904 * A constant String that is associated with the Intent, used with
2905 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2906 * as HTML formatted text. Note that you <em>must</em> also supply
2907 * {@link #EXTRA_TEXT}.
2908 */
2909 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2910
2911 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002912 * A content: URI holding a stream of data associated with the Intent,
2913 * used with {@link #ACTION_SEND} to supply the data being sent.
2914 */
2915 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2916
2917 /**
2918 * A String[] holding e-mail addresses that should be delivered to.
2919 */
2920 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2921
2922 /**
2923 * A String[] holding e-mail addresses that should be carbon copied.
2924 */
2925 public static final String EXTRA_CC = "android.intent.extra.CC";
2926
2927 /**
2928 * A String[] holding e-mail addresses that should be blind carbon copied.
2929 */
2930 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2931
2932 /**
2933 * A constant string holding the desired subject line of a message.
2934 */
2935 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2936
2937 /**
2938 * An Intent describing the choices you would like shown with
2939 * {@link #ACTION_PICK_ACTIVITY}.
2940 */
2941 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2942
2943 /**
2944 * A CharSequence dialog title to provide to the user when used with a
2945 * {@link #ACTION_CHOOSER}.
2946 */
2947 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2948
2949 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002950 * A Parcelable[] of {@link Intent} or
2951 * {@link android.content.pm.LabeledIntent} objects as set with
2952 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2953 * a the front of the list of choices, when shown to the user with a
2954 * {@link #ACTION_CHOOSER}.
2955 */
2956 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2957
2958 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002959 * A {@link android.view.KeyEvent} object containing the event that
2960 * triggered the creation of the Intent it is in.
2961 */
2962 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2963
2964 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002965 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2966 * before shutting down.
2967 *
2968 * {@hide}
2969 */
2970 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2971
2972 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002973 * 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 -07002974 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2975 * of restarting the application.
2976 */
2977 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2978
2979 /**
2980 * A String holding the phone number originally entered in
2981 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2982 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2983 */
2984 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002985
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002986 /**
2987 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2988 * intents to supply the uid the package had been assigned. Also an optional
2989 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2990 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2991 * purpose.
2992 */
2993 public static final String EXTRA_UID = "android.intent.extra.UID";
2994
2995 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002996 * @hide String array of package names.
2997 */
2998 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
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 whether this represents a full uninstall (removing
3003 * both the code and its data) or a partial uninstall (leaving its data,
3004 * implying that this is an update).
3005 */
3006 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003007
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003008 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003009 * @hide
3010 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3011 * intents to indicate that at this point the package has been removed for
3012 * all users on the device.
3013 */
3014 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3015 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3016
3017 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003018 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3019 * intents to indicate that this is a replacement of the package, so this
3020 * broadcast will immediately be followed by an add broadcast for a
3021 * different version of the same package.
3022 */
3023 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003024
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003025 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003026 * Used as an int extra field in {@link android.app.AlarmManager} intents
3027 * to tell the application being invoked how many pending alarms are being
3028 * delievered with the intent. For one-shot alarms this will always be 1.
3029 * For recurring alarms, this might be greater than 1 if the device was
3030 * asleep or powered off at the time an earlier alarm would have been
3031 * delivered.
3032 */
3033 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003034
Jacek Surazski86b6c532009-05-13 14:38:28 +02003035 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003036 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3037 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003038 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3039 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003040 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3041 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3042 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003043 */
3044 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3045
3046 /**
3047 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3048 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003049 */
3050 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3051
3052 /**
3053 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3054 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003055 */
3056 public static final int EXTRA_DOCK_STATE_DESK = 1;
3057
3058 /**
3059 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3060 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003061 */
3062 public static final int EXTRA_DOCK_STATE_CAR = 2;
3063
3064 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003065 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3066 * to represent that the phone is in a analog (low end) dock.
3067 */
3068 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3069
3070 /**
3071 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3072 * to represent that the phone is in a digital (high end) dock.
3073 */
3074 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3075
3076 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003077 * Boolean that can be supplied as meta-data with a dock activity, to
3078 * indicate that the dock should take over the home key when it is active.
3079 */
3080 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003081
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003082 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003083 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3084 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003085 */
3086 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3087
3088 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003089 * Used in the extra field in the remote intent. It's astring token passed with the
3090 * remote intent.
3091 */
3092 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3093 "android.intent.extra.remote_intent_token";
3094
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003095 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003096 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003097 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003098 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003099 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003100 "android.intent.extra.changed_component_name";
3101
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003102 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003103 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003104 * and contains a string array of all of the components that have changed. If
3105 * the state of the overall package has changed, then it will contain an entry
3106 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003107 */
3108 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3109 "android.intent.extra.changed_component_name_list";
3110
3111 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003112 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003113 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3114 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003115 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003116 */
3117 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3118 "android.intent.extra.changed_package_list";
3119
3120 /**
3121 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003122 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3123 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003124 * and contains an integer array of uids of all of the components
3125 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003126 */
3127 public static final String EXTRA_CHANGED_UID_LIST =
3128 "android.intent.extra.changed_uid_list";
3129
3130 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003131 * @hide
3132 * Magic extra system code can use when binding, to give a label for
3133 * who it is that has bound to a service. This is an integer giving
3134 * a framework string resource that can be displayed to the user.
3135 */
3136 public static final String EXTRA_CLIENT_LABEL =
3137 "android.intent.extra.client_label";
3138
3139 /**
3140 * @hide
3141 * Magic extra system code can use when binding, to give a PendingIntent object
3142 * that can be launched for the user to disable the system's use of this
3143 * service.
3144 */
3145 public static final String EXTRA_CLIENT_INTENT =
3146 "android.intent.extra.client_intent";
3147
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003148 /**
3149 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3150 * data that is on the local device. This is a boolean extra; the default
3151 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3152 * the user to select media that is already on the device, not requiring it
3153 * be downloaded from a remote service when opened. Another way to look
3154 * at it is that such content should generally have a "_data" column to the
3155 * path of the content on local external storage.
3156 */
3157 public static final String EXTRA_LOCAL_ONLY =
3158 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003159
Amith Yamasani13593602012-03-22 16:16:17 -07003160 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003161 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3162 * user to select and return multiple items. This is a boolean extra; the default
3163 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3164 * present the user with a UI where they can pick multiple items that are all
3165 * returned to the caller. When this happens, they should be returned as
3166 * the {@link #getClipData()} part of the result Intent.
3167 */
3168 public static final String EXTRA_ALLOW_MULTIPLE =
3169 "android.intent.extra.ALLOW_MULTIPLE";
3170
3171 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003172 * The userHandle carried with broadcast intents related to addition, removal and switching of
3173 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003174 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3175 * @hide
3176 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003177 public static final String EXTRA_USER_HANDLE =
3178 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003179
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003180 /**
3181 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003182 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3183 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003184 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003185 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3186
3187 /**
3188 * Extra sent in the intent to the BroadcastReceiver that handles
3189 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3190 * the restrictions as key/value pairs.
3191 */
3192 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3193 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003194
Amith Yamasani86118ba2013-03-28 14:33:16 -07003195 /**
3196 * Extra used in the response from a BroadcastReceiver that handles
3197 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3198 */
3199 public static final String EXTRA_RESTRICTIONS_INTENT =
3200 "android.intent.extra.restrictions_intent";
3201
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003202 // ---------------------------------------------------------------------
3203 // ---------------------------------------------------------------------
3204 // Intent flags (see mFlags variable).
3205
3206 /**
3207 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003208 * perform read operations on the Uri in the Intent's data and any URIs
3209 * specified in its ClipData. When applying to an Intent's ClipData,
3210 * all URIs as well as recursive traversals through data or other ClipData
3211 * in Intent items will be granted; only the grant flags of the top-level
3212 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003213 */
3214 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3215 /**
3216 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003217 * perform write operations on the Uri in the Intent's data and any URIs
3218 * specified in its ClipData. When applying to an Intent's ClipData,
3219 * all URIs as well as recursive traversals through data or other ClipData
3220 * in Intent items will be granted; only the grant flags of the top-level
3221 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003222 */
3223 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3224 /**
3225 * Can be set by the caller to indicate that this Intent is coming from
3226 * a background operation, not from direct user interaction.
3227 */
3228 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3229 /**
3230 * A flag you can enable for debugging: when set, log messages will be
3231 * printed during the resolution of this intent to show you what has
3232 * been found to create the final resolved list.
3233 */
3234 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003235 /**
3236 * If set, this intent will not match any components in packages that
3237 * are currently stopped. If this is not set, then the default behavior
3238 * is to include such applications in the result.
3239 */
3240 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3241 /**
3242 * If set, this intent will always match any components in packages that
3243 * are currently stopped. This is the default behavior when
3244 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3245 * flags are set, this one wins (it allows overriding of exclude for
3246 * places where the framework may automatically set the exclude flag).
3247 */
3248 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003249
3250 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003251 * If set, the new activity is not kept in the history stack. As soon as
3252 * the user navigates away from it, the activity is finished. This may also
3253 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3254 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003255 */
3256 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3257 /**
3258 * If set, the activity will not be launched if it is already running
3259 * at the top of the history stack.
3260 */
3261 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3262 /**
3263 * If set, this activity will become the start of a new task on this
3264 * history stack. A task (from the activity that started it to the
3265 * next task activity) defines an atomic group of activities that the
3266 * user can move to. Tasks can be moved to the foreground and background;
3267 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003268 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003269 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3270 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003271 *
3272 * <p>This flag is generally used by activities that want
3273 * to present a "launcher" style behavior: they give the user a list of
3274 * separate things that can be done, which otherwise run completely
3275 * independently of the activity launching them.
3276 *
3277 * <p>When using this flag, if a task is already running for the activity
3278 * you are now starting, then a new activity will not be started; instead,
3279 * the current task will simply be brought to the front of the screen with
3280 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3281 * to disable this behavior.
3282 *
3283 * <p>This flag can not be used when the caller is requesting a result from
3284 * the activity being launched.
3285 */
3286 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3287 /**
3288 * <strong>Do not use this flag unless you are implementing your own
3289 * top-level application launcher.</strong> Used in conjunction with
3290 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3291 * behavior of bringing an existing task to the foreground. When set,
3292 * a new task is <em>always</em> started to host the Activity for the
3293 * Intent, regardless of whether there is already an existing task running
3294 * the same thing.
3295 *
3296 * <p><strong>Because the default system does not include graphical task management,
3297 * you should not use this flag unless you provide some way for a user to
3298 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003299 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003300 * <p>This flag is ignored if
3301 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3302 *
Scott Main7aee61f2011-02-08 11:25:01 -08003303 * <p>See
3304 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3305 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003306 */
3307 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3308 /**
3309 * If set, and the activity being launched is already running in the
3310 * current task, then instead of launching a new instance of that activity,
3311 * all of the other activities on top of it will be closed and this Intent
3312 * will be delivered to the (now on top) old activity as a new Intent.
3313 *
3314 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3315 * If D calls startActivity() with an Intent that resolves to the component
3316 * of activity B, then C and D will be finished and B receive the given
3317 * Intent, resulting in the stack now being: A, B.
3318 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003319 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003320 * either receive the new intent you are starting here in its
3321 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003322 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003323 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3324 * the same intent, then it will be finished and re-created; for all other
3325 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3326 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003327 *
3328 * <p>This launch mode can also be used to good effect in conjunction with
3329 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3330 * of a task, it will bring any currently running instance of that task
3331 * to the foreground, and then clear it to its root state. This is
3332 * especially useful, for example, when launching an activity from the
3333 * notification manager.
3334 *
Scott Main7aee61f2011-02-08 11:25:01 -08003335 * <p>See
3336 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3337 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003338 */
3339 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3340 /**
3341 * If set and this intent is being used to launch a new activity from an
3342 * existing one, then the reply target of the existing activity will be
3343 * transfered to the new activity. This way the new activity can call
3344 * {@link android.app.Activity#setResult} and have that result sent back to
3345 * the reply target of the original activity.
3346 */
3347 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3348 /**
3349 * If set and this intent is being used to launch a new activity from an
3350 * existing one, the current activity will not be counted as the top
3351 * activity for deciding whether the new intent should be delivered to
3352 * the top instead of starting a new one. The previous activity will
3353 * be used as the top, with the assumption being that the current activity
3354 * will finish itself immediately.
3355 */
3356 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3357 /**
3358 * If set, the new activity is not kept in the list of recently launched
3359 * activities.
3360 */
3361 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3362 /**
3363 * This flag is not normally set by application code, but set for you by
3364 * the system as described in the
3365 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3366 * launchMode} documentation for the singleTask mode.
3367 */
3368 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3369 /**
3370 * If set, and this activity is either being started in a new task or
3371 * bringing to the top an existing task, then it will be launched as
3372 * the front door of the task. This will result in the application of
3373 * any affinities needed to have that task in the proper state (either
3374 * moving activities to or from it), or simply resetting that task to
3375 * its initial state if needed.
3376 */
3377 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3378 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003379 * This flag is not normally set by application code, but set for you by
3380 * the system if this activity is being launched from history
3381 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003382 */
3383 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003384 /**
3385 * If set, this marks a point in the task's activity stack that should
3386 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003387 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003388 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3389 * the user re-launching it from home), this activity and all on top of
3390 * it will be finished so that the user does not return to them, but
3391 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003392 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003393 * <p>This is useful for cases where you have a logical break in your
3394 * application. For example, an e-mail application may have a command
3395 * to view an attachment, which launches an image view activity to
3396 * display it. This activity should be part of the e-mail application's
3397 * task, since it is a part of the task the user is involved in. However,
3398 * if the user leaves that task, and later selects the e-mail app from
3399 * home, we may like them to return to the conversation they were
3400 * viewing, not the picture attachment, since that is confusing. By
3401 * setting this flag when launching the image viewer, that viewer and
3402 * any activities it starts will be removed the next time the user returns
3403 * to mail.
3404 */
3405 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003406 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003407 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003408 * callback from occurring on the current frontmost activity before it is
3409 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003410 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003411 * <p>Typically, an activity can rely on that callback to indicate that an
3412 * explicit user action has caused their activity to be moved out of the
3413 * foreground. The callback marks an appropriate point in the activity's
3414 * lifecycle for it to dismiss any notifications that it intends to display
3415 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003416 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003417 * <p>If an activity is ever started via any non-user-driven events such as
3418 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3419 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003420 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003421 */
3422 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003423 /**
3424 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3425 * this flag will cause the launched activity to be brought to the front of its
3426 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003427 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003428 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3429 * If D calls startActivity() with an Intent that resolves to the component
3430 * of activity B, then B will be brought to the front of the history stack,
3431 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003432 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003433 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003434 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003435 */
3436 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003437 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003438 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3439 * this flag will prevent the system from applying an activity transition
3440 * animation to go to the next activity state. This doesn't mean an
3441 * animation will never run -- if another activity change happens that doesn't
3442 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003443 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003444 * when you are going to do a series of activity operations but the
3445 * animation seen by the user shouldn't be driven by the first activity
3446 * change but rather a later one.
3447 */
3448 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3449 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003450 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3451 * this flag will cause any existing task that would be associated with the
3452 * activity to be cleared before the activity is started. That is, the activity
3453 * becomes the new root of an otherwise empty task, and any old activities
3454 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3455 */
3456 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3457 /**
3458 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3459 * this flag will cause a newly launching task to be placed on top of the current
3460 * home activity task (if there is one). That is, pressing back from the task
3461 * will always return the user to home even if that was not the last activity they
3462 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3463 */
3464 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3465 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003466 * If set, when sending a broadcast only registered receivers will be
3467 * called -- no BroadcastReceiver components will be launched.
3468 */
3469 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003470 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003471 * If set, when sending a broadcast the new broadcast will replace
3472 * any existing pending broadcast that matches it. Matching is defined
3473 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3474 * true for the intents of the two broadcasts. When a match is found,
3475 * the new broadcast (and receivers associated with it) will replace the
3476 * existing one in the pending broadcast list, remaining at the same
3477 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003478 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003479 * <p>This flag is most typically used with sticky broadcasts, which
3480 * only care about delivering the most recent values of the broadcast
3481 * to their receivers.
3482 */
3483 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3484 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003485 * If set, when sending a broadcast the recipient is allowed to run at
3486 * foreground priority, with a shorter timeout interval. During normal
3487 * broadcasts the receivers are not automatically hoisted out of the
3488 * background priority class.
3489 */
3490 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3491 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003492 * If set, when sending a broadcast <i>before boot has completed</i> only
3493 * registered receivers will be called -- no BroadcastReceiver components
3494 * will be launched. Sticky intent state will be recorded properly even
3495 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3496 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003497 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003498 * <p>This flag is only for use by system sevices as a convenience to
3499 * avoid having to implement a more complex mechanism around detection
3500 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003501 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003502 * @hide
3503 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003504 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003505 /**
3506 * Set when this broadcast is for a boot upgrade, a special mode that
3507 * allows the broadcast to be sent before the system is ready and launches
3508 * the app process with no providers running in it.
3509 * @hide
3510 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003511 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003512
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003513 /**
3514 * @hide Flags that can't be changed with PendingIntent.
3515 */
3516 public static final int IMMUTABLE_FLAGS =
3517 FLAG_GRANT_READ_URI_PERMISSION
3518 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003519
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003520 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003521 // ---------------------------------------------------------------------
3522 // toUri() and parseUri() options.
3523
3524 /**
3525 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3526 * always has the "intent:" scheme. This syntax can be used when you want
3527 * to later disambiguate between URIs that are intended to describe an
3528 * Intent vs. all others that should be treated as raw URIs. When used
3529 * with {@link #parseUri}, any other scheme will result in a generic
3530 * VIEW action for that raw URI.
3531 */
3532 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003533
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003534 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003535
3536 private String mAction;
3537 private Uri mData;
3538 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003539 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003540 private ComponentName mComponent;
3541 private int mFlags;
3542 private HashSet<String> mCategories;
3543 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003544 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003545 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003546 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003547
3548 // ---------------------------------------------------------------------
3549
3550 /**
3551 * Create an empty intent.
3552 */
3553 public Intent() {
3554 }
3555
3556 /**
3557 * Copy constructor.
3558 */
3559 public Intent(Intent o) {
3560 this.mAction = o.mAction;
3561 this.mData = o.mData;
3562 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003563 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003564 this.mComponent = o.mComponent;
3565 this.mFlags = o.mFlags;
3566 if (o.mCategories != null) {
3567 this.mCategories = new HashSet<String>(o.mCategories);
3568 }
3569 if (o.mExtras != null) {
3570 this.mExtras = new Bundle(o.mExtras);
3571 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003572 if (o.mSourceBounds != null) {
3573 this.mSourceBounds = new Rect(o.mSourceBounds);
3574 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003575 if (o.mSelector != null) {
3576 this.mSelector = new Intent(o.mSelector);
3577 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003578 if (o.mClipData != null) {
3579 this.mClipData = new ClipData(o.mClipData);
3580 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003581 }
3582
3583 @Override
3584 public Object clone() {
3585 return new Intent(this);
3586 }
3587
3588 private Intent(Intent o, boolean all) {
3589 this.mAction = o.mAction;
3590 this.mData = o.mData;
3591 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003592 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003593 this.mComponent = o.mComponent;
3594 if (o.mCategories != null) {
3595 this.mCategories = new HashSet<String>(o.mCategories);
3596 }
3597 }
3598
3599 /**
3600 * Make a clone of only the parts of the Intent that are relevant for
3601 * filter matching: the action, data, type, component, and categories.
3602 */
3603 public Intent cloneFilter() {
3604 return new Intent(this, false);
3605 }
3606
3607 /**
3608 * Create an intent with a given action. All other fields (data, type,
3609 * class) are null. Note that the action <em>must</em> be in a
3610 * namespace because Intents are used globally in the system -- for
3611 * example the system VIEW action is android.intent.action.VIEW; an
3612 * application's custom action would be something like
3613 * com.google.app.myapp.CUSTOM_ACTION.
3614 *
3615 * @param action The Intent action, such as ACTION_VIEW.
3616 */
3617 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003618 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003619 }
3620
3621 /**
3622 * Create an intent with a given action and for a given data url. Note
3623 * that the action <em>must</em> be in a namespace because Intents are
3624 * used globally in the system -- for example the system VIEW action is
3625 * android.intent.action.VIEW; an application's custom action would be
3626 * something like com.google.app.myapp.CUSTOM_ACTION.
3627 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003628 * <p><em>Note: scheme and host name matching in the Android framework is
3629 * case-sensitive, unlike the formal RFC. As a result,
3630 * you should always ensure that you write your Uri with these elements
3631 * using lower case letters, and normalize any Uris you receive from
3632 * outside of Android to ensure the scheme and host is lower case.</em></p>
3633 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 * @param action The Intent action, such as ACTION_VIEW.
3635 * @param uri The Intent data URI.
3636 */
3637 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003638 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003639 mData = uri;
3640 }
3641
3642 /**
3643 * Create an intent for a specific component. All other fields (action, data,
3644 * type, class) are null, though they can be modified later with explicit
3645 * calls. This provides a convenient way to create an intent that is
3646 * intended to execute a hard-coded class name, rather than relying on the
3647 * system to find an appropriate class for you; see {@link #setComponent}
3648 * for more information on the repercussions of this.
3649 *
3650 * @param packageContext A Context of the application package implementing
3651 * this class.
3652 * @param cls The component class that is to be used for the intent.
3653 *
3654 * @see #setClass
3655 * @see #setComponent
3656 * @see #Intent(String, android.net.Uri , Context, Class)
3657 */
3658 public Intent(Context packageContext, Class<?> cls) {
3659 mComponent = new ComponentName(packageContext, cls);
3660 }
3661
3662 /**
3663 * Create an intent for a specific component with a specified action and data.
3664 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3665 * construct the Intent and then calling {@link #setClass} to set its
3666 * class.
3667 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003668 * <p><em>Note: scheme and host name matching in the Android framework is
3669 * case-sensitive, unlike the formal RFC. As a result,
3670 * you should always ensure that you write your Uri with these elements
3671 * using lower case letters, and normalize any Uris you receive from
3672 * outside of Android to ensure the scheme and host is lower case.</em></p>
3673 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003674 * @param action The Intent action, such as ACTION_VIEW.
3675 * @param uri The Intent data URI.
3676 * @param packageContext A Context of the application package implementing
3677 * this class.
3678 * @param cls The component class that is to be used for the intent.
3679 *
3680 * @see #Intent(String, android.net.Uri)
3681 * @see #Intent(Context, Class)
3682 * @see #setClass
3683 * @see #setComponent
3684 */
3685 public Intent(String action, Uri uri,
3686 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003687 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003688 mData = uri;
3689 mComponent = new ComponentName(packageContext, cls);
3690 }
3691
3692 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003693 * Create an intent to launch the main (root) activity of a task. This
3694 * is the Intent that is started when the application's is launched from
3695 * Home. For anything else that wants to launch an application in the
3696 * same way, it is important that they use an Intent structured the same
3697 * way, and can use this function to ensure this is the case.
3698 *
3699 * <p>The returned Intent has the given Activity component as its explicit
3700 * component, {@link #ACTION_MAIN} as its action, and includes the
3701 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3702 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3703 * to do that through {@link #addFlags(int)} on the returned Intent.
3704 *
3705 * @param mainActivity The main activity component that this Intent will
3706 * launch.
3707 * @return Returns a newly created Intent that can be used to launch the
3708 * activity as a main application entry.
3709 *
3710 * @see #setClass
3711 * @see #setComponent
3712 */
3713 public static Intent makeMainActivity(ComponentName mainActivity) {
3714 Intent intent = new Intent(ACTION_MAIN);
3715 intent.setComponent(mainActivity);
3716 intent.addCategory(CATEGORY_LAUNCHER);
3717 return intent;
3718 }
3719
3720 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003721 * Make an Intent for the main activity of an application, without
3722 * specifying a specific activity to run but giving a selector to find
3723 * the activity. This results in a final Intent that is structured
3724 * the same as when the application is launched from
3725 * Home. For anything else that wants to launch an application in the
3726 * same way, it is important that they use an Intent structured the same
3727 * way, and can use this function to ensure this is the case.
3728 *
3729 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3730 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3731 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3732 * to do that through {@link #addFlags(int)} on the returned Intent.
3733 *
3734 * @param selectorAction The action name of the Intent's selector.
3735 * @param selectorCategory The name of a category to add to the Intent's
3736 * selector.
3737 * @return Returns a newly created Intent that can be used to launch the
3738 * activity as a main application entry.
3739 *
3740 * @see #setSelector(Intent)
3741 */
3742 public static Intent makeMainSelectorActivity(String selectorAction,
3743 String selectorCategory) {
3744 Intent intent = new Intent(ACTION_MAIN);
3745 intent.addCategory(CATEGORY_LAUNCHER);
3746 Intent selector = new Intent();
3747 selector.setAction(selectorAction);
3748 selector.addCategory(selectorCategory);
3749 intent.setSelector(selector);
3750 return intent;
3751 }
3752
3753 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003754 * Make an Intent that can be used to re-launch an application's task
3755 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3756 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3757 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3758 *
3759 * @param mainActivity The activity component that is the root of the
3760 * task; this is the activity that has been published in the application's
3761 * manifest as the main launcher icon.
3762 *
3763 * @return Returns a newly created Intent that can be used to relaunch the
3764 * activity's task in its root state.
3765 */
3766 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3767 Intent intent = makeMainActivity(mainActivity);
3768 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3769 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3770 return intent;
3771 }
3772
3773 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003774 * Call {@link #parseUri} with 0 flags.
3775 * @deprecated Use {@link #parseUri} instead.
3776 */
3777 @Deprecated
3778 public static Intent getIntent(String uri) throws URISyntaxException {
3779 return parseUri(uri, 0);
3780 }
Tom Taylord4a47292009-12-21 13:59:18 -08003781
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003782 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003783 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003784 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003785 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003786 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003787 *
3788 * <p>The URI given here must not be relative -- that is, it must include
3789 * the scheme and full path.
3790 *
3791 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003792 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003793 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003794 *
3795 * @return Intent The newly created Intent object.
3796 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003797 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3798 * it bad (as parsed by the Uri class) or the Intent data within the
3799 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003800 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003801 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003802 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003803 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003804 int i = 0;
3805 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003806 // Validate intent scheme for if requested.
3807 if ((flags&URI_INTENT_SCHEME) != 0) {
3808 if (!uri.startsWith("intent:")) {
3809 Intent intent = new Intent(ACTION_VIEW);
3810 try {
3811 intent.setData(Uri.parse(uri));
3812 } catch (IllegalArgumentException e) {
3813 throw new URISyntaxException(uri, e.getMessage());
3814 }
3815 return intent;
3816 }
3817 }
Tom Taylord4a47292009-12-21 13:59:18 -08003818
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003819 // simple case
3820 i = uri.lastIndexOf("#");
3821 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3822
3823 // old format Intent URI
3824 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003825
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003826 // new format
3827 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003828 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003829
3830 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003831 String data = i >= 0 ? uri.substring(0, i) : null;
3832 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003833 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003834
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003835 // loop over contents of Intent, all name=value;
3836 while (!uri.startsWith("end", i)) {
3837 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003838 if (eq < 0) eq = i-1;
3839 int semi = uri.indexOf(';', i);
3840 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003841
3842 // action
3843 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003844 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003845 }
3846
3847 // categories
3848 else if (uri.startsWith("category=", i)) {
3849 intent.addCategory(value);
3850 }
3851
3852 // type
3853 else if (uri.startsWith("type=", i)) {
3854 intent.mType = value;
3855 }
3856
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003857 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003858 else if (uri.startsWith("launchFlags=", i)) {
3859 intent.mFlags = Integer.decode(value).intValue();
3860 }
3861
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003862 // package
3863 else if (uri.startsWith("package=", i)) {
3864 intent.mPackage = value;
3865 }
3866
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003867 // component
3868 else if (uri.startsWith("component=", i)) {
3869 intent.mComponent = ComponentName.unflattenFromString(value);
3870 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003871
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003872 // scheme
3873 else if (uri.startsWith("scheme=", i)) {
3874 scheme = value;
3875 }
3876
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003877 // source bounds
3878 else if (uri.startsWith("sourceBounds=", i)) {
3879 intent.mSourceBounds = Rect.unflattenFromString(value);
3880 }
3881
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003882 // selector
3883 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3884 intent = new Intent();
3885 }
3886
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003887 // extra
3888 else {
3889 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003890 // create Bundle if it doesn't already exist
3891 if (intent.mExtras == null) intent.mExtras = new Bundle();
3892 Bundle b = intent.mExtras;
3893 // add EXTRA
3894 if (uri.startsWith("S.", i)) b.putString(key, value);
3895 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3896 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3897 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3898 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3899 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3900 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3901 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3902 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3903 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3904 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003905
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003906 // move to the next item
3907 i = semi + 1;
3908 }
3909
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003910 if (intent != baseIntent) {
3911 // The Intent had a selector; fix it up.
3912 baseIntent.setSelector(intent);
3913 intent = baseIntent;
3914 }
3915
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003916 if (data != null) {
3917 if (data.startsWith("intent:")) {
3918 data = data.substring(7);
3919 if (scheme != null) {
3920 data = scheme + ':' + data;
3921 }
3922 }
Tom Taylord4a47292009-12-21 13:59:18 -08003923
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003924 if (data.length() > 0) {
3925 try {
3926 intent.mData = Uri.parse(data);
3927 } catch (IllegalArgumentException e) {
3928 throw new URISyntaxException(uri, e.getMessage());
3929 }
3930 }
3931 }
Tom Taylord4a47292009-12-21 13:59:18 -08003932
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003933 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003934
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003935 } catch (IndexOutOfBoundsException e) {
3936 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3937 }
3938 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003939
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003940 public static Intent getIntentOld(String uri) throws URISyntaxException {
3941 Intent intent;
3942
3943 int i = uri.lastIndexOf('#');
3944 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003945 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003946 final int intentFragmentStart = i;
3947 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003948
3949 i++;
3950
3951 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003952 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003953 i += 7;
3954 int j = uri.indexOf(')', i);
3955 action = uri.substring(i, j);
3956 i = j + 1;
3957 }
3958
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003959 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003960
3961 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003962 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003963 i += 11;
3964 int j = uri.indexOf(')', i);
3965 while (i < j) {
3966 int sep = uri.indexOf('!', i);
3967 if (sep < 0) sep = j;
3968 if (i < sep) {
3969 intent.addCategory(uri.substring(i, sep));
3970 }
3971 i = sep + 1;
3972 }
3973 i = j + 1;
3974 }
3975
3976 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003977 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003978 i += 5;
3979 int j = uri.indexOf(')', i);
3980 intent.mType = uri.substring(i, j);
3981 i = j + 1;
3982 }
3983
3984 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003985 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003986 i += 12;
3987 int j = uri.indexOf(')', i);
3988 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3989 i = j + 1;
3990 }
3991
3992 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003993 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003994 i += 10;
3995 int j = uri.indexOf(')', i);
3996 int sep = uri.indexOf('!', i);
3997 if (sep >= 0 && sep < j) {
3998 String pkg = uri.substring(i, sep);
3999 String cls = uri.substring(sep + 1, j);
4000 intent.mComponent = new ComponentName(pkg, cls);
4001 }
4002 i = j + 1;
4003 }
4004
4005 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004006 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004007 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004008
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004009 final int closeParen = uri.indexOf(')', i);
4010 if (closeParen == -1) throw new URISyntaxException(uri,
4011 "EXTRA missing trailing ')'", i);
4012
4013 while (i < closeParen) {
4014 // fetch the key value
4015 int j = uri.indexOf('=', i);
4016 if (j <= i + 1 || i >= closeParen) {
4017 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4018 }
4019 char type = uri.charAt(i);
4020 i++;
4021 String key = uri.substring(i, j);
4022 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004023
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004024 // get type-value
4025 j = uri.indexOf('!', i);
4026 if (j == -1 || j >= closeParen) j = closeParen;
4027 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4028 String value = uri.substring(i, j);
4029 i = j;
4030
4031 // create Bundle if it doesn't already exist
4032 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004033
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004034 // add item to bundle
4035 try {
4036 switch (type) {
4037 case 'S':
4038 intent.mExtras.putString(key, Uri.decode(value));
4039 break;
4040 case 'B':
4041 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4042 break;
4043 case 'b':
4044 intent.mExtras.putByte(key, Byte.parseByte(value));
4045 break;
4046 case 'c':
4047 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4048 break;
4049 case 'd':
4050 intent.mExtras.putDouble(key, Double.parseDouble(value));
4051 break;
4052 case 'f':
4053 intent.mExtras.putFloat(key, Float.parseFloat(value));
4054 break;
4055 case 'i':
4056 intent.mExtras.putInt(key, Integer.parseInt(value));
4057 break;
4058 case 'l':
4059 intent.mExtras.putLong(key, Long.parseLong(value));
4060 break;
4061 case 's':
4062 intent.mExtras.putShort(key, Short.parseShort(value));
4063 break;
4064 default:
4065 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4066 }
4067 } catch (NumberFormatException e) {
4068 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4069 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004070
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004071 char ch = uri.charAt(i);
4072 if (ch == ')') break;
4073 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4074 i++;
4075 }
4076 }
4077
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004078 if (isIntentFragment) {
4079 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4080 } else {
4081 intent.mData = Uri.parse(uri);
4082 }
Tom Taylord4a47292009-12-21 13:59:18 -08004083
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004084 if (intent.mAction == null) {
4085 // By default, if no action is specified, then use VIEW.
4086 intent.mAction = ACTION_VIEW;
4087 }
4088
4089 } else {
4090 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4091 }
4092
4093 return intent;
4094 }
4095
4096 /**
4097 * Retrieve the general action to be performed, such as
4098 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4099 * the information in the intent should be interpreted -- most importantly,
4100 * what to do with the data returned by {@link #getData}.
4101 *
4102 * @return The action of this intent or null if none is specified.
4103 *
4104 * @see #setAction
4105 */
4106 public String getAction() {
4107 return mAction;
4108 }
4109
4110 /**
4111 * Retrieve data this intent is operating on. This URI specifies the name
4112 * of the data; often it uses the content: scheme, specifying data in a
4113 * content provider. Other schemes may be handled by specific activities,
4114 * such as http: by the web browser.
4115 *
4116 * @return The URI of the data this intent is targeting or null.
4117 *
4118 * @see #getScheme
4119 * @see #setData
4120 */
4121 public Uri getData() {
4122 return mData;
4123 }
4124
4125 /**
4126 * The same as {@link #getData()}, but returns the URI as an encoded
4127 * String.
4128 */
4129 public String getDataString() {
4130 return mData != null ? mData.toString() : null;
4131 }
4132
4133 /**
4134 * Return the scheme portion of the intent's data. If the data is null or
4135 * does not include a scheme, null is returned. Otherwise, the scheme
4136 * prefix without the final ':' is returned, i.e. "http".
4137 *
4138 * <p>This is the same as calling getData().getScheme() (and checking for
4139 * null data).
4140 *
4141 * @return The scheme of this intent.
4142 *
4143 * @see #getData
4144 */
4145 public String getScheme() {
4146 return mData != null ? mData.getScheme() : null;
4147 }
4148
4149 /**
4150 * Retrieve any explicit MIME type included in the intent. This is usually
4151 * null, as the type is determined by the intent data.
4152 *
4153 * @return If a type was manually set, it is returned; else null is
4154 * returned.
4155 *
4156 * @see #resolveType(ContentResolver)
4157 * @see #setType
4158 */
4159 public String getType() {
4160 return mType;
4161 }
4162
4163 /**
4164 * Return the MIME data type of this intent. If the type field is
4165 * explicitly set, that is simply returned. Otherwise, if the data is set,
4166 * the type of that data is returned. If neither fields are set, a null is
4167 * returned.
4168 *
4169 * @return The MIME type of this intent.
4170 *
4171 * @see #getType
4172 * @see #resolveType(ContentResolver)
4173 */
4174 public String resolveType(Context context) {
4175 return resolveType(context.getContentResolver());
4176 }
4177
4178 /**
4179 * Return the MIME data type of this intent. If the type field is
4180 * explicitly set, that is simply returned. Otherwise, if the data is set,
4181 * the type of that data is returned. If neither fields are set, a null is
4182 * returned.
4183 *
4184 * @param resolver A ContentResolver that can be used to determine the MIME
4185 * type of the intent's data.
4186 *
4187 * @return The MIME type of this intent.
4188 *
4189 * @see #getType
4190 * @see #resolveType(Context)
4191 */
4192 public String resolveType(ContentResolver resolver) {
4193 if (mType != null) {
4194 return mType;
4195 }
4196 if (mData != null) {
4197 if ("content".equals(mData.getScheme())) {
4198 return resolver.getType(mData);
4199 }
4200 }
4201 return null;
4202 }
4203
4204 /**
4205 * Return the MIME data type of this intent, only if it will be needed for
4206 * intent resolution. This is not generally useful for application code;
4207 * it is used by the frameworks for communicating with back-end system
4208 * services.
4209 *
4210 * @param resolver A ContentResolver that can be used to determine the MIME
4211 * type of the intent's data.
4212 *
4213 * @return The MIME type of this intent, or null if it is unknown or not
4214 * needed.
4215 */
4216 public String resolveTypeIfNeeded(ContentResolver resolver) {
4217 if (mComponent != null) {
4218 return mType;
4219 }
4220 return resolveType(resolver);
4221 }
4222
4223 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004224 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004225 *
4226 * @param category The category to check.
4227 *
4228 * @return boolean True if the intent contains the category, else false.
4229 *
4230 * @see #getCategories
4231 * @see #addCategory
4232 */
4233 public boolean hasCategory(String category) {
4234 return mCategories != null && mCategories.contains(category);
4235 }
4236
4237 /**
4238 * Return the set of all categories in the intent. If there are no categories,
4239 * returns NULL.
4240 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004241 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004242 *
4243 * @see #hasCategory
4244 * @see #addCategory
4245 */
4246 public Set<String> getCategories() {
4247 return mCategories;
4248 }
4249
4250 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004251 * Return the specific selector associated with this Intent. If there is
4252 * none, returns null. See {@link #setSelector} for more information.
4253 *
4254 * @see #setSelector
4255 */
4256 public Intent getSelector() {
4257 return mSelector;
4258 }
4259
4260 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004261 * Return the {@link ClipData} associated with this Intent. If there is
4262 * none, returns null. See {@link #setClipData} for more information.
4263 *
4264 * @see #setClipData;
4265 */
4266 public ClipData getClipData() {
4267 return mClipData;
4268 }
4269
4270 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004271 * Sets the ClassLoader that will be used when unmarshalling
4272 * any Parcelable values from the extras of this Intent.
4273 *
4274 * @param loader a ClassLoader, or null to use the default loader
4275 * at the time of unmarshalling.
4276 */
4277 public void setExtrasClassLoader(ClassLoader loader) {
4278 if (mExtras != null) {
4279 mExtras.setClassLoader(loader);
4280 }
4281 }
4282
4283 /**
4284 * Returns true if an extra value is associated with the given name.
4285 * @param name the extra's name
4286 * @return true if the given extra is present.
4287 */
4288 public boolean hasExtra(String name) {
4289 return mExtras != null && mExtras.containsKey(name);
4290 }
4291
4292 /**
4293 * Returns true if the Intent's extras contain a parcelled file descriptor.
4294 * @return true if the Intent contains a parcelled file descriptor.
4295 */
4296 public boolean hasFileDescriptors() {
4297 return mExtras != null && mExtras.hasFileDescriptors();
4298 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004299
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004300 /** @hide */
4301 public void setAllowFds(boolean allowFds) {
4302 if (mExtras != null) {
4303 mExtras.setAllowFds(allowFds);
4304 }
4305 }
4306
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004307 /**
4308 * Retrieve extended data from the intent.
4309 *
4310 * @param name The name of the desired item.
4311 *
4312 * @return the value of an item that previously added with putExtra()
4313 * or null if none was found.
4314 *
4315 * @deprecated
4316 * @hide
4317 */
4318 @Deprecated
4319 public Object getExtra(String name) {
4320 return getExtra(name, null);
4321 }
4322
4323 /**
4324 * Retrieve extended data from the intent.
4325 *
4326 * @param name The name of the desired item.
4327 * @param defaultValue the value to be returned if no value of the desired
4328 * type is stored with the given name.
4329 *
4330 * @return the value of an item that previously added with putExtra()
4331 * or the default value if none was found.
4332 *
4333 * @see #putExtra(String, boolean)
4334 */
4335 public boolean getBooleanExtra(String name, boolean defaultValue) {
4336 return mExtras == null ? defaultValue :
4337 mExtras.getBoolean(name, defaultValue);
4338 }
4339
4340 /**
4341 * Retrieve extended data from the intent.
4342 *
4343 * @param name The name of the desired item.
4344 * @param defaultValue the value to be returned if no value of the desired
4345 * type is stored with the given name.
4346 *
4347 * @return the value of an item that previously added with putExtra()
4348 * or the default value if none was found.
4349 *
4350 * @see #putExtra(String, byte)
4351 */
4352 public byte getByteExtra(String name, byte defaultValue) {
4353 return mExtras == null ? defaultValue :
4354 mExtras.getByte(name, defaultValue);
4355 }
4356
4357 /**
4358 * Retrieve extended data from the intent.
4359 *
4360 * @param name The name of the desired item.
4361 * @param defaultValue the value to be returned if no value of the desired
4362 * type is stored with the given name.
4363 *
4364 * @return the value of an item that previously added with putExtra()
4365 * or the default value if none was found.
4366 *
4367 * @see #putExtra(String, short)
4368 */
4369 public short getShortExtra(String name, short defaultValue) {
4370 return mExtras == null ? defaultValue :
4371 mExtras.getShort(name, defaultValue);
4372 }
4373
4374 /**
4375 * Retrieve extended data from the intent.
4376 *
4377 * @param name The name of the desired item.
4378 * @param defaultValue the value to be returned if no value of the desired
4379 * type is stored with the given name.
4380 *
4381 * @return the value of an item that previously added with putExtra()
4382 * or the default value if none was found.
4383 *
4384 * @see #putExtra(String, char)
4385 */
4386 public char getCharExtra(String name, char defaultValue) {
4387 return mExtras == null ? defaultValue :
4388 mExtras.getChar(name, defaultValue);
4389 }
4390
4391 /**
4392 * Retrieve extended data from the intent.
4393 *
4394 * @param name The name of the desired item.
4395 * @param defaultValue the value to be returned if no value of the desired
4396 * type is stored with the given name.
4397 *
4398 * @return the value of an item that previously added with putExtra()
4399 * or the default value if none was found.
4400 *
4401 * @see #putExtra(String, int)
4402 */
4403 public int getIntExtra(String name, int defaultValue) {
4404 return mExtras == null ? defaultValue :
4405 mExtras.getInt(name, defaultValue);
4406 }
4407
4408 /**
4409 * Retrieve extended data from the intent.
4410 *
4411 * @param name The name of the desired item.
4412 * @param defaultValue the value to be returned if no value of the desired
4413 * type is stored with the given name.
4414 *
4415 * @return the value of an item that previously added with putExtra()
4416 * or the default value if none was found.
4417 *
4418 * @see #putExtra(String, long)
4419 */
4420 public long getLongExtra(String name, long defaultValue) {
4421 return mExtras == null ? defaultValue :
4422 mExtras.getLong(name, defaultValue);
4423 }
4424
4425 /**
4426 * Retrieve extended data from the intent.
4427 *
4428 * @param name The name of the desired item.
4429 * @param defaultValue the value to be returned if no value of the desired
4430 * type is stored with the given name.
4431 *
4432 * @return the value of an item that previously added with putExtra(),
4433 * or the default value if no such item is present
4434 *
4435 * @see #putExtra(String, float)
4436 */
4437 public float getFloatExtra(String name, float defaultValue) {
4438 return mExtras == null ? defaultValue :
4439 mExtras.getFloat(name, defaultValue);
4440 }
4441
4442 /**
4443 * Retrieve extended data from the intent.
4444 *
4445 * @param name The name of the desired item.
4446 * @param defaultValue the value to be returned if no value of the desired
4447 * type is stored with the given name.
4448 *
4449 * @return the value of an item that previously added with putExtra()
4450 * or the default value if none was found.
4451 *
4452 * @see #putExtra(String, double)
4453 */
4454 public double getDoubleExtra(String name, double defaultValue) {
4455 return mExtras == null ? defaultValue :
4456 mExtras.getDouble(name, defaultValue);
4457 }
4458
4459 /**
4460 * Retrieve extended data from the intent.
4461 *
4462 * @param name The name of the desired item.
4463 *
4464 * @return the value of an item that previously added with putExtra()
4465 * or null if no String value was found.
4466 *
4467 * @see #putExtra(String, String)
4468 */
4469 public String getStringExtra(String name) {
4470 return mExtras == null ? null : mExtras.getString(name);
4471 }
4472
4473 /**
4474 * Retrieve extended data from the intent.
4475 *
4476 * @param name The name of the desired item.
4477 *
4478 * @return the value of an item that previously added with putExtra()
4479 * or null if no CharSequence value was found.
4480 *
4481 * @see #putExtra(String, CharSequence)
4482 */
4483 public CharSequence getCharSequenceExtra(String name) {
4484 return mExtras == null ? null : mExtras.getCharSequence(name);
4485 }
4486
4487 /**
4488 * Retrieve extended data from the intent.
4489 *
4490 * @param name The name of the desired item.
4491 *
4492 * @return the value of an item that previously added with putExtra()
4493 * or null if no Parcelable value was found.
4494 *
4495 * @see #putExtra(String, Parcelable)
4496 */
4497 public <T extends Parcelable> T getParcelableExtra(String name) {
4498 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4499 }
4500
4501 /**
4502 * Retrieve extended data from the intent.
4503 *
4504 * @param name The name of the desired item.
4505 *
4506 * @return the value of an item that previously added with putExtra()
4507 * or null if no Parcelable[] value was found.
4508 *
4509 * @see #putExtra(String, Parcelable[])
4510 */
4511 public Parcelable[] getParcelableArrayExtra(String name) {
4512 return mExtras == null ? null : mExtras.getParcelableArray(name);
4513 }
4514
4515 /**
4516 * Retrieve extended data from the intent.
4517 *
4518 * @param name The name of the desired item.
4519 *
4520 * @return the value of an item that previously added with putExtra()
4521 * or null if no ArrayList<Parcelable> value was found.
4522 *
4523 * @see #putParcelableArrayListExtra(String, ArrayList)
4524 */
4525 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4526 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4527 }
4528
4529 /**
4530 * Retrieve extended data from the intent.
4531 *
4532 * @param name The name of the desired item.
4533 *
4534 * @return the value of an item that previously added with putExtra()
4535 * or null if no Serializable value was found.
4536 *
4537 * @see #putExtra(String, Serializable)
4538 */
4539 public Serializable getSerializableExtra(String name) {
4540 return mExtras == null ? null : mExtras.getSerializable(name);
4541 }
4542
4543 /**
4544 * Retrieve extended data from the intent.
4545 *
4546 * @param name The name of the desired item.
4547 *
4548 * @return the value of an item that previously added with putExtra()
4549 * or null if no ArrayList<Integer> value was found.
4550 *
4551 * @see #putIntegerArrayListExtra(String, ArrayList)
4552 */
4553 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4554 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4555 }
4556
4557 /**
4558 * Retrieve extended data from the intent.
4559 *
4560 * @param name The name of the desired item.
4561 *
4562 * @return the value of an item that previously added with putExtra()
4563 * or null if no ArrayList<String> value was found.
4564 *
4565 * @see #putStringArrayListExtra(String, ArrayList)
4566 */
4567 public ArrayList<String> getStringArrayListExtra(String name) {
4568 return mExtras == null ? null : mExtras.getStringArrayList(name);
4569 }
4570
4571 /**
4572 * Retrieve extended data from the intent.
4573 *
4574 * @param name The name of the desired item.
4575 *
4576 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004577 * or null if no ArrayList<CharSequence> value was found.
4578 *
4579 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4580 */
4581 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4582 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4583 }
4584
4585 /**
4586 * Retrieve extended data from the intent.
4587 *
4588 * @param name The name of the desired item.
4589 *
4590 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004591 * or null if no boolean array value was found.
4592 *
4593 * @see #putExtra(String, boolean[])
4594 */
4595 public boolean[] getBooleanArrayExtra(String name) {
4596 return mExtras == null ? null : mExtras.getBooleanArray(name);
4597 }
4598
4599 /**
4600 * Retrieve extended data from the intent.
4601 *
4602 * @param name The name of the desired item.
4603 *
4604 * @return the value of an item that previously added with putExtra()
4605 * or null if no byte array value was found.
4606 *
4607 * @see #putExtra(String, byte[])
4608 */
4609 public byte[] getByteArrayExtra(String name) {
4610 return mExtras == null ? null : mExtras.getByteArray(name);
4611 }
4612
4613 /**
4614 * Retrieve extended data from the intent.
4615 *
4616 * @param name The name of the desired item.
4617 *
4618 * @return the value of an item that previously added with putExtra()
4619 * or null if no short array value was found.
4620 *
4621 * @see #putExtra(String, short[])
4622 */
4623 public short[] getShortArrayExtra(String name) {
4624 return mExtras == null ? null : mExtras.getShortArray(name);
4625 }
4626
4627 /**
4628 * Retrieve extended data from the intent.
4629 *
4630 * @param name The name of the desired item.
4631 *
4632 * @return the value of an item that previously added with putExtra()
4633 * or null if no char array value was found.
4634 *
4635 * @see #putExtra(String, char[])
4636 */
4637 public char[] getCharArrayExtra(String name) {
4638 return mExtras == null ? null : mExtras.getCharArray(name);
4639 }
4640
4641 /**
4642 * Retrieve extended data from the intent.
4643 *
4644 * @param name The name of the desired item.
4645 *
4646 * @return the value of an item that previously added with putExtra()
4647 * or null if no int array value was found.
4648 *
4649 * @see #putExtra(String, int[])
4650 */
4651 public int[] getIntArrayExtra(String name) {
4652 return mExtras == null ? null : mExtras.getIntArray(name);
4653 }
4654
4655 /**
4656 * Retrieve extended data from the intent.
4657 *
4658 * @param name The name of the desired item.
4659 *
4660 * @return the value of an item that previously added with putExtra()
4661 * or null if no long array value was found.
4662 *
4663 * @see #putExtra(String, long[])
4664 */
4665 public long[] getLongArrayExtra(String name) {
4666 return mExtras == null ? null : mExtras.getLongArray(name);
4667 }
4668
4669 /**
4670 * Retrieve extended data from the intent.
4671 *
4672 * @param name The name of the desired item.
4673 *
4674 * @return the value of an item that previously added with putExtra()
4675 * or null if no float array value was found.
4676 *
4677 * @see #putExtra(String, float[])
4678 */
4679 public float[] getFloatArrayExtra(String name) {
4680 return mExtras == null ? null : mExtras.getFloatArray(name);
4681 }
4682
4683 /**
4684 * Retrieve extended data from the intent.
4685 *
4686 * @param name The name of the desired item.
4687 *
4688 * @return the value of an item that previously added with putExtra()
4689 * or null if no double array value was found.
4690 *
4691 * @see #putExtra(String, double[])
4692 */
4693 public double[] getDoubleArrayExtra(String name) {
4694 return mExtras == null ? null : mExtras.getDoubleArray(name);
4695 }
4696
4697 /**
4698 * Retrieve extended data from the intent.
4699 *
4700 * @param name The name of the desired item.
4701 *
4702 * @return the value of an item that previously added with putExtra()
4703 * or null if no String array value was found.
4704 *
4705 * @see #putExtra(String, String[])
4706 */
4707 public String[] getStringArrayExtra(String name) {
4708 return mExtras == null ? null : mExtras.getStringArray(name);
4709 }
4710
4711 /**
4712 * Retrieve extended data from the intent.
4713 *
4714 * @param name The name of the desired item.
4715 *
4716 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004717 * or null if no CharSequence array value was found.
4718 *
4719 * @see #putExtra(String, CharSequence[])
4720 */
4721 public CharSequence[] getCharSequenceArrayExtra(String name) {
4722 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4723 }
4724
4725 /**
4726 * Retrieve extended data from the intent.
4727 *
4728 * @param name The name of the desired item.
4729 *
4730 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004731 * or null if no Bundle value was found.
4732 *
4733 * @see #putExtra(String, Bundle)
4734 */
4735 public Bundle getBundleExtra(String name) {
4736 return mExtras == null ? null : mExtras.getBundle(name);
4737 }
4738
4739 /**
4740 * Retrieve extended data from the intent.
4741 *
4742 * @param name The name of the desired item.
4743 *
4744 * @return the value of an item that previously added with putExtra()
4745 * or null if no IBinder value was found.
4746 *
4747 * @see #putExtra(String, IBinder)
4748 *
4749 * @deprecated
4750 * @hide
4751 */
4752 @Deprecated
4753 public IBinder getIBinderExtra(String name) {
4754 return mExtras == null ? null : mExtras.getIBinder(name);
4755 }
4756
4757 /**
4758 * Retrieve extended data from the intent.
4759 *
4760 * @param name The name of the desired item.
4761 * @param defaultValue The default value to return in case no item is
4762 * associated with the key 'name'
4763 *
4764 * @return the value of an item that previously added with putExtra()
4765 * or defaultValue if none was found.
4766 *
4767 * @see #putExtra
4768 *
4769 * @deprecated
4770 * @hide
4771 */
4772 @Deprecated
4773 public Object getExtra(String name, Object defaultValue) {
4774 Object result = defaultValue;
4775 if (mExtras != null) {
4776 Object result2 = mExtras.get(name);
4777 if (result2 != null) {
4778 result = result2;
4779 }
4780 }
4781
4782 return result;
4783 }
4784
4785 /**
4786 * Retrieves a map of extended data from the intent.
4787 *
4788 * @return the map of all extras previously added with putExtra(),
4789 * or null if none have been added.
4790 */
4791 public Bundle getExtras() {
4792 return (mExtras != null)
4793 ? new Bundle(mExtras)
4794 : null;
4795 }
4796
4797 /**
4798 * Retrieve any special flags associated with this intent. You will
4799 * normally just set them with {@link #setFlags} and let the system
4800 * take the appropriate action with them.
4801 *
4802 * @return int The currently set flags.
4803 *
4804 * @see #setFlags
4805 */
4806 public int getFlags() {
4807 return mFlags;
4808 }
4809
Dianne Hackborne7f97212011-02-24 14:40:20 -08004810 /** @hide */
4811 public boolean isExcludingStopped() {
4812 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4813 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4814 }
4815
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004816 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004817 * Retrieve the application package name this Intent is limited to. When
4818 * resolving an Intent, if non-null this limits the resolution to only
4819 * components in the given application package.
4820 *
4821 * @return The name of the application package for the Intent.
4822 *
4823 * @see #resolveActivity
4824 * @see #setPackage
4825 */
4826 public String getPackage() {
4827 return mPackage;
4828 }
4829
4830 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004831 * Retrieve the concrete component associated with the intent. When receiving
4832 * an intent, this is the component that was found to best handle it (that is,
4833 * yourself) and will always be non-null; in all other cases it will be
4834 * null unless explicitly set.
4835 *
4836 * @return The name of the application component to handle the intent.
4837 *
4838 * @see #resolveActivity
4839 * @see #setComponent
4840 */
4841 public ComponentName getComponent() {
4842 return mComponent;
4843 }
4844
4845 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004846 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4847 * used as a hint to the receiver for animations and the like. Null means that there
4848 * is no source bounds.
4849 */
4850 public Rect getSourceBounds() {
4851 return mSourceBounds;
4852 }
4853
4854 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004855 * Return the Activity component that should be used to handle this intent.
4856 * The appropriate component is determined based on the information in the
4857 * intent, evaluated as follows:
4858 *
4859 * <p>If {@link #getComponent} returns an explicit class, that is returned
4860 * without any further consideration.
4861 *
4862 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4863 * category to be considered.
4864 *
4865 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4866 * action.
4867 *
4868 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4869 * this type.
4870 *
4871 * <p>If {@link #addCategory} has added any categories, the activity must
4872 * handle ALL of the categories specified.
4873 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004874 * <p>If {@link #getPackage} is non-NULL, only activity components in
4875 * that application package will be considered.
4876 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004877 * <p>If there are no activities that satisfy all of these conditions, a
4878 * null string is returned.
4879 *
4880 * <p>If multiple activities are found to satisfy the intent, the one with
4881 * the highest priority will be used. If there are multiple activities
4882 * with the same priority, the system will either pick the best activity
4883 * based on user preference, or resolve to a system class that will allow
4884 * the user to pick an activity and forward from there.
4885 *
4886 * <p>This method is implemented simply by calling
4887 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4888 * true.</p>
4889 * <p> This API is called for you as part of starting an activity from an
4890 * intent. You do not normally need to call it yourself.</p>
4891 *
4892 * @param pm The package manager with which to resolve the Intent.
4893 *
4894 * @return Name of the component implementing an activity that can
4895 * display the intent.
4896 *
4897 * @see #setComponent
4898 * @see #getComponent
4899 * @see #resolveActivityInfo
4900 */
4901 public ComponentName resolveActivity(PackageManager pm) {
4902 if (mComponent != null) {
4903 return mComponent;
4904 }
4905
4906 ResolveInfo info = pm.resolveActivity(
4907 this, PackageManager.MATCH_DEFAULT_ONLY);
4908 if (info != null) {
4909 return new ComponentName(
4910 info.activityInfo.applicationInfo.packageName,
4911 info.activityInfo.name);
4912 }
4913
4914 return null;
4915 }
4916
4917 /**
4918 * Resolve the Intent into an {@link ActivityInfo}
4919 * describing the activity that should execute the intent. Resolution
4920 * follows the same rules as described for {@link #resolveActivity}, but
4921 * you get back the completely information about the resolved activity
4922 * instead of just its class name.
4923 *
4924 * @param pm The package manager with which to resolve the Intent.
4925 * @param flags Addition information to retrieve as per
4926 * {@link PackageManager#getActivityInfo(ComponentName, int)
4927 * PackageManager.getActivityInfo()}.
4928 *
4929 * @return PackageManager.ActivityInfo
4930 *
4931 * @see #resolveActivity
4932 */
4933 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4934 ActivityInfo ai = null;
4935 if (mComponent != null) {
4936 try {
4937 ai = pm.getActivityInfo(mComponent, flags);
4938 } catch (PackageManager.NameNotFoundException e) {
4939 // ignore
4940 }
4941 } else {
4942 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004943 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004944 if (info != null) {
4945 ai = info.activityInfo;
4946 }
4947 }
4948
4949 return ai;
4950 }
4951
4952 /**
4953 * Set the general action to be performed.
4954 *
4955 * @param action An action name, such as ACTION_VIEW. Application-specific
4956 * actions should be prefixed with the vendor's package name.
4957 *
4958 * @return Returns the same Intent object, for chaining multiple calls
4959 * into a single statement.
4960 *
4961 * @see #getAction
4962 */
4963 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004964 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004965 return this;
4966 }
4967
4968 /**
4969 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004970 * clears any type that was previously set by {@link #setType} or
4971 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004972 *
Nick Pellyccae4122012-01-09 14:12:58 -08004973 * <p><em>Note: scheme matching in the Android framework is
4974 * case-sensitive, unlike the formal RFC. As a result,
4975 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004976 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004977 * {@link #setDataAndNormalize}
4978 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004979 *
Nick Pellyccae4122012-01-09 14:12:58 -08004980 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004981 *
4982 * @return Returns the same Intent object, for chaining multiple calls
4983 * into a single statement.
4984 *
4985 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004986 * @see #setDataAndNormalize
4987 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004988 */
4989 public Intent setData(Uri data) {
4990 mData = data;
4991 mType = null;
4992 return this;
4993 }
4994
4995 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004996 * Normalize and set the data this intent is operating on.
4997 *
4998 * <p>This method automatically clears any type that was
4999 * previously set (for example, by {@link #setType}).
5000 *
5001 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005002 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005003 * so really this is just a convenience method for
5004 * <pre>
5005 * setData(data.normalize())
5006 * </pre>
5007 *
5008 * @param data The Uri of the data this intent is now targeting.
5009 *
5010 * @return Returns the same Intent object, for chaining multiple calls
5011 * into a single statement.
5012 *
5013 * @see #getData
5014 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005015 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005016 */
5017 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005018 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005019 }
5020
5021 /**
5022 * Set an explicit MIME data type.
5023 *
5024 * <p>This is used to create intents that only specify a type and not data,
5025 * for example to indicate the type of data to return.
5026 *
5027 * <p>This method automatically clears any data that was
5028 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005029 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005030 * <p><em>Note: MIME type matching in the Android framework is
5031 * case-sensitive, unlike formal RFC MIME types. As a result,
5032 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005033 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5034 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005035 *
5036 * @param type The MIME type of the data being handled by this intent.
5037 *
5038 * @return Returns the same Intent object, for chaining multiple calls
5039 * into a single statement.
5040 *
5041 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005042 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005043 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005044 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005045 */
5046 public Intent setType(String type) {
5047 mData = null;
5048 mType = type;
5049 return this;
5050 }
5051
5052 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005053 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005054 *
Nick Pellyccae4122012-01-09 14:12:58 -08005055 * <p>This is used to create intents that only specify a type and not data,
5056 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005057 *
Nick Pellyccae4122012-01-09 14:12:58 -08005058 * <p>This method automatically clears any data that was
5059 * previously set (for example by {@link #setData}).
5060 *
5061 * <p>The MIME type is normalized using
5062 * {@link #normalizeMimeType} before it is set,
5063 * so really this is just a convenience method for
5064 * <pre>
5065 * setType(Intent.normalizeMimeType(type))
5066 * </pre>
5067 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005068 * @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 *
Nick Pellyccae4122012-01-09 14:12:58 -08005073 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005074 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005075 * @see #normalizeMimeType
5076 */
5077 public Intent setTypeAndNormalize(String type) {
5078 return setType(normalizeMimeType(type));
5079 }
5080
5081 /**
5082 * (Usually optional) Set the data for the intent along with an explicit
5083 * MIME data type. This method should very rarely be used -- it allows you
5084 * to override the MIME type that would ordinarily be inferred from the
5085 * data with your own type given here.
5086 *
5087 * <p><em>Note: MIME type and Uri scheme matching in the
5088 * Android framework is case-sensitive, unlike the formal RFC definitions.
5089 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005090 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005091 * {@link #setDataAndTypeAndNormalize}
5092 * to ensure that they are converted to lower case.</em>
5093 *
5094 * @param data The Uri of the data this intent is now targeting.
5095 * @param type The MIME type of the data being handled by this intent.
5096 *
5097 * @return Returns the same Intent object, for chaining multiple calls
5098 * into a single statement.
5099 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005100 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005101 * @see #setData
5102 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005103 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005104 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005105 */
5106 public Intent setDataAndType(Uri data, String type) {
5107 mData = data;
5108 mType = type;
5109 return this;
5110 }
5111
5112 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005113 * (Usually optional) Normalize and set both the data Uri and an explicit
5114 * MIME data type. This method should very rarely be used -- it allows you
5115 * to override the MIME type that would ordinarily be inferred from the
5116 * data with your own type given here.
5117 *
5118 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005119 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005120 * before they are set, so really this is just a convenience method for
5121 * <pre>
5122 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5123 * </pre>
5124 *
5125 * @param data The Uri of the data this intent is now targeting.
5126 * @param type The MIME type of the data being handled by this intent.
5127 *
5128 * @return Returns the same Intent object, for chaining multiple calls
5129 * into a single statement.
5130 *
5131 * @see #setType
5132 * @see #setData
5133 * @see #setDataAndType
5134 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005135 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005136 */
5137 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005138 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005139 }
5140
5141 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005142 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005143 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005144 * activities that provide <em>all</em> of the requested categories will be
5145 * used.
5146 *
5147 * @param category The desired category. This can be either one of the
5148 * predefined Intent categories, or a custom category in your own
5149 * namespace.
5150 *
5151 * @return Returns the same Intent object, for chaining multiple calls
5152 * into a single statement.
5153 *
5154 * @see #hasCategory
5155 * @see #removeCategory
5156 */
5157 public Intent addCategory(String category) {
5158 if (mCategories == null) {
5159 mCategories = new HashSet<String>();
5160 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005161 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005162 return this;
5163 }
5164
5165 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005166 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005167 *
5168 * @param category The category to remove.
5169 *
5170 * @see #addCategory
5171 */
5172 public void removeCategory(String category) {
5173 if (mCategories != null) {
5174 mCategories.remove(category);
5175 if (mCategories.size() == 0) {
5176 mCategories = null;
5177 }
5178 }
5179 }
5180
5181 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005182 * Set a selector for this Intent. This is a modification to the kinds of
5183 * things the Intent will match. If the selector is set, it will be used
5184 * when trying to find entities that can handle the Intent, instead of the
5185 * main contents of the Intent. This allows you build an Intent containing
5186 * a generic protocol while targeting it more specifically.
5187 *
5188 * <p>An example of where this may be used is with things like
5189 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5190 * Intent that will launch the Browser application. However, the correct
5191 * main entry point of an application is actually {@link #ACTION_MAIN}
5192 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5193 * used to specify the actual Activity to launch. If you launch the browser
5194 * with something different, undesired behavior may happen if the user has
5195 * previously or later launches it the normal way, since they do not match.
5196 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5197 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5198 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5199 *
5200 * <p>Setting a selector does not impact the behavior of
5201 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5202 * desired behavior of a selector -- it does not impact the base meaning
5203 * of the Intent, just what kinds of things will be matched against it
5204 * when determining who can handle it.</p>
5205 *
5206 * <p>You can not use both a selector and {@link #setPackage(String)} on
5207 * the same base Intent.</p>
5208 *
5209 * @param selector The desired selector Intent; set to null to not use
5210 * a special selector.
5211 */
5212 public void setSelector(Intent selector) {
5213 if (selector == this) {
5214 throw new IllegalArgumentException(
5215 "Intent being set as a selector of itself");
5216 }
5217 if (selector != null && mPackage != null) {
5218 throw new IllegalArgumentException(
5219 "Can't set selector when package name is already set");
5220 }
5221 mSelector = selector;
5222 }
5223
5224 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005225 * Set a {@link ClipData} associated with this Intent. This replaces any
5226 * previously set ClipData.
5227 *
5228 * <p>The ClipData in an intent is not used for Intent matching or other
5229 * such operations. Semantically it is like extras, used to transmit
5230 * additional data with the Intent. The main feature of using this over
5231 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5232 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5233 * items included in the clip data. This is useful, in particular, if
5234 * you want to transmit an Intent containing multiple <code>content:</code>
5235 * URIs for which the recipient may not have global permission to access the
5236 * content provider.
5237 *
5238 * <p>If the ClipData contains items that are themselves Intents, any
5239 * grant flags in those Intents will be ignored. Only the top-level flags
5240 * of the main Intent are respected, and will be applied to all Uri or
5241 * Intent items in the clip (or sub-items of the clip).
5242 *
5243 * <p>The MIME type, label, and icon in the ClipData object are not
5244 * directly used by Intent. Applications should generally rely on the
5245 * MIME type of the Intent itself, not what it may find in the ClipData.
5246 * A common practice is to construct a ClipData for use with an Intent
5247 * with a MIME type of "*\/*".
5248 *
5249 * @param clip The new clip to set. May be null to clear the current clip.
5250 */
5251 public void setClipData(ClipData clip) {
5252 mClipData = clip;
5253 }
5254
5255 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005256 * Add extended data to the intent. The name must include a package
5257 * prefix, for example the app com.android.contacts would use names
5258 * like "com.android.contacts.ShowAll".
5259 *
5260 * @param name The name of the extra data, with package prefix.
5261 * @param value The boolean data value.
5262 *
5263 * @return Returns the same Intent object, for chaining multiple calls
5264 * into a single statement.
5265 *
5266 * @see #putExtras
5267 * @see #removeExtra
5268 * @see #getBooleanExtra(String, boolean)
5269 */
5270 public Intent putExtra(String name, boolean value) {
5271 if (mExtras == null) {
5272 mExtras = new Bundle();
5273 }
5274 mExtras.putBoolean(name, value);
5275 return this;
5276 }
5277
5278 /**
5279 * Add extended data to the intent. The name must include a package
5280 * prefix, for example the app com.android.contacts would use names
5281 * like "com.android.contacts.ShowAll".
5282 *
5283 * @param name The name of the extra data, with package prefix.
5284 * @param value The byte data value.
5285 *
5286 * @return Returns the same Intent object, for chaining multiple calls
5287 * into a single statement.
5288 *
5289 * @see #putExtras
5290 * @see #removeExtra
5291 * @see #getByteExtra(String, byte)
5292 */
5293 public Intent putExtra(String name, byte value) {
5294 if (mExtras == null) {
5295 mExtras = new Bundle();
5296 }
5297 mExtras.putByte(name, value);
5298 return this;
5299 }
5300
5301 /**
5302 * Add extended data to the intent. The name must include a package
5303 * prefix, for example the app com.android.contacts would use names
5304 * like "com.android.contacts.ShowAll".
5305 *
5306 * @param name The name of the extra data, with package prefix.
5307 * @param value The char data value.
5308 *
5309 * @return Returns the same Intent object, for chaining multiple calls
5310 * into a single statement.
5311 *
5312 * @see #putExtras
5313 * @see #removeExtra
5314 * @see #getCharExtra(String, char)
5315 */
5316 public Intent putExtra(String name, char value) {
5317 if (mExtras == null) {
5318 mExtras = new Bundle();
5319 }
5320 mExtras.putChar(name, value);
5321 return this;
5322 }
5323
5324 /**
5325 * Add extended data to the intent. The name must include a package
5326 * prefix, for example the app com.android.contacts would use names
5327 * like "com.android.contacts.ShowAll".
5328 *
5329 * @param name The name of the extra data, with package prefix.
5330 * @param value The short data value.
5331 *
5332 * @return Returns the same Intent object, for chaining multiple calls
5333 * into a single statement.
5334 *
5335 * @see #putExtras
5336 * @see #removeExtra
5337 * @see #getShortExtra(String, short)
5338 */
5339 public Intent putExtra(String name, short value) {
5340 if (mExtras == null) {
5341 mExtras = new Bundle();
5342 }
5343 mExtras.putShort(name, value);
5344 return this;
5345 }
5346
5347 /**
5348 * Add extended data to the intent. The name must include a package
5349 * prefix, for example the app com.android.contacts would use names
5350 * like "com.android.contacts.ShowAll".
5351 *
5352 * @param name The name of the extra data, with package prefix.
5353 * @param value The integer data value.
5354 *
5355 * @return Returns the same Intent object, for chaining multiple calls
5356 * into a single statement.
5357 *
5358 * @see #putExtras
5359 * @see #removeExtra
5360 * @see #getIntExtra(String, int)
5361 */
5362 public Intent putExtra(String name, int value) {
5363 if (mExtras == null) {
5364 mExtras = new Bundle();
5365 }
5366 mExtras.putInt(name, value);
5367 return this;
5368 }
5369
5370 /**
5371 * Add extended data to the intent. The name must include a package
5372 * prefix, for example the app com.android.contacts would use names
5373 * like "com.android.contacts.ShowAll".
5374 *
5375 * @param name The name of the extra data, with package prefix.
5376 * @param value The long data value.
5377 *
5378 * @return Returns the same Intent object, for chaining multiple calls
5379 * into a single statement.
5380 *
5381 * @see #putExtras
5382 * @see #removeExtra
5383 * @see #getLongExtra(String, long)
5384 */
5385 public Intent putExtra(String name, long value) {
5386 if (mExtras == null) {
5387 mExtras = new Bundle();
5388 }
5389 mExtras.putLong(name, value);
5390 return this;
5391 }
5392
5393 /**
5394 * Add extended data to the intent. The name must include a package
5395 * prefix, for example the app com.android.contacts would use names
5396 * like "com.android.contacts.ShowAll".
5397 *
5398 * @param name The name of the extra data, with package prefix.
5399 * @param value The float data value.
5400 *
5401 * @return Returns the same Intent object, for chaining multiple calls
5402 * into a single statement.
5403 *
5404 * @see #putExtras
5405 * @see #removeExtra
5406 * @see #getFloatExtra(String, float)
5407 */
5408 public Intent putExtra(String name, float value) {
5409 if (mExtras == null) {
5410 mExtras = new Bundle();
5411 }
5412 mExtras.putFloat(name, value);
5413 return this;
5414 }
5415
5416 /**
5417 * Add extended data to the intent. The name must include a package
5418 * prefix, for example the app com.android.contacts would use names
5419 * like "com.android.contacts.ShowAll".
5420 *
5421 * @param name The name of the extra data, with package prefix.
5422 * @param value The double data value.
5423 *
5424 * @return Returns the same Intent object, for chaining multiple calls
5425 * into a single statement.
5426 *
5427 * @see #putExtras
5428 * @see #removeExtra
5429 * @see #getDoubleExtra(String, double)
5430 */
5431 public Intent putExtra(String name, double value) {
5432 if (mExtras == null) {
5433 mExtras = new Bundle();
5434 }
5435 mExtras.putDouble(name, value);
5436 return this;
5437 }
5438
5439 /**
5440 * Add extended data to the intent. The name must include a package
5441 * prefix, for example the app com.android.contacts would use names
5442 * like "com.android.contacts.ShowAll".
5443 *
5444 * @param name The name of the extra data, with package prefix.
5445 * @param value The String data value.
5446 *
5447 * @return Returns the same Intent object, for chaining multiple calls
5448 * into a single statement.
5449 *
5450 * @see #putExtras
5451 * @see #removeExtra
5452 * @see #getStringExtra(String)
5453 */
5454 public Intent putExtra(String name, String value) {
5455 if (mExtras == null) {
5456 mExtras = new Bundle();
5457 }
5458 mExtras.putString(name, value);
5459 return this;
5460 }
5461
5462 /**
5463 * Add extended data to the intent. The name must include a package
5464 * prefix, for example the app com.android.contacts would use names
5465 * like "com.android.contacts.ShowAll".
5466 *
5467 * @param name The name of the extra data, with package prefix.
5468 * @param value The CharSequence data value.
5469 *
5470 * @return Returns the same Intent object, for chaining multiple calls
5471 * into a single statement.
5472 *
5473 * @see #putExtras
5474 * @see #removeExtra
5475 * @see #getCharSequenceExtra(String)
5476 */
5477 public Intent putExtra(String name, CharSequence value) {
5478 if (mExtras == null) {
5479 mExtras = new Bundle();
5480 }
5481 mExtras.putCharSequence(name, value);
5482 return this;
5483 }
5484
5485 /**
5486 * Add extended data to the intent. The name must include a package
5487 * prefix, for example the app com.android.contacts would use names
5488 * like "com.android.contacts.ShowAll".
5489 *
5490 * @param name The name of the extra data, with package prefix.
5491 * @param value The Parcelable data value.
5492 *
5493 * @return Returns the same Intent object, for chaining multiple calls
5494 * into a single statement.
5495 *
5496 * @see #putExtras
5497 * @see #removeExtra
5498 * @see #getParcelableExtra(String)
5499 */
5500 public Intent putExtra(String name, Parcelable value) {
5501 if (mExtras == null) {
5502 mExtras = new Bundle();
5503 }
5504 mExtras.putParcelable(name, value);
5505 return this;
5506 }
5507
5508 /**
5509 * Add extended data to the intent. The name must include a package
5510 * prefix, for example the app com.android.contacts would use names
5511 * like "com.android.contacts.ShowAll".
5512 *
5513 * @param name The name of the extra data, with package prefix.
5514 * @param value The Parcelable[] data value.
5515 *
5516 * @return Returns the same Intent object, for chaining multiple calls
5517 * into a single statement.
5518 *
5519 * @see #putExtras
5520 * @see #removeExtra
5521 * @see #getParcelableArrayExtra(String)
5522 */
5523 public Intent putExtra(String name, Parcelable[] value) {
5524 if (mExtras == null) {
5525 mExtras = new Bundle();
5526 }
5527 mExtras.putParcelableArray(name, value);
5528 return this;
5529 }
5530
5531 /**
5532 * Add extended data to the intent. The name must include a package
5533 * prefix, for example the app com.android.contacts would use names
5534 * like "com.android.contacts.ShowAll".
5535 *
5536 * @param name The name of the extra data, with package prefix.
5537 * @param value The ArrayList<Parcelable> data value.
5538 *
5539 * @return Returns the same Intent object, for chaining multiple calls
5540 * into a single statement.
5541 *
5542 * @see #putExtras
5543 * @see #removeExtra
5544 * @see #getParcelableArrayListExtra(String)
5545 */
5546 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5547 if (mExtras == null) {
5548 mExtras = new Bundle();
5549 }
5550 mExtras.putParcelableArrayList(name, value);
5551 return this;
5552 }
5553
5554 /**
5555 * Add extended data to the intent. The name must include a package
5556 * prefix, for example the app com.android.contacts would use names
5557 * like "com.android.contacts.ShowAll".
5558 *
5559 * @param name The name of the extra data, with package prefix.
5560 * @param value The ArrayList<Integer> data value.
5561 *
5562 * @return Returns the same Intent object, for chaining multiple calls
5563 * into a single statement.
5564 *
5565 * @see #putExtras
5566 * @see #removeExtra
5567 * @see #getIntegerArrayListExtra(String)
5568 */
5569 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5570 if (mExtras == null) {
5571 mExtras = new Bundle();
5572 }
5573 mExtras.putIntegerArrayList(name, value);
5574 return this;
5575 }
5576
5577 /**
5578 * Add extended data to the intent. The name must include a package
5579 * prefix, for example the app com.android.contacts would use names
5580 * like "com.android.contacts.ShowAll".
5581 *
5582 * @param name The name of the extra data, with package prefix.
5583 * @param value The ArrayList<String> data value.
5584 *
5585 * @return Returns the same Intent object, for chaining multiple calls
5586 * into a single statement.
5587 *
5588 * @see #putExtras
5589 * @see #removeExtra
5590 * @see #getStringArrayListExtra(String)
5591 */
5592 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5593 if (mExtras == null) {
5594 mExtras = new Bundle();
5595 }
5596 mExtras.putStringArrayList(name, value);
5597 return this;
5598 }
5599
5600 /**
5601 * Add extended data to the intent. The name must include a package
5602 * prefix, for example the app com.android.contacts would use names
5603 * like "com.android.contacts.ShowAll".
5604 *
5605 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005606 * @param value The ArrayList<CharSequence> data value.
5607 *
5608 * @return Returns the same Intent object, for chaining multiple calls
5609 * into a single statement.
5610 *
5611 * @see #putExtras
5612 * @see #removeExtra
5613 * @see #getCharSequenceArrayListExtra(String)
5614 */
5615 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5616 if (mExtras == null) {
5617 mExtras = new Bundle();
5618 }
5619 mExtras.putCharSequenceArrayList(name, value);
5620 return this;
5621 }
5622
5623 /**
5624 * Add extended data to the intent. The name must include a package
5625 * prefix, for example the app com.android.contacts would use names
5626 * like "com.android.contacts.ShowAll".
5627 *
5628 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005629 * @param value The Serializable data value.
5630 *
5631 * @return Returns the same Intent object, for chaining multiple calls
5632 * into a single statement.
5633 *
5634 * @see #putExtras
5635 * @see #removeExtra
5636 * @see #getSerializableExtra(String)
5637 */
5638 public Intent putExtra(String name, Serializable value) {
5639 if (mExtras == null) {
5640 mExtras = new Bundle();
5641 }
5642 mExtras.putSerializable(name, value);
5643 return this;
5644 }
5645
5646 /**
5647 * Add extended data to the intent. The name must include a package
5648 * prefix, for example the app com.android.contacts would use names
5649 * like "com.android.contacts.ShowAll".
5650 *
5651 * @param name The name of the extra data, with package prefix.
5652 * @param value The boolean array data value.
5653 *
5654 * @return Returns the same Intent object, for chaining multiple calls
5655 * into a single statement.
5656 *
5657 * @see #putExtras
5658 * @see #removeExtra
5659 * @see #getBooleanArrayExtra(String)
5660 */
5661 public Intent putExtra(String name, boolean[] value) {
5662 if (mExtras == null) {
5663 mExtras = new Bundle();
5664 }
5665 mExtras.putBooleanArray(name, value);
5666 return this;
5667 }
5668
5669 /**
5670 * Add extended data to the intent. The name must include a package
5671 * prefix, for example the app com.android.contacts would use names
5672 * like "com.android.contacts.ShowAll".
5673 *
5674 * @param name The name of the extra data, with package prefix.
5675 * @param value The byte array data value.
5676 *
5677 * @return Returns the same Intent object, for chaining multiple calls
5678 * into a single statement.
5679 *
5680 * @see #putExtras
5681 * @see #removeExtra
5682 * @see #getByteArrayExtra(String)
5683 */
5684 public Intent putExtra(String name, byte[] value) {
5685 if (mExtras == null) {
5686 mExtras = new Bundle();
5687 }
5688 mExtras.putByteArray(name, value);
5689 return this;
5690 }
5691
5692 /**
5693 * Add extended data to the intent. The name must include a package
5694 * prefix, for example the app com.android.contacts would use names
5695 * like "com.android.contacts.ShowAll".
5696 *
5697 * @param name The name of the extra data, with package prefix.
5698 * @param value The short array data value.
5699 *
5700 * @return Returns the same Intent object, for chaining multiple calls
5701 * into a single statement.
5702 *
5703 * @see #putExtras
5704 * @see #removeExtra
5705 * @see #getShortArrayExtra(String)
5706 */
5707 public Intent putExtra(String name, short[] value) {
5708 if (mExtras == null) {
5709 mExtras = new Bundle();
5710 }
5711 mExtras.putShortArray(name, value);
5712 return this;
5713 }
5714
5715 /**
5716 * Add extended data to the intent. The name must include a package
5717 * prefix, for example the app com.android.contacts would use names
5718 * like "com.android.contacts.ShowAll".
5719 *
5720 * @param name The name of the extra data, with package prefix.
5721 * @param value The char array data value.
5722 *
5723 * @return Returns the same Intent object, for chaining multiple calls
5724 * into a single statement.
5725 *
5726 * @see #putExtras
5727 * @see #removeExtra
5728 * @see #getCharArrayExtra(String)
5729 */
5730 public Intent putExtra(String name, char[] value) {
5731 if (mExtras == null) {
5732 mExtras = new Bundle();
5733 }
5734 mExtras.putCharArray(name, value);
5735 return this;
5736 }
5737
5738 /**
5739 * Add extended data to the intent. The name must include a package
5740 * prefix, for example the app com.android.contacts would use names
5741 * like "com.android.contacts.ShowAll".
5742 *
5743 * @param name The name of the extra data, with package prefix.
5744 * @param value The int array data value.
5745 *
5746 * @return Returns the same Intent object, for chaining multiple calls
5747 * into a single statement.
5748 *
5749 * @see #putExtras
5750 * @see #removeExtra
5751 * @see #getIntArrayExtra(String)
5752 */
5753 public Intent putExtra(String name, int[] value) {
5754 if (mExtras == null) {
5755 mExtras = new Bundle();
5756 }
5757 mExtras.putIntArray(name, value);
5758 return this;
5759 }
5760
5761 /**
5762 * Add extended data to the intent. The name must include a package
5763 * prefix, for example the app com.android.contacts would use names
5764 * like "com.android.contacts.ShowAll".
5765 *
5766 * @param name The name of the extra data, with package prefix.
5767 * @param value The byte array data value.
5768 *
5769 * @return Returns the same Intent object, for chaining multiple calls
5770 * into a single statement.
5771 *
5772 * @see #putExtras
5773 * @see #removeExtra
5774 * @see #getLongArrayExtra(String)
5775 */
5776 public Intent putExtra(String name, long[] value) {
5777 if (mExtras == null) {
5778 mExtras = new Bundle();
5779 }
5780 mExtras.putLongArray(name, value);
5781 return this;
5782 }
5783
5784 /**
5785 * Add extended data to the intent. The name must include a package
5786 * prefix, for example the app com.android.contacts would use names
5787 * like "com.android.contacts.ShowAll".
5788 *
5789 * @param name The name of the extra data, with package prefix.
5790 * @param value The float array data value.
5791 *
5792 * @return Returns the same Intent object, for chaining multiple calls
5793 * into a single statement.
5794 *
5795 * @see #putExtras
5796 * @see #removeExtra
5797 * @see #getFloatArrayExtra(String)
5798 */
5799 public Intent putExtra(String name, float[] value) {
5800 if (mExtras == null) {
5801 mExtras = new Bundle();
5802 }
5803 mExtras.putFloatArray(name, value);
5804 return this;
5805 }
5806
5807 /**
5808 * Add extended data to the intent. The name must include a package
5809 * prefix, for example the app com.android.contacts would use names
5810 * like "com.android.contacts.ShowAll".
5811 *
5812 * @param name The name of the extra data, with package prefix.
5813 * @param value The double array data value.
5814 *
5815 * @return Returns the same Intent object, for chaining multiple calls
5816 * into a single statement.
5817 *
5818 * @see #putExtras
5819 * @see #removeExtra
5820 * @see #getDoubleArrayExtra(String)
5821 */
5822 public Intent putExtra(String name, double[] value) {
5823 if (mExtras == null) {
5824 mExtras = new Bundle();
5825 }
5826 mExtras.putDoubleArray(name, value);
5827 return this;
5828 }
5829
5830 /**
5831 * Add extended data to the intent. The name must include a package
5832 * prefix, for example the app com.android.contacts would use names
5833 * like "com.android.contacts.ShowAll".
5834 *
5835 * @param name The name of the extra data, with package prefix.
5836 * @param value The String array data value.
5837 *
5838 * @return Returns the same Intent object, for chaining multiple calls
5839 * into a single statement.
5840 *
5841 * @see #putExtras
5842 * @see #removeExtra
5843 * @see #getStringArrayExtra(String)
5844 */
5845 public Intent putExtra(String name, String[] value) {
5846 if (mExtras == null) {
5847 mExtras = new Bundle();
5848 }
5849 mExtras.putStringArray(name, value);
5850 return this;
5851 }
5852
5853 /**
5854 * Add extended data to the intent. The name must include a package
5855 * prefix, for example the app com.android.contacts would use names
5856 * like "com.android.contacts.ShowAll".
5857 *
5858 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005859 * @param value The CharSequence array data value.
5860 *
5861 * @return Returns the same Intent object, for chaining multiple calls
5862 * into a single statement.
5863 *
5864 * @see #putExtras
5865 * @see #removeExtra
5866 * @see #getCharSequenceArrayExtra(String)
5867 */
5868 public Intent putExtra(String name, CharSequence[] value) {
5869 if (mExtras == null) {
5870 mExtras = new Bundle();
5871 }
5872 mExtras.putCharSequenceArray(name, value);
5873 return this;
5874 }
5875
5876 /**
5877 * Add extended data to the intent. The name must include a package
5878 * prefix, for example the app com.android.contacts would use names
5879 * like "com.android.contacts.ShowAll".
5880 *
5881 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005882 * @param value The Bundle data value.
5883 *
5884 * @return Returns the same Intent object, for chaining multiple calls
5885 * into a single statement.
5886 *
5887 * @see #putExtras
5888 * @see #removeExtra
5889 * @see #getBundleExtra(String)
5890 */
5891 public Intent putExtra(String name, Bundle value) {
5892 if (mExtras == null) {
5893 mExtras = new Bundle();
5894 }
5895 mExtras.putBundle(name, value);
5896 return this;
5897 }
5898
5899 /**
5900 * Add extended data to the intent. The name must include a package
5901 * prefix, for example the app com.android.contacts would use names
5902 * like "com.android.contacts.ShowAll".
5903 *
5904 * @param name The name of the extra data, with package prefix.
5905 * @param value The IBinder data value.
5906 *
5907 * @return Returns the same Intent object, for chaining multiple calls
5908 * into a single statement.
5909 *
5910 * @see #putExtras
5911 * @see #removeExtra
5912 * @see #getIBinderExtra(String)
5913 *
5914 * @deprecated
5915 * @hide
5916 */
5917 @Deprecated
5918 public Intent putExtra(String name, IBinder value) {
5919 if (mExtras == null) {
5920 mExtras = new Bundle();
5921 }
5922 mExtras.putIBinder(name, value);
5923 return this;
5924 }
5925
5926 /**
5927 * Copy all extras in 'src' in to this intent.
5928 *
5929 * @param src Contains the extras to copy.
5930 *
5931 * @see #putExtra
5932 */
5933 public Intent putExtras(Intent src) {
5934 if (src.mExtras != null) {
5935 if (mExtras == null) {
5936 mExtras = new Bundle(src.mExtras);
5937 } else {
5938 mExtras.putAll(src.mExtras);
5939 }
5940 }
5941 return this;
5942 }
5943
5944 /**
5945 * Add a set of extended data to the intent. The keys must include a package
5946 * prefix, for example the app com.android.contacts would use names
5947 * like "com.android.contacts.ShowAll".
5948 *
5949 * @param extras The Bundle of extras to add to this intent.
5950 *
5951 * @see #putExtra
5952 * @see #removeExtra
5953 */
5954 public Intent putExtras(Bundle extras) {
5955 if (mExtras == null) {
5956 mExtras = new Bundle();
5957 }
5958 mExtras.putAll(extras);
5959 return this;
5960 }
5961
5962 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005963 * Completely replace the extras in the Intent with the extras in the
5964 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005965 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005966 * @param src The exact extras contained in this Intent are copied
5967 * into the target intent, replacing any that were previously there.
5968 */
5969 public Intent replaceExtras(Intent src) {
5970 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5971 return this;
5972 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005973
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005974 /**
5975 * Completely replace the extras in the Intent with the given Bundle of
5976 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005977 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005978 * @param extras The new set of extras in the Intent, or null to erase
5979 * all extras.
5980 */
5981 public Intent replaceExtras(Bundle extras) {
5982 mExtras = extras != null ? new Bundle(extras) : null;
5983 return this;
5984 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005985
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005986 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005987 * Remove extended data from the intent.
5988 *
5989 * @see #putExtra
5990 */
5991 public void removeExtra(String name) {
5992 if (mExtras != null) {
5993 mExtras.remove(name);
5994 if (mExtras.size() == 0) {
5995 mExtras = null;
5996 }
5997 }
5998 }
5999
6000 /**
6001 * Set special flags controlling how this intent is handled. Most values
6002 * here depend on the type of component being executed by the Intent,
6003 * specifically the FLAG_ACTIVITY_* flags are all for use with
6004 * {@link Context#startActivity Context.startActivity()} and the
6005 * FLAG_RECEIVER_* flags are all for use with
6006 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6007 *
Scott Main7aee61f2011-02-08 11:25:01 -08006008 * <p>See the
6009 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6010 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006011 * the behavior of your application.
6012 *
6013 * @param flags The desired flags.
6014 *
6015 * @return Returns the same Intent object, for chaining multiple calls
6016 * into a single statement.
6017 *
6018 * @see #getFlags
6019 * @see #addFlags
6020 *
6021 * @see #FLAG_GRANT_READ_URI_PERMISSION
6022 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6023 * @see #FLAG_DEBUG_LOG_RESOLUTION
6024 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006025 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006026 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006027 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006028 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006029 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6030 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006031 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006032 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6033 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006034 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006035 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006036 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006037 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6038 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006039 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006040 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006041 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006042 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6043 */
6044 public Intent setFlags(int flags) {
6045 mFlags = flags;
6046 return this;
6047 }
6048
6049 /**
6050 * Add additional flags to the intent (or with existing flags
6051 * value).
6052 *
6053 * @param flags The new flags to set.
6054 *
6055 * @return Returns the same Intent object, for chaining multiple calls
6056 * into a single statement.
6057 *
6058 * @see #setFlags
6059 */
6060 public Intent addFlags(int flags) {
6061 mFlags |= flags;
6062 return this;
6063 }
6064
6065 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006066 * (Usually optional) Set an explicit application package name that limits
6067 * the components this Intent will resolve to. If left to the default
6068 * value of null, all components in all applications will considered.
6069 * If non-null, the Intent can only match the components in the given
6070 * application package.
6071 *
6072 * @param packageName The name of the application package to handle the
6073 * intent, or null to allow any application package.
6074 *
6075 * @return Returns the same Intent object, for chaining multiple calls
6076 * into a single statement.
6077 *
6078 * @see #getPackage
6079 * @see #resolveActivity
6080 */
6081 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006082 if (packageName != null && mSelector != null) {
6083 throw new IllegalArgumentException(
6084 "Can't set package name when selector is already set");
6085 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006086 mPackage = packageName;
6087 return this;
6088 }
6089
6090 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006091 * (Usually optional) Explicitly set the component to handle the intent.
6092 * If left with the default value of null, the system will determine the
6093 * appropriate class to use based on the other fields (action, data,
6094 * type, categories) in the Intent. If this class is defined, the
6095 * specified class will always be used regardless of the other fields. You
6096 * should only set this value when you know you absolutely want a specific
6097 * class to be used; otherwise it is better to let the system find the
6098 * appropriate class so that you will respect the installed applications
6099 * and user preferences.
6100 *
6101 * @param component The name of the application component to handle the
6102 * intent, or null to let the system find one for you.
6103 *
6104 * @return Returns the same Intent object, for chaining multiple calls
6105 * into a single statement.
6106 *
6107 * @see #setClass
6108 * @see #setClassName(Context, String)
6109 * @see #setClassName(String, String)
6110 * @see #getComponent
6111 * @see #resolveActivity
6112 */
6113 public Intent setComponent(ComponentName component) {
6114 mComponent = component;
6115 return this;
6116 }
6117
6118 /**
6119 * Convenience for calling {@link #setComponent} with an
6120 * explicit class name.
6121 *
6122 * @param packageContext A Context of the application package implementing
6123 * this class.
6124 * @param className The name of a class inside of the application package
6125 * that will be used as the component for this Intent.
6126 *
6127 * @return Returns the same Intent object, for chaining multiple calls
6128 * into a single statement.
6129 *
6130 * @see #setComponent
6131 * @see #setClass
6132 */
6133 public Intent setClassName(Context packageContext, String className) {
6134 mComponent = new ComponentName(packageContext, className);
6135 return this;
6136 }
6137
6138 /**
6139 * Convenience for calling {@link #setComponent} with an
6140 * explicit application package name and class name.
6141 *
6142 * @param packageName The name of the package implementing the desired
6143 * component.
6144 * @param className The name of a class inside of the application package
6145 * that will be used as the component for this Intent.
6146 *
6147 * @return Returns the same Intent object, for chaining multiple calls
6148 * into a single statement.
6149 *
6150 * @see #setComponent
6151 * @see #setClass
6152 */
6153 public Intent setClassName(String packageName, String className) {
6154 mComponent = new ComponentName(packageName, className);
6155 return this;
6156 }
6157
6158 /**
6159 * Convenience for calling {@link #setComponent(ComponentName)} with the
6160 * name returned by a {@link Class} object.
6161 *
6162 * @param packageContext A Context of the application package implementing
6163 * this class.
6164 * @param cls The class name to set, equivalent to
6165 * <code>setClassName(context, cls.getName())</code>.
6166 *
6167 * @return Returns the same Intent object, for chaining multiple calls
6168 * into a single statement.
6169 *
6170 * @see #setComponent
6171 */
6172 public Intent setClass(Context packageContext, Class<?> cls) {
6173 mComponent = new ComponentName(packageContext, cls);
6174 return this;
6175 }
6176
6177 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006178 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6179 * used as a hint to the receiver for animations and the like. Null means that there
6180 * is no source bounds.
6181 */
6182 public void setSourceBounds(Rect r) {
6183 if (r != null) {
6184 mSourceBounds = new Rect(r);
6185 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006186 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006187 }
6188 }
6189
6190 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006191 * Use with {@link #fillIn} to allow the current action value to be
6192 * overwritten, even if it is already set.
6193 */
6194 public static final int FILL_IN_ACTION = 1<<0;
6195
6196 /**
6197 * Use with {@link #fillIn} to allow the current data or type value
6198 * overwritten, even if it is already set.
6199 */
6200 public static final int FILL_IN_DATA = 1<<1;
6201
6202 /**
6203 * Use with {@link #fillIn} to allow the current categories to be
6204 * overwritten, even if they are already set.
6205 */
6206 public static final int FILL_IN_CATEGORIES = 1<<2;
6207
6208 /**
6209 * Use with {@link #fillIn} to allow the current component value to be
6210 * overwritten, even if it is already set.
6211 */
6212 public static final int FILL_IN_COMPONENT = 1<<3;
6213
6214 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006215 * Use with {@link #fillIn} to allow the current package value to be
6216 * overwritten, even if it is already set.
6217 */
6218 public static final int FILL_IN_PACKAGE = 1<<4;
6219
6220 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006221 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006222 * overwritten, even if it is already set.
6223 */
6224 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6225
6226 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006227 * Use with {@link #fillIn} to allow the current selector to be
6228 * overwritten, even if it is already set.
6229 */
6230 public static final int FILL_IN_SELECTOR = 1<<6;
6231
6232 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006233 * Use with {@link #fillIn} to allow the current ClipData to be
6234 * overwritten, even if it is already set.
6235 */
6236 public static final int FILL_IN_CLIP_DATA = 1<<7;
6237
6238 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006239 * Copy the contents of <var>other</var> in to this object, but only
6240 * where fields are not defined by this object. For purposes of a field
6241 * being defined, the following pieces of data in the Intent are
6242 * considered to be separate fields:
6243 *
6244 * <ul>
6245 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006246 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006247 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6248 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006249 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006250 * <li> component, as set by {@link #setComponent(ComponentName)} or
6251 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006252 * <li> source bounds, as set by {@link #setSourceBounds}.
6253 * <li> selector, as set by {@link #setSelector(Intent)}.
6254 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006255 * <li> each top-level name in the associated extras.
6256 * </ul>
6257 *
6258 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006259 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006260 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6261 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6262 * the restriction where the corresponding field will not be replaced if
6263 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006264 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006265 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6266 * is explicitly specified. The selector will only be copied if
6267 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006268 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006269 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6270 * and Intent B with {action="gotit", data-type="some/thing",
6271 * categories="one","two"}.
6272 *
6273 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6274 * containing: {action="gotit", data-type="some/thing",
6275 * categories="bar"}.
6276 *
6277 * @param other Another Intent whose values are to be used to fill in
6278 * the current one.
6279 * @param flags Options to control which fields can be filled in.
6280 *
6281 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006282 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006283 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6284 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006285 */
6286 public int fillIn(Intent other, int flags) {
6287 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006288 if (other.mAction != null
6289 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006290 mAction = other.mAction;
6291 changes |= FILL_IN_ACTION;
6292 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006293 if ((other.mData != null || other.mType != null)
6294 && ((mData == null && mType == null)
6295 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006296 mData = other.mData;
6297 mType = other.mType;
6298 changes |= FILL_IN_DATA;
6299 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006300 if (other.mCategories != null
6301 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006302 if (other.mCategories != null) {
6303 mCategories = new HashSet<String>(other.mCategories);
6304 }
6305 changes |= FILL_IN_CATEGORIES;
6306 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006307 if (other.mPackage != null
6308 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006309 // Only do this if mSelector is not set.
6310 if (mSelector == null) {
6311 mPackage = other.mPackage;
6312 changes |= FILL_IN_PACKAGE;
6313 }
6314 }
6315 // Selector is special: it can only be set if explicitly allowed,
6316 // for the same reason as the component name.
6317 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6318 if (mPackage == null) {
6319 mSelector = new Intent(other.mSelector);
6320 mPackage = null;
6321 changes |= FILL_IN_SELECTOR;
6322 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006323 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006324 if (other.mClipData != null
6325 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6326 mClipData = other.mClipData;
6327 changes |= FILL_IN_CLIP_DATA;
6328 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006329 // Component is special: it can -only- be set if explicitly allowed,
6330 // since otherwise the sender could force the intent somewhere the
6331 // originator didn't intend.
6332 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006333 mComponent = other.mComponent;
6334 changes |= FILL_IN_COMPONENT;
6335 }
6336 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006337 if (other.mSourceBounds != null
6338 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6339 mSourceBounds = new Rect(other.mSourceBounds);
6340 changes |= FILL_IN_SOURCE_BOUNDS;
6341 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006342 if (mExtras == null) {
6343 if (other.mExtras != null) {
6344 mExtras = new Bundle(other.mExtras);
6345 }
6346 } else if (other.mExtras != null) {
6347 try {
6348 Bundle newb = new Bundle(other.mExtras);
6349 newb.putAll(mExtras);
6350 mExtras = newb;
6351 } catch (RuntimeException e) {
6352 // Modifying the extras can cause us to unparcel the contents
6353 // of the bundle, and if we do this in the system process that
6354 // may fail. We really should handle this (i.e., the Bundle
6355 // impl shouldn't be on top of a plain map), but for now just
6356 // ignore it and keep the original contents. :(
6357 Log.w("Intent", "Failure filling in extras", e);
6358 }
6359 }
6360 return changes;
6361 }
6362
6363 /**
6364 * Wrapper class holding an Intent and implementing comparisons on it for
6365 * the purpose of filtering. The class implements its
6366 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6367 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6368 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6369 * on the wrapped Intent.
6370 */
6371 public static final class FilterComparison {
6372 private final Intent mIntent;
6373 private final int mHashCode;
6374
6375 public FilterComparison(Intent intent) {
6376 mIntent = intent;
6377 mHashCode = intent.filterHashCode();
6378 }
6379
6380 /**
6381 * Return the Intent that this FilterComparison represents.
6382 * @return Returns the Intent held by the FilterComparison. Do
6383 * not modify!
6384 */
6385 public Intent getIntent() {
6386 return mIntent;
6387 }
6388
6389 @Override
6390 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006391 if (obj instanceof FilterComparison) {
6392 Intent other = ((FilterComparison)obj).mIntent;
6393 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006394 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006395 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006396 }
6397
6398 @Override
6399 public int hashCode() {
6400 return mHashCode;
6401 }
6402 }
6403
6404 /**
6405 * Determine if two intents are the same for the purposes of intent
6406 * resolution (filtering). That is, if their action, data, type,
6407 * class, and categories are the same. This does <em>not</em> compare
6408 * any extra data included in the intents.
6409 *
6410 * @param other The other Intent to compare against.
6411 *
6412 * @return Returns true if action, data, type, class, and categories
6413 * are the same.
6414 */
6415 public boolean filterEquals(Intent other) {
6416 if (other == null) {
6417 return false;
6418 }
6419 if (mAction != other.mAction) {
6420 if (mAction != null) {
6421 if (!mAction.equals(other.mAction)) {
6422 return false;
6423 }
6424 } else {
6425 if (!other.mAction.equals(mAction)) {
6426 return false;
6427 }
6428 }
6429 }
6430 if (mData != other.mData) {
6431 if (mData != null) {
6432 if (!mData.equals(other.mData)) {
6433 return false;
6434 }
6435 } else {
6436 if (!other.mData.equals(mData)) {
6437 return false;
6438 }
6439 }
6440 }
6441 if (mType != other.mType) {
6442 if (mType != null) {
6443 if (!mType.equals(other.mType)) {
6444 return false;
6445 }
6446 } else {
6447 if (!other.mType.equals(mType)) {
6448 return false;
6449 }
6450 }
6451 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006452 if (mPackage != other.mPackage) {
6453 if (mPackage != null) {
6454 if (!mPackage.equals(other.mPackage)) {
6455 return false;
6456 }
6457 } else {
6458 if (!other.mPackage.equals(mPackage)) {
6459 return false;
6460 }
6461 }
6462 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006463 if (mComponent != other.mComponent) {
6464 if (mComponent != null) {
6465 if (!mComponent.equals(other.mComponent)) {
6466 return false;
6467 }
6468 } else {
6469 if (!other.mComponent.equals(mComponent)) {
6470 return false;
6471 }
6472 }
6473 }
6474 if (mCategories != other.mCategories) {
6475 if (mCategories != null) {
6476 if (!mCategories.equals(other.mCategories)) {
6477 return false;
6478 }
6479 } else {
6480 if (!other.mCategories.equals(mCategories)) {
6481 return false;
6482 }
6483 }
6484 }
6485
6486 return true;
6487 }
6488
6489 /**
6490 * Generate hash code that matches semantics of filterEquals().
6491 *
6492 * @return Returns the hash value of the action, data, type, class, and
6493 * categories.
6494 *
6495 * @see #filterEquals
6496 */
6497 public int filterHashCode() {
6498 int code = 0;
6499 if (mAction != null) {
6500 code += mAction.hashCode();
6501 }
6502 if (mData != null) {
6503 code += mData.hashCode();
6504 }
6505 if (mType != null) {
6506 code += mType.hashCode();
6507 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006508 if (mPackage != null) {
6509 code += mPackage.hashCode();
6510 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006511 if (mComponent != null) {
6512 code += mComponent.hashCode();
6513 }
6514 if (mCategories != null) {
6515 code += mCategories.hashCode();
6516 }
6517 return code;
6518 }
6519
6520 @Override
6521 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006522 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006523
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006524 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006525 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006526 b.append(" }");
6527
6528 return b.toString();
6529 }
6530
6531 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006532 public String toInsecureString() {
6533 StringBuilder b = new StringBuilder(128);
6534
6535 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006536 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006537 b.append(" }");
6538
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006539 return b.toString();
6540 }
Romain Guy4969af72009-06-17 10:53:19 -07006541
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006542 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006543 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006544 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006545
6546 b.append("Intent { ");
6547 toShortString(b, false, true, true, true);
6548 b.append(" }");
6549
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006550 return b.toString();
6551 }
6552
6553 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006554 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6555 StringBuilder b = new StringBuilder(128);
6556 toShortString(b, secure, comp, extras, clip);
6557 return b.toString();
6558 }
6559
6560 /** @hide */
6561 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6562 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006563 boolean first = true;
6564 if (mAction != null) {
6565 b.append("act=").append(mAction);
6566 first = false;
6567 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006568 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006569 if (!first) {
6570 b.append(' ');
6571 }
6572 first = false;
6573 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006574 Iterator<String> i = mCategories.iterator();
6575 boolean didone = false;
6576 while (i.hasNext()) {
6577 if (didone) b.append(",");
6578 didone = true;
6579 b.append(i.next());
6580 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006581 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006582 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006583 if (mData != null) {
6584 if (!first) {
6585 b.append(' ');
6586 }
6587 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006588 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006589 if (secure) {
6590 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006591 } else {
6592 b.append(mData);
6593 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006594 }
6595 if (mType != null) {
6596 if (!first) {
6597 b.append(' ');
6598 }
6599 first = false;
6600 b.append("typ=").append(mType);
6601 }
6602 if (mFlags != 0) {
6603 if (!first) {
6604 b.append(' ');
6605 }
6606 first = false;
6607 b.append("flg=0x").append(Integer.toHexString(mFlags));
6608 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006609 if (mPackage != null) {
6610 if (!first) {
6611 b.append(' ');
6612 }
6613 first = false;
6614 b.append("pkg=").append(mPackage);
6615 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006616 if (comp && mComponent != null) {
6617 if (!first) {
6618 b.append(' ');
6619 }
6620 first = false;
6621 b.append("cmp=").append(mComponent.flattenToShortString());
6622 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006623 if (mSourceBounds != null) {
6624 if (!first) {
6625 b.append(' ');
6626 }
6627 first = false;
6628 b.append("bnds=").append(mSourceBounds.toShortString());
6629 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006630 if (mClipData != null) {
6631 if (!first) {
6632 b.append(' ');
6633 }
6634 first = false;
6635 if (clip) {
6636 b.append("clip={");
6637 mClipData.toShortString(b);
6638 b.append('}');
6639 } else {
6640 b.append("(has clip)");
6641 }
6642 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006643 if (extras && mExtras != null) {
6644 if (!first) {
6645 b.append(' ');
6646 }
6647 first = false;
6648 b.append("(has extras)");
6649 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006650 if (mSelector != null) {
6651 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006652 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006653 b.append("}");
6654 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006655 }
6656
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006657 /**
6658 * Call {@link #toUri} with 0 flags.
6659 * @deprecated Use {@link #toUri} instead.
6660 */
6661 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006662 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006663 return toUri(0);
6664 }
6665
6666 /**
6667 * Convert this Intent into a String holding a URI representation of it.
6668 * The returned URI string has been properly URI encoded, so it can be
6669 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6670 * Intent's data as the base URI, with an additional fragment describing
6671 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006672 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006673 * <p>You can convert the returned string back to an Intent with
6674 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006675 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006676 * @param flags Additional operating flags. Either 0 or
6677 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006678 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006679 * @return Returns a URI encoding URI string describing the entire contents
6680 * of the Intent.
6681 */
6682 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006683 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006684 String scheme = null;
6685 if (mData != null) {
6686 String data = mData.toString();
6687 if ((flags&URI_INTENT_SCHEME) != 0) {
6688 final int N = data.length();
6689 for (int i=0; i<N; i++) {
6690 char c = data.charAt(i);
6691 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6692 || c == '.' || c == '-') {
6693 continue;
6694 }
6695 if (c == ':' && i > 0) {
6696 // Valid scheme.
6697 scheme = data.substring(0, i);
6698 uri.append("intent:");
6699 data = data.substring(i+1);
6700 break;
6701 }
Tom Taylord4a47292009-12-21 13:59:18 -08006702
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006703 // No scheme.
6704 break;
6705 }
6706 }
6707 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006708
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006709 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6710 uri.append("intent:");
6711 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006712
6713 uri.append("#Intent;");
6714
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006715 toUriInner(uri, scheme, flags);
6716 if (mSelector != null) {
6717 uri.append("SEL;");
6718 // Note that for now we are not going to try to handle the
6719 // data part; not clear how to represent this as a URI, and
6720 // not much utility in it.
6721 mSelector.toUriInner(uri, null, flags);
6722 }
6723
6724 uri.append("end");
6725
6726 return uri.toString();
6727 }
6728
6729 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006730 if (scheme != null) {
6731 uri.append("scheme=").append(scheme).append(';');
6732 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006733 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006734 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006735 }
6736 if (mCategories != null) {
6737 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006738 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006739 }
6740 }
6741 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006742 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006743 }
6744 if (mFlags != 0) {
6745 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6746 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006747 if (mPackage != null) {
6748 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6749 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006750 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006751 uri.append("component=").append(Uri.encode(
6752 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006753 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006754 if (mSourceBounds != null) {
6755 uri.append("sourceBounds=")
6756 .append(Uri.encode(mSourceBounds.flattenToString()))
6757 .append(';');
6758 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006759 if (mExtras != null) {
6760 for (String key : mExtras.keySet()) {
6761 final Object value = mExtras.get(key);
6762 char entryType =
6763 value instanceof String ? 'S' :
6764 value instanceof Boolean ? 'B' :
6765 value instanceof Byte ? 'b' :
6766 value instanceof Character ? 'c' :
6767 value instanceof Double ? 'd' :
6768 value instanceof Float ? 'f' :
6769 value instanceof Integer ? 'i' :
6770 value instanceof Long ? 'l' :
6771 value instanceof Short ? 's' :
6772 '\0';
6773
6774 if (entryType != '\0') {
6775 uri.append(entryType);
6776 uri.append('.');
6777 uri.append(Uri.encode(key));
6778 uri.append('=');
6779 uri.append(Uri.encode(value.toString()));
6780 uri.append(';');
6781 }
6782 }
6783 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006784 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006785
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006786 public int describeContents() {
6787 return (mExtras != null) ? mExtras.describeContents() : 0;
6788 }
6789
6790 public void writeToParcel(Parcel out, int flags) {
6791 out.writeString(mAction);
6792 Uri.writeToParcel(out, mData);
6793 out.writeString(mType);
6794 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006795 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006796 ComponentName.writeToParcel(mComponent, out);
6797
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006798 if (mSourceBounds != null) {
6799 out.writeInt(1);
6800 mSourceBounds.writeToParcel(out, flags);
6801 } else {
6802 out.writeInt(0);
6803 }
6804
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006805 if (mCategories != null) {
6806 out.writeInt(mCategories.size());
6807 for (String category : mCategories) {
6808 out.writeString(category);
6809 }
6810 } else {
6811 out.writeInt(0);
6812 }
6813
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006814 if (mSelector != null) {
6815 out.writeInt(1);
6816 mSelector.writeToParcel(out, flags);
6817 } else {
6818 out.writeInt(0);
6819 }
6820
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006821 if (mClipData != null) {
6822 out.writeInt(1);
6823 mClipData.writeToParcel(out, flags);
6824 } else {
6825 out.writeInt(0);
6826 }
6827
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006828 out.writeBundle(mExtras);
6829 }
6830
6831 public static final Parcelable.Creator<Intent> CREATOR
6832 = new Parcelable.Creator<Intent>() {
6833 public Intent createFromParcel(Parcel in) {
6834 return new Intent(in);
6835 }
6836 public Intent[] newArray(int size) {
6837 return new Intent[size];
6838 }
6839 };
6840
Dianne Hackborneb034652009-09-07 00:49:58 -07006841 /** @hide */
6842 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006843 readFromParcel(in);
6844 }
6845
6846 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006847 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006848 mData = Uri.CREATOR.createFromParcel(in);
6849 mType = in.readString();
6850 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006851 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006852 mComponent = ComponentName.readFromParcel(in);
6853
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006854 if (in.readInt() != 0) {
6855 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6856 }
6857
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006858 int N = in.readInt();
6859 if (N > 0) {
6860 mCategories = new HashSet<String>();
6861 int i;
6862 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006863 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006864 }
6865 } else {
6866 mCategories = null;
6867 }
6868
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006869 if (in.readInt() != 0) {
6870 mSelector = new Intent(in);
6871 }
6872
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006873 if (in.readInt() != 0) {
6874 mClipData = new ClipData(in);
6875 }
6876
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006877 mExtras = in.readBundle();
6878 }
6879
6880 /**
6881 * Parses the "intent" element (and its children) from XML and instantiates
6882 * an Intent object. The given XML parser should be located at the tag
6883 * where parsing should start (often named "intent"), from which the
6884 * basic action, data, type, and package and class name will be
6885 * retrieved. The function will then parse in to any child elements,
6886 * looking for <category android:name="xxx"> tags to add categories and
6887 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6888 * to the intent.
6889 *
6890 * @param resources The Resources to use when inflating resources.
6891 * @param parser The XML parser pointing at an "intent" tag.
6892 * @param attrs The AttributeSet interface for retrieving extended
6893 * attribute data at the current <var>parser</var> location.
6894 * @return An Intent object matching the XML data.
6895 * @throws XmlPullParserException If there was an XML parsing error.
6896 * @throws IOException If there was an I/O error.
6897 */
6898 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6899 throws XmlPullParserException, IOException {
6900 Intent intent = new Intent();
6901
6902 TypedArray sa = resources.obtainAttributes(attrs,
6903 com.android.internal.R.styleable.Intent);
6904
6905 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6906
6907 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6908 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6909 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6910
6911 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6912 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6913 if (packageName != null && className != null) {
6914 intent.setComponent(new ComponentName(packageName, className));
6915 }
6916
6917 sa.recycle();
6918
6919 int outerDepth = parser.getDepth();
6920 int type;
6921 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6922 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6923 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6924 continue;
6925 }
6926
6927 String nodeName = parser.getName();
6928 if (nodeName.equals("category")) {
6929 sa = resources.obtainAttributes(attrs,
6930 com.android.internal.R.styleable.IntentCategory);
6931 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6932 sa.recycle();
6933
6934 if (cat != null) {
6935 intent.addCategory(cat);
6936 }
6937 XmlUtils.skipCurrentTag(parser);
6938
6939 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006940 if (intent.mExtras == null) {
6941 intent.mExtras = new Bundle();
6942 }
6943 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6944 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006945
6946 } else {
6947 XmlUtils.skipCurrentTag(parser);
6948 }
6949 }
6950
6951 return intent;
6952 }
Nick Pellyccae4122012-01-09 14:12:58 -08006953
6954 /**
6955 * Normalize a MIME data type.
6956 *
6957 * <p>A normalized MIME type has white-space trimmed,
6958 * content-type parameters removed, and is lower-case.
6959 * This aligns the type with Android best practices for
6960 * intent filtering.
6961 *
6962 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6963 * "text/x-vCard" becomes "text/x-vcard".
6964 *
6965 * <p>All MIME types received from outside Android (such as user input,
6966 * or external sources like Bluetooth, NFC, or the Internet) should
6967 * be normalized before they are used to create an Intent.
6968 *
6969 * @param type MIME data type to normalize
6970 * @return normalized MIME data type, or null if the input was null
6971 * @see {@link #setType}
6972 * @see {@link #setTypeAndNormalize}
6973 */
6974 public static String normalizeMimeType(String type) {
6975 if (type == null) {
6976 return null;
6977 }
6978
6979 type = type.trim().toLowerCase(Locale.US);
6980
6981 final int semicolonIndex = type.indexOf(';');
6982 if (semicolonIndex != -1) {
6983 type = type.substring(0, semicolonIndex);
6984 }
6985 return type;
6986 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006987
6988 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07006989 * Prepare this {@link Intent} to leave an app process.
6990 *
6991 * @hide
6992 */
6993 public void prepareToLeaveProcess() {
6994 setAllowFds(false);
6995
6996 if (mSelector != null) {
6997 mSelector.prepareToLeaveProcess();
6998 }
6999 if (mClipData != null) {
7000 mClipData.prepareToLeaveProcess();
7001 }
7002
7003 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7004 // There are several ACTION_MEDIA_* broadcasts that send file://
7005 // Uris, so only check common actions.
7006 if (ACTION_VIEW.equals(mAction) ||
7007 ACTION_EDIT.equals(mAction) ||
7008 ACTION_ATTACH_DATA.equals(mAction)) {
7009 mData.checkFileUriExposed("Intent.getData()");
7010 }
7011 }
7012 }
7013
7014 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007015 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007016 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7017 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007018 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007019 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007020 * @hide
7021 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007022 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007023 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007024 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007025
7026 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007027 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007028
7029 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007030 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007031 try {
7032 // Inspect target intent to see if we need to migrate
7033 final Intent target = getParcelableExtra(EXTRA_INTENT);
7034 if (target != null && target.migrateExtraStreamToClipData()) {
7035 // Since we migrated in child, we need to promote ClipData
7036 // and flags to ourselves to grant.
7037 setClipData(target.getClipData());
7038 addFlags(target.getFlags()
7039 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
7040 return true;
7041 } else {
7042 return false;
7043 }
7044 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007045 }
7046
7047 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007048 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007049 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7050 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7051 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7052 if (stream != null || text != null || htmlText != null) {
7053 final ClipData clipData = new ClipData(
7054 null, new String[] { getType() },
7055 new ClipData.Item(text, htmlText, null, stream));
7056 setClipData(clipData);
7057 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007058 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007059 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007060 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007061 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007062
7063 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007064 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007065 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7066 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7067 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7068 int num = -1;
7069 if (streams != null) {
7070 num = streams.size();
7071 }
7072 if (texts != null) {
7073 if (num >= 0 && num != texts.size()) {
7074 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007075 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007076 }
7077 num = texts.size();
7078 }
7079 if (htmlTexts != null) {
7080 if (num >= 0 && num != htmlTexts.size()) {
7081 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007082 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007083 }
7084 num = htmlTexts.size();
7085 }
7086 if (num > 0) {
7087 final ClipData clipData = new ClipData(
7088 null, new String[] { getType() },
7089 makeClipItem(streams, texts, htmlTexts, 0));
7090
7091 for (int i = 1; i < num; i++) {
7092 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7093 }
7094
7095 setClipData(clipData);
7096 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007097 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007098 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007099 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007100 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007101 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007102
7103 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007104 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007105
7106 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7107 ArrayList<String> htmlTexts, int which) {
7108 Uri uri = streams != null ? streams.get(which) : null;
7109 CharSequence text = texts != null ? texts.get(which) : null;
7110 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7111 return new ClipData.Item(text, htmlText, null, uri);
7112 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007113}