blob: 621bcee942bf8ffd972e4e503fc9bb71022e7912 [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.
1168 */
1169 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1170 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1171
1172 /**
1173 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1174 * containing the name of the current foreground application package at the time
1175 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001176 */
1177 public static final String EXTRA_ASSIST_PACKAGE
1178 = "android.intent.extra.ASSIST_PACKAGE";
1179
1180 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001181 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1182 * containing additional contextual information supplied by the current
1183 * foreground app at the time of the assist request. This is a {@link Bundle} of
1184 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001185 */
1186 public static final String EXTRA_ASSIST_CONTEXT
1187 = "android.intent.extra.ASSIST_CONTEXT";
1188
Jim Miller07994402012-05-02 14:22:27 -07001189 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001190 * Activity Action: List all available applications
1191 * <p>Input: Nothing.
1192 * <p>Output: nothing.
1193 */
1194 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1195 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1196 /**
1197 * Activity Action: Show settings for choosing wallpaper
1198 * <p>Input: Nothing.
1199 * <p>Output: Nothing.
1200 */
1201 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1202 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1203
1204 /**
1205 * Activity Action: Show activity for reporting a bug.
1206 * <p>Input: Nothing.
1207 * <p>Output: Nothing.
1208 */
1209 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1210 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1211
1212 /**
1213 * Activity Action: Main entry point for factory tests. Only used when
1214 * the device is booting in factory test node. The implementing package
1215 * must be installed in the system image.
1216 * <p>Input: nothing
1217 * <p>Output: nothing
1218 */
1219 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1220
1221 /**
1222 * Activity Action: The user pressed the "call" button to go to the dialer
1223 * or other appropriate UI for placing a call.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1229
1230 /**
1231 * Activity Action: Start Voice Command.
1232 * <p>Input: Nothing.
1233 * <p>Output: Nothing.
1234 */
1235 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1236 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001237
1238 /**
1239 * Activity Action: Start action associated with long pressing on the
1240 * search key.
1241 * <p>Input: Nothing.
1242 * <p>Output: Nothing.
1243 */
1244 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1245 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001246
Jacek Surazski86b6c532009-05-13 14:38:28 +02001247 /**
1248 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1249 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001250 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001251 * <p>Input: No data is specified. The bug report is passed in using
1252 * an {@link #EXTRA_BUG_REPORT} field.
1253 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 *
1255 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001256 */
1257 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1258 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001259
1260 /**
1261 * Activity Action: Show power usage information to the user.
1262 * <p>Input: Nothing.
1263 * <p>Output: Nothing.
1264 */
1265 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1266 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001267
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001268 /**
1269 * Activity Action: Setup wizard to launch after a platform update. This
1270 * activity should have a string meta-data field associated with it,
1271 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1272 * the platform for setup. The activity will be launched only if
1273 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1274 * same value.
1275 * <p>Input: Nothing.
1276 * <p>Output: Nothing.
1277 * @hide
1278 */
1279 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1280 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001281
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001282 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001283 * Activity Action: Show settings for managing network data usage of a
1284 * specific application. Applications should define an activity that offers
1285 * options to control data usage.
1286 */
1287 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1288 public static final String ACTION_MANAGE_NETWORK_USAGE =
1289 "android.intent.action.MANAGE_NETWORK_USAGE";
1290
1291 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001292 * Activity Action: Launch application installer.
1293 * <p>
1294 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001295 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1296 * you can also use "package:<package-name>" to install an application for the
1297 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001298 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1299 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1300 * <p>
1301 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1302 * succeeded.
1303 *
1304 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1305 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1306 * @see #EXTRA_RETURN_RESULT
1307 */
1308 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1309 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1310
1311 /**
1312 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1313 * package. Specifies the installer package name; this package will receive the
1314 * {@link #ACTION_APP_ERROR} intent.
1315 */
1316 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1317 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1318
1319 /**
1320 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1321 * package. Specifies that the application being installed should not be
1322 * treated as coming from an unknown source, but as coming from the app
1323 * invoking the Intent. For this to work you must start the installer with
1324 * startActivityForResult().
1325 */
1326 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1327 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1328
1329 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001330 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1331 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001332 * data field originated from.
1333 */
rich cannings706e8ba2012-08-20 13:20:14 -07001334 public static final String EXTRA_ORIGINATING_URI
1335 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001336
1337 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001338 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1339 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1340 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001341 */
1342 public static final String EXTRA_REFERRER
1343 = "android.intent.extra.REFERRER";
1344
1345 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001346 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1347 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1348 * @hide
1349 */
1350 public static final String EXTRA_ORIGINATING_UID
1351 = "android.intent.extra.ORIGINATING_UID";
1352
1353 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001354 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1355 * package. Tells the installer UI to skip the confirmation with the user
1356 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001357 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1358 * will no longer show an interstitial message about updating existing
1359 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001360 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001361 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001362 public static final String EXTRA_ALLOW_REPLACE
1363 = "android.intent.extra.ALLOW_REPLACE";
1364
1365 /**
1366 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1367 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1368 * return to the application the result code of the install/uninstall. The returned result
1369 * code will be {@link android.app.Activity#RESULT_OK} on success or
1370 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1371 */
1372 public static final String EXTRA_RETURN_RESULT
1373 = "android.intent.extra.RETURN_RESULT";
1374
1375 /**
1376 * Package manager install result code. @hide because result codes are not
1377 * yet ready to be exposed.
1378 */
1379 public static final String EXTRA_INSTALL_RESULT
1380 = "android.intent.extra.INSTALL_RESULT";
1381
1382 /**
1383 * Activity Action: Launch application uninstaller.
1384 * <p>
1385 * Input: The data must be a package: URI whose scheme specific part is
1386 * the package name of the current installed package to be uninstalled.
1387 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1388 * <p>
1389 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1390 * succeeded.
1391 */
1392 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1393 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1394
1395 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001396 * Specify whether the package should be uninstalled for all users.
1397 * @hide because these should not be part of normal application flow.
1398 */
1399 public static final String EXTRA_UNINSTALL_ALL_USERS
1400 = "android.intent.extra.UNINSTALL_ALL_USERS";
1401
1402 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001403 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1404 * describing the last run version of the platform that was setup.
1405 * @hide
1406 */
1407 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1408
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001409 // ---------------------------------------------------------------------
1410 // ---------------------------------------------------------------------
1411 // Standard intent broadcast actions (see action variable).
1412
1413 /**
1414 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001415 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001416 * <p class="note">This is a protected intent that can only be sent
1417 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001418 */
1419 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1420 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1421 /**
1422 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001423 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001424 * <p class="note">This is a protected intent that can only be sent
1425 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001426 */
1427 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1428 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001429
1430 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001431 * Broadcast Action: Sent after the system stops dreaming.
1432 *
1433 * <p class="note">This is a protected intent that can only be sent by the system.
1434 * It is only sent to registered receivers.</p>
1435 */
1436 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1437 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1438
1439 /**
1440 * Broadcast Action: Sent after the system starts dreaming.
1441 *
1442 * <p class="note">This is a protected intent that can only be sent by the system.
1443 * It is only sent to registered receivers.</p>
1444 */
1445 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1446 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1447
1448 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001449 * Broadcast Action: Sent when the user is present after device wakes up (e.g when the
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001450 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001451 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001452 * <p class="note">This is a protected intent that can only be sent
1453 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001454 */
1455 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001456 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001457
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001458 /**
1459 * Broadcast Action: The current time has changed. Sent every
1460 * minute. You can <em>not</em> receive this through components declared
1461 * in manifests, only by exlicitly registering for it with
1462 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1463 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001464 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001465 * <p class="note">This is a protected intent that can only be sent
1466 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001467 */
1468 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1469 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1470 /**
1471 * Broadcast Action: The time was set.
1472 */
1473 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1474 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1475 /**
1476 * Broadcast Action: The date has changed.
1477 */
1478 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1479 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1480 /**
1481 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1482 * <ul>
1483 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1484 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001485 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001486 * <p class="note">This is a protected intent that can only be sent
1487 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001488 */
1489 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1490 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1491 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001492 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1493 * DNS entries should be tossed.
1494 * @hide
1495 */
1496 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1497 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1498 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001499 * Alarm Changed Action: This is broadcast when the AlarmClock
1500 * application's alarm is set or unset. It is used by the
1501 * AlarmClock application and the StatusBar service.
1502 * @hide
1503 */
1504 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1505 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1506 /**
1507 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1508 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1509 * @hide
1510 */
1511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1512 public static final String ACTION_SYNC_STATE_CHANGED
1513 = "android.intent.action.SYNC_STATE_CHANGED";
1514 /**
1515 * Broadcast Action: This is broadcast once, after the system has finished
1516 * booting. It can be used to perform application-specific initialization,
1517 * such as installing alarms. You must hold the
1518 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1519 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001520 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001521 * <p class="note">This is a protected intent that can only be sent
1522 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001523 */
1524 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1525 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1526 /**
1527 * Broadcast Action: This is broadcast when a user action should request a
1528 * temporary system dialog to dismiss. Some examples of temporary system
1529 * dialogs are the notification window-shade and the recent tasks dialog.
1530 */
1531 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1532 /**
1533 * Broadcast Action: Trigger the download and eventual installation
1534 * of a package.
1535 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001536 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001537 * <p class="note">This is a protected intent that can only be sent
1538 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001539 *
1540 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001541 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001542 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001543 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1544 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1545 /**
1546 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001547 * device. The data contains the name of the package. Note that the
1548 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001549 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001550 * <ul>
1551 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1552 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1553 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1554 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001555 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001556 * <p class="note">This is a protected intent that can only be sent
1557 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001558 */
1559 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1560 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1561 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001562 * Broadcast Action: A new version of an application package has been
1563 * installed, replacing an existing version that was previously installed.
1564 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001565 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001566 * <ul>
1567 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1568 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001569 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001570 * <p class="note">This is a protected intent that can only be sent
1571 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001572 */
1573 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1574 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1575 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001576 * Broadcast Action: A new version of your application has been installed
1577 * over an existing one. This is only sent to the application that was
1578 * replaced. It does not contain any additional data; to receive it, just
1579 * use an intent filter for this action.
1580 *
1581 * <p class="note">This is a protected intent that can only be sent
1582 * by the system.
1583 */
1584 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1585 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1586 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001587 * Broadcast Action: An existing application package has been removed from
1588 * the device. The data contains the name of the package. The package
1589 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001590 * <ul>
1591 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1592 * to the package.
1593 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1594 * application -- data and code -- is being removed.
1595 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1596 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1597 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001598 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001599 * <p class="note">This is a protected intent that can only be sent
1600 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001601 */
1602 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1603 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1604 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001605 * Broadcast Action: An existing application package has been completely
1606 * removed from the device. The data contains the name of the package.
1607 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1608 * {@link #EXTRA_DATA_REMOVED} is true and
1609 * {@link #EXTRA_REPLACING} is false of that broadcast.
1610 *
1611 * <ul>
1612 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1613 * to the package.
1614 * </ul>
1615 *
1616 * <p class="note">This is a protected intent that can only be sent
1617 * by the system.
1618 */
1619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1620 public static final String ACTION_PACKAGE_FULLY_REMOVED
1621 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1622 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001623 * Broadcast Action: An existing application package has been changed (e.g.
1624 * a component has been enabled or disabled). The data contains the name of
1625 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001626 * <ul>
1627 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001628 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001629 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001630 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1631 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001632 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001633 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001634 * <p class="note">This is a protected intent that can only be sent
1635 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001636 */
1637 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1638 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1639 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001640 * @hide
1641 * Broadcast Action: Ask system services if there is any reason to
1642 * restart the given package. The data contains the name of the
1643 * package.
1644 * <ul>
1645 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1646 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1647 * </ul>
1648 *
1649 * <p class="note">This is a protected intent that can only be sent
1650 * by the system.
1651 */
1652 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1653 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1654 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001655 * Broadcast Action: The user has restarted a package, and all of its
1656 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001657 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001658 * be removed. Note that the restarted package does <em>not</em>
1659 * receive this broadcast.
1660 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001661 * <ul>
1662 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1663 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001664 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001665 * <p class="note">This is a protected intent that can only be sent
1666 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001667 */
1668 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1669 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1670 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001671 * Broadcast Action: The user has cleared the data of a package. This should
1672 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001673 * its persistent data is erased and this broadcast sent.
1674 * Note that the cleared package does <em>not</em>
1675 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001676 * <ul>
1677 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1678 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001679 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001680 * <p class="note">This is a protected intent that can only be sent
1681 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001682 */
1683 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1684 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1685 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001686 * Broadcast Action: A user ID has been removed from the system. The user
1687 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001688 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001689 * <p class="note">This is a protected intent that can only be sent
1690 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001691 */
1692 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1693 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001694
1695 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001696 * Broadcast Action: Sent to the installer package of an application
1697 * when that application is first launched (that is the first time it
1698 * is moved out of the stopped state). The data contains the name of the package.
1699 *
1700 * <p class="note">This is a protected intent that can only be sent
1701 * by the system.
1702 */
1703 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1704 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1705
1706 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001707 * Broadcast Action: Sent to the system package verifier when a package
1708 * needs to be verified. The data contains the package URI.
1709 * <p class="note">
1710 * This is a protected intent that can only be sent by the system.
1711 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001712 */
1713 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1714 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1715
1716 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001717 * Broadcast Action: Sent to the system package verifier when a package is
1718 * verified. The data contains the package URI.
1719 * <p class="note">
1720 * This is a protected intent that can only be sent by the system.
1721 */
1722 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1723 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1724
1725 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001726 * Broadcast Action: Resources for a set of packages (which were
1727 * previously unavailable) are currently
1728 * available since the media on which they exist is available.
1729 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1730 * list of packages whose availability changed.
1731 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1732 * list of uids of packages whose availability changed.
1733 * Note that the
1734 * packages in this list do <em>not</em> receive this broadcast.
1735 * The specified set of packages are now available on the system.
1736 * <p>Includes the following extras:
1737 * <ul>
1738 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1739 * whose resources(were previously unavailable) are currently available.
1740 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1741 * packages whose resources(were previously unavailable)
1742 * are currently available.
1743 * </ul>
1744 *
1745 * <p class="note">This is a protected intent that can only be sent
1746 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001747 */
1748 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001749 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1750 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001751
1752 /**
1753 * Broadcast Action: Resources for a set of packages are currently
1754 * unavailable since the media on which they exist is unavailable.
1755 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1756 * list of packages whose availability changed.
1757 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1758 * list of uids of packages whose availability changed.
1759 * The specified set of packages can no longer be
1760 * launched and are practically unavailable on the system.
1761 * <p>Inclues the following extras:
1762 * <ul>
1763 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1764 * whose resources are no longer available.
1765 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1766 * whose resources are no longer available.
1767 * </ul>
1768 *
1769 * <p class="note">This is a protected intent that can only be sent
1770 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001771 */
1772 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001773 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001774 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001775
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001776 /**
1777 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001778 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001779 * This should <em>only</em> be used to determine when the wallpaper
1780 * has changed to show the new wallpaper to the user. You should certainly
1781 * never, in response to this, change the wallpaper or other attributes of
1782 * it such as the suggested size. That would be crazy, right? You'd cause
1783 * all kinds of loops, especially if other apps are doing similar things,
1784 * right? Of course. So please don't do this.
1785 *
1786 * @deprecated Modern applications should use
1787 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1788 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1789 * shown behind their UI, rather than watching for this broadcast and
1790 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001791 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001792 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001793 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1794 /**
1795 * Broadcast Action: The current device {@link android.content.res.Configuration}
1796 * (orientation, locale, etc) has changed. When such a change happens, the
1797 * UIs (view hierarchy) will need to be rebuilt based on this new
1798 * information; for the most part, applications don't need to worry about
1799 * this, because the system will take care of stopping and restarting the
1800 * application to make sure it sees the new changes. Some system code that
1801 * can not be restarted will need to watch for this action and handle it
1802 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001803 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001804 * <p class="note">
1805 * You can <em>not</em> receive this through components declared
1806 * in manifests, only by explicitly registering for it with
1807 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1808 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001809 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001810 * <p class="note">This is a protected intent that can only be sent
1811 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001812 *
1813 * @see android.content.res.Configuration
1814 */
1815 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1816 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1817 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001818 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001819 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001820 * <p class="note">This is a protected intent that can only be sent
1821 * by the system.
1822 */
1823 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1824 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1825 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001826 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1827 * charging state, level, and other information about the battery.
1828 * See {@link android.os.BatteryManager} for documentation on the
1829 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001830 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001831 * <p class="note">
1832 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001833 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001834 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001835 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1836 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1837 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1838 * broadcasts that are sent and can be received through manifest
1839 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001840 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001841 * <p class="note">This is a protected intent that can only be sent
1842 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001843 */
1844 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1845 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1846 /**
1847 * Broadcast Action: Indicates low battery condition on the device.
1848 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001849 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001850 * <p class="note">This is a protected intent that can only be sent
1851 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001852 */
1853 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1854 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1855 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001856 * Broadcast Action: Indicates the battery is now okay after being low.
1857 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1858 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001859 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001860 * <p class="note">This is a protected intent that can only be sent
1861 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001862 */
1863 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1864 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1865 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001866 * Broadcast Action: External power has been connected to the device.
1867 * This is intended for applications that wish to register specifically to this notification.
1868 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1869 * stay active to receive this notification. This action can be used to implement actions
1870 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001871 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001872 * <p class="note">This is a protected intent that can only be sent
1873 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001874 */
1875 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001876 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001877 /**
1878 * Broadcast Action: External power has been removed from the device.
1879 * This is intended for applications that wish to register specifically to this notification.
1880 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1881 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001882 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001883 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001884 * <p class="note">This is a protected intent that can only be sent
1885 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001886 */
1887 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001888 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001889 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001890 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001891 * Broadcast Action: Device is shutting down.
1892 * This is broadcast when the device is being shut down (completely turned
1893 * off, not sleeping). Once the broadcast is complete, the final shutdown
1894 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001895 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001896 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001897 * <p class="note">This is a protected intent that can only be sent
1898 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001899 */
1900 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001901 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001902 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001903 * Activity Action: Start this activity to request system shutdown.
1904 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1905 * to request confirmation from the user before shutting down.
1906 *
1907 * <p class="note">This is a protected intent that can only be sent
1908 * by the system.
1909 *
1910 * {@hide}
1911 */
1912 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1913 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001914 * Broadcast Action: A sticky broadcast that indicates low memory
1915 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001916 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001917 * <p class="note">This is a protected intent that can only be sent
1918 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001919 */
1920 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1921 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1922 /**
1923 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001924 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001925 * <p class="note">This is a protected intent that can only be sent
1926 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001927 */
1928 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1929 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1930 /**
Jake Hambybb371632010-08-23 18:16:48 -07001931 * Broadcast Action: A sticky broadcast that indicates a memory full
1932 * condition on the device. This is intended for activities that want
1933 * to be able to fill the data partition completely, leaving only
1934 * enough free space to prevent system-wide SQLite failures.
1935 *
1936 * <p class="note">This is a protected intent that can only be sent
1937 * by the system.
1938 *
1939 * {@hide}
1940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1943 /**
1944 * Broadcast Action: Indicates memory full condition on the device
1945 * no longer exists.
1946 *
1947 * <p class="note">This is a protected intent that can only be sent
1948 * by the system.
1949 *
1950 * {@hide}
1951 */
1952 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1953 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1954 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001955 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1956 * and package management should be started.
1957 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1958 * notification.
1959 */
1960 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1961 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1962 /**
1963 * Broadcast Action: The device has entered USB Mass Storage mode.
1964 * This is used mainly for the USB Settings panel.
1965 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1966 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001967 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001968 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001969 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001970 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1971
1972 /**
1973 * Broadcast Action: The device has exited USB Mass Storage mode.
1974 * This is used mainly for the USB Settings panel.
1975 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1976 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001977 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001978 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001979 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001980 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1981
1982 /**
1983 * Broadcast Action: External media has been removed.
1984 * The path to the mount point for the removed media is contained in the Intent.mData field.
1985 */
1986 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1987 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1988
1989 /**
1990 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001991 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001992 */
1993 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1994 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1995
1996 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001997 * Broadcast Action: External media is present, and being disk-checked
1998 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2002
2003 /**
2004 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2005 * The path to the mount point for the checking media is contained in the Intent.mData field.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08002006 */
2007 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2008 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2009
2010 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002011 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002012 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002013 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2014 * media was mounted read only.
2015 */
2016 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2017 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2018
2019 /**
2020 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002021 * The path to the mount point for the shared media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002022 */
2023 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2024 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2025
2026 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002027 * Broadcast Action: External media is no longer being shared via USB mass storage.
2028 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2029 *
2030 * @hide
2031 */
2032 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2033
2034 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002035 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2036 * The path to the mount point for the removed media is contained in the Intent.mData field.
2037 */
2038 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2039 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2040
2041 /**
2042 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002043 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002044 */
2045 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2046 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2047
2048 /**
2049 * Broadcast Action: User has expressed the desire to remove the external storage media.
2050 * Applications should close all files they have open within the mount point when they receive this intent.
2051 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2052 */
2053 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2054 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2055
2056 /**
2057 * Broadcast Action: The media scanner has started scanning a directory.
2058 * The path to the directory being scanned is contained in the Intent.mData field.
2059 */
2060 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2061 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2062
2063 /**
2064 * Broadcast Action: The media scanner has finished scanning a directory.
2065 * The path to the scanned directory is contained in the Intent.mData field.
2066 */
2067 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2068 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2069
2070 /**
2071 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2072 * The path to the file is contained in the Intent.mData field.
2073 */
2074 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2075 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2076
2077 /**
2078 * Broadcast Action: The "Media Button" was pressed. Includes a single
2079 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2080 * caused the broadcast.
2081 */
2082 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2083 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2084
2085 /**
2086 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2087 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2088 * caused the broadcast.
2089 */
2090 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2091 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2092
2093 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2094 // location; they are not general-purpose actions.
2095
2096 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002097 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002098 */
2099 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2100 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2101 "android.intent.action.GTALK_CONNECTED";
2102
2103 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002104 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2107 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2108 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002109
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002110 /**
2111 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002112 */
2113 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2114 public static final String ACTION_INPUT_METHOD_CHANGED =
2115 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002116
2117 /**
2118 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2119 * more radios have been turned off or on. The intent will have the following extra value:</p>
2120 * <ul>
2121 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2122 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2123 * turned off</li>
2124 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002125 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002126 * <p class="note">This is a protected intent that can only be sent
2127 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002128 */
2129 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2130 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2131
2132 /**
2133 * Broadcast Action: Some content providers have parts of their namespace
2134 * where they publish new events or items that the user may be especially
2135 * interested in. For these things, they may broadcast this action when the
2136 * set of interesting items change.
2137 *
2138 * For example, GmailProvider sends this notification when the set of unread
2139 * mail in the inbox changes.
2140 *
2141 * <p>The data of the intent identifies which part of which provider
2142 * changed. When queried through the content resolver, the data URI will
2143 * return the data set in question.
2144 *
2145 * <p>The intent will have the following extra values:
2146 * <ul>
2147 * <li><em>count</em> - The number of items in the data set. This is the
2148 * same as the number of items in the cursor returned by querying the
2149 * data URI. </li>
2150 * </ul>
2151 *
2152 * This intent will be sent at boot (if the count is non-zero) and when the
2153 * data set changes. It is possible for the data set to change without the
2154 * count changing (for example, if a new unread message arrives in the same
2155 * sync operation in which a message is archived). The phone should still
2156 * ring/vibrate/etc as normal in this case.
2157 */
2158 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2159 public static final String ACTION_PROVIDER_CHANGED =
2160 "android.intent.action.PROVIDER_CHANGED";
2161
2162 /**
2163 * Broadcast Action: Wired Headset plugged in or unplugged.
2164 *
2165 * <p>The intent will have the following extra values:
2166 * <ul>
2167 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2168 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002169 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002170 * </ul>
2171 * </ul>
2172 */
2173 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2174 public static final String ACTION_HEADSET_PLUG =
2175 "android.intent.action.HEADSET_PLUG";
2176
2177 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002178 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2179 *
2180 * <p>The intent will have the following extra values:
2181 * <ul>
2182 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2183 * <li><em>name</em> - Headset type, human readable string </li>
2184 * </ul>
2185 * </ul>
2186 * @hide
2187 */
2188 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002189 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2190 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002191
2192 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002193 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002194 *
2195 * <p>The intent will have the following extra values:
2196 * <ul>
2197 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2198 * <li><em>name</em> - Headset type, human readable string </li>
2199 * </ul>
2200 * </ul>
2201 * @hide
2202 */
2203 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002204 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2205 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002206
2207 /**
2208 * Broadcast Action: A HMDI cable was plugged or unplugged
2209 *
2210 * <p>The intent will have the following extra values:
2211 * <ul>
2212 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2213 * <li><em>name</em> - HDMI cable, human readable string </li>
2214 * </ul>
2215 * </ul>
2216 * @hide
2217 */
2218 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2219 public static final String ACTION_HDMI_AUDIO_PLUG =
2220 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002221
2222 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002223 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2224 *
2225 * <p>The intent will have the following extra values:
2226 * <ul>
2227 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2228 * <li><em>card</em> - ALSA card number (integer) </li>
2229 * <li><em>device</em> - ALSA device number (integer) </li>
2230 * </ul>
2231 * </ul>
2232 * @hide
2233 */
2234 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2235 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2236 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2237
2238 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002239 * Broadcast Action: A USB audio device was plugged in or unplugged.
2240 *
2241 * <p>The intent will have the following extra values:
2242 * <ul>
2243 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2244 * <li><em>card</em> - ALSA card number (integer) </li>
2245 * <li><em>device</em> - ALSA device number (integer) </li>
2246 * </ul>
2247 * </ul>
2248 * @hide
2249 */
2250 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2251 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2252 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2253
2254 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002255 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2256 * <ul>
2257 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2258 * </ul>
2259 *
2260 * <p class="note">This is a protected intent that can only be sent
2261 * by the system.
2262 *
2263 * @hide
2264 */
2265 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2266 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2267 = "android.intent.action.ADVANCED_SETTINGS";
2268
2269 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002270 * Broadcast Action: An outgoing call is about to be placed.
2271 *
2272 * <p>The Intent will have the following extra value:
2273 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002274 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002275 * the phone number originally intended to be dialed.</li>
2276 * </ul>
2277 * <p>Once the broadcast is finished, the resultData is used as the actual
2278 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002279 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002280 * outgoing call in turn: for example, a parental control application
2281 * might verify that the user is authorized to place the call at that
2282 * time, then a number-rewriting application might add an area code if
2283 * one was not specified.</p>
2284 * <p>For consistency, any receiver whose purpose is to prohibit phone
2285 * calls should have a priority of 0, to ensure it will see the final
2286 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002287 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002288 * should have a positive priority.
2289 * Negative priorities are reserved for the system for this broadcast;
2290 * using them may cause problems.</p>
2291 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2292 * abort the broadcast.</p>
2293 * <p>Emergency calls cannot be intercepted using this mechanism, and
2294 * other calls cannot be modified to call emergency numbers using this
2295 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002296 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002297 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2298 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002299 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002300 * <p class="note">This is a protected intent that can only be sent
2301 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002302 */
2303 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2304 public static final String ACTION_NEW_OUTGOING_CALL =
2305 "android.intent.action.NEW_OUTGOING_CALL";
2306
2307 /**
2308 * Broadcast Action: Have the device reboot. This is only for use by
2309 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002310 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002311 * <p class="note">This is a protected intent that can only be sent
2312 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002313 */
2314 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2315 public static final String ACTION_REBOOT =
2316 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002317
Wei Huang97ecc9c2009-05-11 17:44:20 -07002318 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002319 * Broadcast Action: A sticky broadcast for changes in the physical
2320 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002321 *
2322 * <p>The intent will have the following extra values:
2323 * <ul>
2324 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002325 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002326 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002327 * <p>This is intended for monitoring the current physical dock state.
2328 * See {@link android.app.UiModeManager} for the normal API dealing with
2329 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002330 */
2331 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2332 public static final String ACTION_DOCK_EVENT =
2333 "android.intent.action.DOCK_EVENT";
2334
2335 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002336 * Broadcast Action: A broadcast when idle maintenance can be started.
2337 * This means that the user is not interacting with the device and is
2338 * not expected to do so soon. Typical use of the idle maintenance is
2339 * to perform somehow expensive tasks that can be postponed at a moment
2340 * when they will not degrade user experience.
2341 * <p>
2342 * <p class="note">In order to keep the device responsive in case of an
2343 * unexpected user interaction, implementations of a maintenance task
2344 * should be interruptible. In such a scenario a broadcast with action
2345 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2346 * should not do the maintenance work in
2347 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2348 * maintenance service by {@link Context#startService(Intent)}. Also
2349 * you should hold a wake lock while your maintenance service is running
2350 * to prevent the device going to sleep.
2351 * </p>
2352 * <p>
2353 * <p class="note">This is a protected intent that can only be sent by
2354 * the system.
2355 * </p>
2356 *
2357 * @see #ACTION_IDLE_MAINTENANCE_END
2358 */
2359 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2360 public static final String ACTION_IDLE_MAINTENANCE_START =
2361 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2362
2363 /**
2364 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2365 * This means that the user was not interacting with the device as a result
2366 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2367 * was sent and now the user started interacting with the device. Typical
2368 * use of the idle maintenance is to perform somehow expensive tasks that
2369 * can be postponed at a moment when they will not degrade user experience.
2370 * <p>
2371 * <p class="note">In order to keep the device responsive in case of an
2372 * unexpected user interaction, implementations of a maintenance task
2373 * should be interruptible. Hence, on receiving a broadcast with this
2374 * action, the maintenance task should be interrupted as soon as possible.
2375 * In other words, you should not do the maintenance work in
2376 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2377 * maintenance service that was started on receiving of
2378 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2379 * lock you acquired when your maintenance service started.
2380 * </p>
2381 * <p class="note">This is a protected intent that can only be sent
2382 * by the system.
2383 *
2384 * @see #ACTION_IDLE_MAINTENANCE_START
2385 */
2386 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2387 public static final String ACTION_IDLE_MAINTENANCE_END =
2388 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2389
2390 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002391 * Broadcast Action: a remote intent is to be broadcasted.
2392 *
2393 * A remote intent is used for remote RPC between devices. The remote intent
2394 * is serialized and sent from one device to another device. The receiving
2395 * device parses the remote intent and broadcasts it. Note that anyone can
2396 * broadcast a remote intent. However, if the intent receiver of the remote intent
2397 * does not trust intent broadcasts from arbitrary intent senders, it should require
2398 * the sender to hold certain permissions so only trusted sender's broadcast will be
2399 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002400 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002401 */
2402 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002403 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002404
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002405 /**
2406 * Broadcast Action: hook for permforming cleanup after a system update.
2407 *
2408 * The broadcast is sent when the system is booting, before the
2409 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2410 * image. A receiver for this should do its work and then disable itself
2411 * so that it does not get run again at the next boot.
2412 * @hide
2413 */
2414 public static final String ACTION_PRE_BOOT_COMPLETED =
2415 "android.intent.action.PRE_BOOT_COMPLETED";
2416
Amith Yamasani13593602012-03-22 16:16:17 -07002417 /**
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002418 * Broadcast to a specific application to query any supported restrictions to impose
Amith Yamasani7e99bc02013-04-16 18:24:51 -07002419 * on restricted users. The broadcast intent contains an extra
2420 * {@link #EXTRA_RESTRICTIONS_BUNDLE} with the currently persisted
2421 * restrictions as a Bundle of key/value pairs. The value types can be Boolean, String or
2422 * String[] depending on the restriction type.<p/>
2423 * The response should contain an extra {@link #EXTRA_RESTRICTIONS_LIST},
Amith Yamasani86118ba2013-03-28 14:33:16 -07002424 * which is of type <code>ArrayList&lt;RestrictionEntry&gt;</code>. It can also
2425 * contain an extra {@link #EXTRA_RESTRICTIONS_INTENT}, which is of type <code>Intent</code>.
2426 * The activity specified by that intent will be launched for a result which must contain
Amith Yamasani3b458ad2013-04-18 18:40:07 -07002427 * one of the extras {@link #EXTRA_RESTRICTIONS_LIST} or {@link #EXTRA_RESTRICTIONS_BUNDLE}.
2428 * The keys and values of the returned restrictions will be persisted.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08002429 * @see RestrictionEntry
2430 */
2431 public static final String ACTION_GET_RESTRICTION_ENTRIES =
2432 "android.intent.action.GET_RESTRICTION_ENTRIES";
2433
2434 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002435 * Sent the first time a user is starting, to allow system apps to
2436 * perform one time initialization. (This will not be seen by third
2437 * party applications because a newly initialized user does not have any
2438 * third party applications installed for it.) This is sent early in
2439 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002440 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2441 * broadcast, since it is part of a visible user interaction; be as quick
2442 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002443 */
2444 public static final String ACTION_USER_INITIALIZE =
2445 "android.intent.action.USER_INITIALIZE";
2446
2447 /**
2448 * Sent when a user switch is happening, causing the process's user to be
2449 * brought to the foreground. This is only sent to receivers registered
2450 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2451 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002452 * foreground. This is sent as a foreground
2453 * broadcast, since it is part of a visible user interaction; be as quick
2454 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002455 */
2456 public static final String ACTION_USER_FOREGROUND =
2457 "android.intent.action.USER_FOREGROUND";
2458
2459 /**
2460 * Sent when a user switch is happening, causing the process's user to be
2461 * sent to the background. This is only sent to receivers registered
2462 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2463 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002464 * background. This is sent as a foreground
2465 * broadcast, since it is part of a visible user interaction; be as quick
2466 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002467 */
2468 public static final String ACTION_USER_BACKGROUND =
2469 "android.intent.action.USER_BACKGROUND";
2470
2471 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002472 * Broadcast sent to the system when a user is added. Carries an extra
2473 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2474 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002475 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002476 * @hide
2477 */
2478 public static final String ACTION_USER_ADDED =
2479 "android.intent.action.USER_ADDED";
2480
2481 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002482 * Broadcast sent by the system when a user is started. Carries an extra
2483 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002484 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002485 * that has been started. This is sent as a foreground
2486 * broadcast, since it is part of a visible user interaction; be as quick
2487 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002488 * @hide
2489 */
2490 public static final String ACTION_USER_STARTED =
2491 "android.intent.action.USER_STARTED";
2492
2493 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002494 * Broadcast sent when a user is in the process of starting. Carries an extra
2495 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2496 * sent to registered receivers, not manifest receivers. It is sent to all
2497 * users (including the one that is being started). You must hold
2498 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2499 * this broadcast. This is sent as a background broadcast, since
2500 * its result is not part of the primary UX flow; to safely keep track of
2501 * started/stopped state of a user you can use this in conjunction with
2502 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2503 * other user state broadcasts since those are foreground broadcasts so can
2504 * execute in a different order.
2505 * @hide
2506 */
2507 public static final String ACTION_USER_STARTING =
2508 "android.intent.action.USER_STARTING";
2509
2510 /**
2511 * Broadcast sent when a user is going to be stopped. Carries an extra
2512 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2513 * sent to registered receivers, not manifest receivers. It is sent to all
2514 * users (including the one that is being stopped). You must hold
2515 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2516 * this broadcast. The user will not stop until all receivers have
2517 * handled the broadcast. This is sent as a background broadcast, since
2518 * its result is not part of the primary UX flow; to safely keep track of
2519 * started/stopped state of a user you can use this in conjunction with
2520 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2521 * other user state broadcasts since those are foreground broadcasts so can
2522 * execute in a different order.
2523 * @hide
2524 */
2525 public static final String ACTION_USER_STOPPING =
2526 "android.intent.action.USER_STOPPING";
2527
2528 /**
2529 * Broadcast sent to the system when a user is stopped. Carries an extra
2530 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2531 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2532 * specific package. This is only sent to registered receivers, not manifest
2533 * receivers. It is sent to all running users <em>except</em> the one that
2534 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002535 * @hide
2536 */
2537 public static final String ACTION_USER_STOPPED =
2538 "android.intent.action.USER_STOPPED";
2539
2540 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002541 * 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 -07002542 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002543 * one that has been removed. The user will not be completely removed until all receivers have
2544 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002545 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002546 * @hide
2547 */
2548 public static final String ACTION_USER_REMOVED =
2549 "android.intent.action.USER_REMOVED";
2550
2551 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002552 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002553 * the userHandle of the user to become the current one. This is only sent to
2554 * registered receivers, not manifest receivers. It is sent to all running users.
2555 * You must hold
2556 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002557 * @hide
2558 */
2559 public static final String ACTION_USER_SWITCHED =
2560 "android.intent.action.USER_SWITCHED";
2561
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002562 /**
2563 * Broadcast sent to the system when a user's information changes. Carries an extra
2564 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2565 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2566 * whose information has changed.
2567 * @hide
2568 */
2569 public static final String ACTION_USER_INFO_CHANGED =
2570 "android.intent.action.USER_INFO_CHANGED";
2571
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002572 /**
2573 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2574 */
2575 public static final String ACTION_QUICK_CLOCK =
2576 "android.intent.action.QUICK_CLOCK";
2577
Michael Wright0087a142013-02-05 16:29:39 -08002578 /**
2579 * Broadcast Action: This is broadcast when a user action should request the
2580 * brightness setting dialog.
2581 * @hide
2582 */
2583 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2584 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2585
Justin Kohd378ad72013-04-01 12:18:26 -07002586 /**
2587 * Broadcast Action: A global button was pressed. Includes a single
2588 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2589 * caused the broadcast.
2590 * @hide
2591 */
2592 public static final String ACTION_GLOBAL_BUTTON = "android.intent.action.GLOBAL_BUTTON";
2593
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07002594 /**
2595 * Activity Action: Allow the user to select and open one or more existing
2596 * documents. Both read and write access to the documents will be granted
2597 * until explicitly revoked by the user.
2598 * <p>
2599 * Callers can restrict selection to a specific kind of data, such as
2600 * photos, by setting one or more MIME types in {@link #EXTRA_MIME_TYPES}.
2601 * <p>
2602 * If the caller can handle multiple returned items (the user performing
2603 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE} to
2604 * indicate this.
2605 * <p>
2606 * All returned URIs can be opened as a stream with
2607 * {@link ContentResolver#openInputStream(Uri)}.
2608 * <p>
2609 * Output: The URI of the item that was picked. This must be a content: URI
2610 * so that any receiver can access it.
2611 */
2612 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2613 public static final String ACTION_OPEN_DOCUMENT = "android.intent.action.OPEN_DOCUMENT";
2614
2615 /**
2616 * Activity Action: Allow the user to create a new document. Both read and
2617 * write access to the document will be granted until explicitly revoked by
2618 * the user.
2619 * <p>
2620 * Callers can provide a hint document name by setting {@link #EXTRA_TITLE},
2621 * but the user may change this value before creating the file. Callers can
2622 * optionally hint at the MIME type being created by setting
2623 * {@link #setType(String)}.
2624 * <p>
2625 * All returned URIs can be opened as a stream with
2626 * {@link ContentResolver#openOutputStream(Uri)}.
2627 * <p>
2628 * Output: The URI of the item that was created. This must be a content: URI
2629 * so that any receiver can access it.
2630 */
2631 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
2632 public static final String ACTION_CREATE_DOCUMENT = "android.intent.action.CREATE_DOCUMENT";
2633
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002634 // ---------------------------------------------------------------------
2635 // ---------------------------------------------------------------------
2636 // Standard intent categories (see addCategory()).
2637
2638 /**
2639 * Set if the activity should be an option for the default action
2640 * (center press) to perform on a piece of data. Setting this will
2641 * hide from the user any activities without it set when performing an
2642 * action on some data. Note that this is normal -not- set in the
2643 * Intent when initiating an action -- it is for use in intent filters
2644 * specified in packages.
2645 */
2646 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2647 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2648 /**
2649 * Activities that can be safely invoked from a browser must support this
2650 * category. For example, if the user is viewing a web page or an e-mail
2651 * and clicks on a link in the text, the Intent generated execute that
2652 * link will require the BROWSABLE category, so that only activities
2653 * supporting this category will be considered as possible actions. By
2654 * supporting this category, you are promising that there is nothing
2655 * damaging (without user intervention) that can happen by invoking any
2656 * matching Intent.
2657 */
2658 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2659 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2660 /**
2661 * Set if the activity should be considered as an alternative action to
2662 * the data the user is currently viewing. See also
2663 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2664 * applies to the selection in a list of items.
2665 *
2666 * <p>Supporting this category means that you would like your activity to be
2667 * displayed in the set of alternative things the user can do, usually as
2668 * part of the current activity's options menu. You will usually want to
2669 * include a specific label in the &lt;intent-filter&gt; of this action
2670 * describing to the user what it does.
2671 *
2672 * <p>The action of IntentFilter with this category is important in that it
2673 * describes the specific action the target will perform. This generally
2674 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2675 * a specific name such as "com.android.camera.action.CROP. Only one
2676 * alternative of any particular action will be shown to the user, so using
2677 * a specific action like this makes sure that your alternative will be
2678 * displayed while also allowing other applications to provide their own
2679 * overrides of that particular action.
2680 */
2681 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2682 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2683 /**
2684 * Set if the activity should be considered as an alternative selection
2685 * action to the data the user has currently selected. This is like
2686 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2687 * of items from which the user can select, giving them alternatives to the
2688 * default action that will be performed on it.
2689 */
2690 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2691 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2692 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002693 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002694 */
2695 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2696 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2697 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002698 * Should be displayed in the top-level launcher.
2699 */
2700 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2701 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2702 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002703 * Provides information about the package it is in; typically used if
2704 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2705 * a front-door to the user without having to be shown in the all apps list.
2706 */
2707 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2708 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2709 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002710 * This is the home activity, that is the first activity that is displayed
2711 * when the device boots.
2712 */
2713 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2714 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2715 /**
2716 * This activity is a preference panel.
2717 */
2718 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2719 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2720 /**
2721 * This activity is a development preference panel.
2722 */
2723 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2724 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2725 /**
2726 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002727 */
2728 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2729 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2730 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002731 * This activity allows the user to browse and download new applications.
2732 */
2733 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2734 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2735 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002736 * This activity may be exercised by the monkey or other automated test tools.
2737 */
2738 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2739 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2740 /**
2741 * To be used as a test (not part of the normal user experience).
2742 */
2743 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2744 /**
2745 * To be used as a unit test (run through the Test Harness).
2746 */
2747 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2748 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002749 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002750 * experience).
2751 */
2752 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2753 /**
2754 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002755 * ContentResolver.openInputStream. Openable URIs must support the columns in
2756 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002757 * when queried, though it is allowable for those columns to be blank.
2758 */
2759 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2760 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2761
2762 /**
2763 * To be used as code under test for framework instrumentation tests.
2764 */
2765 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2766 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002767 /**
2768 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002769 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2770 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002771 */
2772 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2773 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2774 /**
2775 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002776 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2777 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002778 */
2779 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2780 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002781 /**
2782 * An activity to run when device is inserted into a analog (low end) dock.
2783 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2784 * information, see {@link android.app.UiModeManager}.
2785 */
2786 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2787 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2788
2789 /**
2790 * An activity to run when device is inserted into a digital (high end) dock.
2791 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2792 * information, see {@link android.app.UiModeManager}.
2793 */
2794 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2795 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002796
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002797 /**
2798 * Used to indicate that the activity can be used in a car environment.
2799 */
2800 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2801 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2802
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002803 // ---------------------------------------------------------------------
2804 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002805 // Application launch intent categories (see addCategory()).
2806
2807 /**
2808 * Used with {@link #ACTION_MAIN} to launch the browser application.
2809 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002810 * <p>NOTE: This should not be used as the primary key of an Intent,
2811 * since it will not result in the app launching with the correct
2812 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002813 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002814 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002815 */
2816 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2817 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2818
2819 /**
2820 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2821 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002822 * <p>NOTE: This should not be used as the primary key of an Intent,
2823 * since it will not result in the app launching with the correct
2824 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002825 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002826 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002827 */
2828 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2829 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2830
2831 /**
2832 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2833 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002834 * <p>NOTE: This should not be used as the primary key of an Intent,
2835 * since it will not result in the app launching with the correct
2836 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002837 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002838 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002839 */
2840 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2841 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2842
2843 /**
2844 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2845 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002846 * <p>NOTE: This should not be used as the primary key of an Intent,
2847 * since it will not result in the app launching with the correct
2848 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002849 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002850 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002851 */
2852 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2853 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2854
2855 /**
2856 * Used with {@link #ACTION_MAIN} to launch the email application.
2857 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002858 * <p>NOTE: This should not be used as the primary key of an Intent,
2859 * since it will not result in the app launching with the correct
2860 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002861 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002862 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002863 */
2864 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2865 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2866
2867 /**
2868 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2869 * The activity should be able to view and manipulate image and video files
2870 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002871 * <p>NOTE: This should not be used as the primary key of an Intent,
2872 * since it will not result in the app launching with the correct
2873 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002874 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002875 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002876 */
2877 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2878 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2879
2880 /**
2881 * Used with {@link #ACTION_MAIN} to launch the maps application.
2882 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002883 * <p>NOTE: This should not be used as the primary key of an Intent,
2884 * since it will not result in the app launching with the correct
2885 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002886 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002887 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002888 */
2889 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2890 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2891
2892 /**
2893 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2894 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002895 * <p>NOTE: This should not be used as the primary key of an Intent,
2896 * since it will not result in the app launching with the correct
2897 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002898 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002899 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002900 */
2901 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2902 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2903
2904 /**
2905 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002906 * The activity should be able to play, browse, or manipulate music files
2907 * stored on the device.
2908 * <p>NOTE: This should not be used as the primary key of an Intent,
2909 * since it will not result in the app launching with the correct
2910 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002911 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002912 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002913 */
2914 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2915 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2916
2917 // ---------------------------------------------------------------------
2918 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002919 // Standard extra data keys.
2920
2921 /**
2922 * The initial data to place in a newly created record. Use with
2923 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2924 * fields as would be given to the underlying ContentProvider.insert()
2925 * call.
2926 */
2927 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2928
2929 /**
2930 * A constant CharSequence that is associated with the Intent, used with
2931 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2932 * this may be a styled CharSequence, so you must use
2933 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2934 * retrieve it.
2935 */
2936 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2937
2938 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002939 * A constant String that is associated with the Intent, used with
2940 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2941 * as HTML formatted text. Note that you <em>must</em> also supply
2942 * {@link #EXTRA_TEXT}.
2943 */
2944 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2945
2946 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002947 * A content: URI holding a stream of data associated with the Intent,
2948 * used with {@link #ACTION_SEND} to supply the data being sent.
2949 */
2950 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2951
2952 /**
2953 * A String[] holding e-mail addresses that should be delivered to.
2954 */
2955 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2956
2957 /**
2958 * A String[] holding e-mail addresses that should be carbon copied.
2959 */
2960 public static final String EXTRA_CC = "android.intent.extra.CC";
2961
2962 /**
2963 * A String[] holding e-mail addresses that should be blind carbon copied.
2964 */
2965 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2966
2967 /**
2968 * A constant string holding the desired subject line of a message.
2969 */
2970 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2971
2972 /**
2973 * An Intent describing the choices you would like shown with
2974 * {@link #ACTION_PICK_ACTIVITY}.
2975 */
2976 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2977
2978 /**
2979 * A CharSequence dialog title to provide to the user when used with a
2980 * {@link #ACTION_CHOOSER}.
2981 */
2982 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2983
2984 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002985 * A Parcelable[] of {@link Intent} or
2986 * {@link android.content.pm.LabeledIntent} objects as set with
2987 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2988 * a the front of the list of choices, when shown to the user with a
2989 * {@link #ACTION_CHOOSER}.
2990 */
2991 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2992
2993 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002994 * A {@link android.view.KeyEvent} object containing the event that
2995 * triggered the creation of the Intent it is in.
2996 */
2997 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2998
2999 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07003000 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
3001 * before shutting down.
3002 *
3003 * {@hide}
3004 */
3005 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
3006
3007 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003008 * 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 -07003009 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
3010 * of restarting the application.
3011 */
3012 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
3013
3014 /**
3015 * A String holding the phone number originally entered in
3016 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
3017 * number to call in a {@link android.content.Intent#ACTION_CALL}.
3018 */
3019 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02003020
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003021 /**
3022 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
3023 * intents to supply the uid the package had been assigned. Also an optional
3024 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
3025 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
3026 * purpose.
3027 */
3028 public static final String EXTRA_UID = "android.intent.extra.UID";
3029
3030 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08003031 * @hide String array of package names.
3032 */
3033 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
3034
3035 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003036 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3037 * intents to indicate whether this represents a full uninstall (removing
3038 * both the code and its data) or a partial uninstall (leaving its data,
3039 * implying that this is an update).
3040 */
3041 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07003042
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003043 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07003044 * @hide
3045 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3046 * intents to indicate that at this point the package has been removed for
3047 * all users on the device.
3048 */
3049 public static final String EXTRA_REMOVED_FOR_ALL_USERS
3050 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
3051
3052 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003053 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
3054 * intents to indicate that this is a replacement of the package, so this
3055 * broadcast will immediately be followed by an add broadcast for a
3056 * different version of the same package.
3057 */
3058 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07003059
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003060 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003061 * Used as an int extra field in {@link android.app.AlarmManager} intents
3062 * to tell the application being invoked how many pending alarms are being
3063 * delievered with the intent. For one-shot alarms this will always be 1.
3064 * For recurring alarms, this might be greater than 1 if the device was
3065 * asleep or powered off at the time an earlier alarm would have been
3066 * delivered.
3067 */
3068 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003069
Jacek Surazski86b6c532009-05-13 14:38:28 +02003070 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003071 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3072 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003073 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3074 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003075 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3076 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3077 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003078 */
3079 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3080
3081 /**
3082 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3083 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003084 */
3085 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3086
3087 /**
3088 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3089 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003090 */
3091 public static final int EXTRA_DOCK_STATE_DESK = 1;
3092
3093 /**
3094 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3095 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003096 */
3097 public static final int EXTRA_DOCK_STATE_CAR = 2;
3098
3099 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003100 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3101 * to represent that the phone is in a analog (low end) dock.
3102 */
3103 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3104
3105 /**
3106 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3107 * to represent that the phone is in a digital (high end) dock.
3108 */
3109 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3110
3111 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003112 * Boolean that can be supplied as meta-data with a dock activity, to
3113 * indicate that the dock should take over the home key when it is active.
3114 */
3115 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003116
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003117 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003118 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3119 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003120 */
3121 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3122
3123 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003124 * Used in the extra field in the remote intent. It's astring token passed with the
3125 * remote intent.
3126 */
3127 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3128 "android.intent.extra.remote_intent_token";
3129
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003130 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003131 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003132 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003133 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003134 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003135 "android.intent.extra.changed_component_name";
3136
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003137 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003138 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003139 * and contains a string array of all of the components that have changed. If
3140 * the state of the overall package has changed, then it will contain an entry
3141 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003142 */
3143 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3144 "android.intent.extra.changed_component_name_list";
3145
3146 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003147 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003148 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3149 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003150 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003151 */
3152 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3153 "android.intent.extra.changed_package_list";
3154
3155 /**
3156 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003157 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3158 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003159 * and contains an integer array of uids of all of the components
3160 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003161 */
3162 public static final String EXTRA_CHANGED_UID_LIST =
3163 "android.intent.extra.changed_uid_list";
3164
3165 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003166 * @hide
3167 * Magic extra system code can use when binding, to give a label for
3168 * who it is that has bound to a service. This is an integer giving
3169 * a framework string resource that can be displayed to the user.
3170 */
3171 public static final String EXTRA_CLIENT_LABEL =
3172 "android.intent.extra.client_label";
3173
3174 /**
3175 * @hide
3176 * Magic extra system code can use when binding, to give a PendingIntent object
3177 * that can be launched for the user to disable the system's use of this
3178 * service.
3179 */
3180 public static final String EXTRA_CLIENT_INTENT =
3181 "android.intent.extra.client_intent";
3182
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003183 /**
3184 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3185 * data that is on the local device. This is a boolean extra; the default
3186 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3187 * the user to select media that is already on the device, not requiring it
3188 * be downloaded from a remote service when opened. Another way to look
3189 * at it is that such content should generally have a "_data" column to the
3190 * path of the content on local external storage.
3191 */
3192 public static final String EXTRA_LOCAL_ONLY =
3193 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003194
Amith Yamasani13593602012-03-22 16:16:17 -07003195 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003196 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3197 * user to select and return multiple items. This is a boolean extra; the default
3198 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3199 * present the user with a UI where they can pick multiple items that are all
3200 * returned to the caller. When this happens, they should be returned as
3201 * the {@link #getClipData()} part of the result Intent.
3202 */
3203 public static final String EXTRA_ALLOW_MULTIPLE =
3204 "android.intent.extra.ALLOW_MULTIPLE";
3205
3206 /**
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003207 * The userHandle carried with broadcast intents related to addition, removal and switching of
3208 * users
Amith Yamasani13593602012-03-22 16:16:17 -07003209 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3210 * @hide
3211 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003212 public static final String EXTRA_USER_HANDLE =
3213 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003214
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003215 /**
3216 * Extra used in the response from a BroadcastReceiver that handles
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003217 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is
3218 * <code>ArrayList&lt;RestrictionEntry&gt;</code>.
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003219 */
Amith Yamasani7e99bc02013-04-16 18:24:51 -07003220 public static final String EXTRA_RESTRICTIONS_LIST = "android.intent.extra.restrictions_list";
3221
3222 /**
3223 * Extra sent in the intent to the BroadcastReceiver that handles
3224 * {@link #ACTION_GET_RESTRICTION_ENTRIES}. The type of the extra is a Bundle containing
3225 * the restrictions as key/value pairs.
3226 */
3227 public static final String EXTRA_RESTRICTIONS_BUNDLE =
3228 "android.intent.extra.restrictions_bundle";
Amith Yamasanidf2e92a2013-03-01 17:04:38 -08003229
Amith Yamasani86118ba2013-03-28 14:33:16 -07003230 /**
3231 * Extra used in the response from a BroadcastReceiver that handles
3232 * {@link #ACTION_GET_RESTRICTION_ENTRIES}.
3233 */
3234 public static final String EXTRA_RESTRICTIONS_INTENT =
3235 "android.intent.extra.restrictions_intent";
3236
Jeff Sharkey9ecfee02013-04-19 14:05:03 -07003237 /**
3238 * Extra used to communicate set of acceptable MIME types for
3239 * {@link #ACTION_GET_CONTENT} or {@link #ACTION_OPEN_DOC}. The type of the
3240 * extra is <code>ArrayList&lt;String&gt;</code>.
3241 * @hide
3242 */
3243 public static final String EXTRA_MIME_TYPES = "android.intent.extra.MIME_TYPES";
3244
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003245 // ---------------------------------------------------------------------
3246 // ---------------------------------------------------------------------
3247 // Intent flags (see mFlags variable).
3248
3249 /**
3250 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003251 * perform read operations on the Uri in the Intent's data and any URIs
3252 * specified in its ClipData. When applying to an Intent's ClipData,
3253 * all URIs as well as recursive traversals through data or other ClipData
3254 * in Intent items will be granted; only the grant flags of the top-level
3255 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003256 */
3257 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3258 /**
3259 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003260 * perform write operations on the Uri in the Intent's data and any URIs
3261 * specified in its ClipData. When applying to an Intent's ClipData,
3262 * all URIs as well as recursive traversals through data or other ClipData
3263 * in Intent items will be granted; only the grant flags of the top-level
3264 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003265 */
3266 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3267 /**
3268 * Can be set by the caller to indicate that this Intent is coming from
3269 * a background operation, not from direct user interaction.
3270 */
3271 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3272 /**
3273 * A flag you can enable for debugging: when set, log messages will be
3274 * printed during the resolution of this intent to show you what has
3275 * been found to create the final resolved list.
3276 */
3277 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003278 /**
3279 * If set, this intent will not match any components in packages that
3280 * are currently stopped. If this is not set, then the default behavior
3281 * is to include such applications in the result.
3282 */
3283 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3284 /**
3285 * If set, this intent will always match any components in packages that
3286 * are currently stopped. This is the default behavior when
3287 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3288 * flags are set, this one wins (it allows overriding of exclude for
3289 * places where the framework may automatically set the exclude flag).
3290 */
3291 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003292
3293 /**
Jeff Sharkey328ebf22013-03-21 18:09:39 -07003294 * When combined with {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
3295 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, the grant will be remembered
3296 * until explicitly revoked with
3297 * {@link Context#revokeUriPermission(Uri, int)}. These grants persist
3298 * across device reboots.
3299 */
3300 public static final int FLAG_PERSIST_GRANT_URI_PERMISSION = 0x00000040;
3301
3302 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003303 * If set, the new activity is not kept in the history stack. As soon as
3304 * the user navigates away from it, the activity is finished. This may also
3305 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3306 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003307 */
3308 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3309 /**
3310 * If set, the activity will not be launched if it is already running
3311 * at the top of the history stack.
3312 */
3313 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3314 /**
3315 * If set, this activity will become the start of a new task on this
3316 * history stack. A task (from the activity that started it to the
3317 * next task activity) defines an atomic group of activities that the
3318 * user can move to. Tasks can be moved to the foreground and background;
3319 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003320 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003321 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3322 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003323 *
3324 * <p>This flag is generally used by activities that want
3325 * to present a "launcher" style behavior: they give the user a list of
3326 * separate things that can be done, which otherwise run completely
3327 * independently of the activity launching them.
3328 *
3329 * <p>When using this flag, if a task is already running for the activity
3330 * you are now starting, then a new activity will not be started; instead,
3331 * the current task will simply be brought to the front of the screen with
3332 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3333 * to disable this behavior.
3334 *
3335 * <p>This flag can not be used when the caller is requesting a result from
3336 * the activity being launched.
3337 */
3338 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3339 /**
3340 * <strong>Do not use this flag unless you are implementing your own
3341 * top-level application launcher.</strong> Used in conjunction with
3342 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3343 * behavior of bringing an existing task to the foreground. When set,
3344 * a new task is <em>always</em> started to host the Activity for the
3345 * Intent, regardless of whether there is already an existing task running
3346 * the same thing.
3347 *
3348 * <p><strong>Because the default system does not include graphical task management,
3349 * you should not use this flag unless you provide some way for a user to
3350 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003351 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003352 * <p>This flag is ignored if
3353 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3354 *
Scott Main7aee61f2011-02-08 11:25:01 -08003355 * <p>See
3356 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3357 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003358 */
3359 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3360 /**
3361 * If set, and the activity being launched is already running in the
3362 * current task, then instead of launching a new instance of that activity,
3363 * all of the other activities on top of it will be closed and this Intent
3364 * will be delivered to the (now on top) old activity as a new Intent.
3365 *
3366 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3367 * If D calls startActivity() with an Intent that resolves to the component
3368 * of activity B, then C and D will be finished and B receive the given
3369 * Intent, resulting in the stack now being: A, B.
3370 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003371 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003372 * either receive the new intent you are starting here in its
3373 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003374 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003375 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3376 * the same intent, then it will be finished and re-created; for all other
3377 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3378 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003379 *
3380 * <p>This launch mode can also be used to good effect in conjunction with
3381 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3382 * of a task, it will bring any currently running instance of that task
3383 * to the foreground, and then clear it to its root state. This is
3384 * especially useful, for example, when launching an activity from the
3385 * notification manager.
3386 *
Scott Main7aee61f2011-02-08 11:25:01 -08003387 * <p>See
3388 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3389 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003390 */
3391 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3392 /**
3393 * If set and this intent is being used to launch a new activity from an
3394 * existing one, then the reply target of the existing activity will be
3395 * transfered to the new activity. This way the new activity can call
3396 * {@link android.app.Activity#setResult} and have that result sent back to
3397 * the reply target of the original activity.
3398 */
3399 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3400 /**
3401 * If set and this intent is being used to launch a new activity from an
3402 * existing one, the current activity will not be counted as the top
3403 * activity for deciding whether the new intent should be delivered to
3404 * the top instead of starting a new one. The previous activity will
3405 * be used as the top, with the assumption being that the current activity
3406 * will finish itself immediately.
3407 */
3408 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3409 /**
3410 * If set, the new activity is not kept in the list of recently launched
3411 * activities.
3412 */
3413 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3414 /**
3415 * This flag is not normally set by application code, but set for you by
3416 * the system as described in the
3417 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3418 * launchMode} documentation for the singleTask mode.
3419 */
3420 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3421 /**
3422 * If set, and this activity is either being started in a new task or
3423 * bringing to the top an existing task, then it will be launched as
3424 * the front door of the task. This will result in the application of
3425 * any affinities needed to have that task in the proper state (either
3426 * moving activities to or from it), or simply resetting that task to
3427 * its initial state if needed.
3428 */
3429 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3430 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003431 * This flag is not normally set by application code, but set for you by
3432 * the system if this activity is being launched from history
3433 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003434 */
3435 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003436 /**
3437 * If set, this marks a point in the task's activity stack that should
3438 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003439 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003440 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3441 * the user re-launching it from home), this activity and all on top of
3442 * it will be finished so that the user does not return to them, but
3443 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003444 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003445 * <p>This is useful for cases where you have a logical break in your
3446 * application. For example, an e-mail application may have a command
3447 * to view an attachment, which launches an image view activity to
3448 * display it. This activity should be part of the e-mail application's
3449 * task, since it is a part of the task the user is involved in. However,
3450 * if the user leaves that task, and later selects the e-mail app from
3451 * home, we may like them to return to the conversation they were
3452 * viewing, not the picture attachment, since that is confusing. By
3453 * setting this flag when launching the image viewer, that viewer and
3454 * any activities it starts will be removed the next time the user returns
3455 * to mail.
3456 */
3457 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003458 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003459 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003460 * callback from occurring on the current frontmost activity before it is
3461 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003462 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003463 * <p>Typically, an activity can rely on that callback to indicate that an
3464 * explicit user action has caused their activity to be moved out of the
3465 * foreground. The callback marks an appropriate point in the activity's
3466 * lifecycle for it to dismiss any notifications that it intends to display
3467 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003468 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003469 * <p>If an activity is ever started via any non-user-driven events such as
3470 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3471 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003472 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003473 */
3474 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003475 /**
3476 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3477 * this flag will cause the launched activity to be brought to the front of its
3478 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003479 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003480 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3481 * If D calls startActivity() with an Intent that resolves to the component
3482 * of activity B, then B will be brought to the front of the history stack,
3483 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003484 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003485 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003486 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003487 */
3488 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003489 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003490 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3491 * this flag will prevent the system from applying an activity transition
3492 * animation to go to the next activity state. This doesn't mean an
3493 * animation will never run -- if another activity change happens that doesn't
3494 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003495 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003496 * when you are going to do a series of activity operations but the
3497 * animation seen by the user shouldn't be driven by the first activity
3498 * change but rather a later one.
3499 */
3500 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3501 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003502 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3503 * this flag will cause any existing task that would be associated with the
3504 * activity to be cleared before the activity is started. That is, the activity
3505 * becomes the new root of an otherwise empty task, and any old activities
3506 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3507 */
3508 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3509 /**
3510 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3511 * this flag will cause a newly launching task to be placed on top of the current
3512 * home activity task (if there is one). That is, pressing back from the task
3513 * will always return the user to home even if that was not the last activity they
3514 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3515 */
3516 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3517 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003518 * If set, when sending a broadcast only registered receivers will be
3519 * called -- no BroadcastReceiver components will be launched.
3520 */
3521 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003522 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003523 * If set, when sending a broadcast the new broadcast will replace
3524 * any existing pending broadcast that matches it. Matching is defined
3525 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3526 * true for the intents of the two broadcasts. When a match is found,
3527 * the new broadcast (and receivers associated with it) will replace the
3528 * existing one in the pending broadcast list, remaining at the same
3529 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003530 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003531 * <p>This flag is most typically used with sticky broadcasts, which
3532 * only care about delivering the most recent values of the broadcast
3533 * to their receivers.
3534 */
3535 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3536 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003537 * If set, when sending a broadcast the recipient is allowed to run at
3538 * foreground priority, with a shorter timeout interval. During normal
3539 * broadcasts the receivers are not automatically hoisted out of the
3540 * background priority class.
3541 */
3542 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3543 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003544 * If set, when sending a broadcast <i>before boot has completed</i> only
3545 * registered receivers will be called -- no BroadcastReceiver components
3546 * will be launched. Sticky intent state will be recorded properly even
3547 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3548 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003549 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003550 * <p>This flag is only for use by system sevices as a convenience to
3551 * avoid having to implement a more complex mechanism around detection
3552 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003553 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003554 * @hide
3555 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003556 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003557 /**
3558 * Set when this broadcast is for a boot upgrade, a special mode that
3559 * allows the broadcast to be sent before the system is ready and launches
3560 * the app process with no providers running in it.
3561 * @hide
3562 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003563 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003564
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003565 /**
3566 * @hide Flags that can't be changed with PendingIntent.
3567 */
3568 public static final int IMMUTABLE_FLAGS =
3569 FLAG_GRANT_READ_URI_PERMISSION
3570 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003571
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003572 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003573 // ---------------------------------------------------------------------
3574 // toUri() and parseUri() options.
3575
3576 /**
3577 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3578 * always has the "intent:" scheme. This syntax can be used when you want
3579 * to later disambiguate between URIs that are intended to describe an
3580 * Intent vs. all others that should be treated as raw URIs. When used
3581 * with {@link #parseUri}, any other scheme will result in a generic
3582 * VIEW action for that raw URI.
3583 */
3584 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003585
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003586 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003587
3588 private String mAction;
3589 private Uri mData;
3590 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003591 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003592 private ComponentName mComponent;
3593 private int mFlags;
3594 private HashSet<String> mCategories;
3595 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003596 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003597 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003598 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003599
3600 // ---------------------------------------------------------------------
3601
3602 /**
3603 * Create an empty intent.
3604 */
3605 public Intent() {
3606 }
3607
3608 /**
3609 * Copy constructor.
3610 */
3611 public Intent(Intent o) {
3612 this.mAction = o.mAction;
3613 this.mData = o.mData;
3614 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003615 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003616 this.mComponent = o.mComponent;
3617 this.mFlags = o.mFlags;
3618 if (o.mCategories != null) {
3619 this.mCategories = new HashSet<String>(o.mCategories);
3620 }
3621 if (o.mExtras != null) {
3622 this.mExtras = new Bundle(o.mExtras);
3623 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003624 if (o.mSourceBounds != null) {
3625 this.mSourceBounds = new Rect(o.mSourceBounds);
3626 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003627 if (o.mSelector != null) {
3628 this.mSelector = new Intent(o.mSelector);
3629 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003630 if (o.mClipData != null) {
3631 this.mClipData = new ClipData(o.mClipData);
3632 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003633 }
3634
3635 @Override
3636 public Object clone() {
3637 return new Intent(this);
3638 }
3639
3640 private Intent(Intent o, boolean all) {
3641 this.mAction = o.mAction;
3642 this.mData = o.mData;
3643 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003644 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003645 this.mComponent = o.mComponent;
3646 if (o.mCategories != null) {
3647 this.mCategories = new HashSet<String>(o.mCategories);
3648 }
3649 }
3650
3651 /**
3652 * Make a clone of only the parts of the Intent that are relevant for
3653 * filter matching: the action, data, type, component, and categories.
3654 */
3655 public Intent cloneFilter() {
3656 return new Intent(this, false);
3657 }
3658
3659 /**
3660 * Create an intent with a given action. All other fields (data, type,
3661 * class) are null. Note that the action <em>must</em> be in a
3662 * namespace because Intents are used globally in the system -- for
3663 * example the system VIEW action is android.intent.action.VIEW; an
3664 * application's custom action would be something like
3665 * com.google.app.myapp.CUSTOM_ACTION.
3666 *
3667 * @param action The Intent action, such as ACTION_VIEW.
3668 */
3669 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003670 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003671 }
3672
3673 /**
3674 * Create an intent with a given action and for a given data url. Note
3675 * that the action <em>must</em> be in a namespace because Intents are
3676 * used globally in the system -- for example the system VIEW action is
3677 * android.intent.action.VIEW; an application's custom action would be
3678 * something like com.google.app.myapp.CUSTOM_ACTION.
3679 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003680 * <p><em>Note: scheme and host name matching in the Android framework is
3681 * case-sensitive, unlike the formal RFC. As a result,
3682 * you should always ensure that you write your Uri with these elements
3683 * using lower case letters, and normalize any Uris you receive from
3684 * outside of Android to ensure the scheme and host is lower case.</em></p>
3685 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003686 * @param action The Intent action, such as ACTION_VIEW.
3687 * @param uri The Intent data URI.
3688 */
3689 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003690 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003691 mData = uri;
3692 }
3693
3694 /**
3695 * Create an intent for a specific component. All other fields (action, data,
3696 * type, class) are null, though they can be modified later with explicit
3697 * calls. This provides a convenient way to create an intent that is
3698 * intended to execute a hard-coded class name, rather than relying on the
3699 * system to find an appropriate class for you; see {@link #setComponent}
3700 * for more information on the repercussions of this.
3701 *
3702 * @param packageContext A Context of the application package implementing
3703 * this class.
3704 * @param cls The component class that is to be used for the intent.
3705 *
3706 * @see #setClass
3707 * @see #setComponent
3708 * @see #Intent(String, android.net.Uri , Context, Class)
3709 */
3710 public Intent(Context packageContext, Class<?> cls) {
3711 mComponent = new ComponentName(packageContext, cls);
3712 }
3713
3714 /**
3715 * Create an intent for a specific component with a specified action and data.
3716 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3717 * construct the Intent and then calling {@link #setClass} to set its
3718 * class.
3719 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003720 * <p><em>Note: scheme and host name matching in the Android framework is
3721 * case-sensitive, unlike the formal RFC. As a result,
3722 * you should always ensure that you write your Uri with these elements
3723 * using lower case letters, and normalize any Uris you receive from
3724 * outside of Android to ensure the scheme and host is lower case.</em></p>
3725 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003726 * @param action The Intent action, such as ACTION_VIEW.
3727 * @param uri The Intent data URI.
3728 * @param packageContext A Context of the application package implementing
3729 * this class.
3730 * @param cls The component class that is to be used for the intent.
3731 *
3732 * @see #Intent(String, android.net.Uri)
3733 * @see #Intent(Context, Class)
3734 * @see #setClass
3735 * @see #setComponent
3736 */
3737 public Intent(String action, Uri uri,
3738 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003739 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003740 mData = uri;
3741 mComponent = new ComponentName(packageContext, cls);
3742 }
3743
3744 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003745 * Create an intent to launch the main (root) activity of a task. This
3746 * is the Intent that is started when the application's is launched from
3747 * Home. For anything else that wants to launch an application in the
3748 * same way, it is important that they use an Intent structured the same
3749 * way, and can use this function to ensure this is the case.
3750 *
3751 * <p>The returned Intent has the given Activity component as its explicit
3752 * component, {@link #ACTION_MAIN} as its action, and includes the
3753 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3754 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3755 * to do that through {@link #addFlags(int)} on the returned Intent.
3756 *
3757 * @param mainActivity The main activity component that this Intent will
3758 * launch.
3759 * @return Returns a newly created Intent that can be used to launch the
3760 * activity as a main application entry.
3761 *
3762 * @see #setClass
3763 * @see #setComponent
3764 */
3765 public static Intent makeMainActivity(ComponentName mainActivity) {
3766 Intent intent = new Intent(ACTION_MAIN);
3767 intent.setComponent(mainActivity);
3768 intent.addCategory(CATEGORY_LAUNCHER);
3769 return intent;
3770 }
3771
3772 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003773 * Make an Intent for the main activity of an application, without
3774 * specifying a specific activity to run but giving a selector to find
3775 * the activity. This results in a final Intent that is structured
3776 * the same as when the application is launched from
3777 * Home. For anything else that wants to launch an application in the
3778 * same way, it is important that they use an Intent structured the same
3779 * way, and can use this function to ensure this is the case.
3780 *
3781 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3782 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3783 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3784 * to do that through {@link #addFlags(int)} on the returned Intent.
3785 *
3786 * @param selectorAction The action name of the Intent's selector.
3787 * @param selectorCategory The name of a category to add to the Intent's
3788 * selector.
3789 * @return Returns a newly created Intent that can be used to launch the
3790 * activity as a main application entry.
3791 *
3792 * @see #setSelector(Intent)
3793 */
3794 public static Intent makeMainSelectorActivity(String selectorAction,
3795 String selectorCategory) {
3796 Intent intent = new Intent(ACTION_MAIN);
3797 intent.addCategory(CATEGORY_LAUNCHER);
3798 Intent selector = new Intent();
3799 selector.setAction(selectorAction);
3800 selector.addCategory(selectorCategory);
3801 intent.setSelector(selector);
3802 return intent;
3803 }
3804
3805 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003806 * Make an Intent that can be used to re-launch an application's task
3807 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3808 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3809 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3810 *
3811 * @param mainActivity The activity component that is the root of the
3812 * task; this is the activity that has been published in the application's
3813 * manifest as the main launcher icon.
3814 *
3815 * @return Returns a newly created Intent that can be used to relaunch the
3816 * activity's task in its root state.
3817 */
3818 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3819 Intent intent = makeMainActivity(mainActivity);
3820 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3821 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3822 return intent;
3823 }
3824
3825 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003826 * Call {@link #parseUri} with 0 flags.
3827 * @deprecated Use {@link #parseUri} instead.
3828 */
3829 @Deprecated
3830 public static Intent getIntent(String uri) throws URISyntaxException {
3831 return parseUri(uri, 0);
3832 }
Tom Taylord4a47292009-12-21 13:59:18 -08003833
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003834 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003835 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003836 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003837 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003838 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003839 *
3840 * <p>The URI given here must not be relative -- that is, it must include
3841 * the scheme and full path.
3842 *
3843 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003844 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003845 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003846 *
3847 * @return Intent The newly created Intent object.
3848 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003849 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3850 * it bad (as parsed by the Uri class) or the Intent data within the
3851 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003852 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003853 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003854 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003855 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003856 int i = 0;
3857 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003858 // Validate intent scheme for if requested.
3859 if ((flags&URI_INTENT_SCHEME) != 0) {
3860 if (!uri.startsWith("intent:")) {
3861 Intent intent = new Intent(ACTION_VIEW);
3862 try {
3863 intent.setData(Uri.parse(uri));
3864 } catch (IllegalArgumentException e) {
3865 throw new URISyntaxException(uri, e.getMessage());
3866 }
3867 return intent;
3868 }
3869 }
Tom Taylord4a47292009-12-21 13:59:18 -08003870
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003871 // simple case
3872 i = uri.lastIndexOf("#");
3873 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3874
3875 // old format Intent URI
3876 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003877
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003878 // new format
3879 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003880 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003881
3882 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003883 String data = i >= 0 ? uri.substring(0, i) : null;
3884 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003885 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003886
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003887 // loop over contents of Intent, all name=value;
3888 while (!uri.startsWith("end", i)) {
3889 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003890 if (eq < 0) eq = i-1;
3891 int semi = uri.indexOf(';', i);
3892 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003893
3894 // action
3895 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003896 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003897 }
3898
3899 // categories
3900 else if (uri.startsWith("category=", i)) {
3901 intent.addCategory(value);
3902 }
3903
3904 // type
3905 else if (uri.startsWith("type=", i)) {
3906 intent.mType = value;
3907 }
3908
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003909 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003910 else if (uri.startsWith("launchFlags=", i)) {
3911 intent.mFlags = Integer.decode(value).intValue();
3912 }
3913
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003914 // package
3915 else if (uri.startsWith("package=", i)) {
3916 intent.mPackage = value;
3917 }
3918
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003919 // component
3920 else if (uri.startsWith("component=", i)) {
3921 intent.mComponent = ComponentName.unflattenFromString(value);
3922 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003923
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003924 // scheme
3925 else if (uri.startsWith("scheme=", i)) {
3926 scheme = value;
3927 }
3928
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003929 // source bounds
3930 else if (uri.startsWith("sourceBounds=", i)) {
3931 intent.mSourceBounds = Rect.unflattenFromString(value);
3932 }
3933
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003934 // selector
3935 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3936 intent = new Intent();
3937 }
3938
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003939 // extra
3940 else {
3941 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003942 // create Bundle if it doesn't already exist
3943 if (intent.mExtras == null) intent.mExtras = new Bundle();
3944 Bundle b = intent.mExtras;
3945 // add EXTRA
3946 if (uri.startsWith("S.", i)) b.putString(key, value);
3947 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3948 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3949 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3950 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3951 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3952 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3953 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3954 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3955 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3956 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003957
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003958 // move to the next item
3959 i = semi + 1;
3960 }
3961
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003962 if (intent != baseIntent) {
3963 // The Intent had a selector; fix it up.
3964 baseIntent.setSelector(intent);
3965 intent = baseIntent;
3966 }
3967
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003968 if (data != null) {
3969 if (data.startsWith("intent:")) {
3970 data = data.substring(7);
3971 if (scheme != null) {
3972 data = scheme + ':' + data;
3973 }
3974 }
Tom Taylord4a47292009-12-21 13:59:18 -08003975
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003976 if (data.length() > 0) {
3977 try {
3978 intent.mData = Uri.parse(data);
3979 } catch (IllegalArgumentException e) {
3980 throw new URISyntaxException(uri, e.getMessage());
3981 }
3982 }
3983 }
Tom Taylord4a47292009-12-21 13:59:18 -08003984
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003985 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003986
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003987 } catch (IndexOutOfBoundsException e) {
3988 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3989 }
3990 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003991
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003992 public static Intent getIntentOld(String uri) throws URISyntaxException {
3993 Intent intent;
3994
3995 int i = uri.lastIndexOf('#');
3996 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003997 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003998 final int intentFragmentStart = i;
3999 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004000
4001 i++;
4002
4003 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004004 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004005 i += 7;
4006 int j = uri.indexOf(')', i);
4007 action = uri.substring(i, j);
4008 i = j + 1;
4009 }
4010
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004011 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004012
4013 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004014 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004015 i += 11;
4016 int j = uri.indexOf(')', i);
4017 while (i < j) {
4018 int sep = uri.indexOf('!', i);
4019 if (sep < 0) sep = j;
4020 if (i < sep) {
4021 intent.addCategory(uri.substring(i, sep));
4022 }
4023 i = sep + 1;
4024 }
4025 i = j + 1;
4026 }
4027
4028 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004029 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004030 i += 5;
4031 int j = uri.indexOf(')', i);
4032 intent.mType = uri.substring(i, j);
4033 i = j + 1;
4034 }
4035
4036 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004037 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004038 i += 12;
4039 int j = uri.indexOf(')', i);
4040 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
4041 i = j + 1;
4042 }
4043
4044 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004045 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004046 i += 10;
4047 int j = uri.indexOf(')', i);
4048 int sep = uri.indexOf('!', i);
4049 if (sep >= 0 && sep < j) {
4050 String pkg = uri.substring(i, sep);
4051 String cls = uri.substring(sep + 1, j);
4052 intent.mComponent = new ComponentName(pkg, cls);
4053 }
4054 i = j + 1;
4055 }
4056
4057 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004058 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004059 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07004060
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004061 final int closeParen = uri.indexOf(')', i);
4062 if (closeParen == -1) throw new URISyntaxException(uri,
4063 "EXTRA missing trailing ')'", i);
4064
4065 while (i < closeParen) {
4066 // fetch the key value
4067 int j = uri.indexOf('=', i);
4068 if (j <= i + 1 || i >= closeParen) {
4069 throw new URISyntaxException(uri, "EXTRA missing '='", i);
4070 }
4071 char type = uri.charAt(i);
4072 i++;
4073 String key = uri.substring(i, j);
4074 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07004075
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004076 // get type-value
4077 j = uri.indexOf('!', i);
4078 if (j == -1 || j >= closeParen) j = closeParen;
4079 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4080 String value = uri.substring(i, j);
4081 i = j;
4082
4083 // create Bundle if it doesn't already exist
4084 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07004085
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004086 // add item to bundle
4087 try {
4088 switch (type) {
4089 case 'S':
4090 intent.mExtras.putString(key, Uri.decode(value));
4091 break;
4092 case 'B':
4093 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
4094 break;
4095 case 'b':
4096 intent.mExtras.putByte(key, Byte.parseByte(value));
4097 break;
4098 case 'c':
4099 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
4100 break;
4101 case 'd':
4102 intent.mExtras.putDouble(key, Double.parseDouble(value));
4103 break;
4104 case 'f':
4105 intent.mExtras.putFloat(key, Float.parseFloat(value));
4106 break;
4107 case 'i':
4108 intent.mExtras.putInt(key, Integer.parseInt(value));
4109 break;
4110 case 'l':
4111 intent.mExtras.putLong(key, Long.parseLong(value));
4112 break;
4113 case 's':
4114 intent.mExtras.putShort(key, Short.parseShort(value));
4115 break;
4116 default:
4117 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4118 }
4119 } catch (NumberFormatException e) {
4120 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4121 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004122
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004123 char ch = uri.charAt(i);
4124 if (ch == ')') break;
4125 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4126 i++;
4127 }
4128 }
4129
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004130 if (isIntentFragment) {
4131 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4132 } else {
4133 intent.mData = Uri.parse(uri);
4134 }
Tom Taylord4a47292009-12-21 13:59:18 -08004135
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004136 if (intent.mAction == null) {
4137 // By default, if no action is specified, then use VIEW.
4138 intent.mAction = ACTION_VIEW;
4139 }
4140
4141 } else {
4142 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4143 }
4144
4145 return intent;
4146 }
4147
4148 /**
4149 * Retrieve the general action to be performed, such as
4150 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4151 * the information in the intent should be interpreted -- most importantly,
4152 * what to do with the data returned by {@link #getData}.
4153 *
4154 * @return The action of this intent or null if none is specified.
4155 *
4156 * @see #setAction
4157 */
4158 public String getAction() {
4159 return mAction;
4160 }
4161
4162 /**
4163 * Retrieve data this intent is operating on. This URI specifies the name
4164 * of the data; often it uses the content: scheme, specifying data in a
4165 * content provider. Other schemes may be handled by specific activities,
4166 * such as http: by the web browser.
4167 *
4168 * @return The URI of the data this intent is targeting or null.
4169 *
4170 * @see #getScheme
4171 * @see #setData
4172 */
4173 public Uri getData() {
4174 return mData;
4175 }
4176
4177 /**
4178 * The same as {@link #getData()}, but returns the URI as an encoded
4179 * String.
4180 */
4181 public String getDataString() {
4182 return mData != null ? mData.toString() : null;
4183 }
4184
4185 /**
4186 * Return the scheme portion of the intent's data. If the data is null or
4187 * does not include a scheme, null is returned. Otherwise, the scheme
4188 * prefix without the final ':' is returned, i.e. "http".
4189 *
4190 * <p>This is the same as calling getData().getScheme() (and checking for
4191 * null data).
4192 *
4193 * @return The scheme of this intent.
4194 *
4195 * @see #getData
4196 */
4197 public String getScheme() {
4198 return mData != null ? mData.getScheme() : null;
4199 }
4200
4201 /**
4202 * Retrieve any explicit MIME type included in the intent. This is usually
4203 * null, as the type is determined by the intent data.
4204 *
4205 * @return If a type was manually set, it is returned; else null is
4206 * returned.
4207 *
4208 * @see #resolveType(ContentResolver)
4209 * @see #setType
4210 */
4211 public String getType() {
4212 return mType;
4213 }
4214
4215 /**
4216 * Return the MIME data type of this intent. If the type field is
4217 * explicitly set, that is simply returned. Otherwise, if the data is set,
4218 * the type of that data is returned. If neither fields are set, a null is
4219 * returned.
4220 *
4221 * @return The MIME type of this intent.
4222 *
4223 * @see #getType
4224 * @see #resolveType(ContentResolver)
4225 */
4226 public String resolveType(Context context) {
4227 return resolveType(context.getContentResolver());
4228 }
4229
4230 /**
4231 * Return the MIME data type of this intent. If the type field is
4232 * explicitly set, that is simply returned. Otherwise, if the data is set,
4233 * the type of that data is returned. If neither fields are set, a null is
4234 * returned.
4235 *
4236 * @param resolver A ContentResolver that can be used to determine the MIME
4237 * type of the intent's data.
4238 *
4239 * @return The MIME type of this intent.
4240 *
4241 * @see #getType
4242 * @see #resolveType(Context)
4243 */
4244 public String resolveType(ContentResolver resolver) {
4245 if (mType != null) {
4246 return mType;
4247 }
4248 if (mData != null) {
4249 if ("content".equals(mData.getScheme())) {
4250 return resolver.getType(mData);
4251 }
4252 }
4253 return null;
4254 }
4255
4256 /**
4257 * Return the MIME data type of this intent, only if it will be needed for
4258 * intent resolution. This is not generally useful for application code;
4259 * it is used by the frameworks for communicating with back-end system
4260 * services.
4261 *
4262 * @param resolver A ContentResolver that can be used to determine the MIME
4263 * type of the intent's data.
4264 *
4265 * @return The MIME type of this intent, or null if it is unknown or not
4266 * needed.
4267 */
4268 public String resolveTypeIfNeeded(ContentResolver resolver) {
4269 if (mComponent != null) {
4270 return mType;
4271 }
4272 return resolveType(resolver);
4273 }
4274
4275 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004276 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004277 *
4278 * @param category The category to check.
4279 *
4280 * @return boolean True if the intent contains the category, else false.
4281 *
4282 * @see #getCategories
4283 * @see #addCategory
4284 */
4285 public boolean hasCategory(String category) {
4286 return mCategories != null && mCategories.contains(category);
4287 }
4288
4289 /**
4290 * Return the set of all categories in the intent. If there are no categories,
4291 * returns NULL.
4292 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004293 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004294 *
4295 * @see #hasCategory
4296 * @see #addCategory
4297 */
4298 public Set<String> getCategories() {
4299 return mCategories;
4300 }
4301
4302 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004303 * Return the specific selector associated with this Intent. If there is
4304 * none, returns null. See {@link #setSelector} for more information.
4305 *
4306 * @see #setSelector
4307 */
4308 public Intent getSelector() {
4309 return mSelector;
4310 }
4311
4312 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004313 * Return the {@link ClipData} associated with this Intent. If there is
4314 * none, returns null. See {@link #setClipData} for more information.
4315 *
4316 * @see #setClipData;
4317 */
4318 public ClipData getClipData() {
4319 return mClipData;
4320 }
4321
4322 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004323 * Sets the ClassLoader that will be used when unmarshalling
4324 * any Parcelable values from the extras of this Intent.
4325 *
4326 * @param loader a ClassLoader, or null to use the default loader
4327 * at the time of unmarshalling.
4328 */
4329 public void setExtrasClassLoader(ClassLoader loader) {
4330 if (mExtras != null) {
4331 mExtras.setClassLoader(loader);
4332 }
4333 }
4334
4335 /**
4336 * Returns true if an extra value is associated with the given name.
4337 * @param name the extra's name
4338 * @return true if the given extra is present.
4339 */
4340 public boolean hasExtra(String name) {
4341 return mExtras != null && mExtras.containsKey(name);
4342 }
4343
4344 /**
4345 * Returns true if the Intent's extras contain a parcelled file descriptor.
4346 * @return true if the Intent contains a parcelled file descriptor.
4347 */
4348 public boolean hasFileDescriptors() {
4349 return mExtras != null && mExtras.hasFileDescriptors();
4350 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004351
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004352 /** @hide */
4353 public void setAllowFds(boolean allowFds) {
4354 if (mExtras != null) {
4355 mExtras.setAllowFds(allowFds);
4356 }
4357 }
4358
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004359 /**
4360 * Retrieve extended data from the intent.
4361 *
4362 * @param name The name of the desired item.
4363 *
4364 * @return the value of an item that previously added with putExtra()
4365 * or null if none was found.
4366 *
4367 * @deprecated
4368 * @hide
4369 */
4370 @Deprecated
4371 public Object getExtra(String name) {
4372 return getExtra(name, null);
4373 }
4374
4375 /**
4376 * Retrieve extended data from the intent.
4377 *
4378 * @param name The name of the desired item.
4379 * @param defaultValue the value to be returned if no value of the desired
4380 * type is stored with the given name.
4381 *
4382 * @return the value of an item that previously added with putExtra()
4383 * or the default value if none was found.
4384 *
4385 * @see #putExtra(String, boolean)
4386 */
4387 public boolean getBooleanExtra(String name, boolean defaultValue) {
4388 return mExtras == null ? defaultValue :
4389 mExtras.getBoolean(name, defaultValue);
4390 }
4391
4392 /**
4393 * Retrieve extended data from the intent.
4394 *
4395 * @param name The name of the desired item.
4396 * @param defaultValue the value to be returned if no value of the desired
4397 * type is stored with the given name.
4398 *
4399 * @return the value of an item that previously added with putExtra()
4400 * or the default value if none was found.
4401 *
4402 * @see #putExtra(String, byte)
4403 */
4404 public byte getByteExtra(String name, byte defaultValue) {
4405 return mExtras == null ? defaultValue :
4406 mExtras.getByte(name, defaultValue);
4407 }
4408
4409 /**
4410 * Retrieve extended data from the intent.
4411 *
4412 * @param name The name of the desired item.
4413 * @param defaultValue the value to be returned if no value of the desired
4414 * type is stored with the given name.
4415 *
4416 * @return the value of an item that previously added with putExtra()
4417 * or the default value if none was found.
4418 *
4419 * @see #putExtra(String, short)
4420 */
4421 public short getShortExtra(String name, short defaultValue) {
4422 return mExtras == null ? defaultValue :
4423 mExtras.getShort(name, defaultValue);
4424 }
4425
4426 /**
4427 * Retrieve extended data from the intent.
4428 *
4429 * @param name The name of the desired item.
4430 * @param defaultValue the value to be returned if no value of the desired
4431 * type is stored with the given name.
4432 *
4433 * @return the value of an item that previously added with putExtra()
4434 * or the default value if none was found.
4435 *
4436 * @see #putExtra(String, char)
4437 */
4438 public char getCharExtra(String name, char defaultValue) {
4439 return mExtras == null ? defaultValue :
4440 mExtras.getChar(name, defaultValue);
4441 }
4442
4443 /**
4444 * Retrieve extended data from the intent.
4445 *
4446 * @param name The name of the desired item.
4447 * @param defaultValue the value to be returned if no value of the desired
4448 * type is stored with the given name.
4449 *
4450 * @return the value of an item that previously added with putExtra()
4451 * or the default value if none was found.
4452 *
4453 * @see #putExtra(String, int)
4454 */
4455 public int getIntExtra(String name, int defaultValue) {
4456 return mExtras == null ? defaultValue :
4457 mExtras.getInt(name, defaultValue);
4458 }
4459
4460 /**
4461 * Retrieve extended data from the intent.
4462 *
4463 * @param name The name of the desired item.
4464 * @param defaultValue the value to be returned if no value of the desired
4465 * type is stored with the given name.
4466 *
4467 * @return the value of an item that previously added with putExtra()
4468 * or the default value if none was found.
4469 *
4470 * @see #putExtra(String, long)
4471 */
4472 public long getLongExtra(String name, long defaultValue) {
4473 return mExtras == null ? defaultValue :
4474 mExtras.getLong(name, defaultValue);
4475 }
4476
4477 /**
4478 * Retrieve extended data from the intent.
4479 *
4480 * @param name The name of the desired item.
4481 * @param defaultValue the value to be returned if no value of the desired
4482 * type is stored with the given name.
4483 *
4484 * @return the value of an item that previously added with putExtra(),
4485 * or the default value if no such item is present
4486 *
4487 * @see #putExtra(String, float)
4488 */
4489 public float getFloatExtra(String name, float defaultValue) {
4490 return mExtras == null ? defaultValue :
4491 mExtras.getFloat(name, defaultValue);
4492 }
4493
4494 /**
4495 * Retrieve extended data from the intent.
4496 *
4497 * @param name The name of the desired item.
4498 * @param defaultValue the value to be returned if no value of the desired
4499 * type is stored with the given name.
4500 *
4501 * @return the value of an item that previously added with putExtra()
4502 * or the default value if none was found.
4503 *
4504 * @see #putExtra(String, double)
4505 */
4506 public double getDoubleExtra(String name, double defaultValue) {
4507 return mExtras == null ? defaultValue :
4508 mExtras.getDouble(name, defaultValue);
4509 }
4510
4511 /**
4512 * Retrieve extended data from the intent.
4513 *
4514 * @param name The name of the desired item.
4515 *
4516 * @return the value of an item that previously added with putExtra()
4517 * or null if no String value was found.
4518 *
4519 * @see #putExtra(String, String)
4520 */
4521 public String getStringExtra(String name) {
4522 return mExtras == null ? null : mExtras.getString(name);
4523 }
4524
4525 /**
4526 * Retrieve extended data from the intent.
4527 *
4528 * @param name The name of the desired item.
4529 *
4530 * @return the value of an item that previously added with putExtra()
4531 * or null if no CharSequence value was found.
4532 *
4533 * @see #putExtra(String, CharSequence)
4534 */
4535 public CharSequence getCharSequenceExtra(String name) {
4536 return mExtras == null ? null : mExtras.getCharSequence(name);
4537 }
4538
4539 /**
4540 * Retrieve extended data from the intent.
4541 *
4542 * @param name The name of the desired item.
4543 *
4544 * @return the value of an item that previously added with putExtra()
4545 * or null if no Parcelable value was found.
4546 *
4547 * @see #putExtra(String, Parcelable)
4548 */
4549 public <T extends Parcelable> T getParcelableExtra(String name) {
4550 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4551 }
4552
4553 /**
4554 * Retrieve extended data from the intent.
4555 *
4556 * @param name The name of the desired item.
4557 *
4558 * @return the value of an item that previously added with putExtra()
4559 * or null if no Parcelable[] value was found.
4560 *
4561 * @see #putExtra(String, Parcelable[])
4562 */
4563 public Parcelable[] getParcelableArrayExtra(String name) {
4564 return mExtras == null ? null : mExtras.getParcelableArray(name);
4565 }
4566
4567 /**
4568 * Retrieve extended data from the intent.
4569 *
4570 * @param name The name of the desired item.
4571 *
4572 * @return the value of an item that previously added with putExtra()
4573 * or null if no ArrayList<Parcelable> value was found.
4574 *
4575 * @see #putParcelableArrayListExtra(String, ArrayList)
4576 */
4577 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4578 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4579 }
4580
4581 /**
4582 * Retrieve extended data from the intent.
4583 *
4584 * @param name The name of the desired item.
4585 *
4586 * @return the value of an item that previously added with putExtra()
4587 * or null if no Serializable value was found.
4588 *
4589 * @see #putExtra(String, Serializable)
4590 */
4591 public Serializable getSerializableExtra(String name) {
4592 return mExtras == null ? null : mExtras.getSerializable(name);
4593 }
4594
4595 /**
4596 * Retrieve extended data from the intent.
4597 *
4598 * @param name The name of the desired item.
4599 *
4600 * @return the value of an item that previously added with putExtra()
4601 * or null if no ArrayList<Integer> value was found.
4602 *
4603 * @see #putIntegerArrayListExtra(String, ArrayList)
4604 */
4605 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4606 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4607 }
4608
4609 /**
4610 * Retrieve extended data from the intent.
4611 *
4612 * @param name The name of the desired item.
4613 *
4614 * @return the value of an item that previously added with putExtra()
4615 * or null if no ArrayList<String> value was found.
4616 *
4617 * @see #putStringArrayListExtra(String, ArrayList)
4618 */
4619 public ArrayList<String> getStringArrayListExtra(String name) {
4620 return mExtras == null ? null : mExtras.getStringArrayList(name);
4621 }
4622
4623 /**
4624 * Retrieve extended data from the intent.
4625 *
4626 * @param name The name of the desired item.
4627 *
4628 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004629 * or null if no ArrayList<CharSequence> value was found.
4630 *
4631 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4632 */
4633 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4634 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4635 }
4636
4637 /**
4638 * Retrieve extended data from the intent.
4639 *
4640 * @param name The name of the desired item.
4641 *
4642 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004643 * or null if no boolean array value was found.
4644 *
4645 * @see #putExtra(String, boolean[])
4646 */
4647 public boolean[] getBooleanArrayExtra(String name) {
4648 return mExtras == null ? null : mExtras.getBooleanArray(name);
4649 }
4650
4651 /**
4652 * Retrieve extended data from the intent.
4653 *
4654 * @param name The name of the desired item.
4655 *
4656 * @return the value of an item that previously added with putExtra()
4657 * or null if no byte array value was found.
4658 *
4659 * @see #putExtra(String, byte[])
4660 */
4661 public byte[] getByteArrayExtra(String name) {
4662 return mExtras == null ? null : mExtras.getByteArray(name);
4663 }
4664
4665 /**
4666 * Retrieve extended data from the intent.
4667 *
4668 * @param name The name of the desired item.
4669 *
4670 * @return the value of an item that previously added with putExtra()
4671 * or null if no short array value was found.
4672 *
4673 * @see #putExtra(String, short[])
4674 */
4675 public short[] getShortArrayExtra(String name) {
4676 return mExtras == null ? null : mExtras.getShortArray(name);
4677 }
4678
4679 /**
4680 * Retrieve extended data from the intent.
4681 *
4682 * @param name The name of the desired item.
4683 *
4684 * @return the value of an item that previously added with putExtra()
4685 * or null if no char array value was found.
4686 *
4687 * @see #putExtra(String, char[])
4688 */
4689 public char[] getCharArrayExtra(String name) {
4690 return mExtras == null ? null : mExtras.getCharArray(name);
4691 }
4692
4693 /**
4694 * Retrieve extended data from the intent.
4695 *
4696 * @param name The name of the desired item.
4697 *
4698 * @return the value of an item that previously added with putExtra()
4699 * or null if no int array value was found.
4700 *
4701 * @see #putExtra(String, int[])
4702 */
4703 public int[] getIntArrayExtra(String name) {
4704 return mExtras == null ? null : mExtras.getIntArray(name);
4705 }
4706
4707 /**
4708 * Retrieve extended data from the intent.
4709 *
4710 * @param name The name of the desired item.
4711 *
4712 * @return the value of an item that previously added with putExtra()
4713 * or null if no long array value was found.
4714 *
4715 * @see #putExtra(String, long[])
4716 */
4717 public long[] getLongArrayExtra(String name) {
4718 return mExtras == null ? null : mExtras.getLongArray(name);
4719 }
4720
4721 /**
4722 * Retrieve extended data from the intent.
4723 *
4724 * @param name The name of the desired item.
4725 *
4726 * @return the value of an item that previously added with putExtra()
4727 * or null if no float array value was found.
4728 *
4729 * @see #putExtra(String, float[])
4730 */
4731 public float[] getFloatArrayExtra(String name) {
4732 return mExtras == null ? null : mExtras.getFloatArray(name);
4733 }
4734
4735 /**
4736 * Retrieve extended data from the intent.
4737 *
4738 * @param name The name of the desired item.
4739 *
4740 * @return the value of an item that previously added with putExtra()
4741 * or null if no double array value was found.
4742 *
4743 * @see #putExtra(String, double[])
4744 */
4745 public double[] getDoubleArrayExtra(String name) {
4746 return mExtras == null ? null : mExtras.getDoubleArray(name);
4747 }
4748
4749 /**
4750 * Retrieve extended data from the intent.
4751 *
4752 * @param name The name of the desired item.
4753 *
4754 * @return the value of an item that previously added with putExtra()
4755 * or null if no String array value was found.
4756 *
4757 * @see #putExtra(String, String[])
4758 */
4759 public String[] getStringArrayExtra(String name) {
4760 return mExtras == null ? null : mExtras.getStringArray(name);
4761 }
4762
4763 /**
4764 * Retrieve extended data from the intent.
4765 *
4766 * @param name The name of the desired item.
4767 *
4768 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004769 * or null if no CharSequence array value was found.
4770 *
4771 * @see #putExtra(String, CharSequence[])
4772 */
4773 public CharSequence[] getCharSequenceArrayExtra(String name) {
4774 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4775 }
4776
4777 /**
4778 * Retrieve extended data from the intent.
4779 *
4780 * @param name The name of the desired item.
4781 *
4782 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004783 * or null if no Bundle value was found.
4784 *
4785 * @see #putExtra(String, Bundle)
4786 */
4787 public Bundle getBundleExtra(String name) {
4788 return mExtras == null ? null : mExtras.getBundle(name);
4789 }
4790
4791 /**
4792 * Retrieve extended data from the intent.
4793 *
4794 * @param name The name of the desired item.
4795 *
4796 * @return the value of an item that previously added with putExtra()
4797 * or null if no IBinder value was found.
4798 *
4799 * @see #putExtra(String, IBinder)
4800 *
4801 * @deprecated
4802 * @hide
4803 */
4804 @Deprecated
4805 public IBinder getIBinderExtra(String name) {
4806 return mExtras == null ? null : mExtras.getIBinder(name);
4807 }
4808
4809 /**
4810 * Retrieve extended data from the intent.
4811 *
4812 * @param name The name of the desired item.
4813 * @param defaultValue The default value to return in case no item is
4814 * associated with the key 'name'
4815 *
4816 * @return the value of an item that previously added with putExtra()
4817 * or defaultValue if none was found.
4818 *
4819 * @see #putExtra
4820 *
4821 * @deprecated
4822 * @hide
4823 */
4824 @Deprecated
4825 public Object getExtra(String name, Object defaultValue) {
4826 Object result = defaultValue;
4827 if (mExtras != null) {
4828 Object result2 = mExtras.get(name);
4829 if (result2 != null) {
4830 result = result2;
4831 }
4832 }
4833
4834 return result;
4835 }
4836
4837 /**
4838 * Retrieves a map of extended data from the intent.
4839 *
4840 * @return the map of all extras previously added with putExtra(),
4841 * or null if none have been added.
4842 */
4843 public Bundle getExtras() {
4844 return (mExtras != null)
4845 ? new Bundle(mExtras)
4846 : null;
4847 }
4848
4849 /**
4850 * Retrieve any special flags associated with this intent. You will
4851 * normally just set them with {@link #setFlags} and let the system
4852 * take the appropriate action with them.
4853 *
4854 * @return int The currently set flags.
4855 *
4856 * @see #setFlags
4857 */
4858 public int getFlags() {
4859 return mFlags;
4860 }
4861
Dianne Hackborne7f97212011-02-24 14:40:20 -08004862 /** @hide */
4863 public boolean isExcludingStopped() {
4864 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4865 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4866 }
4867
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004868 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004869 * Retrieve the application package name this Intent is limited to. When
4870 * resolving an Intent, if non-null this limits the resolution to only
4871 * components in the given application package.
4872 *
4873 * @return The name of the application package for the Intent.
4874 *
4875 * @see #resolveActivity
4876 * @see #setPackage
4877 */
4878 public String getPackage() {
4879 return mPackage;
4880 }
4881
4882 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004883 * Retrieve the concrete component associated with the intent. When receiving
4884 * an intent, this is the component that was found to best handle it (that is,
4885 * yourself) and will always be non-null; in all other cases it will be
4886 * null unless explicitly set.
4887 *
4888 * @return The name of the application component to handle the intent.
4889 *
4890 * @see #resolveActivity
4891 * @see #setComponent
4892 */
4893 public ComponentName getComponent() {
4894 return mComponent;
4895 }
4896
4897 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004898 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4899 * used as a hint to the receiver for animations and the like. Null means that there
4900 * is no source bounds.
4901 */
4902 public Rect getSourceBounds() {
4903 return mSourceBounds;
4904 }
4905
4906 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004907 * Return the Activity component that should be used to handle this intent.
4908 * The appropriate component is determined based on the information in the
4909 * intent, evaluated as follows:
4910 *
4911 * <p>If {@link #getComponent} returns an explicit class, that is returned
4912 * without any further consideration.
4913 *
4914 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4915 * category to be considered.
4916 *
4917 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4918 * action.
4919 *
4920 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4921 * this type.
4922 *
4923 * <p>If {@link #addCategory} has added any categories, the activity must
4924 * handle ALL of the categories specified.
4925 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004926 * <p>If {@link #getPackage} is non-NULL, only activity components in
4927 * that application package will be considered.
4928 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004929 * <p>If there are no activities that satisfy all of these conditions, a
4930 * null string is returned.
4931 *
4932 * <p>If multiple activities are found to satisfy the intent, the one with
4933 * the highest priority will be used. If there are multiple activities
4934 * with the same priority, the system will either pick the best activity
4935 * based on user preference, or resolve to a system class that will allow
4936 * the user to pick an activity and forward from there.
4937 *
4938 * <p>This method is implemented simply by calling
4939 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4940 * true.</p>
4941 * <p> This API is called for you as part of starting an activity from an
4942 * intent. You do not normally need to call it yourself.</p>
4943 *
4944 * @param pm The package manager with which to resolve the Intent.
4945 *
4946 * @return Name of the component implementing an activity that can
4947 * display the intent.
4948 *
4949 * @see #setComponent
4950 * @see #getComponent
4951 * @see #resolveActivityInfo
4952 */
4953 public ComponentName resolveActivity(PackageManager pm) {
4954 if (mComponent != null) {
4955 return mComponent;
4956 }
4957
4958 ResolveInfo info = pm.resolveActivity(
4959 this, PackageManager.MATCH_DEFAULT_ONLY);
4960 if (info != null) {
4961 return new ComponentName(
4962 info.activityInfo.applicationInfo.packageName,
4963 info.activityInfo.name);
4964 }
4965
4966 return null;
4967 }
4968
4969 /**
4970 * Resolve the Intent into an {@link ActivityInfo}
4971 * describing the activity that should execute the intent. Resolution
4972 * follows the same rules as described for {@link #resolveActivity}, but
4973 * you get back the completely information about the resolved activity
4974 * instead of just its class name.
4975 *
4976 * @param pm The package manager with which to resolve the Intent.
4977 * @param flags Addition information to retrieve as per
4978 * {@link PackageManager#getActivityInfo(ComponentName, int)
4979 * PackageManager.getActivityInfo()}.
4980 *
4981 * @return PackageManager.ActivityInfo
4982 *
4983 * @see #resolveActivity
4984 */
4985 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4986 ActivityInfo ai = null;
4987 if (mComponent != null) {
4988 try {
4989 ai = pm.getActivityInfo(mComponent, flags);
4990 } catch (PackageManager.NameNotFoundException e) {
4991 // ignore
4992 }
4993 } else {
4994 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004995 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004996 if (info != null) {
4997 ai = info.activityInfo;
4998 }
4999 }
5000
5001 return ai;
5002 }
5003
5004 /**
5005 * Set the general action to be performed.
5006 *
5007 * @param action An action name, such as ACTION_VIEW. Application-specific
5008 * actions should be prefixed with the vendor's package name.
5009 *
5010 * @return Returns the same Intent object, for chaining multiple calls
5011 * into a single statement.
5012 *
5013 * @see #getAction
5014 */
5015 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08005016 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005017 return this;
5018 }
5019
5020 /**
5021 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08005022 * clears any type that was previously set by {@link #setType} or
5023 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005024 *
Nick Pellyccae4122012-01-09 14:12:58 -08005025 * <p><em>Note: scheme matching in the Android framework is
5026 * case-sensitive, unlike the formal RFC. As a result,
5027 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005028 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005029 * {@link #setDataAndNormalize}
5030 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005031 *
Nick Pellyccae4122012-01-09 14:12:58 -08005032 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005033 *
5034 * @return Returns the same Intent object, for chaining multiple calls
5035 * into a single statement.
5036 *
5037 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08005038 * @see #setDataAndNormalize
5039 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005040 */
5041 public Intent setData(Uri data) {
5042 mData = data;
5043 mType = null;
5044 return this;
5045 }
5046
5047 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005048 * Normalize and set the data this intent is operating on.
5049 *
5050 * <p>This method automatically clears any type that was
5051 * previously set (for example, by {@link #setType}).
5052 *
5053 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005054 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08005055 * so really this is just a convenience method for
5056 * <pre>
5057 * setData(data.normalize())
5058 * </pre>
5059 *
5060 * @param data The Uri of the data this intent is now targeting.
5061 *
5062 * @return Returns the same Intent object, for chaining multiple calls
5063 * into a single statement.
5064 *
5065 * @see #getData
5066 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005067 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005068 */
5069 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005070 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08005071 }
5072
5073 /**
5074 * Set an explicit MIME data type.
5075 *
5076 * <p>This is used to create intents that only specify a type and not data,
5077 * for example to indicate the type of data to return.
5078 *
5079 * <p>This method automatically clears any data that was
5080 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07005081 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005082 * <p><em>Note: MIME type matching in the Android framework is
5083 * case-sensitive, unlike formal RFC MIME types. As a result,
5084 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08005085 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
5086 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005087 *
5088 * @param type The MIME type of the data being handled by this intent.
5089 *
5090 * @return Returns the same Intent object, for chaining multiple calls
5091 * into a single statement.
5092 *
5093 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08005094 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005095 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08005096 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005097 */
5098 public Intent setType(String type) {
5099 mData = null;
5100 mType = type;
5101 return this;
5102 }
5103
5104 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005105 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005106 *
Nick Pellyccae4122012-01-09 14:12:58 -08005107 * <p>This is used to create intents that only specify a type and not data,
5108 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005109 *
Nick Pellyccae4122012-01-09 14:12:58 -08005110 * <p>This method automatically clears any data that was
5111 * previously set (for example by {@link #setData}).
5112 *
5113 * <p>The MIME type is normalized using
5114 * {@link #normalizeMimeType} before it is set,
5115 * so really this is just a convenience method for
5116 * <pre>
5117 * setType(Intent.normalizeMimeType(type))
5118 * </pre>
5119 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005120 * @param type The MIME type of the data being handled by this intent.
5121 *
5122 * @return Returns the same Intent object, for chaining multiple calls
5123 * into a single statement.
5124 *
Nick Pellyccae4122012-01-09 14:12:58 -08005125 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005126 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005127 * @see #normalizeMimeType
5128 */
5129 public Intent setTypeAndNormalize(String type) {
5130 return setType(normalizeMimeType(type));
5131 }
5132
5133 /**
5134 * (Usually optional) Set the data for the intent along with an explicit
5135 * MIME data type. This method should very rarely be used -- it allows you
5136 * to override the MIME type that would ordinarily be inferred from the
5137 * data with your own type given here.
5138 *
5139 * <p><em>Note: MIME type and Uri scheme matching in the
5140 * Android framework is case-sensitive, unlike the formal RFC definitions.
5141 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005142 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005143 * {@link #setDataAndTypeAndNormalize}
5144 * to ensure that they are converted to lower case.</em>
5145 *
5146 * @param data The Uri of the data this intent is now targeting.
5147 * @param type The MIME type of the data being handled by this intent.
5148 *
5149 * @return Returns the same Intent object, for chaining multiple calls
5150 * into a single statement.
5151 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005152 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005153 * @see #setData
5154 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005155 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005156 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005157 */
5158 public Intent setDataAndType(Uri data, String type) {
5159 mData = data;
5160 mType = type;
5161 return this;
5162 }
5163
5164 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005165 * (Usually optional) Normalize and set both the data Uri and an explicit
5166 * MIME data type. This method should very rarely be used -- it allows you
5167 * to override the MIME type that would ordinarily be inferred from the
5168 * data with your own type given here.
5169 *
5170 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005171 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005172 * before they are set, so really this is just a convenience method for
5173 * <pre>
5174 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5175 * </pre>
5176 *
5177 * @param data The Uri of the data this intent is now targeting.
5178 * @param type The MIME type of the data being handled by this intent.
5179 *
5180 * @return Returns the same Intent object, for chaining multiple calls
5181 * into a single statement.
5182 *
5183 * @see #setType
5184 * @see #setData
5185 * @see #setDataAndType
5186 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005187 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005188 */
5189 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005190 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005191 }
5192
5193 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005194 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005195 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005196 * activities that provide <em>all</em> of the requested categories will be
5197 * used.
5198 *
5199 * @param category The desired category. This can be either one of the
5200 * predefined Intent categories, or a custom category in your own
5201 * namespace.
5202 *
5203 * @return Returns the same Intent object, for chaining multiple calls
5204 * into a single statement.
5205 *
5206 * @see #hasCategory
5207 * @see #removeCategory
5208 */
5209 public Intent addCategory(String category) {
5210 if (mCategories == null) {
5211 mCategories = new HashSet<String>();
5212 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005213 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005214 return this;
5215 }
5216
5217 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005218 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005219 *
5220 * @param category The category to remove.
5221 *
5222 * @see #addCategory
5223 */
5224 public void removeCategory(String category) {
5225 if (mCategories != null) {
5226 mCategories.remove(category);
5227 if (mCategories.size() == 0) {
5228 mCategories = null;
5229 }
5230 }
5231 }
5232
5233 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005234 * Set a selector for this Intent. This is a modification to the kinds of
5235 * things the Intent will match. If the selector is set, it will be used
5236 * when trying to find entities that can handle the Intent, instead of the
5237 * main contents of the Intent. This allows you build an Intent containing
5238 * a generic protocol while targeting it more specifically.
5239 *
5240 * <p>An example of where this may be used is with things like
5241 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5242 * Intent that will launch the Browser application. However, the correct
5243 * main entry point of an application is actually {@link #ACTION_MAIN}
5244 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5245 * used to specify the actual Activity to launch. If you launch the browser
5246 * with something different, undesired behavior may happen if the user has
5247 * previously or later launches it the normal way, since they do not match.
5248 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5249 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5250 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5251 *
5252 * <p>Setting a selector does not impact the behavior of
5253 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5254 * desired behavior of a selector -- it does not impact the base meaning
5255 * of the Intent, just what kinds of things will be matched against it
5256 * when determining who can handle it.</p>
5257 *
5258 * <p>You can not use both a selector and {@link #setPackage(String)} on
5259 * the same base Intent.</p>
5260 *
5261 * @param selector The desired selector Intent; set to null to not use
5262 * a special selector.
5263 */
5264 public void setSelector(Intent selector) {
5265 if (selector == this) {
5266 throw new IllegalArgumentException(
5267 "Intent being set as a selector of itself");
5268 }
5269 if (selector != null && mPackage != null) {
5270 throw new IllegalArgumentException(
5271 "Can't set selector when package name is already set");
5272 }
5273 mSelector = selector;
5274 }
5275
5276 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005277 * Set a {@link ClipData} associated with this Intent. This replaces any
5278 * previously set ClipData.
5279 *
5280 * <p>The ClipData in an intent is not used for Intent matching or other
5281 * such operations. Semantically it is like extras, used to transmit
5282 * additional data with the Intent. The main feature of using this over
5283 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5284 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5285 * items included in the clip data. This is useful, in particular, if
5286 * you want to transmit an Intent containing multiple <code>content:</code>
5287 * URIs for which the recipient may not have global permission to access the
5288 * content provider.
5289 *
5290 * <p>If the ClipData contains items that are themselves Intents, any
5291 * grant flags in those Intents will be ignored. Only the top-level flags
5292 * of the main Intent are respected, and will be applied to all Uri or
5293 * Intent items in the clip (or sub-items of the clip).
5294 *
5295 * <p>The MIME type, label, and icon in the ClipData object are not
5296 * directly used by Intent. Applications should generally rely on the
5297 * MIME type of the Intent itself, not what it may find in the ClipData.
5298 * A common practice is to construct a ClipData for use with an Intent
5299 * with a MIME type of "*\/*".
5300 *
5301 * @param clip The new clip to set. May be null to clear the current clip.
5302 */
5303 public void setClipData(ClipData clip) {
5304 mClipData = clip;
5305 }
5306
5307 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005308 * Add extended data to the intent. The name must include a package
5309 * prefix, for example the app com.android.contacts would use names
5310 * like "com.android.contacts.ShowAll".
5311 *
5312 * @param name The name of the extra data, with package prefix.
5313 * @param value The boolean data value.
5314 *
5315 * @return Returns the same Intent object, for chaining multiple calls
5316 * into a single statement.
5317 *
5318 * @see #putExtras
5319 * @see #removeExtra
5320 * @see #getBooleanExtra(String, boolean)
5321 */
5322 public Intent putExtra(String name, boolean value) {
5323 if (mExtras == null) {
5324 mExtras = new Bundle();
5325 }
5326 mExtras.putBoolean(name, value);
5327 return this;
5328 }
5329
5330 /**
5331 * Add extended data to the intent. The name must include a package
5332 * prefix, for example the app com.android.contacts would use names
5333 * like "com.android.contacts.ShowAll".
5334 *
5335 * @param name The name of the extra data, with package prefix.
5336 * @param value The byte data value.
5337 *
5338 * @return Returns the same Intent object, for chaining multiple calls
5339 * into a single statement.
5340 *
5341 * @see #putExtras
5342 * @see #removeExtra
5343 * @see #getByteExtra(String, byte)
5344 */
5345 public Intent putExtra(String name, byte value) {
5346 if (mExtras == null) {
5347 mExtras = new Bundle();
5348 }
5349 mExtras.putByte(name, value);
5350 return this;
5351 }
5352
5353 /**
5354 * Add extended data to the intent. The name must include a package
5355 * prefix, for example the app com.android.contacts would use names
5356 * like "com.android.contacts.ShowAll".
5357 *
5358 * @param name The name of the extra data, with package prefix.
5359 * @param value The char data value.
5360 *
5361 * @return Returns the same Intent object, for chaining multiple calls
5362 * into a single statement.
5363 *
5364 * @see #putExtras
5365 * @see #removeExtra
5366 * @see #getCharExtra(String, char)
5367 */
5368 public Intent putExtra(String name, char value) {
5369 if (mExtras == null) {
5370 mExtras = new Bundle();
5371 }
5372 mExtras.putChar(name, value);
5373 return this;
5374 }
5375
5376 /**
5377 * Add extended data to the intent. The name must include a package
5378 * prefix, for example the app com.android.contacts would use names
5379 * like "com.android.contacts.ShowAll".
5380 *
5381 * @param name The name of the extra data, with package prefix.
5382 * @param value The short data value.
5383 *
5384 * @return Returns the same Intent object, for chaining multiple calls
5385 * into a single statement.
5386 *
5387 * @see #putExtras
5388 * @see #removeExtra
5389 * @see #getShortExtra(String, short)
5390 */
5391 public Intent putExtra(String name, short value) {
5392 if (mExtras == null) {
5393 mExtras = new Bundle();
5394 }
5395 mExtras.putShort(name, value);
5396 return this;
5397 }
5398
5399 /**
5400 * Add extended data to the intent. The name must include a package
5401 * prefix, for example the app com.android.contacts would use names
5402 * like "com.android.contacts.ShowAll".
5403 *
5404 * @param name The name of the extra data, with package prefix.
5405 * @param value The integer data value.
5406 *
5407 * @return Returns the same Intent object, for chaining multiple calls
5408 * into a single statement.
5409 *
5410 * @see #putExtras
5411 * @see #removeExtra
5412 * @see #getIntExtra(String, int)
5413 */
5414 public Intent putExtra(String name, int value) {
5415 if (mExtras == null) {
5416 mExtras = new Bundle();
5417 }
5418 mExtras.putInt(name, value);
5419 return this;
5420 }
5421
5422 /**
5423 * Add extended data to the intent. The name must include a package
5424 * prefix, for example the app com.android.contacts would use names
5425 * like "com.android.contacts.ShowAll".
5426 *
5427 * @param name The name of the extra data, with package prefix.
5428 * @param value The long data value.
5429 *
5430 * @return Returns the same Intent object, for chaining multiple calls
5431 * into a single statement.
5432 *
5433 * @see #putExtras
5434 * @see #removeExtra
5435 * @see #getLongExtra(String, long)
5436 */
5437 public Intent putExtra(String name, long value) {
5438 if (mExtras == null) {
5439 mExtras = new Bundle();
5440 }
5441 mExtras.putLong(name, value);
5442 return this;
5443 }
5444
5445 /**
5446 * Add extended data to the intent. The name must include a package
5447 * prefix, for example the app com.android.contacts would use names
5448 * like "com.android.contacts.ShowAll".
5449 *
5450 * @param name The name of the extra data, with package prefix.
5451 * @param value The float data value.
5452 *
5453 * @return Returns the same Intent object, for chaining multiple calls
5454 * into a single statement.
5455 *
5456 * @see #putExtras
5457 * @see #removeExtra
5458 * @see #getFloatExtra(String, float)
5459 */
5460 public Intent putExtra(String name, float value) {
5461 if (mExtras == null) {
5462 mExtras = new Bundle();
5463 }
5464 mExtras.putFloat(name, value);
5465 return this;
5466 }
5467
5468 /**
5469 * Add extended data to the intent. The name must include a package
5470 * prefix, for example the app com.android.contacts would use names
5471 * like "com.android.contacts.ShowAll".
5472 *
5473 * @param name The name of the extra data, with package prefix.
5474 * @param value The double data value.
5475 *
5476 * @return Returns the same Intent object, for chaining multiple calls
5477 * into a single statement.
5478 *
5479 * @see #putExtras
5480 * @see #removeExtra
5481 * @see #getDoubleExtra(String, double)
5482 */
5483 public Intent putExtra(String name, double value) {
5484 if (mExtras == null) {
5485 mExtras = new Bundle();
5486 }
5487 mExtras.putDouble(name, value);
5488 return this;
5489 }
5490
5491 /**
5492 * Add extended data to the intent. The name must include a package
5493 * prefix, for example the app com.android.contacts would use names
5494 * like "com.android.contacts.ShowAll".
5495 *
5496 * @param name The name of the extra data, with package prefix.
5497 * @param value The String data value.
5498 *
5499 * @return Returns the same Intent object, for chaining multiple calls
5500 * into a single statement.
5501 *
5502 * @see #putExtras
5503 * @see #removeExtra
5504 * @see #getStringExtra(String)
5505 */
5506 public Intent putExtra(String name, String value) {
5507 if (mExtras == null) {
5508 mExtras = new Bundle();
5509 }
5510 mExtras.putString(name, value);
5511 return this;
5512 }
5513
5514 /**
5515 * Add extended data to the intent. The name must include a package
5516 * prefix, for example the app com.android.contacts would use names
5517 * like "com.android.contacts.ShowAll".
5518 *
5519 * @param name The name of the extra data, with package prefix.
5520 * @param value The CharSequence data value.
5521 *
5522 * @return Returns the same Intent object, for chaining multiple calls
5523 * into a single statement.
5524 *
5525 * @see #putExtras
5526 * @see #removeExtra
5527 * @see #getCharSequenceExtra(String)
5528 */
5529 public Intent putExtra(String name, CharSequence value) {
5530 if (mExtras == null) {
5531 mExtras = new Bundle();
5532 }
5533 mExtras.putCharSequence(name, value);
5534 return this;
5535 }
5536
5537 /**
5538 * Add extended data to the intent. The name must include a package
5539 * prefix, for example the app com.android.contacts would use names
5540 * like "com.android.contacts.ShowAll".
5541 *
5542 * @param name The name of the extra data, with package prefix.
5543 * @param value The Parcelable data value.
5544 *
5545 * @return Returns the same Intent object, for chaining multiple calls
5546 * into a single statement.
5547 *
5548 * @see #putExtras
5549 * @see #removeExtra
5550 * @see #getParcelableExtra(String)
5551 */
5552 public Intent putExtra(String name, Parcelable value) {
5553 if (mExtras == null) {
5554 mExtras = new Bundle();
5555 }
5556 mExtras.putParcelable(name, value);
5557 return this;
5558 }
5559
5560 /**
5561 * Add extended data to the intent. The name must include a package
5562 * prefix, for example the app com.android.contacts would use names
5563 * like "com.android.contacts.ShowAll".
5564 *
5565 * @param name The name of the extra data, with package prefix.
5566 * @param value The Parcelable[] data value.
5567 *
5568 * @return Returns the same Intent object, for chaining multiple calls
5569 * into a single statement.
5570 *
5571 * @see #putExtras
5572 * @see #removeExtra
5573 * @see #getParcelableArrayExtra(String)
5574 */
5575 public Intent putExtra(String name, Parcelable[] value) {
5576 if (mExtras == null) {
5577 mExtras = new Bundle();
5578 }
5579 mExtras.putParcelableArray(name, value);
5580 return this;
5581 }
5582
5583 /**
5584 * Add extended data to the intent. The name must include a package
5585 * prefix, for example the app com.android.contacts would use names
5586 * like "com.android.contacts.ShowAll".
5587 *
5588 * @param name The name of the extra data, with package prefix.
5589 * @param value The ArrayList<Parcelable> data value.
5590 *
5591 * @return Returns the same Intent object, for chaining multiple calls
5592 * into a single statement.
5593 *
5594 * @see #putExtras
5595 * @see #removeExtra
5596 * @see #getParcelableArrayListExtra(String)
5597 */
5598 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5599 if (mExtras == null) {
5600 mExtras = new Bundle();
5601 }
5602 mExtras.putParcelableArrayList(name, value);
5603 return this;
5604 }
5605
5606 /**
5607 * Add extended data to the intent. The name must include a package
5608 * prefix, for example the app com.android.contacts would use names
5609 * like "com.android.contacts.ShowAll".
5610 *
5611 * @param name The name of the extra data, with package prefix.
5612 * @param value The ArrayList<Integer> data value.
5613 *
5614 * @return Returns the same Intent object, for chaining multiple calls
5615 * into a single statement.
5616 *
5617 * @see #putExtras
5618 * @see #removeExtra
5619 * @see #getIntegerArrayListExtra(String)
5620 */
5621 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5622 if (mExtras == null) {
5623 mExtras = new Bundle();
5624 }
5625 mExtras.putIntegerArrayList(name, value);
5626 return this;
5627 }
5628
5629 /**
5630 * Add extended data to the intent. The name must include a package
5631 * prefix, for example the app com.android.contacts would use names
5632 * like "com.android.contacts.ShowAll".
5633 *
5634 * @param name The name of the extra data, with package prefix.
5635 * @param value The ArrayList<String> data value.
5636 *
5637 * @return Returns the same Intent object, for chaining multiple calls
5638 * into a single statement.
5639 *
5640 * @see #putExtras
5641 * @see #removeExtra
5642 * @see #getStringArrayListExtra(String)
5643 */
5644 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5645 if (mExtras == null) {
5646 mExtras = new Bundle();
5647 }
5648 mExtras.putStringArrayList(name, value);
5649 return this;
5650 }
5651
5652 /**
5653 * Add extended data to the intent. The name must include a package
5654 * prefix, for example the app com.android.contacts would use names
5655 * like "com.android.contacts.ShowAll".
5656 *
5657 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005658 * @param value The ArrayList<CharSequence> data value.
5659 *
5660 * @return Returns the same Intent object, for chaining multiple calls
5661 * into a single statement.
5662 *
5663 * @see #putExtras
5664 * @see #removeExtra
5665 * @see #getCharSequenceArrayListExtra(String)
5666 */
5667 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5668 if (mExtras == null) {
5669 mExtras = new Bundle();
5670 }
5671 mExtras.putCharSequenceArrayList(name, value);
5672 return this;
5673 }
5674
5675 /**
5676 * Add extended data to the intent. The name must include a package
5677 * prefix, for example the app com.android.contacts would use names
5678 * like "com.android.contacts.ShowAll".
5679 *
5680 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005681 * @param value The Serializable data value.
5682 *
5683 * @return Returns the same Intent object, for chaining multiple calls
5684 * into a single statement.
5685 *
5686 * @see #putExtras
5687 * @see #removeExtra
5688 * @see #getSerializableExtra(String)
5689 */
5690 public Intent putExtra(String name, Serializable value) {
5691 if (mExtras == null) {
5692 mExtras = new Bundle();
5693 }
5694 mExtras.putSerializable(name, value);
5695 return this;
5696 }
5697
5698 /**
5699 * Add extended data to the intent. The name must include a package
5700 * prefix, for example the app com.android.contacts would use names
5701 * like "com.android.contacts.ShowAll".
5702 *
5703 * @param name The name of the extra data, with package prefix.
5704 * @param value The boolean array data value.
5705 *
5706 * @return Returns the same Intent object, for chaining multiple calls
5707 * into a single statement.
5708 *
5709 * @see #putExtras
5710 * @see #removeExtra
5711 * @see #getBooleanArrayExtra(String)
5712 */
5713 public Intent putExtra(String name, boolean[] value) {
5714 if (mExtras == null) {
5715 mExtras = new Bundle();
5716 }
5717 mExtras.putBooleanArray(name, value);
5718 return this;
5719 }
5720
5721 /**
5722 * Add extended data to the intent. The name must include a package
5723 * prefix, for example the app com.android.contacts would use names
5724 * like "com.android.contacts.ShowAll".
5725 *
5726 * @param name The name of the extra data, with package prefix.
5727 * @param value The byte array data value.
5728 *
5729 * @return Returns the same Intent object, for chaining multiple calls
5730 * into a single statement.
5731 *
5732 * @see #putExtras
5733 * @see #removeExtra
5734 * @see #getByteArrayExtra(String)
5735 */
5736 public Intent putExtra(String name, byte[] value) {
5737 if (mExtras == null) {
5738 mExtras = new Bundle();
5739 }
5740 mExtras.putByteArray(name, value);
5741 return this;
5742 }
5743
5744 /**
5745 * Add extended data to the intent. The name must include a package
5746 * prefix, for example the app com.android.contacts would use names
5747 * like "com.android.contacts.ShowAll".
5748 *
5749 * @param name The name of the extra data, with package prefix.
5750 * @param value The short array data value.
5751 *
5752 * @return Returns the same Intent object, for chaining multiple calls
5753 * into a single statement.
5754 *
5755 * @see #putExtras
5756 * @see #removeExtra
5757 * @see #getShortArrayExtra(String)
5758 */
5759 public Intent putExtra(String name, short[] value) {
5760 if (mExtras == null) {
5761 mExtras = new Bundle();
5762 }
5763 mExtras.putShortArray(name, value);
5764 return this;
5765 }
5766
5767 /**
5768 * Add extended data to the intent. The name must include a package
5769 * prefix, for example the app com.android.contacts would use names
5770 * like "com.android.contacts.ShowAll".
5771 *
5772 * @param name The name of the extra data, with package prefix.
5773 * @param value The char array data value.
5774 *
5775 * @return Returns the same Intent object, for chaining multiple calls
5776 * into a single statement.
5777 *
5778 * @see #putExtras
5779 * @see #removeExtra
5780 * @see #getCharArrayExtra(String)
5781 */
5782 public Intent putExtra(String name, char[] value) {
5783 if (mExtras == null) {
5784 mExtras = new Bundle();
5785 }
5786 mExtras.putCharArray(name, value);
5787 return this;
5788 }
5789
5790 /**
5791 * Add extended data to the intent. The name must include a package
5792 * prefix, for example the app com.android.contacts would use names
5793 * like "com.android.contacts.ShowAll".
5794 *
5795 * @param name The name of the extra data, with package prefix.
5796 * @param value The int array data value.
5797 *
5798 * @return Returns the same Intent object, for chaining multiple calls
5799 * into a single statement.
5800 *
5801 * @see #putExtras
5802 * @see #removeExtra
5803 * @see #getIntArrayExtra(String)
5804 */
5805 public Intent putExtra(String name, int[] value) {
5806 if (mExtras == null) {
5807 mExtras = new Bundle();
5808 }
5809 mExtras.putIntArray(name, value);
5810 return this;
5811 }
5812
5813 /**
5814 * Add extended data to the intent. The name must include a package
5815 * prefix, for example the app com.android.contacts would use names
5816 * like "com.android.contacts.ShowAll".
5817 *
5818 * @param name The name of the extra data, with package prefix.
5819 * @param value The byte array data value.
5820 *
5821 * @return Returns the same Intent object, for chaining multiple calls
5822 * into a single statement.
5823 *
5824 * @see #putExtras
5825 * @see #removeExtra
5826 * @see #getLongArrayExtra(String)
5827 */
5828 public Intent putExtra(String name, long[] value) {
5829 if (mExtras == null) {
5830 mExtras = new Bundle();
5831 }
5832 mExtras.putLongArray(name, value);
5833 return this;
5834 }
5835
5836 /**
5837 * Add extended data to the intent. The name must include a package
5838 * prefix, for example the app com.android.contacts would use names
5839 * like "com.android.contacts.ShowAll".
5840 *
5841 * @param name The name of the extra data, with package prefix.
5842 * @param value The float array data value.
5843 *
5844 * @return Returns the same Intent object, for chaining multiple calls
5845 * into a single statement.
5846 *
5847 * @see #putExtras
5848 * @see #removeExtra
5849 * @see #getFloatArrayExtra(String)
5850 */
5851 public Intent putExtra(String name, float[] value) {
5852 if (mExtras == null) {
5853 mExtras = new Bundle();
5854 }
5855 mExtras.putFloatArray(name, value);
5856 return this;
5857 }
5858
5859 /**
5860 * Add extended data to the intent. The name must include a package
5861 * prefix, for example the app com.android.contacts would use names
5862 * like "com.android.contacts.ShowAll".
5863 *
5864 * @param name The name of the extra data, with package prefix.
5865 * @param value The double array data value.
5866 *
5867 * @return Returns the same Intent object, for chaining multiple calls
5868 * into a single statement.
5869 *
5870 * @see #putExtras
5871 * @see #removeExtra
5872 * @see #getDoubleArrayExtra(String)
5873 */
5874 public Intent putExtra(String name, double[] value) {
5875 if (mExtras == null) {
5876 mExtras = new Bundle();
5877 }
5878 mExtras.putDoubleArray(name, value);
5879 return this;
5880 }
5881
5882 /**
5883 * Add extended data to the intent. The name must include a package
5884 * prefix, for example the app com.android.contacts would use names
5885 * like "com.android.contacts.ShowAll".
5886 *
5887 * @param name The name of the extra data, with package prefix.
5888 * @param value The String array data value.
5889 *
5890 * @return Returns the same Intent object, for chaining multiple calls
5891 * into a single statement.
5892 *
5893 * @see #putExtras
5894 * @see #removeExtra
5895 * @see #getStringArrayExtra(String)
5896 */
5897 public Intent putExtra(String name, String[] value) {
5898 if (mExtras == null) {
5899 mExtras = new Bundle();
5900 }
5901 mExtras.putStringArray(name, value);
5902 return this;
5903 }
5904
5905 /**
5906 * Add extended data to the intent. The name must include a package
5907 * prefix, for example the app com.android.contacts would use names
5908 * like "com.android.contacts.ShowAll".
5909 *
5910 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005911 * @param value The CharSequence array data value.
5912 *
5913 * @return Returns the same Intent object, for chaining multiple calls
5914 * into a single statement.
5915 *
5916 * @see #putExtras
5917 * @see #removeExtra
5918 * @see #getCharSequenceArrayExtra(String)
5919 */
5920 public Intent putExtra(String name, CharSequence[] value) {
5921 if (mExtras == null) {
5922 mExtras = new Bundle();
5923 }
5924 mExtras.putCharSequenceArray(name, value);
5925 return this;
5926 }
5927
5928 /**
5929 * Add extended data to the intent. The name must include a package
5930 * prefix, for example the app com.android.contacts would use names
5931 * like "com.android.contacts.ShowAll".
5932 *
5933 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005934 * @param value The Bundle data value.
5935 *
5936 * @return Returns the same Intent object, for chaining multiple calls
5937 * into a single statement.
5938 *
5939 * @see #putExtras
5940 * @see #removeExtra
5941 * @see #getBundleExtra(String)
5942 */
5943 public Intent putExtra(String name, Bundle value) {
5944 if (mExtras == null) {
5945 mExtras = new Bundle();
5946 }
5947 mExtras.putBundle(name, value);
5948 return this;
5949 }
5950
5951 /**
5952 * Add extended data to the intent. The name must include a package
5953 * prefix, for example the app com.android.contacts would use names
5954 * like "com.android.contacts.ShowAll".
5955 *
5956 * @param name The name of the extra data, with package prefix.
5957 * @param value The IBinder data value.
5958 *
5959 * @return Returns the same Intent object, for chaining multiple calls
5960 * into a single statement.
5961 *
5962 * @see #putExtras
5963 * @see #removeExtra
5964 * @see #getIBinderExtra(String)
5965 *
5966 * @deprecated
5967 * @hide
5968 */
5969 @Deprecated
5970 public Intent putExtra(String name, IBinder value) {
5971 if (mExtras == null) {
5972 mExtras = new Bundle();
5973 }
5974 mExtras.putIBinder(name, value);
5975 return this;
5976 }
5977
5978 /**
5979 * Copy all extras in 'src' in to this intent.
5980 *
5981 * @param src Contains the extras to copy.
5982 *
5983 * @see #putExtra
5984 */
5985 public Intent putExtras(Intent src) {
5986 if (src.mExtras != null) {
5987 if (mExtras == null) {
5988 mExtras = new Bundle(src.mExtras);
5989 } else {
5990 mExtras.putAll(src.mExtras);
5991 }
5992 }
5993 return this;
5994 }
5995
5996 /**
5997 * Add a set of extended data to the intent. The keys must include a package
5998 * prefix, for example the app com.android.contacts would use names
5999 * like "com.android.contacts.ShowAll".
6000 *
6001 * @param extras The Bundle of extras to add to this intent.
6002 *
6003 * @see #putExtra
6004 * @see #removeExtra
6005 */
6006 public Intent putExtras(Bundle extras) {
6007 if (mExtras == null) {
6008 mExtras = new Bundle();
6009 }
6010 mExtras.putAll(extras);
6011 return this;
6012 }
6013
6014 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006015 * Completely replace the extras in the Intent with the extras in the
6016 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07006017 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006018 * @param src The exact extras contained in this Intent are copied
6019 * into the target intent, replacing any that were previously there.
6020 */
6021 public Intent replaceExtras(Intent src) {
6022 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
6023 return this;
6024 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006025
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006026 /**
6027 * Completely replace the extras in the Intent with the given Bundle of
6028 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07006029 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006030 * @param extras The new set of extras in the Intent, or null to erase
6031 * all extras.
6032 */
6033 public Intent replaceExtras(Bundle extras) {
6034 mExtras = extras != null ? new Bundle(extras) : null;
6035 return this;
6036 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006037
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006038 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006039 * Remove extended data from the intent.
6040 *
6041 * @see #putExtra
6042 */
6043 public void removeExtra(String name) {
6044 if (mExtras != null) {
6045 mExtras.remove(name);
6046 if (mExtras.size() == 0) {
6047 mExtras = null;
6048 }
6049 }
6050 }
6051
6052 /**
6053 * Set special flags controlling how this intent is handled. Most values
6054 * here depend on the type of component being executed by the Intent,
6055 * specifically the FLAG_ACTIVITY_* flags are all for use with
6056 * {@link Context#startActivity Context.startActivity()} and the
6057 * FLAG_RECEIVER_* flags are all for use with
6058 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
6059 *
Scott Main7aee61f2011-02-08 11:25:01 -08006060 * <p>See the
6061 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
6062 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006063 * the behavior of your application.
6064 *
6065 * @param flags The desired flags.
6066 *
6067 * @return Returns the same Intent object, for chaining multiple calls
6068 * into a single statement.
6069 *
6070 * @see #getFlags
6071 * @see #addFlags
6072 *
6073 * @see #FLAG_GRANT_READ_URI_PERMISSION
6074 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
6075 * @see #FLAG_DEBUG_LOG_RESOLUTION
6076 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006077 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006078 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006079 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006080 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006081 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
6082 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006083 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006084 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
6085 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006086 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006087 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08006088 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006089 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
6090 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006091 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006092 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08006093 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006094 * @see #FLAG_RECEIVER_REGISTERED_ONLY
6095 */
6096 public Intent setFlags(int flags) {
6097 mFlags = flags;
6098 return this;
6099 }
6100
6101 /**
6102 * Add additional flags to the intent (or with existing flags
6103 * value).
6104 *
6105 * @param flags The new flags to set.
6106 *
6107 * @return Returns the same Intent object, for chaining multiple calls
6108 * into a single statement.
6109 *
6110 * @see #setFlags
6111 */
6112 public Intent addFlags(int flags) {
6113 mFlags |= flags;
6114 return this;
6115 }
6116
6117 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006118 * (Usually optional) Set an explicit application package name that limits
6119 * the components this Intent will resolve to. If left to the default
6120 * value of null, all components in all applications will considered.
6121 * If non-null, the Intent can only match the components in the given
6122 * application package.
6123 *
6124 * @param packageName The name of the application package to handle the
6125 * intent, or null to allow any application package.
6126 *
6127 * @return Returns the same Intent object, for chaining multiple calls
6128 * into a single statement.
6129 *
6130 * @see #getPackage
6131 * @see #resolveActivity
6132 */
6133 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006134 if (packageName != null && mSelector != null) {
6135 throw new IllegalArgumentException(
6136 "Can't set package name when selector is already set");
6137 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006138 mPackage = packageName;
6139 return this;
6140 }
6141
6142 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006143 * (Usually optional) Explicitly set the component to handle the intent.
6144 * If left with the default value of null, the system will determine the
6145 * appropriate class to use based on the other fields (action, data,
6146 * type, categories) in the Intent. If this class is defined, the
6147 * specified class will always be used regardless of the other fields. You
6148 * should only set this value when you know you absolutely want a specific
6149 * class to be used; otherwise it is better to let the system find the
6150 * appropriate class so that you will respect the installed applications
6151 * and user preferences.
6152 *
6153 * @param component The name of the application component to handle the
6154 * intent, or null to let the system find one for you.
6155 *
6156 * @return Returns the same Intent object, for chaining multiple calls
6157 * into a single statement.
6158 *
6159 * @see #setClass
6160 * @see #setClassName(Context, String)
6161 * @see #setClassName(String, String)
6162 * @see #getComponent
6163 * @see #resolveActivity
6164 */
6165 public Intent setComponent(ComponentName component) {
6166 mComponent = component;
6167 return this;
6168 }
6169
6170 /**
6171 * Convenience for calling {@link #setComponent} with an
6172 * explicit class name.
6173 *
6174 * @param packageContext A Context of the application package implementing
6175 * this class.
6176 * @param className The name of a class inside of the application package
6177 * that will be used as the component for this Intent.
6178 *
6179 * @return Returns the same Intent object, for chaining multiple calls
6180 * into a single statement.
6181 *
6182 * @see #setComponent
6183 * @see #setClass
6184 */
6185 public Intent setClassName(Context packageContext, String className) {
6186 mComponent = new ComponentName(packageContext, className);
6187 return this;
6188 }
6189
6190 /**
6191 * Convenience for calling {@link #setComponent} with an
6192 * explicit application package name and class name.
6193 *
6194 * @param packageName The name of the package implementing the desired
6195 * component.
6196 * @param className The name of a class inside of the application package
6197 * that will be used as the component for this Intent.
6198 *
6199 * @return Returns the same Intent object, for chaining multiple calls
6200 * into a single statement.
6201 *
6202 * @see #setComponent
6203 * @see #setClass
6204 */
6205 public Intent setClassName(String packageName, String className) {
6206 mComponent = new ComponentName(packageName, className);
6207 return this;
6208 }
6209
6210 /**
6211 * Convenience for calling {@link #setComponent(ComponentName)} with the
6212 * name returned by a {@link Class} object.
6213 *
6214 * @param packageContext A Context of the application package implementing
6215 * this class.
6216 * @param cls The class name to set, equivalent to
6217 * <code>setClassName(context, cls.getName())</code>.
6218 *
6219 * @return Returns the same Intent object, for chaining multiple calls
6220 * into a single statement.
6221 *
6222 * @see #setComponent
6223 */
6224 public Intent setClass(Context packageContext, Class<?> cls) {
6225 mComponent = new ComponentName(packageContext, cls);
6226 return this;
6227 }
6228
6229 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006230 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6231 * used as a hint to the receiver for animations and the like. Null means that there
6232 * is no source bounds.
6233 */
6234 public void setSourceBounds(Rect r) {
6235 if (r != null) {
6236 mSourceBounds = new Rect(r);
6237 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006238 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006239 }
6240 }
6241
6242 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006243 * Use with {@link #fillIn} to allow the current action value to be
6244 * overwritten, even if it is already set.
6245 */
6246 public static final int FILL_IN_ACTION = 1<<0;
6247
6248 /**
6249 * Use with {@link #fillIn} to allow the current data or type value
6250 * overwritten, even if it is already set.
6251 */
6252 public static final int FILL_IN_DATA = 1<<1;
6253
6254 /**
6255 * Use with {@link #fillIn} to allow the current categories to be
6256 * overwritten, even if they are already set.
6257 */
6258 public static final int FILL_IN_CATEGORIES = 1<<2;
6259
6260 /**
6261 * Use with {@link #fillIn} to allow the current component value to be
6262 * overwritten, even if it is already set.
6263 */
6264 public static final int FILL_IN_COMPONENT = 1<<3;
6265
6266 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006267 * Use with {@link #fillIn} to allow the current package value to be
6268 * overwritten, even if it is already set.
6269 */
6270 public static final int FILL_IN_PACKAGE = 1<<4;
6271
6272 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006273 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006274 * overwritten, even if it is already set.
6275 */
6276 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6277
6278 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006279 * Use with {@link #fillIn} to allow the current selector to be
6280 * overwritten, even if it is already set.
6281 */
6282 public static final int FILL_IN_SELECTOR = 1<<6;
6283
6284 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006285 * Use with {@link #fillIn} to allow the current ClipData to be
6286 * overwritten, even if it is already set.
6287 */
6288 public static final int FILL_IN_CLIP_DATA = 1<<7;
6289
6290 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006291 * Copy the contents of <var>other</var> in to this object, but only
6292 * where fields are not defined by this object. For purposes of a field
6293 * being defined, the following pieces of data in the Intent are
6294 * considered to be separate fields:
6295 *
6296 * <ul>
6297 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006298 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006299 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6300 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006301 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006302 * <li> component, as set by {@link #setComponent(ComponentName)} or
6303 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006304 * <li> source bounds, as set by {@link #setSourceBounds}.
6305 * <li> selector, as set by {@link #setSelector(Intent)}.
6306 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006307 * <li> each top-level name in the associated extras.
6308 * </ul>
6309 *
6310 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006311 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006312 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6313 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6314 * the restriction where the corresponding field will not be replaced if
6315 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006316 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006317 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6318 * is explicitly specified. The selector will only be copied if
6319 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006320 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006321 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6322 * and Intent B with {action="gotit", data-type="some/thing",
6323 * categories="one","two"}.
6324 *
6325 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6326 * containing: {action="gotit", data-type="some/thing",
6327 * categories="bar"}.
6328 *
6329 * @param other Another Intent whose values are to be used to fill in
6330 * the current one.
6331 * @param flags Options to control which fields can be filled in.
6332 *
6333 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006334 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006335 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6336 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006337 */
6338 public int fillIn(Intent other, int flags) {
6339 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006340 if (other.mAction != null
6341 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006342 mAction = other.mAction;
6343 changes |= FILL_IN_ACTION;
6344 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006345 if ((other.mData != null || other.mType != null)
6346 && ((mData == null && mType == null)
6347 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006348 mData = other.mData;
6349 mType = other.mType;
6350 changes |= FILL_IN_DATA;
6351 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006352 if (other.mCategories != null
6353 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006354 if (other.mCategories != null) {
6355 mCategories = new HashSet<String>(other.mCategories);
6356 }
6357 changes |= FILL_IN_CATEGORIES;
6358 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006359 if (other.mPackage != null
6360 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006361 // Only do this if mSelector is not set.
6362 if (mSelector == null) {
6363 mPackage = other.mPackage;
6364 changes |= FILL_IN_PACKAGE;
6365 }
6366 }
6367 // Selector is special: it can only be set if explicitly allowed,
6368 // for the same reason as the component name.
6369 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6370 if (mPackage == null) {
6371 mSelector = new Intent(other.mSelector);
6372 mPackage = null;
6373 changes |= FILL_IN_SELECTOR;
6374 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006375 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006376 if (other.mClipData != null
6377 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6378 mClipData = other.mClipData;
6379 changes |= FILL_IN_CLIP_DATA;
6380 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006381 // Component is special: it can -only- be set if explicitly allowed,
6382 // since otherwise the sender could force the intent somewhere the
6383 // originator didn't intend.
6384 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006385 mComponent = other.mComponent;
6386 changes |= FILL_IN_COMPONENT;
6387 }
6388 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006389 if (other.mSourceBounds != null
6390 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6391 mSourceBounds = new Rect(other.mSourceBounds);
6392 changes |= FILL_IN_SOURCE_BOUNDS;
6393 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006394 if (mExtras == null) {
6395 if (other.mExtras != null) {
6396 mExtras = new Bundle(other.mExtras);
6397 }
6398 } else if (other.mExtras != null) {
6399 try {
6400 Bundle newb = new Bundle(other.mExtras);
6401 newb.putAll(mExtras);
6402 mExtras = newb;
6403 } catch (RuntimeException e) {
6404 // Modifying the extras can cause us to unparcel the contents
6405 // of the bundle, and if we do this in the system process that
6406 // may fail. We really should handle this (i.e., the Bundle
6407 // impl shouldn't be on top of a plain map), but for now just
6408 // ignore it and keep the original contents. :(
6409 Log.w("Intent", "Failure filling in extras", e);
6410 }
6411 }
6412 return changes;
6413 }
6414
6415 /**
6416 * Wrapper class holding an Intent and implementing comparisons on it for
6417 * the purpose of filtering. The class implements its
6418 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6419 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6420 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6421 * on the wrapped Intent.
6422 */
6423 public static final class FilterComparison {
6424 private final Intent mIntent;
6425 private final int mHashCode;
6426
6427 public FilterComparison(Intent intent) {
6428 mIntent = intent;
6429 mHashCode = intent.filterHashCode();
6430 }
6431
6432 /**
6433 * Return the Intent that this FilterComparison represents.
6434 * @return Returns the Intent held by the FilterComparison. Do
6435 * not modify!
6436 */
6437 public Intent getIntent() {
6438 return mIntent;
6439 }
6440
6441 @Override
6442 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006443 if (obj instanceof FilterComparison) {
6444 Intent other = ((FilterComparison)obj).mIntent;
6445 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006446 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006447 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006448 }
6449
6450 @Override
6451 public int hashCode() {
6452 return mHashCode;
6453 }
6454 }
6455
6456 /**
6457 * Determine if two intents are the same for the purposes of intent
6458 * resolution (filtering). That is, if their action, data, type,
6459 * class, and categories are the same. This does <em>not</em> compare
6460 * any extra data included in the intents.
6461 *
6462 * @param other The other Intent to compare against.
6463 *
6464 * @return Returns true if action, data, type, class, and categories
6465 * are the same.
6466 */
6467 public boolean filterEquals(Intent other) {
6468 if (other == null) {
6469 return false;
6470 }
6471 if (mAction != other.mAction) {
6472 if (mAction != null) {
6473 if (!mAction.equals(other.mAction)) {
6474 return false;
6475 }
6476 } else {
6477 if (!other.mAction.equals(mAction)) {
6478 return false;
6479 }
6480 }
6481 }
6482 if (mData != other.mData) {
6483 if (mData != null) {
6484 if (!mData.equals(other.mData)) {
6485 return false;
6486 }
6487 } else {
6488 if (!other.mData.equals(mData)) {
6489 return false;
6490 }
6491 }
6492 }
6493 if (mType != other.mType) {
6494 if (mType != null) {
6495 if (!mType.equals(other.mType)) {
6496 return false;
6497 }
6498 } else {
6499 if (!other.mType.equals(mType)) {
6500 return false;
6501 }
6502 }
6503 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006504 if (mPackage != other.mPackage) {
6505 if (mPackage != null) {
6506 if (!mPackage.equals(other.mPackage)) {
6507 return false;
6508 }
6509 } else {
6510 if (!other.mPackage.equals(mPackage)) {
6511 return false;
6512 }
6513 }
6514 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006515 if (mComponent != other.mComponent) {
6516 if (mComponent != null) {
6517 if (!mComponent.equals(other.mComponent)) {
6518 return false;
6519 }
6520 } else {
6521 if (!other.mComponent.equals(mComponent)) {
6522 return false;
6523 }
6524 }
6525 }
6526 if (mCategories != other.mCategories) {
6527 if (mCategories != null) {
6528 if (!mCategories.equals(other.mCategories)) {
6529 return false;
6530 }
6531 } else {
6532 if (!other.mCategories.equals(mCategories)) {
6533 return false;
6534 }
6535 }
6536 }
6537
6538 return true;
6539 }
6540
6541 /**
6542 * Generate hash code that matches semantics of filterEquals().
6543 *
6544 * @return Returns the hash value of the action, data, type, class, and
6545 * categories.
6546 *
6547 * @see #filterEquals
6548 */
6549 public int filterHashCode() {
6550 int code = 0;
6551 if (mAction != null) {
6552 code += mAction.hashCode();
6553 }
6554 if (mData != null) {
6555 code += mData.hashCode();
6556 }
6557 if (mType != null) {
6558 code += mType.hashCode();
6559 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006560 if (mPackage != null) {
6561 code += mPackage.hashCode();
6562 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006563 if (mComponent != null) {
6564 code += mComponent.hashCode();
6565 }
6566 if (mCategories != null) {
6567 code += mCategories.hashCode();
6568 }
6569 return code;
6570 }
6571
6572 @Override
6573 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006574 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006575
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006576 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006577 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006578 b.append(" }");
6579
6580 return b.toString();
6581 }
6582
6583 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006584 public String toInsecureString() {
6585 StringBuilder b = new StringBuilder(128);
6586
6587 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006588 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006589 b.append(" }");
6590
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006591 return b.toString();
6592 }
Romain Guy4969af72009-06-17 10:53:19 -07006593
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006594 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006595 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006596 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006597
6598 b.append("Intent { ");
6599 toShortString(b, false, true, true, true);
6600 b.append(" }");
6601
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006602 return b.toString();
6603 }
6604
6605 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006606 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6607 StringBuilder b = new StringBuilder(128);
6608 toShortString(b, secure, comp, extras, clip);
6609 return b.toString();
6610 }
6611
6612 /** @hide */
6613 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6614 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006615 boolean first = true;
6616 if (mAction != null) {
6617 b.append("act=").append(mAction);
6618 first = false;
6619 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006620 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006621 if (!first) {
6622 b.append(' ');
6623 }
6624 first = false;
6625 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006626 Iterator<String> i = mCategories.iterator();
6627 boolean didone = false;
6628 while (i.hasNext()) {
6629 if (didone) b.append(",");
6630 didone = true;
6631 b.append(i.next());
6632 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006633 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006634 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006635 if (mData != null) {
6636 if (!first) {
6637 b.append(' ');
6638 }
6639 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006640 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006641 if (secure) {
6642 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006643 } else {
6644 b.append(mData);
6645 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006646 }
6647 if (mType != null) {
6648 if (!first) {
6649 b.append(' ');
6650 }
6651 first = false;
6652 b.append("typ=").append(mType);
6653 }
6654 if (mFlags != 0) {
6655 if (!first) {
6656 b.append(' ');
6657 }
6658 first = false;
6659 b.append("flg=0x").append(Integer.toHexString(mFlags));
6660 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006661 if (mPackage != null) {
6662 if (!first) {
6663 b.append(' ');
6664 }
6665 first = false;
6666 b.append("pkg=").append(mPackage);
6667 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006668 if (comp && mComponent != null) {
6669 if (!first) {
6670 b.append(' ');
6671 }
6672 first = false;
6673 b.append("cmp=").append(mComponent.flattenToShortString());
6674 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006675 if (mSourceBounds != null) {
6676 if (!first) {
6677 b.append(' ');
6678 }
6679 first = false;
6680 b.append("bnds=").append(mSourceBounds.toShortString());
6681 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006682 if (mClipData != null) {
6683 if (!first) {
6684 b.append(' ');
6685 }
6686 first = false;
6687 if (clip) {
6688 b.append("clip={");
6689 mClipData.toShortString(b);
6690 b.append('}');
6691 } else {
6692 b.append("(has clip)");
6693 }
6694 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006695 if (extras && mExtras != null) {
6696 if (!first) {
6697 b.append(' ');
6698 }
6699 first = false;
6700 b.append("(has extras)");
6701 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006702 if (mSelector != null) {
6703 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006704 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006705 b.append("}");
6706 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006707 }
6708
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006709 /**
6710 * Call {@link #toUri} with 0 flags.
6711 * @deprecated Use {@link #toUri} instead.
6712 */
6713 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006714 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006715 return toUri(0);
6716 }
6717
6718 /**
6719 * Convert this Intent into a String holding a URI representation of it.
6720 * The returned URI string has been properly URI encoded, so it can be
6721 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6722 * Intent's data as the base URI, with an additional fragment describing
6723 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006724 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006725 * <p>You can convert the returned string back to an Intent with
6726 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006727 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006728 * @param flags Additional operating flags. Either 0 or
6729 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006730 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006731 * @return Returns a URI encoding URI string describing the entire contents
6732 * of the Intent.
6733 */
6734 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006735 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006736 String scheme = null;
6737 if (mData != null) {
6738 String data = mData.toString();
6739 if ((flags&URI_INTENT_SCHEME) != 0) {
6740 final int N = data.length();
6741 for (int i=0; i<N; i++) {
6742 char c = data.charAt(i);
6743 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6744 || c == '.' || c == '-') {
6745 continue;
6746 }
6747 if (c == ':' && i > 0) {
6748 // Valid scheme.
6749 scheme = data.substring(0, i);
6750 uri.append("intent:");
6751 data = data.substring(i+1);
6752 break;
6753 }
Tom Taylord4a47292009-12-21 13:59:18 -08006754
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006755 // No scheme.
6756 break;
6757 }
6758 }
6759 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006760
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006761 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6762 uri.append("intent:");
6763 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006764
6765 uri.append("#Intent;");
6766
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006767 toUriInner(uri, scheme, flags);
6768 if (mSelector != null) {
6769 uri.append("SEL;");
6770 // Note that for now we are not going to try to handle the
6771 // data part; not clear how to represent this as a URI, and
6772 // not much utility in it.
6773 mSelector.toUriInner(uri, null, flags);
6774 }
6775
6776 uri.append("end");
6777
6778 return uri.toString();
6779 }
6780
6781 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006782 if (scheme != null) {
6783 uri.append("scheme=").append(scheme).append(';');
6784 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006785 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006786 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006787 }
6788 if (mCategories != null) {
6789 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006790 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006791 }
6792 }
6793 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006794 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006795 }
6796 if (mFlags != 0) {
6797 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6798 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006799 if (mPackage != null) {
6800 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6801 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006802 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006803 uri.append("component=").append(Uri.encode(
6804 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006805 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006806 if (mSourceBounds != null) {
6807 uri.append("sourceBounds=")
6808 .append(Uri.encode(mSourceBounds.flattenToString()))
6809 .append(';');
6810 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006811 if (mExtras != null) {
6812 for (String key : mExtras.keySet()) {
6813 final Object value = mExtras.get(key);
6814 char entryType =
6815 value instanceof String ? 'S' :
6816 value instanceof Boolean ? 'B' :
6817 value instanceof Byte ? 'b' :
6818 value instanceof Character ? 'c' :
6819 value instanceof Double ? 'd' :
6820 value instanceof Float ? 'f' :
6821 value instanceof Integer ? 'i' :
6822 value instanceof Long ? 'l' :
6823 value instanceof Short ? 's' :
6824 '\0';
6825
6826 if (entryType != '\0') {
6827 uri.append(entryType);
6828 uri.append('.');
6829 uri.append(Uri.encode(key));
6830 uri.append('=');
6831 uri.append(Uri.encode(value.toString()));
6832 uri.append(';');
6833 }
6834 }
6835 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006836 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006837
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006838 public int describeContents() {
6839 return (mExtras != null) ? mExtras.describeContents() : 0;
6840 }
6841
6842 public void writeToParcel(Parcel out, int flags) {
6843 out.writeString(mAction);
6844 Uri.writeToParcel(out, mData);
6845 out.writeString(mType);
6846 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006847 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006848 ComponentName.writeToParcel(mComponent, out);
6849
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006850 if (mSourceBounds != null) {
6851 out.writeInt(1);
6852 mSourceBounds.writeToParcel(out, flags);
6853 } else {
6854 out.writeInt(0);
6855 }
6856
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006857 if (mCategories != null) {
6858 out.writeInt(mCategories.size());
6859 for (String category : mCategories) {
6860 out.writeString(category);
6861 }
6862 } else {
6863 out.writeInt(0);
6864 }
6865
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006866 if (mSelector != null) {
6867 out.writeInt(1);
6868 mSelector.writeToParcel(out, flags);
6869 } else {
6870 out.writeInt(0);
6871 }
6872
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006873 if (mClipData != null) {
6874 out.writeInt(1);
6875 mClipData.writeToParcel(out, flags);
6876 } else {
6877 out.writeInt(0);
6878 }
6879
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006880 out.writeBundle(mExtras);
6881 }
6882
6883 public static final Parcelable.Creator<Intent> CREATOR
6884 = new Parcelable.Creator<Intent>() {
6885 public Intent createFromParcel(Parcel in) {
6886 return new Intent(in);
6887 }
6888 public Intent[] newArray(int size) {
6889 return new Intent[size];
6890 }
6891 };
6892
Dianne Hackborneb034652009-09-07 00:49:58 -07006893 /** @hide */
6894 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006895 readFromParcel(in);
6896 }
6897
6898 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006899 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006900 mData = Uri.CREATOR.createFromParcel(in);
6901 mType = in.readString();
6902 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006903 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006904 mComponent = ComponentName.readFromParcel(in);
6905
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006906 if (in.readInt() != 0) {
6907 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6908 }
6909
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006910 int N = in.readInt();
6911 if (N > 0) {
6912 mCategories = new HashSet<String>();
6913 int i;
6914 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006915 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006916 }
6917 } else {
6918 mCategories = null;
6919 }
6920
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006921 if (in.readInt() != 0) {
6922 mSelector = new Intent(in);
6923 }
6924
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006925 if (in.readInt() != 0) {
6926 mClipData = new ClipData(in);
6927 }
6928
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006929 mExtras = in.readBundle();
6930 }
6931
6932 /**
6933 * Parses the "intent" element (and its children) from XML and instantiates
6934 * an Intent object. The given XML parser should be located at the tag
6935 * where parsing should start (often named "intent"), from which the
6936 * basic action, data, type, and package and class name will be
6937 * retrieved. The function will then parse in to any child elements,
6938 * looking for <category android:name="xxx"> tags to add categories and
6939 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6940 * to the intent.
6941 *
6942 * @param resources The Resources to use when inflating resources.
6943 * @param parser The XML parser pointing at an "intent" tag.
6944 * @param attrs The AttributeSet interface for retrieving extended
6945 * attribute data at the current <var>parser</var> location.
6946 * @return An Intent object matching the XML data.
6947 * @throws XmlPullParserException If there was an XML parsing error.
6948 * @throws IOException If there was an I/O error.
6949 */
6950 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6951 throws XmlPullParserException, IOException {
6952 Intent intent = new Intent();
6953
6954 TypedArray sa = resources.obtainAttributes(attrs,
6955 com.android.internal.R.styleable.Intent);
6956
6957 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6958
6959 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6960 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6961 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6962
6963 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6964 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6965 if (packageName != null && className != null) {
6966 intent.setComponent(new ComponentName(packageName, className));
6967 }
6968
6969 sa.recycle();
6970
6971 int outerDepth = parser.getDepth();
6972 int type;
6973 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6974 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6975 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6976 continue;
6977 }
6978
6979 String nodeName = parser.getName();
6980 if (nodeName.equals("category")) {
6981 sa = resources.obtainAttributes(attrs,
6982 com.android.internal.R.styleable.IntentCategory);
6983 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6984 sa.recycle();
6985
6986 if (cat != null) {
6987 intent.addCategory(cat);
6988 }
6989 XmlUtils.skipCurrentTag(parser);
6990
6991 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006992 if (intent.mExtras == null) {
6993 intent.mExtras = new Bundle();
6994 }
6995 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6996 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006997
6998 } else {
6999 XmlUtils.skipCurrentTag(parser);
7000 }
7001 }
7002
7003 return intent;
7004 }
Nick Pellyccae4122012-01-09 14:12:58 -08007005
7006 /**
7007 * Normalize a MIME data type.
7008 *
7009 * <p>A normalized MIME type has white-space trimmed,
7010 * content-type parameters removed, and is lower-case.
7011 * This aligns the type with Android best practices for
7012 * intent filtering.
7013 *
7014 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
7015 * "text/x-vCard" becomes "text/x-vcard".
7016 *
7017 * <p>All MIME types received from outside Android (such as user input,
7018 * or external sources like Bluetooth, NFC, or the Internet) should
7019 * be normalized before they are used to create an Intent.
7020 *
7021 * @param type MIME data type to normalize
7022 * @return normalized MIME data type, or null if the input was null
7023 * @see {@link #setType}
7024 * @see {@link #setTypeAndNormalize}
7025 */
7026 public static String normalizeMimeType(String type) {
7027 if (type == null) {
7028 return null;
7029 }
7030
7031 type = type.trim().toLowerCase(Locale.US);
7032
7033 final int semicolonIndex = type.indexOf(';');
7034 if (semicolonIndex != -1) {
7035 type = type.substring(0, semicolonIndex);
7036 }
7037 return type;
7038 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007039
7040 /**
Jeff Sharkeya14acd22013-04-02 18:27:45 -07007041 * Prepare this {@link Intent} to leave an app process.
7042 *
7043 * @hide
7044 */
7045 public void prepareToLeaveProcess() {
7046 setAllowFds(false);
7047
7048 if (mSelector != null) {
7049 mSelector.prepareToLeaveProcess();
7050 }
7051 if (mClipData != null) {
7052 mClipData.prepareToLeaveProcess();
7053 }
7054
7055 if (mData != null && StrictMode.vmFileUriExposureEnabled()) {
7056 // There are several ACTION_MEDIA_* broadcasts that send file://
7057 // Uris, so only check common actions.
7058 if (ACTION_VIEW.equals(mAction) ||
7059 ACTION_EDIT.equals(mAction) ||
7060 ACTION_ATTACH_DATA.equals(mAction)) {
7061 mData.checkFileUriExposed("Intent.getData()");
7062 }
7063 }
7064 }
7065
7066 /**
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007067 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007068 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
7069 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007070 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007071 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007072 * @hide
7073 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007074 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007075 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007076 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007077
7078 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007079 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007080
7081 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007082 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07007083 try {
7084 // Inspect target intent to see if we need to migrate
7085 final Intent target = getParcelableExtra(EXTRA_INTENT);
7086 if (target != null && target.migrateExtraStreamToClipData()) {
7087 // Since we migrated in child, we need to promote ClipData
7088 // and flags to ourselves to grant.
7089 setClipData(target.getClipData());
7090 addFlags(target.getFlags()
Jeff Sharkey328ebf22013-03-21 18:09:39 -07007091 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION
7092 | FLAG_PERSIST_GRANT_URI_PERMISSION));
Jeff Sharkey1c297002012-05-18 13:55:47 -07007093 return true;
7094 } else {
7095 return false;
7096 }
7097 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007098 }
7099
7100 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007101 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007102 final Uri stream = getParcelableExtra(EXTRA_STREAM);
7103 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
7104 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
7105 if (stream != null || text != null || htmlText != null) {
7106 final ClipData clipData = new ClipData(
7107 null, new String[] { getType() },
7108 new ClipData.Item(text, htmlText, null, stream));
7109 setClipData(clipData);
7110 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007111 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007112 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007113 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007114 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007115
7116 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007117 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007118 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
7119 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
7120 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
7121 int num = -1;
7122 if (streams != null) {
7123 num = streams.size();
7124 }
7125 if (texts != null) {
7126 if (num >= 0 && num != texts.size()) {
7127 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007128 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007129 }
7130 num = texts.size();
7131 }
7132 if (htmlTexts != null) {
7133 if (num >= 0 && num != htmlTexts.size()) {
7134 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007135 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007136 }
7137 num = htmlTexts.size();
7138 }
7139 if (num > 0) {
7140 final ClipData clipData = new ClipData(
7141 null, new String[] { getType() },
7142 makeClipItem(streams, texts, htmlTexts, 0));
7143
7144 for (int i = 1; i < num; i++) {
7145 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7146 }
7147
7148 setClipData(clipData);
7149 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007150 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007151 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007152 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007153 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007154 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007155
7156 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007157 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007158
7159 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7160 ArrayList<String> htmlTexts, int which) {
7161 Uri uri = streams != null ? streams.get(which) : null;
7162 CharSequence text = texts != null ? texts.get(which) : null;
7163 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7164 return new ClipData.Item(text, htmlText, null, uri);
7165 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007166}