blob: 53e0a7545a885cb9f62f8dc25c05b3badb25b97d [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;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700573 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800574 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700575 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
577 * <li> {@link #EXTRA_REPLACING}
578 * <li> {@link #EXTRA_SHORTCUT_ICON}
579 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
580 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700581 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800582 * <li> {@link #EXTRA_SHORTCUT_NAME}
583 * <li> {@link #EXTRA_SUBJECT}
584 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700585 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_TITLE}
587 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * </ul>
589 *
590 * <h3>Flags</h3>
591 *
592 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800593 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
594 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800596public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 // ---------------------------------------------------------------------
598 // ---------------------------------------------------------------------
599 // Standard intent activity actions (see action variable).
600
601 /**
602 * Activity Action: Start as a main entry point, does not expect to
603 * receive data.
604 * <p>Input: nothing
605 * <p>Output: nothing
606 */
607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
608 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700610 /**
611 * Activity Action: Display the data to the user. This is the most common
612 * action performed on data -- it is the generic action you can use on
613 * a piece of data to get the most reasonable thing to occur. For example,
614 * when used on a contacts entry it will view the entry; when used on a
615 * mailto: URI it will bring up a compose window filled with the information
616 * supplied by the URI; when used with a tel: URI it will invoke the
617 * dialer.
618 * <p>Input: {@link #getData} is URI from which to retrieve data.
619 * <p>Output: nothing.
620 */
621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
622 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 /**
625 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
626 * performed on a piece of data.
627 */
628 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Used to indicate that some piece of data should be attached to some other
632 * place. For example, image data could be attached to a contact. It is up
633 * to the recipient to decide where the data should be attached; the intent
634 * does not specify the ultimate destination.
635 * <p>Input: {@link #getData} is URI of data to be attached.
636 * <p>Output: nothing.
637 */
638 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
639 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700641 /**
642 * Activity Action: Provide explicit editable access to the given data.
643 * <p>Input: {@link #getData} is URI of data to be edited.
644 * <p>Output: nothing.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
651 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
652 * The extras can contain type specific data to pass through to the editing/creating
653 * activity.
654 * <p>Output: The URI of the item that was picked. This must be a content:
655 * URI so that any receiver can access it.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * Activity Action: Pick an item from the data, returning what was selected.
662 * <p>Input: {@link #getData} is URI containing a directory of data
663 * (vnd.android.cursor.dir/*) from which to pick an item.
664 * <p>Output: The URI of the item that was picked.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800671 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 * <p>Output: An Intent representing the shortcut. The intent must contain three
673 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
674 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675 * (value: ShortcutIconResource).</p>
676 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * @see #EXTRA_SHORTCUT_INTENT
678 * @see #EXTRA_SHORTCUT_NAME
679 * @see #EXTRA_SHORTCUT_ICON
680 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
681 * @see android.content.Intent.ShortcutIconResource
682 */
683 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
684 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
685
686 /**
687 * The name of the extra used to define the Intent of a shortcut.
688 *
689 * @see #ACTION_CREATE_SHORTCUT
690 */
691 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
692 /**
693 * The name of the extra used to define the name of a shortcut.
694 *
695 * @see #ACTION_CREATE_SHORTCUT
696 */
697 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
698 /**
699 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
700 *
701 * @see #ACTION_CREATE_SHORTCUT
702 */
703 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
704 /**
705 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
706 *
707 * @see #ACTION_CREATE_SHORTCUT
708 * @see android.content.Intent.ShortcutIconResource
709 */
710 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
711 "android.intent.extra.shortcut.ICON_RESOURCE";
712
713 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 *
716 * @see Intent#ACTION_CREATE_SHORTCUT
717 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
719 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 */
721 public static class ShortcutIconResource implements Parcelable {
722 /**
723 * The package name of the application containing the icon.
724 */
725 public String packageName;
726
727 /**
728 * The resource name of the icon, including package, name and type.
729 */
730 public String resourceName;
731
732 /**
733 * Creates a new ShortcutIconResource for the specified context and resource
734 * identifier.
735 *
736 * @param context The context of the application.
737 * @param resourceId The resource idenfitier for the icon.
738 * @return A new ShortcutIconResource with the specified's context package name
739 * and icon resource idenfitier.
740 */
741 public static ShortcutIconResource fromContext(Context context, int resourceId) {
742 ShortcutIconResource icon = new ShortcutIconResource();
743 icon.packageName = context.getPackageName();
744 icon.resourceName = context.getResources().getResourceName(resourceId);
745 return icon;
746 }
747
748 /**
749 * Used to read a ShortcutIconResource from a Parcel.
750 */
751 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
752 new Parcelable.Creator<ShortcutIconResource>() {
753
754 public ShortcutIconResource createFromParcel(Parcel source) {
755 ShortcutIconResource icon = new ShortcutIconResource();
756 icon.packageName = source.readString();
757 icon.resourceName = source.readString();
758 return icon;
759 }
760
761 public ShortcutIconResource[] newArray(int size) {
762 return new ShortcutIconResource[size];
763 }
764 };
765
766 /**
767 * No special parcel contents.
768 */
769 public int describeContents() {
770 return 0;
771 }
772
773 public void writeToParcel(Parcel dest, int flags) {
774 dest.writeString(packageName);
775 dest.writeString(resourceName);
776 }
777
778 @Override
779 public String toString() {
780 return resourceName;
781 }
782 }
783
784 /**
785 * Activity Action: Display an activity chooser, allowing the user to pick
786 * what they want to before proceeding. This can be used as an alternative
787 * to the standard activity picker that is displayed by the system when
788 * you try to start an activity with multiple possible matches, with these
789 * differences in behavior:
790 * <ul>
791 * <li>You can specify the title that will appear in the activity chooser.
792 * <li>The user does not have the option to make one of the matching
793 * activities a preferred activity, and all possible activities will
794 * always be shown even if one of them is currently marked as the
795 * preferred activity.
796 * </ul>
797 * <p>
798 * This action should be used when the user will naturally expect to
799 * select an activity in order to proceed. An example if when not to use
800 * it is when the user clicks on a "mailto:" link. They would naturally
801 * expect to go directly to their mail app, so startActivity() should be
802 * called directly: it will
803 * either launch the current preferred app, or put up a dialog allowing the
804 * user to pick an app to use and optionally marking that as preferred.
805 * <p>
806 * In contrast, if the user is selecting a menu item to send a picture
807 * they are viewing to someone else, there are many different things they
808 * may want to do at this point: send it through e-mail, upload it to a
809 * web service, etc. In this case the CHOOSER action should be used, to
810 * always present to the user a list of the things they can do, with a
811 * nice title given by the caller such as "Send this photo with:".
812 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700813 * If you need to grant URI permissions through a chooser, you must specify
814 * the permissions to be granted on the ACTION_CHOOSER Intent
815 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
816 * {@link #setClipData} to specify the URIs to be granted as well as
817 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
818 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
819 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 * As a convenience, an Intent of this form can be created with the
821 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700822 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
825 * and can optionally have a {@link #EXTRA_TITLE} field containing the
826 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700827 * <p>
828 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700829 */
830 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
831 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
832
833 /**
834 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
835 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700836 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
837 * target intent, also optionally supplying a title. If the target
838 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
839 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
840 * set in the returned chooser intent, with its ClipData set appropriately:
841 * either a direct reflection of {@link #getClipData()} if that is non-null,
842 * or a new ClipData build from {@link #getData()}.
843 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 * @param target The Intent that the user will be selecting an activity
845 * to perform.
846 * @param title Optional title that will be displayed in the chooser.
847 * @return Return a new Intent object that you can hand to
848 * {@link Context#startActivity(Intent) Context.startActivity()} and
849 * related methods.
850 */
851 public static Intent createChooser(Intent target, CharSequence title) {
852 Intent intent = new Intent(ACTION_CHOOSER);
853 intent.putExtra(EXTRA_INTENT, target);
854 if (title != null) {
855 intent.putExtra(EXTRA_TITLE, title);
856 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700857
858 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700859 int permFlags = target.getFlags()
860 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
861 if (permFlags != 0) {
862 ClipData targetClipData = target.getClipData();
863 if (targetClipData == null && target.getData() != null) {
864 ClipData.Item item = new ClipData.Item(target.getData());
865 String[] mimeTypes;
866 if (target.getType() != null) {
867 mimeTypes = new String[] { target.getType() };
868 } else {
869 mimeTypes = new String[] { };
870 }
871 targetClipData = new ClipData(null, mimeTypes, item);
872 }
873 if (targetClipData != null) {
874 intent.setClipData(targetClipData);
875 intent.addFlags(permFlags);
876 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700879 return intent;
880 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700882 /**
883 * Activity Action: Allow the user to select a particular kind of data and
884 * return it. This is different than {@link #ACTION_PICK} in that here we
885 * just say what kind of data is desired, not a URI of existing data from
886 * which the user can pick. A ACTION_GET_CONTENT could allow the user to
887 * create the data as it runs (for example taking a picture or recording a
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900888 * sound), let them browse over the web and download the desired data,
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700889 * etc.
890 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900891 * 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 -0700892 * of data, such as a person contact, you set the MIME type to the kind of
893 * data you want and launch it with {@link Context#startActivity(Intent)}.
894 * The system will then launch the best application to select that kind
895 * of data for you.
896 * <p>
897 * You may also be interested in any of a set of types of content the user
898 * can pick. For example, an e-mail application that wants to allow the
899 * user to add an attachment to an e-mail message can use this action to
900 * bring up a list of all of the types of content the user can attach.
901 * <p>
902 * In this case, you should wrap the GET_CONTENT intent with a chooser
903 * (through {@link #createChooser}), which will give the proper interface
904 * for the user to pick how to send your data and allow you to specify
905 * a prompt indicating what they are doing. You will usually specify a
906 * broad MIME type (such as image/* or {@literal *}/*), resulting in a
907 * broad range of content types the user can select from.
908 * <p>
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900909 * When using such a broad GET_CONTENT action, it is often desirable to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700910 * only pick from data that can be represented as a stream. This is
911 * accomplished by requiring the {@link #CATEGORY_OPENABLE} in the Intent.
912 * <p>
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800913 * Callers can optionally specify {@link #EXTRA_LOCAL_ONLY} to request that
Ken Wakasaf76a50c2012-03-09 19:56:35 +0900914 * the launched content chooser only returns results representing data that
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800915 * is locally available on the device. For example, if this extra is set
916 * to true then an image picker should not show any pictures that are available
917 * from a remote server but not already on the local device (thus requiring
918 * they be downloaded when opened).
919 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700920 * Input: {@link #getType} is the desired MIME type to retrieve. Note
921 * that no URI is supplied in the intent, as there are no constraints on
922 * where the returned data originally comes from. You may also include the
923 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800924 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
925 * selection to local data.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700926 * <p>
927 * Output: The URI of the item that was picked. This must be a content:
928 * URI so that any receiver can access it.
929 */
930 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
931 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
932 /**
933 * Activity Action: Dial a number as specified by the data. This shows a
934 * UI with the number being dialed, allowing the user to explicitly
935 * initiate the call.
936 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
937 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
938 * number.
939 * <p>Output: nothing.
940 */
941 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
942 public static final String ACTION_DIAL = "android.intent.action.DIAL";
943 /**
944 * Activity Action: Perform a call to someone specified by the data.
945 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
946 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
947 * number.
948 * <p>Output: nothing.
949 *
950 * <p>Note: there will be restrictions on which applications can initiate a
951 * call; most applications should use the {@link #ACTION_DIAL}.
952 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
953 * numbers. Applications can <strong>dial</strong> emergency numbers using
954 * {@link #ACTION_DIAL}, however.
955 */
956 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
957 public static final String ACTION_CALL = "android.intent.action.CALL";
958 /**
959 * Activity Action: Perform a call to an emergency number specified by the
960 * data.
961 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
962 * tel: URI of an explicit phone number.
963 * <p>Output: nothing.
964 * @hide
965 */
966 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
967 /**
968 * Activity action: Perform a call to any number (emergency or not)
969 * specified by the data.
970 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
971 * tel: URI of an explicit phone number.
972 * <p>Output: nothing.
973 * @hide
974 */
975 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
976 /**
977 * Activity Action: Send a message to someone specified by the data.
978 * <p>Input: {@link #getData} is URI describing the target.
979 * <p>Output: nothing.
980 */
981 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
982 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
983 /**
984 * Activity Action: Deliver some data to someone else. Who the data is
985 * being delivered to is not specified; it is up to the receiver of this
986 * action to ask the user where the data should be sent.
987 * <p>
988 * When launching a SEND intent, you should usually wrap it in a chooser
989 * (through {@link #createChooser}), which will give the proper interface
990 * for the user to pick how to send your data and allow you to specify
991 * a prompt indicating what they are doing.
992 * <p>
993 * Input: {@link #getType} is the MIME type of the data being sent.
994 * get*Extra can have either a {@link #EXTRA_TEXT}
995 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
996 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
997 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
998 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -0700999 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1000 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1001 * your text with HTML formatting.
1002 * <p>
1003 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1004 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1005 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1006 * content: URIs and other advanced features of {@link ClipData}. If
1007 * using this approach, you still must supply the same data through the
1008 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1009 * for compatibility with old applications. If you don't set a ClipData,
1010 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001011 * <p>
1012 * Optional standard extras, which may be interpreted by some recipients as
1013 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1014 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1015 * <p>
1016 * Output: nothing.
1017 */
1018 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1019 public static final String ACTION_SEND = "android.intent.action.SEND";
1020 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001021 * Activity Action: Deliver multiple data to someone else.
1022 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001023 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001024 * <p>
1025 * Input: {@link #getType} is the MIME type of the data being sent.
1026 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001027 * #EXTRA_STREAM} field, containing the data to be sent. If using
1028 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1029 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001030 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001031 * Multiple types are supported, and receivers should handle mixed types
1032 * whenever possible. The right way for the receiver to check them is to
1033 * use the content resolver on each URI. The intent sender should try to
1034 * put the most concrete mime type in the intent type, but it can fall
1035 * back to {@literal <type>/*} or {@literal *}/* as needed.
1036 * <p>
1037 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1038 * be image/jpg, but if you are sending image/jpg and image/png, then the
1039 * intent's type should be image/*.
1040 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001041 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1042 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1043 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1044 * content: URIs and other advanced features of {@link ClipData}. If
1045 * using this approach, you still must supply the same data through the
1046 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1047 * for compatibility with old applications. If you don't set a ClipData,
1048 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1049 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001050 * Optional standard extras, which may be interpreted by some recipients as
1051 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1052 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1053 * <p>
1054 * Output: nothing.
1055 */
1056 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1057 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1058 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001059 * Activity Action: Handle an incoming phone call.
1060 * <p>Input: nothing.
1061 * <p>Output: nothing.
1062 */
1063 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1064 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1065 /**
1066 * Activity Action: Insert an empty item into the given container.
1067 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1068 * in which to place the data.
1069 * <p>Output: URI of the new data that was created.
1070 */
1071 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1072 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1073 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001074 * Activity Action: Create a new item in the given container, initializing it
1075 * from the current contents of the clipboard.
1076 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1077 * in which to place the data.
1078 * <p>Output: URI of the new data that was created.
1079 */
1080 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1081 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1082 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001083 * Activity Action: Delete the given data from its container.
1084 * <p>Input: {@link #getData} is URI of data to be deleted.
1085 * <p>Output: nothing.
1086 */
1087 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1088 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1089 /**
1090 * Activity Action: Run the data, whatever that means.
1091 * <p>Input: ? (Note: this is currently specific to the test harness.)
1092 * <p>Output: nothing.
1093 */
1094 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1095 public static final String ACTION_RUN = "android.intent.action.RUN";
1096 /**
1097 * Activity Action: Perform a data synchronization.
1098 * <p>Input: ?
1099 * <p>Output: ?
1100 */
1101 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1102 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1103 /**
1104 * Activity Action: Pick an activity given an intent, returning the class
1105 * selected.
1106 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1107 * used with {@link PackageManager#queryIntentActivities} to determine the
1108 * set of activities from which to pick.
1109 * <p>Output: Class name of the activity that was selected.
1110 */
1111 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1112 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1113 /**
1114 * Activity Action: Perform a search.
1115 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1116 * is the text to search for. If empty, simply
1117 * enter your search results Activity with the search UI activated.
1118 * <p>Output: nothing.
1119 */
1120 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1121 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1122 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001123 * Activity Action: Start the platform-defined tutorial
1124 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1125 * is the text to search for. If empty, simply
1126 * enter your search results Activity with the search UI activated.
1127 * <p>Output: nothing.
1128 */
1129 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1130 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1131 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001132 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001133 * <p>
1134 * Input: {@link android.app.SearchManager#QUERY
1135 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1136 * a url starts with http or https, the site will be opened. If it is plain
1137 * text, Google search will be applied.
1138 * <p>
1139 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001140 */
1141 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1142 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
1143 /**
Jim Miller07994402012-05-02 14:22:27 -07001144 * Activity Action: Perform assist action.
1145 * <p>
1146 * Input: nothing
1147 * Output: nothing.
1148 */
1149 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1150 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
1151 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001152 * Activity Action: List all available applications
1153 * <p>Input: Nothing.
1154 * <p>Output: nothing.
1155 */
1156 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1157 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1158 /**
1159 * Activity Action: Show settings for choosing wallpaper
1160 * <p>Input: Nothing.
1161 * <p>Output: Nothing.
1162 */
1163 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1164 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1165
1166 /**
1167 * Activity Action: Show activity for reporting a bug.
1168 * <p>Input: Nothing.
1169 * <p>Output: Nothing.
1170 */
1171 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1172 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1173
1174 /**
1175 * Activity Action: Main entry point for factory tests. Only used when
1176 * the device is booting in factory test node. The implementing package
1177 * must be installed in the system image.
1178 * <p>Input: nothing
1179 * <p>Output: nothing
1180 */
1181 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1182
1183 /**
1184 * Activity Action: The user pressed the "call" button to go to the dialer
1185 * or other appropriate UI for placing a call.
1186 * <p>Input: Nothing.
1187 * <p>Output: Nothing.
1188 */
1189 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1190 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1191
1192 /**
1193 * Activity Action: Start Voice Command.
1194 * <p>Input: Nothing.
1195 * <p>Output: Nothing.
1196 */
1197 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1198 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001199
1200 /**
1201 * Activity Action: Start action associated with long pressing on the
1202 * search key.
1203 * <p>Input: Nothing.
1204 * <p>Output: Nothing.
1205 */
1206 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1207 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001208
Jacek Surazski86b6c532009-05-13 14:38:28 +02001209 /**
1210 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1211 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001212 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001213 * <p>Input: No data is specified. The bug report is passed in using
1214 * an {@link #EXTRA_BUG_REPORT} field.
1215 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001216 *
1217 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001218 */
1219 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1220 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001221
1222 /**
1223 * Activity Action: Show power usage information to the user.
1224 * <p>Input: Nothing.
1225 * <p>Output: Nothing.
1226 */
1227 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1228 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001229
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001230 /**
1231 * Activity Action: Setup wizard to launch after a platform update. This
1232 * activity should have a string meta-data field associated with it,
1233 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1234 * the platform for setup. The activity will be launched only if
1235 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1236 * same value.
1237 * <p>Input: Nothing.
1238 * <p>Output: Nothing.
1239 * @hide
1240 */
1241 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1242 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001243
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001244 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001245 * Activity Action: Show settings for managing network data usage of a
1246 * specific application. Applications should define an activity that offers
1247 * options to control data usage.
1248 */
1249 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1250 public static final String ACTION_MANAGE_NETWORK_USAGE =
1251 "android.intent.action.MANAGE_NETWORK_USAGE";
1252
1253 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001254 * Activity Action: Launch application installer.
1255 * <p>
1256 * Input: The data must be a content: or file: URI at which the application
1257 * can be retrieved. You can optionally supply
1258 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1259 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1260 * <p>
1261 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1262 * succeeded.
1263 *
1264 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1265 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1266 * @see #EXTRA_RETURN_RESULT
1267 */
1268 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1269 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1270
1271 /**
1272 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1273 * package. Specifies the installer package name; this package will receive the
1274 * {@link #ACTION_APP_ERROR} intent.
1275 */
1276 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1277 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1278
1279 /**
1280 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1281 * package. Specifies that the application being installed should not be
1282 * treated as coming from an unknown source, but as coming from the app
1283 * invoking the Intent. For this to work you must start the installer with
1284 * startActivityForResult().
1285 */
1286 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1287 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1288
1289 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001290 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1291 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001292 * data field originated from.
1293 */
rich cannings706e8ba2012-08-20 13:20:14 -07001294 public static final String EXTRA_ORIGINATING_URI
1295 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001296
1297 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001298 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1299 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1300 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001301 */
1302 public static final String EXTRA_REFERRER
1303 = "android.intent.extra.REFERRER";
1304
1305 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001306 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1307 * package. Tells the installer UI to skip the confirmation with the user
1308 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001309 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1310 * will no longer show an interstitial message about updating existing
1311 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001312 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001313 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001314 public static final String EXTRA_ALLOW_REPLACE
1315 = "android.intent.extra.ALLOW_REPLACE";
1316
1317 /**
1318 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1319 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1320 * return to the application the result code of the install/uninstall. The returned result
1321 * code will be {@link android.app.Activity#RESULT_OK} on success or
1322 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1323 */
1324 public static final String EXTRA_RETURN_RESULT
1325 = "android.intent.extra.RETURN_RESULT";
1326
1327 /**
1328 * Package manager install result code. @hide because result codes are not
1329 * yet ready to be exposed.
1330 */
1331 public static final String EXTRA_INSTALL_RESULT
1332 = "android.intent.extra.INSTALL_RESULT";
1333
1334 /**
1335 * Activity Action: Launch application uninstaller.
1336 * <p>
1337 * Input: The data must be a package: URI whose scheme specific part is
1338 * the package name of the current installed package to be uninstalled.
1339 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1340 * <p>
1341 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1342 * succeeded.
1343 */
1344 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1345 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1346
1347 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001348 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1349 * describing the last run version of the platform that was setup.
1350 * @hide
1351 */
1352 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1353
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001354 // ---------------------------------------------------------------------
1355 // ---------------------------------------------------------------------
1356 // Standard intent broadcast actions (see action variable).
1357
1358 /**
1359 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001360 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001361 * <p class="note">This is a protected intent that can only be sent
1362 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001363 */
1364 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1365 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1366 /**
1367 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001368 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001369 * <p class="note">This is a protected intent that can only be sent
1370 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001371 */
1372 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1373 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001374
1375 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001376 * 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 -07001377 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001378 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001379 * <p class="note">This is a protected intent that can only be sent
1380 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001381 */
1382 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001383 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001384
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001385 /**
1386 * Broadcast Action: The current time has changed. Sent every
1387 * minute. You can <em>not</em> receive this through components declared
1388 * in manifests, only by exlicitly registering for it with
1389 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1390 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001391 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001392 * <p class="note">This is a protected intent that can only be sent
1393 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001394 */
1395 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1396 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1397 /**
1398 * Broadcast Action: The time was set.
1399 */
1400 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1401 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1402 /**
1403 * Broadcast Action: The date has changed.
1404 */
1405 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1406 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1407 /**
1408 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1409 * <ul>
1410 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1411 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001412 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001413 * <p class="note">This is a protected intent that can only be sent
1414 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001415 */
1416 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1417 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1418 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001419 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1420 * DNS entries should be tossed.
1421 * @hide
1422 */
1423 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1424 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1425 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001426 * Alarm Changed Action: This is broadcast when the AlarmClock
1427 * application's alarm is set or unset. It is used by the
1428 * AlarmClock application and the StatusBar service.
1429 * @hide
1430 */
1431 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1432 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1433 /**
1434 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1435 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1436 * @hide
1437 */
1438 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1439 public static final String ACTION_SYNC_STATE_CHANGED
1440 = "android.intent.action.SYNC_STATE_CHANGED";
1441 /**
1442 * Broadcast Action: This is broadcast once, after the system has finished
1443 * booting. It can be used to perform application-specific initialization,
1444 * such as installing alarms. You must hold the
1445 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1446 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001447 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001448 * <p class="note">This is a protected intent that can only be sent
1449 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001450 */
1451 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1452 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1453 /**
1454 * Broadcast Action: This is broadcast when a user action should request a
1455 * temporary system dialog to dismiss. Some examples of temporary system
1456 * dialogs are the notification window-shade and the recent tasks dialog.
1457 */
1458 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1459 /**
1460 * Broadcast Action: Trigger the download and eventual installation
1461 * of a package.
1462 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001463 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001464 * <p class="note">This is a protected intent that can only be sent
1465 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001466 *
1467 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001468 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001469 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001470 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1471 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1472 /**
1473 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001474 * device. The data contains the name of the package. Note that the
1475 * newly installed package does <em>not</em> receive this broadcast.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001476 * <p>My include the following extras:
1477 * <ul>
1478 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1479 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1480 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1481 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001482 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001483 * <p class="note">This is a protected intent that can only be sent
1484 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001485 */
1486 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1487 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1488 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001489 * Broadcast Action: A new version of an application package has been
1490 * installed, replacing an existing version that was previously installed.
1491 * The data contains the name of the package.
1492 * <p>My include the following extras:
1493 * <ul>
1494 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1495 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001496 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001497 * <p class="note">This is a protected intent that can only be sent
1498 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001499 */
1500 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1501 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1502 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001503 * Broadcast Action: A new version of your application has been installed
1504 * over an existing one. This is only sent to the application that was
1505 * replaced. It does not contain any additional data; to receive it, just
1506 * use an intent filter for this action.
1507 *
1508 * <p class="note">This is a protected intent that can only be sent
1509 * by the system.
1510 */
1511 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1512 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1513 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001514 * Broadcast Action: An existing application package has been removed from
1515 * the device. The data contains the name of the package. The package
1516 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001517 * <ul>
1518 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1519 * to the package.
1520 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1521 * application -- data and code -- is being removed.
1522 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1523 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1524 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001525 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001526 * <p class="note">This is a protected intent that can only be sent
1527 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001528 */
1529 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1530 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1531 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001532 * Broadcast Action: An existing application package has been completely
1533 * removed from the device. The data contains the name of the package.
1534 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1535 * {@link #EXTRA_DATA_REMOVED} is true and
1536 * {@link #EXTRA_REPLACING} is false of that broadcast.
1537 *
1538 * <ul>
1539 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1540 * to the package.
1541 * </ul>
1542 *
1543 * <p class="note">This is a protected intent that can only be sent
1544 * by the system.
1545 */
1546 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1547 public static final String ACTION_PACKAGE_FULLY_REMOVED
1548 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1549 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001550 * Broadcast Action: An existing application package has been changed (e.g.
1551 * a component has been enabled or disabled). The data contains the name of
1552 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001553 * <ul>
1554 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001555 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
1556 * of the changed components.
1557 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1558 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001559 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001560 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001561 * <p class="note">This is a protected intent that can only be sent
1562 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001563 */
1564 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1565 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1566 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001567 * @hide
1568 * Broadcast Action: Ask system services if there is any reason to
1569 * restart the given package. The data contains the name of the
1570 * package.
1571 * <ul>
1572 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1573 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1574 * </ul>
1575 *
1576 * <p class="note">This is a protected intent that can only be sent
1577 * by the system.
1578 */
1579 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1580 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1581 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001582 * Broadcast Action: The user has restarted a package, and all of its
1583 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001584 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001585 * be removed. Note that the restarted package does <em>not</em>
1586 * receive this broadcast.
1587 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001588 * <ul>
1589 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1590 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001591 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001592 * <p class="note">This is a protected intent that can only be sent
1593 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001594 */
1595 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1596 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1597 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001598 * Broadcast Action: The user has cleared the data of a package. This should
1599 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001600 * its persistent data is erased and this broadcast sent.
1601 * Note that the cleared package does <em>not</em>
1602 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001603 * <ul>
1604 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1605 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001606 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001607 * <p class="note">This is a protected intent that can only be sent
1608 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001609 */
1610 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1611 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1612 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001613 * Broadcast Action: A user ID has been removed from the system. The user
1614 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001615 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001616 * <p class="note">This is a protected intent that can only be sent
1617 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001618 */
1619 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1620 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001621
1622 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001623 * Broadcast Action: Sent to the installer package of an application
1624 * when that application is first launched (that is the first time it
1625 * is moved out of the stopped state). The data contains the name of the package.
1626 *
1627 * <p class="note">This is a protected intent that can only be sent
1628 * by the system.
1629 */
1630 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1631 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1632
1633 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001634 * Broadcast Action: Sent to the system package verifier when a package
1635 * needs to be verified. The data contains the package URI.
1636 * <p class="note">
1637 * This is a protected intent that can only be sent by the system.
1638 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001639 */
1640 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1641 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1642
1643 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001644 * Broadcast Action: Resources for a set of packages (which were
1645 * previously unavailable) are currently
1646 * available since the media on which they exist is available.
1647 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1648 * list of packages whose availability changed.
1649 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1650 * list of uids of packages whose availability changed.
1651 * Note that the
1652 * packages in this list do <em>not</em> receive this broadcast.
1653 * The specified set of packages are now available on the system.
1654 * <p>Includes the following extras:
1655 * <ul>
1656 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1657 * whose resources(were previously unavailable) are currently available.
1658 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1659 * packages whose resources(were previously unavailable)
1660 * are currently available.
1661 * </ul>
1662 *
1663 * <p class="note">This is a protected intent that can only be sent
1664 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001665 */
1666 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001667 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1668 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001669
1670 /**
1671 * Broadcast Action: Resources for a set of packages are currently
1672 * unavailable since the media on which they exist is unavailable.
1673 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1674 * list of packages whose availability changed.
1675 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1676 * list of uids of packages whose availability changed.
1677 * The specified set of packages can no longer be
1678 * launched and are practically unavailable on the system.
1679 * <p>Inclues the following extras:
1680 * <ul>
1681 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1682 * whose resources are no longer available.
1683 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1684 * whose resources are no longer available.
1685 * </ul>
1686 *
1687 * <p class="note">This is a protected intent that can only be sent
1688 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001689 */
1690 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001691 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001692 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001693
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001694 /**
1695 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001696 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001697 * This should <em>only</em> be used to determine when the wallpaper
1698 * has changed to show the new wallpaper to the user. You should certainly
1699 * never, in response to this, change the wallpaper or other attributes of
1700 * it such as the suggested size. That would be crazy, right? You'd cause
1701 * all kinds of loops, especially if other apps are doing similar things,
1702 * right? Of course. So please don't do this.
1703 *
1704 * @deprecated Modern applications should use
1705 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1706 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1707 * shown behind their UI, rather than watching for this broadcast and
1708 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001709 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001710 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001711 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1712 /**
1713 * Broadcast Action: The current device {@link android.content.res.Configuration}
1714 * (orientation, locale, etc) has changed. When such a change happens, the
1715 * UIs (view hierarchy) will need to be rebuilt based on this new
1716 * information; for the most part, applications don't need to worry about
1717 * this, because the system will take care of stopping and restarting the
1718 * application to make sure it sees the new changes. Some system code that
1719 * can not be restarted will need to watch for this action and handle it
1720 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001721 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001722 * <p class="note">
1723 * You can <em>not</em> receive this through components declared
1724 * in manifests, only by explicitly registering for it with
1725 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1726 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001727 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001728 * <p class="note">This is a protected intent that can only be sent
1729 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001730 *
1731 * @see android.content.res.Configuration
1732 */
1733 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1734 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1735 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001736 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001737 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001738 * <p class="note">This is a protected intent that can only be sent
1739 * by the system.
1740 */
1741 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1742 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1743 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001744 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1745 * charging state, level, and other information about the battery.
1746 * See {@link android.os.BatteryManager} for documentation on the
1747 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001748 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001749 * <p class="note">
1750 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001751 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001752 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001753 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1754 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1755 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1756 * broadcasts that are sent and can be received through manifest
1757 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001758 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001759 * <p class="note">This is a protected intent that can only be sent
1760 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001761 */
1762 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1763 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1764 /**
1765 * Broadcast Action: Indicates low battery condition on the device.
1766 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001767 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001768 * <p class="note">This is a protected intent that can only be sent
1769 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001770 */
1771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1772 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1773 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001774 * Broadcast Action: Indicates the battery is now okay after being low.
1775 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1776 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001777 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001778 * <p class="note">This is a protected intent that can only be sent
1779 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001780 */
1781 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1782 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1783 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001784 * Broadcast Action: External power has been connected to the device.
1785 * This is intended for applications that wish to register specifically to this notification.
1786 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1787 * stay active to receive this notification. This action can be used to implement actions
1788 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001789 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001790 * <p class="note">This is a protected intent that can only be sent
1791 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001792 */
1793 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001794 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001795 /**
1796 * Broadcast Action: External power has been removed from the device.
1797 * This is intended for applications that wish to register specifically to this notification.
1798 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1799 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001800 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001801 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001802 * <p class="note">This is a protected intent that can only be sent
1803 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001804 */
1805 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001806 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001807 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001808 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001809 * Broadcast Action: Device is shutting down.
1810 * This is broadcast when the device is being shut down (completely turned
1811 * off, not sleeping). Once the broadcast is complete, the final shutdown
1812 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001813 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001814 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001815 * <p class="note">This is a protected intent that can only be sent
1816 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001817 */
1818 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001819 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001820 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001821 * Activity Action: Start this activity to request system shutdown.
1822 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1823 * to request confirmation from the user before shutting down.
1824 *
1825 * <p class="note">This is a protected intent that can only be sent
1826 * by the system.
1827 *
1828 * {@hide}
1829 */
1830 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1831 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001832 * Broadcast Action: A sticky broadcast that indicates low memory
1833 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001834 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001835 * <p class="note">This is a protected intent that can only be sent
1836 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001837 */
1838 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1839 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1840 /**
1841 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001842 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001843 * <p class="note">This is a protected intent that can only be sent
1844 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001845 */
1846 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1847 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1848 /**
Jake Hambybb371632010-08-23 18:16:48 -07001849 * Broadcast Action: A sticky broadcast that indicates a memory full
1850 * condition on the device. This is intended for activities that want
1851 * to be able to fill the data partition completely, leaving only
1852 * enough free space to prevent system-wide SQLite failures.
1853 *
1854 * <p class="note">This is a protected intent that can only be sent
1855 * by the system.
1856 *
1857 * {@hide}
1858 */
1859 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1860 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1861 /**
1862 * Broadcast Action: Indicates memory full condition on the device
1863 * no longer exists.
1864 *
1865 * <p class="note">This is a protected intent that can only be sent
1866 * by the system.
1867 *
1868 * {@hide}
1869 */
1870 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1871 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1872 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001873 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1874 * and package management should be started.
1875 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1876 * notification.
1877 */
1878 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1879 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1880 /**
1881 * Broadcast Action: The device has entered USB Mass Storage mode.
1882 * This is used mainly for the USB Settings panel.
1883 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1884 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001885 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001886 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001887 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001888 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1889
1890 /**
1891 * Broadcast Action: The device has exited USB Mass Storage mode.
1892 * This is used mainly for the USB Settings panel.
1893 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1894 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001895 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001896 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001897 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001898 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1899
1900 /**
1901 * Broadcast Action: External media has been removed.
1902 * The path to the mount point for the removed media is contained in the Intent.mData field.
1903 */
1904 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1905 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1906
1907 /**
1908 * Broadcast Action: External media is present, but not mounted at its mount point.
1909 * The path to the mount point for the removed media is contained in the Intent.mData field.
1910 */
1911 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1912 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1913
1914 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001915 * Broadcast Action: External media is present, and being disk-checked
1916 * 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 -08001917 */
1918 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1919 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
1920
1921 /**
1922 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
1923 * 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 -08001924 */
1925 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1926 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
1927
1928 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001929 * Broadcast Action: External media is present and mounted at its mount point.
1930 * The path to the mount point for the removed media is contained in the Intent.mData field.
1931 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
1932 * media was mounted read only.
1933 */
1934 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1935 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
1936
1937 /**
1938 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001939 * 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 -07001940 */
1941 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1942 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
1943
1944 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05001945 * Broadcast Action: External media is no longer being shared via USB mass storage.
1946 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
1947 *
1948 * @hide
1949 */
1950 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
1951
1952 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001953 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
1954 * The path to the mount point for the removed media is contained in the Intent.mData field.
1955 */
1956 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1957 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
1958
1959 /**
1960 * Broadcast Action: External media is present but cannot be mounted.
1961 * The path to the mount point for the removed media is contained in the Intent.mData field.
1962 */
1963 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1964 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
1965
1966 /**
1967 * Broadcast Action: User has expressed the desire to remove the external storage media.
1968 * Applications should close all files they have open within the mount point when they receive this intent.
1969 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
1970 */
1971 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1972 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
1973
1974 /**
1975 * Broadcast Action: The media scanner has started scanning a directory.
1976 * The path to the directory being scanned is contained in the Intent.mData field.
1977 */
1978 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1979 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
1980
1981 /**
1982 * Broadcast Action: The media scanner has finished scanning a directory.
1983 * The path to the scanned directory is contained in the Intent.mData field.
1984 */
1985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1986 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
1987
1988 /**
1989 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
1990 * The path to the file is contained in the Intent.mData field.
1991 */
1992 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1993 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
1994
1995 /**
1996 * Broadcast Action: The "Media Button" was pressed. Includes a single
1997 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
1998 * caused the broadcast.
1999 */
2000 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2001 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2002
2003 /**
2004 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2005 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2006 * caused the broadcast.
2007 */
2008 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2009 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2010
2011 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2012 // location; they are not general-purpose actions.
2013
2014 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002015 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002016 */
2017 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2018 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2019 "android.intent.action.GTALK_CONNECTED";
2020
2021 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002022 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002023 */
2024 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2025 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2026 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002027
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002028 /**
2029 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002030 */
2031 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2032 public static final String ACTION_INPUT_METHOD_CHANGED =
2033 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002034
2035 /**
2036 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2037 * more radios have been turned off or on. The intent will have the following extra value:</p>
2038 * <ul>
2039 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2040 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2041 * turned off</li>
2042 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002043 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002044 * <p class="note">This is a protected intent that can only be sent
2045 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002046 */
2047 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2048 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2049
2050 /**
2051 * Broadcast Action: Some content providers have parts of their namespace
2052 * where they publish new events or items that the user may be especially
2053 * interested in. For these things, they may broadcast this action when the
2054 * set of interesting items change.
2055 *
2056 * For example, GmailProvider sends this notification when the set of unread
2057 * mail in the inbox changes.
2058 *
2059 * <p>The data of the intent identifies which part of which provider
2060 * changed. When queried through the content resolver, the data URI will
2061 * return the data set in question.
2062 *
2063 * <p>The intent will have the following extra values:
2064 * <ul>
2065 * <li><em>count</em> - The number of items in the data set. This is the
2066 * same as the number of items in the cursor returned by querying the
2067 * data URI. </li>
2068 * </ul>
2069 *
2070 * This intent will be sent at boot (if the count is non-zero) and when the
2071 * data set changes. It is possible for the data set to change without the
2072 * count changing (for example, if a new unread message arrives in the same
2073 * sync operation in which a message is archived). The phone should still
2074 * ring/vibrate/etc as normal in this case.
2075 */
2076 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2077 public static final String ACTION_PROVIDER_CHANGED =
2078 "android.intent.action.PROVIDER_CHANGED";
2079
2080 /**
2081 * Broadcast Action: Wired Headset plugged in or unplugged.
2082 *
2083 * <p>The intent will have the following extra values:
2084 * <ul>
2085 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2086 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002087 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002088 * </ul>
2089 * </ul>
2090 */
2091 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2092 public static final String ACTION_HEADSET_PLUG =
2093 "android.intent.action.HEADSET_PLUG";
2094
2095 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002096 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2097 *
2098 * <p>The intent will have the following extra values:
2099 * <ul>
2100 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2101 * <li><em>name</em> - Headset type, human readable string </li>
2102 * </ul>
2103 * </ul>
2104 * @hide
2105 */
2106 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002107 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2108 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002109
2110 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002111 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002112 *
2113 * <p>The intent will have the following extra values:
2114 * <ul>
2115 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2116 * <li><em>name</em> - Headset type, human readable string </li>
2117 * </ul>
2118 * </ul>
2119 * @hide
2120 */
2121 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002122 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2123 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002124
2125 /**
2126 * Broadcast Action: A HMDI cable was plugged or unplugged
2127 *
2128 * <p>The intent will have the following extra values:
2129 * <ul>
2130 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2131 * <li><em>name</em> - HDMI cable, human readable string </li>
2132 * </ul>
2133 * </ul>
2134 * @hide
2135 */
2136 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2137 public static final String ACTION_HDMI_AUDIO_PLUG =
2138 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002139
2140 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002141 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2142 *
2143 * <p>The intent will have the following extra values:
2144 * <ul>
2145 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2146 * <li><em>card</em> - ALSA card number (integer) </li>
2147 * <li><em>device</em> - ALSA device number (integer) </li>
2148 * </ul>
2149 * </ul>
2150 * @hide
2151 */
2152 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2153 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2154 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2155
2156 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002157 * Broadcast Action: A USB audio device was plugged in or unplugged.
2158 *
2159 * <p>The intent will have the following extra values:
2160 * <ul>
2161 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2162 * <li><em>card</em> - ALSA card number (integer) </li>
2163 * <li><em>device</em> - ALSA device number (integer) </li>
2164 * </ul>
2165 * </ul>
2166 * @hide
2167 */
2168 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2169 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2170 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2171
2172 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002173 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2174 * <ul>
2175 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2176 * </ul>
2177 *
2178 * <p class="note">This is a protected intent that can only be sent
2179 * by the system.
2180 *
2181 * @hide
2182 */
2183 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2184 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2185 = "android.intent.action.ADVANCED_SETTINGS";
2186
2187 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002188 * Broadcast Action: An outgoing call is about to be placed.
2189 *
2190 * <p>The Intent will have the following extra value:
2191 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002192 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002193 * the phone number originally intended to be dialed.</li>
2194 * </ul>
2195 * <p>Once the broadcast is finished, the resultData is used as the actual
2196 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002197 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002198 * outgoing call in turn: for example, a parental control application
2199 * might verify that the user is authorized to place the call at that
2200 * time, then a number-rewriting application might add an area code if
2201 * one was not specified.</p>
2202 * <p>For consistency, any receiver whose purpose is to prohibit phone
2203 * calls should have a priority of 0, to ensure it will see the final
2204 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002205 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002206 * should have a positive priority.
2207 * Negative priorities are reserved for the system for this broadcast;
2208 * using them may cause problems.</p>
2209 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2210 * abort the broadcast.</p>
2211 * <p>Emergency calls cannot be intercepted using this mechanism, and
2212 * other calls cannot be modified to call emergency numbers using this
2213 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002214 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002215 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2216 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002217 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002218 * <p class="note">This is a protected intent that can only be sent
2219 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002220 */
2221 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2222 public static final String ACTION_NEW_OUTGOING_CALL =
2223 "android.intent.action.NEW_OUTGOING_CALL";
2224
2225 /**
2226 * Broadcast Action: Have the device reboot. This is only for use by
2227 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002228 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002229 * <p class="note">This is a protected intent that can only be sent
2230 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002231 */
2232 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2233 public static final String ACTION_REBOOT =
2234 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002235
Wei Huang97ecc9c2009-05-11 17:44:20 -07002236 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002237 * Broadcast Action: A sticky broadcast for changes in the physical
2238 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002239 *
2240 * <p>The intent will have the following extra values:
2241 * <ul>
2242 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002243 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002244 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002245 * <p>This is intended for monitoring the current physical dock state.
2246 * See {@link android.app.UiModeManager} for the normal API dealing with
2247 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002248 */
2249 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2250 public static final String ACTION_DOCK_EVENT =
2251 "android.intent.action.DOCK_EVENT";
2252
2253 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002254 * Broadcast Action: a remote intent is to be broadcasted.
2255 *
2256 * A remote intent is used for remote RPC between devices. The remote intent
2257 * is serialized and sent from one device to another device. The receiving
2258 * device parses the remote intent and broadcasts it. Note that anyone can
2259 * broadcast a remote intent. However, if the intent receiver of the remote intent
2260 * does not trust intent broadcasts from arbitrary intent senders, it should require
2261 * the sender to hold certain permissions so only trusted sender's broadcast will be
2262 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002263 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002264 */
2265 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002266 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002267
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002268 /**
2269 * Broadcast Action: hook for permforming cleanup after a system update.
2270 *
2271 * The broadcast is sent when the system is booting, before the
2272 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2273 * image. A receiver for this should do its work and then disable itself
2274 * so that it does not get run again at the next boot.
2275 * @hide
2276 */
2277 public static final String ACTION_PRE_BOOT_COMPLETED =
2278 "android.intent.action.PRE_BOOT_COMPLETED";
2279
Amith Yamasani13593602012-03-22 16:16:17 -07002280 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002281 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USER_HANDLE that has the
2282 * userHandle of the new user.
Amith Yamasani13593602012-03-22 16:16:17 -07002283 * @hide
2284 */
2285 public static final String ACTION_USER_ADDED =
2286 "android.intent.action.USER_ADDED";
2287
2288 /**
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002289 * Broadcast sent to the system when a user is stopped. Carries an extra EXTRA_USER_HANDLE that has
2290 * the userHandle of the user. This is similar to {@link #ACTION_PACKAGE_RESTARTED},
2291 * but for an entire user instead of a specific package.
2292 * @hide
2293 */
2294 public static final String ACTION_USER_STOPPED =
2295 "android.intent.action.USER_STOPPED";
2296
2297 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002298 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
2299 * the userHandle of the user.
Amith Yamasani13593602012-03-22 16:16:17 -07002300 * @hide
2301 */
2302 public static final String ACTION_USER_REMOVED =
2303 "android.intent.action.USER_REMOVED";
2304
2305 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002306 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
2307 * the userHandle of the user to become the current one.
Amith Yamasani13593602012-03-22 16:16:17 -07002308 * @hide
2309 */
2310 public static final String ACTION_USER_SWITCHED =
2311 "android.intent.action.USER_SWITCHED";
2312
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002313 // ---------------------------------------------------------------------
2314 // ---------------------------------------------------------------------
2315 // Standard intent categories (see addCategory()).
2316
2317 /**
2318 * Set if the activity should be an option for the default action
2319 * (center press) to perform on a piece of data. Setting this will
2320 * hide from the user any activities without it set when performing an
2321 * action on some data. Note that this is normal -not- set in the
2322 * Intent when initiating an action -- it is for use in intent filters
2323 * specified in packages.
2324 */
2325 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2326 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2327 /**
2328 * Activities that can be safely invoked from a browser must support this
2329 * category. For example, if the user is viewing a web page or an e-mail
2330 * and clicks on a link in the text, the Intent generated execute that
2331 * link will require the BROWSABLE category, so that only activities
2332 * supporting this category will be considered as possible actions. By
2333 * supporting this category, you are promising that there is nothing
2334 * damaging (without user intervention) that can happen by invoking any
2335 * matching Intent.
2336 */
2337 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2338 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2339 /**
2340 * Set if the activity should be considered as an alternative action to
2341 * the data the user is currently viewing. See also
2342 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2343 * applies to the selection in a list of items.
2344 *
2345 * <p>Supporting this category means that you would like your activity to be
2346 * displayed in the set of alternative things the user can do, usually as
2347 * part of the current activity's options menu. You will usually want to
2348 * include a specific label in the &lt;intent-filter&gt; of this action
2349 * describing to the user what it does.
2350 *
2351 * <p>The action of IntentFilter with this category is important in that it
2352 * describes the specific action the target will perform. This generally
2353 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2354 * a specific name such as "com.android.camera.action.CROP. Only one
2355 * alternative of any particular action will be shown to the user, so using
2356 * a specific action like this makes sure that your alternative will be
2357 * displayed while also allowing other applications to provide their own
2358 * overrides of that particular action.
2359 */
2360 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2361 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2362 /**
2363 * Set if the activity should be considered as an alternative selection
2364 * action to the data the user has currently selected. This is like
2365 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2366 * of items from which the user can select, giving them alternatives to the
2367 * default action that will be performed on it.
2368 */
2369 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2370 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2371 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002372 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002373 */
2374 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2375 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2376 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002377 * Should be displayed in the top-level launcher.
2378 */
2379 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2380 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2381 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002382 * Provides information about the package it is in; typically used if
2383 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2384 * a front-door to the user without having to be shown in the all apps list.
2385 */
2386 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2387 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2388 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002389 * This is the home activity, that is the first activity that is displayed
2390 * when the device boots.
2391 */
2392 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2393 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2394 /**
2395 * This activity is a preference panel.
2396 */
2397 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2398 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2399 /**
2400 * This activity is a development preference panel.
2401 */
2402 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2403 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2404 /**
2405 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002406 */
2407 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2408 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2409 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002410 * This activity allows the user to browse and download new applications.
2411 */
2412 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2413 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2414 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002415 * This activity may be exercised by the monkey or other automated test tools.
2416 */
2417 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2418 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2419 /**
2420 * To be used as a test (not part of the normal user experience).
2421 */
2422 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2423 /**
2424 * To be used as a unit test (run through the Test Harness).
2425 */
2426 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2427 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002428 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002429 * experience).
2430 */
2431 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2432 /**
2433 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2434 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2435 * when queried, though it is allowable for those columns to be blank.
2436 */
2437 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2438 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2439
2440 /**
2441 * To be used as code under test for framework instrumentation tests.
2442 */
2443 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2444 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002445 /**
2446 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002447 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2448 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002449 */
2450 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2451 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2452 /**
2453 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002454 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2455 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002456 */
2457 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2458 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002459 /**
2460 * An activity to run when device is inserted into a analog (low end) dock.
2461 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2462 * information, see {@link android.app.UiModeManager}.
2463 */
2464 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2465 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2466
2467 /**
2468 * An activity to run when device is inserted into a digital (high end) dock.
2469 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2470 * information, see {@link android.app.UiModeManager}.
2471 */
2472 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2473 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002474
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002475 /**
2476 * Used to indicate that the activity can be used in a car environment.
2477 */
2478 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2479 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2480
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002481 // ---------------------------------------------------------------------
2482 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002483 // Application launch intent categories (see addCategory()).
2484
2485 /**
2486 * Used with {@link #ACTION_MAIN} to launch the browser application.
2487 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002488 * <p>NOTE: This should not be used as the primary key of an Intent,
2489 * since it will not result in the app launching with the correct
2490 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002491 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002492 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002493 */
2494 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2495 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2496
2497 /**
2498 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2499 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002500 * <p>NOTE: This should not be used as the primary key of an Intent,
2501 * since it will not result in the app launching with the correct
2502 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002503 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002504 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002505 */
2506 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2507 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2508
2509 /**
2510 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2511 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002512 * <p>NOTE: This should not be used as the primary key of an Intent,
2513 * since it will not result in the app launching with the correct
2514 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002515 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002516 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002517 */
2518 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2519 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2520
2521 /**
2522 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2523 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002524 * <p>NOTE: This should not be used as the primary key of an Intent,
2525 * since it will not result in the app launching with the correct
2526 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002527 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002528 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002529 */
2530 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2531 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2532
2533 /**
2534 * Used with {@link #ACTION_MAIN} to launch the email application.
2535 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002536 * <p>NOTE: This should not be used as the primary key of an Intent,
2537 * since it will not result in the app launching with the correct
2538 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002539 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002540 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002541 */
2542 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2543 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2544
2545 /**
2546 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2547 * The activity should be able to view and manipulate image and video files
2548 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002549 * <p>NOTE: This should not be used as the primary key of an Intent,
2550 * since it will not result in the app launching with the correct
2551 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002552 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002553 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002554 */
2555 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2556 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2557
2558 /**
2559 * Used with {@link #ACTION_MAIN} to launch the maps application.
2560 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002561 * <p>NOTE: This should not be used as the primary key of an Intent,
2562 * since it will not result in the app launching with the correct
2563 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002564 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002565 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002566 */
2567 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2568 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2569
2570 /**
2571 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2572 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002573 * <p>NOTE: This should not be used as the primary key of an Intent,
2574 * since it will not result in the app launching with the correct
2575 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002576 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002577 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002578 */
2579 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2580 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2581
2582 /**
2583 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002584 * The activity should be able to play, browse, or manipulate music files
2585 * stored on the device.
2586 * <p>NOTE: This should not be used as the primary key of an Intent,
2587 * since it will not result in the app launching with the correct
2588 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002589 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002590 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002591 */
2592 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2593 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2594
2595 // ---------------------------------------------------------------------
2596 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002597 // Standard extra data keys.
2598
2599 /**
2600 * The initial data to place in a newly created record. Use with
2601 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2602 * fields as would be given to the underlying ContentProvider.insert()
2603 * call.
2604 */
2605 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2606
2607 /**
2608 * A constant CharSequence that is associated with the Intent, used with
2609 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2610 * this may be a styled CharSequence, so you must use
2611 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2612 * retrieve it.
2613 */
2614 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2615
2616 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002617 * A constant String that is associated with the Intent, used with
2618 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2619 * as HTML formatted text. Note that you <em>must</em> also supply
2620 * {@link #EXTRA_TEXT}.
2621 */
2622 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2623
2624 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002625 * A content: URI holding a stream of data associated with the Intent,
2626 * used with {@link #ACTION_SEND} to supply the data being sent.
2627 */
2628 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2629
2630 /**
2631 * A String[] holding e-mail addresses that should be delivered to.
2632 */
2633 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2634
2635 /**
2636 * A String[] holding e-mail addresses that should be carbon copied.
2637 */
2638 public static final String EXTRA_CC = "android.intent.extra.CC";
2639
2640 /**
2641 * A String[] holding e-mail addresses that should be blind carbon copied.
2642 */
2643 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2644
2645 /**
2646 * A constant string holding the desired subject line of a message.
2647 */
2648 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2649
2650 /**
2651 * An Intent describing the choices you would like shown with
2652 * {@link #ACTION_PICK_ACTIVITY}.
2653 */
2654 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2655
2656 /**
2657 * A CharSequence dialog title to provide to the user when used with a
2658 * {@link #ACTION_CHOOSER}.
2659 */
2660 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2661
2662 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002663 * A Parcelable[] of {@link Intent} or
2664 * {@link android.content.pm.LabeledIntent} objects as set with
2665 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2666 * a the front of the list of choices, when shown to the user with a
2667 * {@link #ACTION_CHOOSER}.
2668 */
2669 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2670
2671 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002672 * A {@link android.view.KeyEvent} object containing the event that
2673 * triggered the creation of the Intent it is in.
2674 */
2675 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2676
2677 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002678 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2679 * before shutting down.
2680 *
2681 * {@hide}
2682 */
2683 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2684
2685 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002686 * 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 -07002687 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2688 * of restarting the application.
2689 */
2690 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2691
2692 /**
2693 * A String holding the phone number originally entered in
2694 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2695 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2696 */
2697 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002698
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002699 /**
2700 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2701 * intents to supply the uid the package had been assigned. Also an optional
2702 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2703 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2704 * purpose.
2705 */
2706 public static final String EXTRA_UID = "android.intent.extra.UID";
2707
2708 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002709 * @hide String array of package names.
2710 */
2711 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2712
2713 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002714 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2715 * intents to indicate whether this represents a full uninstall (removing
2716 * both the code and its data) or a partial uninstall (leaving its data,
2717 * implying that this is an update).
2718 */
2719 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002720
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002721 /**
2722 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2723 * intents to indicate that this is a replacement of the package, so this
2724 * broadcast will immediately be followed by an add broadcast for a
2725 * different version of the same package.
2726 */
2727 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002728
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002729 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002730 * Used as an int extra field in {@link android.app.AlarmManager} intents
2731 * to tell the application being invoked how many pending alarms are being
2732 * delievered with the intent. For one-shot alarms this will always be 1.
2733 * For recurring alarms, this might be greater than 1 if the device was
2734 * asleep or powered off at the time an earlier alarm would have been
2735 * delivered.
2736 */
2737 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002738
Jacek Surazski86b6c532009-05-13 14:38:28 +02002739 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002740 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2741 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002742 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2743 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002744 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2745 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2746 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002747 */
2748 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2749
2750 /**
2751 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2752 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002753 */
2754 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2755
2756 /**
2757 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2758 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002759 */
2760 public static final int EXTRA_DOCK_STATE_DESK = 1;
2761
2762 /**
2763 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2764 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002765 */
2766 public static final int EXTRA_DOCK_STATE_CAR = 2;
2767
2768 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002769 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2770 * to represent that the phone is in a analog (low end) dock.
2771 */
2772 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2773
2774 /**
2775 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2776 * to represent that the phone is in a digital (high end) dock.
2777 */
2778 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2779
2780 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002781 * Boolean that can be supplied as meta-data with a dock activity, to
2782 * indicate that the dock should take over the home key when it is active.
2783 */
2784 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002785
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002786 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002787 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2788 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002789 */
2790 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2791
2792 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002793 * Used in the extra field in the remote intent. It's astring token passed with the
2794 * remote intent.
2795 */
2796 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2797 "android.intent.extra.remote_intent_token";
2798
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002799 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002800 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002801 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002802 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002803 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002804 "android.intent.extra.changed_component_name";
2805
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002806 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002807 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002808 * and contains a string array of all of the components that have changed.
2809 */
2810 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2811 "android.intent.extra.changed_component_name_list";
2812
2813 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002814 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002815 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2816 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002817 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002818 */
2819 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2820 "android.intent.extra.changed_package_list";
2821
2822 /**
2823 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002824 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2825 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002826 * and contains an integer array of uids of all of the components
2827 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002828 */
2829 public static final String EXTRA_CHANGED_UID_LIST =
2830 "android.intent.extra.changed_uid_list";
2831
2832 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002833 * @hide
2834 * Magic extra system code can use when binding, to give a label for
2835 * who it is that has bound to a service. This is an integer giving
2836 * a framework string resource that can be displayed to the user.
2837 */
2838 public static final String EXTRA_CLIENT_LABEL =
2839 "android.intent.extra.client_label";
2840
2841 /**
2842 * @hide
2843 * Magic extra system code can use when binding, to give a PendingIntent object
2844 * that can be launched for the user to disable the system's use of this
2845 * service.
2846 */
2847 public static final String EXTRA_CLIENT_INTENT =
2848 "android.intent.extra.client_intent";
2849
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002850 /**
2851 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2852 * data that is on the local device. This is a boolean extra; the default
2853 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2854 * the user to select media that is already on the device, not requiring it
2855 * be downloaded from a remote service when opened. Another way to look
2856 * at it is that such content should generally have a "_data" column to the
2857 * path of the content on local external storage.
2858 */
2859 public static final String EXTRA_LOCAL_ONLY =
2860 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002861
Amith Yamasani13593602012-03-22 16:16:17 -07002862 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002863 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07002864 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2865 * @hide
2866 */
Amith Yamasani2a003292012-08-14 18:25:45 -07002867 public static final String EXTRA_USER_HANDLE =
2868 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07002869
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002870 // ---------------------------------------------------------------------
2871 // ---------------------------------------------------------------------
2872 // Intent flags (see mFlags variable).
2873
2874 /**
2875 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002876 * perform read operations on the Uri in the Intent's data and any URIs
2877 * specified in its ClipData. When applying to an Intent's ClipData,
2878 * all URIs as well as recursive traversals through data or other ClipData
2879 * in Intent items will be granted; only the grant flags of the top-level
2880 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002881 */
2882 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2883 /**
2884 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002885 * perform write operations on the Uri in the Intent's data and any URIs
2886 * specified in its ClipData. When applying to an Intent's ClipData,
2887 * all URIs as well as recursive traversals through data or other ClipData
2888 * in Intent items will be granted; only the grant flags of the top-level
2889 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002890 */
2891 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2892 /**
2893 * Can be set by the caller to indicate that this Intent is coming from
2894 * a background operation, not from direct user interaction.
2895 */
2896 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2897 /**
2898 * A flag you can enable for debugging: when set, log messages will be
2899 * printed during the resolution of this intent to show you what has
2900 * been found to create the final resolved list.
2901 */
2902 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002903 /**
2904 * If set, this intent will not match any components in packages that
2905 * are currently stopped. If this is not set, then the default behavior
2906 * is to include such applications in the result.
2907 */
2908 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2909 /**
2910 * If set, this intent will always match any components in packages that
2911 * are currently stopped. This is the default behavior when
2912 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2913 * flags are set, this one wins (it allows overriding of exclude for
2914 * places where the framework may automatically set the exclude flag).
2915 */
2916 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002917
2918 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002919 * If set, the new activity is not kept in the history stack. As soon as
2920 * the user navigates away from it, the activity is finished. This may also
2921 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2922 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002923 */
2924 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2925 /**
2926 * If set, the activity will not be launched if it is already running
2927 * at the top of the history stack.
2928 */
2929 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2930 /**
2931 * If set, this activity will become the start of a new task on this
2932 * history stack. A task (from the activity that started it to the
2933 * next task activity) defines an atomic group of activities that the
2934 * user can move to. Tasks can be moved to the foreground and background;
2935 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002936 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002937 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2938 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002939 *
2940 * <p>This flag is generally used by activities that want
2941 * to present a "launcher" style behavior: they give the user a list of
2942 * separate things that can be done, which otherwise run completely
2943 * independently of the activity launching them.
2944 *
2945 * <p>When using this flag, if a task is already running for the activity
2946 * you are now starting, then a new activity will not be started; instead,
2947 * the current task will simply be brought to the front of the screen with
2948 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2949 * to disable this behavior.
2950 *
2951 * <p>This flag can not be used when the caller is requesting a result from
2952 * the activity being launched.
2953 */
2954 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2955 /**
2956 * <strong>Do not use this flag unless you are implementing your own
2957 * top-level application launcher.</strong> Used in conjunction with
2958 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2959 * behavior of bringing an existing task to the foreground. When set,
2960 * a new task is <em>always</em> started to host the Activity for the
2961 * Intent, regardless of whether there is already an existing task running
2962 * the same thing.
2963 *
2964 * <p><strong>Because the default system does not include graphical task management,
2965 * you should not use this flag unless you provide some way for a user to
2966 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002967 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002968 * <p>This flag is ignored if
2969 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2970 *
Scott Main7aee61f2011-02-08 11:25:01 -08002971 * <p>See
2972 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2973 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002974 */
2975 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2976 /**
2977 * If set, and the activity being launched is already running in the
2978 * current task, then instead of launching a new instance of that activity,
2979 * all of the other activities on top of it will be closed and this Intent
2980 * will be delivered to the (now on top) old activity as a new Intent.
2981 *
2982 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2983 * If D calls startActivity() with an Intent that resolves to the component
2984 * of activity B, then C and D will be finished and B receive the given
2985 * Intent, resulting in the stack now being: A, B.
2986 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002987 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002988 * either receive the new intent you are starting here in its
2989 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002990 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002991 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2992 * the same intent, then it will be finished and re-created; for all other
2993 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2994 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002995 *
2996 * <p>This launch mode can also be used to good effect in conjunction with
2997 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2998 * of a task, it will bring any currently running instance of that task
2999 * to the foreground, and then clear it to its root state. This is
3000 * especially useful, for example, when launching an activity from the
3001 * notification manager.
3002 *
Scott Main7aee61f2011-02-08 11:25:01 -08003003 * <p>See
3004 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3005 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003006 */
3007 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3008 /**
3009 * If set and this intent is being used to launch a new activity from an
3010 * existing one, then the reply target of the existing activity will be
3011 * transfered to the new activity. This way the new activity can call
3012 * {@link android.app.Activity#setResult} and have that result sent back to
3013 * the reply target of the original activity.
3014 */
3015 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3016 /**
3017 * If set and this intent is being used to launch a new activity from an
3018 * existing one, the current activity will not be counted as the top
3019 * activity for deciding whether the new intent should be delivered to
3020 * the top instead of starting a new one. The previous activity will
3021 * be used as the top, with the assumption being that the current activity
3022 * will finish itself immediately.
3023 */
3024 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3025 /**
3026 * If set, the new activity is not kept in the list of recently launched
3027 * activities.
3028 */
3029 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3030 /**
3031 * This flag is not normally set by application code, but set for you by
3032 * the system as described in the
3033 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3034 * launchMode} documentation for the singleTask mode.
3035 */
3036 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3037 /**
3038 * If set, and this activity is either being started in a new task or
3039 * bringing to the top an existing task, then it will be launched as
3040 * the front door of the task. This will result in the application of
3041 * any affinities needed to have that task in the proper state (either
3042 * moving activities to or from it), or simply resetting that task to
3043 * its initial state if needed.
3044 */
3045 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3046 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003047 * This flag is not normally set by application code, but set for you by
3048 * the system if this activity is being launched from history
3049 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003050 */
3051 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003052 /**
3053 * If set, this marks a point in the task's activity stack that should
3054 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003055 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003056 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3057 * the user re-launching it from home), this activity and all on top of
3058 * it will be finished so that the user does not return to them, but
3059 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003060 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003061 * <p>This is useful for cases where you have a logical break in your
3062 * application. For example, an e-mail application may have a command
3063 * to view an attachment, which launches an image view activity to
3064 * display it. This activity should be part of the e-mail application's
3065 * task, since it is a part of the task the user is involved in. However,
3066 * if the user leaves that task, and later selects the e-mail app from
3067 * home, we may like them to return to the conversation they were
3068 * viewing, not the picture attachment, since that is confusing. By
3069 * setting this flag when launching the image viewer, that viewer and
3070 * any activities it starts will be removed the next time the user returns
3071 * to mail.
3072 */
3073 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003074 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003075 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003076 * callback from occurring on the current frontmost activity before it is
3077 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003078 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003079 * <p>Typically, an activity can rely on that callback to indicate that an
3080 * explicit user action has caused their activity to be moved out of the
3081 * foreground. The callback marks an appropriate point in the activity's
3082 * lifecycle for it to dismiss any notifications that it intends to display
3083 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003084 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003085 * <p>If an activity is ever started via any non-user-driven events such as
3086 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3087 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003088 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003089 */
3090 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003091 /**
3092 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3093 * this flag will cause the launched activity to be brought to the front of its
3094 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003095 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003096 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3097 * If D calls startActivity() with an Intent that resolves to the component
3098 * of activity B, then B will be brought to the front of the history stack,
3099 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003100 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003101 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003102 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003103 */
3104 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003105 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003106 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3107 * this flag will prevent the system from applying an activity transition
3108 * animation to go to the next activity state. This doesn't mean an
3109 * animation will never run -- if another activity change happens that doesn't
3110 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003111 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003112 * when you are going to do a series of activity operations but the
3113 * animation seen by the user shouldn't be driven by the first activity
3114 * change but rather a later one.
3115 */
3116 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3117 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003118 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3119 * this flag will cause any existing task that would be associated with the
3120 * activity to be cleared before the activity is started. That is, the activity
3121 * becomes the new root of an otherwise empty task, and any old activities
3122 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3123 */
3124 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3125 /**
3126 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3127 * this flag will cause a newly launching task to be placed on top of the current
3128 * home activity task (if there is one). That is, pressing back from the task
3129 * will always return the user to home even if that was not the last activity they
3130 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3131 */
3132 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3133 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003134 * If set, when sending a broadcast only registered receivers will be
3135 * called -- no BroadcastReceiver components will be launched.
3136 */
3137 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003138 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003139 * If set, when sending a broadcast the new broadcast will replace
3140 * any existing pending broadcast that matches it. Matching is defined
3141 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3142 * true for the intents of the two broadcasts. When a match is found,
3143 * the new broadcast (and receivers associated with it) will replace the
3144 * existing one in the pending broadcast list, remaining at the same
3145 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003146 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003147 * <p>This flag is most typically used with sticky broadcasts, which
3148 * only care about delivering the most recent values of the broadcast
3149 * to their receivers.
3150 */
3151 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3152 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003153 * If set, when sending a broadcast the recipient is allowed to run at
3154 * foreground priority, with a shorter timeout interval. During normal
3155 * broadcasts the receivers are not automatically hoisted out of the
3156 * background priority class.
3157 */
3158 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3159 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003160 * If set, when sending a broadcast <i>before boot has completed</i> only
3161 * registered receivers will be called -- no BroadcastReceiver components
3162 * will be launched. Sticky intent state will be recorded properly even
3163 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3164 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003165 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003166 * <p>This flag is only for use by system sevices as a convenience to
3167 * avoid having to implement a more complex mechanism around detection
3168 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003169 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003170 * @hide
3171 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003172 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003173 /**
3174 * Set when this broadcast is for a boot upgrade, a special mode that
3175 * allows the broadcast to be sent before the system is ready and launches
3176 * the app process with no providers running in it.
3177 * @hide
3178 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003179 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003180
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003181 /**
3182 * @hide Flags that can't be changed with PendingIntent.
3183 */
3184 public static final int IMMUTABLE_FLAGS =
3185 FLAG_GRANT_READ_URI_PERMISSION
3186 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003187
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003188 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003189 // ---------------------------------------------------------------------
3190 // toUri() and parseUri() options.
3191
3192 /**
3193 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3194 * always has the "intent:" scheme. This syntax can be used when you want
3195 * to later disambiguate between URIs that are intended to describe an
3196 * Intent vs. all others that should be treated as raw URIs. When used
3197 * with {@link #parseUri}, any other scheme will result in a generic
3198 * VIEW action for that raw URI.
3199 */
3200 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003201
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003202 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003203
3204 private String mAction;
3205 private Uri mData;
3206 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003207 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003208 private ComponentName mComponent;
3209 private int mFlags;
3210 private HashSet<String> mCategories;
3211 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003212 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003213 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003214 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003215
3216 // ---------------------------------------------------------------------
3217
3218 /**
3219 * Create an empty intent.
3220 */
3221 public Intent() {
3222 }
3223
3224 /**
3225 * Copy constructor.
3226 */
3227 public Intent(Intent o) {
3228 this.mAction = o.mAction;
3229 this.mData = o.mData;
3230 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003231 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003232 this.mComponent = o.mComponent;
3233 this.mFlags = o.mFlags;
3234 if (o.mCategories != null) {
3235 this.mCategories = new HashSet<String>(o.mCategories);
3236 }
3237 if (o.mExtras != null) {
3238 this.mExtras = new Bundle(o.mExtras);
3239 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003240 if (o.mSourceBounds != null) {
3241 this.mSourceBounds = new Rect(o.mSourceBounds);
3242 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003243 if (o.mSelector != null) {
3244 this.mSelector = new Intent(o.mSelector);
3245 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003246 if (o.mClipData != null) {
3247 this.mClipData = new ClipData(o.mClipData);
3248 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003249 }
3250
3251 @Override
3252 public Object clone() {
3253 return new Intent(this);
3254 }
3255
3256 private Intent(Intent o, boolean all) {
3257 this.mAction = o.mAction;
3258 this.mData = o.mData;
3259 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003260 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003261 this.mComponent = o.mComponent;
3262 if (o.mCategories != null) {
3263 this.mCategories = new HashSet<String>(o.mCategories);
3264 }
3265 }
3266
3267 /**
3268 * Make a clone of only the parts of the Intent that are relevant for
3269 * filter matching: the action, data, type, component, and categories.
3270 */
3271 public Intent cloneFilter() {
3272 return new Intent(this, false);
3273 }
3274
3275 /**
3276 * Create an intent with a given action. All other fields (data, type,
3277 * class) are null. Note that the action <em>must</em> be in a
3278 * namespace because Intents are used globally in the system -- for
3279 * example the system VIEW action is android.intent.action.VIEW; an
3280 * application's custom action would be something like
3281 * com.google.app.myapp.CUSTOM_ACTION.
3282 *
3283 * @param action The Intent action, such as ACTION_VIEW.
3284 */
3285 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003286 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003287 }
3288
3289 /**
3290 * Create an intent with a given action and for a given data url. Note
3291 * that the action <em>must</em> be in a namespace because Intents are
3292 * used globally in the system -- for example the system VIEW action is
3293 * android.intent.action.VIEW; an application's custom action would be
3294 * something like com.google.app.myapp.CUSTOM_ACTION.
3295 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003296 * <p><em>Note: scheme and host name matching in the Android framework is
3297 * case-sensitive, unlike the formal RFC. As a result,
3298 * you should always ensure that you write your Uri with these elements
3299 * using lower case letters, and normalize any Uris you receive from
3300 * outside of Android to ensure the scheme and host is lower case.</em></p>
3301 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003302 * @param action The Intent action, such as ACTION_VIEW.
3303 * @param uri The Intent data URI.
3304 */
3305 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003306 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003307 mData = uri;
3308 }
3309
3310 /**
3311 * Create an intent for a specific component. All other fields (action, data,
3312 * type, class) are null, though they can be modified later with explicit
3313 * calls. This provides a convenient way to create an intent that is
3314 * intended to execute a hard-coded class name, rather than relying on the
3315 * system to find an appropriate class for you; see {@link #setComponent}
3316 * for more information on the repercussions of this.
3317 *
3318 * @param packageContext A Context of the application package implementing
3319 * this class.
3320 * @param cls The component class that is to be used for the intent.
3321 *
3322 * @see #setClass
3323 * @see #setComponent
3324 * @see #Intent(String, android.net.Uri , Context, Class)
3325 */
3326 public Intent(Context packageContext, Class<?> cls) {
3327 mComponent = new ComponentName(packageContext, cls);
3328 }
3329
3330 /**
3331 * Create an intent for a specific component with a specified action and data.
3332 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3333 * construct the Intent and then calling {@link #setClass} to set its
3334 * class.
3335 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003336 * <p><em>Note: scheme and host name matching in the Android framework is
3337 * case-sensitive, unlike the formal RFC. As a result,
3338 * you should always ensure that you write your Uri with these elements
3339 * using lower case letters, and normalize any Uris you receive from
3340 * outside of Android to ensure the scheme and host is lower case.</em></p>
3341 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003342 * @param action The Intent action, such as ACTION_VIEW.
3343 * @param uri The Intent data URI.
3344 * @param packageContext A Context of the application package implementing
3345 * this class.
3346 * @param cls The component class that is to be used for the intent.
3347 *
3348 * @see #Intent(String, android.net.Uri)
3349 * @see #Intent(Context, Class)
3350 * @see #setClass
3351 * @see #setComponent
3352 */
3353 public Intent(String action, Uri uri,
3354 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003355 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003356 mData = uri;
3357 mComponent = new ComponentName(packageContext, cls);
3358 }
3359
3360 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003361 * Create an intent to launch the main (root) activity of a task. This
3362 * is the Intent that is started when the application's is launched from
3363 * Home. For anything else that wants to launch an application in the
3364 * same way, it is important that they use an Intent structured the same
3365 * way, and can use this function to ensure this is the case.
3366 *
3367 * <p>The returned Intent has the given Activity component as its explicit
3368 * component, {@link #ACTION_MAIN} as its action, and includes the
3369 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3370 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3371 * to do that through {@link #addFlags(int)} on the returned Intent.
3372 *
3373 * @param mainActivity The main activity component that this Intent will
3374 * launch.
3375 * @return Returns a newly created Intent that can be used to launch the
3376 * activity as a main application entry.
3377 *
3378 * @see #setClass
3379 * @see #setComponent
3380 */
3381 public static Intent makeMainActivity(ComponentName mainActivity) {
3382 Intent intent = new Intent(ACTION_MAIN);
3383 intent.setComponent(mainActivity);
3384 intent.addCategory(CATEGORY_LAUNCHER);
3385 return intent;
3386 }
3387
3388 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003389 * Make an Intent for the main activity of an application, without
3390 * specifying a specific activity to run but giving a selector to find
3391 * the activity. This results in a final Intent that is structured
3392 * the same as when the application is launched from
3393 * Home. For anything else that wants to launch an application in the
3394 * same way, it is important that they use an Intent structured the same
3395 * way, and can use this function to ensure this is the case.
3396 *
3397 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3398 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3399 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3400 * to do that through {@link #addFlags(int)} on the returned Intent.
3401 *
3402 * @param selectorAction The action name of the Intent's selector.
3403 * @param selectorCategory The name of a category to add to the Intent's
3404 * selector.
3405 * @return Returns a newly created Intent that can be used to launch the
3406 * activity as a main application entry.
3407 *
3408 * @see #setSelector(Intent)
3409 */
3410 public static Intent makeMainSelectorActivity(String selectorAction,
3411 String selectorCategory) {
3412 Intent intent = new Intent(ACTION_MAIN);
3413 intent.addCategory(CATEGORY_LAUNCHER);
3414 Intent selector = new Intent();
3415 selector.setAction(selectorAction);
3416 selector.addCategory(selectorCategory);
3417 intent.setSelector(selector);
3418 return intent;
3419 }
3420
3421 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003422 * Make an Intent that can be used to re-launch an application's task
3423 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3424 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3425 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3426 *
3427 * @param mainActivity The activity component that is the root of the
3428 * task; this is the activity that has been published in the application's
3429 * manifest as the main launcher icon.
3430 *
3431 * @return Returns a newly created Intent that can be used to relaunch the
3432 * activity's task in its root state.
3433 */
3434 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3435 Intent intent = makeMainActivity(mainActivity);
3436 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3437 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3438 return intent;
3439 }
3440
3441 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003442 * Call {@link #parseUri} with 0 flags.
3443 * @deprecated Use {@link #parseUri} instead.
3444 */
3445 @Deprecated
3446 public static Intent getIntent(String uri) throws URISyntaxException {
3447 return parseUri(uri, 0);
3448 }
Tom Taylord4a47292009-12-21 13:59:18 -08003449
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003450 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003451 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003452 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003453 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003454 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003455 *
3456 * <p>The URI given here must not be relative -- that is, it must include
3457 * the scheme and full path.
3458 *
3459 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003460 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003461 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003462 *
3463 * @return Intent The newly created Intent object.
3464 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003465 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3466 * it bad (as parsed by the Uri class) or the Intent data within the
3467 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003468 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003469 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003470 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003471 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003472 int i = 0;
3473 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003474 // Validate intent scheme for if requested.
3475 if ((flags&URI_INTENT_SCHEME) != 0) {
3476 if (!uri.startsWith("intent:")) {
3477 Intent intent = new Intent(ACTION_VIEW);
3478 try {
3479 intent.setData(Uri.parse(uri));
3480 } catch (IllegalArgumentException e) {
3481 throw new URISyntaxException(uri, e.getMessage());
3482 }
3483 return intent;
3484 }
3485 }
Tom Taylord4a47292009-12-21 13:59:18 -08003486
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003487 // simple case
3488 i = uri.lastIndexOf("#");
3489 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3490
3491 // old format Intent URI
3492 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003493
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003494 // new format
3495 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003496 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003497
3498 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003499 String data = i >= 0 ? uri.substring(0, i) : null;
3500 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003501 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003502
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003503 // loop over contents of Intent, all name=value;
3504 while (!uri.startsWith("end", i)) {
3505 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003506 if (eq < 0) eq = i-1;
3507 int semi = uri.indexOf(';', i);
3508 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003509
3510 // action
3511 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003512 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003513 }
3514
3515 // categories
3516 else if (uri.startsWith("category=", i)) {
3517 intent.addCategory(value);
3518 }
3519
3520 // type
3521 else if (uri.startsWith("type=", i)) {
3522 intent.mType = value;
3523 }
3524
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003525 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003526 else if (uri.startsWith("launchFlags=", i)) {
3527 intent.mFlags = Integer.decode(value).intValue();
3528 }
3529
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003530 // package
3531 else if (uri.startsWith("package=", i)) {
3532 intent.mPackage = value;
3533 }
3534
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003535 // component
3536 else if (uri.startsWith("component=", i)) {
3537 intent.mComponent = ComponentName.unflattenFromString(value);
3538 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003539
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003540 // scheme
3541 else if (uri.startsWith("scheme=", i)) {
3542 scheme = value;
3543 }
3544
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003545 // source bounds
3546 else if (uri.startsWith("sourceBounds=", i)) {
3547 intent.mSourceBounds = Rect.unflattenFromString(value);
3548 }
3549
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003550 // selector
3551 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3552 intent = new Intent();
3553 }
3554
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003555 // extra
3556 else {
3557 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003558 // create Bundle if it doesn't already exist
3559 if (intent.mExtras == null) intent.mExtras = new Bundle();
3560 Bundle b = intent.mExtras;
3561 // add EXTRA
3562 if (uri.startsWith("S.", i)) b.putString(key, value);
3563 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3564 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3565 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3566 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3567 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3568 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3569 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3570 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3571 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3572 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003573
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003574 // move to the next item
3575 i = semi + 1;
3576 }
3577
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003578 if (intent != baseIntent) {
3579 // The Intent had a selector; fix it up.
3580 baseIntent.setSelector(intent);
3581 intent = baseIntent;
3582 }
3583
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003584 if (data != null) {
3585 if (data.startsWith("intent:")) {
3586 data = data.substring(7);
3587 if (scheme != null) {
3588 data = scheme + ':' + data;
3589 }
3590 }
Tom Taylord4a47292009-12-21 13:59:18 -08003591
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003592 if (data.length() > 0) {
3593 try {
3594 intent.mData = Uri.parse(data);
3595 } catch (IllegalArgumentException e) {
3596 throw new URISyntaxException(uri, e.getMessage());
3597 }
3598 }
3599 }
Tom Taylord4a47292009-12-21 13:59:18 -08003600
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003601 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003602
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003603 } catch (IndexOutOfBoundsException e) {
3604 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3605 }
3606 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003607
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003608 public static Intent getIntentOld(String uri) throws URISyntaxException {
3609 Intent intent;
3610
3611 int i = uri.lastIndexOf('#');
3612 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003613 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003614 final int intentFragmentStart = i;
3615 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003616
3617 i++;
3618
3619 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003620 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003621 i += 7;
3622 int j = uri.indexOf(')', i);
3623 action = uri.substring(i, j);
3624 i = j + 1;
3625 }
3626
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003627 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003628
3629 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003630 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003631 i += 11;
3632 int j = uri.indexOf(')', i);
3633 while (i < j) {
3634 int sep = uri.indexOf('!', i);
3635 if (sep < 0) sep = j;
3636 if (i < sep) {
3637 intent.addCategory(uri.substring(i, sep));
3638 }
3639 i = sep + 1;
3640 }
3641 i = j + 1;
3642 }
3643
3644 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003645 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003646 i += 5;
3647 int j = uri.indexOf(')', i);
3648 intent.mType = uri.substring(i, j);
3649 i = j + 1;
3650 }
3651
3652 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003653 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003654 i += 12;
3655 int j = uri.indexOf(')', i);
3656 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3657 i = j + 1;
3658 }
3659
3660 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003661 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003662 i += 10;
3663 int j = uri.indexOf(')', i);
3664 int sep = uri.indexOf('!', i);
3665 if (sep >= 0 && sep < j) {
3666 String pkg = uri.substring(i, sep);
3667 String cls = uri.substring(sep + 1, j);
3668 intent.mComponent = new ComponentName(pkg, cls);
3669 }
3670 i = j + 1;
3671 }
3672
3673 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003674 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003675 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003676
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003677 final int closeParen = uri.indexOf(')', i);
3678 if (closeParen == -1) throw new URISyntaxException(uri,
3679 "EXTRA missing trailing ')'", i);
3680
3681 while (i < closeParen) {
3682 // fetch the key value
3683 int j = uri.indexOf('=', i);
3684 if (j <= i + 1 || i >= closeParen) {
3685 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3686 }
3687 char type = uri.charAt(i);
3688 i++;
3689 String key = uri.substring(i, j);
3690 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003691
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003692 // get type-value
3693 j = uri.indexOf('!', i);
3694 if (j == -1 || j >= closeParen) j = closeParen;
3695 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3696 String value = uri.substring(i, j);
3697 i = j;
3698
3699 // create Bundle if it doesn't already exist
3700 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003701
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003702 // add item to bundle
3703 try {
3704 switch (type) {
3705 case 'S':
3706 intent.mExtras.putString(key, Uri.decode(value));
3707 break;
3708 case 'B':
3709 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3710 break;
3711 case 'b':
3712 intent.mExtras.putByte(key, Byte.parseByte(value));
3713 break;
3714 case 'c':
3715 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3716 break;
3717 case 'd':
3718 intent.mExtras.putDouble(key, Double.parseDouble(value));
3719 break;
3720 case 'f':
3721 intent.mExtras.putFloat(key, Float.parseFloat(value));
3722 break;
3723 case 'i':
3724 intent.mExtras.putInt(key, Integer.parseInt(value));
3725 break;
3726 case 'l':
3727 intent.mExtras.putLong(key, Long.parseLong(value));
3728 break;
3729 case 's':
3730 intent.mExtras.putShort(key, Short.parseShort(value));
3731 break;
3732 default:
3733 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3734 }
3735 } catch (NumberFormatException e) {
3736 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3737 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003738
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003739 char ch = uri.charAt(i);
3740 if (ch == ')') break;
3741 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3742 i++;
3743 }
3744 }
3745
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003746 if (isIntentFragment) {
3747 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3748 } else {
3749 intent.mData = Uri.parse(uri);
3750 }
Tom Taylord4a47292009-12-21 13:59:18 -08003751
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003752 if (intent.mAction == null) {
3753 // By default, if no action is specified, then use VIEW.
3754 intent.mAction = ACTION_VIEW;
3755 }
3756
3757 } else {
3758 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3759 }
3760
3761 return intent;
3762 }
3763
3764 /**
3765 * Retrieve the general action to be performed, such as
3766 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3767 * the information in the intent should be interpreted -- most importantly,
3768 * what to do with the data returned by {@link #getData}.
3769 *
3770 * @return The action of this intent or null if none is specified.
3771 *
3772 * @see #setAction
3773 */
3774 public String getAction() {
3775 return mAction;
3776 }
3777
3778 /**
3779 * Retrieve data this intent is operating on. This URI specifies the name
3780 * of the data; often it uses the content: scheme, specifying data in a
3781 * content provider. Other schemes may be handled by specific activities,
3782 * such as http: by the web browser.
3783 *
3784 * @return The URI of the data this intent is targeting or null.
3785 *
3786 * @see #getScheme
3787 * @see #setData
3788 */
3789 public Uri getData() {
3790 return mData;
3791 }
3792
3793 /**
3794 * The same as {@link #getData()}, but returns the URI as an encoded
3795 * String.
3796 */
3797 public String getDataString() {
3798 return mData != null ? mData.toString() : null;
3799 }
3800
3801 /**
3802 * Return the scheme portion of the intent's data. If the data is null or
3803 * does not include a scheme, null is returned. Otherwise, the scheme
3804 * prefix without the final ':' is returned, i.e. "http".
3805 *
3806 * <p>This is the same as calling getData().getScheme() (and checking for
3807 * null data).
3808 *
3809 * @return The scheme of this intent.
3810 *
3811 * @see #getData
3812 */
3813 public String getScheme() {
3814 return mData != null ? mData.getScheme() : null;
3815 }
3816
3817 /**
3818 * Retrieve any explicit MIME type included in the intent. This is usually
3819 * null, as the type is determined by the intent data.
3820 *
3821 * @return If a type was manually set, it is returned; else null is
3822 * returned.
3823 *
3824 * @see #resolveType(ContentResolver)
3825 * @see #setType
3826 */
3827 public String getType() {
3828 return mType;
3829 }
3830
3831 /**
3832 * Return the MIME data type of this intent. If the type field is
3833 * explicitly set, that is simply returned. Otherwise, if the data is set,
3834 * the type of that data is returned. If neither fields are set, a null is
3835 * returned.
3836 *
3837 * @return The MIME type of this intent.
3838 *
3839 * @see #getType
3840 * @see #resolveType(ContentResolver)
3841 */
3842 public String resolveType(Context context) {
3843 return resolveType(context.getContentResolver());
3844 }
3845
3846 /**
3847 * Return the MIME data type of this intent. If the type field is
3848 * explicitly set, that is simply returned. Otherwise, if the data is set,
3849 * the type of that data is returned. If neither fields are set, a null is
3850 * returned.
3851 *
3852 * @param resolver A ContentResolver that can be used to determine the MIME
3853 * type of the intent's data.
3854 *
3855 * @return The MIME type of this intent.
3856 *
3857 * @see #getType
3858 * @see #resolveType(Context)
3859 */
3860 public String resolveType(ContentResolver resolver) {
3861 if (mType != null) {
3862 return mType;
3863 }
3864 if (mData != null) {
3865 if ("content".equals(mData.getScheme())) {
3866 return resolver.getType(mData);
3867 }
3868 }
3869 return null;
3870 }
3871
3872 /**
3873 * Return the MIME data type of this intent, only if it will be needed for
3874 * intent resolution. This is not generally useful for application code;
3875 * it is used by the frameworks for communicating with back-end system
3876 * services.
3877 *
3878 * @param resolver A ContentResolver that can be used to determine the MIME
3879 * type of the intent's data.
3880 *
3881 * @return The MIME type of this intent, or null if it is unknown or not
3882 * needed.
3883 */
3884 public String resolveTypeIfNeeded(ContentResolver resolver) {
3885 if (mComponent != null) {
3886 return mType;
3887 }
3888 return resolveType(resolver);
3889 }
3890
3891 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003892 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003893 *
3894 * @param category The category to check.
3895 *
3896 * @return boolean True if the intent contains the category, else false.
3897 *
3898 * @see #getCategories
3899 * @see #addCategory
3900 */
3901 public boolean hasCategory(String category) {
3902 return mCategories != null && mCategories.contains(category);
3903 }
3904
3905 /**
3906 * Return the set of all categories in the intent. If there are no categories,
3907 * returns NULL.
3908 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003909 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003910 *
3911 * @see #hasCategory
3912 * @see #addCategory
3913 */
3914 public Set<String> getCategories() {
3915 return mCategories;
3916 }
3917
3918 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003919 * Return the specific selector associated with this Intent. If there is
3920 * none, returns null. See {@link #setSelector} for more information.
3921 *
3922 * @see #setSelector
3923 */
3924 public Intent getSelector() {
3925 return mSelector;
3926 }
3927
3928 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003929 * Return the {@link ClipData} associated with this Intent. If there is
3930 * none, returns null. See {@link #setClipData} for more information.
3931 *
3932 * @see #setClipData;
3933 */
3934 public ClipData getClipData() {
3935 return mClipData;
3936 }
3937
3938 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003939 * Sets the ClassLoader that will be used when unmarshalling
3940 * any Parcelable values from the extras of this Intent.
3941 *
3942 * @param loader a ClassLoader, or null to use the default loader
3943 * at the time of unmarshalling.
3944 */
3945 public void setExtrasClassLoader(ClassLoader loader) {
3946 if (mExtras != null) {
3947 mExtras.setClassLoader(loader);
3948 }
3949 }
3950
3951 /**
3952 * Returns true if an extra value is associated with the given name.
3953 * @param name the extra's name
3954 * @return true if the given extra is present.
3955 */
3956 public boolean hasExtra(String name) {
3957 return mExtras != null && mExtras.containsKey(name);
3958 }
3959
3960 /**
3961 * Returns true if the Intent's extras contain a parcelled file descriptor.
3962 * @return true if the Intent contains a parcelled file descriptor.
3963 */
3964 public boolean hasFileDescriptors() {
3965 return mExtras != null && mExtras.hasFileDescriptors();
3966 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003967
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003968 /** @hide */
3969 public void setAllowFds(boolean allowFds) {
3970 if (mExtras != null) {
3971 mExtras.setAllowFds(allowFds);
3972 }
3973 }
3974
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003975 /**
3976 * Retrieve extended data from the intent.
3977 *
3978 * @param name The name of the desired item.
3979 *
3980 * @return the value of an item that previously added with putExtra()
3981 * or null if none was found.
3982 *
3983 * @deprecated
3984 * @hide
3985 */
3986 @Deprecated
3987 public Object getExtra(String name) {
3988 return getExtra(name, null);
3989 }
3990
3991 /**
3992 * Retrieve extended data from the intent.
3993 *
3994 * @param name The name of the desired item.
3995 * @param defaultValue the value to be returned if no value of the desired
3996 * type is stored with the given name.
3997 *
3998 * @return the value of an item that previously added with putExtra()
3999 * or the default value if none was found.
4000 *
4001 * @see #putExtra(String, boolean)
4002 */
4003 public boolean getBooleanExtra(String name, boolean defaultValue) {
4004 return mExtras == null ? defaultValue :
4005 mExtras.getBoolean(name, defaultValue);
4006 }
4007
4008 /**
4009 * Retrieve extended data from the intent.
4010 *
4011 * @param name The name of the desired item.
4012 * @param defaultValue the value to be returned if no value of the desired
4013 * type is stored with the given name.
4014 *
4015 * @return the value of an item that previously added with putExtra()
4016 * or the default value if none was found.
4017 *
4018 * @see #putExtra(String, byte)
4019 */
4020 public byte getByteExtra(String name, byte defaultValue) {
4021 return mExtras == null ? defaultValue :
4022 mExtras.getByte(name, defaultValue);
4023 }
4024
4025 /**
4026 * Retrieve extended data from the intent.
4027 *
4028 * @param name The name of the desired item.
4029 * @param defaultValue the value to be returned if no value of the desired
4030 * type is stored with the given name.
4031 *
4032 * @return the value of an item that previously added with putExtra()
4033 * or the default value if none was found.
4034 *
4035 * @see #putExtra(String, short)
4036 */
4037 public short getShortExtra(String name, short defaultValue) {
4038 return mExtras == null ? defaultValue :
4039 mExtras.getShort(name, defaultValue);
4040 }
4041
4042 /**
4043 * Retrieve extended data from the intent.
4044 *
4045 * @param name The name of the desired item.
4046 * @param defaultValue the value to be returned if no value of the desired
4047 * type is stored with the given name.
4048 *
4049 * @return the value of an item that previously added with putExtra()
4050 * or the default value if none was found.
4051 *
4052 * @see #putExtra(String, char)
4053 */
4054 public char getCharExtra(String name, char defaultValue) {
4055 return mExtras == null ? defaultValue :
4056 mExtras.getChar(name, defaultValue);
4057 }
4058
4059 /**
4060 * Retrieve extended data from the intent.
4061 *
4062 * @param name The name of the desired item.
4063 * @param defaultValue the value to be returned if no value of the desired
4064 * type is stored with the given name.
4065 *
4066 * @return the value of an item that previously added with putExtra()
4067 * or the default value if none was found.
4068 *
4069 * @see #putExtra(String, int)
4070 */
4071 public int getIntExtra(String name, int defaultValue) {
4072 return mExtras == null ? defaultValue :
4073 mExtras.getInt(name, defaultValue);
4074 }
4075
4076 /**
4077 * Retrieve extended data from the intent.
4078 *
4079 * @param name The name of the desired item.
4080 * @param defaultValue the value to be returned if no value of the desired
4081 * type is stored with the given name.
4082 *
4083 * @return the value of an item that previously added with putExtra()
4084 * or the default value if none was found.
4085 *
4086 * @see #putExtra(String, long)
4087 */
4088 public long getLongExtra(String name, long defaultValue) {
4089 return mExtras == null ? defaultValue :
4090 mExtras.getLong(name, defaultValue);
4091 }
4092
4093 /**
4094 * Retrieve extended data from the intent.
4095 *
4096 * @param name The name of the desired item.
4097 * @param defaultValue the value to be returned if no value of the desired
4098 * type is stored with the given name.
4099 *
4100 * @return the value of an item that previously added with putExtra(),
4101 * or the default value if no such item is present
4102 *
4103 * @see #putExtra(String, float)
4104 */
4105 public float getFloatExtra(String name, float defaultValue) {
4106 return mExtras == null ? defaultValue :
4107 mExtras.getFloat(name, defaultValue);
4108 }
4109
4110 /**
4111 * Retrieve extended data from the intent.
4112 *
4113 * @param name The name of the desired item.
4114 * @param defaultValue the value to be returned if no value of the desired
4115 * type is stored with the given name.
4116 *
4117 * @return the value of an item that previously added with putExtra()
4118 * or the default value if none was found.
4119 *
4120 * @see #putExtra(String, double)
4121 */
4122 public double getDoubleExtra(String name, double defaultValue) {
4123 return mExtras == null ? defaultValue :
4124 mExtras.getDouble(name, defaultValue);
4125 }
4126
4127 /**
4128 * Retrieve extended data from the intent.
4129 *
4130 * @param name The name of the desired item.
4131 *
4132 * @return the value of an item that previously added with putExtra()
4133 * or null if no String value was found.
4134 *
4135 * @see #putExtra(String, String)
4136 */
4137 public String getStringExtra(String name) {
4138 return mExtras == null ? null : mExtras.getString(name);
4139 }
4140
4141 /**
4142 * Retrieve extended data from the intent.
4143 *
4144 * @param name The name of the desired item.
4145 *
4146 * @return the value of an item that previously added with putExtra()
4147 * or null if no CharSequence value was found.
4148 *
4149 * @see #putExtra(String, CharSequence)
4150 */
4151 public CharSequence getCharSequenceExtra(String name) {
4152 return mExtras == null ? null : mExtras.getCharSequence(name);
4153 }
4154
4155 /**
4156 * Retrieve extended data from the intent.
4157 *
4158 * @param name The name of the desired item.
4159 *
4160 * @return the value of an item that previously added with putExtra()
4161 * or null if no Parcelable value was found.
4162 *
4163 * @see #putExtra(String, Parcelable)
4164 */
4165 public <T extends Parcelable> T getParcelableExtra(String name) {
4166 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4167 }
4168
4169 /**
4170 * Retrieve extended data from the intent.
4171 *
4172 * @param name The name of the desired item.
4173 *
4174 * @return the value of an item that previously added with putExtra()
4175 * or null if no Parcelable[] value was found.
4176 *
4177 * @see #putExtra(String, Parcelable[])
4178 */
4179 public Parcelable[] getParcelableArrayExtra(String name) {
4180 return mExtras == null ? null : mExtras.getParcelableArray(name);
4181 }
4182
4183 /**
4184 * Retrieve extended data from the intent.
4185 *
4186 * @param name The name of the desired item.
4187 *
4188 * @return the value of an item that previously added with putExtra()
4189 * or null if no ArrayList<Parcelable> value was found.
4190 *
4191 * @see #putParcelableArrayListExtra(String, ArrayList)
4192 */
4193 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4194 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4195 }
4196
4197 /**
4198 * Retrieve extended data from the intent.
4199 *
4200 * @param name The name of the desired item.
4201 *
4202 * @return the value of an item that previously added with putExtra()
4203 * or null if no Serializable value was found.
4204 *
4205 * @see #putExtra(String, Serializable)
4206 */
4207 public Serializable getSerializableExtra(String name) {
4208 return mExtras == null ? null : mExtras.getSerializable(name);
4209 }
4210
4211 /**
4212 * Retrieve extended data from the intent.
4213 *
4214 * @param name The name of the desired item.
4215 *
4216 * @return the value of an item that previously added with putExtra()
4217 * or null if no ArrayList<Integer> value was found.
4218 *
4219 * @see #putIntegerArrayListExtra(String, ArrayList)
4220 */
4221 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4222 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4223 }
4224
4225 /**
4226 * Retrieve extended data from the intent.
4227 *
4228 * @param name The name of the desired item.
4229 *
4230 * @return the value of an item that previously added with putExtra()
4231 * or null if no ArrayList<String> value was found.
4232 *
4233 * @see #putStringArrayListExtra(String, ArrayList)
4234 */
4235 public ArrayList<String> getStringArrayListExtra(String name) {
4236 return mExtras == null ? null : mExtras.getStringArrayList(name);
4237 }
4238
4239 /**
4240 * Retrieve extended data from the intent.
4241 *
4242 * @param name The name of the desired item.
4243 *
4244 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004245 * or null if no ArrayList<CharSequence> value was found.
4246 *
4247 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4248 */
4249 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4250 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4251 }
4252
4253 /**
4254 * Retrieve extended data from the intent.
4255 *
4256 * @param name The name of the desired item.
4257 *
4258 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004259 * or null if no boolean array value was found.
4260 *
4261 * @see #putExtra(String, boolean[])
4262 */
4263 public boolean[] getBooleanArrayExtra(String name) {
4264 return mExtras == null ? null : mExtras.getBooleanArray(name);
4265 }
4266
4267 /**
4268 * Retrieve extended data from the intent.
4269 *
4270 * @param name The name of the desired item.
4271 *
4272 * @return the value of an item that previously added with putExtra()
4273 * or null if no byte array value was found.
4274 *
4275 * @see #putExtra(String, byte[])
4276 */
4277 public byte[] getByteArrayExtra(String name) {
4278 return mExtras == null ? null : mExtras.getByteArray(name);
4279 }
4280
4281 /**
4282 * Retrieve extended data from the intent.
4283 *
4284 * @param name The name of the desired item.
4285 *
4286 * @return the value of an item that previously added with putExtra()
4287 * or null if no short array value was found.
4288 *
4289 * @see #putExtra(String, short[])
4290 */
4291 public short[] getShortArrayExtra(String name) {
4292 return mExtras == null ? null : mExtras.getShortArray(name);
4293 }
4294
4295 /**
4296 * Retrieve extended data from the intent.
4297 *
4298 * @param name The name of the desired item.
4299 *
4300 * @return the value of an item that previously added with putExtra()
4301 * or null if no char array value was found.
4302 *
4303 * @see #putExtra(String, char[])
4304 */
4305 public char[] getCharArrayExtra(String name) {
4306 return mExtras == null ? null : mExtras.getCharArray(name);
4307 }
4308
4309 /**
4310 * Retrieve extended data from the intent.
4311 *
4312 * @param name The name of the desired item.
4313 *
4314 * @return the value of an item that previously added with putExtra()
4315 * or null if no int array value was found.
4316 *
4317 * @see #putExtra(String, int[])
4318 */
4319 public int[] getIntArrayExtra(String name) {
4320 return mExtras == null ? null : mExtras.getIntArray(name);
4321 }
4322
4323 /**
4324 * Retrieve extended data from the intent.
4325 *
4326 * @param name The name of the desired item.
4327 *
4328 * @return the value of an item that previously added with putExtra()
4329 * or null if no long array value was found.
4330 *
4331 * @see #putExtra(String, long[])
4332 */
4333 public long[] getLongArrayExtra(String name) {
4334 return mExtras == null ? null : mExtras.getLongArray(name);
4335 }
4336
4337 /**
4338 * Retrieve extended data from the intent.
4339 *
4340 * @param name The name of the desired item.
4341 *
4342 * @return the value of an item that previously added with putExtra()
4343 * or null if no float array value was found.
4344 *
4345 * @see #putExtra(String, float[])
4346 */
4347 public float[] getFloatArrayExtra(String name) {
4348 return mExtras == null ? null : mExtras.getFloatArray(name);
4349 }
4350
4351 /**
4352 * Retrieve extended data from the intent.
4353 *
4354 * @param name The name of the desired item.
4355 *
4356 * @return the value of an item that previously added with putExtra()
4357 * or null if no double array value was found.
4358 *
4359 * @see #putExtra(String, double[])
4360 */
4361 public double[] getDoubleArrayExtra(String name) {
4362 return mExtras == null ? null : mExtras.getDoubleArray(name);
4363 }
4364
4365 /**
4366 * Retrieve extended data from the intent.
4367 *
4368 * @param name The name of the desired item.
4369 *
4370 * @return the value of an item that previously added with putExtra()
4371 * or null if no String array value was found.
4372 *
4373 * @see #putExtra(String, String[])
4374 */
4375 public String[] getStringArrayExtra(String name) {
4376 return mExtras == null ? null : mExtras.getStringArray(name);
4377 }
4378
4379 /**
4380 * Retrieve extended data from the intent.
4381 *
4382 * @param name The name of the desired item.
4383 *
4384 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004385 * or null if no CharSequence array value was found.
4386 *
4387 * @see #putExtra(String, CharSequence[])
4388 */
4389 public CharSequence[] getCharSequenceArrayExtra(String name) {
4390 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4391 }
4392
4393 /**
4394 * Retrieve extended data from the intent.
4395 *
4396 * @param name The name of the desired item.
4397 *
4398 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004399 * or null if no Bundle value was found.
4400 *
4401 * @see #putExtra(String, Bundle)
4402 */
4403 public Bundle getBundleExtra(String name) {
4404 return mExtras == null ? null : mExtras.getBundle(name);
4405 }
4406
4407 /**
4408 * Retrieve extended data from the intent.
4409 *
4410 * @param name The name of the desired item.
4411 *
4412 * @return the value of an item that previously added with putExtra()
4413 * or null if no IBinder value was found.
4414 *
4415 * @see #putExtra(String, IBinder)
4416 *
4417 * @deprecated
4418 * @hide
4419 */
4420 @Deprecated
4421 public IBinder getIBinderExtra(String name) {
4422 return mExtras == null ? null : mExtras.getIBinder(name);
4423 }
4424
4425 /**
4426 * Retrieve extended data from the intent.
4427 *
4428 * @param name The name of the desired item.
4429 * @param defaultValue The default value to return in case no item is
4430 * associated with the key 'name'
4431 *
4432 * @return the value of an item that previously added with putExtra()
4433 * or defaultValue if none was found.
4434 *
4435 * @see #putExtra
4436 *
4437 * @deprecated
4438 * @hide
4439 */
4440 @Deprecated
4441 public Object getExtra(String name, Object defaultValue) {
4442 Object result = defaultValue;
4443 if (mExtras != null) {
4444 Object result2 = mExtras.get(name);
4445 if (result2 != null) {
4446 result = result2;
4447 }
4448 }
4449
4450 return result;
4451 }
4452
4453 /**
4454 * Retrieves a map of extended data from the intent.
4455 *
4456 * @return the map of all extras previously added with putExtra(),
4457 * or null if none have been added.
4458 */
4459 public Bundle getExtras() {
4460 return (mExtras != null)
4461 ? new Bundle(mExtras)
4462 : null;
4463 }
4464
4465 /**
4466 * Retrieve any special flags associated with this intent. You will
4467 * normally just set them with {@link #setFlags} and let the system
4468 * take the appropriate action with them.
4469 *
4470 * @return int The currently set flags.
4471 *
4472 * @see #setFlags
4473 */
4474 public int getFlags() {
4475 return mFlags;
4476 }
4477
Dianne Hackborne7f97212011-02-24 14:40:20 -08004478 /** @hide */
4479 public boolean isExcludingStopped() {
4480 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4481 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4482 }
4483
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004484 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004485 * Retrieve the application package name this Intent is limited to. When
4486 * resolving an Intent, if non-null this limits the resolution to only
4487 * components in the given application package.
4488 *
4489 * @return The name of the application package for the Intent.
4490 *
4491 * @see #resolveActivity
4492 * @see #setPackage
4493 */
4494 public String getPackage() {
4495 return mPackage;
4496 }
4497
4498 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004499 * Retrieve the concrete component associated with the intent. When receiving
4500 * an intent, this is the component that was found to best handle it (that is,
4501 * yourself) and will always be non-null; in all other cases it will be
4502 * null unless explicitly set.
4503 *
4504 * @return The name of the application component to handle the intent.
4505 *
4506 * @see #resolveActivity
4507 * @see #setComponent
4508 */
4509 public ComponentName getComponent() {
4510 return mComponent;
4511 }
4512
4513 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004514 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4515 * used as a hint to the receiver for animations and the like. Null means that there
4516 * is no source bounds.
4517 */
4518 public Rect getSourceBounds() {
4519 return mSourceBounds;
4520 }
4521
4522 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004523 * Return the Activity component that should be used to handle this intent.
4524 * The appropriate component is determined based on the information in the
4525 * intent, evaluated as follows:
4526 *
4527 * <p>If {@link #getComponent} returns an explicit class, that is returned
4528 * without any further consideration.
4529 *
4530 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4531 * category to be considered.
4532 *
4533 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4534 * action.
4535 *
4536 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4537 * this type.
4538 *
4539 * <p>If {@link #addCategory} has added any categories, the activity must
4540 * handle ALL of the categories specified.
4541 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004542 * <p>If {@link #getPackage} is non-NULL, only activity components in
4543 * that application package will be considered.
4544 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004545 * <p>If there are no activities that satisfy all of these conditions, a
4546 * null string is returned.
4547 *
4548 * <p>If multiple activities are found to satisfy the intent, the one with
4549 * the highest priority will be used. If there are multiple activities
4550 * with the same priority, the system will either pick the best activity
4551 * based on user preference, or resolve to a system class that will allow
4552 * the user to pick an activity and forward from there.
4553 *
4554 * <p>This method is implemented simply by calling
4555 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4556 * true.</p>
4557 * <p> This API is called for you as part of starting an activity from an
4558 * intent. You do not normally need to call it yourself.</p>
4559 *
4560 * @param pm The package manager with which to resolve the Intent.
4561 *
4562 * @return Name of the component implementing an activity that can
4563 * display the intent.
4564 *
4565 * @see #setComponent
4566 * @see #getComponent
4567 * @see #resolveActivityInfo
4568 */
4569 public ComponentName resolveActivity(PackageManager pm) {
4570 if (mComponent != null) {
4571 return mComponent;
4572 }
4573
4574 ResolveInfo info = pm.resolveActivity(
4575 this, PackageManager.MATCH_DEFAULT_ONLY);
4576 if (info != null) {
4577 return new ComponentName(
4578 info.activityInfo.applicationInfo.packageName,
4579 info.activityInfo.name);
4580 }
4581
4582 return null;
4583 }
4584
4585 /**
4586 * Resolve the Intent into an {@link ActivityInfo}
4587 * describing the activity that should execute the intent. Resolution
4588 * follows the same rules as described for {@link #resolveActivity}, but
4589 * you get back the completely information about the resolved activity
4590 * instead of just its class name.
4591 *
4592 * @param pm The package manager with which to resolve the Intent.
4593 * @param flags Addition information to retrieve as per
4594 * {@link PackageManager#getActivityInfo(ComponentName, int)
4595 * PackageManager.getActivityInfo()}.
4596 *
4597 * @return PackageManager.ActivityInfo
4598 *
4599 * @see #resolveActivity
4600 */
4601 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4602 ActivityInfo ai = null;
4603 if (mComponent != null) {
4604 try {
4605 ai = pm.getActivityInfo(mComponent, flags);
4606 } catch (PackageManager.NameNotFoundException e) {
4607 // ignore
4608 }
4609 } else {
4610 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004611 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004612 if (info != null) {
4613 ai = info.activityInfo;
4614 }
4615 }
4616
4617 return ai;
4618 }
4619
4620 /**
4621 * Set the general action to be performed.
4622 *
4623 * @param action An action name, such as ACTION_VIEW. Application-specific
4624 * actions should be prefixed with the vendor's package name.
4625 *
4626 * @return Returns the same Intent object, for chaining multiple calls
4627 * into a single statement.
4628 *
4629 * @see #getAction
4630 */
4631 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004632 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004633 return this;
4634 }
4635
4636 /**
4637 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004638 * clears any type that was previously set by {@link #setType} or
4639 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004640 *
Nick Pellyccae4122012-01-09 14:12:58 -08004641 * <p><em>Note: scheme matching in the Android framework is
4642 * case-sensitive, unlike the formal RFC. As a result,
4643 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004644 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004645 * {@link #setDataAndNormalize}
4646 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004647 *
Nick Pellyccae4122012-01-09 14:12:58 -08004648 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004649 *
4650 * @return Returns the same Intent object, for chaining multiple calls
4651 * into a single statement.
4652 *
4653 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004654 * @see #setDataAndNormalize
4655 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004656 */
4657 public Intent setData(Uri data) {
4658 mData = data;
4659 mType = null;
4660 return this;
4661 }
4662
4663 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004664 * Normalize and set the data this intent is operating on.
4665 *
4666 * <p>This method automatically clears any type that was
4667 * previously set (for example, by {@link #setType}).
4668 *
4669 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004670 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004671 * so really this is just a convenience method for
4672 * <pre>
4673 * setData(data.normalize())
4674 * </pre>
4675 *
4676 * @param data The Uri of the data this intent is now targeting.
4677 *
4678 * @return Returns the same Intent object, for chaining multiple calls
4679 * into a single statement.
4680 *
4681 * @see #getData
4682 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004683 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004684 */
4685 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004686 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004687 }
4688
4689 /**
4690 * Set an explicit MIME data type.
4691 *
4692 * <p>This is used to create intents that only specify a type and not data,
4693 * for example to indicate the type of data to return.
4694 *
4695 * <p>This method automatically clears any data that was
4696 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004697 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004698 * <p><em>Note: MIME type matching in the Android framework is
4699 * case-sensitive, unlike formal RFC MIME types. As a result,
4700 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004701 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4702 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004703 *
4704 * @param type The MIME type of the data being handled by this intent.
4705 *
4706 * @return Returns the same Intent object, for chaining multiple calls
4707 * into a single statement.
4708 *
4709 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004710 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004711 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004712 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004713 */
4714 public Intent setType(String type) {
4715 mData = null;
4716 mType = type;
4717 return this;
4718 }
4719
4720 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004721 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004722 *
Nick Pellyccae4122012-01-09 14:12:58 -08004723 * <p>This is used to create intents that only specify a type and not data,
4724 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004725 *
Nick Pellyccae4122012-01-09 14:12:58 -08004726 * <p>This method automatically clears any data that was
4727 * previously set (for example by {@link #setData}).
4728 *
4729 * <p>The MIME type is normalized using
4730 * {@link #normalizeMimeType} before it is set,
4731 * so really this is just a convenience method for
4732 * <pre>
4733 * setType(Intent.normalizeMimeType(type))
4734 * </pre>
4735 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004736 * @param type The MIME type of the data being handled by this intent.
4737 *
4738 * @return Returns the same Intent object, for chaining multiple calls
4739 * into a single statement.
4740 *
Nick Pellyccae4122012-01-09 14:12:58 -08004741 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004742 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004743 * @see #normalizeMimeType
4744 */
4745 public Intent setTypeAndNormalize(String type) {
4746 return setType(normalizeMimeType(type));
4747 }
4748
4749 /**
4750 * (Usually optional) Set the data for the intent along with an explicit
4751 * MIME data type. This method should very rarely be used -- it allows you
4752 * to override the MIME type that would ordinarily be inferred from the
4753 * data with your own type given here.
4754 *
4755 * <p><em>Note: MIME type and Uri scheme matching in the
4756 * Android framework is case-sensitive, unlike the formal RFC definitions.
4757 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004758 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004759 * {@link #setDataAndTypeAndNormalize}
4760 * to ensure that they are converted to lower case.</em>
4761 *
4762 * @param data The Uri of the data this intent is now targeting.
4763 * @param type The MIME type of the data being handled by this intent.
4764 *
4765 * @return Returns the same Intent object, for chaining multiple calls
4766 * into a single statement.
4767 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004768 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004769 * @see #setData
4770 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004771 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004772 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004773 */
4774 public Intent setDataAndType(Uri data, String type) {
4775 mData = data;
4776 mType = type;
4777 return this;
4778 }
4779
4780 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004781 * (Usually optional) Normalize and set both the data Uri and an explicit
4782 * MIME data type. This method should very rarely be used -- it allows you
4783 * to override the MIME type that would ordinarily be inferred from the
4784 * data with your own type given here.
4785 *
4786 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004787 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004788 * before they are set, so really this is just a convenience method for
4789 * <pre>
4790 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4791 * </pre>
4792 *
4793 * @param data The Uri of the data this intent is now targeting.
4794 * @param type The MIME type of the data being handled by this intent.
4795 *
4796 * @return Returns the same Intent object, for chaining multiple calls
4797 * into a single statement.
4798 *
4799 * @see #setType
4800 * @see #setData
4801 * @see #setDataAndType
4802 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004803 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004804 */
4805 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004806 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004807 }
4808
4809 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004810 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004811 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004812 * activities that provide <em>all</em> of the requested categories will be
4813 * used.
4814 *
4815 * @param category The desired category. This can be either one of the
4816 * predefined Intent categories, or a custom category in your own
4817 * namespace.
4818 *
4819 * @return Returns the same Intent object, for chaining multiple calls
4820 * into a single statement.
4821 *
4822 * @see #hasCategory
4823 * @see #removeCategory
4824 */
4825 public Intent addCategory(String category) {
4826 if (mCategories == null) {
4827 mCategories = new HashSet<String>();
4828 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004829 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004830 return this;
4831 }
4832
4833 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004834 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004835 *
4836 * @param category The category to remove.
4837 *
4838 * @see #addCategory
4839 */
4840 public void removeCategory(String category) {
4841 if (mCategories != null) {
4842 mCategories.remove(category);
4843 if (mCategories.size() == 0) {
4844 mCategories = null;
4845 }
4846 }
4847 }
4848
4849 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004850 * Set a selector for this Intent. This is a modification to the kinds of
4851 * things the Intent will match. If the selector is set, it will be used
4852 * when trying to find entities that can handle the Intent, instead of the
4853 * main contents of the Intent. This allows you build an Intent containing
4854 * a generic protocol while targeting it more specifically.
4855 *
4856 * <p>An example of where this may be used is with things like
4857 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4858 * Intent that will launch the Browser application. However, the correct
4859 * main entry point of an application is actually {@link #ACTION_MAIN}
4860 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4861 * used to specify the actual Activity to launch. If you launch the browser
4862 * with something different, undesired behavior may happen if the user has
4863 * previously or later launches it the normal way, since they do not match.
4864 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4865 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4866 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4867 *
4868 * <p>Setting a selector does not impact the behavior of
4869 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4870 * desired behavior of a selector -- it does not impact the base meaning
4871 * of the Intent, just what kinds of things will be matched against it
4872 * when determining who can handle it.</p>
4873 *
4874 * <p>You can not use both a selector and {@link #setPackage(String)} on
4875 * the same base Intent.</p>
4876 *
4877 * @param selector The desired selector Intent; set to null to not use
4878 * a special selector.
4879 */
4880 public void setSelector(Intent selector) {
4881 if (selector == this) {
4882 throw new IllegalArgumentException(
4883 "Intent being set as a selector of itself");
4884 }
4885 if (selector != null && mPackage != null) {
4886 throw new IllegalArgumentException(
4887 "Can't set selector when package name is already set");
4888 }
4889 mSelector = selector;
4890 }
4891
4892 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004893 * Set a {@link ClipData} associated with this Intent. This replaces any
4894 * previously set ClipData.
4895 *
4896 * <p>The ClipData in an intent is not used for Intent matching or other
4897 * such operations. Semantically it is like extras, used to transmit
4898 * additional data with the Intent. The main feature of using this over
4899 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4900 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4901 * items included in the clip data. This is useful, in particular, if
4902 * you want to transmit an Intent containing multiple <code>content:</code>
4903 * URIs for which the recipient may not have global permission to access the
4904 * content provider.
4905 *
4906 * <p>If the ClipData contains items that are themselves Intents, any
4907 * grant flags in those Intents will be ignored. Only the top-level flags
4908 * of the main Intent are respected, and will be applied to all Uri or
4909 * Intent items in the clip (or sub-items of the clip).
4910 *
4911 * <p>The MIME type, label, and icon in the ClipData object are not
4912 * directly used by Intent. Applications should generally rely on the
4913 * MIME type of the Intent itself, not what it may find in the ClipData.
4914 * A common practice is to construct a ClipData for use with an Intent
4915 * with a MIME type of "*\/*".
4916 *
4917 * @param clip The new clip to set. May be null to clear the current clip.
4918 */
4919 public void setClipData(ClipData clip) {
4920 mClipData = clip;
4921 }
4922
4923 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004924 * Add extended data to the intent. The name must include a package
4925 * prefix, for example the app com.android.contacts would use names
4926 * like "com.android.contacts.ShowAll".
4927 *
4928 * @param name The name of the extra data, with package prefix.
4929 * @param value The boolean data value.
4930 *
4931 * @return Returns the same Intent object, for chaining multiple calls
4932 * into a single statement.
4933 *
4934 * @see #putExtras
4935 * @see #removeExtra
4936 * @see #getBooleanExtra(String, boolean)
4937 */
4938 public Intent putExtra(String name, boolean value) {
4939 if (mExtras == null) {
4940 mExtras = new Bundle();
4941 }
4942 mExtras.putBoolean(name, value);
4943 return this;
4944 }
4945
4946 /**
4947 * Add extended data to the intent. The name must include a package
4948 * prefix, for example the app com.android.contacts would use names
4949 * like "com.android.contacts.ShowAll".
4950 *
4951 * @param name The name of the extra data, with package prefix.
4952 * @param value The byte data value.
4953 *
4954 * @return Returns the same Intent object, for chaining multiple calls
4955 * into a single statement.
4956 *
4957 * @see #putExtras
4958 * @see #removeExtra
4959 * @see #getByteExtra(String, byte)
4960 */
4961 public Intent putExtra(String name, byte value) {
4962 if (mExtras == null) {
4963 mExtras = new Bundle();
4964 }
4965 mExtras.putByte(name, value);
4966 return this;
4967 }
4968
4969 /**
4970 * Add extended data to the intent. The name must include a package
4971 * prefix, for example the app com.android.contacts would use names
4972 * like "com.android.contacts.ShowAll".
4973 *
4974 * @param name The name of the extra data, with package prefix.
4975 * @param value The char data value.
4976 *
4977 * @return Returns the same Intent object, for chaining multiple calls
4978 * into a single statement.
4979 *
4980 * @see #putExtras
4981 * @see #removeExtra
4982 * @see #getCharExtra(String, char)
4983 */
4984 public Intent putExtra(String name, char value) {
4985 if (mExtras == null) {
4986 mExtras = new Bundle();
4987 }
4988 mExtras.putChar(name, value);
4989 return this;
4990 }
4991
4992 /**
4993 * Add extended data to the intent. The name must include a package
4994 * prefix, for example the app com.android.contacts would use names
4995 * like "com.android.contacts.ShowAll".
4996 *
4997 * @param name The name of the extra data, with package prefix.
4998 * @param value The short data value.
4999 *
5000 * @return Returns the same Intent object, for chaining multiple calls
5001 * into a single statement.
5002 *
5003 * @see #putExtras
5004 * @see #removeExtra
5005 * @see #getShortExtra(String, short)
5006 */
5007 public Intent putExtra(String name, short value) {
5008 if (mExtras == null) {
5009 mExtras = new Bundle();
5010 }
5011 mExtras.putShort(name, value);
5012 return this;
5013 }
5014
5015 /**
5016 * Add extended data to the intent. The name must include a package
5017 * prefix, for example the app com.android.contacts would use names
5018 * like "com.android.contacts.ShowAll".
5019 *
5020 * @param name The name of the extra data, with package prefix.
5021 * @param value The integer data value.
5022 *
5023 * @return Returns the same Intent object, for chaining multiple calls
5024 * into a single statement.
5025 *
5026 * @see #putExtras
5027 * @see #removeExtra
5028 * @see #getIntExtra(String, int)
5029 */
5030 public Intent putExtra(String name, int value) {
5031 if (mExtras == null) {
5032 mExtras = new Bundle();
5033 }
5034 mExtras.putInt(name, value);
5035 return this;
5036 }
5037
5038 /**
5039 * Add extended data to the intent. The name must include a package
5040 * prefix, for example the app com.android.contacts would use names
5041 * like "com.android.contacts.ShowAll".
5042 *
5043 * @param name The name of the extra data, with package prefix.
5044 * @param value The long data value.
5045 *
5046 * @return Returns the same Intent object, for chaining multiple calls
5047 * into a single statement.
5048 *
5049 * @see #putExtras
5050 * @see #removeExtra
5051 * @see #getLongExtra(String, long)
5052 */
5053 public Intent putExtra(String name, long value) {
5054 if (mExtras == null) {
5055 mExtras = new Bundle();
5056 }
5057 mExtras.putLong(name, value);
5058 return this;
5059 }
5060
5061 /**
5062 * Add extended data to the intent. The name must include a package
5063 * prefix, for example the app com.android.contacts would use names
5064 * like "com.android.contacts.ShowAll".
5065 *
5066 * @param name The name of the extra data, with package prefix.
5067 * @param value The float data value.
5068 *
5069 * @return Returns the same Intent object, for chaining multiple calls
5070 * into a single statement.
5071 *
5072 * @see #putExtras
5073 * @see #removeExtra
5074 * @see #getFloatExtra(String, float)
5075 */
5076 public Intent putExtra(String name, float value) {
5077 if (mExtras == null) {
5078 mExtras = new Bundle();
5079 }
5080 mExtras.putFloat(name, value);
5081 return this;
5082 }
5083
5084 /**
5085 * Add extended data to the intent. The name must include a package
5086 * prefix, for example the app com.android.contacts would use names
5087 * like "com.android.contacts.ShowAll".
5088 *
5089 * @param name The name of the extra data, with package prefix.
5090 * @param value The double data value.
5091 *
5092 * @return Returns the same Intent object, for chaining multiple calls
5093 * into a single statement.
5094 *
5095 * @see #putExtras
5096 * @see #removeExtra
5097 * @see #getDoubleExtra(String, double)
5098 */
5099 public Intent putExtra(String name, double value) {
5100 if (mExtras == null) {
5101 mExtras = new Bundle();
5102 }
5103 mExtras.putDouble(name, value);
5104 return this;
5105 }
5106
5107 /**
5108 * Add extended data to the intent. The name must include a package
5109 * prefix, for example the app com.android.contacts would use names
5110 * like "com.android.contacts.ShowAll".
5111 *
5112 * @param name The name of the extra data, with package prefix.
5113 * @param value The String data value.
5114 *
5115 * @return Returns the same Intent object, for chaining multiple calls
5116 * into a single statement.
5117 *
5118 * @see #putExtras
5119 * @see #removeExtra
5120 * @see #getStringExtra(String)
5121 */
5122 public Intent putExtra(String name, String value) {
5123 if (mExtras == null) {
5124 mExtras = new Bundle();
5125 }
5126 mExtras.putString(name, value);
5127 return this;
5128 }
5129
5130 /**
5131 * Add extended data to the intent. The name must include a package
5132 * prefix, for example the app com.android.contacts would use names
5133 * like "com.android.contacts.ShowAll".
5134 *
5135 * @param name The name of the extra data, with package prefix.
5136 * @param value The CharSequence data value.
5137 *
5138 * @return Returns the same Intent object, for chaining multiple calls
5139 * into a single statement.
5140 *
5141 * @see #putExtras
5142 * @see #removeExtra
5143 * @see #getCharSequenceExtra(String)
5144 */
5145 public Intent putExtra(String name, CharSequence value) {
5146 if (mExtras == null) {
5147 mExtras = new Bundle();
5148 }
5149 mExtras.putCharSequence(name, value);
5150 return this;
5151 }
5152
5153 /**
5154 * Add extended data to the intent. The name must include a package
5155 * prefix, for example the app com.android.contacts would use names
5156 * like "com.android.contacts.ShowAll".
5157 *
5158 * @param name The name of the extra data, with package prefix.
5159 * @param value The Parcelable data value.
5160 *
5161 * @return Returns the same Intent object, for chaining multiple calls
5162 * into a single statement.
5163 *
5164 * @see #putExtras
5165 * @see #removeExtra
5166 * @see #getParcelableExtra(String)
5167 */
5168 public Intent putExtra(String name, Parcelable value) {
5169 if (mExtras == null) {
5170 mExtras = new Bundle();
5171 }
5172 mExtras.putParcelable(name, value);
5173 return this;
5174 }
5175
5176 /**
5177 * Add extended data to the intent. The name must include a package
5178 * prefix, for example the app com.android.contacts would use names
5179 * like "com.android.contacts.ShowAll".
5180 *
5181 * @param name The name of the extra data, with package prefix.
5182 * @param value The Parcelable[] data value.
5183 *
5184 * @return Returns the same Intent object, for chaining multiple calls
5185 * into a single statement.
5186 *
5187 * @see #putExtras
5188 * @see #removeExtra
5189 * @see #getParcelableArrayExtra(String)
5190 */
5191 public Intent putExtra(String name, Parcelable[] value) {
5192 if (mExtras == null) {
5193 mExtras = new Bundle();
5194 }
5195 mExtras.putParcelableArray(name, value);
5196 return this;
5197 }
5198
5199 /**
5200 * Add extended data to the intent. The name must include a package
5201 * prefix, for example the app com.android.contacts would use names
5202 * like "com.android.contacts.ShowAll".
5203 *
5204 * @param name The name of the extra data, with package prefix.
5205 * @param value The ArrayList<Parcelable> data value.
5206 *
5207 * @return Returns the same Intent object, for chaining multiple calls
5208 * into a single statement.
5209 *
5210 * @see #putExtras
5211 * @see #removeExtra
5212 * @see #getParcelableArrayListExtra(String)
5213 */
5214 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5215 if (mExtras == null) {
5216 mExtras = new Bundle();
5217 }
5218 mExtras.putParcelableArrayList(name, value);
5219 return this;
5220 }
5221
5222 /**
5223 * Add extended data to the intent. The name must include a package
5224 * prefix, for example the app com.android.contacts would use names
5225 * like "com.android.contacts.ShowAll".
5226 *
5227 * @param name The name of the extra data, with package prefix.
5228 * @param value The ArrayList<Integer> data value.
5229 *
5230 * @return Returns the same Intent object, for chaining multiple calls
5231 * into a single statement.
5232 *
5233 * @see #putExtras
5234 * @see #removeExtra
5235 * @see #getIntegerArrayListExtra(String)
5236 */
5237 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5238 if (mExtras == null) {
5239 mExtras = new Bundle();
5240 }
5241 mExtras.putIntegerArrayList(name, value);
5242 return this;
5243 }
5244
5245 /**
5246 * Add extended data to the intent. The name must include a package
5247 * prefix, for example the app com.android.contacts would use names
5248 * like "com.android.contacts.ShowAll".
5249 *
5250 * @param name The name of the extra data, with package prefix.
5251 * @param value The ArrayList<String> data value.
5252 *
5253 * @return Returns the same Intent object, for chaining multiple calls
5254 * into a single statement.
5255 *
5256 * @see #putExtras
5257 * @see #removeExtra
5258 * @see #getStringArrayListExtra(String)
5259 */
5260 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5261 if (mExtras == null) {
5262 mExtras = new Bundle();
5263 }
5264 mExtras.putStringArrayList(name, value);
5265 return this;
5266 }
5267
5268 /**
5269 * Add extended data to the intent. The name must include a package
5270 * prefix, for example the app com.android.contacts would use names
5271 * like "com.android.contacts.ShowAll".
5272 *
5273 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005274 * @param value The ArrayList<CharSequence> data value.
5275 *
5276 * @return Returns the same Intent object, for chaining multiple calls
5277 * into a single statement.
5278 *
5279 * @see #putExtras
5280 * @see #removeExtra
5281 * @see #getCharSequenceArrayListExtra(String)
5282 */
5283 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5284 if (mExtras == null) {
5285 mExtras = new Bundle();
5286 }
5287 mExtras.putCharSequenceArrayList(name, value);
5288 return this;
5289 }
5290
5291 /**
5292 * Add extended data to the intent. The name must include a package
5293 * prefix, for example the app com.android.contacts would use names
5294 * like "com.android.contacts.ShowAll".
5295 *
5296 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005297 * @param value The Serializable data value.
5298 *
5299 * @return Returns the same Intent object, for chaining multiple calls
5300 * into a single statement.
5301 *
5302 * @see #putExtras
5303 * @see #removeExtra
5304 * @see #getSerializableExtra(String)
5305 */
5306 public Intent putExtra(String name, Serializable value) {
5307 if (mExtras == null) {
5308 mExtras = new Bundle();
5309 }
5310 mExtras.putSerializable(name, value);
5311 return this;
5312 }
5313
5314 /**
5315 * Add extended data to the intent. The name must include a package
5316 * prefix, for example the app com.android.contacts would use names
5317 * like "com.android.contacts.ShowAll".
5318 *
5319 * @param name The name of the extra data, with package prefix.
5320 * @param value The boolean array data value.
5321 *
5322 * @return Returns the same Intent object, for chaining multiple calls
5323 * into a single statement.
5324 *
5325 * @see #putExtras
5326 * @see #removeExtra
5327 * @see #getBooleanArrayExtra(String)
5328 */
5329 public Intent putExtra(String name, boolean[] value) {
5330 if (mExtras == null) {
5331 mExtras = new Bundle();
5332 }
5333 mExtras.putBooleanArray(name, value);
5334 return this;
5335 }
5336
5337 /**
5338 * Add extended data to the intent. The name must include a package
5339 * prefix, for example the app com.android.contacts would use names
5340 * like "com.android.contacts.ShowAll".
5341 *
5342 * @param name The name of the extra data, with package prefix.
5343 * @param value The byte array data value.
5344 *
5345 * @return Returns the same Intent object, for chaining multiple calls
5346 * into a single statement.
5347 *
5348 * @see #putExtras
5349 * @see #removeExtra
5350 * @see #getByteArrayExtra(String)
5351 */
5352 public Intent putExtra(String name, byte[] value) {
5353 if (mExtras == null) {
5354 mExtras = new Bundle();
5355 }
5356 mExtras.putByteArray(name, value);
5357 return this;
5358 }
5359
5360 /**
5361 * Add extended data to the intent. The name must include a package
5362 * prefix, for example the app com.android.contacts would use names
5363 * like "com.android.contacts.ShowAll".
5364 *
5365 * @param name The name of the extra data, with package prefix.
5366 * @param value The short array data value.
5367 *
5368 * @return Returns the same Intent object, for chaining multiple calls
5369 * into a single statement.
5370 *
5371 * @see #putExtras
5372 * @see #removeExtra
5373 * @see #getShortArrayExtra(String)
5374 */
5375 public Intent putExtra(String name, short[] value) {
5376 if (mExtras == null) {
5377 mExtras = new Bundle();
5378 }
5379 mExtras.putShortArray(name, value);
5380 return this;
5381 }
5382
5383 /**
5384 * Add extended data to the intent. The name must include a package
5385 * prefix, for example the app com.android.contacts would use names
5386 * like "com.android.contacts.ShowAll".
5387 *
5388 * @param name The name of the extra data, with package prefix.
5389 * @param value The char array data value.
5390 *
5391 * @return Returns the same Intent object, for chaining multiple calls
5392 * into a single statement.
5393 *
5394 * @see #putExtras
5395 * @see #removeExtra
5396 * @see #getCharArrayExtra(String)
5397 */
5398 public Intent putExtra(String name, char[] value) {
5399 if (mExtras == null) {
5400 mExtras = new Bundle();
5401 }
5402 mExtras.putCharArray(name, value);
5403 return this;
5404 }
5405
5406 /**
5407 * Add extended data to the intent. The name must include a package
5408 * prefix, for example the app com.android.contacts would use names
5409 * like "com.android.contacts.ShowAll".
5410 *
5411 * @param name The name of the extra data, with package prefix.
5412 * @param value The int array data value.
5413 *
5414 * @return Returns the same Intent object, for chaining multiple calls
5415 * into a single statement.
5416 *
5417 * @see #putExtras
5418 * @see #removeExtra
5419 * @see #getIntArrayExtra(String)
5420 */
5421 public Intent putExtra(String name, int[] value) {
5422 if (mExtras == null) {
5423 mExtras = new Bundle();
5424 }
5425 mExtras.putIntArray(name, value);
5426 return this;
5427 }
5428
5429 /**
5430 * Add extended data to the intent. The name must include a package
5431 * prefix, for example the app com.android.contacts would use names
5432 * like "com.android.contacts.ShowAll".
5433 *
5434 * @param name The name of the extra data, with package prefix.
5435 * @param value The byte array data value.
5436 *
5437 * @return Returns the same Intent object, for chaining multiple calls
5438 * into a single statement.
5439 *
5440 * @see #putExtras
5441 * @see #removeExtra
5442 * @see #getLongArrayExtra(String)
5443 */
5444 public Intent putExtra(String name, long[] value) {
5445 if (mExtras == null) {
5446 mExtras = new Bundle();
5447 }
5448 mExtras.putLongArray(name, value);
5449 return this;
5450 }
5451
5452 /**
5453 * Add extended data to the intent. The name must include a package
5454 * prefix, for example the app com.android.contacts would use names
5455 * like "com.android.contacts.ShowAll".
5456 *
5457 * @param name The name of the extra data, with package prefix.
5458 * @param value The float array data value.
5459 *
5460 * @return Returns the same Intent object, for chaining multiple calls
5461 * into a single statement.
5462 *
5463 * @see #putExtras
5464 * @see #removeExtra
5465 * @see #getFloatArrayExtra(String)
5466 */
5467 public Intent putExtra(String name, float[] value) {
5468 if (mExtras == null) {
5469 mExtras = new Bundle();
5470 }
5471 mExtras.putFloatArray(name, value);
5472 return this;
5473 }
5474
5475 /**
5476 * Add extended data to the intent. The name must include a package
5477 * prefix, for example the app com.android.contacts would use names
5478 * like "com.android.contacts.ShowAll".
5479 *
5480 * @param name The name of the extra data, with package prefix.
5481 * @param value The double array data value.
5482 *
5483 * @return Returns the same Intent object, for chaining multiple calls
5484 * into a single statement.
5485 *
5486 * @see #putExtras
5487 * @see #removeExtra
5488 * @see #getDoubleArrayExtra(String)
5489 */
5490 public Intent putExtra(String name, double[] value) {
5491 if (mExtras == null) {
5492 mExtras = new Bundle();
5493 }
5494 mExtras.putDoubleArray(name, value);
5495 return this;
5496 }
5497
5498 /**
5499 * Add extended data to the intent. The name must include a package
5500 * prefix, for example the app com.android.contacts would use names
5501 * like "com.android.contacts.ShowAll".
5502 *
5503 * @param name The name of the extra data, with package prefix.
5504 * @param value The String array data value.
5505 *
5506 * @return Returns the same Intent object, for chaining multiple calls
5507 * into a single statement.
5508 *
5509 * @see #putExtras
5510 * @see #removeExtra
5511 * @see #getStringArrayExtra(String)
5512 */
5513 public Intent putExtra(String name, String[] value) {
5514 if (mExtras == null) {
5515 mExtras = new Bundle();
5516 }
5517 mExtras.putStringArray(name, value);
5518 return this;
5519 }
5520
5521 /**
5522 * Add extended data to the intent. The name must include a package
5523 * prefix, for example the app com.android.contacts would use names
5524 * like "com.android.contacts.ShowAll".
5525 *
5526 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005527 * @param value The CharSequence array data value.
5528 *
5529 * @return Returns the same Intent object, for chaining multiple calls
5530 * into a single statement.
5531 *
5532 * @see #putExtras
5533 * @see #removeExtra
5534 * @see #getCharSequenceArrayExtra(String)
5535 */
5536 public Intent putExtra(String name, CharSequence[] value) {
5537 if (mExtras == null) {
5538 mExtras = new Bundle();
5539 }
5540 mExtras.putCharSequenceArray(name, value);
5541 return this;
5542 }
5543
5544 /**
5545 * Add extended data to the intent. The name must include a package
5546 * prefix, for example the app com.android.contacts would use names
5547 * like "com.android.contacts.ShowAll".
5548 *
5549 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005550 * @param value The Bundle data value.
5551 *
5552 * @return Returns the same Intent object, for chaining multiple calls
5553 * into a single statement.
5554 *
5555 * @see #putExtras
5556 * @see #removeExtra
5557 * @see #getBundleExtra(String)
5558 */
5559 public Intent putExtra(String name, Bundle value) {
5560 if (mExtras == null) {
5561 mExtras = new Bundle();
5562 }
5563 mExtras.putBundle(name, value);
5564 return this;
5565 }
5566
5567 /**
5568 * Add extended data to the intent. The name must include a package
5569 * prefix, for example the app com.android.contacts would use names
5570 * like "com.android.contacts.ShowAll".
5571 *
5572 * @param name The name of the extra data, with package prefix.
5573 * @param value The IBinder data value.
5574 *
5575 * @return Returns the same Intent object, for chaining multiple calls
5576 * into a single statement.
5577 *
5578 * @see #putExtras
5579 * @see #removeExtra
5580 * @see #getIBinderExtra(String)
5581 *
5582 * @deprecated
5583 * @hide
5584 */
5585 @Deprecated
5586 public Intent putExtra(String name, IBinder value) {
5587 if (mExtras == null) {
5588 mExtras = new Bundle();
5589 }
5590 mExtras.putIBinder(name, value);
5591 return this;
5592 }
5593
5594 /**
5595 * Copy all extras in 'src' in to this intent.
5596 *
5597 * @param src Contains the extras to copy.
5598 *
5599 * @see #putExtra
5600 */
5601 public Intent putExtras(Intent src) {
5602 if (src.mExtras != null) {
5603 if (mExtras == null) {
5604 mExtras = new Bundle(src.mExtras);
5605 } else {
5606 mExtras.putAll(src.mExtras);
5607 }
5608 }
5609 return this;
5610 }
5611
5612 /**
5613 * Add a set of extended data to the intent. The keys must include a package
5614 * prefix, for example the app com.android.contacts would use names
5615 * like "com.android.contacts.ShowAll".
5616 *
5617 * @param extras The Bundle of extras to add to this intent.
5618 *
5619 * @see #putExtra
5620 * @see #removeExtra
5621 */
5622 public Intent putExtras(Bundle extras) {
5623 if (mExtras == null) {
5624 mExtras = new Bundle();
5625 }
5626 mExtras.putAll(extras);
5627 return this;
5628 }
5629
5630 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005631 * Completely replace the extras in the Intent with the extras in the
5632 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005633 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005634 * @param src The exact extras contained in this Intent are copied
5635 * into the target intent, replacing any that were previously there.
5636 */
5637 public Intent replaceExtras(Intent src) {
5638 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5639 return this;
5640 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005641
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005642 /**
5643 * Completely replace the extras in the Intent with the given Bundle of
5644 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005645 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005646 * @param extras The new set of extras in the Intent, or null to erase
5647 * all extras.
5648 */
5649 public Intent replaceExtras(Bundle extras) {
5650 mExtras = extras != null ? new Bundle(extras) : null;
5651 return this;
5652 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005653
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005654 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005655 * Remove extended data from the intent.
5656 *
5657 * @see #putExtra
5658 */
5659 public void removeExtra(String name) {
5660 if (mExtras != null) {
5661 mExtras.remove(name);
5662 if (mExtras.size() == 0) {
5663 mExtras = null;
5664 }
5665 }
5666 }
5667
5668 /**
5669 * Set special flags controlling how this intent is handled. Most values
5670 * here depend on the type of component being executed by the Intent,
5671 * specifically the FLAG_ACTIVITY_* flags are all for use with
5672 * {@link Context#startActivity Context.startActivity()} and the
5673 * FLAG_RECEIVER_* flags are all for use with
5674 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5675 *
Scott Main7aee61f2011-02-08 11:25:01 -08005676 * <p>See the
5677 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5678 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005679 * the behavior of your application.
5680 *
5681 * @param flags The desired flags.
5682 *
5683 * @return Returns the same Intent object, for chaining multiple calls
5684 * into a single statement.
5685 *
5686 * @see #getFlags
5687 * @see #addFlags
5688 *
5689 * @see #FLAG_GRANT_READ_URI_PERMISSION
5690 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5691 * @see #FLAG_DEBUG_LOG_RESOLUTION
5692 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005693 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005694 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005695 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005696 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005697 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5698 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005699 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005700 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5701 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005702 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005703 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005704 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005705 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5706 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005707 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005708 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005709 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005710 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5711 */
5712 public Intent setFlags(int flags) {
5713 mFlags = flags;
5714 return this;
5715 }
5716
5717 /**
5718 * Add additional flags to the intent (or with existing flags
5719 * value).
5720 *
5721 * @param flags The new flags to set.
5722 *
5723 * @return Returns the same Intent object, for chaining multiple calls
5724 * into a single statement.
5725 *
5726 * @see #setFlags
5727 */
5728 public Intent addFlags(int flags) {
5729 mFlags |= flags;
5730 return this;
5731 }
5732
5733 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005734 * (Usually optional) Set an explicit application package name that limits
5735 * the components this Intent will resolve to. If left to the default
5736 * value of null, all components in all applications will considered.
5737 * If non-null, the Intent can only match the components in the given
5738 * application package.
5739 *
5740 * @param packageName The name of the application package to handle the
5741 * intent, or null to allow any application package.
5742 *
5743 * @return Returns the same Intent object, for chaining multiple calls
5744 * into a single statement.
5745 *
5746 * @see #getPackage
5747 * @see #resolveActivity
5748 */
5749 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005750 if (packageName != null && mSelector != null) {
5751 throw new IllegalArgumentException(
5752 "Can't set package name when selector is already set");
5753 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005754 mPackage = packageName;
5755 return this;
5756 }
5757
5758 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005759 * (Usually optional) Explicitly set the component to handle the intent.
5760 * If left with the default value of null, the system will determine the
5761 * appropriate class to use based on the other fields (action, data,
5762 * type, categories) in the Intent. If this class is defined, the
5763 * specified class will always be used regardless of the other fields. You
5764 * should only set this value when you know you absolutely want a specific
5765 * class to be used; otherwise it is better to let the system find the
5766 * appropriate class so that you will respect the installed applications
5767 * and user preferences.
5768 *
5769 * @param component The name of the application component to handle the
5770 * intent, or null to let the system find one for you.
5771 *
5772 * @return Returns the same Intent object, for chaining multiple calls
5773 * into a single statement.
5774 *
5775 * @see #setClass
5776 * @see #setClassName(Context, String)
5777 * @see #setClassName(String, String)
5778 * @see #getComponent
5779 * @see #resolveActivity
5780 */
5781 public Intent setComponent(ComponentName component) {
5782 mComponent = component;
5783 return this;
5784 }
5785
5786 /**
5787 * Convenience for calling {@link #setComponent} with an
5788 * explicit class name.
5789 *
5790 * @param packageContext A Context of the application package implementing
5791 * this class.
5792 * @param className The name of a class inside of the application package
5793 * that will be used as the component for this Intent.
5794 *
5795 * @return Returns the same Intent object, for chaining multiple calls
5796 * into a single statement.
5797 *
5798 * @see #setComponent
5799 * @see #setClass
5800 */
5801 public Intent setClassName(Context packageContext, String className) {
5802 mComponent = new ComponentName(packageContext, className);
5803 return this;
5804 }
5805
5806 /**
5807 * Convenience for calling {@link #setComponent} with an
5808 * explicit application package name and class name.
5809 *
5810 * @param packageName The name of the package implementing the desired
5811 * component.
5812 * @param className The name of a class inside of the application package
5813 * that will be used as the component for this Intent.
5814 *
5815 * @return Returns the same Intent object, for chaining multiple calls
5816 * into a single statement.
5817 *
5818 * @see #setComponent
5819 * @see #setClass
5820 */
5821 public Intent setClassName(String packageName, String className) {
5822 mComponent = new ComponentName(packageName, className);
5823 return this;
5824 }
5825
5826 /**
5827 * Convenience for calling {@link #setComponent(ComponentName)} with the
5828 * name returned by a {@link Class} object.
5829 *
5830 * @param packageContext A Context of the application package implementing
5831 * this class.
5832 * @param cls The class name to set, equivalent to
5833 * <code>setClassName(context, cls.getName())</code>.
5834 *
5835 * @return Returns the same Intent object, for chaining multiple calls
5836 * into a single statement.
5837 *
5838 * @see #setComponent
5839 */
5840 public Intent setClass(Context packageContext, Class<?> cls) {
5841 mComponent = new ComponentName(packageContext, cls);
5842 return this;
5843 }
5844
5845 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005846 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5847 * used as a hint to the receiver for animations and the like. Null means that there
5848 * is no source bounds.
5849 */
5850 public void setSourceBounds(Rect r) {
5851 if (r != null) {
5852 mSourceBounds = new Rect(r);
5853 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005854 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005855 }
5856 }
5857
5858 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005859 * Use with {@link #fillIn} to allow the current action value to be
5860 * overwritten, even if it is already set.
5861 */
5862 public static final int FILL_IN_ACTION = 1<<0;
5863
5864 /**
5865 * Use with {@link #fillIn} to allow the current data or type value
5866 * overwritten, even if it is already set.
5867 */
5868 public static final int FILL_IN_DATA = 1<<1;
5869
5870 /**
5871 * Use with {@link #fillIn} to allow the current categories to be
5872 * overwritten, even if they are already set.
5873 */
5874 public static final int FILL_IN_CATEGORIES = 1<<2;
5875
5876 /**
5877 * Use with {@link #fillIn} to allow the current component value to be
5878 * overwritten, even if it is already set.
5879 */
5880 public static final int FILL_IN_COMPONENT = 1<<3;
5881
5882 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005883 * Use with {@link #fillIn} to allow the current package value to be
5884 * overwritten, even if it is already set.
5885 */
5886 public static final int FILL_IN_PACKAGE = 1<<4;
5887
5888 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005889 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005890 * overwritten, even if it is already set.
5891 */
5892 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5893
5894 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005895 * Use with {@link #fillIn} to allow the current selector to be
5896 * overwritten, even if it is already set.
5897 */
5898 public static final int FILL_IN_SELECTOR = 1<<6;
5899
5900 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005901 * Use with {@link #fillIn} to allow the current ClipData to be
5902 * overwritten, even if it is already set.
5903 */
5904 public static final int FILL_IN_CLIP_DATA = 1<<7;
5905
5906 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005907 * Copy the contents of <var>other</var> in to this object, but only
5908 * where fields are not defined by this object. For purposes of a field
5909 * being defined, the following pieces of data in the Intent are
5910 * considered to be separate fields:
5911 *
5912 * <ul>
5913 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005914 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005915 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5916 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005917 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005918 * <li> component, as set by {@link #setComponent(ComponentName)} or
5919 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005920 * <li> source bounds, as set by {@link #setSourceBounds}.
5921 * <li> selector, as set by {@link #setSelector(Intent)}.
5922 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005923 * <li> each top-level name in the associated extras.
5924 * </ul>
5925 *
5926 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005927 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005928 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5929 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5930 * the restriction where the corresponding field will not be replaced if
5931 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005932 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005933 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
5934 * is explicitly specified. The selector will only be copied if
5935 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005936 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005937 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5938 * and Intent B with {action="gotit", data-type="some/thing",
5939 * categories="one","two"}.
5940 *
5941 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5942 * containing: {action="gotit", data-type="some/thing",
5943 * categories="bar"}.
5944 *
5945 * @param other Another Intent whose values are to be used to fill in
5946 * the current one.
5947 * @param flags Options to control which fields can be filled in.
5948 *
5949 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005950 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005951 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5952 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005953 */
5954 public int fillIn(Intent other, int flags) {
5955 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005956 if (other.mAction != null
5957 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005958 mAction = other.mAction;
5959 changes |= FILL_IN_ACTION;
5960 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005961 if ((other.mData != null || other.mType != null)
5962 && ((mData == null && mType == null)
5963 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005964 mData = other.mData;
5965 mType = other.mType;
5966 changes |= FILL_IN_DATA;
5967 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005968 if (other.mCategories != null
5969 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005970 if (other.mCategories != null) {
5971 mCategories = new HashSet<String>(other.mCategories);
5972 }
5973 changes |= FILL_IN_CATEGORIES;
5974 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005975 if (other.mPackage != null
5976 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005977 // Only do this if mSelector is not set.
5978 if (mSelector == null) {
5979 mPackage = other.mPackage;
5980 changes |= FILL_IN_PACKAGE;
5981 }
5982 }
5983 // Selector is special: it can only be set if explicitly allowed,
5984 // for the same reason as the component name.
5985 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5986 if (mPackage == null) {
5987 mSelector = new Intent(other.mSelector);
5988 mPackage = null;
5989 changes |= FILL_IN_SELECTOR;
5990 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005991 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005992 if (other.mClipData != null
5993 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
5994 mClipData = other.mClipData;
5995 changes |= FILL_IN_CLIP_DATA;
5996 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005997 // Component is special: it can -only- be set if explicitly allowed,
5998 // since otherwise the sender could force the intent somewhere the
5999 // originator didn't intend.
6000 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006001 mComponent = other.mComponent;
6002 changes |= FILL_IN_COMPONENT;
6003 }
6004 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006005 if (other.mSourceBounds != null
6006 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6007 mSourceBounds = new Rect(other.mSourceBounds);
6008 changes |= FILL_IN_SOURCE_BOUNDS;
6009 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006010 if (mExtras == null) {
6011 if (other.mExtras != null) {
6012 mExtras = new Bundle(other.mExtras);
6013 }
6014 } else if (other.mExtras != null) {
6015 try {
6016 Bundle newb = new Bundle(other.mExtras);
6017 newb.putAll(mExtras);
6018 mExtras = newb;
6019 } catch (RuntimeException e) {
6020 // Modifying the extras can cause us to unparcel the contents
6021 // of the bundle, and if we do this in the system process that
6022 // may fail. We really should handle this (i.e., the Bundle
6023 // impl shouldn't be on top of a plain map), but for now just
6024 // ignore it and keep the original contents. :(
6025 Log.w("Intent", "Failure filling in extras", e);
6026 }
6027 }
6028 return changes;
6029 }
6030
6031 /**
6032 * Wrapper class holding an Intent and implementing comparisons on it for
6033 * the purpose of filtering. The class implements its
6034 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6035 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6036 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6037 * on the wrapped Intent.
6038 */
6039 public static final class FilterComparison {
6040 private final Intent mIntent;
6041 private final int mHashCode;
6042
6043 public FilterComparison(Intent intent) {
6044 mIntent = intent;
6045 mHashCode = intent.filterHashCode();
6046 }
6047
6048 /**
6049 * Return the Intent that this FilterComparison represents.
6050 * @return Returns the Intent held by the FilterComparison. Do
6051 * not modify!
6052 */
6053 public Intent getIntent() {
6054 return mIntent;
6055 }
6056
6057 @Override
6058 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006059 if (obj instanceof FilterComparison) {
6060 Intent other = ((FilterComparison)obj).mIntent;
6061 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006062 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006063 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006064 }
6065
6066 @Override
6067 public int hashCode() {
6068 return mHashCode;
6069 }
6070 }
6071
6072 /**
6073 * Determine if two intents are the same for the purposes of intent
6074 * resolution (filtering). That is, if their action, data, type,
6075 * class, and categories are the same. This does <em>not</em> compare
6076 * any extra data included in the intents.
6077 *
6078 * @param other The other Intent to compare against.
6079 *
6080 * @return Returns true if action, data, type, class, and categories
6081 * are the same.
6082 */
6083 public boolean filterEquals(Intent other) {
6084 if (other == null) {
6085 return false;
6086 }
6087 if (mAction != other.mAction) {
6088 if (mAction != null) {
6089 if (!mAction.equals(other.mAction)) {
6090 return false;
6091 }
6092 } else {
6093 if (!other.mAction.equals(mAction)) {
6094 return false;
6095 }
6096 }
6097 }
6098 if (mData != other.mData) {
6099 if (mData != null) {
6100 if (!mData.equals(other.mData)) {
6101 return false;
6102 }
6103 } else {
6104 if (!other.mData.equals(mData)) {
6105 return false;
6106 }
6107 }
6108 }
6109 if (mType != other.mType) {
6110 if (mType != null) {
6111 if (!mType.equals(other.mType)) {
6112 return false;
6113 }
6114 } else {
6115 if (!other.mType.equals(mType)) {
6116 return false;
6117 }
6118 }
6119 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006120 if (mPackage != other.mPackage) {
6121 if (mPackage != null) {
6122 if (!mPackage.equals(other.mPackage)) {
6123 return false;
6124 }
6125 } else {
6126 if (!other.mPackage.equals(mPackage)) {
6127 return false;
6128 }
6129 }
6130 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006131 if (mComponent != other.mComponent) {
6132 if (mComponent != null) {
6133 if (!mComponent.equals(other.mComponent)) {
6134 return false;
6135 }
6136 } else {
6137 if (!other.mComponent.equals(mComponent)) {
6138 return false;
6139 }
6140 }
6141 }
6142 if (mCategories != other.mCategories) {
6143 if (mCategories != null) {
6144 if (!mCategories.equals(other.mCategories)) {
6145 return false;
6146 }
6147 } else {
6148 if (!other.mCategories.equals(mCategories)) {
6149 return false;
6150 }
6151 }
6152 }
6153
6154 return true;
6155 }
6156
6157 /**
6158 * Generate hash code that matches semantics of filterEquals().
6159 *
6160 * @return Returns the hash value of the action, data, type, class, and
6161 * categories.
6162 *
6163 * @see #filterEquals
6164 */
6165 public int filterHashCode() {
6166 int code = 0;
6167 if (mAction != null) {
6168 code += mAction.hashCode();
6169 }
6170 if (mData != null) {
6171 code += mData.hashCode();
6172 }
6173 if (mType != null) {
6174 code += mType.hashCode();
6175 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006176 if (mPackage != null) {
6177 code += mPackage.hashCode();
6178 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006179 if (mComponent != null) {
6180 code += mComponent.hashCode();
6181 }
6182 if (mCategories != null) {
6183 code += mCategories.hashCode();
6184 }
6185 return code;
6186 }
6187
6188 @Override
6189 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006190 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006191
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006192 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006193 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006194 b.append(" }");
6195
6196 return b.toString();
6197 }
6198
6199 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006200 public String toInsecureString() {
6201 StringBuilder b = new StringBuilder(128);
6202
6203 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006204 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006205 b.append(" }");
6206
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006207 return b.toString();
6208 }
Romain Guy4969af72009-06-17 10:53:19 -07006209
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006210 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006211 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006212 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006213
6214 b.append("Intent { ");
6215 toShortString(b, false, true, true, true);
6216 b.append(" }");
6217
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006218 return b.toString();
6219 }
6220
6221 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006222 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6223 StringBuilder b = new StringBuilder(128);
6224 toShortString(b, secure, comp, extras, clip);
6225 return b.toString();
6226 }
6227
6228 /** @hide */
6229 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6230 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006231 boolean first = true;
6232 if (mAction != null) {
6233 b.append("act=").append(mAction);
6234 first = false;
6235 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006236 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006237 if (!first) {
6238 b.append(' ');
6239 }
6240 first = false;
6241 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006242 Iterator<String> i = mCategories.iterator();
6243 boolean didone = false;
6244 while (i.hasNext()) {
6245 if (didone) b.append(",");
6246 didone = true;
6247 b.append(i.next());
6248 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006249 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006250 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006251 if (mData != null) {
6252 if (!first) {
6253 b.append(' ');
6254 }
6255 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006256 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006257 if (secure) {
6258 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006259 } else {
6260 b.append(mData);
6261 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006262 }
6263 if (mType != null) {
6264 if (!first) {
6265 b.append(' ');
6266 }
6267 first = false;
6268 b.append("typ=").append(mType);
6269 }
6270 if (mFlags != 0) {
6271 if (!first) {
6272 b.append(' ');
6273 }
6274 first = false;
6275 b.append("flg=0x").append(Integer.toHexString(mFlags));
6276 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006277 if (mPackage != null) {
6278 if (!first) {
6279 b.append(' ');
6280 }
6281 first = false;
6282 b.append("pkg=").append(mPackage);
6283 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006284 if (comp && mComponent != null) {
6285 if (!first) {
6286 b.append(' ');
6287 }
6288 first = false;
6289 b.append("cmp=").append(mComponent.flattenToShortString());
6290 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006291 if (mSourceBounds != null) {
6292 if (!first) {
6293 b.append(' ');
6294 }
6295 first = false;
6296 b.append("bnds=").append(mSourceBounds.toShortString());
6297 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006298 if (mClipData != null) {
6299 if (!first) {
6300 b.append(' ');
6301 }
6302 first = false;
6303 if (clip) {
6304 b.append("clip={");
6305 mClipData.toShortString(b);
6306 b.append('}');
6307 } else {
6308 b.append("(has clip)");
6309 }
6310 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006311 if (extras && mExtras != null) {
6312 if (!first) {
6313 b.append(' ');
6314 }
6315 first = false;
6316 b.append("(has extras)");
6317 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006318 if (mSelector != null) {
6319 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006320 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006321 b.append("}");
6322 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006323 }
6324
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006325 /**
6326 * Call {@link #toUri} with 0 flags.
6327 * @deprecated Use {@link #toUri} instead.
6328 */
6329 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006330 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006331 return toUri(0);
6332 }
6333
6334 /**
6335 * Convert this Intent into a String holding a URI representation of it.
6336 * The returned URI string has been properly URI encoded, so it can be
6337 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6338 * Intent's data as the base URI, with an additional fragment describing
6339 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006340 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006341 * <p>You can convert the returned string back to an Intent with
6342 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006343 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006344 * @param flags Additional operating flags. Either 0 or
6345 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006346 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006347 * @return Returns a URI encoding URI string describing the entire contents
6348 * of the Intent.
6349 */
6350 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006351 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006352 String scheme = null;
6353 if (mData != null) {
6354 String data = mData.toString();
6355 if ((flags&URI_INTENT_SCHEME) != 0) {
6356 final int N = data.length();
6357 for (int i=0; i<N; i++) {
6358 char c = data.charAt(i);
6359 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6360 || c == '.' || c == '-') {
6361 continue;
6362 }
6363 if (c == ':' && i > 0) {
6364 // Valid scheme.
6365 scheme = data.substring(0, i);
6366 uri.append("intent:");
6367 data = data.substring(i+1);
6368 break;
6369 }
Tom Taylord4a47292009-12-21 13:59:18 -08006370
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006371 // No scheme.
6372 break;
6373 }
6374 }
6375 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006376
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006377 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6378 uri.append("intent:");
6379 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006380
6381 uri.append("#Intent;");
6382
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006383 toUriInner(uri, scheme, flags);
6384 if (mSelector != null) {
6385 uri.append("SEL;");
6386 // Note that for now we are not going to try to handle the
6387 // data part; not clear how to represent this as a URI, and
6388 // not much utility in it.
6389 mSelector.toUriInner(uri, null, flags);
6390 }
6391
6392 uri.append("end");
6393
6394 return uri.toString();
6395 }
6396
6397 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006398 if (scheme != null) {
6399 uri.append("scheme=").append(scheme).append(';');
6400 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006401 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006402 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006403 }
6404 if (mCategories != null) {
6405 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006406 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006407 }
6408 }
6409 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006410 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006411 }
6412 if (mFlags != 0) {
6413 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6414 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006415 if (mPackage != null) {
6416 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6417 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006418 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006419 uri.append("component=").append(Uri.encode(
6420 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006421 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006422 if (mSourceBounds != null) {
6423 uri.append("sourceBounds=")
6424 .append(Uri.encode(mSourceBounds.flattenToString()))
6425 .append(';');
6426 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006427 if (mExtras != null) {
6428 for (String key : mExtras.keySet()) {
6429 final Object value = mExtras.get(key);
6430 char entryType =
6431 value instanceof String ? 'S' :
6432 value instanceof Boolean ? 'B' :
6433 value instanceof Byte ? 'b' :
6434 value instanceof Character ? 'c' :
6435 value instanceof Double ? 'd' :
6436 value instanceof Float ? 'f' :
6437 value instanceof Integer ? 'i' :
6438 value instanceof Long ? 'l' :
6439 value instanceof Short ? 's' :
6440 '\0';
6441
6442 if (entryType != '\0') {
6443 uri.append(entryType);
6444 uri.append('.');
6445 uri.append(Uri.encode(key));
6446 uri.append('=');
6447 uri.append(Uri.encode(value.toString()));
6448 uri.append(';');
6449 }
6450 }
6451 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006452 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006453
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006454 public int describeContents() {
6455 return (mExtras != null) ? mExtras.describeContents() : 0;
6456 }
6457
6458 public void writeToParcel(Parcel out, int flags) {
6459 out.writeString(mAction);
6460 Uri.writeToParcel(out, mData);
6461 out.writeString(mType);
6462 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006463 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006464 ComponentName.writeToParcel(mComponent, out);
6465
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006466 if (mSourceBounds != null) {
6467 out.writeInt(1);
6468 mSourceBounds.writeToParcel(out, flags);
6469 } else {
6470 out.writeInt(0);
6471 }
6472
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006473 if (mCategories != null) {
6474 out.writeInt(mCategories.size());
6475 for (String category : mCategories) {
6476 out.writeString(category);
6477 }
6478 } else {
6479 out.writeInt(0);
6480 }
6481
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006482 if (mSelector != null) {
6483 out.writeInt(1);
6484 mSelector.writeToParcel(out, flags);
6485 } else {
6486 out.writeInt(0);
6487 }
6488
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006489 if (mClipData != null) {
6490 out.writeInt(1);
6491 mClipData.writeToParcel(out, flags);
6492 } else {
6493 out.writeInt(0);
6494 }
6495
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006496 out.writeBundle(mExtras);
6497 }
6498
6499 public static final Parcelable.Creator<Intent> CREATOR
6500 = new Parcelable.Creator<Intent>() {
6501 public Intent createFromParcel(Parcel in) {
6502 return new Intent(in);
6503 }
6504 public Intent[] newArray(int size) {
6505 return new Intent[size];
6506 }
6507 };
6508
Dianne Hackborneb034652009-09-07 00:49:58 -07006509 /** @hide */
6510 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006511 readFromParcel(in);
6512 }
6513
6514 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006515 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006516 mData = Uri.CREATOR.createFromParcel(in);
6517 mType = in.readString();
6518 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006519 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006520 mComponent = ComponentName.readFromParcel(in);
6521
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006522 if (in.readInt() != 0) {
6523 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6524 }
6525
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006526 int N = in.readInt();
6527 if (N > 0) {
6528 mCategories = new HashSet<String>();
6529 int i;
6530 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006531 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006532 }
6533 } else {
6534 mCategories = null;
6535 }
6536
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006537 if (in.readInt() != 0) {
6538 mSelector = new Intent(in);
6539 }
6540
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006541 if (in.readInt() != 0) {
6542 mClipData = new ClipData(in);
6543 }
6544
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006545 mExtras = in.readBundle();
6546 }
6547
6548 /**
6549 * Parses the "intent" element (and its children) from XML and instantiates
6550 * an Intent object. The given XML parser should be located at the tag
6551 * where parsing should start (often named "intent"), from which the
6552 * basic action, data, type, and package and class name will be
6553 * retrieved. The function will then parse in to any child elements,
6554 * looking for <category android:name="xxx"> tags to add categories and
6555 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6556 * to the intent.
6557 *
6558 * @param resources The Resources to use when inflating resources.
6559 * @param parser The XML parser pointing at an "intent" tag.
6560 * @param attrs The AttributeSet interface for retrieving extended
6561 * attribute data at the current <var>parser</var> location.
6562 * @return An Intent object matching the XML data.
6563 * @throws XmlPullParserException If there was an XML parsing error.
6564 * @throws IOException If there was an I/O error.
6565 */
6566 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6567 throws XmlPullParserException, IOException {
6568 Intent intent = new Intent();
6569
6570 TypedArray sa = resources.obtainAttributes(attrs,
6571 com.android.internal.R.styleable.Intent);
6572
6573 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6574
6575 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6576 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6577 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6578
6579 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6580 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6581 if (packageName != null && className != null) {
6582 intent.setComponent(new ComponentName(packageName, className));
6583 }
6584
6585 sa.recycle();
6586
6587 int outerDepth = parser.getDepth();
6588 int type;
6589 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6590 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6591 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6592 continue;
6593 }
6594
6595 String nodeName = parser.getName();
6596 if (nodeName.equals("category")) {
6597 sa = resources.obtainAttributes(attrs,
6598 com.android.internal.R.styleable.IntentCategory);
6599 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6600 sa.recycle();
6601
6602 if (cat != null) {
6603 intent.addCategory(cat);
6604 }
6605 XmlUtils.skipCurrentTag(parser);
6606
6607 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006608 if (intent.mExtras == null) {
6609 intent.mExtras = new Bundle();
6610 }
6611 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6612 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006613
6614 } else {
6615 XmlUtils.skipCurrentTag(parser);
6616 }
6617 }
6618
6619 return intent;
6620 }
Nick Pellyccae4122012-01-09 14:12:58 -08006621
6622 /**
6623 * Normalize a MIME data type.
6624 *
6625 * <p>A normalized MIME type has white-space trimmed,
6626 * content-type parameters removed, and is lower-case.
6627 * This aligns the type with Android best practices for
6628 * intent filtering.
6629 *
6630 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6631 * "text/x-vCard" becomes "text/x-vcard".
6632 *
6633 * <p>All MIME types received from outside Android (such as user input,
6634 * or external sources like Bluetooth, NFC, or the Internet) should
6635 * be normalized before they are used to create an Intent.
6636 *
6637 * @param type MIME data type to normalize
6638 * @return normalized MIME data type, or null if the input was null
6639 * @see {@link #setType}
6640 * @see {@link #setTypeAndNormalize}
6641 */
6642 public static String normalizeMimeType(String type) {
6643 if (type == null) {
6644 return null;
6645 }
6646
6647 type = type.trim().toLowerCase(Locale.US);
6648
6649 final int semicolonIndex = type.indexOf(';');
6650 if (semicolonIndex != -1) {
6651 type = type.substring(0, semicolonIndex);
6652 }
6653 return type;
6654 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006655
6656 /**
6657 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006658 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6659 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006660 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006661 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006662 * @hide
6663 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006664 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006665 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006666 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006667
6668 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006669 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006670
6671 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006672 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006673 try {
6674 // Inspect target intent to see if we need to migrate
6675 final Intent target = getParcelableExtra(EXTRA_INTENT);
6676 if (target != null && target.migrateExtraStreamToClipData()) {
6677 // Since we migrated in child, we need to promote ClipData
6678 // and flags to ourselves to grant.
6679 setClipData(target.getClipData());
6680 addFlags(target.getFlags()
6681 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6682 return true;
6683 } else {
6684 return false;
6685 }
6686 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006687 }
6688
6689 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006690 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006691 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6692 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6693 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6694 if (stream != null || text != null || htmlText != null) {
6695 final ClipData clipData = new ClipData(
6696 null, new String[] { getType() },
6697 new ClipData.Item(text, htmlText, null, stream));
6698 setClipData(clipData);
6699 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006700 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006701 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006702 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006703 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006704
6705 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006706 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006707 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6708 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6709 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6710 int num = -1;
6711 if (streams != null) {
6712 num = streams.size();
6713 }
6714 if (texts != null) {
6715 if (num >= 0 && num != texts.size()) {
6716 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006717 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006718 }
6719 num = texts.size();
6720 }
6721 if (htmlTexts != null) {
6722 if (num >= 0 && num != htmlTexts.size()) {
6723 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006724 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006725 }
6726 num = htmlTexts.size();
6727 }
6728 if (num > 0) {
6729 final ClipData clipData = new ClipData(
6730 null, new String[] { getType() },
6731 makeClipItem(streams, texts, htmlTexts, 0));
6732
6733 for (int i = 1; i < num; i++) {
6734 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6735 }
6736
6737 setClipData(clipData);
6738 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006739 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006740 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006741 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006742 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006743 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006744
6745 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006746 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006747
6748 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6749 ArrayList<String> htmlTexts, int which) {
6750 Uri uri = streams != null ? streams.get(which) : null;
6751 CharSequence text = texts != null ? texts.get(which) : null;
6752 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6753 return new ClipData.Item(text, htmlText, null, uri);
6754 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006755}