blob: 352f996b08d41f69a76408ef9f0f4436ebb86615 [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 cannings368ed012012-06-07 15:37:57 -0700573 * <li> {@link #EXTRA_ORIGINATING_URL}
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 cannings368ed012012-06-07 15:37:57 -07001290 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} and
1291 * {@link #ACTION_VIEW} to indicate the URL from which the local APK in the Intent
1292 * data field originated from.
1293 */
1294 public static final String EXTRA_ORIGINATING_URL
1295 = "android.intent.extra.ORIGINATING_URL";
1296
1297 /**
1298 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} and
1299 * {@link #ACTION_VIEW} to indicate the HTTP referrer associated with the Intent
1300 * data field or {@link #EXTRA_ORIGINATING_URL}.
1301 */
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 /**
2281 * Broadcast sent to the system when a user is added. Carries an extra EXTRA_USERID that has the
2282 * userid of the new user.
2283 * @hide
2284 */
2285 public static final String ACTION_USER_ADDED =
2286 "android.intent.action.USER_ADDED";
2287
2288 /**
2289 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USERID that has
2290 * the userid of the user.
2291 * @hide
2292 */
2293 public static final String ACTION_USER_REMOVED =
2294 "android.intent.action.USER_REMOVED";
2295
2296 /**
2297 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USERID that has
2298 * the userid of the user to become the current one.
2299 * @hide
2300 */
2301 public static final String ACTION_USER_SWITCHED =
2302 "android.intent.action.USER_SWITCHED";
2303
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002304 // ---------------------------------------------------------------------
2305 // ---------------------------------------------------------------------
2306 // Standard intent categories (see addCategory()).
2307
2308 /**
2309 * Set if the activity should be an option for the default action
2310 * (center press) to perform on a piece of data. Setting this will
2311 * hide from the user any activities without it set when performing an
2312 * action on some data. Note that this is normal -not- set in the
2313 * Intent when initiating an action -- it is for use in intent filters
2314 * specified in packages.
2315 */
2316 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2317 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2318 /**
2319 * Activities that can be safely invoked from a browser must support this
2320 * category. For example, if the user is viewing a web page or an e-mail
2321 * and clicks on a link in the text, the Intent generated execute that
2322 * link will require the BROWSABLE category, so that only activities
2323 * supporting this category will be considered as possible actions. By
2324 * supporting this category, you are promising that there is nothing
2325 * damaging (without user intervention) that can happen by invoking any
2326 * matching Intent.
2327 */
2328 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2329 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2330 /**
2331 * Set if the activity should be considered as an alternative action to
2332 * the data the user is currently viewing. See also
2333 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2334 * applies to the selection in a list of items.
2335 *
2336 * <p>Supporting this category means that you would like your activity to be
2337 * displayed in the set of alternative things the user can do, usually as
2338 * part of the current activity's options menu. You will usually want to
2339 * include a specific label in the &lt;intent-filter&gt; of this action
2340 * describing to the user what it does.
2341 *
2342 * <p>The action of IntentFilter with this category is important in that it
2343 * describes the specific action the target will perform. This generally
2344 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2345 * a specific name such as "com.android.camera.action.CROP. Only one
2346 * alternative of any particular action will be shown to the user, so using
2347 * a specific action like this makes sure that your alternative will be
2348 * displayed while also allowing other applications to provide their own
2349 * overrides of that particular action.
2350 */
2351 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2352 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2353 /**
2354 * Set if the activity should be considered as an alternative selection
2355 * action to the data the user has currently selected. This is like
2356 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2357 * of items from which the user can select, giving them alternatives to the
2358 * default action that will be performed on it.
2359 */
2360 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2361 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2362 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002363 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002364 */
2365 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2366 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2367 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002368 * Should be displayed in the top-level launcher.
2369 */
2370 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2371 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2372 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002373 * Provides information about the package it is in; typically used if
2374 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2375 * a front-door to the user without having to be shown in the all apps list.
2376 */
2377 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2378 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2379 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002380 * This is the home activity, that is the first activity that is displayed
2381 * when the device boots.
2382 */
2383 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2384 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2385 /**
2386 * This activity is a preference panel.
2387 */
2388 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2389 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2390 /**
2391 * This activity is a development preference panel.
2392 */
2393 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2394 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2395 /**
2396 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002397 */
2398 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2399 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2400 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002401 * This activity allows the user to browse and download new applications.
2402 */
2403 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2404 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2405 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002406 * This activity may be exercised by the monkey or other automated test tools.
2407 */
2408 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2409 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2410 /**
2411 * To be used as a test (not part of the normal user experience).
2412 */
2413 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2414 /**
2415 * To be used as a unit test (run through the Test Harness).
2416 */
2417 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2418 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002419 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002420 * experience).
2421 */
2422 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2423 /**
2424 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
2425 * ContentResolver.openInputStream. Openable URIs must support the columns in OpenableColumns
2426 * when queried, though it is allowable for those columns to be blank.
2427 */
2428 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2429 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2430
2431 /**
2432 * To be used as code under test for framework instrumentation tests.
2433 */
2434 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2435 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002436 /**
2437 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002438 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2439 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002440 */
2441 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2442 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2443 /**
2444 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002445 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2446 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002447 */
2448 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2449 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002450 /**
2451 * An activity to run when device is inserted into a analog (low end) dock.
2452 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2453 * information, see {@link android.app.UiModeManager}.
2454 */
2455 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2456 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2457
2458 /**
2459 * An activity to run when device is inserted into a digital (high end) dock.
2460 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2461 * information, see {@link android.app.UiModeManager}.
2462 */
2463 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2464 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002465
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002466 /**
2467 * Used to indicate that the activity can be used in a car environment.
2468 */
2469 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2470 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2471
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002472 // ---------------------------------------------------------------------
2473 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002474 // Application launch intent categories (see addCategory()).
2475
2476 /**
2477 * Used with {@link #ACTION_MAIN} to launch the browser application.
2478 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002479 * <p>NOTE: This should not be used as the primary key of an Intent,
2480 * since it will not result in the app launching with the correct
2481 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002482 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002483 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002484 */
2485 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2486 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2487
2488 /**
2489 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2490 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002491 * <p>NOTE: This should not be used as the primary key of an Intent,
2492 * since it will not result in the app launching with the correct
2493 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002494 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002495 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002496 */
2497 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2498 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2499
2500 /**
2501 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2502 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002503 * <p>NOTE: This should not be used as the primary key of an Intent,
2504 * since it will not result in the app launching with the correct
2505 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002506 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002507 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002508 */
2509 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2510 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2511
2512 /**
2513 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2514 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002515 * <p>NOTE: This should not be used as the primary key of an Intent,
2516 * since it will not result in the app launching with the correct
2517 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002518 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002519 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002520 */
2521 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2522 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2523
2524 /**
2525 * Used with {@link #ACTION_MAIN} to launch the email application.
2526 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002527 * <p>NOTE: This should not be used as the primary key of an Intent,
2528 * since it will not result in the app launching with the correct
2529 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002530 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002531 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002532 */
2533 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2534 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2535
2536 /**
2537 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2538 * The activity should be able to view and manipulate image and video files
2539 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002540 * <p>NOTE: This should not be used as the primary key of an Intent,
2541 * since it will not result in the app launching with the correct
2542 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002543 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002544 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002545 */
2546 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2547 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2548
2549 /**
2550 * Used with {@link #ACTION_MAIN} to launch the maps application.
2551 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002552 * <p>NOTE: This should not be used as the primary key of an Intent,
2553 * since it will not result in the app launching with the correct
2554 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002555 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002556 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002557 */
2558 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2559 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2560
2561 /**
2562 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2563 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002564 * <p>NOTE: This should not be used as the primary key of an Intent,
2565 * since it will not result in the app launching with the correct
2566 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002567 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002568 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002569 */
2570 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2571 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2572
2573 /**
2574 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002575 * The activity should be able to play, browse, or manipulate music files
2576 * stored on the device.
2577 * <p>NOTE: This should not be used as the primary key of an Intent,
2578 * since it will not result in the app launching with the correct
2579 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002580 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002581 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002582 */
2583 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2584 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2585
2586 // ---------------------------------------------------------------------
2587 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002588 // Standard extra data keys.
2589
2590 /**
2591 * The initial data to place in a newly created record. Use with
2592 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2593 * fields as would be given to the underlying ContentProvider.insert()
2594 * call.
2595 */
2596 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2597
2598 /**
2599 * A constant CharSequence that is associated with the Intent, used with
2600 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2601 * this may be a styled CharSequence, so you must use
2602 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2603 * retrieve it.
2604 */
2605 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2606
2607 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002608 * A constant String that is associated with the Intent, used with
2609 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2610 * as HTML formatted text. Note that you <em>must</em> also supply
2611 * {@link #EXTRA_TEXT}.
2612 */
2613 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2614
2615 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002616 * A content: URI holding a stream of data associated with the Intent,
2617 * used with {@link #ACTION_SEND} to supply the data being sent.
2618 */
2619 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2620
2621 /**
2622 * A String[] holding e-mail addresses that should be delivered to.
2623 */
2624 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2625
2626 /**
2627 * A String[] holding e-mail addresses that should be carbon copied.
2628 */
2629 public static final String EXTRA_CC = "android.intent.extra.CC";
2630
2631 /**
2632 * A String[] holding e-mail addresses that should be blind carbon copied.
2633 */
2634 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2635
2636 /**
2637 * A constant string holding the desired subject line of a message.
2638 */
2639 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2640
2641 /**
2642 * An Intent describing the choices you would like shown with
2643 * {@link #ACTION_PICK_ACTIVITY}.
2644 */
2645 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2646
2647 /**
2648 * A CharSequence dialog title to provide to the user when used with a
2649 * {@link #ACTION_CHOOSER}.
2650 */
2651 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2652
2653 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002654 * A Parcelable[] of {@link Intent} or
2655 * {@link android.content.pm.LabeledIntent} objects as set with
2656 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2657 * a the front of the list of choices, when shown to the user with a
2658 * {@link #ACTION_CHOOSER}.
2659 */
2660 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2661
2662 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002663 * A {@link android.view.KeyEvent} object containing the event that
2664 * triggered the creation of the Intent it is in.
2665 */
2666 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2667
2668 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002669 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2670 * before shutting down.
2671 *
2672 * {@hide}
2673 */
2674 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2675
2676 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002677 * 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 -07002678 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2679 * of restarting the application.
2680 */
2681 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2682
2683 /**
2684 * A String holding the phone number originally entered in
2685 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2686 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2687 */
2688 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002689
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002690 /**
2691 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2692 * intents to supply the uid the package had been assigned. Also an optional
2693 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2694 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2695 * purpose.
2696 */
2697 public static final String EXTRA_UID = "android.intent.extra.UID";
2698
2699 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002700 * @hide String array of package names.
2701 */
2702 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2703
2704 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002705 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2706 * intents to indicate whether this represents a full uninstall (removing
2707 * both the code and its data) or a partial uninstall (leaving its data,
2708 * implying that this is an update).
2709 */
2710 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002711
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002712 /**
2713 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2714 * intents to indicate that this is a replacement of the package, so this
2715 * broadcast will immediately be followed by an add broadcast for a
2716 * different version of the same package.
2717 */
2718 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002719
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002720 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002721 * Used as an int extra field in {@link android.app.AlarmManager} intents
2722 * to tell the application being invoked how many pending alarms are being
2723 * delievered with the intent. For one-shot alarms this will always be 1.
2724 * For recurring alarms, this might be greater than 1 if the device was
2725 * asleep or powered off at the time an earlier alarm would have been
2726 * delivered.
2727 */
2728 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07002729
Jacek Surazski86b6c532009-05-13 14:38:28 +02002730 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002731 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
2732 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07002733 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
2734 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002735 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
2736 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
2737 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002738 */
2739 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
2740
2741 /**
2742 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2743 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002744 */
2745 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
2746
2747 /**
2748 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2749 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002750 */
2751 public static final int EXTRA_DOCK_STATE_DESK = 1;
2752
2753 /**
2754 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2755 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002756 */
2757 public static final int EXTRA_DOCK_STATE_CAR = 2;
2758
2759 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002760 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2761 * to represent that the phone is in a analog (low end) dock.
2762 */
2763 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
2764
2765 /**
2766 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
2767 * to represent that the phone is in a digital (high end) dock.
2768 */
2769 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
2770
2771 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002772 * Boolean that can be supplied as meta-data with a dock activity, to
2773 * indicate that the dock should take over the home key when it is active.
2774 */
2775 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08002776
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07002777 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02002778 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
2779 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02002780 */
2781 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
2782
2783 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002784 * Used in the extra field in the remote intent. It's astring token passed with the
2785 * remote intent.
2786 */
2787 public static final String EXTRA_REMOTE_INTENT_TOKEN =
2788 "android.intent.extra.remote_intent_token";
2789
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002790 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002791 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002792 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002793 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08002794 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07002795 "android.intent.extra.changed_component_name";
2796
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002797 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002798 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackborn86a72da2009-11-11 20:12:41 -08002799 * and contains a string array of all of the components that have changed.
2800 */
2801 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
2802 "android.intent.extra.changed_component_name_list";
2803
2804 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002805 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08002806 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
2807 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002808 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002809 */
2810 public static final String EXTRA_CHANGED_PACKAGE_LIST =
2811 "android.intent.extra.changed_package_list";
2812
2813 /**
2814 * 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 an integer array of uids of all of the components
2818 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08002819 */
2820 public static final String EXTRA_CHANGED_UID_LIST =
2821 "android.intent.extra.changed_uid_list";
2822
2823 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07002824 * @hide
2825 * Magic extra system code can use when binding, to give a label for
2826 * who it is that has bound to a service. This is an integer giving
2827 * a framework string resource that can be displayed to the user.
2828 */
2829 public static final String EXTRA_CLIENT_LABEL =
2830 "android.intent.extra.client_label";
2831
2832 /**
2833 * @hide
2834 * Magic extra system code can use when binding, to give a PendingIntent object
2835 * that can be launched for the user to disable the system's use of this
2836 * service.
2837 */
2838 public static final String EXTRA_CLIENT_INTENT =
2839 "android.intent.extra.client_intent";
2840
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08002841 /**
2842 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
2843 * data that is on the local device. This is a boolean extra; the default
2844 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
2845 * the user to select media that is already on the device, not requiring it
2846 * be downloaded from a remote service when opened. Another way to look
2847 * at it is that such content should generally have a "_data" column to the
2848 * path of the content on local external storage.
2849 */
2850 public static final String EXTRA_LOCAL_ONLY =
2851 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07002852
Amith Yamasani13593602012-03-22 16:16:17 -07002853 /**
2854 * The userid carried with broadcast intents related to addition, removal and switching of users
2855 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
2856 * @hide
2857 */
2858 public static final String EXTRA_USERID =
2859 "android.intent.extra.user_id";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002860 // ---------------------------------------------------------------------
2861 // ---------------------------------------------------------------------
2862 // Intent flags (see mFlags variable).
2863
2864 /**
2865 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002866 * perform read operations on the Uri in the Intent's data and any URIs
2867 * specified in its ClipData. When applying to an Intent's ClipData,
2868 * all URIs as well as recursive traversals through data or other ClipData
2869 * in Intent items will be granted; only the grant flags of the top-level
2870 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002871 */
2872 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
2873 /**
2874 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08002875 * perform write operations on the Uri in the Intent's data and any URIs
2876 * specified in its ClipData. When applying to an Intent's ClipData,
2877 * all URIs as well as recursive traversals through data or other ClipData
2878 * in Intent items will be granted; only the grant flags of the top-level
2879 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002880 */
2881 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
2882 /**
2883 * Can be set by the caller to indicate that this Intent is coming from
2884 * a background operation, not from direct user interaction.
2885 */
2886 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
2887 /**
2888 * A flag you can enable for debugging: when set, log messages will be
2889 * printed during the resolution of this intent to show you what has
2890 * been found to create the final resolved list.
2891 */
2892 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08002893 /**
2894 * If set, this intent will not match any components in packages that
2895 * are currently stopped. If this is not set, then the default behavior
2896 * is to include such applications in the result.
2897 */
2898 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
2899 /**
2900 * If set, this intent will always match any components in packages that
2901 * are currently stopped. This is the default behavior when
2902 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
2903 * flags are set, this one wins (it allows overriding of exclude for
2904 * places where the framework may automatically set the exclude flag).
2905 */
2906 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002907
2908 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002909 * If set, the new activity is not kept in the history stack. As soon as
2910 * the user navigates away from it, the activity is finished. This may also
2911 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
2912 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002913 */
2914 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
2915 /**
2916 * If set, the activity will not be launched if it is already running
2917 * at the top of the history stack.
2918 */
2919 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
2920 /**
2921 * If set, this activity will become the start of a new task on this
2922 * history stack. A task (from the activity that started it to the
2923 * next task activity) defines an atomic group of activities that the
2924 * user can move to. Tasks can be moved to the foreground and background;
2925 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07002926 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08002927 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2928 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002929 *
2930 * <p>This flag is generally used by activities that want
2931 * to present a "launcher" style behavior: they give the user a list of
2932 * separate things that can be done, which otherwise run completely
2933 * independently of the activity launching them.
2934 *
2935 * <p>When using this flag, if a task is already running for the activity
2936 * you are now starting, then a new activity will not be started; instead,
2937 * the current task will simply be brought to the front of the screen with
2938 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
2939 * to disable this behavior.
2940 *
2941 * <p>This flag can not be used when the caller is requesting a result from
2942 * the activity being launched.
2943 */
2944 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
2945 /**
2946 * <strong>Do not use this flag unless you are implementing your own
2947 * top-level application launcher.</strong> Used in conjunction with
2948 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
2949 * behavior of bringing an existing task to the foreground. When set,
2950 * a new task is <em>always</em> started to host the Activity for the
2951 * Intent, regardless of whether there is already an existing task running
2952 * the same thing.
2953 *
2954 * <p><strong>Because the default system does not include graphical task management,
2955 * you should not use this flag unless you provide some way for a user to
2956 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07002957 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002958 * <p>This flag is ignored if
2959 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
2960 *
Scott Main7aee61f2011-02-08 11:25:01 -08002961 * <p>See
2962 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2963 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002964 */
2965 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
2966 /**
2967 * If set, and the activity being launched is already running in the
2968 * current task, then instead of launching a new instance of that activity,
2969 * all of the other activities on top of it will be closed and this Intent
2970 * will be delivered to the (now on top) old activity as a new Intent.
2971 *
2972 * <p>For example, consider a task consisting of the activities: A, B, C, D.
2973 * If D calls startActivity() with an Intent that resolves to the component
2974 * of activity B, then C and D will be finished and B receive the given
2975 * Intent, resulting in the stack now being: A, B.
2976 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002977 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002978 * either receive the new intent you are starting here in its
2979 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002980 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07002981 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
2982 * the same intent, then it will be finished and re-created; for all other
2983 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
2984 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002985 *
2986 * <p>This launch mode can also be used to good effect in conjunction with
2987 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
2988 * of a task, it will bring any currently running instance of that task
2989 * to the foreground, and then clear it to its root state. This is
2990 * especially useful, for example, when launching an activity from the
2991 * notification manager.
2992 *
Scott Main7aee61f2011-02-08 11:25:01 -08002993 * <p>See
2994 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
2995 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002996 */
2997 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
2998 /**
2999 * If set and this intent is being used to launch a new activity from an
3000 * existing one, then the reply target of the existing activity will be
3001 * transfered to the new activity. This way the new activity can call
3002 * {@link android.app.Activity#setResult} and have that result sent back to
3003 * the reply target of the original activity.
3004 */
3005 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3006 /**
3007 * If set and this intent is being used to launch a new activity from an
3008 * existing one, the current activity will not be counted as the top
3009 * activity for deciding whether the new intent should be delivered to
3010 * the top instead of starting a new one. The previous activity will
3011 * be used as the top, with the assumption being that the current activity
3012 * will finish itself immediately.
3013 */
3014 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3015 /**
3016 * If set, the new activity is not kept in the list of recently launched
3017 * activities.
3018 */
3019 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3020 /**
3021 * This flag is not normally set by application code, but set for you by
3022 * the system as described in the
3023 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3024 * launchMode} documentation for the singleTask mode.
3025 */
3026 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3027 /**
3028 * If set, and this activity is either being started in a new task or
3029 * bringing to the top an existing task, then it will be launched as
3030 * the front door of the task. This will result in the application of
3031 * any affinities needed to have that task in the proper state (either
3032 * moving activities to or from it), or simply resetting that task to
3033 * its initial state if needed.
3034 */
3035 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3036 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003037 * This flag is not normally set by application code, but set for you by
3038 * the system if this activity is being launched from history
3039 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003040 */
3041 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003042 /**
3043 * If set, this marks a point in the task's activity stack that should
3044 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003045 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003046 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3047 * the user re-launching it from home), this activity and all on top of
3048 * it will be finished so that the user does not return to them, but
3049 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003050 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003051 * <p>This is useful for cases where you have a logical break in your
3052 * application. For example, an e-mail application may have a command
3053 * to view an attachment, which launches an image view activity to
3054 * display it. This activity should be part of the e-mail application's
3055 * task, since it is a part of the task the user is involved in. However,
3056 * if the user leaves that task, and later selects the e-mail app from
3057 * home, we may like them to return to the conversation they were
3058 * viewing, not the picture attachment, since that is confusing. By
3059 * setting this flag when launching the image viewer, that viewer and
3060 * any activities it starts will be removed the next time the user returns
3061 * to mail.
3062 */
3063 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003064 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003065 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003066 * callback from occurring on the current frontmost activity before it is
3067 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003068 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003069 * <p>Typically, an activity can rely on that callback to indicate that an
3070 * explicit user action has caused their activity to be moved out of the
3071 * foreground. The callback marks an appropriate point in the activity's
3072 * lifecycle for it to dismiss any notifications that it intends to display
3073 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003074 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003075 * <p>If an activity is ever started via any non-user-driven events such as
3076 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3077 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003078 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003079 */
3080 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003081 /**
3082 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3083 * this flag will cause the launched activity to be brought to the front of its
3084 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003085 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003086 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3087 * If D calls startActivity() with an Intent that resolves to the component
3088 * of activity B, then B will be brought to the front of the history stack,
3089 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003090 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003091 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003092 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003093 */
3094 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003095 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003096 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3097 * this flag will prevent the system from applying an activity transition
3098 * animation to go to the next activity state. This doesn't mean an
3099 * animation will never run -- if another activity change happens that doesn't
3100 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003101 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003102 * when you are going to do a series of activity operations but the
3103 * animation seen by the user shouldn't be driven by the first activity
3104 * change but rather a later one.
3105 */
3106 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3107 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003108 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3109 * this flag will cause any existing task that would be associated with the
3110 * activity to be cleared before the activity is started. That is, the activity
3111 * becomes the new root of an otherwise empty task, and any old activities
3112 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3113 */
3114 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3115 /**
3116 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3117 * this flag will cause a newly launching task to be placed on top of the current
3118 * home activity task (if there is one). That is, pressing back from the task
3119 * will always return the user to home even if that was not the last activity they
3120 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3121 */
3122 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3123 /**
Dianne Hackborne302a162012-05-15 14:58:32 -07003124 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3125 * upon starting the activity the system will also clear any system dialogs that
3126 * are currently shown. This is intended primarily for any actions that are
3127 * associated with buttons in a notification: tapping on the button to launch
3128 * the activity needs to also dismiss the notification window (which is one
3129 * of the system dialogs); setting this flag on the Intent associated with that
3130 * action will ensure that and other system dialogs are dismissed so that the
3131 * user arrives in the new activity.
3132 */
3133 public static final int FLAG_ACTIVITY_CLOSE_SYSTEM_DIALOGS = 0X00002000;
3134 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003135 * If set, when sending a broadcast only registered receivers will be
3136 * called -- no BroadcastReceiver components will be launched.
3137 */
3138 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003139 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003140 * If set, when sending a broadcast the new broadcast will replace
3141 * any existing pending broadcast that matches it. Matching is defined
3142 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3143 * true for the intents of the two broadcasts. When a match is found,
3144 * the new broadcast (and receivers associated with it) will replace the
3145 * existing one in the pending broadcast list, remaining at the same
3146 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003147 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003148 * <p>This flag is most typically used with sticky broadcasts, which
3149 * only care about delivering the most recent values of the broadcast
3150 * to their receivers.
3151 */
3152 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3153 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003154 * If set, when sending a broadcast the recipient is allowed to run at
3155 * foreground priority, with a shorter timeout interval. During normal
3156 * broadcasts the receivers are not automatically hoisted out of the
3157 * background priority class.
3158 */
3159 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3160 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003161 * If set, when sending a broadcast <i>before boot has completed</i> only
3162 * registered receivers will be called -- no BroadcastReceiver components
3163 * will be launched. Sticky intent state will be recorded properly even
3164 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3165 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003166 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003167 * <p>This flag is only for use by system sevices as a convenience to
3168 * avoid having to implement a more complex mechanism around detection
3169 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003170 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003171 * @hide
3172 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003173 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003174 /**
3175 * Set when this broadcast is for a boot upgrade, a special mode that
3176 * allows the broadcast to be sent before the system is ready and launches
3177 * the app process with no providers running in it.
3178 * @hide
3179 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003180 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003181
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003182 /**
3183 * @hide Flags that can't be changed with PendingIntent.
3184 */
3185 public static final int IMMUTABLE_FLAGS =
3186 FLAG_GRANT_READ_URI_PERMISSION
3187 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003188
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003189 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003190 // ---------------------------------------------------------------------
3191 // toUri() and parseUri() options.
3192
3193 /**
3194 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3195 * always has the "intent:" scheme. This syntax can be used when you want
3196 * to later disambiguate between URIs that are intended to describe an
3197 * Intent vs. all others that should be treated as raw URIs. When used
3198 * with {@link #parseUri}, any other scheme will result in a generic
3199 * VIEW action for that raw URI.
3200 */
3201 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003202
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003203 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003204
3205 private String mAction;
3206 private Uri mData;
3207 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003208 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003209 private ComponentName mComponent;
3210 private int mFlags;
3211 private HashSet<String> mCategories;
3212 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003213 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003214 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003215 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003216
3217 // ---------------------------------------------------------------------
3218
3219 /**
3220 * Create an empty intent.
3221 */
3222 public Intent() {
3223 }
3224
3225 /**
3226 * Copy constructor.
3227 */
3228 public Intent(Intent o) {
3229 this.mAction = o.mAction;
3230 this.mData = o.mData;
3231 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003232 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003233 this.mComponent = o.mComponent;
3234 this.mFlags = o.mFlags;
3235 if (o.mCategories != null) {
3236 this.mCategories = new HashSet<String>(o.mCategories);
3237 }
3238 if (o.mExtras != null) {
3239 this.mExtras = new Bundle(o.mExtras);
3240 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003241 if (o.mSourceBounds != null) {
3242 this.mSourceBounds = new Rect(o.mSourceBounds);
3243 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003244 if (o.mSelector != null) {
3245 this.mSelector = new Intent(o.mSelector);
3246 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003247 if (o.mClipData != null) {
3248 this.mClipData = new ClipData(o.mClipData);
3249 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003250 }
3251
3252 @Override
3253 public Object clone() {
3254 return new Intent(this);
3255 }
3256
3257 private Intent(Intent o, boolean all) {
3258 this.mAction = o.mAction;
3259 this.mData = o.mData;
3260 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003261 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003262 this.mComponent = o.mComponent;
3263 if (o.mCategories != null) {
3264 this.mCategories = new HashSet<String>(o.mCategories);
3265 }
3266 }
3267
3268 /**
3269 * Make a clone of only the parts of the Intent that are relevant for
3270 * filter matching: the action, data, type, component, and categories.
3271 */
3272 public Intent cloneFilter() {
3273 return new Intent(this, false);
3274 }
3275
3276 /**
3277 * Create an intent with a given action. All other fields (data, type,
3278 * class) are null. Note that the action <em>must</em> be in a
3279 * namespace because Intents are used globally in the system -- for
3280 * example the system VIEW action is android.intent.action.VIEW; an
3281 * application's custom action would be something like
3282 * com.google.app.myapp.CUSTOM_ACTION.
3283 *
3284 * @param action The Intent action, such as ACTION_VIEW.
3285 */
3286 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003287 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003288 }
3289
3290 /**
3291 * Create an intent with a given action and for a given data url. Note
3292 * that the action <em>must</em> be in a namespace because Intents are
3293 * used globally in the system -- for example the system VIEW action is
3294 * android.intent.action.VIEW; an application's custom action would be
3295 * something like com.google.app.myapp.CUSTOM_ACTION.
3296 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003297 * <p><em>Note: scheme and host name matching in the Android framework is
3298 * case-sensitive, unlike the formal RFC. As a result,
3299 * you should always ensure that you write your Uri with these elements
3300 * using lower case letters, and normalize any Uris you receive from
3301 * outside of Android to ensure the scheme and host is lower case.</em></p>
3302 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003303 * @param action The Intent action, such as ACTION_VIEW.
3304 * @param uri The Intent data URI.
3305 */
3306 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003307 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003308 mData = uri;
3309 }
3310
3311 /**
3312 * Create an intent for a specific component. All other fields (action, data,
3313 * type, class) are null, though they can be modified later with explicit
3314 * calls. This provides a convenient way to create an intent that is
3315 * intended to execute a hard-coded class name, rather than relying on the
3316 * system to find an appropriate class for you; see {@link #setComponent}
3317 * for more information on the repercussions of this.
3318 *
3319 * @param packageContext A Context of the application package implementing
3320 * this class.
3321 * @param cls The component class that is to be used for the intent.
3322 *
3323 * @see #setClass
3324 * @see #setComponent
3325 * @see #Intent(String, android.net.Uri , Context, Class)
3326 */
3327 public Intent(Context packageContext, Class<?> cls) {
3328 mComponent = new ComponentName(packageContext, cls);
3329 }
3330
3331 /**
3332 * Create an intent for a specific component with a specified action and data.
3333 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3334 * construct the Intent and then calling {@link #setClass} to set its
3335 * class.
3336 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003337 * <p><em>Note: scheme and host name matching in the Android framework is
3338 * case-sensitive, unlike the formal RFC. As a result,
3339 * you should always ensure that you write your Uri with these elements
3340 * using lower case letters, and normalize any Uris you receive from
3341 * outside of Android to ensure the scheme and host is lower case.</em></p>
3342 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003343 * @param action The Intent action, such as ACTION_VIEW.
3344 * @param uri The Intent data URI.
3345 * @param packageContext A Context of the application package implementing
3346 * this class.
3347 * @param cls The component class that is to be used for the intent.
3348 *
3349 * @see #Intent(String, android.net.Uri)
3350 * @see #Intent(Context, Class)
3351 * @see #setClass
3352 * @see #setComponent
3353 */
3354 public Intent(String action, Uri uri,
3355 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003356 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003357 mData = uri;
3358 mComponent = new ComponentName(packageContext, cls);
3359 }
3360
3361 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003362 * Create an intent to launch the main (root) activity of a task. This
3363 * is the Intent that is started when the application's is launched from
3364 * Home. For anything else that wants to launch an application in the
3365 * same way, it is important that they use an Intent structured the same
3366 * way, and can use this function to ensure this is the case.
3367 *
3368 * <p>The returned Intent has the given Activity component as its explicit
3369 * component, {@link #ACTION_MAIN} as its action, and includes the
3370 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3371 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3372 * to do that through {@link #addFlags(int)} on the returned Intent.
3373 *
3374 * @param mainActivity The main activity component that this Intent will
3375 * launch.
3376 * @return Returns a newly created Intent that can be used to launch the
3377 * activity as a main application entry.
3378 *
3379 * @see #setClass
3380 * @see #setComponent
3381 */
3382 public static Intent makeMainActivity(ComponentName mainActivity) {
3383 Intent intent = new Intent(ACTION_MAIN);
3384 intent.setComponent(mainActivity);
3385 intent.addCategory(CATEGORY_LAUNCHER);
3386 return intent;
3387 }
3388
3389 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003390 * Make an Intent for the main activity of an application, without
3391 * specifying a specific activity to run but giving a selector to find
3392 * the activity. This results in a final Intent that is structured
3393 * the same as when the application is launched from
3394 * Home. For anything else that wants to launch an application in the
3395 * same way, it is important that they use an Intent structured the same
3396 * way, and can use this function to ensure this is the case.
3397 *
3398 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3399 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3400 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3401 * to do that through {@link #addFlags(int)} on the returned Intent.
3402 *
3403 * @param selectorAction The action name of the Intent's selector.
3404 * @param selectorCategory The name of a category to add to the Intent's
3405 * selector.
3406 * @return Returns a newly created Intent that can be used to launch the
3407 * activity as a main application entry.
3408 *
3409 * @see #setSelector(Intent)
3410 */
3411 public static Intent makeMainSelectorActivity(String selectorAction,
3412 String selectorCategory) {
3413 Intent intent = new Intent(ACTION_MAIN);
3414 intent.addCategory(CATEGORY_LAUNCHER);
3415 Intent selector = new Intent();
3416 selector.setAction(selectorAction);
3417 selector.addCategory(selectorCategory);
3418 intent.setSelector(selector);
3419 return intent;
3420 }
3421
3422 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003423 * Make an Intent that can be used to re-launch an application's task
3424 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3425 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3426 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3427 *
3428 * @param mainActivity The activity component that is the root of the
3429 * task; this is the activity that has been published in the application's
3430 * manifest as the main launcher icon.
3431 *
3432 * @return Returns a newly created Intent that can be used to relaunch the
3433 * activity's task in its root state.
3434 */
3435 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3436 Intent intent = makeMainActivity(mainActivity);
3437 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3438 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3439 return intent;
3440 }
3441
3442 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003443 * Call {@link #parseUri} with 0 flags.
3444 * @deprecated Use {@link #parseUri} instead.
3445 */
3446 @Deprecated
3447 public static Intent getIntent(String uri) throws URISyntaxException {
3448 return parseUri(uri, 0);
3449 }
Tom Taylord4a47292009-12-21 13:59:18 -08003450
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003451 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003452 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003453 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003454 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003455 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003456 *
3457 * <p>The URI given here must not be relative -- that is, it must include
3458 * the scheme and full path.
3459 *
3460 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003461 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003462 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003463 *
3464 * @return Intent The newly created Intent object.
3465 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003466 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3467 * it bad (as parsed by the Uri class) or the Intent data within the
3468 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003469 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003470 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003471 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003472 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003473 int i = 0;
3474 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003475 // Validate intent scheme for if requested.
3476 if ((flags&URI_INTENT_SCHEME) != 0) {
3477 if (!uri.startsWith("intent:")) {
3478 Intent intent = new Intent(ACTION_VIEW);
3479 try {
3480 intent.setData(Uri.parse(uri));
3481 } catch (IllegalArgumentException e) {
3482 throw new URISyntaxException(uri, e.getMessage());
3483 }
3484 return intent;
3485 }
3486 }
Tom Taylord4a47292009-12-21 13:59:18 -08003487
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003488 // simple case
3489 i = uri.lastIndexOf("#");
3490 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3491
3492 // old format Intent URI
3493 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003494
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003495 // new format
3496 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003497 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003498
3499 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003500 String data = i >= 0 ? uri.substring(0, i) : null;
3501 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003502 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003503
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003504 // loop over contents of Intent, all name=value;
3505 while (!uri.startsWith("end", i)) {
3506 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003507 if (eq < 0) eq = i-1;
3508 int semi = uri.indexOf(';', i);
3509 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003510
3511 // action
3512 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003513 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003514 }
3515
3516 // categories
3517 else if (uri.startsWith("category=", i)) {
3518 intent.addCategory(value);
3519 }
3520
3521 // type
3522 else if (uri.startsWith("type=", i)) {
3523 intent.mType = value;
3524 }
3525
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003526 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003527 else if (uri.startsWith("launchFlags=", i)) {
3528 intent.mFlags = Integer.decode(value).intValue();
3529 }
3530
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003531 // package
3532 else if (uri.startsWith("package=", i)) {
3533 intent.mPackage = value;
3534 }
3535
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003536 // component
3537 else if (uri.startsWith("component=", i)) {
3538 intent.mComponent = ComponentName.unflattenFromString(value);
3539 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003540
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003541 // scheme
3542 else if (uri.startsWith("scheme=", i)) {
3543 scheme = value;
3544 }
3545
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003546 // source bounds
3547 else if (uri.startsWith("sourceBounds=", i)) {
3548 intent.mSourceBounds = Rect.unflattenFromString(value);
3549 }
3550
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003551 // selector
3552 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3553 intent = new Intent();
3554 }
3555
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003556 // extra
3557 else {
3558 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003559 // create Bundle if it doesn't already exist
3560 if (intent.mExtras == null) intent.mExtras = new Bundle();
3561 Bundle b = intent.mExtras;
3562 // add EXTRA
3563 if (uri.startsWith("S.", i)) b.putString(key, value);
3564 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3565 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3566 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3567 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3568 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3569 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3570 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3571 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3572 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3573 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003574
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003575 // move to the next item
3576 i = semi + 1;
3577 }
3578
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003579 if (intent != baseIntent) {
3580 // The Intent had a selector; fix it up.
3581 baseIntent.setSelector(intent);
3582 intent = baseIntent;
3583 }
3584
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003585 if (data != null) {
3586 if (data.startsWith("intent:")) {
3587 data = data.substring(7);
3588 if (scheme != null) {
3589 data = scheme + ':' + data;
3590 }
3591 }
Tom Taylord4a47292009-12-21 13:59:18 -08003592
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003593 if (data.length() > 0) {
3594 try {
3595 intent.mData = Uri.parse(data);
3596 } catch (IllegalArgumentException e) {
3597 throw new URISyntaxException(uri, e.getMessage());
3598 }
3599 }
3600 }
Tom Taylord4a47292009-12-21 13:59:18 -08003601
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003602 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003603
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003604 } catch (IndexOutOfBoundsException e) {
3605 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3606 }
3607 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003608
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003609 public static Intent getIntentOld(String uri) throws URISyntaxException {
3610 Intent intent;
3611
3612 int i = uri.lastIndexOf('#');
3613 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003614 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003615 final int intentFragmentStart = i;
3616 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003617
3618 i++;
3619
3620 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003621 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003622 i += 7;
3623 int j = uri.indexOf(')', i);
3624 action = uri.substring(i, j);
3625 i = j + 1;
3626 }
3627
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003628 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003629
3630 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003631 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003632 i += 11;
3633 int j = uri.indexOf(')', i);
3634 while (i < j) {
3635 int sep = uri.indexOf('!', i);
3636 if (sep < 0) sep = j;
3637 if (i < sep) {
3638 intent.addCategory(uri.substring(i, sep));
3639 }
3640 i = sep + 1;
3641 }
3642 i = j + 1;
3643 }
3644
3645 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003646 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003647 i += 5;
3648 int j = uri.indexOf(')', i);
3649 intent.mType = uri.substring(i, j);
3650 i = j + 1;
3651 }
3652
3653 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003654 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003655 i += 12;
3656 int j = uri.indexOf(')', i);
3657 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3658 i = j + 1;
3659 }
3660
3661 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003662 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003663 i += 10;
3664 int j = uri.indexOf(')', i);
3665 int sep = uri.indexOf('!', i);
3666 if (sep >= 0 && sep < j) {
3667 String pkg = uri.substring(i, sep);
3668 String cls = uri.substring(sep + 1, j);
3669 intent.mComponent = new ComponentName(pkg, cls);
3670 }
3671 i = j + 1;
3672 }
3673
3674 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003675 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003676 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003677
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003678 final int closeParen = uri.indexOf(')', i);
3679 if (closeParen == -1) throw new URISyntaxException(uri,
3680 "EXTRA missing trailing ')'", i);
3681
3682 while (i < closeParen) {
3683 // fetch the key value
3684 int j = uri.indexOf('=', i);
3685 if (j <= i + 1 || i >= closeParen) {
3686 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3687 }
3688 char type = uri.charAt(i);
3689 i++;
3690 String key = uri.substring(i, j);
3691 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003692
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003693 // get type-value
3694 j = uri.indexOf('!', i);
3695 if (j == -1 || j >= closeParen) j = closeParen;
3696 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3697 String value = uri.substring(i, j);
3698 i = j;
3699
3700 // create Bundle if it doesn't already exist
3701 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003702
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003703 // add item to bundle
3704 try {
3705 switch (type) {
3706 case 'S':
3707 intent.mExtras.putString(key, Uri.decode(value));
3708 break;
3709 case 'B':
3710 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3711 break;
3712 case 'b':
3713 intent.mExtras.putByte(key, Byte.parseByte(value));
3714 break;
3715 case 'c':
3716 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3717 break;
3718 case 'd':
3719 intent.mExtras.putDouble(key, Double.parseDouble(value));
3720 break;
3721 case 'f':
3722 intent.mExtras.putFloat(key, Float.parseFloat(value));
3723 break;
3724 case 'i':
3725 intent.mExtras.putInt(key, Integer.parseInt(value));
3726 break;
3727 case 'l':
3728 intent.mExtras.putLong(key, Long.parseLong(value));
3729 break;
3730 case 's':
3731 intent.mExtras.putShort(key, Short.parseShort(value));
3732 break;
3733 default:
3734 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
3735 }
3736 } catch (NumberFormatException e) {
3737 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
3738 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003739
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003740 char ch = uri.charAt(i);
3741 if (ch == ')') break;
3742 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3743 i++;
3744 }
3745 }
3746
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003747 if (isIntentFragment) {
3748 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
3749 } else {
3750 intent.mData = Uri.parse(uri);
3751 }
Tom Taylord4a47292009-12-21 13:59:18 -08003752
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003753 if (intent.mAction == null) {
3754 // By default, if no action is specified, then use VIEW.
3755 intent.mAction = ACTION_VIEW;
3756 }
3757
3758 } else {
3759 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
3760 }
3761
3762 return intent;
3763 }
3764
3765 /**
3766 * Retrieve the general action to be performed, such as
3767 * {@link #ACTION_VIEW}. The action describes the general way the rest of
3768 * the information in the intent should be interpreted -- most importantly,
3769 * what to do with the data returned by {@link #getData}.
3770 *
3771 * @return The action of this intent or null if none is specified.
3772 *
3773 * @see #setAction
3774 */
3775 public String getAction() {
3776 return mAction;
3777 }
3778
3779 /**
3780 * Retrieve data this intent is operating on. This URI specifies the name
3781 * of the data; often it uses the content: scheme, specifying data in a
3782 * content provider. Other schemes may be handled by specific activities,
3783 * such as http: by the web browser.
3784 *
3785 * @return The URI of the data this intent is targeting or null.
3786 *
3787 * @see #getScheme
3788 * @see #setData
3789 */
3790 public Uri getData() {
3791 return mData;
3792 }
3793
3794 /**
3795 * The same as {@link #getData()}, but returns the URI as an encoded
3796 * String.
3797 */
3798 public String getDataString() {
3799 return mData != null ? mData.toString() : null;
3800 }
3801
3802 /**
3803 * Return the scheme portion of the intent's data. If the data is null or
3804 * does not include a scheme, null is returned. Otherwise, the scheme
3805 * prefix without the final ':' is returned, i.e. "http".
3806 *
3807 * <p>This is the same as calling getData().getScheme() (and checking for
3808 * null data).
3809 *
3810 * @return The scheme of this intent.
3811 *
3812 * @see #getData
3813 */
3814 public String getScheme() {
3815 return mData != null ? mData.getScheme() : null;
3816 }
3817
3818 /**
3819 * Retrieve any explicit MIME type included in the intent. This is usually
3820 * null, as the type is determined by the intent data.
3821 *
3822 * @return If a type was manually set, it is returned; else null is
3823 * returned.
3824 *
3825 * @see #resolveType(ContentResolver)
3826 * @see #setType
3827 */
3828 public String getType() {
3829 return mType;
3830 }
3831
3832 /**
3833 * Return the MIME data type of this intent. If the type field is
3834 * explicitly set, that is simply returned. Otherwise, if the data is set,
3835 * the type of that data is returned. If neither fields are set, a null is
3836 * returned.
3837 *
3838 * @return The MIME type of this intent.
3839 *
3840 * @see #getType
3841 * @see #resolveType(ContentResolver)
3842 */
3843 public String resolveType(Context context) {
3844 return resolveType(context.getContentResolver());
3845 }
3846
3847 /**
3848 * Return the MIME data type of this intent. If the type field is
3849 * explicitly set, that is simply returned. Otherwise, if the data is set,
3850 * the type of that data is returned. If neither fields are set, a null is
3851 * returned.
3852 *
3853 * @param resolver A ContentResolver that can be used to determine the MIME
3854 * type of the intent's data.
3855 *
3856 * @return The MIME type of this intent.
3857 *
3858 * @see #getType
3859 * @see #resolveType(Context)
3860 */
3861 public String resolveType(ContentResolver resolver) {
3862 if (mType != null) {
3863 return mType;
3864 }
3865 if (mData != null) {
3866 if ("content".equals(mData.getScheme())) {
3867 return resolver.getType(mData);
3868 }
3869 }
3870 return null;
3871 }
3872
3873 /**
3874 * Return the MIME data type of this intent, only if it will be needed for
3875 * intent resolution. This is not generally useful for application code;
3876 * it is used by the frameworks for communicating with back-end system
3877 * services.
3878 *
3879 * @param resolver A ContentResolver that can be used to determine the MIME
3880 * type of the intent's data.
3881 *
3882 * @return The MIME type of this intent, or null if it is unknown or not
3883 * needed.
3884 */
3885 public String resolveTypeIfNeeded(ContentResolver resolver) {
3886 if (mComponent != null) {
3887 return mType;
3888 }
3889 return resolveType(resolver);
3890 }
3891
3892 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09003893 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003894 *
3895 * @param category The category to check.
3896 *
3897 * @return boolean True if the intent contains the category, else false.
3898 *
3899 * @see #getCategories
3900 * @see #addCategory
3901 */
3902 public boolean hasCategory(String category) {
3903 return mCategories != null && mCategories.contains(category);
3904 }
3905
3906 /**
3907 * Return the set of all categories in the intent. If there are no categories,
3908 * returns NULL.
3909 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003910 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003911 *
3912 * @see #hasCategory
3913 * @see #addCategory
3914 */
3915 public Set<String> getCategories() {
3916 return mCategories;
3917 }
3918
3919 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003920 * Return the specific selector associated with this Intent. If there is
3921 * none, returns null. See {@link #setSelector} for more information.
3922 *
3923 * @see #setSelector
3924 */
3925 public Intent getSelector() {
3926 return mSelector;
3927 }
3928
3929 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003930 * Return the {@link ClipData} associated with this Intent. If there is
3931 * none, returns null. See {@link #setClipData} for more information.
3932 *
3933 * @see #setClipData;
3934 */
3935 public ClipData getClipData() {
3936 return mClipData;
3937 }
3938
3939 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003940 * Sets the ClassLoader that will be used when unmarshalling
3941 * any Parcelable values from the extras of this Intent.
3942 *
3943 * @param loader a ClassLoader, or null to use the default loader
3944 * at the time of unmarshalling.
3945 */
3946 public void setExtrasClassLoader(ClassLoader loader) {
3947 if (mExtras != null) {
3948 mExtras.setClassLoader(loader);
3949 }
3950 }
3951
3952 /**
3953 * Returns true if an extra value is associated with the given name.
3954 * @param name the extra's name
3955 * @return true if the given extra is present.
3956 */
3957 public boolean hasExtra(String name) {
3958 return mExtras != null && mExtras.containsKey(name);
3959 }
3960
3961 /**
3962 * Returns true if the Intent's extras contain a parcelled file descriptor.
3963 * @return true if the Intent contains a parcelled file descriptor.
3964 */
3965 public boolean hasFileDescriptors() {
3966 return mExtras != null && mExtras.hasFileDescriptors();
3967 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003968
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04003969 /** @hide */
3970 public void setAllowFds(boolean allowFds) {
3971 if (mExtras != null) {
3972 mExtras.setAllowFds(allowFds);
3973 }
3974 }
3975
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003976 /**
3977 * Retrieve extended data from the intent.
3978 *
3979 * @param name The name of the desired item.
3980 *
3981 * @return the value of an item that previously added with putExtra()
3982 * or null if none was found.
3983 *
3984 * @deprecated
3985 * @hide
3986 */
3987 @Deprecated
3988 public Object getExtra(String name) {
3989 return getExtra(name, null);
3990 }
3991
3992 /**
3993 * Retrieve extended data from the intent.
3994 *
3995 * @param name The name of the desired item.
3996 * @param defaultValue the value to be returned if no value of the desired
3997 * type is stored with the given name.
3998 *
3999 * @return the value of an item that previously added with putExtra()
4000 * or the default value if none was found.
4001 *
4002 * @see #putExtra(String, boolean)
4003 */
4004 public boolean getBooleanExtra(String name, boolean defaultValue) {
4005 return mExtras == null ? defaultValue :
4006 mExtras.getBoolean(name, defaultValue);
4007 }
4008
4009 /**
4010 * Retrieve extended data from the intent.
4011 *
4012 * @param name The name of the desired item.
4013 * @param defaultValue the value to be returned if no value of the desired
4014 * type is stored with the given name.
4015 *
4016 * @return the value of an item that previously added with putExtra()
4017 * or the default value if none was found.
4018 *
4019 * @see #putExtra(String, byte)
4020 */
4021 public byte getByteExtra(String name, byte defaultValue) {
4022 return mExtras == null ? defaultValue :
4023 mExtras.getByte(name, defaultValue);
4024 }
4025
4026 /**
4027 * Retrieve extended data from the intent.
4028 *
4029 * @param name The name of the desired item.
4030 * @param defaultValue the value to be returned if no value of the desired
4031 * type is stored with the given name.
4032 *
4033 * @return the value of an item that previously added with putExtra()
4034 * or the default value if none was found.
4035 *
4036 * @see #putExtra(String, short)
4037 */
4038 public short getShortExtra(String name, short defaultValue) {
4039 return mExtras == null ? defaultValue :
4040 mExtras.getShort(name, defaultValue);
4041 }
4042
4043 /**
4044 * Retrieve extended data from the intent.
4045 *
4046 * @param name The name of the desired item.
4047 * @param defaultValue the value to be returned if no value of the desired
4048 * type is stored with the given name.
4049 *
4050 * @return the value of an item that previously added with putExtra()
4051 * or the default value if none was found.
4052 *
4053 * @see #putExtra(String, char)
4054 */
4055 public char getCharExtra(String name, char defaultValue) {
4056 return mExtras == null ? defaultValue :
4057 mExtras.getChar(name, defaultValue);
4058 }
4059
4060 /**
4061 * Retrieve extended data from the intent.
4062 *
4063 * @param name The name of the desired item.
4064 * @param defaultValue the value to be returned if no value of the desired
4065 * type is stored with the given name.
4066 *
4067 * @return the value of an item that previously added with putExtra()
4068 * or the default value if none was found.
4069 *
4070 * @see #putExtra(String, int)
4071 */
4072 public int getIntExtra(String name, int defaultValue) {
4073 return mExtras == null ? defaultValue :
4074 mExtras.getInt(name, defaultValue);
4075 }
4076
4077 /**
4078 * Retrieve extended data from the intent.
4079 *
4080 * @param name The name of the desired item.
4081 * @param defaultValue the value to be returned if no value of the desired
4082 * type is stored with the given name.
4083 *
4084 * @return the value of an item that previously added with putExtra()
4085 * or the default value if none was found.
4086 *
4087 * @see #putExtra(String, long)
4088 */
4089 public long getLongExtra(String name, long defaultValue) {
4090 return mExtras == null ? defaultValue :
4091 mExtras.getLong(name, defaultValue);
4092 }
4093
4094 /**
4095 * Retrieve extended data from the intent.
4096 *
4097 * @param name The name of the desired item.
4098 * @param defaultValue the value to be returned if no value of the desired
4099 * type is stored with the given name.
4100 *
4101 * @return the value of an item that previously added with putExtra(),
4102 * or the default value if no such item is present
4103 *
4104 * @see #putExtra(String, float)
4105 */
4106 public float getFloatExtra(String name, float defaultValue) {
4107 return mExtras == null ? defaultValue :
4108 mExtras.getFloat(name, defaultValue);
4109 }
4110
4111 /**
4112 * Retrieve extended data from the intent.
4113 *
4114 * @param name The name of the desired item.
4115 * @param defaultValue the value to be returned if no value of the desired
4116 * type is stored with the given name.
4117 *
4118 * @return the value of an item that previously added with putExtra()
4119 * or the default value if none was found.
4120 *
4121 * @see #putExtra(String, double)
4122 */
4123 public double getDoubleExtra(String name, double defaultValue) {
4124 return mExtras == null ? defaultValue :
4125 mExtras.getDouble(name, defaultValue);
4126 }
4127
4128 /**
4129 * Retrieve extended data from the intent.
4130 *
4131 * @param name The name of the desired item.
4132 *
4133 * @return the value of an item that previously added with putExtra()
4134 * or null if no String value was found.
4135 *
4136 * @see #putExtra(String, String)
4137 */
4138 public String getStringExtra(String name) {
4139 return mExtras == null ? null : mExtras.getString(name);
4140 }
4141
4142 /**
4143 * Retrieve extended data from the intent.
4144 *
4145 * @param name The name of the desired item.
4146 *
4147 * @return the value of an item that previously added with putExtra()
4148 * or null if no CharSequence value was found.
4149 *
4150 * @see #putExtra(String, CharSequence)
4151 */
4152 public CharSequence getCharSequenceExtra(String name) {
4153 return mExtras == null ? null : mExtras.getCharSequence(name);
4154 }
4155
4156 /**
4157 * Retrieve extended data from the intent.
4158 *
4159 * @param name The name of the desired item.
4160 *
4161 * @return the value of an item that previously added with putExtra()
4162 * or null if no Parcelable value was found.
4163 *
4164 * @see #putExtra(String, Parcelable)
4165 */
4166 public <T extends Parcelable> T getParcelableExtra(String name) {
4167 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4168 }
4169
4170 /**
4171 * Retrieve extended data from the intent.
4172 *
4173 * @param name The name of the desired item.
4174 *
4175 * @return the value of an item that previously added with putExtra()
4176 * or null if no Parcelable[] value was found.
4177 *
4178 * @see #putExtra(String, Parcelable[])
4179 */
4180 public Parcelable[] getParcelableArrayExtra(String name) {
4181 return mExtras == null ? null : mExtras.getParcelableArray(name);
4182 }
4183
4184 /**
4185 * Retrieve extended data from the intent.
4186 *
4187 * @param name The name of the desired item.
4188 *
4189 * @return the value of an item that previously added with putExtra()
4190 * or null if no ArrayList<Parcelable> value was found.
4191 *
4192 * @see #putParcelableArrayListExtra(String, ArrayList)
4193 */
4194 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4195 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4196 }
4197
4198 /**
4199 * Retrieve extended data from the intent.
4200 *
4201 * @param name The name of the desired item.
4202 *
4203 * @return the value of an item that previously added with putExtra()
4204 * or null if no Serializable value was found.
4205 *
4206 * @see #putExtra(String, Serializable)
4207 */
4208 public Serializable getSerializableExtra(String name) {
4209 return mExtras == null ? null : mExtras.getSerializable(name);
4210 }
4211
4212 /**
4213 * Retrieve extended data from the intent.
4214 *
4215 * @param name The name of the desired item.
4216 *
4217 * @return the value of an item that previously added with putExtra()
4218 * or null if no ArrayList<Integer> value was found.
4219 *
4220 * @see #putIntegerArrayListExtra(String, ArrayList)
4221 */
4222 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4223 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4224 }
4225
4226 /**
4227 * Retrieve extended data from the intent.
4228 *
4229 * @param name The name of the desired item.
4230 *
4231 * @return the value of an item that previously added with putExtra()
4232 * or null if no ArrayList<String> value was found.
4233 *
4234 * @see #putStringArrayListExtra(String, ArrayList)
4235 */
4236 public ArrayList<String> getStringArrayListExtra(String name) {
4237 return mExtras == null ? null : mExtras.getStringArrayList(name);
4238 }
4239
4240 /**
4241 * Retrieve extended data from the intent.
4242 *
4243 * @param name The name of the desired item.
4244 *
4245 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004246 * or null if no ArrayList<CharSequence> value was found.
4247 *
4248 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4249 */
4250 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4251 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4252 }
4253
4254 /**
4255 * Retrieve extended data from the intent.
4256 *
4257 * @param name The name of the desired item.
4258 *
4259 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004260 * or null if no boolean array value was found.
4261 *
4262 * @see #putExtra(String, boolean[])
4263 */
4264 public boolean[] getBooleanArrayExtra(String name) {
4265 return mExtras == null ? null : mExtras.getBooleanArray(name);
4266 }
4267
4268 /**
4269 * Retrieve extended data from the intent.
4270 *
4271 * @param name The name of the desired item.
4272 *
4273 * @return the value of an item that previously added with putExtra()
4274 * or null if no byte array value was found.
4275 *
4276 * @see #putExtra(String, byte[])
4277 */
4278 public byte[] getByteArrayExtra(String name) {
4279 return mExtras == null ? null : mExtras.getByteArray(name);
4280 }
4281
4282 /**
4283 * Retrieve extended data from the intent.
4284 *
4285 * @param name The name of the desired item.
4286 *
4287 * @return the value of an item that previously added with putExtra()
4288 * or null if no short array value was found.
4289 *
4290 * @see #putExtra(String, short[])
4291 */
4292 public short[] getShortArrayExtra(String name) {
4293 return mExtras == null ? null : mExtras.getShortArray(name);
4294 }
4295
4296 /**
4297 * Retrieve extended data from the intent.
4298 *
4299 * @param name The name of the desired item.
4300 *
4301 * @return the value of an item that previously added with putExtra()
4302 * or null if no char array value was found.
4303 *
4304 * @see #putExtra(String, char[])
4305 */
4306 public char[] getCharArrayExtra(String name) {
4307 return mExtras == null ? null : mExtras.getCharArray(name);
4308 }
4309
4310 /**
4311 * Retrieve extended data from the intent.
4312 *
4313 * @param name The name of the desired item.
4314 *
4315 * @return the value of an item that previously added with putExtra()
4316 * or null if no int array value was found.
4317 *
4318 * @see #putExtra(String, int[])
4319 */
4320 public int[] getIntArrayExtra(String name) {
4321 return mExtras == null ? null : mExtras.getIntArray(name);
4322 }
4323
4324 /**
4325 * Retrieve extended data from the intent.
4326 *
4327 * @param name The name of the desired item.
4328 *
4329 * @return the value of an item that previously added with putExtra()
4330 * or null if no long array value was found.
4331 *
4332 * @see #putExtra(String, long[])
4333 */
4334 public long[] getLongArrayExtra(String name) {
4335 return mExtras == null ? null : mExtras.getLongArray(name);
4336 }
4337
4338 /**
4339 * Retrieve extended data from the intent.
4340 *
4341 * @param name The name of the desired item.
4342 *
4343 * @return the value of an item that previously added with putExtra()
4344 * or null if no float array value was found.
4345 *
4346 * @see #putExtra(String, float[])
4347 */
4348 public float[] getFloatArrayExtra(String name) {
4349 return mExtras == null ? null : mExtras.getFloatArray(name);
4350 }
4351
4352 /**
4353 * Retrieve extended data from the intent.
4354 *
4355 * @param name The name of the desired item.
4356 *
4357 * @return the value of an item that previously added with putExtra()
4358 * or null if no double array value was found.
4359 *
4360 * @see #putExtra(String, double[])
4361 */
4362 public double[] getDoubleArrayExtra(String name) {
4363 return mExtras == null ? null : mExtras.getDoubleArray(name);
4364 }
4365
4366 /**
4367 * Retrieve extended data from the intent.
4368 *
4369 * @param name The name of the desired item.
4370 *
4371 * @return the value of an item that previously added with putExtra()
4372 * or null if no String array value was found.
4373 *
4374 * @see #putExtra(String, String[])
4375 */
4376 public String[] getStringArrayExtra(String name) {
4377 return mExtras == null ? null : mExtras.getStringArray(name);
4378 }
4379
4380 /**
4381 * Retrieve extended data from the intent.
4382 *
4383 * @param name The name of the desired item.
4384 *
4385 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004386 * or null if no CharSequence array value was found.
4387 *
4388 * @see #putExtra(String, CharSequence[])
4389 */
4390 public CharSequence[] getCharSequenceArrayExtra(String name) {
4391 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4392 }
4393
4394 /**
4395 * Retrieve extended data from the intent.
4396 *
4397 * @param name The name of the desired item.
4398 *
4399 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004400 * or null if no Bundle value was found.
4401 *
4402 * @see #putExtra(String, Bundle)
4403 */
4404 public Bundle getBundleExtra(String name) {
4405 return mExtras == null ? null : mExtras.getBundle(name);
4406 }
4407
4408 /**
4409 * Retrieve extended data from the intent.
4410 *
4411 * @param name The name of the desired item.
4412 *
4413 * @return the value of an item that previously added with putExtra()
4414 * or null if no IBinder value was found.
4415 *
4416 * @see #putExtra(String, IBinder)
4417 *
4418 * @deprecated
4419 * @hide
4420 */
4421 @Deprecated
4422 public IBinder getIBinderExtra(String name) {
4423 return mExtras == null ? null : mExtras.getIBinder(name);
4424 }
4425
4426 /**
4427 * Retrieve extended data from the intent.
4428 *
4429 * @param name The name of the desired item.
4430 * @param defaultValue The default value to return in case no item is
4431 * associated with the key 'name'
4432 *
4433 * @return the value of an item that previously added with putExtra()
4434 * or defaultValue if none was found.
4435 *
4436 * @see #putExtra
4437 *
4438 * @deprecated
4439 * @hide
4440 */
4441 @Deprecated
4442 public Object getExtra(String name, Object defaultValue) {
4443 Object result = defaultValue;
4444 if (mExtras != null) {
4445 Object result2 = mExtras.get(name);
4446 if (result2 != null) {
4447 result = result2;
4448 }
4449 }
4450
4451 return result;
4452 }
4453
4454 /**
4455 * Retrieves a map of extended data from the intent.
4456 *
4457 * @return the map of all extras previously added with putExtra(),
4458 * or null if none have been added.
4459 */
4460 public Bundle getExtras() {
4461 return (mExtras != null)
4462 ? new Bundle(mExtras)
4463 : null;
4464 }
4465
4466 /**
4467 * Retrieve any special flags associated with this intent. You will
4468 * normally just set them with {@link #setFlags} and let the system
4469 * take the appropriate action with them.
4470 *
4471 * @return int The currently set flags.
4472 *
4473 * @see #setFlags
4474 */
4475 public int getFlags() {
4476 return mFlags;
4477 }
4478
Dianne Hackborne7f97212011-02-24 14:40:20 -08004479 /** @hide */
4480 public boolean isExcludingStopped() {
4481 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4482 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4483 }
4484
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004485 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004486 * Retrieve the application package name this Intent is limited to. When
4487 * resolving an Intent, if non-null this limits the resolution to only
4488 * components in the given application package.
4489 *
4490 * @return The name of the application package for the Intent.
4491 *
4492 * @see #resolveActivity
4493 * @see #setPackage
4494 */
4495 public String getPackage() {
4496 return mPackage;
4497 }
4498
4499 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004500 * Retrieve the concrete component associated with the intent. When receiving
4501 * an intent, this is the component that was found to best handle it (that is,
4502 * yourself) and will always be non-null; in all other cases it will be
4503 * null unless explicitly set.
4504 *
4505 * @return The name of the application component to handle the intent.
4506 *
4507 * @see #resolveActivity
4508 * @see #setComponent
4509 */
4510 public ComponentName getComponent() {
4511 return mComponent;
4512 }
4513
4514 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004515 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4516 * used as a hint to the receiver for animations and the like. Null means that there
4517 * is no source bounds.
4518 */
4519 public Rect getSourceBounds() {
4520 return mSourceBounds;
4521 }
4522
4523 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004524 * Return the Activity component that should be used to handle this intent.
4525 * The appropriate component is determined based on the information in the
4526 * intent, evaluated as follows:
4527 *
4528 * <p>If {@link #getComponent} returns an explicit class, that is returned
4529 * without any further consideration.
4530 *
4531 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4532 * category to be considered.
4533 *
4534 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4535 * action.
4536 *
4537 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4538 * this type.
4539 *
4540 * <p>If {@link #addCategory} has added any categories, the activity must
4541 * handle ALL of the categories specified.
4542 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004543 * <p>If {@link #getPackage} is non-NULL, only activity components in
4544 * that application package will be considered.
4545 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004546 * <p>If there are no activities that satisfy all of these conditions, a
4547 * null string is returned.
4548 *
4549 * <p>If multiple activities are found to satisfy the intent, the one with
4550 * the highest priority will be used. If there are multiple activities
4551 * with the same priority, the system will either pick the best activity
4552 * based on user preference, or resolve to a system class that will allow
4553 * the user to pick an activity and forward from there.
4554 *
4555 * <p>This method is implemented simply by calling
4556 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4557 * true.</p>
4558 * <p> This API is called for you as part of starting an activity from an
4559 * intent. You do not normally need to call it yourself.</p>
4560 *
4561 * @param pm The package manager with which to resolve the Intent.
4562 *
4563 * @return Name of the component implementing an activity that can
4564 * display the intent.
4565 *
4566 * @see #setComponent
4567 * @see #getComponent
4568 * @see #resolveActivityInfo
4569 */
4570 public ComponentName resolveActivity(PackageManager pm) {
4571 if (mComponent != null) {
4572 return mComponent;
4573 }
4574
4575 ResolveInfo info = pm.resolveActivity(
4576 this, PackageManager.MATCH_DEFAULT_ONLY);
4577 if (info != null) {
4578 return new ComponentName(
4579 info.activityInfo.applicationInfo.packageName,
4580 info.activityInfo.name);
4581 }
4582
4583 return null;
4584 }
4585
4586 /**
4587 * Resolve the Intent into an {@link ActivityInfo}
4588 * describing the activity that should execute the intent. Resolution
4589 * follows the same rules as described for {@link #resolveActivity}, but
4590 * you get back the completely information about the resolved activity
4591 * instead of just its class name.
4592 *
4593 * @param pm The package manager with which to resolve the Intent.
4594 * @param flags Addition information to retrieve as per
4595 * {@link PackageManager#getActivityInfo(ComponentName, int)
4596 * PackageManager.getActivityInfo()}.
4597 *
4598 * @return PackageManager.ActivityInfo
4599 *
4600 * @see #resolveActivity
4601 */
4602 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4603 ActivityInfo ai = null;
4604 if (mComponent != null) {
4605 try {
4606 ai = pm.getActivityInfo(mComponent, flags);
4607 } catch (PackageManager.NameNotFoundException e) {
4608 // ignore
4609 }
4610 } else {
4611 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004612 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004613 if (info != null) {
4614 ai = info.activityInfo;
4615 }
4616 }
4617
4618 return ai;
4619 }
4620
4621 /**
4622 * Set the general action to be performed.
4623 *
4624 * @param action An action name, such as ACTION_VIEW. Application-specific
4625 * actions should be prefixed with the vendor's package name.
4626 *
4627 * @return Returns the same Intent object, for chaining multiple calls
4628 * into a single statement.
4629 *
4630 * @see #getAction
4631 */
4632 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004633 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004634 return this;
4635 }
4636
4637 /**
4638 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004639 * clears any type that was previously set by {@link #setType} or
4640 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004641 *
Nick Pellyccae4122012-01-09 14:12:58 -08004642 * <p><em>Note: scheme matching in the Android framework is
4643 * case-sensitive, unlike the formal RFC. As a result,
4644 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004645 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004646 * {@link #setDataAndNormalize}
4647 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004648 *
Nick Pellyccae4122012-01-09 14:12:58 -08004649 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004650 *
4651 * @return Returns the same Intent object, for chaining multiple calls
4652 * into a single statement.
4653 *
4654 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004655 * @see #setDataAndNormalize
4656 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004657 */
4658 public Intent setData(Uri data) {
4659 mData = data;
4660 mType = null;
4661 return this;
4662 }
4663
4664 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004665 * Normalize and set the data this intent is operating on.
4666 *
4667 * <p>This method automatically clears any type that was
4668 * previously set (for example, by {@link #setType}).
4669 *
4670 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004671 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004672 * so really this is just a convenience method for
4673 * <pre>
4674 * setData(data.normalize())
4675 * </pre>
4676 *
4677 * @param data The Uri of the data this intent is now targeting.
4678 *
4679 * @return Returns the same Intent object, for chaining multiple calls
4680 * into a single statement.
4681 *
4682 * @see #getData
4683 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004684 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004685 */
4686 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004687 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004688 }
4689
4690 /**
4691 * Set an explicit MIME data type.
4692 *
4693 * <p>This is used to create intents that only specify a type and not data,
4694 * for example to indicate the type of data to return.
4695 *
4696 * <p>This method automatically clears any data that was
4697 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004698 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004699 * <p><em>Note: MIME type matching in the Android framework is
4700 * case-sensitive, unlike formal RFC MIME types. As a result,
4701 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004702 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4703 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004704 *
4705 * @param type The MIME type of the data being handled by this intent.
4706 *
4707 * @return Returns the same Intent object, for chaining multiple calls
4708 * into a single statement.
4709 *
4710 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004711 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004712 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004713 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004714 */
4715 public Intent setType(String type) {
4716 mData = null;
4717 mType = type;
4718 return this;
4719 }
4720
4721 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004722 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004723 *
Nick Pellyccae4122012-01-09 14:12:58 -08004724 * <p>This is used to create intents that only specify a type and not data,
4725 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004726 *
Nick Pellyccae4122012-01-09 14:12:58 -08004727 * <p>This method automatically clears any data that was
4728 * previously set (for example by {@link #setData}).
4729 *
4730 * <p>The MIME type is normalized using
4731 * {@link #normalizeMimeType} before it is set,
4732 * so really this is just a convenience method for
4733 * <pre>
4734 * setType(Intent.normalizeMimeType(type))
4735 * </pre>
4736 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004737 * @param type The MIME type of the data being handled by this intent.
4738 *
4739 * @return Returns the same Intent object, for chaining multiple calls
4740 * into a single statement.
4741 *
Nick Pellyccae4122012-01-09 14:12:58 -08004742 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004743 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08004744 * @see #normalizeMimeType
4745 */
4746 public Intent setTypeAndNormalize(String type) {
4747 return setType(normalizeMimeType(type));
4748 }
4749
4750 /**
4751 * (Usually optional) Set the data for the intent along with an explicit
4752 * MIME data type. This method should very rarely be used -- it allows you
4753 * to override the MIME type that would ordinarily be inferred from the
4754 * data with your own type given here.
4755 *
4756 * <p><em>Note: MIME type and Uri scheme matching in the
4757 * Android framework is case-sensitive, unlike the formal RFC definitions.
4758 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004759 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004760 * {@link #setDataAndTypeAndNormalize}
4761 * to ensure that they are converted to lower case.</em>
4762 *
4763 * @param data The Uri of the data this intent is now targeting.
4764 * @param type The MIME type of the data being handled by this intent.
4765 *
4766 * @return Returns the same Intent object, for chaining multiple calls
4767 * into a single statement.
4768 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004769 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08004770 * @see #setData
4771 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004772 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004773 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004774 */
4775 public Intent setDataAndType(Uri data, String type) {
4776 mData = data;
4777 mType = type;
4778 return this;
4779 }
4780
4781 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004782 * (Usually optional) Normalize and set both the data Uri and an explicit
4783 * MIME data type. This method should very rarely be used -- it allows you
4784 * to override the MIME type that would ordinarily be inferred from the
4785 * data with your own type given here.
4786 *
4787 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004788 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08004789 * before they are set, so really this is just a convenience method for
4790 * <pre>
4791 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
4792 * </pre>
4793 *
4794 * @param data The Uri of the data this intent is now targeting.
4795 * @param type The MIME type of the data being handled by this intent.
4796 *
4797 * @return Returns the same Intent object, for chaining multiple calls
4798 * into a single statement.
4799 *
4800 * @see #setType
4801 * @see #setData
4802 * @see #setDataAndType
4803 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004804 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004805 */
4806 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004807 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08004808 }
4809
4810 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004811 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004812 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004813 * activities that provide <em>all</em> of the requested categories will be
4814 * used.
4815 *
4816 * @param category The desired category. This can be either one of the
4817 * predefined Intent categories, or a custom category in your own
4818 * namespace.
4819 *
4820 * @return Returns the same Intent object, for chaining multiple calls
4821 * into a single statement.
4822 *
4823 * @see #hasCategory
4824 * @see #removeCategory
4825 */
4826 public Intent addCategory(String category) {
4827 if (mCategories == null) {
4828 mCategories = new HashSet<String>();
4829 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08004830 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004831 return this;
4832 }
4833
4834 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004835 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004836 *
4837 * @param category The category to remove.
4838 *
4839 * @see #addCategory
4840 */
4841 public void removeCategory(String category) {
4842 if (mCategories != null) {
4843 mCategories.remove(category);
4844 if (mCategories.size() == 0) {
4845 mCategories = null;
4846 }
4847 }
4848 }
4849
4850 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004851 * Set a selector for this Intent. This is a modification to the kinds of
4852 * things the Intent will match. If the selector is set, it will be used
4853 * when trying to find entities that can handle the Intent, instead of the
4854 * main contents of the Intent. This allows you build an Intent containing
4855 * a generic protocol while targeting it more specifically.
4856 *
4857 * <p>An example of where this may be used is with things like
4858 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
4859 * Intent that will launch the Browser application. However, the correct
4860 * main entry point of an application is actually {@link #ACTION_MAIN}
4861 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
4862 * used to specify the actual Activity to launch. If you launch the browser
4863 * with something different, undesired behavior may happen if the user has
4864 * previously or later launches it the normal way, since they do not match.
4865 * Instead, you can build an Intent with the MAIN action (but no ComponentName
4866 * yet specified) and set a selector with {@link #ACTION_MAIN} and
4867 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
4868 *
4869 * <p>Setting a selector does not impact the behavior of
4870 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
4871 * desired behavior of a selector -- it does not impact the base meaning
4872 * of the Intent, just what kinds of things will be matched against it
4873 * when determining who can handle it.</p>
4874 *
4875 * <p>You can not use both a selector and {@link #setPackage(String)} on
4876 * the same base Intent.</p>
4877 *
4878 * @param selector The desired selector Intent; set to null to not use
4879 * a special selector.
4880 */
4881 public void setSelector(Intent selector) {
4882 if (selector == this) {
4883 throw new IllegalArgumentException(
4884 "Intent being set as a selector of itself");
4885 }
4886 if (selector != null && mPackage != null) {
4887 throw new IllegalArgumentException(
4888 "Can't set selector when package name is already set");
4889 }
4890 mSelector = selector;
4891 }
4892
4893 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004894 * Set a {@link ClipData} associated with this Intent. This replaces any
4895 * previously set ClipData.
4896 *
4897 * <p>The ClipData in an intent is not used for Intent matching or other
4898 * such operations. Semantically it is like extras, used to transmit
4899 * additional data with the Intent. The main feature of using this over
4900 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
4901 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
4902 * items included in the clip data. This is useful, in particular, if
4903 * you want to transmit an Intent containing multiple <code>content:</code>
4904 * URIs for which the recipient may not have global permission to access the
4905 * content provider.
4906 *
4907 * <p>If the ClipData contains items that are themselves Intents, any
4908 * grant flags in those Intents will be ignored. Only the top-level flags
4909 * of the main Intent are respected, and will be applied to all Uri or
4910 * Intent items in the clip (or sub-items of the clip).
4911 *
4912 * <p>The MIME type, label, and icon in the ClipData object are not
4913 * directly used by Intent. Applications should generally rely on the
4914 * MIME type of the Intent itself, not what it may find in the ClipData.
4915 * A common practice is to construct a ClipData for use with an Intent
4916 * with a MIME type of "*\/*".
4917 *
4918 * @param clip The new clip to set. May be null to clear the current clip.
4919 */
4920 public void setClipData(ClipData clip) {
4921 mClipData = clip;
4922 }
4923
4924 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004925 * Add extended data to the intent. The name must include a package
4926 * prefix, for example the app com.android.contacts would use names
4927 * like "com.android.contacts.ShowAll".
4928 *
4929 * @param name The name of the extra data, with package prefix.
4930 * @param value The boolean data value.
4931 *
4932 * @return Returns the same Intent object, for chaining multiple calls
4933 * into a single statement.
4934 *
4935 * @see #putExtras
4936 * @see #removeExtra
4937 * @see #getBooleanExtra(String, boolean)
4938 */
4939 public Intent putExtra(String name, boolean value) {
4940 if (mExtras == null) {
4941 mExtras = new Bundle();
4942 }
4943 mExtras.putBoolean(name, value);
4944 return this;
4945 }
4946
4947 /**
4948 * Add extended data to the intent. The name must include a package
4949 * prefix, for example the app com.android.contacts would use names
4950 * like "com.android.contacts.ShowAll".
4951 *
4952 * @param name The name of the extra data, with package prefix.
4953 * @param value The byte data value.
4954 *
4955 * @return Returns the same Intent object, for chaining multiple calls
4956 * into a single statement.
4957 *
4958 * @see #putExtras
4959 * @see #removeExtra
4960 * @see #getByteExtra(String, byte)
4961 */
4962 public Intent putExtra(String name, byte value) {
4963 if (mExtras == null) {
4964 mExtras = new Bundle();
4965 }
4966 mExtras.putByte(name, value);
4967 return this;
4968 }
4969
4970 /**
4971 * Add extended data to the intent. The name must include a package
4972 * prefix, for example the app com.android.contacts would use names
4973 * like "com.android.contacts.ShowAll".
4974 *
4975 * @param name The name of the extra data, with package prefix.
4976 * @param value The char data value.
4977 *
4978 * @return Returns the same Intent object, for chaining multiple calls
4979 * into a single statement.
4980 *
4981 * @see #putExtras
4982 * @see #removeExtra
4983 * @see #getCharExtra(String, char)
4984 */
4985 public Intent putExtra(String name, char value) {
4986 if (mExtras == null) {
4987 mExtras = new Bundle();
4988 }
4989 mExtras.putChar(name, value);
4990 return this;
4991 }
4992
4993 /**
4994 * Add extended data to the intent. The name must include a package
4995 * prefix, for example the app com.android.contacts would use names
4996 * like "com.android.contacts.ShowAll".
4997 *
4998 * @param name The name of the extra data, with package prefix.
4999 * @param value The short data value.
5000 *
5001 * @return Returns the same Intent object, for chaining multiple calls
5002 * into a single statement.
5003 *
5004 * @see #putExtras
5005 * @see #removeExtra
5006 * @see #getShortExtra(String, short)
5007 */
5008 public Intent putExtra(String name, short value) {
5009 if (mExtras == null) {
5010 mExtras = new Bundle();
5011 }
5012 mExtras.putShort(name, value);
5013 return this;
5014 }
5015
5016 /**
5017 * Add extended data to the intent. The name must include a package
5018 * prefix, for example the app com.android.contacts would use names
5019 * like "com.android.contacts.ShowAll".
5020 *
5021 * @param name The name of the extra data, with package prefix.
5022 * @param value The integer data value.
5023 *
5024 * @return Returns the same Intent object, for chaining multiple calls
5025 * into a single statement.
5026 *
5027 * @see #putExtras
5028 * @see #removeExtra
5029 * @see #getIntExtra(String, int)
5030 */
5031 public Intent putExtra(String name, int value) {
5032 if (mExtras == null) {
5033 mExtras = new Bundle();
5034 }
5035 mExtras.putInt(name, value);
5036 return this;
5037 }
5038
5039 /**
5040 * Add extended data to the intent. The name must include a package
5041 * prefix, for example the app com.android.contacts would use names
5042 * like "com.android.contacts.ShowAll".
5043 *
5044 * @param name The name of the extra data, with package prefix.
5045 * @param value The long data value.
5046 *
5047 * @return Returns the same Intent object, for chaining multiple calls
5048 * into a single statement.
5049 *
5050 * @see #putExtras
5051 * @see #removeExtra
5052 * @see #getLongExtra(String, long)
5053 */
5054 public Intent putExtra(String name, long value) {
5055 if (mExtras == null) {
5056 mExtras = new Bundle();
5057 }
5058 mExtras.putLong(name, value);
5059 return this;
5060 }
5061
5062 /**
5063 * Add extended data to the intent. The name must include a package
5064 * prefix, for example the app com.android.contacts would use names
5065 * like "com.android.contacts.ShowAll".
5066 *
5067 * @param name The name of the extra data, with package prefix.
5068 * @param value The float data value.
5069 *
5070 * @return Returns the same Intent object, for chaining multiple calls
5071 * into a single statement.
5072 *
5073 * @see #putExtras
5074 * @see #removeExtra
5075 * @see #getFloatExtra(String, float)
5076 */
5077 public Intent putExtra(String name, float value) {
5078 if (mExtras == null) {
5079 mExtras = new Bundle();
5080 }
5081 mExtras.putFloat(name, value);
5082 return this;
5083 }
5084
5085 /**
5086 * Add extended data to the intent. The name must include a package
5087 * prefix, for example the app com.android.contacts would use names
5088 * like "com.android.contacts.ShowAll".
5089 *
5090 * @param name The name of the extra data, with package prefix.
5091 * @param value The double data value.
5092 *
5093 * @return Returns the same Intent object, for chaining multiple calls
5094 * into a single statement.
5095 *
5096 * @see #putExtras
5097 * @see #removeExtra
5098 * @see #getDoubleExtra(String, double)
5099 */
5100 public Intent putExtra(String name, double value) {
5101 if (mExtras == null) {
5102 mExtras = new Bundle();
5103 }
5104 mExtras.putDouble(name, value);
5105 return this;
5106 }
5107
5108 /**
5109 * Add extended data to the intent. The name must include a package
5110 * prefix, for example the app com.android.contacts would use names
5111 * like "com.android.contacts.ShowAll".
5112 *
5113 * @param name The name of the extra data, with package prefix.
5114 * @param value The String data value.
5115 *
5116 * @return Returns the same Intent object, for chaining multiple calls
5117 * into a single statement.
5118 *
5119 * @see #putExtras
5120 * @see #removeExtra
5121 * @see #getStringExtra(String)
5122 */
5123 public Intent putExtra(String name, String value) {
5124 if (mExtras == null) {
5125 mExtras = new Bundle();
5126 }
5127 mExtras.putString(name, value);
5128 return this;
5129 }
5130
5131 /**
5132 * Add extended data to the intent. The name must include a package
5133 * prefix, for example the app com.android.contacts would use names
5134 * like "com.android.contacts.ShowAll".
5135 *
5136 * @param name The name of the extra data, with package prefix.
5137 * @param value The CharSequence data value.
5138 *
5139 * @return Returns the same Intent object, for chaining multiple calls
5140 * into a single statement.
5141 *
5142 * @see #putExtras
5143 * @see #removeExtra
5144 * @see #getCharSequenceExtra(String)
5145 */
5146 public Intent putExtra(String name, CharSequence value) {
5147 if (mExtras == null) {
5148 mExtras = new Bundle();
5149 }
5150 mExtras.putCharSequence(name, value);
5151 return this;
5152 }
5153
5154 /**
5155 * Add extended data to the intent. The name must include a package
5156 * prefix, for example the app com.android.contacts would use names
5157 * like "com.android.contacts.ShowAll".
5158 *
5159 * @param name The name of the extra data, with package prefix.
5160 * @param value The Parcelable data value.
5161 *
5162 * @return Returns the same Intent object, for chaining multiple calls
5163 * into a single statement.
5164 *
5165 * @see #putExtras
5166 * @see #removeExtra
5167 * @see #getParcelableExtra(String)
5168 */
5169 public Intent putExtra(String name, Parcelable value) {
5170 if (mExtras == null) {
5171 mExtras = new Bundle();
5172 }
5173 mExtras.putParcelable(name, value);
5174 return this;
5175 }
5176
5177 /**
5178 * Add extended data to the intent. The name must include a package
5179 * prefix, for example the app com.android.contacts would use names
5180 * like "com.android.contacts.ShowAll".
5181 *
5182 * @param name The name of the extra data, with package prefix.
5183 * @param value The Parcelable[] data value.
5184 *
5185 * @return Returns the same Intent object, for chaining multiple calls
5186 * into a single statement.
5187 *
5188 * @see #putExtras
5189 * @see #removeExtra
5190 * @see #getParcelableArrayExtra(String)
5191 */
5192 public Intent putExtra(String name, Parcelable[] value) {
5193 if (mExtras == null) {
5194 mExtras = new Bundle();
5195 }
5196 mExtras.putParcelableArray(name, value);
5197 return this;
5198 }
5199
5200 /**
5201 * Add extended data to the intent. The name must include a package
5202 * prefix, for example the app com.android.contacts would use names
5203 * like "com.android.contacts.ShowAll".
5204 *
5205 * @param name The name of the extra data, with package prefix.
5206 * @param value The ArrayList<Parcelable> data value.
5207 *
5208 * @return Returns the same Intent object, for chaining multiple calls
5209 * into a single statement.
5210 *
5211 * @see #putExtras
5212 * @see #removeExtra
5213 * @see #getParcelableArrayListExtra(String)
5214 */
5215 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5216 if (mExtras == null) {
5217 mExtras = new Bundle();
5218 }
5219 mExtras.putParcelableArrayList(name, value);
5220 return this;
5221 }
5222
5223 /**
5224 * Add extended data to the intent. The name must include a package
5225 * prefix, for example the app com.android.contacts would use names
5226 * like "com.android.contacts.ShowAll".
5227 *
5228 * @param name The name of the extra data, with package prefix.
5229 * @param value The ArrayList<Integer> data value.
5230 *
5231 * @return Returns the same Intent object, for chaining multiple calls
5232 * into a single statement.
5233 *
5234 * @see #putExtras
5235 * @see #removeExtra
5236 * @see #getIntegerArrayListExtra(String)
5237 */
5238 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5239 if (mExtras == null) {
5240 mExtras = new Bundle();
5241 }
5242 mExtras.putIntegerArrayList(name, value);
5243 return this;
5244 }
5245
5246 /**
5247 * Add extended data to the intent. The name must include a package
5248 * prefix, for example the app com.android.contacts would use names
5249 * like "com.android.contacts.ShowAll".
5250 *
5251 * @param name The name of the extra data, with package prefix.
5252 * @param value The ArrayList<String> data value.
5253 *
5254 * @return Returns the same Intent object, for chaining multiple calls
5255 * into a single statement.
5256 *
5257 * @see #putExtras
5258 * @see #removeExtra
5259 * @see #getStringArrayListExtra(String)
5260 */
5261 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5262 if (mExtras == null) {
5263 mExtras = new Bundle();
5264 }
5265 mExtras.putStringArrayList(name, value);
5266 return this;
5267 }
5268
5269 /**
5270 * Add extended data to the intent. The name must include a package
5271 * prefix, for example the app com.android.contacts would use names
5272 * like "com.android.contacts.ShowAll".
5273 *
5274 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005275 * @param value The ArrayList<CharSequence> data value.
5276 *
5277 * @return Returns the same Intent object, for chaining multiple calls
5278 * into a single statement.
5279 *
5280 * @see #putExtras
5281 * @see #removeExtra
5282 * @see #getCharSequenceArrayListExtra(String)
5283 */
5284 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5285 if (mExtras == null) {
5286 mExtras = new Bundle();
5287 }
5288 mExtras.putCharSequenceArrayList(name, value);
5289 return this;
5290 }
5291
5292 /**
5293 * Add extended data to the intent. The name must include a package
5294 * prefix, for example the app com.android.contacts would use names
5295 * like "com.android.contacts.ShowAll".
5296 *
5297 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005298 * @param value The Serializable data value.
5299 *
5300 * @return Returns the same Intent object, for chaining multiple calls
5301 * into a single statement.
5302 *
5303 * @see #putExtras
5304 * @see #removeExtra
5305 * @see #getSerializableExtra(String)
5306 */
5307 public Intent putExtra(String name, Serializable value) {
5308 if (mExtras == null) {
5309 mExtras = new Bundle();
5310 }
5311 mExtras.putSerializable(name, value);
5312 return this;
5313 }
5314
5315 /**
5316 * Add extended data to the intent. The name must include a package
5317 * prefix, for example the app com.android.contacts would use names
5318 * like "com.android.contacts.ShowAll".
5319 *
5320 * @param name The name of the extra data, with package prefix.
5321 * @param value The boolean array data value.
5322 *
5323 * @return Returns the same Intent object, for chaining multiple calls
5324 * into a single statement.
5325 *
5326 * @see #putExtras
5327 * @see #removeExtra
5328 * @see #getBooleanArrayExtra(String)
5329 */
5330 public Intent putExtra(String name, boolean[] value) {
5331 if (mExtras == null) {
5332 mExtras = new Bundle();
5333 }
5334 mExtras.putBooleanArray(name, value);
5335 return this;
5336 }
5337
5338 /**
5339 * Add extended data to the intent. The name must include a package
5340 * prefix, for example the app com.android.contacts would use names
5341 * like "com.android.contacts.ShowAll".
5342 *
5343 * @param name The name of the extra data, with package prefix.
5344 * @param value The byte array data value.
5345 *
5346 * @return Returns the same Intent object, for chaining multiple calls
5347 * into a single statement.
5348 *
5349 * @see #putExtras
5350 * @see #removeExtra
5351 * @see #getByteArrayExtra(String)
5352 */
5353 public Intent putExtra(String name, byte[] value) {
5354 if (mExtras == null) {
5355 mExtras = new Bundle();
5356 }
5357 mExtras.putByteArray(name, value);
5358 return this;
5359 }
5360
5361 /**
5362 * Add extended data to the intent. The name must include a package
5363 * prefix, for example the app com.android.contacts would use names
5364 * like "com.android.contacts.ShowAll".
5365 *
5366 * @param name The name of the extra data, with package prefix.
5367 * @param value The short array data value.
5368 *
5369 * @return Returns the same Intent object, for chaining multiple calls
5370 * into a single statement.
5371 *
5372 * @see #putExtras
5373 * @see #removeExtra
5374 * @see #getShortArrayExtra(String)
5375 */
5376 public Intent putExtra(String name, short[] value) {
5377 if (mExtras == null) {
5378 mExtras = new Bundle();
5379 }
5380 mExtras.putShortArray(name, value);
5381 return this;
5382 }
5383
5384 /**
5385 * Add extended data to the intent. The name must include a package
5386 * prefix, for example the app com.android.contacts would use names
5387 * like "com.android.contacts.ShowAll".
5388 *
5389 * @param name The name of the extra data, with package prefix.
5390 * @param value The char array data value.
5391 *
5392 * @return Returns the same Intent object, for chaining multiple calls
5393 * into a single statement.
5394 *
5395 * @see #putExtras
5396 * @see #removeExtra
5397 * @see #getCharArrayExtra(String)
5398 */
5399 public Intent putExtra(String name, char[] value) {
5400 if (mExtras == null) {
5401 mExtras = new Bundle();
5402 }
5403 mExtras.putCharArray(name, value);
5404 return this;
5405 }
5406
5407 /**
5408 * Add extended data to the intent. The name must include a package
5409 * prefix, for example the app com.android.contacts would use names
5410 * like "com.android.contacts.ShowAll".
5411 *
5412 * @param name The name of the extra data, with package prefix.
5413 * @param value The int array data value.
5414 *
5415 * @return Returns the same Intent object, for chaining multiple calls
5416 * into a single statement.
5417 *
5418 * @see #putExtras
5419 * @see #removeExtra
5420 * @see #getIntArrayExtra(String)
5421 */
5422 public Intent putExtra(String name, int[] value) {
5423 if (mExtras == null) {
5424 mExtras = new Bundle();
5425 }
5426 mExtras.putIntArray(name, value);
5427 return this;
5428 }
5429
5430 /**
5431 * Add extended data to the intent. The name must include a package
5432 * prefix, for example the app com.android.contacts would use names
5433 * like "com.android.contacts.ShowAll".
5434 *
5435 * @param name The name of the extra data, with package prefix.
5436 * @param value The byte array data value.
5437 *
5438 * @return Returns the same Intent object, for chaining multiple calls
5439 * into a single statement.
5440 *
5441 * @see #putExtras
5442 * @see #removeExtra
5443 * @see #getLongArrayExtra(String)
5444 */
5445 public Intent putExtra(String name, long[] value) {
5446 if (mExtras == null) {
5447 mExtras = new Bundle();
5448 }
5449 mExtras.putLongArray(name, value);
5450 return this;
5451 }
5452
5453 /**
5454 * Add extended data to the intent. The name must include a package
5455 * prefix, for example the app com.android.contacts would use names
5456 * like "com.android.contacts.ShowAll".
5457 *
5458 * @param name The name of the extra data, with package prefix.
5459 * @param value The float array data value.
5460 *
5461 * @return Returns the same Intent object, for chaining multiple calls
5462 * into a single statement.
5463 *
5464 * @see #putExtras
5465 * @see #removeExtra
5466 * @see #getFloatArrayExtra(String)
5467 */
5468 public Intent putExtra(String name, float[] value) {
5469 if (mExtras == null) {
5470 mExtras = new Bundle();
5471 }
5472 mExtras.putFloatArray(name, value);
5473 return this;
5474 }
5475
5476 /**
5477 * Add extended data to the intent. The name must include a package
5478 * prefix, for example the app com.android.contacts would use names
5479 * like "com.android.contacts.ShowAll".
5480 *
5481 * @param name The name of the extra data, with package prefix.
5482 * @param value The double array data value.
5483 *
5484 * @return Returns the same Intent object, for chaining multiple calls
5485 * into a single statement.
5486 *
5487 * @see #putExtras
5488 * @see #removeExtra
5489 * @see #getDoubleArrayExtra(String)
5490 */
5491 public Intent putExtra(String name, double[] value) {
5492 if (mExtras == null) {
5493 mExtras = new Bundle();
5494 }
5495 mExtras.putDoubleArray(name, value);
5496 return this;
5497 }
5498
5499 /**
5500 * Add extended data to the intent. The name must include a package
5501 * prefix, for example the app com.android.contacts would use names
5502 * like "com.android.contacts.ShowAll".
5503 *
5504 * @param name The name of the extra data, with package prefix.
5505 * @param value The String array data value.
5506 *
5507 * @return Returns the same Intent object, for chaining multiple calls
5508 * into a single statement.
5509 *
5510 * @see #putExtras
5511 * @see #removeExtra
5512 * @see #getStringArrayExtra(String)
5513 */
5514 public Intent putExtra(String name, String[] value) {
5515 if (mExtras == null) {
5516 mExtras = new Bundle();
5517 }
5518 mExtras.putStringArray(name, value);
5519 return this;
5520 }
5521
5522 /**
5523 * Add extended data to the intent. The name must include a package
5524 * prefix, for example the app com.android.contacts would use names
5525 * like "com.android.contacts.ShowAll".
5526 *
5527 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005528 * @param value The CharSequence array data value.
5529 *
5530 * @return Returns the same Intent object, for chaining multiple calls
5531 * into a single statement.
5532 *
5533 * @see #putExtras
5534 * @see #removeExtra
5535 * @see #getCharSequenceArrayExtra(String)
5536 */
5537 public Intent putExtra(String name, CharSequence[] value) {
5538 if (mExtras == null) {
5539 mExtras = new Bundle();
5540 }
5541 mExtras.putCharSequenceArray(name, value);
5542 return this;
5543 }
5544
5545 /**
5546 * Add extended data to the intent. The name must include a package
5547 * prefix, for example the app com.android.contacts would use names
5548 * like "com.android.contacts.ShowAll".
5549 *
5550 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005551 * @param value The Bundle data value.
5552 *
5553 * @return Returns the same Intent object, for chaining multiple calls
5554 * into a single statement.
5555 *
5556 * @see #putExtras
5557 * @see #removeExtra
5558 * @see #getBundleExtra(String)
5559 */
5560 public Intent putExtra(String name, Bundle value) {
5561 if (mExtras == null) {
5562 mExtras = new Bundle();
5563 }
5564 mExtras.putBundle(name, value);
5565 return this;
5566 }
5567
5568 /**
5569 * Add extended data to the intent. The name must include a package
5570 * prefix, for example the app com.android.contacts would use names
5571 * like "com.android.contacts.ShowAll".
5572 *
5573 * @param name The name of the extra data, with package prefix.
5574 * @param value The IBinder data value.
5575 *
5576 * @return Returns the same Intent object, for chaining multiple calls
5577 * into a single statement.
5578 *
5579 * @see #putExtras
5580 * @see #removeExtra
5581 * @see #getIBinderExtra(String)
5582 *
5583 * @deprecated
5584 * @hide
5585 */
5586 @Deprecated
5587 public Intent putExtra(String name, IBinder value) {
5588 if (mExtras == null) {
5589 mExtras = new Bundle();
5590 }
5591 mExtras.putIBinder(name, value);
5592 return this;
5593 }
5594
5595 /**
5596 * Copy all extras in 'src' in to this intent.
5597 *
5598 * @param src Contains the extras to copy.
5599 *
5600 * @see #putExtra
5601 */
5602 public Intent putExtras(Intent src) {
5603 if (src.mExtras != null) {
5604 if (mExtras == null) {
5605 mExtras = new Bundle(src.mExtras);
5606 } else {
5607 mExtras.putAll(src.mExtras);
5608 }
5609 }
5610 return this;
5611 }
5612
5613 /**
5614 * Add a set of extended data to the intent. The keys must include a package
5615 * prefix, for example the app com.android.contacts would use names
5616 * like "com.android.contacts.ShowAll".
5617 *
5618 * @param extras The Bundle of extras to add to this intent.
5619 *
5620 * @see #putExtra
5621 * @see #removeExtra
5622 */
5623 public Intent putExtras(Bundle extras) {
5624 if (mExtras == null) {
5625 mExtras = new Bundle();
5626 }
5627 mExtras.putAll(extras);
5628 return this;
5629 }
5630
5631 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005632 * Completely replace the extras in the Intent with the extras in the
5633 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005634 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005635 * @param src The exact extras contained in this Intent are copied
5636 * into the target intent, replacing any that were previously there.
5637 */
5638 public Intent replaceExtras(Intent src) {
5639 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5640 return this;
5641 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005642
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005643 /**
5644 * Completely replace the extras in the Intent with the given Bundle of
5645 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005646 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005647 * @param extras The new set of extras in the Intent, or null to erase
5648 * all extras.
5649 */
5650 public Intent replaceExtras(Bundle extras) {
5651 mExtras = extras != null ? new Bundle(extras) : null;
5652 return this;
5653 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005654
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005655 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005656 * Remove extended data from the intent.
5657 *
5658 * @see #putExtra
5659 */
5660 public void removeExtra(String name) {
5661 if (mExtras != null) {
5662 mExtras.remove(name);
5663 if (mExtras.size() == 0) {
5664 mExtras = null;
5665 }
5666 }
5667 }
5668
5669 /**
5670 * Set special flags controlling how this intent is handled. Most values
5671 * here depend on the type of component being executed by the Intent,
5672 * specifically the FLAG_ACTIVITY_* flags are all for use with
5673 * {@link Context#startActivity Context.startActivity()} and the
5674 * FLAG_RECEIVER_* flags are all for use with
5675 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5676 *
Scott Main7aee61f2011-02-08 11:25:01 -08005677 * <p>See the
5678 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5679 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005680 * the behavior of your application.
5681 *
5682 * @param flags The desired flags.
5683 *
5684 * @return Returns the same Intent object, for chaining multiple calls
5685 * into a single statement.
5686 *
5687 * @see #getFlags
5688 * @see #addFlags
5689 *
5690 * @see #FLAG_GRANT_READ_URI_PERMISSION
5691 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5692 * @see #FLAG_DEBUG_LOG_RESOLUTION
5693 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005694 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005695 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005696 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005697 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005698 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5699 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005700 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005701 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5702 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005703 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005704 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005705 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005706 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5707 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005708 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005709 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005710 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005711 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5712 */
5713 public Intent setFlags(int flags) {
5714 mFlags = flags;
5715 return this;
5716 }
5717
5718 /**
5719 * Add additional flags to the intent (or with existing flags
5720 * value).
5721 *
5722 * @param flags The new flags to set.
5723 *
5724 * @return Returns the same Intent object, for chaining multiple calls
5725 * into a single statement.
5726 *
5727 * @see #setFlags
5728 */
5729 public Intent addFlags(int flags) {
5730 mFlags |= flags;
5731 return this;
5732 }
5733
5734 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005735 * (Usually optional) Set an explicit application package name that limits
5736 * the components this Intent will resolve to. If left to the default
5737 * value of null, all components in all applications will considered.
5738 * If non-null, the Intent can only match the components in the given
5739 * application package.
5740 *
5741 * @param packageName The name of the application package to handle the
5742 * intent, or null to allow any application package.
5743 *
5744 * @return Returns the same Intent object, for chaining multiple calls
5745 * into a single statement.
5746 *
5747 * @see #getPackage
5748 * @see #resolveActivity
5749 */
5750 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005751 if (packageName != null && mSelector != null) {
5752 throw new IllegalArgumentException(
5753 "Can't set package name when selector is already set");
5754 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005755 mPackage = packageName;
5756 return this;
5757 }
5758
5759 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005760 * (Usually optional) Explicitly set the component to handle the intent.
5761 * If left with the default value of null, the system will determine the
5762 * appropriate class to use based on the other fields (action, data,
5763 * type, categories) in the Intent. If this class is defined, the
5764 * specified class will always be used regardless of the other fields. You
5765 * should only set this value when you know you absolutely want a specific
5766 * class to be used; otherwise it is better to let the system find the
5767 * appropriate class so that you will respect the installed applications
5768 * and user preferences.
5769 *
5770 * @param component The name of the application component to handle the
5771 * intent, or null to let the system find one for you.
5772 *
5773 * @return Returns the same Intent object, for chaining multiple calls
5774 * into a single statement.
5775 *
5776 * @see #setClass
5777 * @see #setClassName(Context, String)
5778 * @see #setClassName(String, String)
5779 * @see #getComponent
5780 * @see #resolveActivity
5781 */
5782 public Intent setComponent(ComponentName component) {
5783 mComponent = component;
5784 return this;
5785 }
5786
5787 /**
5788 * Convenience for calling {@link #setComponent} with an
5789 * explicit class name.
5790 *
5791 * @param packageContext A Context of the application package implementing
5792 * this class.
5793 * @param className The name of a class inside of the application package
5794 * that will be used as the component for this Intent.
5795 *
5796 * @return Returns the same Intent object, for chaining multiple calls
5797 * into a single statement.
5798 *
5799 * @see #setComponent
5800 * @see #setClass
5801 */
5802 public Intent setClassName(Context packageContext, String className) {
5803 mComponent = new ComponentName(packageContext, className);
5804 return this;
5805 }
5806
5807 /**
5808 * Convenience for calling {@link #setComponent} with an
5809 * explicit application package name and class name.
5810 *
5811 * @param packageName The name of the package implementing the desired
5812 * component.
5813 * @param className The name of a class inside of the application package
5814 * that will be used as the component for this Intent.
5815 *
5816 * @return Returns the same Intent object, for chaining multiple calls
5817 * into a single statement.
5818 *
5819 * @see #setComponent
5820 * @see #setClass
5821 */
5822 public Intent setClassName(String packageName, String className) {
5823 mComponent = new ComponentName(packageName, className);
5824 return this;
5825 }
5826
5827 /**
5828 * Convenience for calling {@link #setComponent(ComponentName)} with the
5829 * name returned by a {@link Class} object.
5830 *
5831 * @param packageContext A Context of the application package implementing
5832 * this class.
5833 * @param cls The class name to set, equivalent to
5834 * <code>setClassName(context, cls.getName())</code>.
5835 *
5836 * @return Returns the same Intent object, for chaining multiple calls
5837 * into a single statement.
5838 *
5839 * @see #setComponent
5840 */
5841 public Intent setClass(Context packageContext, Class<?> cls) {
5842 mComponent = new ComponentName(packageContext, cls);
5843 return this;
5844 }
5845
5846 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005847 * Set the bounds of the sender of this intent, in screen coordinates. This can be
5848 * used as a hint to the receiver for animations and the like. Null means that there
5849 * is no source bounds.
5850 */
5851 public void setSourceBounds(Rect r) {
5852 if (r != null) {
5853 mSourceBounds = new Rect(r);
5854 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07005855 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005856 }
5857 }
5858
5859 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005860 * Use with {@link #fillIn} to allow the current action value to be
5861 * overwritten, even if it is already set.
5862 */
5863 public static final int FILL_IN_ACTION = 1<<0;
5864
5865 /**
5866 * Use with {@link #fillIn} to allow the current data or type value
5867 * overwritten, even if it is already set.
5868 */
5869 public static final int FILL_IN_DATA = 1<<1;
5870
5871 /**
5872 * Use with {@link #fillIn} to allow the current categories to be
5873 * overwritten, even if they are already set.
5874 */
5875 public static final int FILL_IN_CATEGORIES = 1<<2;
5876
5877 /**
5878 * Use with {@link #fillIn} to allow the current component value to be
5879 * overwritten, even if it is already set.
5880 */
5881 public static final int FILL_IN_COMPONENT = 1<<3;
5882
5883 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005884 * Use with {@link #fillIn} to allow the current package value to be
5885 * overwritten, even if it is already set.
5886 */
5887 public static final int FILL_IN_PACKAGE = 1<<4;
5888
5889 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005890 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08005891 * overwritten, even if it is already set.
5892 */
5893 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
5894
5895 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005896 * Use with {@link #fillIn} to allow the current selector to be
5897 * overwritten, even if it is already set.
5898 */
5899 public static final int FILL_IN_SELECTOR = 1<<6;
5900
5901 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005902 * Use with {@link #fillIn} to allow the current ClipData to be
5903 * overwritten, even if it is already set.
5904 */
5905 public static final int FILL_IN_CLIP_DATA = 1<<7;
5906
5907 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005908 * Copy the contents of <var>other</var> in to this object, but only
5909 * where fields are not defined by this object. For purposes of a field
5910 * being defined, the following pieces of data in the Intent are
5911 * considered to be separate fields:
5912 *
5913 * <ul>
5914 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08005915 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005916 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
5917 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005918 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005919 * <li> component, as set by {@link #setComponent(ComponentName)} or
5920 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005921 * <li> source bounds, as set by {@link #setSourceBounds}.
5922 * <li> selector, as set by {@link #setSelector(Intent)}.
5923 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005924 * <li> each top-level name in the associated extras.
5925 * </ul>
5926 *
5927 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005928 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005929 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
5930 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
5931 * the restriction where the corresponding field will not be replaced if
5932 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005933 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005934 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
5935 * is explicitly specified. The selector will only be copied if
5936 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07005937 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005938 * <p>For example, consider Intent A with {data="foo", categories="bar"}
5939 * and Intent B with {action="gotit", data-type="some/thing",
5940 * categories="one","two"}.
5941 *
5942 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
5943 * containing: {action="gotit", data-type="some/thing",
5944 * categories="bar"}.
5945 *
5946 * @param other Another Intent whose values are to be used to fill in
5947 * the current one.
5948 * @param flags Options to control which fields can be filled in.
5949 *
5950 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005951 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005952 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
5953 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005954 */
5955 public int fillIn(Intent other, int flags) {
5956 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005957 if (other.mAction != null
5958 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005959 mAction = other.mAction;
5960 changes |= FILL_IN_ACTION;
5961 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005962 if ((other.mData != null || other.mType != null)
5963 && ((mData == null && mType == null)
5964 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005965 mData = other.mData;
5966 mType = other.mType;
5967 changes |= FILL_IN_DATA;
5968 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005969 if (other.mCategories != null
5970 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005971 if (other.mCategories != null) {
5972 mCategories = new HashSet<String>(other.mCategories);
5973 }
5974 changes |= FILL_IN_CATEGORIES;
5975 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005976 if (other.mPackage != null
5977 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005978 // Only do this if mSelector is not set.
5979 if (mSelector == null) {
5980 mPackage = other.mPackage;
5981 changes |= FILL_IN_PACKAGE;
5982 }
5983 }
5984 // Selector is special: it can only be set if explicitly allowed,
5985 // for the same reason as the component name.
5986 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
5987 if (mPackage == null) {
5988 mSelector = new Intent(other.mSelector);
5989 mPackage = null;
5990 changes |= FILL_IN_SELECTOR;
5991 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005992 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005993 if (other.mClipData != null
5994 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
5995 mClipData = other.mClipData;
5996 changes |= FILL_IN_CLIP_DATA;
5997 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07005998 // Component is special: it can -only- be set if explicitly allowed,
5999 // since otherwise the sender could force the intent somewhere the
6000 // originator didn't intend.
6001 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006002 mComponent = other.mComponent;
6003 changes |= FILL_IN_COMPONENT;
6004 }
6005 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006006 if (other.mSourceBounds != null
6007 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6008 mSourceBounds = new Rect(other.mSourceBounds);
6009 changes |= FILL_IN_SOURCE_BOUNDS;
6010 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006011 if (mExtras == null) {
6012 if (other.mExtras != null) {
6013 mExtras = new Bundle(other.mExtras);
6014 }
6015 } else if (other.mExtras != null) {
6016 try {
6017 Bundle newb = new Bundle(other.mExtras);
6018 newb.putAll(mExtras);
6019 mExtras = newb;
6020 } catch (RuntimeException e) {
6021 // Modifying the extras can cause us to unparcel the contents
6022 // of the bundle, and if we do this in the system process that
6023 // may fail. We really should handle this (i.e., the Bundle
6024 // impl shouldn't be on top of a plain map), but for now just
6025 // ignore it and keep the original contents. :(
6026 Log.w("Intent", "Failure filling in extras", e);
6027 }
6028 }
6029 return changes;
6030 }
6031
6032 /**
6033 * Wrapper class holding an Intent and implementing comparisons on it for
6034 * the purpose of filtering. The class implements its
6035 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6036 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6037 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6038 * on the wrapped Intent.
6039 */
6040 public static final class FilterComparison {
6041 private final Intent mIntent;
6042 private final int mHashCode;
6043
6044 public FilterComparison(Intent intent) {
6045 mIntent = intent;
6046 mHashCode = intent.filterHashCode();
6047 }
6048
6049 /**
6050 * Return the Intent that this FilterComparison represents.
6051 * @return Returns the Intent held by the FilterComparison. Do
6052 * not modify!
6053 */
6054 public Intent getIntent() {
6055 return mIntent;
6056 }
6057
6058 @Override
6059 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006060 if (obj instanceof FilterComparison) {
6061 Intent other = ((FilterComparison)obj).mIntent;
6062 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006063 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006064 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006065 }
6066
6067 @Override
6068 public int hashCode() {
6069 return mHashCode;
6070 }
6071 }
6072
6073 /**
6074 * Determine if two intents are the same for the purposes of intent
6075 * resolution (filtering). That is, if their action, data, type,
6076 * class, and categories are the same. This does <em>not</em> compare
6077 * any extra data included in the intents.
6078 *
6079 * @param other The other Intent to compare against.
6080 *
6081 * @return Returns true if action, data, type, class, and categories
6082 * are the same.
6083 */
6084 public boolean filterEquals(Intent other) {
6085 if (other == null) {
6086 return false;
6087 }
6088 if (mAction != other.mAction) {
6089 if (mAction != null) {
6090 if (!mAction.equals(other.mAction)) {
6091 return false;
6092 }
6093 } else {
6094 if (!other.mAction.equals(mAction)) {
6095 return false;
6096 }
6097 }
6098 }
6099 if (mData != other.mData) {
6100 if (mData != null) {
6101 if (!mData.equals(other.mData)) {
6102 return false;
6103 }
6104 } else {
6105 if (!other.mData.equals(mData)) {
6106 return false;
6107 }
6108 }
6109 }
6110 if (mType != other.mType) {
6111 if (mType != null) {
6112 if (!mType.equals(other.mType)) {
6113 return false;
6114 }
6115 } else {
6116 if (!other.mType.equals(mType)) {
6117 return false;
6118 }
6119 }
6120 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006121 if (mPackage != other.mPackage) {
6122 if (mPackage != null) {
6123 if (!mPackage.equals(other.mPackage)) {
6124 return false;
6125 }
6126 } else {
6127 if (!other.mPackage.equals(mPackage)) {
6128 return false;
6129 }
6130 }
6131 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006132 if (mComponent != other.mComponent) {
6133 if (mComponent != null) {
6134 if (!mComponent.equals(other.mComponent)) {
6135 return false;
6136 }
6137 } else {
6138 if (!other.mComponent.equals(mComponent)) {
6139 return false;
6140 }
6141 }
6142 }
6143 if (mCategories != other.mCategories) {
6144 if (mCategories != null) {
6145 if (!mCategories.equals(other.mCategories)) {
6146 return false;
6147 }
6148 } else {
6149 if (!other.mCategories.equals(mCategories)) {
6150 return false;
6151 }
6152 }
6153 }
6154
6155 return true;
6156 }
6157
6158 /**
6159 * Generate hash code that matches semantics of filterEquals().
6160 *
6161 * @return Returns the hash value of the action, data, type, class, and
6162 * categories.
6163 *
6164 * @see #filterEquals
6165 */
6166 public int filterHashCode() {
6167 int code = 0;
6168 if (mAction != null) {
6169 code += mAction.hashCode();
6170 }
6171 if (mData != null) {
6172 code += mData.hashCode();
6173 }
6174 if (mType != null) {
6175 code += mType.hashCode();
6176 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006177 if (mPackage != null) {
6178 code += mPackage.hashCode();
6179 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006180 if (mComponent != null) {
6181 code += mComponent.hashCode();
6182 }
6183 if (mCategories != null) {
6184 code += mCategories.hashCode();
6185 }
6186 return code;
6187 }
6188
6189 @Override
6190 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006191 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006192
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006193 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006194 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006195 b.append(" }");
6196
6197 return b.toString();
6198 }
6199
6200 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006201 public String toInsecureString() {
6202 StringBuilder b = new StringBuilder(128);
6203
6204 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006205 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006206 b.append(" }");
6207
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006208 return b.toString();
6209 }
Romain Guy4969af72009-06-17 10:53:19 -07006210
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006211 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006212 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006213 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006214
6215 b.append("Intent { ");
6216 toShortString(b, false, true, true, true);
6217 b.append(" }");
6218
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006219 return b.toString();
6220 }
6221
6222 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006223 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6224 StringBuilder b = new StringBuilder(128);
6225 toShortString(b, secure, comp, extras, clip);
6226 return b.toString();
6227 }
6228
6229 /** @hide */
6230 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6231 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006232 boolean first = true;
6233 if (mAction != null) {
6234 b.append("act=").append(mAction);
6235 first = false;
6236 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006237 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006238 if (!first) {
6239 b.append(' ');
6240 }
6241 first = false;
6242 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006243 Iterator<String> i = mCategories.iterator();
6244 boolean didone = false;
6245 while (i.hasNext()) {
6246 if (didone) b.append(",");
6247 didone = true;
6248 b.append(i.next());
6249 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006250 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006251 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006252 if (mData != null) {
6253 if (!first) {
6254 b.append(' ');
6255 }
6256 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006257 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006258 if (secure) {
6259 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006260 } else {
6261 b.append(mData);
6262 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006263 }
6264 if (mType != null) {
6265 if (!first) {
6266 b.append(' ');
6267 }
6268 first = false;
6269 b.append("typ=").append(mType);
6270 }
6271 if (mFlags != 0) {
6272 if (!first) {
6273 b.append(' ');
6274 }
6275 first = false;
6276 b.append("flg=0x").append(Integer.toHexString(mFlags));
6277 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006278 if (mPackage != null) {
6279 if (!first) {
6280 b.append(' ');
6281 }
6282 first = false;
6283 b.append("pkg=").append(mPackage);
6284 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006285 if (comp && mComponent != null) {
6286 if (!first) {
6287 b.append(' ');
6288 }
6289 first = false;
6290 b.append("cmp=").append(mComponent.flattenToShortString());
6291 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006292 if (mSourceBounds != null) {
6293 if (!first) {
6294 b.append(' ');
6295 }
6296 first = false;
6297 b.append("bnds=").append(mSourceBounds.toShortString());
6298 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006299 if (mClipData != null) {
6300 if (!first) {
6301 b.append(' ');
6302 }
6303 first = false;
6304 if (clip) {
6305 b.append("clip={");
6306 mClipData.toShortString(b);
6307 b.append('}');
6308 } else {
6309 b.append("(has clip)");
6310 }
6311 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006312 if (extras && mExtras != null) {
6313 if (!first) {
6314 b.append(' ');
6315 }
6316 first = false;
6317 b.append("(has extras)");
6318 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006319 if (mSelector != null) {
6320 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006321 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006322 b.append("}");
6323 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006324 }
6325
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006326 /**
6327 * Call {@link #toUri} with 0 flags.
6328 * @deprecated Use {@link #toUri} instead.
6329 */
6330 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006331 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006332 return toUri(0);
6333 }
6334
6335 /**
6336 * Convert this Intent into a String holding a URI representation of it.
6337 * The returned URI string has been properly URI encoded, so it can be
6338 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6339 * Intent's data as the base URI, with an additional fragment describing
6340 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006341 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006342 * <p>You can convert the returned string back to an Intent with
6343 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006344 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006345 * @param flags Additional operating flags. Either 0 or
6346 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006347 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006348 * @return Returns a URI encoding URI string describing the entire contents
6349 * of the Intent.
6350 */
6351 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006352 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006353 String scheme = null;
6354 if (mData != null) {
6355 String data = mData.toString();
6356 if ((flags&URI_INTENT_SCHEME) != 0) {
6357 final int N = data.length();
6358 for (int i=0; i<N; i++) {
6359 char c = data.charAt(i);
6360 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6361 || c == '.' || c == '-') {
6362 continue;
6363 }
6364 if (c == ':' && i > 0) {
6365 // Valid scheme.
6366 scheme = data.substring(0, i);
6367 uri.append("intent:");
6368 data = data.substring(i+1);
6369 break;
6370 }
Tom Taylord4a47292009-12-21 13:59:18 -08006371
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006372 // No scheme.
6373 break;
6374 }
6375 }
6376 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006377
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006378 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6379 uri.append("intent:");
6380 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006381
6382 uri.append("#Intent;");
6383
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006384 toUriInner(uri, scheme, flags);
6385 if (mSelector != null) {
6386 uri.append("SEL;");
6387 // Note that for now we are not going to try to handle the
6388 // data part; not clear how to represent this as a URI, and
6389 // not much utility in it.
6390 mSelector.toUriInner(uri, null, flags);
6391 }
6392
6393 uri.append("end");
6394
6395 return uri.toString();
6396 }
6397
6398 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006399 if (scheme != null) {
6400 uri.append("scheme=").append(scheme).append(';');
6401 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006402 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006403 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006404 }
6405 if (mCategories != null) {
6406 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006407 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006408 }
6409 }
6410 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006411 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006412 }
6413 if (mFlags != 0) {
6414 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6415 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006416 if (mPackage != null) {
6417 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6418 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006419 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006420 uri.append("component=").append(Uri.encode(
6421 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006422 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006423 if (mSourceBounds != null) {
6424 uri.append("sourceBounds=")
6425 .append(Uri.encode(mSourceBounds.flattenToString()))
6426 .append(';');
6427 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006428 if (mExtras != null) {
6429 for (String key : mExtras.keySet()) {
6430 final Object value = mExtras.get(key);
6431 char entryType =
6432 value instanceof String ? 'S' :
6433 value instanceof Boolean ? 'B' :
6434 value instanceof Byte ? 'b' :
6435 value instanceof Character ? 'c' :
6436 value instanceof Double ? 'd' :
6437 value instanceof Float ? 'f' :
6438 value instanceof Integer ? 'i' :
6439 value instanceof Long ? 'l' :
6440 value instanceof Short ? 's' :
6441 '\0';
6442
6443 if (entryType != '\0') {
6444 uri.append(entryType);
6445 uri.append('.');
6446 uri.append(Uri.encode(key));
6447 uri.append('=');
6448 uri.append(Uri.encode(value.toString()));
6449 uri.append(';');
6450 }
6451 }
6452 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006453 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006454
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006455 public int describeContents() {
6456 return (mExtras != null) ? mExtras.describeContents() : 0;
6457 }
6458
6459 public void writeToParcel(Parcel out, int flags) {
6460 out.writeString(mAction);
6461 Uri.writeToParcel(out, mData);
6462 out.writeString(mType);
6463 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006464 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006465 ComponentName.writeToParcel(mComponent, out);
6466
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006467 if (mSourceBounds != null) {
6468 out.writeInt(1);
6469 mSourceBounds.writeToParcel(out, flags);
6470 } else {
6471 out.writeInt(0);
6472 }
6473
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006474 if (mCategories != null) {
6475 out.writeInt(mCategories.size());
6476 for (String category : mCategories) {
6477 out.writeString(category);
6478 }
6479 } else {
6480 out.writeInt(0);
6481 }
6482
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006483 if (mSelector != null) {
6484 out.writeInt(1);
6485 mSelector.writeToParcel(out, flags);
6486 } else {
6487 out.writeInt(0);
6488 }
6489
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006490 if (mClipData != null) {
6491 out.writeInt(1);
6492 mClipData.writeToParcel(out, flags);
6493 } else {
6494 out.writeInt(0);
6495 }
6496
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006497 out.writeBundle(mExtras);
6498 }
6499
6500 public static final Parcelable.Creator<Intent> CREATOR
6501 = new Parcelable.Creator<Intent>() {
6502 public Intent createFromParcel(Parcel in) {
6503 return new Intent(in);
6504 }
6505 public Intent[] newArray(int size) {
6506 return new Intent[size];
6507 }
6508 };
6509
Dianne Hackborneb034652009-09-07 00:49:58 -07006510 /** @hide */
6511 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006512 readFromParcel(in);
6513 }
6514
6515 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006516 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006517 mData = Uri.CREATOR.createFromParcel(in);
6518 mType = in.readString();
6519 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006520 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006521 mComponent = ComponentName.readFromParcel(in);
6522
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006523 if (in.readInt() != 0) {
6524 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6525 }
6526
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006527 int N = in.readInt();
6528 if (N > 0) {
6529 mCategories = new HashSet<String>();
6530 int i;
6531 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006532 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006533 }
6534 } else {
6535 mCategories = null;
6536 }
6537
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006538 if (in.readInt() != 0) {
6539 mSelector = new Intent(in);
6540 }
6541
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006542 if (in.readInt() != 0) {
6543 mClipData = new ClipData(in);
6544 }
6545
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006546 mExtras = in.readBundle();
6547 }
6548
6549 /**
6550 * Parses the "intent" element (and its children) from XML and instantiates
6551 * an Intent object. The given XML parser should be located at the tag
6552 * where parsing should start (often named "intent"), from which the
6553 * basic action, data, type, and package and class name will be
6554 * retrieved. The function will then parse in to any child elements,
6555 * looking for <category android:name="xxx"> tags to add categories and
6556 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6557 * to the intent.
6558 *
6559 * @param resources The Resources to use when inflating resources.
6560 * @param parser The XML parser pointing at an "intent" tag.
6561 * @param attrs The AttributeSet interface for retrieving extended
6562 * attribute data at the current <var>parser</var> location.
6563 * @return An Intent object matching the XML data.
6564 * @throws XmlPullParserException If there was an XML parsing error.
6565 * @throws IOException If there was an I/O error.
6566 */
6567 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6568 throws XmlPullParserException, IOException {
6569 Intent intent = new Intent();
6570
6571 TypedArray sa = resources.obtainAttributes(attrs,
6572 com.android.internal.R.styleable.Intent);
6573
6574 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6575
6576 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6577 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6578 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6579
6580 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6581 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6582 if (packageName != null && className != null) {
6583 intent.setComponent(new ComponentName(packageName, className));
6584 }
6585
6586 sa.recycle();
6587
6588 int outerDepth = parser.getDepth();
6589 int type;
6590 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6591 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6592 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6593 continue;
6594 }
6595
6596 String nodeName = parser.getName();
6597 if (nodeName.equals("category")) {
6598 sa = resources.obtainAttributes(attrs,
6599 com.android.internal.R.styleable.IntentCategory);
6600 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6601 sa.recycle();
6602
6603 if (cat != null) {
6604 intent.addCategory(cat);
6605 }
6606 XmlUtils.skipCurrentTag(parser);
6607
6608 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006609 if (intent.mExtras == null) {
6610 intent.mExtras = new Bundle();
6611 }
6612 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6613 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006614
6615 } else {
6616 XmlUtils.skipCurrentTag(parser);
6617 }
6618 }
6619
6620 return intent;
6621 }
Nick Pellyccae4122012-01-09 14:12:58 -08006622
6623 /**
6624 * Normalize a MIME data type.
6625 *
6626 * <p>A normalized MIME type has white-space trimmed,
6627 * content-type parameters removed, and is lower-case.
6628 * This aligns the type with Android best practices for
6629 * intent filtering.
6630 *
6631 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6632 * "text/x-vCard" becomes "text/x-vcard".
6633 *
6634 * <p>All MIME types received from outside Android (such as user input,
6635 * or external sources like Bluetooth, NFC, or the Internet) should
6636 * be normalized before they are used to create an Intent.
6637 *
6638 * @param type MIME data type to normalize
6639 * @return normalized MIME data type, or null if the input was null
6640 * @see {@link #setType}
6641 * @see {@link #setTypeAndNormalize}
6642 */
6643 public static String normalizeMimeType(String type) {
6644 if (type == null) {
6645 return null;
6646 }
6647
6648 type = type.trim().toLowerCase(Locale.US);
6649
6650 final int semicolonIndex = type.indexOf(';');
6651 if (semicolonIndex != -1) {
6652 type = type.substring(0, semicolonIndex);
6653 }
6654 return type;
6655 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006656
6657 /**
6658 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006659 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6660 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006661 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006662 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006663 * @hide
6664 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006665 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006666 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006667 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006668
6669 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006670 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006671
6672 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006673 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006674 try {
6675 // Inspect target intent to see if we need to migrate
6676 final Intent target = getParcelableExtra(EXTRA_INTENT);
6677 if (target != null && target.migrateExtraStreamToClipData()) {
6678 // Since we migrated in child, we need to promote ClipData
6679 // and flags to ourselves to grant.
6680 setClipData(target.getClipData());
6681 addFlags(target.getFlags()
6682 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6683 return true;
6684 } else {
6685 return false;
6686 }
6687 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006688 }
6689
6690 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006691 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006692 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6693 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6694 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6695 if (stream != null || text != null || htmlText != null) {
6696 final ClipData clipData = new ClipData(
6697 null, new String[] { getType() },
6698 new ClipData.Item(text, htmlText, null, stream));
6699 setClipData(clipData);
6700 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006701 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006702 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006703 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006704 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006705
6706 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006707 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006708 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6709 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6710 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6711 int num = -1;
6712 if (streams != null) {
6713 num = streams.size();
6714 }
6715 if (texts != null) {
6716 if (num >= 0 && num != texts.size()) {
6717 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006718 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006719 }
6720 num = texts.size();
6721 }
6722 if (htmlTexts != null) {
6723 if (num >= 0 && num != htmlTexts.size()) {
6724 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006725 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006726 }
6727 num = htmlTexts.size();
6728 }
6729 if (num > 0) {
6730 final ClipData clipData = new ClipData(
6731 null, new String[] { getType() },
6732 makeClipItem(streams, texts, htmlTexts, 0));
6733
6734 for (int i = 1; i < num; i++) {
6735 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
6736 }
6737
6738 setClipData(clipData);
6739 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006740 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006741 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006742 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006743 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006744 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006745
6746 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006747 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07006748
6749 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
6750 ArrayList<String> htmlTexts, int which) {
6751 Uri uri = streams != null ? streams.get(which) : null;
6752 CharSequence text = texts != null ? texts.get(which) : null;
6753 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
6754 return new ClipData.Item(text, htmlText, null, uri);
6755 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006756}