blob: 60e9f58b171b393663b940d7646deea973291d4e [file] [log] [blame]
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001/*
2 * Copyright (C) 2006 The Android Open Source Project
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17package android.content;
18
19import org.xmlpull.v1.XmlPullParser;
20import org.xmlpull.v1.XmlPullParserException;
21
22import android.annotation.SdkConstant;
23import android.annotation.SdkConstant.SdkConstantType;
24import android.content.pm.ActivityInfo;
25import android.content.pm.PackageManager;
26import android.content.pm.ResolveInfo;
27import android.content.res.Resources;
28import android.content.res.TypedArray;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -080029import android.graphics.Rect;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070030import android.net.Uri;
31import android.os.Bundle;
32import android.os.IBinder;
33import android.os.Parcel;
34import android.os.Parcelable;
35import android.util.AttributeSet;
36import android.util.Log;
Dianne Hackborn2269d1572010-02-24 19:54:22 -080037
38import com.android.internal.util.XmlUtils;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070039
40import java.io.IOException;
41import java.io.Serializable;
42import java.net.URISyntaxException;
43import java.util.ArrayList;
44import java.util.HashSet;
45import java.util.Iterator;
Nick Pellyccae4122012-01-09 14:12:58 -080046import java.util.Locale;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070047import java.util.Set;
48
49/**
50 * An intent is an abstract description of an operation to be performed. It
51 * can be used with {@link Context#startActivity(Intent) startActivity} to
52 * launch an {@link android.app.Activity},
53 * {@link android.content.Context#sendBroadcast(Intent) broadcastIntent} to
54 * send it to any interested {@link BroadcastReceiver BroadcastReceiver} components,
55 * and {@link android.content.Context#startService} or
56 * {@link android.content.Context#bindService} to communicate with a
57 * background {@link android.app.Service}.
58 *
Joe Fernandezb54e7a32011-10-03 15:09:50 -070059 * <p>An Intent provides a facility for performing late runtime binding between the code in
60 * different applications. Its most significant use is in the launching of activities, where it
Daniel Lehmanna5b58df2011-10-12 16:24:22 -070061 * can be thought of as the glue between activities. It is basically a passive data structure
62 * holding an abstract description of an action to be performed.</p>
Joe Fernandezb54e7a32011-10-03 15:09:50 -070063 *
64 * <div class="special reference">
65 * <h3>Developer Guides</h3>
66 * <p>For information about how to create and resolve intents, read the
67 * <a href="{@docRoot}guide/topics/intents/intents-filters.html">Intents and Intent Filters</a>
68 * developer guide.</p>
69 * </div>
70 *
71 * <a name="IntentStructure"></a>
72 * <h3>Intent Structure</h3>
73 * <p>The primary pieces of information in an intent are:</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070074 *
75 * <ul>
76 * <li> <p><b>action</b> -- The general action to be performed, such as
77 * {@link #ACTION_VIEW}, {@link #ACTION_EDIT}, {@link #ACTION_MAIN},
78 * etc.</p>
79 * </li>
80 * <li> <p><b>data</b> -- The data to operate on, such as a person record
81 * in the contacts database, expressed as a {@link android.net.Uri}.</p>
82 * </li>
83 * </ul>
84 *
85 *
86 * <p>Some examples of action/data pairs are:</p>
87 *
88 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070089 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070090 * information about the person whose identifier is "1".</p>
91 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -070092 * <li> <p><b>{@link #ACTION_DIAL} <i>content://contacts/people/1</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -070093 * the phone dialer with the person filled in.</p>
94 * </li>
95 * <li> <p><b>{@link #ACTION_VIEW} <i>tel:123</i></b> -- Display
96 * the phone dialer with the given number filled in. Note how the
97 * VIEW action does what what is considered the most reasonable thing for
98 * a particular URI.</p>
99 * </li>
100 * <li> <p><b>{@link #ACTION_DIAL} <i>tel:123</i></b> -- Display
101 * the phone dialer with the given number filled in.</p>
102 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700103 * <li> <p><b>{@link #ACTION_EDIT} <i>content://contacts/people/1</i></b> -- Edit
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700104 * information about the person whose identifier is "1".</p>
105 * </li>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700106 * <li> <p><b>{@link #ACTION_VIEW} <i>content://contacts/people/</i></b> -- Display
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700107 * a list of people, which the user can browse through. This example is a
108 * typical top-level entry into the Contacts application, showing you the
109 * list of people. Selecting a particular person to view would result in a
110 * new intent { <b>{@link #ACTION_VIEW} <i>content://contacts/N</i></b> }
111 * being used to start an activity to display that person.</p>
112 * </li>
113 * </ul>
114 *
115 * <p>In addition to these primary attributes, there are a number of secondary
116 * attributes that you can also include with an intent:</p>
117 *
118 * <ul>
119 * <li> <p><b>category</b> -- Gives additional information about the action
120 * to execute. For example, {@link #CATEGORY_LAUNCHER} means it should
121 * appear in the Launcher as a top-level application, while
122 * {@link #CATEGORY_ALTERNATIVE} means it should be included in a list
123 * of alternative actions the user can perform on a piece of data.</p>
124 * <li> <p><b>type</b> -- Specifies an explicit type (a MIME type) of the
125 * intent data. Normally the type is inferred from the data itself.
126 * By setting this attribute, you disable that evaluation and force
127 * an explicit type.</p>
128 * <li> <p><b>component</b> -- Specifies an explicit name of a component
129 * class to use for the intent. Normally this is determined by looking
130 * at the other information in the intent (the action, data/type, and
131 * categories) and matching that with a component that can handle it.
132 * If this attribute is set then none of the evaluation is performed,
133 * and this component is used exactly as is. By specifying this attribute,
134 * all of the other Intent attributes become optional.</p>
135 * <li> <p><b>extras</b> -- This is a {@link Bundle} of any additional information.
136 * This can be used to provide extended information to the component.
137 * For example, if we have a action to send an e-mail message, we could
138 * also include extra pieces of data here to supply a subject, body,
139 * etc.</p>
140 * </ul>
141 *
142 * <p>Here are some examples of other operations you can specify as intents
143 * using these additional parameters:</p>
144 *
145 * <ul>
146 * <li> <p><b>{@link #ACTION_MAIN} with category {@link #CATEGORY_HOME}</b> --
147 * Launch the home screen.</p>
148 * </li>
149 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
150 * <i>{@link android.provider.Contacts.Phones#CONTENT_URI
151 * vnd.android.cursor.item/phone}</i></b>
152 * -- Display the list of people's phone numbers, allowing the user to
153 * browse through them and pick one and return it to the parent activity.</p>
154 * </li>
155 * <li> <p><b>{@link #ACTION_GET_CONTENT} with MIME type
156 * <i>*{@literal /}*</i> and category {@link #CATEGORY_OPENABLE}</b>
157 * -- Display all pickers for data that can be opened with
158 * {@link ContentResolver#openInputStream(Uri) ContentResolver.openInputStream()},
159 * allowing the user to pick one of them and then some data inside of it
160 * and returning the resulting URI to the caller. This can be used,
161 * for example, in an e-mail application to allow the user to pick some
162 * data to include as an attachment.</p>
163 * </li>
164 * </ul>
165 *
166 * <p>There are a variety of standard Intent action and category constants
167 * defined in the Intent class, but applications can also define their own.
168 * These strings use java style scoping, to ensure they are unique -- for
169 * example, the standard {@link #ACTION_VIEW} is called
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700170 * "android.intent.action.VIEW".</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700171 *
172 * <p>Put together, the set of actions, data types, categories, and extra data
173 * defines a language for the system allowing for the expression of phrases
174 * such as "call john smith's cell". As applications are added to the system,
175 * they can extend this language by adding new actions, types, and categories, or
176 * they can modify the behavior of existing phrases by supplying their own
177 * activities that handle them.</p>
178 *
179 * <a name="IntentResolution"></a>
180 * <h3>Intent Resolution</h3>
181 *
182 * <p>There are two primary forms of intents you will use.
183 *
184 * <ul>
185 * <li> <p><b>Explicit Intents</b> have specified a component (via
186 * {@link #setComponent} or {@link #setClass}), which provides the exact
187 * class to be run. Often these will not include any other information,
188 * simply being a way for an application to launch various internal
189 * activities it has as the user interacts with the application.
190 *
191 * <li> <p><b>Implicit Intents</b> have not specified a component;
192 * instead, they must include enough information for the system to
193 * determine which of the available components is best to run for that
194 * intent.
195 * </ul>
196 *
197 * <p>When using implicit intents, given such an arbitrary intent we need to
198 * know what to do with it. This is handled by the process of <em>Intent
199 * resolution</em>, which maps an Intent to an {@link android.app.Activity},
200 * {@link BroadcastReceiver}, or {@link android.app.Service} (or sometimes two or
201 * more activities/receivers) that can handle it.</p>
202 *
203 * <p>The intent resolution mechanism basically revolves around matching an
204 * Intent against all of the &lt;intent-filter&gt; descriptions in the
205 * installed application packages. (Plus, in the case of broadcasts, any {@link BroadcastReceiver}
206 * objects explicitly registered with {@link Context#registerReceiver}.) More
207 * details on this can be found in the documentation on the {@link
208 * IntentFilter} class.</p>
209 *
210 * <p>There are three pieces of information in the Intent that are used for
211 * resolution: the action, type, and category. Using this information, a query
212 * is done on the {@link PackageManager} for a component that can handle the
213 * intent. The appropriate component is determined based on the intent
214 * information supplied in the <code>AndroidManifest.xml</code> file as
215 * follows:</p>
216 *
217 * <ul>
218 * <li> <p>The <b>action</b>, if given, must be listed by the component as
219 * one it handles.</p>
220 * <li> <p>The <b>type</b> is retrieved from the Intent's data, if not
221 * already supplied in the Intent. Like the action, if a type is
222 * included in the intent (either explicitly or implicitly in its
223 * data), then this must be listed by the component as one it handles.</p>
224 * <li> For data that is not a <code>content:</code> URI and where no explicit
225 * type is included in the Intent, instead the <b>scheme</b> of the
226 * intent data (such as <code>http:</code> or <code>mailto:</code>) is
227 * considered. Again like the action, if we are matching a scheme it
228 * must be listed by the component as one it can handle.
229 * <li> <p>The <b>categories</b>, if supplied, must <em>all</em> be listed
230 * by the activity as categories it handles. That is, if you include
231 * the categories {@link #CATEGORY_LAUNCHER} and
232 * {@link #CATEGORY_ALTERNATIVE}, then you will only resolve to components
233 * with an intent that lists <em>both</em> of those categories.
234 * Activities will very often need to support the
235 * {@link #CATEGORY_DEFAULT} so that they can be found by
236 * {@link Context#startActivity Context.startActivity()}.</p>
237 * </ul>
238 *
239 * <p>For example, consider the Note Pad sample application that
240 * allows user to browse through a list of notes data and view details about
241 * individual items. Text in italics indicate places were you would replace a
242 * name with one specific to your own package.</p>
243 *
244 * <pre> &lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
245 * package="<i>com.android.notepad</i>"&gt;
246 * &lt;application android:icon="@drawable/app_notes"
247 * android:label="@string/app_name"&gt;
248 *
249 * &lt;provider class=".NotePadProvider"
250 * android:authorities="<i>com.google.provider.NotePad</i>" /&gt;
251 *
252 * &lt;activity class=".NotesList" android:label="@string/title_notes_list"&gt;
253 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700254 * &lt;action android:name="android.intent.action.MAIN" /&gt;
255 * &lt;category android:name="android.intent.category.LAUNCHER" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700256 * &lt;/intent-filter&gt;
257 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700258 * &lt;action android:name="android.intent.action.VIEW" /&gt;
259 * &lt;action android:name="android.intent.action.EDIT" /&gt;
260 * &lt;action android:name="android.intent.action.PICK" /&gt;
261 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
262 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700263 * &lt;/intent-filter&gt;
264 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700265 * &lt;action android:name="android.intent.action.GET_CONTENT" /&gt;
266 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
267 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700268 * &lt;/intent-filter&gt;
269 * &lt;/activity&gt;
270 *
271 * &lt;activity class=".NoteEditor" android:label="@string/title_note"&gt;
272 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700273 * &lt;action android:name="android.intent.action.VIEW" /&gt;
274 * &lt;action android:name="android.intent.action.EDIT" /&gt;
275 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
276 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700277 * &lt;/intent-filter&gt;
278 *
279 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700280 * &lt;action android:name="android.intent.action.INSERT" /&gt;
281 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
282 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700283 * &lt;/intent-filter&gt;
284 *
285 * &lt;/activity&gt;
286 *
287 * &lt;activity class=".TitleEditor" android:label="@string/title_edit_title"
288 * android:theme="@android:style/Theme.Dialog"&gt;
289 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700290 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
291 * &lt;category android:name="android.intent.category.DEFAULT" /&gt;
292 * &lt;category android:name="android.intent.category.ALTERNATIVE" /&gt;
293 * &lt;category android:name="android.intent.category.SELECTED_ALTERNATIVE" /&gt;
294 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700295 * &lt;/intent-filter&gt;
296 * &lt;/activity&gt;
297 *
298 * &lt;/application&gt;
299 * &lt;/manifest&gt;</pre>
300 *
301 * <p>The first activity,
302 * <code>com.android.notepad.NotesList</code>, serves as our main
303 * entry into the app. It can do three things as described by its three intent
304 * templates:
305 * <ol>
306 * <li><pre>
307 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700308 * &lt;action android:name="{@link #ACTION_MAIN android.intent.action.MAIN}" /&gt;
309 * &lt;category android:name="{@link #CATEGORY_LAUNCHER android.intent.category.LAUNCHER}" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700310 * &lt;/intent-filter&gt;</pre>
311 * <p>This provides a top-level entry into the NotePad application: the standard
312 * MAIN action is a main entry point (not requiring any other information in
313 * the Intent), and the LAUNCHER category says that this entry point should be
314 * listed in the application launcher.</p>
315 * <li><pre>
316 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700317 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
318 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
319 * &lt;action android:name="{@link #ACTION_PICK android.intent.action.PICK}" /&gt;
320 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
321 * &lt;data mimeType:name="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700322 * &lt;/intent-filter&gt;</pre>
323 * <p>This declares the things that the activity can do on a directory of
324 * notes. The type being supported is given with the &lt;type&gt; tag, where
325 * <code>vnd.android.cursor.dir/vnd.google.note</code> is a URI from which
326 * a Cursor of zero or more items (<code>vnd.android.cursor.dir</code>) can
327 * be retrieved which holds our note pad data (<code>vnd.google.note</code>).
328 * The activity allows the user to view or edit the directory of data (via
329 * the VIEW and EDIT actions), or to pick a particular note and return it
330 * to the caller (via the PICK action). Note also the DEFAULT category
331 * supplied here: this is <em>required</em> for the
332 * {@link Context#startActivity Context.startActivity} method to resolve your
333 * activity when its component name is not explicitly specified.</p>
334 * <li><pre>
335 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700336 * &lt;action android:name="{@link #ACTION_GET_CONTENT android.intent.action.GET_CONTENT}" /&gt;
337 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
338 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700339 * &lt;/intent-filter&gt;</pre>
340 * <p>This filter describes the ability return to the caller a note selected by
341 * the user without needing to know where it came from. The data type
342 * <code>vnd.android.cursor.item/vnd.google.note</code> is a URI from which
343 * a Cursor of exactly one (<code>vnd.android.cursor.item</code>) item can
344 * be retrieved which contains our note pad data (<code>vnd.google.note</code>).
345 * The GET_CONTENT action is similar to the PICK action, where the activity
346 * will return to its caller a piece of data selected by the user. Here,
347 * however, the caller specifies the type of data they desire instead of
348 * the type of data the user will be picking from.</p>
349 * </ol>
350 *
351 * <p>Given these capabilities, the following intents will resolve to the
352 * NotesList activity:</p>
353 *
354 * <ul>
355 * <li> <p><b>{ action=android.app.action.MAIN }</b> matches all of the
356 * activities that can be used as top-level entry points into an
357 * application.</p>
358 * <li> <p><b>{ action=android.app.action.MAIN,
359 * category=android.app.category.LAUNCHER }</b> is the actual intent
360 * used by the Launcher to populate its top-level list.</p>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700361 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700362 * data=content://com.google.provider.NotePad/notes }</b>
363 * displays a list of all the notes under
364 * "content://com.google.provider.NotePad/notes", which
365 * the user can browse through and see the details on.</p>
366 * <li> <p><b>{ action=android.app.action.PICK
367 * data=content://com.google.provider.NotePad/notes }</b>
368 * provides a list of the notes under
369 * "content://com.google.provider.NotePad/notes", from which
370 * the user can pick a note whose data URL is returned back to the caller.</p>
371 * <li> <p><b>{ action=android.app.action.GET_CONTENT
372 * type=vnd.android.cursor.item/vnd.google.note }</b>
373 * is similar to the pick action, but allows the caller to specify the
374 * kind of data they want back so that the system can find the appropriate
375 * activity to pick something of that data type.</p>
376 * </ul>
377 *
378 * <p>The second activity,
379 * <code>com.android.notepad.NoteEditor</code>, shows the user a single
380 * note entry and allows them to edit it. It can do two things as described
381 * by its two intent templates:
382 * <ol>
383 * <li><pre>
384 * &lt;intent-filter android:label="@string/resolve_edit"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700385 * &lt;action android:name="{@link #ACTION_VIEW android.intent.action.VIEW}" /&gt;
386 * &lt;action android:name="{@link #ACTION_EDIT android.intent.action.EDIT}" /&gt;
387 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
388 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700389 * &lt;/intent-filter&gt;</pre>
390 * <p>The first, primary, purpose of this activity is to let the user interact
391 * with a single note, as decribed by the MIME type
392 * <code>vnd.android.cursor.item/vnd.google.note</code>. The activity can
393 * either VIEW a note or allow the user to EDIT it. Again we support the
394 * DEFAULT category to allow the activity to be launched without explicitly
395 * specifying its component.</p>
396 * <li><pre>
397 * &lt;intent-filter&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700398 * &lt;action android:name="{@link #ACTION_INSERT android.intent.action.INSERT}" /&gt;
399 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
400 * &lt;data android:mimeType="vnd.android.cursor.dir/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700401 * &lt;/intent-filter&gt;</pre>
402 * <p>The secondary use of this activity is to insert a new note entry into
403 * an existing directory of notes. This is used when the user creates a new
404 * note: the INSERT action is executed on the directory of notes, causing
405 * this activity to run and have the user create the new note data which
406 * it then adds to the content provider.</p>
407 * </ol>
408 *
409 * <p>Given these capabilities, the following intents will resolve to the
410 * NoteEditor activity:</p>
411 *
412 * <ul>
Yusuf T. Mobile8ecb36e2009-07-10 14:13:29 -0700413 * <li> <p><b>{ action=android.intent.action.VIEW
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700414 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
415 * shows the user the content of note <var>{ID}</var>.</p>
416 * <li> <p><b>{ action=android.app.action.EDIT
417 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
418 * allows the user to edit the content of note <var>{ID}</var>.</p>
419 * <li> <p><b>{ action=android.app.action.INSERT
420 * data=content://com.google.provider.NotePad/notes }</b>
421 * creates a new, empty note in the notes list at
422 * "content://com.google.provider.NotePad/notes"
423 * and allows the user to edit it. If they keep their changes, the URI
424 * of the newly created note is returned to the caller.</p>
425 * </ul>
426 *
427 * <p>The last activity,
428 * <code>com.android.notepad.TitleEditor</code>, allows the user to
429 * edit the title of a note. This could be implemented as a class that the
430 * application directly invokes (by explicitly setting its component in
431 * the Intent), but here we show a way you can publish alternative
432 * operations on existing data:</p>
433 *
434 * <pre>
435 * &lt;intent-filter android:label="@string/resolve_title"&gt;
Romain Guy4969af72009-06-17 10:53:19 -0700436 * &lt;action android:name="<i>com.android.notepad.action.EDIT_TITLE</i>" /&gt;
437 * &lt;category android:name="{@link #CATEGORY_DEFAULT android.intent.category.DEFAULT}" /&gt;
438 * &lt;category android:name="{@link #CATEGORY_ALTERNATIVE android.intent.category.ALTERNATIVE}" /&gt;
439 * &lt;category android:name="{@link #CATEGORY_SELECTED_ALTERNATIVE android.intent.category.SELECTED_ALTERNATIVE}" /&gt;
440 * &lt;data android:mimeType="vnd.android.cursor.item/<i>vnd.google.note</i>" /&gt;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700441 * &lt;/intent-filter&gt;</pre>
442 *
443 * <p>In the single intent template here, we
444 * have created our own private action called
445 * <code>com.android.notepad.action.EDIT_TITLE</code> which means to
446 * edit the title of a note. It must be invoked on a specific note
447 * (data type <code>vnd.android.cursor.item/vnd.google.note</code>) like the previous
448 * view and edit actions, but here displays and edits the title contained
449 * in the note data.
450 *
451 * <p>In addition to supporting the default category as usual, our title editor
452 * also supports two other standard categories: ALTERNATIVE and
453 * SELECTED_ALTERNATIVE. Implementing
454 * these categories allows others to find the special action it provides
455 * without directly knowing about it, through the
456 * {@link android.content.pm.PackageManager#queryIntentActivityOptions} method, or
457 * more often to build dynamic menu items with
458 * {@link android.view.Menu#addIntentOptions}. Note that in the intent
459 * template here was also supply an explicit name for the template
460 * (via <code>android:label="@string/resolve_title"</code>) to better control
461 * what the user sees when presented with this activity as an alternative
462 * action to the data they are viewing.
463 *
464 * <p>Given these capabilities, the following intent will resolve to the
465 * TitleEditor activity:</p>
466 *
467 * <ul>
468 * <li> <p><b>{ action=com.android.notepad.action.EDIT_TITLE
469 * data=content://com.google.provider.NotePad/notes/<var>{ID}</var> }</b>
470 * displays and allows the user to edit the title associated
471 * with note <var>{ID}</var>.</p>
472 * </ul>
473 *
474 * <h3>Standard Activity Actions</h3>
475 *
476 * <p>These are the current standard actions that Intent defines for launching
477 * activities (usually through {@link Context#startActivity}. The most
478 * important, and by far most frequently used, are {@link #ACTION_MAIN} and
479 * {@link #ACTION_EDIT}.
480 *
481 * <ul>
482 * <li> {@link #ACTION_MAIN}
483 * <li> {@link #ACTION_VIEW}
484 * <li> {@link #ACTION_ATTACH_DATA}
485 * <li> {@link #ACTION_EDIT}
486 * <li> {@link #ACTION_PICK}
487 * <li> {@link #ACTION_CHOOSER}
488 * <li> {@link #ACTION_GET_CONTENT}
489 * <li> {@link #ACTION_DIAL}
490 * <li> {@link #ACTION_CALL}
491 * <li> {@link #ACTION_SEND}
492 * <li> {@link #ACTION_SENDTO}
493 * <li> {@link #ACTION_ANSWER}
494 * <li> {@link #ACTION_INSERT}
495 * <li> {@link #ACTION_DELETE}
496 * <li> {@link #ACTION_RUN}
497 * <li> {@link #ACTION_SYNC}
498 * <li> {@link #ACTION_PICK_ACTIVITY}
499 * <li> {@link #ACTION_SEARCH}
500 * <li> {@link #ACTION_WEB_SEARCH}
501 * <li> {@link #ACTION_FACTORY_TEST}
502 * </ul>
503 *
504 * <h3>Standard Broadcast Actions</h3>
505 *
506 * <p>These are the current standard actions that Intent defines for receiving
507 * broadcasts (usually through {@link Context#registerReceiver} or a
508 * &lt;receiver&gt; tag in a manifest).
509 *
510 * <ul>
511 * <li> {@link #ACTION_TIME_TICK}
512 * <li> {@link #ACTION_TIME_CHANGED}
513 * <li> {@link #ACTION_TIMEZONE_CHANGED}
514 * <li> {@link #ACTION_BOOT_COMPLETED}
515 * <li> {@link #ACTION_PACKAGE_ADDED}
516 * <li> {@link #ACTION_PACKAGE_CHANGED}
517 * <li> {@link #ACTION_PACKAGE_REMOVED}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800518 * <li> {@link #ACTION_PACKAGE_RESTARTED}
519 * <li> {@link #ACTION_PACKAGE_DATA_CLEARED}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700520 * <li> {@link #ACTION_UID_REMOVED}
521 * <li> {@link #ACTION_BATTERY_CHANGED}
Cliff Spradlinfda6fae2008-10-22 20:29:16 -0700522 * <li> {@link #ACTION_POWER_CONNECTED}
Romain Guy4969af72009-06-17 10:53:19 -0700523 * <li> {@link #ACTION_POWER_DISCONNECTED}
524 * <li> {@link #ACTION_SHUTDOWN}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700525 * </ul>
526 *
527 * <h3>Standard Categories</h3>
528 *
529 * <p>These are the current standard categories that can be used to further
530 * clarify an Intent via {@link #addCategory}.
531 *
532 * <ul>
533 * <li> {@link #CATEGORY_DEFAULT}
534 * <li> {@link #CATEGORY_BROWSABLE}
535 * <li> {@link #CATEGORY_TAB}
536 * <li> {@link #CATEGORY_ALTERNATIVE}
537 * <li> {@link #CATEGORY_SELECTED_ALTERNATIVE}
538 * <li> {@link #CATEGORY_LAUNCHER}
The Android Open Source Project9066cfe2009-03-03 19:31:44 -0800539 * <li> {@link #CATEGORY_INFO}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700540 * <li> {@link #CATEGORY_HOME}
541 * <li> {@link #CATEGORY_PREFERENCE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700542 * <li> {@link #CATEGORY_TEST}
Mike Lockwood9092ab42009-09-16 13:01:32 -0400543 * <li> {@link #CATEGORY_CAR_DOCK}
544 * <li> {@link #CATEGORY_DESK_DOCK}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500545 * <li> {@link #CATEGORY_LE_DESK_DOCK}
546 * <li> {@link #CATEGORY_HE_DESK_DOCK}
Bernd Holzheyaea4b672010-03-31 09:46:13 +0200547 * <li> {@link #CATEGORY_CAR_MODE}
Patrick Dubroy6dabe242010-08-30 10:43:47 -0700548 * <li> {@link #CATEGORY_APP_MARKET}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700549 * </ul>
550 *
551 * <h3>Standard Extra Data</h3>
552 *
553 * <p>These are the current standard fields that can be used as extra data via
554 * {@link #putExtra}.
555 *
556 * <ul>
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800557 * <li> {@link #EXTRA_ALARM_COUNT}
558 * <li> {@link #EXTRA_BCC}
559 * <li> {@link #EXTRA_CC}
560 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME}
561 * <li> {@link #EXTRA_DATA_REMOVED}
562 * <li> {@link #EXTRA_DOCK_STATE}
Praveen Bharathi21e941b2010-10-06 15:23:14 -0500563 * <li> {@link #EXTRA_DOCK_STATE_HE_DESK}
564 * <li> {@link #EXTRA_DOCK_STATE_LE_DESK}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800565 * <li> {@link #EXTRA_DOCK_STATE_CAR}
566 * <li> {@link #EXTRA_DOCK_STATE_DESK}
567 * <li> {@link #EXTRA_DOCK_STATE_UNDOCKED}
568 * <li> {@link #EXTRA_DONT_KILL_APP}
569 * <li> {@link #EXTRA_EMAIL}
570 * <li> {@link #EXTRA_INITIAL_INTENTS}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700571 * <li> {@link #EXTRA_INTENT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800572 * <li> {@link #EXTRA_KEY_EVENT}
rich cannings706e8ba2012-08-20 13:20:14 -0700573 * <li> {@link #EXTRA_ORIGINATING_URI}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800574 * <li> {@link #EXTRA_PHONE_NUMBER}
rich cannings368ed012012-06-07 15:37:57 -0700575 * <li> {@link #EXTRA_REFERRER}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800576 * <li> {@link #EXTRA_REMOTE_INTENT_TOKEN}
577 * <li> {@link #EXTRA_REPLACING}
578 * <li> {@link #EXTRA_SHORTCUT_ICON}
579 * <li> {@link #EXTRA_SHORTCUT_ICON_RESOURCE}
580 * <li> {@link #EXTRA_SHORTCUT_INTENT}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700581 * <li> {@link #EXTRA_STREAM}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800582 * <li> {@link #EXTRA_SHORTCUT_NAME}
583 * <li> {@link #EXTRA_SUBJECT}
584 * <li> {@link #EXTRA_TEMPLATE}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700585 * <li> {@link #EXTRA_TEXT}
Trevor Johnsd59fb6e2009-11-20 12:54:57 -0800586 * <li> {@link #EXTRA_TITLE}
587 * <li> {@link #EXTRA_UID}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700588 * </ul>
589 *
590 * <h3>Flags</h3>
591 *
592 * <p>These are the possible flags that can be used in the Intent via
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800593 * {@link #setFlags} and {@link #addFlags}. See {@link #setFlags} for a list
594 * of all possible flags.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700595 */
Dianne Hackbornee0511d2009-12-21 18:08:13 -0800596public class Intent implements Parcelable, Cloneable {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700597 // ---------------------------------------------------------------------
598 // ---------------------------------------------------------------------
599 // Standard intent activity actions (see action variable).
600
601 /**
602 * Activity Action: Start as a main entry point, does not expect to
603 * receive data.
604 * <p>Input: nothing
605 * <p>Output: nothing
606 */
607 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
608 public static final String ACTION_MAIN = "android.intent.action.MAIN";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800609
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700610 /**
611 * Activity Action: Display the data to the user. This is the most common
612 * action performed on data -- it is the generic action you can use on
613 * a piece of data to get the most reasonable thing to occur. For example,
614 * when used on a contacts entry it will view the entry; when used on a
615 * mailto: URI it will bring up a compose window filled with the information
616 * supplied by the URI; when used with a tel: URI it will invoke the
617 * dialer.
618 * <p>Input: {@link #getData} is URI from which to retrieve data.
619 * <p>Output: nothing.
620 */
621 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
622 public static final String ACTION_VIEW = "android.intent.action.VIEW";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800623
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700624 /**
625 * A synonym for {@link #ACTION_VIEW}, the "standard" action that is
626 * performed on a piece of data.
627 */
628 public static final String ACTION_DEFAULT = ACTION_VIEW;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800629
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700630 /**
631 * Used to indicate that some piece of data should be attached to some other
632 * place. For example, image data could be attached to a contact. It is up
633 * to the recipient to decide where the data should be attached; the intent
634 * does not specify the ultimate destination.
635 * <p>Input: {@link #getData} is URI of data to be attached.
636 * <p>Output: nothing.
637 */
638 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
639 public static final String ACTION_ATTACH_DATA = "android.intent.action.ATTACH_DATA";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800640
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700641 /**
642 * Activity Action: Provide explicit editable access to the given data.
643 * <p>Input: {@link #getData} is URI of data to be edited.
644 * <p>Output: nothing.
645 */
646 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
647 public static final String ACTION_EDIT = "android.intent.action.EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800648
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700649 /**
650 * Activity Action: Pick an existing item, or insert a new item, and then edit it.
651 * <p>Input: {@link #getType} is the desired MIME type of the item to create or edit.
652 * The extras can contain type specific data to pass through to the editing/creating
653 * activity.
654 * <p>Output: The URI of the item that was picked. This must be a content:
655 * URI so that any receiver can access it.
656 */
657 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
658 public static final String ACTION_INSERT_OR_EDIT = "android.intent.action.INSERT_OR_EDIT";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800659
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700660 /**
661 * Activity Action: Pick an item from the data, returning what was selected.
662 * <p>Input: {@link #getData} is URI containing a directory of data
663 * (vnd.android.cursor.dir/*) from which to pick an item.
664 * <p>Output: The URI of the item that was picked.
665 */
666 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
667 public static final String ACTION_PICK = "android.intent.action.PICK";
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800668
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700669 /**
670 * Activity Action: Creates a shortcut.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800671 * <p>Input: Nothing.</p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700672 * <p>Output: An Intent representing the shortcut. The intent must contain three
673 * extras: SHORTCUT_INTENT (value: Intent), SHORTCUT_NAME (value: String),
674 * and SHORTCUT_ICON (value: Bitmap) or SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800675 * (value: ShortcutIconResource).</p>
676 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700677 * @see #EXTRA_SHORTCUT_INTENT
678 * @see #EXTRA_SHORTCUT_NAME
679 * @see #EXTRA_SHORTCUT_ICON
680 * @see #EXTRA_SHORTCUT_ICON_RESOURCE
681 * @see android.content.Intent.ShortcutIconResource
682 */
683 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
684 public static final String ACTION_CREATE_SHORTCUT = "android.intent.action.CREATE_SHORTCUT";
685
686 /**
687 * The name of the extra used to define the Intent of a shortcut.
688 *
689 * @see #ACTION_CREATE_SHORTCUT
690 */
691 public static final String EXTRA_SHORTCUT_INTENT = "android.intent.extra.shortcut.INTENT";
692 /**
693 * The name of the extra used to define the name of a shortcut.
694 *
695 * @see #ACTION_CREATE_SHORTCUT
696 */
697 public static final String EXTRA_SHORTCUT_NAME = "android.intent.extra.shortcut.NAME";
698 /**
699 * The name of the extra used to define the icon, as a Bitmap, of a shortcut.
700 *
701 * @see #ACTION_CREATE_SHORTCUT
702 */
703 public static final String EXTRA_SHORTCUT_ICON = "android.intent.extra.shortcut.ICON";
704 /**
705 * The name of the extra used to define the icon, as a ShortcutIconResource, of a shortcut.
706 *
707 * @see #ACTION_CREATE_SHORTCUT
708 * @see android.content.Intent.ShortcutIconResource
709 */
710 public static final String EXTRA_SHORTCUT_ICON_RESOURCE =
711 "android.intent.extra.shortcut.ICON_RESOURCE";
712
713 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800714 * Represents a shortcut/live folder icon resource.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700715 *
716 * @see Intent#ACTION_CREATE_SHORTCUT
717 * @see Intent#EXTRA_SHORTCUT_ICON_RESOURCE
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -0800718 * @see android.provider.LiveFolders#ACTION_CREATE_LIVE_FOLDER
719 * @see android.provider.LiveFolders#EXTRA_LIVE_FOLDER_ICON
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700720 */
721 public static class ShortcutIconResource implements Parcelable {
722 /**
723 * The package name of the application containing the icon.
724 */
725 public String packageName;
726
727 /**
728 * The resource name of the icon, including package, name and type.
729 */
730 public String resourceName;
731
732 /**
733 * Creates a new ShortcutIconResource for the specified context and resource
734 * identifier.
735 *
736 * @param context The context of the application.
737 * @param resourceId The resource idenfitier for the icon.
738 * @return A new ShortcutIconResource with the specified's context package name
739 * and icon resource idenfitier.
740 */
741 public static ShortcutIconResource fromContext(Context context, int resourceId) {
742 ShortcutIconResource icon = new ShortcutIconResource();
743 icon.packageName = context.getPackageName();
744 icon.resourceName = context.getResources().getResourceName(resourceId);
745 return icon;
746 }
747
748 /**
749 * Used to read a ShortcutIconResource from a Parcel.
750 */
751 public static final Parcelable.Creator<ShortcutIconResource> CREATOR =
752 new Parcelable.Creator<ShortcutIconResource>() {
753
754 public ShortcutIconResource createFromParcel(Parcel source) {
755 ShortcutIconResource icon = new ShortcutIconResource();
756 icon.packageName = source.readString();
757 icon.resourceName = source.readString();
758 return icon;
759 }
760
761 public ShortcutIconResource[] newArray(int size) {
762 return new ShortcutIconResource[size];
763 }
764 };
765
766 /**
767 * No special parcel contents.
768 */
769 public int describeContents() {
770 return 0;
771 }
772
773 public void writeToParcel(Parcel dest, int flags) {
774 dest.writeString(packageName);
775 dest.writeString(resourceName);
776 }
777
778 @Override
779 public String toString() {
780 return resourceName;
781 }
782 }
783
784 /**
785 * Activity Action: Display an activity chooser, allowing the user to pick
786 * what they want to before proceeding. This can be used as an alternative
787 * to the standard activity picker that is displayed by the system when
788 * you try to start an activity with multiple possible matches, with these
789 * differences in behavior:
790 * <ul>
791 * <li>You can specify the title that will appear in the activity chooser.
792 * <li>The user does not have the option to make one of the matching
793 * activities a preferred activity, and all possible activities will
794 * always be shown even if one of them is currently marked as the
795 * preferred activity.
796 * </ul>
797 * <p>
798 * This action should be used when the user will naturally expect to
799 * select an activity in order to proceed. An example if when not to use
800 * it is when the user clicks on a "mailto:" link. They would naturally
801 * expect to go directly to their mail app, so startActivity() should be
802 * called directly: it will
803 * either launch the current preferred app, or put up a dialog allowing the
804 * user to pick an app to use and optionally marking that as preferred.
805 * <p>
806 * In contrast, if the user is selecting a menu item to send a picture
807 * they are viewing to someone else, there are many different things they
808 * may want to do at this point: send it through e-mail, upload it to a
809 * web service, etc. In this case the CHOOSER action should be used, to
810 * always present to the user a list of the things they can do, with a
811 * nice title given by the caller such as "Send this photo with:".
812 * <p>
Dianne Hackborne302a162012-05-15 14:58:32 -0700813 * If you need to grant URI permissions through a chooser, you must specify
814 * the permissions to be granted on the ACTION_CHOOSER Intent
815 * <em>in addition</em> to the EXTRA_INTENT inside. This means using
816 * {@link #setClipData} to specify the URIs to be granted as well as
817 * {@link #FLAG_GRANT_READ_URI_PERMISSION} and/or
818 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION} as appropriate.
819 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700820 * As a convenience, an Intent of this form can be created with the
821 * {@link #createChooser} function.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700822 * <p>
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700823 * Input: No data should be specified. get*Extra must have
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700824 * a {@link #EXTRA_INTENT} field containing the Intent being executed,
825 * and can optionally have a {@link #EXTRA_TITLE} field containing the
826 * title text to display in the chooser.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700827 * <p>
828 * Output: Depends on the protocol of {@link #EXTRA_INTENT}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700829 */
830 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
831 public static final String ACTION_CHOOSER = "android.intent.action.CHOOSER";
832
833 /**
834 * Convenience function for creating a {@link #ACTION_CHOOSER} Intent.
835 *
Dianne Hackborne302a162012-05-15 14:58:32 -0700836 * <p>Builds a new {@link #ACTION_CHOOSER} Intent that wraps the given
837 * target intent, also optionally supplying a title. If the target
838 * intent has specified {@link #FLAG_GRANT_READ_URI_PERMISSION} or
839 * {@link #FLAG_GRANT_WRITE_URI_PERMISSION}, then these flags will also be
840 * set in the returned chooser intent, with its ClipData set appropriately:
841 * either a direct reflection of {@link #getClipData()} if that is non-null,
842 * or a new ClipData build from {@link #getData()}.
843 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700844 * @param target The Intent that the user will be selecting an activity
845 * to perform.
846 * @param title Optional title that will be displayed in the chooser.
847 * @return Return a new Intent object that you can hand to
848 * {@link Context#startActivity(Intent) Context.startActivity()} and
849 * related methods.
850 */
851 public static Intent createChooser(Intent target, CharSequence title) {
852 Intent intent = new Intent(ACTION_CHOOSER);
853 intent.putExtra(EXTRA_INTENT, target);
854 if (title != null) {
855 intent.putExtra(EXTRA_TITLE, title);
856 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700857
858 // Migrate any clip data and flags from target.
Dianne Hackborne302a162012-05-15 14:58:32 -0700859 int permFlags = target.getFlags()
860 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION);
861 if (permFlags != 0) {
862 ClipData targetClipData = target.getClipData();
863 if (targetClipData == null && target.getData() != null) {
864 ClipData.Item item = new ClipData.Item(target.getData());
865 String[] mimeTypes;
866 if (target.getType() != null) {
867 mimeTypes = new String[] { target.getType() };
868 } else {
869 mimeTypes = new String[] { };
870 }
871 targetClipData = new ClipData(null, mimeTypes, item);
872 }
873 if (targetClipData != null) {
874 intent.setClipData(targetClipData);
875 intent.addFlags(permFlags);
876 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700877 }
Dianne Hackborne302a162012-05-15 14:58:32 -0700878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700879 return intent;
880 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -0700881
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700882 /**
883 * Activity Action: Allow the user to select a particular kind of data and
884 * return it. This is different than {@link #ACTION_PICK} in that here we
885 * just say what kind of data is desired, not a URI of existing data from
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800886 * which the user can pick. An ACTION_GET_CONTENT could allow the user to
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700887 * 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>
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800920 * If the caller can handle multiple returned items (the user performing
921 * multiple selection), then it can specify {@link #EXTRA_ALLOW_MULTIPLE}
922 * to indicate this.
923 * <p>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700924 * Input: {@link #getType} is the desired MIME type to retrieve. Note
925 * that no URI is supplied in the intent, as there are no constraints on
926 * where the returned data originally comes from. You may also include the
927 * {@link #CATEGORY_OPENABLE} if you can only accept data that can be
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -0800928 * opened as a stream. You may use {@link #EXTRA_LOCAL_ONLY} to limit content
Dianne Hackbornfdb3f092013-01-28 15:10:48 -0800929 * selection to local data. You may use {@link #EXTRA_ALLOW_MULTIPLE} to
930 * allow the user to select multiple items.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -0700931 * <p>
932 * Output: The URI of the item that was picked. This must be a content:
933 * URI so that any receiver can access it.
934 */
935 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
936 public static final String ACTION_GET_CONTENT = "android.intent.action.GET_CONTENT";
937 /**
938 * Activity Action: Dial a number as specified by the data. This shows a
939 * UI with the number being dialed, allowing the user to explicitly
940 * initiate the call.
941 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
942 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
943 * number.
944 * <p>Output: nothing.
945 */
946 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
947 public static final String ACTION_DIAL = "android.intent.action.DIAL";
948 /**
949 * Activity Action: Perform a call to someone specified by the data.
950 * <p>Input: If nothing, an empty dialer is started; else {@link #getData}
951 * is URI of a phone number to be dialed or a tel: URI of an explicit phone
952 * number.
953 * <p>Output: nothing.
954 *
955 * <p>Note: there will be restrictions on which applications can initiate a
956 * call; most applications should use the {@link #ACTION_DIAL}.
957 * <p>Note: this Intent <strong>cannot</strong> be used to call emergency
958 * numbers. Applications can <strong>dial</strong> emergency numbers using
959 * {@link #ACTION_DIAL}, however.
960 */
961 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
962 public static final String ACTION_CALL = "android.intent.action.CALL";
963 /**
964 * Activity Action: Perform a call to an emergency number specified by the
965 * data.
966 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
967 * tel: URI of an explicit phone number.
968 * <p>Output: nothing.
969 * @hide
970 */
971 public static final String ACTION_CALL_EMERGENCY = "android.intent.action.CALL_EMERGENCY";
972 /**
973 * Activity action: Perform a call to any number (emergency or not)
974 * specified by the data.
975 * <p>Input: {@link #getData} is URI of a phone number to be dialed or a
976 * tel: URI of an explicit phone number.
977 * <p>Output: nothing.
978 * @hide
979 */
980 public static final String ACTION_CALL_PRIVILEGED = "android.intent.action.CALL_PRIVILEGED";
981 /**
982 * Activity Action: Send a message to someone specified by the data.
983 * <p>Input: {@link #getData} is URI describing the target.
984 * <p>Output: nothing.
985 */
986 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
987 public static final String ACTION_SENDTO = "android.intent.action.SENDTO";
988 /**
989 * Activity Action: Deliver some data to someone else. Who the data is
990 * being delivered to is not specified; it is up to the receiver of this
991 * action to ask the user where the data should be sent.
992 * <p>
993 * When launching a SEND intent, you should usually wrap it in a chooser
994 * (through {@link #createChooser}), which will give the proper interface
995 * for the user to pick how to send your data and allow you to specify
996 * a prompt indicating what they are doing.
997 * <p>
998 * Input: {@link #getType} is the MIME type of the data being sent.
999 * get*Extra can have either a {@link #EXTRA_TEXT}
1000 * or {@link #EXTRA_STREAM} field, containing the data to be sent. If
1001 * using EXTRA_TEXT, the MIME type should be "text/plain"; otherwise it
1002 * should be the MIME type of the data in EXTRA_STREAM. Use {@literal *}/*
1003 * if the MIME type is unknown (this will only allow senders that can
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001004 * handle generic data streams). If using {@link #EXTRA_TEXT}, you can
1005 * also optionally supply {@link #EXTRA_HTML_TEXT} for clients to retrieve
1006 * your text with HTML formatting.
1007 * <p>
1008 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1009 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1010 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1011 * content: URIs and other advanced features of {@link ClipData}. If
1012 * using this approach, you still must supply the same data through the
1013 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1014 * for compatibility with old applications. If you don't set a ClipData,
1015 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001016 * <p>
1017 * Optional standard extras, which may be interpreted by some recipients as
1018 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1019 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1020 * <p>
1021 * Output: nothing.
1022 */
1023 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1024 public static final String ACTION_SEND = "android.intent.action.SEND";
1025 /**
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001026 * Activity Action: Deliver multiple data to someone else.
1027 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001028 * Like {@link #ACTION_SEND}, except the data is multiple.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001029 * <p>
1030 * Input: {@link #getType} is the MIME type of the data being sent.
1031 * get*ArrayListExtra can have either a {@link #EXTRA_TEXT} or {@link
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001032 * #EXTRA_STREAM} field, containing the data to be sent. If using
1033 * {@link #EXTRA_TEXT}, you can also optionally supply {@link #EXTRA_HTML_TEXT}
1034 * for clients to retrieve your text with HTML formatting.
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001035 * <p>
Chih-Chung Chang5962d272009-09-04 14:36:01 +08001036 * Multiple types are supported, and receivers should handle mixed types
1037 * whenever possible. The right way for the receiver to check them is to
1038 * use the content resolver on each URI. The intent sender should try to
1039 * put the most concrete mime type in the intent type, but it can fall
1040 * back to {@literal <type>/*} or {@literal *}/* as needed.
1041 * <p>
1042 * e.g. if you are sending image/jpg and image/jpg, the intent's type can
1043 * be image/jpg, but if you are sending image/jpg and image/png, then the
1044 * intent's type should be image/*.
1045 * <p>
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07001046 * As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, the data
1047 * being sent can be supplied through {@link #setClipData(ClipData)}. This
1048 * allows you to use {@link #FLAG_GRANT_READ_URI_PERMISSION} when sharing
1049 * content: URIs and other advanced features of {@link ClipData}. If
1050 * using this approach, you still must supply the same data through the
1051 * {@link #EXTRA_TEXT} or {@link #EXTRA_STREAM} fields described below
1052 * for compatibility with old applications. If you don't set a ClipData,
1053 * it will be copied there for you when calling {@link Context#startActivity(Intent)}.
1054 * <p>
Wu-cheng Li649f99e2009-06-17 14:29:57 +08001055 * Optional standard extras, which may be interpreted by some recipients as
1056 * appropriate, are: {@link #EXTRA_EMAIL}, {@link #EXTRA_CC},
1057 * {@link #EXTRA_BCC}, {@link #EXTRA_SUBJECT}.
1058 * <p>
1059 * Output: nothing.
1060 */
1061 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1062 public static final String ACTION_SEND_MULTIPLE = "android.intent.action.SEND_MULTIPLE";
1063 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001064 * Activity Action: Handle an incoming phone call.
1065 * <p>Input: nothing.
1066 * <p>Output: nothing.
1067 */
1068 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1069 public static final String ACTION_ANSWER = "android.intent.action.ANSWER";
1070 /**
1071 * Activity Action: Insert an empty item into the given container.
1072 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1073 * in which to place the data.
1074 * <p>Output: URI of the new data that was created.
1075 */
1076 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1077 public static final String ACTION_INSERT = "android.intent.action.INSERT";
1078 /**
Dianne Hackborn23fdaf62010-08-06 12:16:55 -07001079 * Activity Action: Create a new item in the given container, initializing it
1080 * from the current contents of the clipboard.
1081 * <p>Input: {@link #getData} is URI of the directory (vnd.android.cursor.dir/*)
1082 * in which to place the data.
1083 * <p>Output: URI of the new data that was created.
1084 */
1085 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1086 public static final String ACTION_PASTE = "android.intent.action.PASTE";
1087 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001088 * Activity Action: Delete the given data from its container.
1089 * <p>Input: {@link #getData} is URI of data to be deleted.
1090 * <p>Output: nothing.
1091 */
1092 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1093 public static final String ACTION_DELETE = "android.intent.action.DELETE";
1094 /**
1095 * Activity Action: Run the data, whatever that means.
1096 * <p>Input: ? (Note: this is currently specific to the test harness.)
1097 * <p>Output: nothing.
1098 */
1099 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1100 public static final String ACTION_RUN = "android.intent.action.RUN";
1101 /**
1102 * Activity Action: Perform a data synchronization.
1103 * <p>Input: ?
1104 * <p>Output: ?
1105 */
1106 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1107 public static final String ACTION_SYNC = "android.intent.action.SYNC";
1108 /**
1109 * Activity Action: Pick an activity given an intent, returning the class
1110 * selected.
1111 * <p>Input: get*Extra field {@link #EXTRA_INTENT} is an Intent
1112 * used with {@link PackageManager#queryIntentActivities} to determine the
1113 * set of activities from which to pick.
1114 * <p>Output: Class name of the activity that was selected.
1115 */
1116 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1117 public static final String ACTION_PICK_ACTIVITY = "android.intent.action.PICK_ACTIVITY";
1118 /**
1119 * Activity Action: Perform a search.
1120 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1121 * is the text to search for. If empty, simply
1122 * enter your search results Activity with the search UI activated.
1123 * <p>Output: nothing.
1124 */
1125 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1126 public static final String ACTION_SEARCH = "android.intent.action.SEARCH";
1127 /**
Jim Miller7e4ad352009-03-25 18:16:41 -07001128 * Activity Action: Start the platform-defined tutorial
1129 * <p>Input: {@link android.app.SearchManager#QUERY getStringExtra(SearchManager.QUERY)}
1130 * is the text to search for. If empty, simply
1131 * enter your search results Activity with the search UI activated.
1132 * <p>Output: nothing.
1133 */
1134 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1135 public static final String ACTION_SYSTEM_TUTORIAL = "android.intent.action.SYSTEM_TUTORIAL";
1136 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001137 * Activity Action: Perform a web search.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08001138 * <p>
1139 * Input: {@link android.app.SearchManager#QUERY
1140 * getStringExtra(SearchManager.QUERY)} is the text to search for. If it is
1141 * a url starts with http or https, the site will be opened. If it is plain
1142 * text, Google search will be applied.
1143 * <p>
1144 * Output: nothing.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001145 */
1146 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1147 public static final String ACTION_WEB_SEARCH = "android.intent.action.WEB_SEARCH";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001148
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001149 /**
Jim Miller07994402012-05-02 14:22:27 -07001150 * Activity Action: Perform assist action.
1151 * <p>
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001152 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1153 * additional optional contextual information about where the user was when they requested
1154 * the assist.
Jim Miller07994402012-05-02 14:22:27 -07001155 * Output: nothing.
1156 */
1157 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1158 public static final String ACTION_ASSIST = "android.intent.action.ASSIST";
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001159
1160 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001161 * Activity Action: Perform voice assist action.
1162 * <p>
1163 * Input: {@link #EXTRA_ASSIST_PACKAGE} and {@link #EXTRA_ASSIST_CONTEXT} can provide
1164 * additional optional contextual information about where the user was when they requested
1165 * the voice assist.
1166 * Output: nothing.
1167 */
1168 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1169 public static final String ACTION_VOICE_ASSIST = "android.intent.action.VOICE_ASSIST";
1170
1171 /**
1172 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1173 * containing the name of the current foreground application package at the time
1174 * the assist was invoked.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001175 */
1176 public static final String EXTRA_ASSIST_PACKAGE
1177 = "android.intent.extra.ASSIST_PACKAGE";
1178
1179 /**
Bjorn Bringertbc086862013-03-01 12:59:24 +00001180 * An optional field on {@link #ACTION_ASSIST} and {@link #ACTION_VOICE_ASSIST}
1181 * containing additional contextual information supplied by the current
1182 * foreground app at the time of the assist request. This is a {@link Bundle} of
1183 * additional data.
Dianne Hackbornf9c5e0f2013-01-23 14:39:13 -08001184 */
1185 public static final String EXTRA_ASSIST_CONTEXT
1186 = "android.intent.extra.ASSIST_CONTEXT";
1187
Jim Miller07994402012-05-02 14:22:27 -07001188 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001189 * Activity Action: List all available applications
1190 * <p>Input: Nothing.
1191 * <p>Output: nothing.
1192 */
1193 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1194 public static final String ACTION_ALL_APPS = "android.intent.action.ALL_APPS";
1195 /**
1196 * Activity Action: Show settings for choosing wallpaper
1197 * <p>Input: Nothing.
1198 * <p>Output: Nothing.
1199 */
1200 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1201 public static final String ACTION_SET_WALLPAPER = "android.intent.action.SET_WALLPAPER";
1202
1203 /**
1204 * Activity Action: Show activity for reporting a bug.
1205 * <p>Input: Nothing.
1206 * <p>Output: Nothing.
1207 */
1208 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1209 public static final String ACTION_BUG_REPORT = "android.intent.action.BUG_REPORT";
1210
1211 /**
1212 * Activity Action: Main entry point for factory tests. Only used when
1213 * the device is booting in factory test node. The implementing package
1214 * must be installed in the system image.
1215 * <p>Input: nothing
1216 * <p>Output: nothing
1217 */
1218 public static final String ACTION_FACTORY_TEST = "android.intent.action.FACTORY_TEST";
1219
1220 /**
1221 * Activity Action: The user pressed the "call" button to go to the dialer
1222 * or other appropriate UI for placing a call.
1223 * <p>Input: Nothing.
1224 * <p>Output: Nothing.
1225 */
1226 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1227 public static final String ACTION_CALL_BUTTON = "android.intent.action.CALL_BUTTON";
1228
1229 /**
1230 * Activity Action: Start Voice Command.
1231 * <p>Input: Nothing.
1232 * <p>Output: Nothing.
1233 */
1234 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1235 public static final String ACTION_VOICE_COMMAND = "android.intent.action.VOICE_COMMAND";
The Android Open Source Projectba87e3e2009-03-13 13:04:22 -07001236
1237 /**
1238 * Activity Action: Start action associated with long pressing on the
1239 * search key.
1240 * <p>Input: Nothing.
1241 * <p>Output: Nothing.
1242 */
1243 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1244 public static final String ACTION_SEARCH_LONG_PRESS = "android.intent.action.SEARCH_LONG_PRESS";
The Android Open Source Project10592532009-03-18 17:39:46 -07001245
Jacek Surazski86b6c532009-05-13 14:38:28 +02001246 /**
1247 * Activity Action: The user pressed the "Report" button in the crash/ANR dialog.
1248 * This intent is delivered to the package which installed the application, usually
Dirk Dougherty4d7bc6552012-01-27 17:56:49 -08001249 * Google Play.
Jacek Surazski86b6c532009-05-13 14:38:28 +02001250 * <p>Input: No data is specified. The bug report is passed in using
1251 * an {@link #EXTRA_BUG_REPORT} field.
1252 * <p>Output: Nothing.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001253 *
1254 * @see #EXTRA_BUG_REPORT
Jacek Surazski86b6c532009-05-13 14:38:28 +02001255 */
1256 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1257 public static final String ACTION_APP_ERROR = "android.intent.action.APP_ERROR";
Dianne Hackborn3d74bb42009-06-19 10:35:21 -07001258
1259 /**
1260 * Activity Action: Show power usage information to the user.
1261 * <p>Input: Nothing.
1262 * <p>Output: Nothing.
1263 */
1264 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1265 public static final String ACTION_POWER_USAGE_SUMMARY = "android.intent.action.POWER_USAGE_SUMMARY";
Tom Taylord4a47292009-12-21 13:59:18 -08001266
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001267 /**
1268 * Activity Action: Setup wizard to launch after a platform update. This
1269 * activity should have a string meta-data field associated with it,
1270 * {@link #METADATA_SETUP_VERSION}, which defines the current version of
1271 * the platform for setup. The activity will be launched only if
1272 * {@link android.provider.Settings.Secure#LAST_SETUP_SHOWN} is not the
1273 * same value.
1274 * <p>Input: Nothing.
1275 * <p>Output: Nothing.
1276 * @hide
1277 */
1278 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1279 public static final String ACTION_UPGRADE_SETUP = "android.intent.action.UPGRADE_SETUP";
Tom Taylord4a47292009-12-21 13:59:18 -08001280
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001281 /**
Jeff Sharkey7f868272011-06-05 16:05:02 -07001282 * Activity Action: Show settings for managing network data usage of a
1283 * specific application. Applications should define an activity that offers
1284 * options to control data usage.
1285 */
1286 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1287 public static final String ACTION_MANAGE_NETWORK_USAGE =
1288 "android.intent.action.MANAGE_NETWORK_USAGE";
1289
1290 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001291 * Activity Action: Launch application installer.
1292 * <p>
1293 * Input: The data must be a content: or file: URI at which the application
Dianne Hackborneba784ff2012-09-19 12:42:37 -07001294 * can be retrieved. As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN_MR1},
1295 * you can also use "package:<package-name>" to install an application for the
1296 * current user that is already installed for another user. You can optionally supply
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001297 * {@link #EXTRA_INSTALLER_PACKAGE_NAME}, {@link #EXTRA_NOT_UNKNOWN_SOURCE},
1298 * {@link #EXTRA_ALLOW_REPLACE}, and {@link #EXTRA_RETURN_RESULT}.
1299 * <p>
1300 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1301 * succeeded.
1302 *
1303 * @see #EXTRA_INSTALLER_PACKAGE_NAME
1304 * @see #EXTRA_NOT_UNKNOWN_SOURCE
1305 * @see #EXTRA_RETURN_RESULT
1306 */
1307 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1308 public static final String ACTION_INSTALL_PACKAGE = "android.intent.action.INSTALL_PACKAGE";
1309
1310 /**
1311 * Used as a string extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1312 * package. Specifies the installer package name; this package will receive the
1313 * {@link #ACTION_APP_ERROR} intent.
1314 */
1315 public static final String EXTRA_INSTALLER_PACKAGE_NAME
1316 = "android.intent.extra.INSTALLER_PACKAGE_NAME";
1317
1318 /**
1319 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1320 * package. Specifies that the application being installed should not be
1321 * treated as coming from an unknown source, but as coming from the app
1322 * invoking the Intent. For this to work you must start the installer with
1323 * startActivityForResult().
1324 */
1325 public static final String EXTRA_NOT_UNKNOWN_SOURCE
1326 = "android.intent.extra.NOT_UNKNOWN_SOURCE";
1327
1328 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001329 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1330 * {@link #ACTION_VIEW} to indicate the URI from which the local APK in the Intent
rich cannings368ed012012-06-07 15:37:57 -07001331 * data field originated from.
1332 */
rich cannings706e8ba2012-08-20 13:20:14 -07001333 public static final String EXTRA_ORIGINATING_URI
1334 = "android.intent.extra.ORIGINATING_URI";
rich cannings368ed012012-06-07 15:37:57 -07001335
1336 /**
rich cannings706e8ba2012-08-20 13:20:14 -07001337 * Used as a URI extra field with {@link #ACTION_INSTALL_PACKAGE} and
1338 * {@link #ACTION_VIEW} to indicate the HTTP referrer URI associated with the Intent
1339 * data field or {@link #EXTRA_ORIGINATING_URI}.
rich cannings368ed012012-06-07 15:37:57 -07001340 */
1341 public static final String EXTRA_REFERRER
1342 = "android.intent.extra.REFERRER";
1343
1344 /**
Ben Gruver37d83a32012-09-27 13:02:06 -07001345 * Used as an int extra field with {@link #ACTION_INSTALL_PACKAGE} and
1346 * {@link} #ACTION_VIEW} to indicate the uid of the package that initiated the install
1347 * @hide
1348 */
1349 public static final String EXTRA_ORIGINATING_UID
1350 = "android.intent.extra.ORIGINATING_UID";
1351
1352 /**
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001353 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} to install a
1354 * package. Tells the installer UI to skip the confirmation with the user
1355 * if the .apk is replacing an existing one.
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001356 * @deprecated As of {@link android.os.Build.VERSION_CODES#JELLY_BEAN}, Android
1357 * will no longer show an interstitial message about updating existing
1358 * applications so this is no longer needed.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001359 */
Dianne Hackborn0e128bb2012-05-01 14:40:15 -07001360 @Deprecated
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001361 public static final String EXTRA_ALLOW_REPLACE
1362 = "android.intent.extra.ALLOW_REPLACE";
1363
1364 /**
1365 * Used as a boolean extra field with {@link #ACTION_INSTALL_PACKAGE} or
1366 * {@link #ACTION_UNINSTALL_PACKAGE}. Specifies that the installer UI should
1367 * return to the application the result code of the install/uninstall. The returned result
1368 * code will be {@link android.app.Activity#RESULT_OK} on success or
1369 * {@link android.app.Activity#RESULT_FIRST_USER} on failure.
1370 */
1371 public static final String EXTRA_RETURN_RESULT
1372 = "android.intent.extra.RETURN_RESULT";
1373
1374 /**
1375 * Package manager install result code. @hide because result codes are not
1376 * yet ready to be exposed.
1377 */
1378 public static final String EXTRA_INSTALL_RESULT
1379 = "android.intent.extra.INSTALL_RESULT";
1380
1381 /**
1382 * Activity Action: Launch application uninstaller.
1383 * <p>
1384 * Input: The data must be a package: URI whose scheme specific part is
1385 * the package name of the current installed package to be uninstalled.
1386 * You can optionally supply {@link #EXTRA_RETURN_RESULT}.
1387 * <p>
1388 * Output: If {@link #EXTRA_RETURN_RESULT}, returns whether the install
1389 * succeeded.
1390 */
1391 @SdkConstant(SdkConstantType.ACTIVITY_INTENT_ACTION)
1392 public static final String ACTION_UNINSTALL_PACKAGE = "android.intent.action.UNINSTALL_PACKAGE";
1393
1394 /**
Dianne Hackborn6d235d82012-09-16 18:25:40 -07001395 * Specify whether the package should be uninstalled for all users.
1396 * @hide because these should not be part of normal application flow.
1397 */
1398 public static final String EXTRA_UNINSTALL_ALL_USERS
1399 = "android.intent.extra.UNINSTALL_ALL_USERS";
1400
1401 /**
Dianne Hackbornd7cd29d2009-07-01 11:22:45 -07001402 * A string associated with a {@link #ACTION_UPGRADE_SETUP} activity
1403 * describing the last run version of the platform that was setup.
1404 * @hide
1405 */
1406 public static final String METADATA_SETUP_VERSION = "android.SETUP_VERSION";
1407
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001408 // ---------------------------------------------------------------------
1409 // ---------------------------------------------------------------------
1410 // Standard intent broadcast actions (see action variable).
1411
1412 /**
1413 * Broadcast Action: Sent after the screen turns off.
Tom Taylord4a47292009-12-21 13:59:18 -08001414 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001415 * <p class="note">This is a protected intent that can only be sent
1416 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001417 */
1418 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1419 public static final String ACTION_SCREEN_OFF = "android.intent.action.SCREEN_OFF";
1420 /**
1421 * Broadcast Action: Sent after the screen turns on.
Tom Taylord4a47292009-12-21 13:59:18 -08001422 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001423 * <p class="note">This is a protected intent that can only be sent
1424 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001425 */
1426 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1427 public static final String ACTION_SCREEN_ON = "android.intent.action.SCREEN_ON";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001428
1429 /**
Dianne Hackbornbe87e2f2012-09-28 16:31:34 -07001430 * Broadcast Action: Sent after the system stops dreaming.
1431 *
1432 * <p class="note">This is a protected intent that can only be sent by the system.
1433 * It is only sent to registered receivers.</p>
1434 */
1435 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1436 public static final String ACTION_DREAMING_STOPPED = "android.intent.action.DREAMING_STOPPED";
1437
1438 /**
1439 * Broadcast Action: Sent after the system starts dreaming.
1440 *
1441 * <p class="note">This is a protected intent that can only be sent by the system.
1442 * It is only sent to registered receivers.</p>
1443 */
1444 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1445 public static final String ACTION_DREAMING_STARTED = "android.intent.action.DREAMING_STARTED";
1446
1447 /**
The Android Open Source Project10592532009-03-18 17:39:46 -07001448 * 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 -07001449 * keyguard is gone).
Tom Taylord4a47292009-12-21 13:59:18 -08001450 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001451 * <p class="note">This is a protected intent that can only be sent
1452 * by the system.
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001453 */
1454 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08001455 public static final String ACTION_USER_PRESENT = "android.intent.action.USER_PRESENT";
The Android Open Source Projectb2a3dd82009-03-09 11:52:12 -07001456
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001457 /**
1458 * Broadcast Action: The current time has changed. Sent every
1459 * minute. You can <em>not</em> receive this through components declared
1460 * in manifests, only by exlicitly registering for it with
1461 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1462 * Context.registerReceiver()}.
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.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001466 */
1467 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1468 public static final String ACTION_TIME_TICK = "android.intent.action.TIME_TICK";
1469 /**
1470 * Broadcast Action: The time was set.
1471 */
1472 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1473 public static final String ACTION_TIME_CHANGED = "android.intent.action.TIME_SET";
1474 /**
1475 * Broadcast Action: The date has changed.
1476 */
1477 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1478 public static final String ACTION_DATE_CHANGED = "android.intent.action.DATE_CHANGED";
1479 /**
1480 * Broadcast Action: The timezone has changed. The intent will have the following extra values:</p>
1481 * <ul>
1482 * <li><em>time-zone</em> - The java.util.TimeZone.getID() value identifying the new time zone.</li>
1483 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001484 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001485 * <p class="note">This is a protected intent that can only be sent
1486 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001487 */
1488 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1489 public static final String ACTION_TIMEZONE_CHANGED = "android.intent.action.TIMEZONE_CHANGED";
1490 /**
Robert Greenwalt03595d02010-11-02 14:08:23 -07001491 * Clear DNS Cache Action: This is broadcast when networks have changed and old
1492 * DNS entries should be tossed.
1493 * @hide
1494 */
1495 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1496 public static final String ACTION_CLEAR_DNS_CACHE = "android.intent.action.CLEAR_DNS_CACHE";
1497 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001498 * Alarm Changed Action: This is broadcast when the AlarmClock
1499 * application's alarm is set or unset. It is used by the
1500 * AlarmClock application and the StatusBar service.
1501 * @hide
1502 */
1503 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1504 public static final String ACTION_ALARM_CHANGED = "android.intent.action.ALARM_CHANGED";
1505 /**
1506 * Sync State Changed Action: This is broadcast when the sync starts or stops or when one has
1507 * been failing for a long time. It is used by the SyncManager and the StatusBar service.
1508 * @hide
1509 */
1510 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1511 public static final String ACTION_SYNC_STATE_CHANGED
1512 = "android.intent.action.SYNC_STATE_CHANGED";
1513 /**
1514 * Broadcast Action: This is broadcast once, after the system has finished
1515 * booting. It can be used to perform application-specific initialization,
1516 * such as installing alarms. You must hold the
1517 * {@link android.Manifest.permission#RECEIVE_BOOT_COMPLETED} permission
1518 * in order to receive this broadcast.
Tom Taylord4a47292009-12-21 13:59:18 -08001519 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001520 * <p class="note">This is a protected intent that can only be sent
1521 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001522 */
1523 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1524 public static final String ACTION_BOOT_COMPLETED = "android.intent.action.BOOT_COMPLETED";
1525 /**
1526 * Broadcast Action: This is broadcast when a user action should request a
1527 * temporary system dialog to dismiss. Some examples of temporary system
1528 * dialogs are the notification window-shade and the recent tasks dialog.
1529 */
1530 public static final String ACTION_CLOSE_SYSTEM_DIALOGS = "android.intent.action.CLOSE_SYSTEM_DIALOGS";
1531 /**
1532 * Broadcast Action: Trigger the download and eventual installation
1533 * of a package.
1534 * <p>Input: {@link #getData} is the URI of the package file to download.
Tom Taylord4a47292009-12-21 13:59:18 -08001535 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001536 * <p class="note">This is a protected intent that can only be sent
1537 * by the system.
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001538 *
1539 * @deprecated This constant has never been used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001540 */
Dianne Hackborn271c2fe2011-08-09 19:35:13 -07001541 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001542 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1543 public static final String ACTION_PACKAGE_INSTALL = "android.intent.action.PACKAGE_INSTALL";
1544 /**
1545 * Broadcast Action: A new application package has been installed on the
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001546 * device. The data contains the name of the package. Note that the
1547 * newly installed package does <em>not</em> receive this broadcast.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001548 * <p>May include the following extras:
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001549 * <ul>
1550 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1551 * <li> {@link #EXTRA_REPLACING} is set to true if this is following
1552 * an {@link #ACTION_PACKAGE_REMOVED} broadcast for the same package.
1553 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001554 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001555 * <p class="note">This is a protected intent that can only be sent
1556 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001557 */
1558 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1559 public static final String ACTION_PACKAGE_ADDED = "android.intent.action.PACKAGE_ADDED";
1560 /**
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001561 * Broadcast Action: A new version of an application package has been
1562 * installed, replacing an existing version that was previously installed.
1563 * The data contains the name of the package.
Jeff Sharkeyd0c6ccb2012-09-14 16:26:37 -07001564 * <p>May include the following extras:
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001565 * <ul>
1566 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the new package.
1567 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001568 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001569 * <p class="note">This is a protected intent that can only be sent
1570 * by the system.
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001571 */
1572 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1573 public static final String ACTION_PACKAGE_REPLACED = "android.intent.action.PACKAGE_REPLACED";
1574 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001575 * Broadcast Action: A new version of your application has been installed
1576 * over an existing one. This is only sent to the application that was
1577 * replaced. It does not contain any additional data; to receive it, just
1578 * use an intent filter for this action.
1579 *
1580 * <p class="note">This is a protected intent that can only be sent
1581 * by the system.
1582 */
1583 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1584 public static final String ACTION_MY_PACKAGE_REPLACED = "android.intent.action.MY_PACKAGE_REPLACED";
1585 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001586 * Broadcast Action: An existing application package has been removed from
1587 * the device. The data contains the name of the package. The package
1588 * that is being installed does <em>not</em> receive this Intent.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001589 * <ul>
1590 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1591 * to the package.
1592 * <li> {@link #EXTRA_DATA_REMOVED} is set to true if the entire
1593 * application -- data and code -- is being removed.
1594 * <li> {@link #EXTRA_REPLACING} is set to true if this will be followed
1595 * by an {@link #ACTION_PACKAGE_ADDED} broadcast for the same package.
1596 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001597 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001598 * <p class="note">This is a protected intent that can only be sent
1599 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001600 */
1601 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1602 public static final String ACTION_PACKAGE_REMOVED = "android.intent.action.PACKAGE_REMOVED";
1603 /**
Dianne Hackbornf9abb402011-08-10 15:00:59 -07001604 * Broadcast Action: An existing application package has been completely
1605 * removed from the device. The data contains the name of the package.
1606 * This is like {@link #ACTION_PACKAGE_REMOVED}, but only set when
1607 * {@link #EXTRA_DATA_REMOVED} is true and
1608 * {@link #EXTRA_REPLACING} is false of that broadcast.
1609 *
1610 * <ul>
1611 * <li> {@link #EXTRA_UID} containing the integer uid previously assigned
1612 * to the package.
1613 * </ul>
1614 *
1615 * <p class="note">This is a protected intent that can only be sent
1616 * by the system.
1617 */
1618 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1619 public static final String ACTION_PACKAGE_FULLY_REMOVED
1620 = "android.intent.action.PACKAGE_FULLY_REMOVED";
1621 /**
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001622 * Broadcast Action: An existing application package has been changed (e.g.
1623 * a component has been enabled or disabled). The data contains the name of
1624 * the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001625 * <ul>
1626 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001627 * <li> {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST} containing the class name
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08001628 * of the changed components (or the package name itself).
Dianne Hackborn86a72da2009-11-11 20:12:41 -08001629 * <li> {@link #EXTRA_DONT_KILL_APP} containing boolean field to override the
1630 * default action of restarting the application.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001631 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001632 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001633 * <p class="note">This is a protected intent that can only be sent
1634 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001635 */
1636 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1637 public static final String ACTION_PACKAGE_CHANGED = "android.intent.action.PACKAGE_CHANGED";
1638 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08001639 * @hide
1640 * Broadcast Action: Ask system services if there is any reason to
1641 * restart the given package. The data contains the name of the
1642 * package.
1643 * <ul>
1644 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1645 * <li> {@link #EXTRA_PACKAGES} String array of all packages to check.
1646 * </ul>
1647 *
1648 * <p class="note">This is a protected intent that can only be sent
1649 * by the system.
1650 */
1651 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1652 public static final String ACTION_QUERY_PACKAGE_RESTART = "android.intent.action.QUERY_PACKAGE_RESTART";
1653 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001654 * Broadcast Action: The user has restarted a package, and all of its
1655 * processes have been killed. All runtime state
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001656 * associated with it (processes, alarms, notifications, etc) should
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001657 * be removed. Note that the restarted package does <em>not</em>
1658 * receive this broadcast.
1659 * The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001660 * <ul>
1661 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1662 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001663 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001664 * <p class="note">This is a protected intent that can only be sent
1665 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001666 */
1667 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1668 public static final String ACTION_PACKAGE_RESTARTED = "android.intent.action.PACKAGE_RESTARTED";
1669 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001670 * Broadcast Action: The user has cleared the data of a package. This should
1671 * be preceded by {@link #ACTION_PACKAGE_RESTARTED}, after which all of
The Android Open Source Projectc2ad2412009-03-19 23:08:54 -07001672 * its persistent data is erased and this broadcast sent.
1673 * Note that the cleared package does <em>not</em>
1674 * receive this broadcast. The data contains the name of the package.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001675 * <ul>
1676 * <li> {@link #EXTRA_UID} containing the integer uid assigned to the package.
1677 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08001678 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001679 * <p class="note">This is a protected intent that can only be sent
1680 * by the system.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08001681 */
1682 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1683 public static final String ACTION_PACKAGE_DATA_CLEARED = "android.intent.action.PACKAGE_DATA_CLEARED";
1684 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001685 * Broadcast Action: A user ID has been removed from the system. The user
1686 * ID number is stored in the extra data under {@link #EXTRA_UID}.
Tom Taylord4a47292009-12-21 13:59:18 -08001687 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001688 * <p class="note">This is a protected intent that can only be sent
1689 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001690 */
1691 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1692 public static final String ACTION_UID_REMOVED = "android.intent.action.UID_REMOVED";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001693
1694 /**
Dianne Hackborne7f97212011-02-24 14:40:20 -08001695 * Broadcast Action: Sent to the installer package of an application
1696 * when that application is first launched (that is the first time it
1697 * is moved out of the stopped state). The data contains the name of the package.
1698 *
1699 * <p class="note">This is a protected intent that can only be sent
1700 * by the system.
1701 */
1702 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1703 public static final String ACTION_PACKAGE_FIRST_LAUNCH = "android.intent.action.PACKAGE_FIRST_LAUNCH";
1704
1705 /**
Kenny Root5ab21572011-07-27 11:11:19 -07001706 * Broadcast Action: Sent to the system package verifier when a package
1707 * needs to be verified. The data contains the package URI.
1708 * <p class="note">
1709 * This is a protected intent that can only be sent by the system.
1710 * </p>
Kenny Root5ab21572011-07-27 11:11:19 -07001711 */
1712 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1713 public static final String ACTION_PACKAGE_NEEDS_VERIFICATION = "android.intent.action.PACKAGE_NEEDS_VERIFICATION";
1714
1715 /**
rich canningsd1b5cfc2012-08-29 14:49:51 -07001716 * Broadcast Action: Sent to the system package verifier when a package is
1717 * verified. The data contains the package URI.
1718 * <p class="note">
1719 * This is a protected intent that can only be sent by the system.
1720 */
1721 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1722 public static final String ACTION_PACKAGE_VERIFIED = "android.intent.action.PACKAGE_VERIFIED";
1723
1724 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001725 * Broadcast Action: Resources for a set of packages (which were
1726 * previously unavailable) are currently
1727 * available since the media on which they exist is available.
1728 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1729 * list of packages whose availability changed.
1730 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1731 * list of uids of packages whose availability changed.
1732 * Note that the
1733 * packages in this list do <em>not</em> receive this broadcast.
1734 * The specified set of packages are now available on the system.
1735 * <p>Includes the following extras:
1736 * <ul>
1737 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1738 * whose resources(were previously unavailable) are currently available.
1739 * {@link #EXTRA_CHANGED_UID_LIST} is the set of uids of the
1740 * packages whose resources(were previously unavailable)
1741 * are currently available.
1742 * </ul>
1743 *
1744 * <p class="note">This is a protected intent that can only be sent
1745 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001746 */
1747 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001748 public static final String ACTION_EXTERNAL_APPLICATIONS_AVAILABLE =
1749 "android.intent.action.EXTERNAL_APPLICATIONS_AVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001750
1751 /**
1752 * Broadcast Action: Resources for a set of packages are currently
1753 * unavailable since the media on which they exist is unavailable.
1754 * The extra data {@link #EXTRA_CHANGED_PACKAGE_LIST} contains a
1755 * list of packages whose availability changed.
1756 * The extra data {@link #EXTRA_CHANGED_UID_LIST} contains a
1757 * list of uids of packages whose availability changed.
1758 * The specified set of packages can no longer be
1759 * launched and are practically unavailable on the system.
1760 * <p>Inclues the following extras:
1761 * <ul>
1762 * <li> {@link #EXTRA_CHANGED_PACKAGE_LIST} is the set of packages
1763 * whose resources are no longer available.
1764 * {@link #EXTRA_CHANGED_UID_LIST} is the set of packages
1765 * whose resources are no longer available.
1766 * </ul>
1767 *
1768 * <p class="note">This is a protected intent that can only be sent
1769 * by the system.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001770 */
1771 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08001772 public static final String ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE =
Joe Onorato8a051a42010-03-04 15:54:50 -05001773 "android.intent.action.EXTERNAL_APPLICATIONS_UNAVAILABLE";
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08001774
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001775 /**
1776 * Broadcast Action: The current system wallpaper has changed. See
Scott Main8b2e0002009-09-29 18:17:31 -07001777 * {@link android.app.WallpaperManager} for retrieving the new wallpaper.
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001778 * This should <em>only</em> be used to determine when the wallpaper
1779 * has changed to show the new wallpaper to the user. You should certainly
1780 * never, in response to this, change the wallpaper or other attributes of
1781 * it such as the suggested size. That would be crazy, right? You'd cause
1782 * all kinds of loops, especially if other apps are doing similar things,
1783 * right? Of course. So please don't do this.
1784 *
1785 * @deprecated Modern applications should use
1786 * {@link android.view.WindowManager.LayoutParams#FLAG_SHOW_WALLPAPER
1787 * WindowManager.LayoutParams.FLAG_SHOW_WALLPAPER} to have the wallpaper
1788 * shown behind their UI, rather than watching for this broadcast and
1789 * rendering the wallpaper on their own.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001790 */
Dianne Hackbornc5bf7582012-04-25 19:12:07 -07001791 @Deprecated @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001792 public static final String ACTION_WALLPAPER_CHANGED = "android.intent.action.WALLPAPER_CHANGED";
1793 /**
1794 * Broadcast Action: The current device {@link android.content.res.Configuration}
1795 * (orientation, locale, etc) has changed. When such a change happens, the
1796 * UIs (view hierarchy) will need to be rebuilt based on this new
1797 * information; for the most part, applications don't need to worry about
1798 * this, because the system will take care of stopping and restarting the
1799 * application to make sure it sees the new changes. Some system code that
1800 * can not be restarted will need to watch for this action and handle it
1801 * appropriately.
Tom Taylord4a47292009-12-21 13:59:18 -08001802 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001803 * <p class="note">
1804 * You can <em>not</em> receive this through components declared
1805 * in manifests, only by explicitly registering for it with
1806 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
1807 * Context.registerReceiver()}.
Tom Taylord4a47292009-12-21 13:59:18 -08001808 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001809 * <p class="note">This is a protected intent that can only be sent
1810 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001811 *
1812 * @see android.content.res.Configuration
1813 */
1814 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1815 public static final String ACTION_CONFIGURATION_CHANGED = "android.intent.action.CONFIGURATION_CHANGED";
1816 /**
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001817 * Broadcast Action: The current device's locale has changed.
Tom Taylord4a47292009-12-21 13:59:18 -08001818 *
Dianne Hackborn362d5b92009-11-11 18:04:39 -08001819 * <p class="note">This is a protected intent that can only be sent
1820 * by the system.
1821 */
1822 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1823 public static final String ACTION_LOCALE_CHANGED = "android.intent.action.LOCALE_CHANGED";
1824 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001825 * Broadcast Action: This is a <em>sticky broadcast</em> containing the
1826 * charging state, level, and other information about the battery.
1827 * See {@link android.os.BatteryManager} for documentation on the
1828 * contents of the Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07001829 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001830 * <p class="note">
1831 * You can <em>not</em> receive this through components declared
Dianne Hackborn854060af2009-07-09 18:14:31 -07001832 * in manifests, only by explicitly registering for it with
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001833 * {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
Dianne Hackbornedd93162009-09-19 14:03:05 -07001834 * Context.registerReceiver()}. See {@link #ACTION_BATTERY_LOW},
1835 * {@link #ACTION_BATTERY_OKAY}, {@link #ACTION_POWER_CONNECTED},
1836 * and {@link #ACTION_POWER_DISCONNECTED} for distinct battery-related
1837 * broadcasts that are sent and can be received through manifest
1838 * receivers.
Tom Taylord4a47292009-12-21 13:59:18 -08001839 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001840 * <p class="note">This is a protected intent that can only be sent
1841 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001842 */
1843 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1844 public static final String ACTION_BATTERY_CHANGED = "android.intent.action.BATTERY_CHANGED";
1845 /**
1846 * Broadcast Action: Indicates low battery condition on the device.
1847 * This broadcast corresponds to the "Low battery warning" system dialog.
Tom Taylord4a47292009-12-21 13:59:18 -08001848 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001849 * <p class="note">This is a protected intent that can only be sent
1850 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001851 */
1852 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1853 public static final String ACTION_BATTERY_LOW = "android.intent.action.BATTERY_LOW";
1854 /**
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001855 * Broadcast Action: Indicates the battery is now okay after being low.
1856 * This will be sent after {@link #ACTION_BATTERY_LOW} once the battery has
1857 * gone back up to an okay state.
Tom Taylord4a47292009-12-21 13:59:18 -08001858 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001859 * <p class="note">This is a protected intent that can only be sent
1860 * by the system.
Dianne Hackborn1dac2772009-06-26 18:16:48 -07001861 */
1862 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1863 public static final String ACTION_BATTERY_OKAY = "android.intent.action.BATTERY_OKAY";
1864 /**
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001865 * Broadcast Action: External power has been connected to the device.
1866 * This is intended for applications that wish to register specifically to this notification.
1867 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1868 * stay active to receive this notification. This action can be used to implement actions
1869 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001870 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001871 * <p class="note">This is a protected intent that can only be sent
1872 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001873 */
1874 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001875 public static final String ACTION_POWER_CONNECTED = "android.intent.action.ACTION_POWER_CONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001876 /**
1877 * Broadcast Action: External power has been removed from the device.
1878 * This is intended for applications that wish to register specifically to this notification.
1879 * Unlike ACTION_BATTERY_CHANGED, applications will be woken for this and so do not have to
1880 * stay active to receive this notification. This action can be used to implement actions
Romain Guy4969af72009-06-17 10:53:19 -07001881 * that wait until power is available to trigger.
Tom Taylord4a47292009-12-21 13:59:18 -08001882 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001883 * <p class="note">This is a protected intent that can only be sent
1884 * by the system.
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001885 */
1886 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Jean-Baptiste Queru1ef45642008-10-24 11:49:25 -07001887 public static final String ACTION_POWER_DISCONNECTED =
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001888 "android.intent.action.ACTION_POWER_DISCONNECTED";
Cliff Spradlinfda6fae2008-10-22 20:29:16 -07001889 /**
Dianne Hackborn55280a92009-05-07 15:53:46 -07001890 * Broadcast Action: Device is shutting down.
1891 * This is broadcast when the device is being shut down (completely turned
1892 * off, not sleeping). Once the broadcast is complete, the final shutdown
1893 * will proceed and all unsaved data lost. Apps will not normally need
Dianne Hackbornfe240ec2009-08-27 12:51:11 -07001894 * to handle this, since the foreground activity will be paused as well.
Tom Taylord4a47292009-12-21 13:59:18 -08001895 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001896 * <p class="note">This is a protected intent that can only be sent
1897 * by the system.
Dianne Hackborn55280a92009-05-07 15:53:46 -07001898 */
1899 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Romain Guy4969af72009-06-17 10:53:19 -07001900 public static final String ACTION_SHUTDOWN = "android.intent.action.ACTION_SHUTDOWN";
Dianne Hackborn55280a92009-05-07 15:53:46 -07001901 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07001902 * Activity Action: Start this activity to request system shutdown.
1903 * The optional boolean extra field {@link #EXTRA_KEY_CONFIRM} can be set to true
1904 * to request confirmation from the user before shutting down.
1905 *
1906 * <p class="note">This is a protected intent that can only be sent
1907 * by the system.
1908 *
1909 * {@hide}
1910 */
1911 public static final String ACTION_REQUEST_SHUTDOWN = "android.intent.action.ACTION_REQUEST_SHUTDOWN";
1912 /**
Dianne Hackbornedd93162009-09-19 14:03:05 -07001913 * Broadcast Action: A sticky broadcast that indicates low memory
1914 * condition on the device
Tom Taylord4a47292009-12-21 13:59:18 -08001915 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001916 * <p class="note">This is a protected intent that can only be sent
1917 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001918 */
1919 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1920 public static final String ACTION_DEVICE_STORAGE_LOW = "android.intent.action.DEVICE_STORAGE_LOW";
1921 /**
1922 * Broadcast Action: Indicates low memory condition on the device no longer exists
Tom Taylord4a47292009-12-21 13:59:18 -08001923 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07001924 * <p class="note">This is a protected intent that can only be sent
1925 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001926 */
1927 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1928 public static final String ACTION_DEVICE_STORAGE_OK = "android.intent.action.DEVICE_STORAGE_OK";
1929 /**
Jake Hambybb371632010-08-23 18:16:48 -07001930 * Broadcast Action: A sticky broadcast that indicates a memory full
1931 * condition on the device. This is intended for activities that want
1932 * to be able to fill the data partition completely, leaving only
1933 * enough free space to prevent system-wide SQLite failures.
1934 *
1935 * <p class="note">This is a protected intent that can only be sent
1936 * by the system.
1937 *
1938 * {@hide}
1939 */
1940 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1941 public static final String ACTION_DEVICE_STORAGE_FULL = "android.intent.action.DEVICE_STORAGE_FULL";
1942 /**
1943 * Broadcast Action: Indicates memory full condition on the device
1944 * no longer exists.
1945 *
1946 * <p class="note">This is a protected intent that can only be sent
1947 * by the system.
1948 *
1949 * {@hide}
1950 */
1951 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1952 public static final String ACTION_DEVICE_STORAGE_NOT_FULL = "android.intent.action.DEVICE_STORAGE_NOT_FULL";
1953 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001954 * Broadcast Action: Indicates low memory condition notification acknowledged by user
1955 * and package management should be started.
1956 * This is triggered by the user from the ACTION_DEVICE_STORAGE_LOW
1957 * notification.
1958 */
1959 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1960 public static final String ACTION_MANAGE_PACKAGE_STORAGE = "android.intent.action.MANAGE_PACKAGE_STORAGE";
1961 /**
1962 * Broadcast Action: The device has entered USB Mass Storage mode.
1963 * This is used mainly for the USB Settings panel.
1964 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1965 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001966 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001967 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001968 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001969 public static final String ACTION_UMS_CONNECTED = "android.intent.action.UMS_CONNECTED";
1970
1971 /**
1972 * Broadcast Action: The device has exited USB Mass Storage mode.
1973 * This is used mainly for the USB Settings panel.
1974 * Apps should listen for ACTION_MEDIA_MOUNTED and ACTION_MEDIA_UNMOUNTED broadcasts to be notified
1975 * when the SD card file system is mounted or unmounted
Mike Lockwood7e4db372011-06-07 11:23:44 -07001976 * @deprecated replaced by android.os.storage.StorageEventListener
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001977 */
Mike Lockwoodda85e522011-06-07 09:08:34 -07001978 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001979 public static final String ACTION_UMS_DISCONNECTED = "android.intent.action.UMS_DISCONNECTED";
1980
1981 /**
1982 * Broadcast Action: External media has been removed.
1983 * The path to the mount point for the removed media is contained in the Intent.mData field.
1984 */
1985 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1986 public static final String ACTION_MEDIA_REMOVED = "android.intent.action.MEDIA_REMOVED";
1987
1988 /**
1989 * Broadcast Action: External media is present, but not mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08001990 * The path to the mount point for the unmounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07001991 */
1992 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
1993 public static final String ACTION_MEDIA_UNMOUNTED = "android.intent.action.MEDIA_UNMOUNTED";
1994
1995 /**
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08001996 * Broadcast Action: External media is present, and being disk-checked
1997 * 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 -08001998 */
1999 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2000 public static final String ACTION_MEDIA_CHECKING = "android.intent.action.MEDIA_CHECKING";
2001
2002 /**
2003 * Broadcast Action: External media is present, but is using an incompatible fs (or is blank)
2004 * 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 -08002005 */
2006 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2007 public static final String ACTION_MEDIA_NOFS = "android.intent.action.MEDIA_NOFS";
2008
2009 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002010 * Broadcast Action: External media is present and mounted at its mount point.
suyi Yuanbe7af832013-01-04 21:21:59 +08002011 * The path to the mount point for the mounted media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002012 * The Intent contains an extra with name "read-only" and Boolean value to indicate if the
2013 * media was mounted read only.
2014 */
2015 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2016 public static final String ACTION_MEDIA_MOUNTED = "android.intent.action.MEDIA_MOUNTED";
2017
2018 /**
2019 * Broadcast Action: External media is unmounted because it is being shared via USB mass storage.
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002020 * 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 -07002021 */
2022 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2023 public static final String ACTION_MEDIA_SHARED = "android.intent.action.MEDIA_SHARED";
2024
2025 /**
Mike Lockwoodbf2dd442010-03-03 06:16:52 -05002026 * Broadcast Action: External media is no longer being shared via USB mass storage.
2027 * The path to the mount point for the previously shared media is contained in the Intent.mData field.
2028 *
2029 * @hide
2030 */
2031 public static final String ACTION_MEDIA_UNSHARED = "android.intent.action.MEDIA_UNSHARED";
2032
2033 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002034 * Broadcast Action: External media was removed from SD card slot, but mount point was not unmounted.
2035 * The path to the mount point for the removed media is contained in the Intent.mData field.
2036 */
2037 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2038 public static final String ACTION_MEDIA_BAD_REMOVAL = "android.intent.action.MEDIA_BAD_REMOVAL";
2039
2040 /**
2041 * Broadcast Action: External media is present but cannot be mounted.
suyi Yuanbe7af832013-01-04 21:21:59 +08002042 * The path to the mount point for the unmountable media is contained in the Intent.mData field.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002043 */
2044 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2045 public static final String ACTION_MEDIA_UNMOUNTABLE = "android.intent.action.MEDIA_UNMOUNTABLE";
2046
2047 /**
2048 * Broadcast Action: User has expressed the desire to remove the external storage media.
2049 * Applications should close all files they have open within the mount point when they receive this intent.
2050 * The path to the mount point for the media to be ejected is contained in the Intent.mData field.
2051 */
2052 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2053 public static final String ACTION_MEDIA_EJECT = "android.intent.action.MEDIA_EJECT";
2054
2055 /**
2056 * Broadcast Action: The media scanner has started scanning a directory.
2057 * The path to the directory being scanned is contained in the Intent.mData field.
2058 */
2059 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2060 public static final String ACTION_MEDIA_SCANNER_STARTED = "android.intent.action.MEDIA_SCANNER_STARTED";
2061
2062 /**
2063 * Broadcast Action: The media scanner has finished scanning a directory.
2064 * The path to the scanned directory is contained in the Intent.mData field.
2065 */
2066 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2067 public static final String ACTION_MEDIA_SCANNER_FINISHED = "android.intent.action.MEDIA_SCANNER_FINISHED";
2068
2069 /**
2070 * Broadcast Action: Request the media scanner to scan a file and add it to the media database.
2071 * The path to the file is contained in the Intent.mData field.
2072 */
2073 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2074 public static final String ACTION_MEDIA_SCANNER_SCAN_FILE = "android.intent.action.MEDIA_SCANNER_SCAN_FILE";
2075
2076 /**
2077 * Broadcast Action: The "Media Button" was pressed. Includes a single
2078 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2079 * caused the broadcast.
2080 */
2081 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2082 public static final String ACTION_MEDIA_BUTTON = "android.intent.action.MEDIA_BUTTON";
2083
2084 /**
2085 * Broadcast Action: The "Camera Button" was pressed. Includes a single
2086 * extra field, {@link #EXTRA_KEY_EVENT}, containing the key event that
2087 * caused the broadcast.
2088 */
2089 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2090 public static final String ACTION_CAMERA_BUTTON = "android.intent.action.CAMERA_BUTTON";
2091
2092 // *** NOTE: @todo(*) The following really should go into a more domain-specific
2093 // location; they are not general-purpose actions.
2094
2095 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002096 * Broadcast Action: A GTalk connection has been established.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002097 */
2098 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2099 public static final String ACTION_GTALK_SERVICE_CONNECTED =
2100 "android.intent.action.GTALK_CONNECTED";
2101
2102 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002103 * Broadcast Action: A GTalk connection has been disconnected.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002104 */
2105 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2106 public static final String ACTION_GTALK_SERVICE_DISCONNECTED =
2107 "android.intent.action.GTALK_DISCONNECTED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002108
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002109 /**
2110 * Broadcast Action: An input method has been changed.
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08002111 */
2112 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2113 public static final String ACTION_INPUT_METHOD_CHANGED =
2114 "android.intent.action.INPUT_METHOD_CHANGED";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002115
2116 /**
2117 * <p>Broadcast Action: The user has switched the phone into or out of Airplane Mode. One or
2118 * more radios have been turned off or on. The intent will have the following extra value:</p>
2119 * <ul>
2120 * <li><em>state</em> - A boolean value indicating whether Airplane Mode is on. If true,
2121 * then cell radio and possibly other radios such as bluetooth or WiFi may have also been
2122 * turned off</li>
2123 * </ul>
Tom Taylord4a47292009-12-21 13:59:18 -08002124 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002125 * <p class="note">This is a protected intent that can only be sent
2126 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002127 */
2128 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2129 public static final String ACTION_AIRPLANE_MODE_CHANGED = "android.intent.action.AIRPLANE_MODE";
2130
2131 /**
2132 * Broadcast Action: Some content providers have parts of their namespace
2133 * where they publish new events or items that the user may be especially
2134 * interested in. For these things, they may broadcast this action when the
2135 * set of interesting items change.
2136 *
2137 * For example, GmailProvider sends this notification when the set of unread
2138 * mail in the inbox changes.
2139 *
2140 * <p>The data of the intent identifies which part of which provider
2141 * changed. When queried through the content resolver, the data URI will
2142 * return the data set in question.
2143 *
2144 * <p>The intent will have the following extra values:
2145 * <ul>
2146 * <li><em>count</em> - The number of items in the data set. This is the
2147 * same as the number of items in the cursor returned by querying the
2148 * data URI. </li>
2149 * </ul>
2150 *
2151 * This intent will be sent at boot (if the count is non-zero) and when the
2152 * data set changes. It is possible for the data set to change without the
2153 * count changing (for example, if a new unread message arrives in the same
2154 * sync operation in which a message is archived). The phone should still
2155 * ring/vibrate/etc as normal in this case.
2156 */
2157 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2158 public static final String ACTION_PROVIDER_CHANGED =
2159 "android.intent.action.PROVIDER_CHANGED";
2160
2161 /**
2162 * Broadcast Action: Wired Headset plugged in or unplugged.
2163 *
2164 * <p>The intent will have the following extra values:
2165 * <ul>
2166 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2167 * <li><em>name</em> - Headset type, human readable string </li>
Eric Laurent923d7d72009-11-12 12:09:06 -08002168 * <li><em>microphone</em> - 1 if headset has a microphone, 0 otherwise </li>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002169 * </ul>
2170 * </ul>
2171 */
2172 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2173 public static final String ACTION_HEADSET_PLUG =
2174 "android.intent.action.HEADSET_PLUG";
2175
2176 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002177 * Broadcast Action: An analog audio speaker/headset plugged in or unplugged.
2178 *
2179 * <p>The intent will have the following extra values:
2180 * <ul>
2181 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2182 * <li><em>name</em> - Headset type, human readable string </li>
2183 * </ul>
2184 * </ul>
2185 * @hide
2186 */
2187 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002188 public static final String ACTION_ANALOG_AUDIO_DOCK_PLUG =
2189 "android.intent.action.ANALOG_AUDIO_DOCK_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002190
2191 /**
Marco Nelisseneb6b9e62011-04-21 15:43:34 -07002192 * Broadcast Action: A digital audio speaker/headset plugged in or unplugged.
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002193 *
2194 * <p>The intent will have the following extra values:
2195 * <ul>
2196 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2197 * <li><em>name</em> - Headset type, human readable string </li>
2198 * </ul>
2199 * </ul>
2200 * @hide
2201 */
2202 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
Eric Laurent59f48272012-04-05 19:42:21 -07002203 public static final String ACTION_DIGITAL_AUDIO_DOCK_PLUG =
2204 "android.intent.action.DIGITAL_AUDIO_DOCK_PLUG";
Praveen Bharathi26e37342010-11-02 19:23:30 -07002205
2206 /**
2207 * Broadcast Action: A HMDI cable was plugged or unplugged
2208 *
2209 * <p>The intent will have the following extra values:
2210 * <ul>
2211 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2212 * <li><em>name</em> - HDMI cable, human readable string </li>
2213 * </ul>
2214 * </ul>
2215 * @hide
2216 */
2217 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2218 public static final String ACTION_HDMI_AUDIO_PLUG =
2219 "android.intent.action.HDMI_AUDIO_PLUG";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002220
2221 /**
Mike Lockwood9d5a4be2012-04-06 09:41:32 -07002222 * Broadcast Action: A USB audio accessory was plugged in or unplugged.
2223 *
2224 * <p>The intent will have the following extra values:
2225 * <ul>
2226 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2227 * <li><em>card</em> - ALSA card number (integer) </li>
2228 * <li><em>device</em> - ALSA device number (integer) </li>
2229 * </ul>
2230 * </ul>
2231 * @hide
2232 */
2233 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2234 public static final String ACTION_USB_AUDIO_ACCESSORY_PLUG =
2235 "android.intent.action.USB_AUDIO_ACCESSORY_PLUG";
2236
2237 /**
Eric Laurent59f48272012-04-05 19:42:21 -07002238 * Broadcast Action: A USB audio device was plugged in or unplugged.
2239 *
2240 * <p>The intent will have the following extra values:
2241 * <ul>
2242 * <li><em>state</em> - 0 for unplugged, 1 for plugged. </li>
2243 * <li><em>card</em> - ALSA card number (integer) </li>
2244 * <li><em>device</em> - ALSA device number (integer) </li>
2245 * </ul>
2246 * </ul>
2247 * @hide
2248 */
2249 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2250 public static final String ACTION_USB_AUDIO_DEVICE_PLUG =
2251 "android.intent.action.USB_AUDIO_DEVICE_PLUG";
2252
2253 /**
Joe Onorato9cdffa12011-04-06 18:27:27 -07002254 * <p>Broadcast Action: The user has switched on advanced settings in the settings app:</p>
2255 * <ul>
2256 * <li><em>state</em> - A boolean value indicating whether the settings is on or off.</li>
2257 * </ul>
2258 *
2259 * <p class="note">This is a protected intent that can only be sent
2260 * by the system.
2261 *
2262 * @hide
2263 */
2264 //@SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2265 public static final String ACTION_ADVANCED_SETTINGS_CHANGED
2266 = "android.intent.action.ADVANCED_SETTINGS";
2267
2268 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002269 * Broadcast Action: An outgoing call is about to be placed.
2270 *
2271 * <p>The Intent will have the following extra value:
2272 * <ul>
The Android Open Source Project10592532009-03-18 17:39:46 -07002273 * <li><em>{@link android.content.Intent#EXTRA_PHONE_NUMBER}</em> -
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002274 * the phone number originally intended to be dialed.</li>
2275 * </ul>
2276 * <p>Once the broadcast is finished, the resultData is used as the actual
2277 * number to call. If <code>null</code>, no call will be placed.</p>
The Android Open Source Project10592532009-03-18 17:39:46 -07002278 * <p>It is perfectly acceptable for multiple receivers to process the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002279 * outgoing call in turn: for example, a parental control application
2280 * might verify that the user is authorized to place the call at that
2281 * time, then a number-rewriting application might add an area code if
2282 * one was not specified.</p>
2283 * <p>For consistency, any receiver whose purpose is to prohibit phone
2284 * calls should have a priority of 0, to ensure it will see the final
2285 * phone number to be dialed.
The Android Open Source Project10592532009-03-18 17:39:46 -07002286 * Any receiver whose purpose is to rewrite phone numbers to be called
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002287 * should have a positive priority.
2288 * Negative priorities are reserved for the system for this broadcast;
2289 * using them may cause problems.</p>
2290 * <p>Any BroadcastReceiver receiving this Intent <em>must not</em>
2291 * abort the broadcast.</p>
2292 * <p>Emergency calls cannot be intercepted using this mechanism, and
2293 * other calls cannot be modified to call emergency numbers using this
2294 * mechanism.
The Android Open Source Project10592532009-03-18 17:39:46 -07002295 * <p>You must hold the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002296 * {@link android.Manifest.permission#PROCESS_OUTGOING_CALLS}
2297 * permission to receive this Intent.</p>
Tom Taylord4a47292009-12-21 13:59:18 -08002298 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002299 * <p class="note">This is a protected intent that can only be sent
2300 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002301 */
2302 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2303 public static final String ACTION_NEW_OUTGOING_CALL =
2304 "android.intent.action.NEW_OUTGOING_CALL";
2305
2306 /**
2307 * Broadcast Action: Have the device reboot. This is only for use by
2308 * system code.
Tom Taylord4a47292009-12-21 13:59:18 -08002309 *
Dianne Hackborn854060af2009-07-09 18:14:31 -07002310 * <p class="note">This is a protected intent that can only be sent
2311 * by the system.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002312 */
2313 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2314 public static final String ACTION_REBOOT =
2315 "android.intent.action.REBOOT";
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002316
Wei Huang97ecc9c2009-05-11 17:44:20 -07002317 /**
Dianne Hackborn7299c412010-03-04 18:41:49 -08002318 * Broadcast Action: A sticky broadcast for changes in the physical
2319 * docking state of the device.
Tobias Haamel154f7a12010-02-17 11:56:39 -08002320 *
2321 * <p>The intent will have the following extra values:
2322 * <ul>
2323 * <li><em>{@link #EXTRA_DOCK_STATE}</em> - the current dock
Dianne Hackborn7299c412010-03-04 18:41:49 -08002324 * state, indicating which dock the device is physically in.</li>
Tobias Haamel154f7a12010-02-17 11:56:39 -08002325 * </ul>
Dianne Hackborn7299c412010-03-04 18:41:49 -08002326 * <p>This is intended for monitoring the current physical dock state.
2327 * See {@link android.app.UiModeManager} for the normal API dealing with
2328 * dock mode changes.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002329 */
2330 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2331 public static final String ACTION_DOCK_EVENT =
2332 "android.intent.action.DOCK_EVENT";
2333
2334 /**
Svetoslavb3038ec2013-02-13 14:39:30 -08002335 * Broadcast Action: A broadcast when idle maintenance can be started.
2336 * This means that the user is not interacting with the device and is
2337 * not expected to do so soon. Typical use of the idle maintenance is
2338 * to perform somehow expensive tasks that can be postponed at a moment
2339 * when they will not degrade user experience.
2340 * <p>
2341 * <p class="note">In order to keep the device responsive in case of an
2342 * unexpected user interaction, implementations of a maintenance task
2343 * should be interruptible. In such a scenario a broadcast with action
2344 * {@link #ACTION_IDLE_MAINTENANCE_END} will be sent. In other words, you
2345 * should not do the maintenance work in
2346 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather start a
2347 * maintenance service by {@link Context#startService(Intent)}. Also
2348 * you should hold a wake lock while your maintenance service is running
2349 * to prevent the device going to sleep.
2350 * </p>
2351 * <p>
2352 * <p class="note">This is a protected intent that can only be sent by
2353 * the system.
2354 * </p>
2355 *
2356 * @see #ACTION_IDLE_MAINTENANCE_END
2357 */
2358 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2359 public static final String ACTION_IDLE_MAINTENANCE_START =
2360 "android.intent.action.ACTION_IDLE_MAINTENANCE_START";
2361
2362 /**
2363 * Broadcast Action: A broadcast when idle maintenance should be stopped.
2364 * This means that the user was not interacting with the device as a result
2365 * of which a broadcast with action {@link #ACTION_IDLE_MAINTENANCE_START}
2366 * was sent and now the user started interacting with the device. Typical
2367 * use of the idle maintenance is to perform somehow expensive tasks that
2368 * can be postponed at a moment when they will not degrade user experience.
2369 * <p>
2370 * <p class="note">In order to keep the device responsive in case of an
2371 * unexpected user interaction, implementations of a maintenance task
2372 * should be interruptible. Hence, on receiving a broadcast with this
2373 * action, the maintenance task should be interrupted as soon as possible.
2374 * In other words, you should not do the maintenance work in
2375 * {@link BroadcastReceiver#onReceive(Context, Intent)}, rather stop the
2376 * maintenance service that was started on receiving of
2377 * {@link #ACTION_IDLE_MAINTENANCE_START}.Also you should release the wake
2378 * lock you acquired when your maintenance service started.
2379 * </p>
2380 * <p class="note">This is a protected intent that can only be sent
2381 * by the system.
2382 *
2383 * @see #ACTION_IDLE_MAINTENANCE_START
2384 */
2385 @SdkConstant(SdkConstantType.BROADCAST_INTENT_ACTION)
2386 public static final String ACTION_IDLE_MAINTENANCE_END =
2387 "android.intent.action.ACTION_IDLE_MAINTENANCE_END";
2388
2389 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07002390 * Broadcast Action: a remote intent is to be broadcasted.
2391 *
2392 * A remote intent is used for remote RPC between devices. The remote intent
2393 * is serialized and sent from one device to another device. The receiving
2394 * device parses the remote intent and broadcasts it. Note that anyone can
2395 * broadcast a remote intent. However, if the intent receiver of the remote intent
2396 * does not trust intent broadcasts from arbitrary intent senders, it should require
2397 * the sender to hold certain permissions so only trusted sender's broadcast will be
2398 * let through.
Dianne Hackbornedd93162009-09-19 14:03:05 -07002399 * @hide
Wei Huang97ecc9c2009-05-11 17:44:20 -07002400 */
2401 public static final String ACTION_REMOTE_INTENT =
Costin Manolache8d83f9e2010-05-12 16:04:10 -07002402 "com.google.android.c2dm.intent.RECEIVE";
Wei Huang97ecc9c2009-05-11 17:44:20 -07002403
Dianne Hackborn9acc0302009-08-25 00:27:12 -07002404 /**
2405 * Broadcast Action: hook for permforming cleanup after a system update.
2406 *
2407 * The broadcast is sent when the system is booting, before the
2408 * BOOT_COMPLETED broadcast. It is only sent to receivers in the system
2409 * image. A receiver for this should do its work and then disable itself
2410 * so that it does not get run again at the next boot.
2411 * @hide
2412 */
2413 public static final String ACTION_PRE_BOOT_COMPLETED =
2414 "android.intent.action.PRE_BOOT_COMPLETED";
2415
Amith Yamasani13593602012-03-22 16:16:17 -07002416 /**
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002417 * Sent the first time a user is starting, to allow system apps to
2418 * perform one time initialization. (This will not be seen by third
2419 * party applications because a newly initialized user does not have any
2420 * third party applications installed for it.) This is sent early in
2421 * starting the user, around the time the home app is started, before
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002422 * {@link #ACTION_BOOT_COMPLETED} is sent. This is sent as a foreground
2423 * broadcast, since it is part of a visible user interaction; be as quick
2424 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002425 */
2426 public static final String ACTION_USER_INITIALIZE =
2427 "android.intent.action.USER_INITIALIZE";
2428
2429 /**
2430 * Sent when a user switch is happening, causing the process's user to be
2431 * brought to the foreground. This is only sent to receivers registered
2432 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2433 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002434 * foreground. This is sent as a foreground
2435 * broadcast, since it is part of a visible user interaction; be as quick
2436 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002437 */
2438 public static final String ACTION_USER_FOREGROUND =
2439 "android.intent.action.USER_FOREGROUND";
2440
2441 /**
2442 * Sent when a user switch is happening, causing the process's user to be
2443 * sent to the background. This is only sent to receivers registered
2444 * through {@link Context#registerReceiver(BroadcastReceiver, IntentFilter)
2445 * Context.registerReceiver}. It is sent to the user that is going to the
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002446 * background. This is sent as a foreground
2447 * broadcast, since it is part of a visible user interaction; be as quick
2448 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002449 */
2450 public static final String ACTION_USER_BACKGROUND =
2451 "android.intent.action.USER_BACKGROUND";
2452
2453 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002454 * Broadcast sent to the system when a user is added. Carries an extra
2455 * EXTRA_USER_HANDLE that has the userHandle of the new user. It is sent to
2456 * all running users. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002457 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002458 * @hide
2459 */
2460 public static final String ACTION_USER_ADDED =
2461 "android.intent.action.USER_ADDED";
2462
2463 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002464 * Broadcast sent by the system when a user is started. Carries an extra
2465 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only sent to
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002466 * registered receivers, not manifest receivers. It is sent to the user
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002467 * that has been started. This is sent as a foreground
2468 * broadcast, since it is part of a visible user interaction; be as quick
2469 * as possible when handling it.
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002470 * @hide
2471 */
2472 public static final String ACTION_USER_STARTED =
2473 "android.intent.action.USER_STARTED";
2474
2475 /**
Dianne Hackborn36d337a2012-10-08 14:33:47 -07002476 * Broadcast sent when a user is in the process of starting. Carries an extra
2477 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2478 * sent to registered receivers, not manifest receivers. It is sent to all
2479 * users (including the one that is being started). You must hold
2480 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2481 * this broadcast. This is sent as a background broadcast, since
2482 * its result is not part of the primary UX flow; to safely keep track of
2483 * started/stopped state of a user you can use this in conjunction with
2484 * {@link #ACTION_USER_STOPPING}. It is <b>not</b> generally safe to use with
2485 * other user state broadcasts since those are foreground broadcasts so can
2486 * execute in a different order.
2487 * @hide
2488 */
2489 public static final String ACTION_USER_STARTING =
2490 "android.intent.action.USER_STARTING";
2491
2492 /**
2493 * Broadcast sent when a user is going to be stopped. Carries an extra
2494 * EXTRA_USER_HANDLE that has the userHandle of the user. This is only
2495 * sent to registered receivers, not manifest receivers. It is sent to all
2496 * users (including the one that is being stopped). You must hold
2497 * {@link android.Manifest.permission#INTERACT_ACROSS_USERS} to receive
2498 * this broadcast. The user will not stop until all receivers have
2499 * handled the broadcast. This is sent as a background broadcast, since
2500 * its result is not part of the primary UX flow; to safely keep track of
2501 * started/stopped state of a user you can use this in conjunction with
2502 * {@link #ACTION_USER_STARTING}. It is <b>not</b> generally safe to use with
2503 * other user state broadcasts since those are foreground broadcasts so can
2504 * execute in a different order.
2505 * @hide
2506 */
2507 public static final String ACTION_USER_STOPPING =
2508 "android.intent.action.USER_STOPPING";
2509
2510 /**
2511 * Broadcast sent to the system when a user is stopped. Carries an extra
2512 * EXTRA_USER_HANDLE that has the userHandle of the user. This is similar to
2513 * {@link #ACTION_PACKAGE_RESTARTED}, but for an entire user instead of a
2514 * specific package. This is only sent to registered receivers, not manifest
2515 * receivers. It is sent to all running users <em>except</em> the one that
2516 * has just been stopped (which is no longer running).
Dianne Hackborn80a4af22012-08-27 19:18:31 -07002517 * @hide
2518 */
2519 public static final String ACTION_USER_STOPPED =
2520 "android.intent.action.USER_STOPPED";
2521
2522 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002523 * Broadcast sent to the system when a user is removed. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002524 * the userHandle of the user. It is sent to all running users except the
Amith Yamasanidb6a14c2012-10-17 21:16:52 -07002525 * one that has been removed. The user will not be completely removed until all receivers have
2526 * handled the broadcast. You must hold
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002527 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002528 * @hide
2529 */
2530 public static final String ACTION_USER_REMOVED =
2531 "android.intent.action.USER_REMOVED";
2532
2533 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07002534 * Broadcast sent to the system when the user switches. Carries an extra EXTRA_USER_HANDLE that has
Dianne Hackborn5dc5a002012-09-15 19:33:48 -07002535 * the userHandle of the user to become the current one. This is only sent to
2536 * registered receivers, not manifest receivers. It is sent to all running users.
2537 * You must hold
2538 * {@link android.Manifest.permission#MANAGE_USERS} to receive this broadcast.
Amith Yamasani13593602012-03-22 16:16:17 -07002539 * @hide
2540 */
2541 public static final String ACTION_USER_SWITCHED =
2542 "android.intent.action.USER_SWITCHED";
2543
Amith Yamasanie928d7d2012-09-17 21:46:51 -07002544 /**
2545 * Broadcast sent to the system when a user's information changes. Carries an extra
2546 * {@link #EXTRA_USER_HANDLE} to indicate which user's information changed.
2547 * This is only sent to registered receivers, not manifest receivers. It is sent to the user
2548 * whose information has changed.
2549 * @hide
2550 */
2551 public static final String ACTION_USER_INFO_CHANGED =
2552 "android.intent.action.USER_INFO_CHANGED";
2553
Daniel Sandler2e7d25b2012-10-01 16:43:26 -04002554 /**
2555 * Sent when the user taps on the clock widget in the system's "quick settings" area.
2556 */
2557 public static final String ACTION_QUICK_CLOCK =
2558 "android.intent.action.QUICK_CLOCK";
2559
Michael Wright0087a142013-02-05 16:29:39 -08002560 /**
2561 * Broadcast Action: This is broadcast when a user action should request the
2562 * brightness setting dialog.
2563 * @hide
2564 */
2565 public static final String ACTION_SHOW_BRIGHTNESS_DIALOG =
2566 "android.intent.action.SHOW_BRIGHTNESS_DIALOG";
2567
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002568 // ---------------------------------------------------------------------
2569 // ---------------------------------------------------------------------
2570 // Standard intent categories (see addCategory()).
2571
2572 /**
2573 * Set if the activity should be an option for the default action
2574 * (center press) to perform on a piece of data. Setting this will
2575 * hide from the user any activities without it set when performing an
2576 * action on some data. Note that this is normal -not- set in the
2577 * Intent when initiating an action -- it is for use in intent filters
2578 * specified in packages.
2579 */
2580 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2581 public static final String CATEGORY_DEFAULT = "android.intent.category.DEFAULT";
2582 /**
2583 * Activities that can be safely invoked from a browser must support this
2584 * category. For example, if the user is viewing a web page or an e-mail
2585 * and clicks on a link in the text, the Intent generated execute that
2586 * link will require the BROWSABLE category, so that only activities
2587 * supporting this category will be considered as possible actions. By
2588 * supporting this category, you are promising that there is nothing
2589 * damaging (without user intervention) that can happen by invoking any
2590 * matching Intent.
2591 */
2592 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2593 public static final String CATEGORY_BROWSABLE = "android.intent.category.BROWSABLE";
2594 /**
2595 * Set if the activity should be considered as an alternative action to
2596 * the data the user is currently viewing. See also
2597 * {@link #CATEGORY_SELECTED_ALTERNATIVE} for an alternative action that
2598 * applies to the selection in a list of items.
2599 *
2600 * <p>Supporting this category means that you would like your activity to be
2601 * displayed in the set of alternative things the user can do, usually as
2602 * part of the current activity's options menu. You will usually want to
2603 * include a specific label in the &lt;intent-filter&gt; of this action
2604 * describing to the user what it does.
2605 *
2606 * <p>The action of IntentFilter with this category is important in that it
2607 * describes the specific action the target will perform. This generally
2608 * should not be a generic action (such as {@link #ACTION_VIEW}, but rather
2609 * a specific name such as "com.android.camera.action.CROP. Only one
2610 * alternative of any particular action will be shown to the user, so using
2611 * a specific action like this makes sure that your alternative will be
2612 * displayed while also allowing other applications to provide their own
2613 * overrides of that particular action.
2614 */
2615 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2616 public static final String CATEGORY_ALTERNATIVE = "android.intent.category.ALTERNATIVE";
2617 /**
2618 * Set if the activity should be considered as an alternative selection
2619 * action to the data the user has currently selected. This is like
2620 * {@link #CATEGORY_ALTERNATIVE}, but is used in activities showing a list
2621 * of items from which the user can select, giving them alternatives to the
2622 * default action that will be performed on it.
2623 */
2624 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2625 public static final String CATEGORY_SELECTED_ALTERNATIVE = "android.intent.category.SELECTED_ALTERNATIVE";
2626 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002627 * Intended to be used as a tab inside of a containing TabActivity.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002628 */
2629 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2630 public static final String CATEGORY_TAB = "android.intent.category.TAB";
2631 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002632 * Should be displayed in the top-level launcher.
2633 */
2634 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2635 public static final String CATEGORY_LAUNCHER = "android.intent.category.LAUNCHER";
2636 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002637 * Provides information about the package it is in; typically used if
2638 * a package does not contain a {@link #CATEGORY_LAUNCHER} to provide
2639 * a front-door to the user without having to be shown in the all apps list.
2640 */
2641 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2642 public static final String CATEGORY_INFO = "android.intent.category.INFO";
2643 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002644 * This is the home activity, that is the first activity that is displayed
2645 * when the device boots.
2646 */
2647 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2648 public static final String CATEGORY_HOME = "android.intent.category.HOME";
2649 /**
2650 * This activity is a preference panel.
2651 */
2652 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2653 public static final String CATEGORY_PREFERENCE = "android.intent.category.PREFERENCE";
2654 /**
2655 * This activity is a development preference panel.
2656 */
2657 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2658 public static final String CATEGORY_DEVELOPMENT_PREFERENCE = "android.intent.category.DEVELOPMENT_PREFERENCE";
2659 /**
2660 * Capable of running inside a parent activity container.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002661 */
2662 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2663 public static final String CATEGORY_EMBED = "android.intent.category.EMBED";
2664 /**
Patrick Dubroy6dabe242010-08-30 10:43:47 -07002665 * This activity allows the user to browse and download new applications.
2666 */
2667 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2668 public static final String CATEGORY_APP_MARKET = "android.intent.category.APP_MARKET";
2669 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002670 * This activity may be exercised by the monkey or other automated test tools.
2671 */
2672 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2673 public static final String CATEGORY_MONKEY = "android.intent.category.MONKEY";
2674 /**
2675 * To be used as a test (not part of the normal user experience).
2676 */
2677 public static final String CATEGORY_TEST = "android.intent.category.TEST";
2678 /**
2679 * To be used as a unit test (run through the Test Harness).
2680 */
2681 public static final String CATEGORY_UNIT_TEST = "android.intent.category.UNIT_TEST";
2682 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002683 * To be used as a sample code example (not part of the normal user
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002684 * experience).
2685 */
2686 public static final String CATEGORY_SAMPLE_CODE = "android.intent.category.SAMPLE_CODE";
2687 /**
2688 * Used to indicate that a GET_CONTENT intent only wants URIs that can be opened with
Dianne Hackborna53ee352013-02-20 12:47:02 -08002689 * ContentResolver.openInputStream. Openable URIs must support the columns in
2690 * {@link android.provider.OpenableColumns}
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002691 * when queried, though it is allowable for those columns to be blank.
2692 */
2693 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2694 public static final String CATEGORY_OPENABLE = "android.intent.category.OPENABLE";
2695
2696 /**
2697 * To be used as code under test for framework instrumentation tests.
2698 */
2699 public static final String CATEGORY_FRAMEWORK_INSTRUMENTATION_TEST =
2700 "android.intent.category.FRAMEWORK_INSTRUMENTATION_TEST";
Mike Lockwood9092ab42009-09-16 13:01:32 -04002701 /**
2702 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002703 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2704 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002705 */
2706 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2707 public static final String CATEGORY_CAR_DOCK = "android.intent.category.CAR_DOCK";
2708 /**
2709 * An activity to run when device is inserted into a car dock.
Dianne Hackborn7299c412010-03-04 18:41:49 -08002710 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2711 * information, see {@link android.app.UiModeManager}.
Mike Lockwood9092ab42009-09-16 13:01:32 -04002712 */
2713 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2714 public static final String CATEGORY_DESK_DOCK = "android.intent.category.DESK_DOCK";
Praveen Bharathi21e941b2010-10-06 15:23:14 -05002715 /**
2716 * An activity to run when device is inserted into a analog (low end) dock.
2717 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2718 * information, see {@link android.app.UiModeManager}.
2719 */
2720 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2721 public static final String CATEGORY_LE_DESK_DOCK = "android.intent.category.LE_DESK_DOCK";
2722
2723 /**
2724 * An activity to run when device is inserted into a digital (high end) dock.
2725 * Used with {@link #ACTION_MAIN} to launch an activity. For more
2726 * information, see {@link android.app.UiModeManager}.
2727 */
2728 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2729 public static final String CATEGORY_HE_DESK_DOCK = "android.intent.category.HE_DESK_DOCK";
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05002730
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002731 /**
2732 * Used to indicate that the activity can be used in a car environment.
2733 */
2734 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2735 public static final String CATEGORY_CAR_MODE = "android.intent.category.CAR_MODE";
2736
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002737 // ---------------------------------------------------------------------
2738 // ---------------------------------------------------------------------
Jeff Brown6651a632011-11-28 12:59:11 -08002739 // Application launch intent categories (see addCategory()).
2740
2741 /**
2742 * Used with {@link #ACTION_MAIN} to launch the browser application.
2743 * The activity should be able to browse the Internet.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002744 * <p>NOTE: This should not be used as the primary key of an Intent,
2745 * since it will not result in the app launching with the correct
2746 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002747 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002748 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002749 */
2750 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2751 public static final String CATEGORY_APP_BROWSER = "android.intent.category.APP_BROWSER";
2752
2753 /**
2754 * Used with {@link #ACTION_MAIN} to launch the calculator application.
2755 * The activity should be able to perform standard arithmetic operations.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002756 * <p>NOTE: This should not be used as the primary key of an Intent,
2757 * since it will not result in the app launching with the correct
2758 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002759 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002760 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002761 */
2762 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2763 public static final String CATEGORY_APP_CALCULATOR = "android.intent.category.APP_CALCULATOR";
2764
2765 /**
2766 * Used with {@link #ACTION_MAIN} to launch the calendar application.
2767 * The activity should be able to view and manipulate calendar entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002768 * <p>NOTE: This should not be used as the primary key of an Intent,
2769 * since it will not result in the app launching with the correct
2770 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002771 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002772 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002773 */
2774 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2775 public static final String CATEGORY_APP_CALENDAR = "android.intent.category.APP_CALENDAR";
2776
2777 /**
2778 * Used with {@link #ACTION_MAIN} to launch the contacts application.
2779 * The activity should be able to view and manipulate address book entries.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002780 * <p>NOTE: This should not be used as the primary key of an Intent,
2781 * since it will not result in the app launching with the correct
2782 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002783 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002784 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002785 */
2786 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2787 public static final String CATEGORY_APP_CONTACTS = "android.intent.category.APP_CONTACTS";
2788
2789 /**
2790 * Used with {@link #ACTION_MAIN} to launch the email application.
2791 * The activity should be able to send and receive email.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002792 * <p>NOTE: This should not be used as the primary key of an Intent,
2793 * since it will not result in the app launching with the correct
2794 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002795 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002796 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002797 */
2798 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2799 public static final String CATEGORY_APP_EMAIL = "android.intent.category.APP_EMAIL";
2800
2801 /**
2802 * Used with {@link #ACTION_MAIN} to launch the gallery application.
2803 * The activity should be able to view and manipulate image and video files
2804 * stored on the device.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002805 * <p>NOTE: This should not be used as the primary key of an Intent,
2806 * since it will not result in the app launching with the correct
2807 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002808 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002809 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002810 */
2811 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2812 public static final String CATEGORY_APP_GALLERY = "android.intent.category.APP_GALLERY";
2813
2814 /**
2815 * Used with {@link #ACTION_MAIN} to launch the maps application.
2816 * The activity should be able to show the user's current location and surroundings.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002817 * <p>NOTE: This should not be used as the primary key of an Intent,
2818 * since it will not result in the app launching with the correct
2819 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002820 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002821 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002822 */
2823 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2824 public static final String CATEGORY_APP_MAPS = "android.intent.category.APP_MAPS";
2825
2826 /**
2827 * Used with {@link #ACTION_MAIN} to launch the messaging application.
2828 * The activity should be able to send and receive text messages.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002829 * <p>NOTE: This should not be used as the primary key of an Intent,
2830 * since it will not result in the app launching with the correct
2831 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002832 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002833 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002834 */
2835 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2836 public static final String CATEGORY_APP_MESSAGING = "android.intent.category.APP_MESSAGING";
2837
2838 /**
2839 * Used with {@link #ACTION_MAIN} to launch the music application.
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002840 * The activity should be able to play, browse, or manipulate music files
2841 * stored on the device.
2842 * <p>NOTE: This should not be used as the primary key of an Intent,
2843 * since it will not result in the app launching with the correct
2844 * action and category. Instead, use this with
Dianne Hackborn251fe262011-12-14 17:20:54 -08002845 * {@link #makeMainSelectorActivity(String, String)} to generate a main
Dianne Hackbornf5b86712011-12-05 17:42:41 -08002846 * Intent with this category in the selector.</p>
Jeff Brown6651a632011-11-28 12:59:11 -08002847 */
2848 @SdkConstant(SdkConstantType.INTENT_CATEGORY)
2849 public static final String CATEGORY_APP_MUSIC = "android.intent.category.APP_MUSIC";
2850
2851 // ---------------------------------------------------------------------
2852 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002853 // Standard extra data keys.
2854
2855 /**
2856 * The initial data to place in a newly created record. Use with
2857 * {@link #ACTION_INSERT}. The data here is a Map containing the same
2858 * fields as would be given to the underlying ContentProvider.insert()
2859 * call.
2860 */
2861 public static final String EXTRA_TEMPLATE = "android.intent.extra.TEMPLATE";
2862
2863 /**
2864 * A constant CharSequence that is associated with the Intent, used with
2865 * {@link #ACTION_SEND} to supply the literal data to be sent. Note that
2866 * this may be a styled CharSequence, so you must use
2867 * {@link Bundle#getCharSequence(String) Bundle.getCharSequence()} to
2868 * retrieve it.
2869 */
2870 public static final String EXTRA_TEXT = "android.intent.extra.TEXT";
2871
2872 /**
Dianne Hackbornacb69bb2012-04-13 15:36:06 -07002873 * A constant String that is associated with the Intent, used with
2874 * {@link #ACTION_SEND} to supply an alternative to {@link #EXTRA_TEXT}
2875 * as HTML formatted text. Note that you <em>must</em> also supply
2876 * {@link #EXTRA_TEXT}.
2877 */
2878 public static final String EXTRA_HTML_TEXT = "android.intent.extra.HTML_TEXT";
2879
2880 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002881 * A content: URI holding a stream of data associated with the Intent,
2882 * used with {@link #ACTION_SEND} to supply the data being sent.
2883 */
2884 public static final String EXTRA_STREAM = "android.intent.extra.STREAM";
2885
2886 /**
2887 * A String[] holding e-mail addresses that should be delivered to.
2888 */
2889 public static final String EXTRA_EMAIL = "android.intent.extra.EMAIL";
2890
2891 /**
2892 * A String[] holding e-mail addresses that should be carbon copied.
2893 */
2894 public static final String EXTRA_CC = "android.intent.extra.CC";
2895
2896 /**
2897 * A String[] holding e-mail addresses that should be blind carbon copied.
2898 */
2899 public static final String EXTRA_BCC = "android.intent.extra.BCC";
2900
2901 /**
2902 * A constant string holding the desired subject line of a message.
2903 */
2904 public static final String EXTRA_SUBJECT = "android.intent.extra.SUBJECT";
2905
2906 /**
2907 * An Intent describing the choices you would like shown with
2908 * {@link #ACTION_PICK_ACTIVITY}.
2909 */
2910 public static final String EXTRA_INTENT = "android.intent.extra.INTENT";
2911
2912 /**
2913 * A CharSequence dialog title to provide to the user when used with a
2914 * {@link #ACTION_CHOOSER}.
2915 */
2916 public static final String EXTRA_TITLE = "android.intent.extra.TITLE";
2917
2918 /**
Dianne Hackborneb034652009-09-07 00:49:58 -07002919 * A Parcelable[] of {@link Intent} or
2920 * {@link android.content.pm.LabeledIntent} objects as set with
2921 * {@link #putExtra(String, Parcelable[])} of additional activities to place
2922 * a the front of the list of choices, when shown to the user with a
2923 * {@link #ACTION_CHOOSER}.
2924 */
2925 public static final String EXTRA_INITIAL_INTENTS = "android.intent.extra.INITIAL_INTENTS";
2926
2927 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002928 * A {@link android.view.KeyEvent} object containing the event that
2929 * triggered the creation of the Intent it is in.
2930 */
2931 public static final String EXTRA_KEY_EVENT = "android.intent.extra.KEY_EVENT";
2932
2933 /**
Mike Lockwoodbad80e02009-07-30 01:21:08 -07002934 * Set to true in {@link #ACTION_REQUEST_SHUTDOWN} to request confirmation from the user
2935 * before shutting down.
2936 *
2937 * {@hide}
2938 */
2939 public static final String EXTRA_KEY_CONFIRM = "android.intent.extra.KEY_CONFIRM";
2940
2941 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09002942 * 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 -07002943 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} intents to override the default action
2944 * of restarting the application.
2945 */
2946 public static final String EXTRA_DONT_KILL_APP = "android.intent.extra.DONT_KILL_APP";
2947
2948 /**
2949 * A String holding the phone number originally entered in
2950 * {@link android.content.Intent#ACTION_NEW_OUTGOING_CALL}, or the actual
2951 * number to call in a {@link android.content.Intent#ACTION_CALL}.
2952 */
2953 public static final String EXTRA_PHONE_NUMBER = "android.intent.extra.PHONE_NUMBER";
Bernd Holzheyaea4b672010-03-31 09:46:13 +02002954
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002955 /**
2956 * Used as an int extra field in {@link android.content.Intent#ACTION_UID_REMOVED}
2957 * intents to supply the uid the package had been assigned. Also an optional
2958 * extra in {@link android.content.Intent#ACTION_PACKAGE_REMOVED} or
2959 * {@link android.content.Intent#ACTION_PACKAGE_CHANGED} for the same
2960 * purpose.
2961 */
2962 public static final String EXTRA_UID = "android.intent.extra.UID";
2963
2964 /**
Dianne Hackborn21f1bd12010-02-19 17:02:21 -08002965 * @hide String array of package names.
2966 */
2967 public static final String EXTRA_PACKAGES = "android.intent.extra.PACKAGES";
2968
2969 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002970 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2971 * intents to indicate whether this represents a full uninstall (removing
2972 * both the code and its data) or a partial uninstall (leaving its data,
2973 * implying that this is an update).
2974 */
2975 public static final String EXTRA_DATA_REMOVED = "android.intent.extra.DATA_REMOVED";
The Android Open Source Project10592532009-03-18 17:39:46 -07002976
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002977 /**
Dianne Hackbornc72fc672012-09-20 13:12:03 -07002978 * @hide
2979 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2980 * intents to indicate that at this point the package has been removed for
2981 * all users on the device.
2982 */
2983 public static final String EXTRA_REMOVED_FOR_ALL_USERS
2984 = "android.intent.extra.REMOVED_FOR_ALL_USERS";
2985
2986 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002987 * Used as a boolean extra field in {@link android.content.Intent#ACTION_PACKAGE_REMOVED}
2988 * intents to indicate that this is a replacement of the package, so this
2989 * broadcast will immediately be followed by an add broadcast for a
2990 * different version of the same package.
2991 */
2992 public static final String EXTRA_REPLACING = "android.intent.extra.REPLACING";
The Android Open Source Project10592532009-03-18 17:39:46 -07002993
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08002994 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07002995 * Used as an int extra field in {@link android.app.AlarmManager} intents
2996 * to tell the application being invoked how many pending alarms are being
2997 * delievered with the intent. For one-shot alarms this will always be 1.
2998 * For recurring alarms, this might be greater than 1 if the device was
2999 * asleep or powered off at the time an earlier alarm would have been
3000 * delivered.
3001 */
3002 public static final String EXTRA_ALARM_COUNT = "android.intent.extra.ALARM_COUNT";
Romain Guy4969af72009-06-17 10:53:19 -07003003
Jacek Surazski86b6c532009-05-13 14:38:28 +02003004 /**
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003005 * Used as an int extra field in {@link android.content.Intent#ACTION_DOCK_EVENT}
3006 * intents to request the dock state. Possible values are
Mike Lockwood725fcbf2009-08-24 13:09:20 -07003007 * {@link android.content.Intent#EXTRA_DOCK_STATE_UNDOCKED},
3008 * {@link android.content.Intent#EXTRA_DOCK_STATE_DESK}, or
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003009 * {@link android.content.Intent#EXTRA_DOCK_STATE_CAR}, or
3010 * {@link android.content.Intent#EXTRA_DOCK_STATE_LE_DESK}, or
3011 * {@link android.content.Intent#EXTRA_DOCK_STATE_HE_DESK}.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003012 */
3013 public static final String EXTRA_DOCK_STATE = "android.intent.extra.DOCK_STATE";
3014
3015 /**
3016 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3017 * to represent that the phone is not in any dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003018 */
3019 public static final int EXTRA_DOCK_STATE_UNDOCKED = 0;
3020
3021 /**
3022 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3023 * to represent that the phone is in a desk dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003024 */
3025 public static final int EXTRA_DOCK_STATE_DESK = 1;
3026
3027 /**
3028 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3029 * to represent that the phone is in a car dock.
Dan Murphyc9f4eaf2009-08-12 15:15:43 -05003030 */
3031 public static final int EXTRA_DOCK_STATE_CAR = 2;
3032
3033 /**
Praveen Bharathi21e941b2010-10-06 15:23:14 -05003034 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3035 * to represent that the phone is in a analog (low end) dock.
3036 */
3037 public static final int EXTRA_DOCK_STATE_LE_DESK = 3;
3038
3039 /**
3040 * Used as an int value for {@link android.content.Intent#EXTRA_DOCK_STATE}
3041 * to represent that the phone is in a digital (high end) dock.
3042 */
3043 public static final int EXTRA_DOCK_STATE_HE_DESK = 4;
3044
3045 /**
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003046 * Boolean that can be supplied as meta-data with a dock activity, to
3047 * indicate that the dock should take over the home key when it is active.
3048 */
3049 public static final String METADATA_DOCK_HOME = "android.dock_home";
Tom Taylord4a47292009-12-21 13:59:18 -08003050
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07003051 /**
Jacek Surazski86b6c532009-05-13 14:38:28 +02003052 * Used as a parcelable extra field in {@link #ACTION_APP_ERROR}, containing
3053 * the bug report.
Jacek Surazski86b6c532009-05-13 14:38:28 +02003054 */
3055 public static final String EXTRA_BUG_REPORT = "android.intent.extra.BUG_REPORT";
3056
3057 /**
Wei Huang97ecc9c2009-05-11 17:44:20 -07003058 * Used in the extra field in the remote intent. It's astring token passed with the
3059 * remote intent.
3060 */
3061 public static final String EXTRA_REMOTE_INTENT_TOKEN =
3062 "android.intent.extra.remote_intent_token";
3063
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003064 /**
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003065 * @deprecated See {@link #EXTRA_CHANGED_COMPONENT_NAME_LIST}; this field
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003066 * will contain only the first name in the list.
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003067 */
Dianne Hackborn1d62ea92009-11-17 12:49:50 -08003068 @Deprecated public static final String EXTRA_CHANGED_COMPONENT_NAME =
Suchi Amalapurapu0214e942009-09-02 11:03:18 -07003069 "android.intent.extra.changed_component_name";
3070
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003071 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003072 * This field is part of {@link android.content.Intent#ACTION_PACKAGE_CHANGED},
Dianne Hackbornfd7aded2013-01-22 17:10:23 -08003073 * and contains a string array of all of the components that have changed. If
3074 * the state of the overall package has changed, then it will contain an entry
3075 * with the package name itself.
Dianne Hackborn86a72da2009-11-11 20:12:41 -08003076 */
3077 public static final String EXTRA_CHANGED_COMPONENT_NAME_LIST =
3078 "android.intent.extra.changed_component_name_list";
3079
3080 /**
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003081 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003082 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3083 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003084 * and contains a string array of all of the components that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003085 */
3086 public static final String EXTRA_CHANGED_PACKAGE_LIST =
3087 "android.intent.extra.changed_package_list";
3088
3089 /**
3090 * This field is part of
Suchi Amalapurapub56ae202010-02-04 22:51:07 -08003091 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_AVAILABLE},
3092 * {@link android.content.Intent#ACTION_EXTERNAL_APPLICATIONS_UNAVAILABLE}
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003093 * and contains an integer array of uids of all of the components
3094 * that have changed.
Suchi Amalapurapu08675a32010-01-28 09:57:30 -08003095 */
3096 public static final String EXTRA_CHANGED_UID_LIST =
3097 "android.intent.extra.changed_uid_list";
3098
3099 /**
Dianne Hackborndd9b82c2009-09-03 00:18:47 -07003100 * @hide
3101 * Magic extra system code can use when binding, to give a label for
3102 * who it is that has bound to a service. This is an integer giving
3103 * a framework string resource that can be displayed to the user.
3104 */
3105 public static final String EXTRA_CLIENT_LABEL =
3106 "android.intent.extra.client_label";
3107
3108 /**
3109 * @hide
3110 * Magic extra system code can use when binding, to give a PendingIntent object
3111 * that can be launched for the user to disable the system's use of this
3112 * service.
3113 */
3114 public static final String EXTRA_CLIENT_INTENT =
3115 "android.intent.extra.client_intent";
3116
Dianne Hackbornc4d0e6f2011-01-25 14:55:06 -08003117 /**
3118 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent should only return
3119 * data that is on the local device. This is a boolean extra; the default
3120 * is false. If true, an implementation of ACTION_GET_CONTENT should only allow
3121 * the user to select media that is already on the device, not requiring it
3122 * be downloaded from a remote service when opened. Another way to look
3123 * at it is that such content should generally have a "_data" column to the
3124 * path of the content on local external storage.
3125 */
3126 public static final String EXTRA_LOCAL_ONLY =
3127 "android.intent.extra.LOCAL_ONLY";
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07003128
Amith Yamasani13593602012-03-22 16:16:17 -07003129 /**
Dianne Hackbornfdb3f092013-01-28 15:10:48 -08003130 * Used to indicate that a {@link #ACTION_GET_CONTENT} intent can allow the
3131 * user to select and return multiple items. This is a boolean extra; the default
3132 * is false. If true, an implementation of ACTION_GET_CONTENT is allowed to
3133 * present the user with a UI where they can pick multiple items that are all
3134 * returned to the caller. When this happens, they should be returned as
3135 * the {@link #getClipData()} part of the result Intent.
3136 */
3137 public static final String EXTRA_ALLOW_MULTIPLE =
3138 "android.intent.extra.ALLOW_MULTIPLE";
3139
3140 /**
Amith Yamasani2a003292012-08-14 18:25:45 -07003141 * The userHandle carried with broadcast intents related to addition, removal and switching of users
Amith Yamasani13593602012-03-22 16:16:17 -07003142 * - {@link #ACTION_USER_ADDED}, {@link #ACTION_USER_REMOVED} and {@link #ACTION_USER_SWITCHED}.
3143 * @hide
3144 */
Amith Yamasani2a003292012-08-14 18:25:45 -07003145 public static final String EXTRA_USER_HANDLE =
3146 "android.intent.extra.user_handle";
Jean-Michel Trivi3114ce32012-06-11 15:03:52 -07003147
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003148 // ---------------------------------------------------------------------
3149 // ---------------------------------------------------------------------
3150 // Intent flags (see mFlags variable).
3151
3152 /**
3153 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003154 * perform read operations on the Uri in the Intent's data and any URIs
3155 * specified in its ClipData. When applying to an Intent's ClipData,
3156 * all URIs as well as recursive traversals through data or other ClipData
3157 * in Intent items will be granted; only the grant flags of the top-level
3158 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003159 */
3160 public static final int FLAG_GRANT_READ_URI_PERMISSION = 0x00000001;
3161 /**
3162 * If set, the recipient of this Intent will be granted permission to
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003163 * perform write operations on the Uri in the Intent's data and any URIs
3164 * specified in its ClipData. When applying to an Intent's ClipData,
3165 * all URIs as well as recursive traversals through data or other ClipData
3166 * in Intent items will be granted; only the grant flags of the top-level
3167 * Intent are used.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003168 */
3169 public static final int FLAG_GRANT_WRITE_URI_PERMISSION = 0x00000002;
3170 /**
3171 * Can be set by the caller to indicate that this Intent is coming from
3172 * a background operation, not from direct user interaction.
3173 */
3174 public static final int FLAG_FROM_BACKGROUND = 0x00000004;
3175 /**
3176 * A flag you can enable for debugging: when set, log messages will be
3177 * printed during the resolution of this intent to show you what has
3178 * been found to create the final resolved list.
3179 */
3180 public static final int FLAG_DEBUG_LOG_RESOLUTION = 0x00000008;
Dianne Hackborne7f97212011-02-24 14:40:20 -08003181 /**
3182 * If set, this intent will not match any components in packages that
3183 * are currently stopped. If this is not set, then the default behavior
3184 * is to include such applications in the result.
3185 */
3186 public static final int FLAG_EXCLUDE_STOPPED_PACKAGES = 0x00000010;
3187 /**
3188 * If set, this intent will always match any components in packages that
3189 * are currently stopped. This is the default behavior when
3190 * {@link #FLAG_EXCLUDE_STOPPED_PACKAGES} is not set. If both of these
3191 * flags are set, this one wins (it allows overriding of exclude for
3192 * places where the framework may automatically set the exclude flag).
3193 */
3194 public static final int FLAG_INCLUDE_STOPPED_PACKAGES = 0x00000020;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003195
3196 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003197 * If set, the new activity is not kept in the history stack. As soon as
3198 * the user navigates away from it, the activity is finished. This may also
3199 * be set with the {@link android.R.styleable#AndroidManifestActivity_noHistory
3200 * noHistory} attribute.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003201 */
3202 public static final int FLAG_ACTIVITY_NO_HISTORY = 0x40000000;
3203 /**
3204 * If set, the activity will not be launched if it is already running
3205 * at the top of the history stack.
3206 */
3207 public static final int FLAG_ACTIVITY_SINGLE_TOP = 0x20000000;
3208 /**
3209 * If set, this activity will become the start of a new task on this
3210 * history stack. A task (from the activity that started it to the
3211 * next task activity) defines an atomic group of activities that the
3212 * user can move to. Tasks can be moved to the foreground and background;
3213 * all of the activities inside of a particular task always remain in
The Android Open Source Project10592532009-03-18 17:39:46 -07003214 * the same order. See
Scott Main7aee61f2011-02-08 11:25:01 -08003215 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3216 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003217 *
3218 * <p>This flag is generally used by activities that want
3219 * to present a "launcher" style behavior: they give the user a list of
3220 * separate things that can be done, which otherwise run completely
3221 * independently of the activity launching them.
3222 *
3223 * <p>When using this flag, if a task is already running for the activity
3224 * you are now starting, then a new activity will not be started; instead,
3225 * the current task will simply be brought to the front of the screen with
3226 * the state it was last in. See {@link #FLAG_ACTIVITY_MULTIPLE_TASK} for a flag
3227 * to disable this behavior.
3228 *
3229 * <p>This flag can not be used when the caller is requesting a result from
3230 * the activity being launched.
3231 */
3232 public static final int FLAG_ACTIVITY_NEW_TASK = 0x10000000;
3233 /**
3234 * <strong>Do not use this flag unless you are implementing your own
3235 * top-level application launcher.</strong> Used in conjunction with
3236 * {@link #FLAG_ACTIVITY_NEW_TASK} to disable the
3237 * behavior of bringing an existing task to the foreground. When set,
3238 * a new task is <em>always</em> started to host the Activity for the
3239 * Intent, regardless of whether there is already an existing task running
3240 * the same thing.
3241 *
3242 * <p><strong>Because the default system does not include graphical task management,
3243 * you should not use this flag unless you provide some way for a user to
3244 * return back to the tasks you have launched.</strong>
The Android Open Source Project10592532009-03-18 17:39:46 -07003245 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003246 * <p>This flag is ignored if
3247 * {@link #FLAG_ACTIVITY_NEW_TASK} is not set.
3248 *
Scott Main7aee61f2011-02-08 11:25:01 -08003249 * <p>See
3250 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3251 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003252 */
3253 public static final int FLAG_ACTIVITY_MULTIPLE_TASK = 0x08000000;
3254 /**
3255 * If set, and the activity being launched is already running in the
3256 * current task, then instead of launching a new instance of that activity,
3257 * all of the other activities on top of it will be closed and this Intent
3258 * will be delivered to the (now on top) old activity as a new Intent.
3259 *
3260 * <p>For example, consider a task consisting of the activities: A, B, C, D.
3261 * If D calls startActivity() with an Intent that resolves to the component
3262 * of activity B, then C and D will be finished and B receive the given
3263 * Intent, resulting in the stack now being: A, B.
3264 *
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003265 * <p>The currently running instance of activity B in the above example will
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003266 * either receive the new intent you are starting here in its
3267 * onNewIntent() method, or be itself finished and restarted with the
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003268 * new intent. If it has declared its launch mode to be "multiple" (the
Dianne Hackbornaa52f9a2009-08-25 16:01:15 -07003269 * default) and you have not set {@link #FLAG_ACTIVITY_SINGLE_TOP} in
3270 * the same intent, then it will be finished and re-created; for all other
3271 * launch modes or if {@link #FLAG_ACTIVITY_SINGLE_TOP} is set then this
3272 * Intent will be delivered to the current instance's onNewIntent().
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003273 *
3274 * <p>This launch mode can also be used to good effect in conjunction with
3275 * {@link #FLAG_ACTIVITY_NEW_TASK}: if used to start the root activity
3276 * of a task, it will bring any currently running instance of that task
3277 * to the foreground, and then clear it to its root state. This is
3278 * especially useful, for example, when launching an activity from the
3279 * notification manager.
3280 *
Scott Main7aee61f2011-02-08 11:25:01 -08003281 * <p>See
3282 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
3283 * Stack</a> for more information about tasks.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003284 */
3285 public static final int FLAG_ACTIVITY_CLEAR_TOP = 0x04000000;
3286 /**
3287 * If set and this intent is being used to launch a new activity from an
3288 * existing one, then the reply target of the existing activity will be
3289 * transfered to the new activity. This way the new activity can call
3290 * {@link android.app.Activity#setResult} and have that result sent back to
3291 * the reply target of the original activity.
3292 */
3293 public static final int FLAG_ACTIVITY_FORWARD_RESULT = 0x02000000;
3294 /**
3295 * If set and this intent is being used to launch a new activity from an
3296 * existing one, the current activity will not be counted as the top
3297 * activity for deciding whether the new intent should be delivered to
3298 * the top instead of starting a new one. The previous activity will
3299 * be used as the top, with the assumption being that the current activity
3300 * will finish itself immediately.
3301 */
3302 public static final int FLAG_ACTIVITY_PREVIOUS_IS_TOP = 0x01000000;
3303 /**
3304 * If set, the new activity is not kept in the list of recently launched
3305 * activities.
3306 */
3307 public static final int FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS = 0x00800000;
3308 /**
3309 * This flag is not normally set by application code, but set for you by
3310 * the system as described in the
3311 * {@link android.R.styleable#AndroidManifestActivity_launchMode
3312 * launchMode} documentation for the singleTask mode.
3313 */
3314 public static final int FLAG_ACTIVITY_BROUGHT_TO_FRONT = 0x00400000;
3315 /**
3316 * If set, and this activity is either being started in a new task or
3317 * bringing to the top an existing task, then it will be launched as
3318 * the front door of the task. This will result in the application of
3319 * any affinities needed to have that task in the proper state (either
3320 * moving activities to or from it), or simply resetting that task to
3321 * its initial state if needed.
3322 */
3323 public static final int FLAG_ACTIVITY_RESET_TASK_IF_NEEDED = 0x00200000;
3324 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003325 * This flag is not normally set by application code, but set for you by
3326 * the system if this activity is being launched from history
3327 * (longpress home key).
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003328 */
3329 public static final int FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY = 0x00100000;
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003330 /**
3331 * If set, this marks a point in the task's activity stack that should
3332 * be cleared when the task is reset. That is, the next time the task
Marco Nelissenc53fc4e2009-05-11 12:15:31 -07003333 * is brought to the foreground with
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003334 * {@link #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED} (typically as a result of
3335 * the user re-launching it from home), this activity and all on top of
3336 * it will be finished so that the user does not return to them, but
3337 * instead returns to whatever activity preceeded it.
The Android Open Source Project10592532009-03-18 17:39:46 -07003338 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08003339 * <p>This is useful for cases where you have a logical break in your
3340 * application. For example, an e-mail application may have a command
3341 * to view an attachment, which launches an image view activity to
3342 * display it. This activity should be part of the e-mail application's
3343 * task, since it is a part of the task the user is involved in. However,
3344 * if the user leaves that task, and later selects the e-mail app from
3345 * home, we may like them to return to the conversation they were
3346 * viewing, not the picture attachment, since that is confusing. By
3347 * setting this flag when launching the image viewer, that viewer and
3348 * any activities it starts will be removed the next time the user returns
3349 * to mail.
3350 */
3351 public static final int FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET = 0x00080000;
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003352 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003353 * If set, this flag will prevent the normal {@link android.app.Activity#onUserLeaveHint}
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003354 * callback from occurring on the current frontmost activity before it is
3355 * paused as the newly-started activity is brought to the front.
The Android Open Source Project10592532009-03-18 17:39:46 -07003356 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003357 * <p>Typically, an activity can rely on that callback to indicate that an
3358 * explicit user action has caused their activity to be moved out of the
3359 * foreground. The callback marks an appropriate point in the activity's
3360 * lifecycle for it to dismiss any notifications that it intends to display
3361 * "until the user has seen them," such as a blinking LED.
The Android Open Source Project10592532009-03-18 17:39:46 -07003362 *
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003363 * <p>If an activity is ever started via any non-user-driven events such as
3364 * phone-call receipt or an alarm handler, this flag should be passed to {@link
3365 * Context#startActivity Context.startActivity}, ensuring that the pausing
The Android Open Source Project10592532009-03-18 17:39:46 -07003366 * activity does not think the user has acknowledged its notification.
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08003367 */
3368 public static final int FLAG_ACTIVITY_NO_USER_ACTION = 0x00040000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003369 /**
3370 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3371 * this flag will cause the launched activity to be brought to the front of its
3372 * task's history stack if it is already running.
The Android Open Source Project10592532009-03-18 17:39:46 -07003373 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003374 * <p>For example, consider a task consisting of four activities: A, B, C, D.
3375 * If D calls startActivity() with an Intent that resolves to the component
3376 * of activity B, then B will be brought to the front of the history stack,
3377 * with this resulting order: A, C, D, B.
The Android Open Source Project10592532009-03-18 17:39:46 -07003378 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003379 * This flag will be ignored if {@link #FLAG_ACTIVITY_CLEAR_TOP} is also
The Android Open Source Project10592532009-03-18 17:39:46 -07003380 * specified.
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003381 */
3382 public static final int FLAG_ACTIVITY_REORDER_TO_FRONT = 0X00020000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003383 /**
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003384 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3385 * this flag will prevent the system from applying an activity transition
3386 * animation to go to the next activity state. This doesn't mean an
3387 * animation will never run -- if another activity change happens that doesn't
3388 * specify this flag before the activity started here is displayed, then
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003389 * that transition will be used. This flag can be put to good use
Dianne Hackbornbfe319e2009-09-21 00:34:05 -07003390 * when you are going to do a series of activity operations but the
3391 * animation seen by the user shouldn't be driven by the first activity
3392 * change but rather a later one.
3393 */
3394 public static final int FLAG_ACTIVITY_NO_ANIMATION = 0X00010000;
3395 /**
Dianne Hackborn621e17d2010-11-22 15:59:56 -08003396 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3397 * this flag will cause any existing task that would be associated with the
3398 * activity to be cleared before the activity is started. That is, the activity
3399 * becomes the new root of an otherwise empty task, and any old activities
3400 * are finished. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3401 */
3402 public static final int FLAG_ACTIVITY_CLEAR_TASK = 0X00008000;
3403 /**
3404 * If set in an Intent passed to {@link Context#startActivity Context.startActivity()},
3405 * this flag will cause a newly launching task to be placed on top of the current
3406 * home activity task (if there is one). That is, pressing back from the task
3407 * will always return the user to home even if that was not the last activity they
3408 * saw. This can only be used in conjunction with {@link #FLAG_ACTIVITY_NEW_TASK}.
3409 */
3410 public static final int FLAG_ACTIVITY_TASK_ON_HOME = 0X00004000;
3411 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003412 * If set, when sending a broadcast only registered receivers will be
3413 * called -- no BroadcastReceiver components will be launched.
3414 */
3415 public static final int FLAG_RECEIVER_REGISTERED_ONLY = 0x40000000;
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003416 /**
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003417 * If set, when sending a broadcast the new broadcast will replace
3418 * any existing pending broadcast that matches it. Matching is defined
3419 * by {@link Intent#filterEquals(Intent) Intent.filterEquals} returning
3420 * true for the intents of the two broadcasts. When a match is found,
3421 * the new broadcast (and receivers associated with it) will replace the
3422 * existing one in the pending broadcast list, remaining at the same
3423 * position in the list.
Tom Taylord4a47292009-12-21 13:59:18 -08003424 *
Dianne Hackborn1c633fc2009-12-08 19:45:14 -08003425 * <p>This flag is most typically used with sticky broadcasts, which
3426 * only care about delivering the most recent values of the broadcast
3427 * to their receivers.
3428 */
3429 public static final int FLAG_RECEIVER_REPLACE_PENDING = 0x20000000;
3430 /**
Christopher Tatef46723b2012-01-26 14:19:24 -08003431 * If set, when sending a broadcast the recipient is allowed to run at
3432 * foreground priority, with a shorter timeout interval. During normal
3433 * broadcasts the receivers are not automatically hoisted out of the
3434 * background priority class.
3435 */
3436 public static final int FLAG_RECEIVER_FOREGROUND = 0x10000000;
3437 /**
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003438 * If set, when sending a broadcast <i>before boot has completed</i> only
3439 * registered receivers will be called -- no BroadcastReceiver components
3440 * will be launched. Sticky intent state will be recorded properly even
3441 * if no receivers wind up being called. If {@link #FLAG_RECEIVER_REGISTERED_ONLY}
3442 * is specified in the broadcast intent, this flag is unnecessary.
The Android Open Source Project10592532009-03-18 17:39:46 -07003443 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003444 * <p>This flag is only for use by system sevices as a convenience to
3445 * avoid having to implement a more complex mechanism around detection
3446 * of boot completion.
The Android Open Source Project10592532009-03-18 17:39:46 -07003447 *
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08003448 * @hide
3449 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003450 public static final int FLAG_RECEIVER_REGISTERED_ONLY_BEFORE_BOOT = 0x08000000;
Dianne Hackborn9acc0302009-08-25 00:27:12 -07003451 /**
3452 * Set when this broadcast is for a boot upgrade, a special mode that
3453 * allows the broadcast to be sent before the system is ready and launches
3454 * the app process with no providers running in it.
3455 * @hide
3456 */
Christopher Tatef46723b2012-01-26 14:19:24 -08003457 public static final int FLAG_RECEIVER_BOOT_UPGRADE = 0x04000000;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003458
Dianne Hackbornfa82f222009-09-17 15:14:12 -07003459 /**
3460 * @hide Flags that can't be changed with PendingIntent.
3461 */
3462 public static final int IMMUTABLE_FLAGS =
3463 FLAG_GRANT_READ_URI_PERMISSION
3464 | FLAG_GRANT_WRITE_URI_PERMISSION;
Tom Taylord4a47292009-12-21 13:59:18 -08003465
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003466 // ---------------------------------------------------------------------
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003467 // ---------------------------------------------------------------------
3468 // toUri() and parseUri() options.
3469
3470 /**
3471 * Flag for use with {@link #toUri} and {@link #parseUri}: the URI string
3472 * always has the "intent:" scheme. This syntax can be used when you want
3473 * to later disambiguate between URIs that are intended to describe an
3474 * Intent vs. all others that should be treated as raw URIs. When used
3475 * with {@link #parseUri}, any other scheme will result in a generic
3476 * VIEW action for that raw URI.
3477 */
3478 public static final int URI_INTENT_SCHEME = 1<<0;
Tom Taylord4a47292009-12-21 13:59:18 -08003479
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003480 // ---------------------------------------------------------------------
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003481
3482 private String mAction;
3483 private Uri mData;
3484 private String mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003485 private String mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003486 private ComponentName mComponent;
3487 private int mFlags;
3488 private HashSet<String> mCategories;
3489 private Bundle mExtras;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003490 private Rect mSourceBounds;
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003491 private Intent mSelector;
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003492 private ClipData mClipData;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003493
3494 // ---------------------------------------------------------------------
3495
3496 /**
3497 * Create an empty intent.
3498 */
3499 public Intent() {
3500 }
3501
3502 /**
3503 * Copy constructor.
3504 */
3505 public Intent(Intent o) {
3506 this.mAction = o.mAction;
3507 this.mData = o.mData;
3508 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003509 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003510 this.mComponent = o.mComponent;
3511 this.mFlags = o.mFlags;
3512 if (o.mCategories != null) {
3513 this.mCategories = new HashSet<String>(o.mCategories);
3514 }
3515 if (o.mExtras != null) {
3516 this.mExtras = new Bundle(o.mExtras);
3517 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003518 if (o.mSourceBounds != null) {
3519 this.mSourceBounds = new Rect(o.mSourceBounds);
3520 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003521 if (o.mSelector != null) {
3522 this.mSelector = new Intent(o.mSelector);
3523 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08003524 if (o.mClipData != null) {
3525 this.mClipData = new ClipData(o.mClipData);
3526 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003527 }
3528
3529 @Override
3530 public Object clone() {
3531 return new Intent(this);
3532 }
3533
3534 private Intent(Intent o, boolean all) {
3535 this.mAction = o.mAction;
3536 this.mData = o.mData;
3537 this.mType = o.mType;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003538 this.mPackage = o.mPackage;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003539 this.mComponent = o.mComponent;
3540 if (o.mCategories != null) {
3541 this.mCategories = new HashSet<String>(o.mCategories);
3542 }
3543 }
3544
3545 /**
3546 * Make a clone of only the parts of the Intent that are relevant for
3547 * filter matching: the action, data, type, component, and categories.
3548 */
3549 public Intent cloneFilter() {
3550 return new Intent(this, false);
3551 }
3552
3553 /**
3554 * Create an intent with a given action. All other fields (data, type,
3555 * class) are null. Note that the action <em>must</em> be in a
3556 * namespace because Intents are used globally in the system -- for
3557 * example the system VIEW action is android.intent.action.VIEW; an
3558 * application's custom action would be something like
3559 * com.google.app.myapp.CUSTOM_ACTION.
3560 *
3561 * @param action The Intent action, such as ACTION_VIEW.
3562 */
3563 public Intent(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003564 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003565 }
3566
3567 /**
3568 * Create an intent with a given action and for a given data url. Note
3569 * that the action <em>must</em> be in a namespace because Intents are
3570 * used globally in the system -- for example the system VIEW action is
3571 * android.intent.action.VIEW; an application's custom action would be
3572 * something like com.google.app.myapp.CUSTOM_ACTION.
3573 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003574 * <p><em>Note: scheme and host name matching in the Android framework is
3575 * case-sensitive, unlike the formal RFC. As a result,
3576 * you should always ensure that you write your Uri with these elements
3577 * using lower case letters, and normalize any Uris you receive from
3578 * outside of Android to ensure the scheme and host is lower case.</em></p>
3579 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003580 * @param action The Intent action, such as ACTION_VIEW.
3581 * @param uri The Intent data URI.
3582 */
3583 public Intent(String action, Uri uri) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003584 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003585 mData = uri;
3586 }
3587
3588 /**
3589 * Create an intent for a specific component. All other fields (action, data,
3590 * type, class) are null, though they can be modified later with explicit
3591 * calls. This provides a convenient way to create an intent that is
3592 * intended to execute a hard-coded class name, rather than relying on the
3593 * system to find an appropriate class for you; see {@link #setComponent}
3594 * for more information on the repercussions of this.
3595 *
3596 * @param packageContext A Context of the application package implementing
3597 * this class.
3598 * @param cls The component class that is to be used for the intent.
3599 *
3600 * @see #setClass
3601 * @see #setComponent
3602 * @see #Intent(String, android.net.Uri , Context, Class)
3603 */
3604 public Intent(Context packageContext, Class<?> cls) {
3605 mComponent = new ComponentName(packageContext, cls);
3606 }
3607
3608 /**
3609 * Create an intent for a specific component with a specified action and data.
3610 * This is equivalent using {@link #Intent(String, android.net.Uri)} to
3611 * construct the Intent and then calling {@link #setClass} to set its
3612 * class.
3613 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07003614 * <p><em>Note: scheme and host name matching in the Android framework is
3615 * case-sensitive, unlike the formal RFC. As a result,
3616 * you should always ensure that you write your Uri with these elements
3617 * using lower case letters, and normalize any Uris you receive from
3618 * outside of Android to ensure the scheme and host is lower case.</em></p>
3619 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003620 * @param action The Intent action, such as ACTION_VIEW.
3621 * @param uri The Intent data URI.
3622 * @param packageContext A Context of the application package implementing
3623 * this class.
3624 * @param cls The component class that is to be used for the intent.
3625 *
3626 * @see #Intent(String, android.net.Uri)
3627 * @see #Intent(Context, Class)
3628 * @see #setClass
3629 * @see #setComponent
3630 */
3631 public Intent(String action, Uri uri,
3632 Context packageContext, Class<?> cls) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003633 setAction(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003634 mData = uri;
3635 mComponent = new ComponentName(packageContext, cls);
3636 }
3637
3638 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003639 * Create an intent to launch the main (root) activity of a task. This
3640 * is the Intent that is started when the application's is launched from
3641 * Home. For anything else that wants to launch an application in the
3642 * same way, it is important that they use an Intent structured the same
3643 * way, and can use this function to ensure this is the case.
3644 *
3645 * <p>The returned Intent has the given Activity component as its explicit
3646 * component, {@link #ACTION_MAIN} as its action, and includes the
3647 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3648 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3649 * to do that through {@link #addFlags(int)} on the returned Intent.
3650 *
3651 * @param mainActivity The main activity component that this Intent will
3652 * launch.
3653 * @return Returns a newly created Intent that can be used to launch the
3654 * activity as a main application entry.
3655 *
3656 * @see #setClass
3657 * @see #setComponent
3658 */
3659 public static Intent makeMainActivity(ComponentName mainActivity) {
3660 Intent intent = new Intent(ACTION_MAIN);
3661 intent.setComponent(mainActivity);
3662 intent.addCategory(CATEGORY_LAUNCHER);
3663 return intent;
3664 }
3665
3666 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003667 * Make an Intent for the main activity of an application, without
3668 * specifying a specific activity to run but giving a selector to find
3669 * the activity. This results in a final Intent that is structured
3670 * the same as when the application is launched from
3671 * Home. For anything else that wants to launch an application in the
3672 * same way, it is important that they use an Intent structured the same
3673 * way, and can use this function to ensure this is the case.
3674 *
3675 * <p>The returned Intent has {@link #ACTION_MAIN} as its action, and includes the
3676 * category {@link #CATEGORY_LAUNCHER}. This does <em>not</em> have
3677 * {@link #FLAG_ACTIVITY_NEW_TASK} set, though typically you will want
3678 * to do that through {@link #addFlags(int)} on the returned Intent.
3679 *
3680 * @param selectorAction The action name of the Intent's selector.
3681 * @param selectorCategory The name of a category to add to the Intent's
3682 * selector.
3683 * @return Returns a newly created Intent that can be used to launch the
3684 * activity as a main application entry.
3685 *
3686 * @see #setSelector(Intent)
3687 */
3688 public static Intent makeMainSelectorActivity(String selectorAction,
3689 String selectorCategory) {
3690 Intent intent = new Intent(ACTION_MAIN);
3691 intent.addCategory(CATEGORY_LAUNCHER);
3692 Intent selector = new Intent();
3693 selector.setAction(selectorAction);
3694 selector.addCategory(selectorCategory);
3695 intent.setSelector(selector);
3696 return intent;
3697 }
3698
3699 /**
Dianne Hackborn30d71892010-12-11 10:37:55 -08003700 * Make an Intent that can be used to re-launch an application's task
3701 * in its base state. This is like {@link #makeMainActivity(ComponentName)},
3702 * but also sets the flags {@link #FLAG_ACTIVITY_NEW_TASK} and
3703 * {@link #FLAG_ACTIVITY_CLEAR_TASK}.
3704 *
3705 * @param mainActivity The activity component that is the root of the
3706 * task; this is the activity that has been published in the application's
3707 * manifest as the main launcher icon.
3708 *
3709 * @return Returns a newly created Intent that can be used to relaunch the
3710 * activity's task in its root state.
3711 */
3712 public static Intent makeRestartActivityTask(ComponentName mainActivity) {
3713 Intent intent = makeMainActivity(mainActivity);
3714 intent.addFlags(Intent.FLAG_ACTIVITY_NEW_TASK
3715 | Intent.FLAG_ACTIVITY_CLEAR_TASK);
3716 return intent;
3717 }
3718
3719 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003720 * Call {@link #parseUri} with 0 flags.
3721 * @deprecated Use {@link #parseUri} instead.
3722 */
3723 @Deprecated
3724 public static Intent getIntent(String uri) throws URISyntaxException {
3725 return parseUri(uri, 0);
3726 }
Tom Taylord4a47292009-12-21 13:59:18 -08003727
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003728 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003729 * Create an intent from a URI. This URI may encode the action,
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003730 * category, and other intent fields, if it was returned by
Dianne Hackborn7f205432009-07-28 00:13:47 -07003731 * {@link #toUri}. If the Intent was not generate by toUri(), its data
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003732 * will be the entire URI and its action will be ACTION_VIEW.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003733 *
3734 * <p>The URI given here must not be relative -- that is, it must include
3735 * the scheme and full path.
3736 *
3737 * @param uri The URI to turn into an Intent.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003738 * @param flags Additional processing flags. Either 0 or
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003739 * {@link #URI_INTENT_SCHEME}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003740 *
3741 * @return Intent The newly created Intent object.
3742 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003743 * @throws URISyntaxException Throws URISyntaxError if the basic URI syntax
3744 * it bad (as parsed by the Uri class) or the Intent data within the
3745 * URI is invalid.
Tom Taylord4a47292009-12-21 13:59:18 -08003746 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003747 * @see #toUri
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003748 */
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003749 public static Intent parseUri(String uri, int flags) throws URISyntaxException {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003750 int i = 0;
3751 try {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003752 // Validate intent scheme for if requested.
3753 if ((flags&URI_INTENT_SCHEME) != 0) {
3754 if (!uri.startsWith("intent:")) {
3755 Intent intent = new Intent(ACTION_VIEW);
3756 try {
3757 intent.setData(Uri.parse(uri));
3758 } catch (IllegalArgumentException e) {
3759 throw new URISyntaxException(uri, e.getMessage());
3760 }
3761 return intent;
3762 }
3763 }
Tom Taylord4a47292009-12-21 13:59:18 -08003764
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003765 // simple case
3766 i = uri.lastIndexOf("#");
3767 if (i == -1) return new Intent(ACTION_VIEW, Uri.parse(uri));
3768
3769 // old format Intent URI
3770 if (!uri.startsWith("#Intent;", i)) return getIntentOld(uri);
The Android Open Source Project10592532009-03-18 17:39:46 -07003771
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003772 // new format
3773 Intent intent = new Intent(ACTION_VIEW);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003774 Intent baseIntent = intent;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003775
3776 // fetch data part, if present
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003777 String data = i >= 0 ? uri.substring(0, i) : null;
3778 String scheme = null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003779 i += "#Intent;".length();
The Android Open Source Project10592532009-03-18 17:39:46 -07003780
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003781 // loop over contents of Intent, all name=value;
3782 while (!uri.startsWith("end", i)) {
3783 int eq = uri.indexOf('=', i);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003784 if (eq < 0) eq = i-1;
3785 int semi = uri.indexOf(';', i);
3786 String value = eq < semi ? Uri.decode(uri.substring(eq + 1, semi)) : "";
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003787
3788 // action
3789 if (uri.startsWith("action=", i)) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08003790 intent.setAction(value);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003791 }
3792
3793 // categories
3794 else if (uri.startsWith("category=", i)) {
3795 intent.addCategory(value);
3796 }
3797
3798 // type
3799 else if (uri.startsWith("type=", i)) {
3800 intent.mType = value;
3801 }
3802
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003803 // launch flags
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003804 else if (uri.startsWith("launchFlags=", i)) {
3805 intent.mFlags = Integer.decode(value).intValue();
3806 }
3807
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003808 // package
3809 else if (uri.startsWith("package=", i)) {
3810 intent.mPackage = value;
3811 }
3812
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003813 // component
3814 else if (uri.startsWith("component=", i)) {
3815 intent.mComponent = ComponentName.unflattenFromString(value);
3816 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003817
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003818 // scheme
3819 else if (uri.startsWith("scheme=", i)) {
3820 scheme = value;
3821 }
3822
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08003823 // source bounds
3824 else if (uri.startsWith("sourceBounds=", i)) {
3825 intent.mSourceBounds = Rect.unflattenFromString(value);
3826 }
3827
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003828 // selector
3829 else if (semi == (i+3) && uri.startsWith("SEL", i)) {
3830 intent = new Intent();
3831 }
3832
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003833 // extra
3834 else {
3835 String key = Uri.decode(uri.substring(i + 2, eq));
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003836 // create Bundle if it doesn't already exist
3837 if (intent.mExtras == null) intent.mExtras = new Bundle();
3838 Bundle b = intent.mExtras;
3839 // add EXTRA
3840 if (uri.startsWith("S.", i)) b.putString(key, value);
3841 else if (uri.startsWith("B.", i)) b.putBoolean(key, Boolean.parseBoolean(value));
3842 else if (uri.startsWith("b.", i)) b.putByte(key, Byte.parseByte(value));
3843 else if (uri.startsWith("c.", i)) b.putChar(key, value.charAt(0));
3844 else if (uri.startsWith("d.", i)) b.putDouble(key, Double.parseDouble(value));
3845 else if (uri.startsWith("f.", i)) b.putFloat(key, Float.parseFloat(value));
3846 else if (uri.startsWith("i.", i)) b.putInt(key, Integer.parseInt(value));
3847 else if (uri.startsWith("l.", i)) b.putLong(key, Long.parseLong(value));
3848 else if (uri.startsWith("s.", i)) b.putShort(key, Short.parseShort(value));
3849 else throw new URISyntaxException(uri, "unknown EXTRA type", i);
3850 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003851
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003852 // move to the next item
3853 i = semi + 1;
3854 }
3855
Dianne Hackbornf5b86712011-12-05 17:42:41 -08003856 if (intent != baseIntent) {
3857 // The Intent had a selector; fix it up.
3858 baseIntent.setSelector(intent);
3859 intent = baseIntent;
3860 }
3861
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003862 if (data != null) {
3863 if (data.startsWith("intent:")) {
3864 data = data.substring(7);
3865 if (scheme != null) {
3866 data = scheme + ':' + data;
3867 }
3868 }
Tom Taylord4a47292009-12-21 13:59:18 -08003869
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07003870 if (data.length() > 0) {
3871 try {
3872 intent.mData = Uri.parse(data);
3873 } catch (IllegalArgumentException e) {
3874 throw new URISyntaxException(uri, e.getMessage());
3875 }
3876 }
3877 }
Tom Taylord4a47292009-12-21 13:59:18 -08003878
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003879 return intent;
The Android Open Source Project10592532009-03-18 17:39:46 -07003880
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003881 } catch (IndexOutOfBoundsException e) {
3882 throw new URISyntaxException(uri, "illegal Intent URI format", i);
3883 }
3884 }
The Android Open Source Project10592532009-03-18 17:39:46 -07003885
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003886 public static Intent getIntentOld(String uri) throws URISyntaxException {
3887 Intent intent;
3888
3889 int i = uri.lastIndexOf('#');
3890 if (i >= 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003891 String action = null;
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003892 final int intentFragmentStart = i;
3893 boolean isIntentFragment = false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003894
3895 i++;
3896
3897 if (uri.regionMatches(i, "action(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003898 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003899 i += 7;
3900 int j = uri.indexOf(')', i);
3901 action = uri.substring(i, j);
3902 i = j + 1;
3903 }
3904
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003905 intent = new Intent(action);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003906
3907 if (uri.regionMatches(i, "categories(", 0, 11)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003908 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003909 i += 11;
3910 int j = uri.indexOf(')', i);
3911 while (i < j) {
3912 int sep = uri.indexOf('!', i);
3913 if (sep < 0) sep = j;
3914 if (i < sep) {
3915 intent.addCategory(uri.substring(i, sep));
3916 }
3917 i = sep + 1;
3918 }
3919 i = j + 1;
3920 }
3921
3922 if (uri.regionMatches(i, "type(", 0, 5)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003923 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003924 i += 5;
3925 int j = uri.indexOf(')', i);
3926 intent.mType = uri.substring(i, j);
3927 i = j + 1;
3928 }
3929
3930 if (uri.regionMatches(i, "launchFlags(", 0, 12)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003931 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003932 i += 12;
3933 int j = uri.indexOf(')', i);
3934 intent.mFlags = Integer.decode(uri.substring(i, j)).intValue();
3935 i = j + 1;
3936 }
3937
3938 if (uri.regionMatches(i, "component(", 0, 10)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003939 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003940 i += 10;
3941 int j = uri.indexOf(')', i);
3942 int sep = uri.indexOf('!', i);
3943 if (sep >= 0 && sep < j) {
3944 String pkg = uri.substring(i, sep);
3945 String cls = uri.substring(sep + 1, j);
3946 intent.mComponent = new ComponentName(pkg, cls);
3947 }
3948 i = j + 1;
3949 }
3950
3951 if (uri.regionMatches(i, "extras(", 0, 7)) {
Dianne Hackborn6cca1592009-09-20 12:40:03 -07003952 isIntentFragment = true;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003953 i += 7;
The Android Open Source Project10592532009-03-18 17:39:46 -07003954
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003955 final int closeParen = uri.indexOf(')', i);
3956 if (closeParen == -1) throw new URISyntaxException(uri,
3957 "EXTRA missing trailing ')'", i);
3958
3959 while (i < closeParen) {
3960 // fetch the key value
3961 int j = uri.indexOf('=', i);
3962 if (j <= i + 1 || i >= closeParen) {
3963 throw new URISyntaxException(uri, "EXTRA missing '='", i);
3964 }
3965 char type = uri.charAt(i);
3966 i++;
3967 String key = uri.substring(i, j);
3968 i = j + 1;
The Android Open Source Project10592532009-03-18 17:39:46 -07003969
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003970 // get type-value
3971 j = uri.indexOf('!', i);
3972 if (j == -1 || j >= closeParen) j = closeParen;
3973 if (i >= j) throw new URISyntaxException(uri, "EXTRA missing '!'", i);
3974 String value = uri.substring(i, j);
3975 i = j;
3976
3977 // create Bundle if it doesn't already exist
3978 if (intent.mExtras == null) intent.mExtras = new Bundle();
The Android Open Source Project10592532009-03-18 17:39:46 -07003979
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07003980 // add item to bundle
3981 try {
3982 switch (type) {
3983 case 'S':
3984 intent.mExtras.putString(key, Uri.decode(value));
3985 break;
3986 case 'B':
3987 intent.mExtras.putBoolean(key, Boolean.parseBoolean(value));
3988 break;
3989 case 'b':
3990 intent.mExtras.putByte(key, Byte.parseByte(value));
3991 break;
3992 case 'c':
3993 intent.mExtras.putChar(key, Uri.decode(value).charAt(0));
3994 break;
3995 case 'd':
3996 intent.mExtras.putDouble(key, Double.parseDouble(value));
3997 break;
3998 case 'f':
3999 intent.mExtras.putFloat(key, Float.parseFloat(value));
4000 break;
4001 case 'i':
4002 intent.mExtras.putInt(key, Integer.parseInt(value));
4003 break;
4004 case 'l':
4005 intent.mExtras.putLong(key, Long.parseLong(value));
4006 break;
4007 case 's':
4008 intent.mExtras.putShort(key, Short.parseShort(value));
4009 break;
4010 default:
4011 throw new URISyntaxException(uri, "EXTRA has unknown type", i);
4012 }
4013 } catch (NumberFormatException e) {
4014 throw new URISyntaxException(uri, "EXTRA value can't be parsed", i);
4015 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004016
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004017 char ch = uri.charAt(i);
4018 if (ch == ')') break;
4019 if (ch != '!') throw new URISyntaxException(uri, "EXTRA missing '!'", i);
4020 i++;
4021 }
4022 }
4023
Dianne Hackborn6cca1592009-09-20 12:40:03 -07004024 if (isIntentFragment) {
4025 intent.mData = Uri.parse(uri.substring(0, intentFragmentStart));
4026 } else {
4027 intent.mData = Uri.parse(uri);
4028 }
Tom Taylord4a47292009-12-21 13:59:18 -08004029
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004030 if (intent.mAction == null) {
4031 // By default, if no action is specified, then use VIEW.
4032 intent.mAction = ACTION_VIEW;
4033 }
4034
4035 } else {
4036 intent = new Intent(ACTION_VIEW, Uri.parse(uri));
4037 }
4038
4039 return intent;
4040 }
4041
4042 /**
4043 * Retrieve the general action to be performed, such as
4044 * {@link #ACTION_VIEW}. The action describes the general way the rest of
4045 * the information in the intent should be interpreted -- most importantly,
4046 * what to do with the data returned by {@link #getData}.
4047 *
4048 * @return The action of this intent or null if none is specified.
4049 *
4050 * @see #setAction
4051 */
4052 public String getAction() {
4053 return mAction;
4054 }
4055
4056 /**
4057 * Retrieve data this intent is operating on. This URI specifies the name
4058 * of the data; often it uses the content: scheme, specifying data in a
4059 * content provider. Other schemes may be handled by specific activities,
4060 * such as http: by the web browser.
4061 *
4062 * @return The URI of the data this intent is targeting or null.
4063 *
4064 * @see #getScheme
4065 * @see #setData
4066 */
4067 public Uri getData() {
4068 return mData;
4069 }
4070
4071 /**
4072 * The same as {@link #getData()}, but returns the URI as an encoded
4073 * String.
4074 */
4075 public String getDataString() {
4076 return mData != null ? mData.toString() : null;
4077 }
4078
4079 /**
4080 * Return the scheme portion of the intent's data. If the data is null or
4081 * does not include a scheme, null is returned. Otherwise, the scheme
4082 * prefix without the final ':' is returned, i.e. "http".
4083 *
4084 * <p>This is the same as calling getData().getScheme() (and checking for
4085 * null data).
4086 *
4087 * @return The scheme of this intent.
4088 *
4089 * @see #getData
4090 */
4091 public String getScheme() {
4092 return mData != null ? mData.getScheme() : null;
4093 }
4094
4095 /**
4096 * Retrieve any explicit MIME type included in the intent. This is usually
4097 * null, as the type is determined by the intent data.
4098 *
4099 * @return If a type was manually set, it is returned; else null is
4100 * returned.
4101 *
4102 * @see #resolveType(ContentResolver)
4103 * @see #setType
4104 */
4105 public String getType() {
4106 return mType;
4107 }
4108
4109 /**
4110 * Return the MIME data type of this intent. If the type field is
4111 * explicitly set, that is simply returned. Otherwise, if the data is set,
4112 * the type of that data is returned. If neither fields are set, a null is
4113 * returned.
4114 *
4115 * @return The MIME type of this intent.
4116 *
4117 * @see #getType
4118 * @see #resolveType(ContentResolver)
4119 */
4120 public String resolveType(Context context) {
4121 return resolveType(context.getContentResolver());
4122 }
4123
4124 /**
4125 * Return the MIME data type of this intent. If the type field is
4126 * explicitly set, that is simply returned. Otherwise, if the data is set,
4127 * the type of that data is returned. If neither fields are set, a null is
4128 * returned.
4129 *
4130 * @param resolver A ContentResolver that can be used to determine the MIME
4131 * type of the intent's data.
4132 *
4133 * @return The MIME type of this intent.
4134 *
4135 * @see #getType
4136 * @see #resolveType(Context)
4137 */
4138 public String resolveType(ContentResolver resolver) {
4139 if (mType != null) {
4140 return mType;
4141 }
4142 if (mData != null) {
4143 if ("content".equals(mData.getScheme())) {
4144 return resolver.getType(mData);
4145 }
4146 }
4147 return null;
4148 }
4149
4150 /**
4151 * Return the MIME data type of this intent, only if it will be needed for
4152 * intent resolution. This is not generally useful for application code;
4153 * it is used by the frameworks for communicating with back-end system
4154 * services.
4155 *
4156 * @param resolver A ContentResolver that can be used to determine the MIME
4157 * type of the intent's data.
4158 *
4159 * @return The MIME type of this intent, or null if it is unknown or not
4160 * needed.
4161 */
4162 public String resolveTypeIfNeeded(ContentResolver resolver) {
4163 if (mComponent != null) {
4164 return mType;
4165 }
4166 return resolveType(resolver);
4167 }
4168
4169 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09004170 * Check if a category exists in the intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004171 *
4172 * @param category The category to check.
4173 *
4174 * @return boolean True if the intent contains the category, else false.
4175 *
4176 * @see #getCategories
4177 * @see #addCategory
4178 */
4179 public boolean hasCategory(String category) {
4180 return mCategories != null && mCategories.contains(category);
4181 }
4182
4183 /**
4184 * Return the set of all categories in the intent. If there are no categories,
4185 * returns NULL.
4186 *
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004187 * @return The set of categories you can examine. Do not modify!
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004188 *
4189 * @see #hasCategory
4190 * @see #addCategory
4191 */
4192 public Set<String> getCategories() {
4193 return mCategories;
4194 }
4195
4196 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08004197 * Return the specific selector associated with this Intent. If there is
4198 * none, returns null. See {@link #setSelector} for more information.
4199 *
4200 * @see #setSelector
4201 */
4202 public Intent getSelector() {
4203 return mSelector;
4204 }
4205
4206 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08004207 * Return the {@link ClipData} associated with this Intent. If there is
4208 * none, returns null. See {@link #setClipData} for more information.
4209 *
4210 * @see #setClipData;
4211 */
4212 public ClipData getClipData() {
4213 return mClipData;
4214 }
4215
4216 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004217 * Sets the ClassLoader that will be used when unmarshalling
4218 * any Parcelable values from the extras of this Intent.
4219 *
4220 * @param loader a ClassLoader, or null to use the default loader
4221 * at the time of unmarshalling.
4222 */
4223 public void setExtrasClassLoader(ClassLoader loader) {
4224 if (mExtras != null) {
4225 mExtras.setClassLoader(loader);
4226 }
4227 }
4228
4229 /**
4230 * Returns true if an extra value is associated with the given name.
4231 * @param name the extra's name
4232 * @return true if the given extra is present.
4233 */
4234 public boolean hasExtra(String name) {
4235 return mExtras != null && mExtras.containsKey(name);
4236 }
4237
4238 /**
4239 * Returns true if the Intent's extras contain a parcelled file descriptor.
4240 * @return true if the Intent contains a parcelled file descriptor.
4241 */
4242 public boolean hasFileDescriptors() {
4243 return mExtras != null && mExtras.hasFileDescriptors();
4244 }
The Android Open Source Project10592532009-03-18 17:39:46 -07004245
Dianne Hackborn9ecebbf2011-09-28 23:19:47 -04004246 /** @hide */
4247 public void setAllowFds(boolean allowFds) {
4248 if (mExtras != null) {
4249 mExtras.setAllowFds(allowFds);
4250 }
4251 }
4252
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004253 /**
4254 * Retrieve extended data from the intent.
4255 *
4256 * @param name The name of the desired item.
4257 *
4258 * @return the value of an item that previously added with putExtra()
4259 * or null if none was found.
4260 *
4261 * @deprecated
4262 * @hide
4263 */
4264 @Deprecated
4265 public Object getExtra(String name) {
4266 return getExtra(name, null);
4267 }
4268
4269 /**
4270 * Retrieve extended data from the intent.
4271 *
4272 * @param name The name of the desired item.
4273 * @param defaultValue the value to be returned if no value of the desired
4274 * type is stored with the given name.
4275 *
4276 * @return the value of an item that previously added with putExtra()
4277 * or the default value if none was found.
4278 *
4279 * @see #putExtra(String, boolean)
4280 */
4281 public boolean getBooleanExtra(String name, boolean defaultValue) {
4282 return mExtras == null ? defaultValue :
4283 mExtras.getBoolean(name, defaultValue);
4284 }
4285
4286 /**
4287 * Retrieve extended data from the intent.
4288 *
4289 * @param name The name of the desired item.
4290 * @param defaultValue the value to be returned if no value of the desired
4291 * type is stored with the given name.
4292 *
4293 * @return the value of an item that previously added with putExtra()
4294 * or the default value if none was found.
4295 *
4296 * @see #putExtra(String, byte)
4297 */
4298 public byte getByteExtra(String name, byte defaultValue) {
4299 return mExtras == null ? defaultValue :
4300 mExtras.getByte(name, defaultValue);
4301 }
4302
4303 /**
4304 * Retrieve extended data from the intent.
4305 *
4306 * @param name The name of the desired item.
4307 * @param defaultValue the value to be returned if no value of the desired
4308 * type is stored with the given name.
4309 *
4310 * @return the value of an item that previously added with putExtra()
4311 * or the default value if none was found.
4312 *
4313 * @see #putExtra(String, short)
4314 */
4315 public short getShortExtra(String name, short defaultValue) {
4316 return mExtras == null ? defaultValue :
4317 mExtras.getShort(name, defaultValue);
4318 }
4319
4320 /**
4321 * Retrieve extended data from the intent.
4322 *
4323 * @param name The name of the desired item.
4324 * @param defaultValue the value to be returned if no value of the desired
4325 * type is stored with the given name.
4326 *
4327 * @return the value of an item that previously added with putExtra()
4328 * or the default value if none was found.
4329 *
4330 * @see #putExtra(String, char)
4331 */
4332 public char getCharExtra(String name, char defaultValue) {
4333 return mExtras == null ? defaultValue :
4334 mExtras.getChar(name, defaultValue);
4335 }
4336
4337 /**
4338 * Retrieve extended data from the intent.
4339 *
4340 * @param name The name of the desired item.
4341 * @param defaultValue the value to be returned if no value of the desired
4342 * type is stored with the given name.
4343 *
4344 * @return the value of an item that previously added with putExtra()
4345 * or the default value if none was found.
4346 *
4347 * @see #putExtra(String, int)
4348 */
4349 public int getIntExtra(String name, int defaultValue) {
4350 return mExtras == null ? defaultValue :
4351 mExtras.getInt(name, defaultValue);
4352 }
4353
4354 /**
4355 * Retrieve extended data from the intent.
4356 *
4357 * @param name The name of the desired item.
4358 * @param defaultValue the value to be returned if no value of the desired
4359 * type is stored with the given name.
4360 *
4361 * @return the value of an item that previously added with putExtra()
4362 * or the default value if none was found.
4363 *
4364 * @see #putExtra(String, long)
4365 */
4366 public long getLongExtra(String name, long defaultValue) {
4367 return mExtras == null ? defaultValue :
4368 mExtras.getLong(name, defaultValue);
4369 }
4370
4371 /**
4372 * Retrieve extended data from the intent.
4373 *
4374 * @param name The name of the desired item.
4375 * @param defaultValue the value to be returned if no value of the desired
4376 * type is stored with the given name.
4377 *
4378 * @return the value of an item that previously added with putExtra(),
4379 * or the default value if no such item is present
4380 *
4381 * @see #putExtra(String, float)
4382 */
4383 public float getFloatExtra(String name, float defaultValue) {
4384 return mExtras == null ? defaultValue :
4385 mExtras.getFloat(name, defaultValue);
4386 }
4387
4388 /**
4389 * Retrieve extended data from the intent.
4390 *
4391 * @param name The name of the desired item.
4392 * @param defaultValue the value to be returned if no value of the desired
4393 * type is stored with the given name.
4394 *
4395 * @return the value of an item that previously added with putExtra()
4396 * or the default value if none was found.
4397 *
4398 * @see #putExtra(String, double)
4399 */
4400 public double getDoubleExtra(String name, double defaultValue) {
4401 return mExtras == null ? defaultValue :
4402 mExtras.getDouble(name, defaultValue);
4403 }
4404
4405 /**
4406 * Retrieve extended data from the intent.
4407 *
4408 * @param name The name of the desired item.
4409 *
4410 * @return the value of an item that previously added with putExtra()
4411 * or null if no String value was found.
4412 *
4413 * @see #putExtra(String, String)
4414 */
4415 public String getStringExtra(String name) {
4416 return mExtras == null ? null : mExtras.getString(name);
4417 }
4418
4419 /**
4420 * Retrieve extended data from the intent.
4421 *
4422 * @param name The name of the desired item.
4423 *
4424 * @return the value of an item that previously added with putExtra()
4425 * or null if no CharSequence value was found.
4426 *
4427 * @see #putExtra(String, CharSequence)
4428 */
4429 public CharSequence getCharSequenceExtra(String name) {
4430 return mExtras == null ? null : mExtras.getCharSequence(name);
4431 }
4432
4433 /**
4434 * Retrieve extended data from the intent.
4435 *
4436 * @param name The name of the desired item.
4437 *
4438 * @return the value of an item that previously added with putExtra()
4439 * or null if no Parcelable value was found.
4440 *
4441 * @see #putExtra(String, Parcelable)
4442 */
4443 public <T extends Parcelable> T getParcelableExtra(String name) {
4444 return mExtras == null ? null : mExtras.<T>getParcelable(name);
4445 }
4446
4447 /**
4448 * Retrieve extended data from the intent.
4449 *
4450 * @param name The name of the desired item.
4451 *
4452 * @return the value of an item that previously added with putExtra()
4453 * or null if no Parcelable[] value was found.
4454 *
4455 * @see #putExtra(String, Parcelable[])
4456 */
4457 public Parcelable[] getParcelableArrayExtra(String name) {
4458 return mExtras == null ? null : mExtras.getParcelableArray(name);
4459 }
4460
4461 /**
4462 * Retrieve extended data from the intent.
4463 *
4464 * @param name The name of the desired item.
4465 *
4466 * @return the value of an item that previously added with putExtra()
4467 * or null if no ArrayList<Parcelable> value was found.
4468 *
4469 * @see #putParcelableArrayListExtra(String, ArrayList)
4470 */
4471 public <T extends Parcelable> ArrayList<T> getParcelableArrayListExtra(String name) {
4472 return mExtras == null ? null : mExtras.<T>getParcelableArrayList(name);
4473 }
4474
4475 /**
4476 * Retrieve extended data from the intent.
4477 *
4478 * @param name The name of the desired item.
4479 *
4480 * @return the value of an item that previously added with putExtra()
4481 * or null if no Serializable value was found.
4482 *
4483 * @see #putExtra(String, Serializable)
4484 */
4485 public Serializable getSerializableExtra(String name) {
4486 return mExtras == null ? null : mExtras.getSerializable(name);
4487 }
4488
4489 /**
4490 * Retrieve extended data from the intent.
4491 *
4492 * @param name The name of the desired item.
4493 *
4494 * @return the value of an item that previously added with putExtra()
4495 * or null if no ArrayList<Integer> value was found.
4496 *
4497 * @see #putIntegerArrayListExtra(String, ArrayList)
4498 */
4499 public ArrayList<Integer> getIntegerArrayListExtra(String name) {
4500 return mExtras == null ? null : mExtras.getIntegerArrayList(name);
4501 }
4502
4503 /**
4504 * Retrieve extended data from the intent.
4505 *
4506 * @param name The name of the desired item.
4507 *
4508 * @return the value of an item that previously added with putExtra()
4509 * or null if no ArrayList<String> value was found.
4510 *
4511 * @see #putStringArrayListExtra(String, ArrayList)
4512 */
4513 public ArrayList<String> getStringArrayListExtra(String name) {
4514 return mExtras == null ? null : mExtras.getStringArrayList(name);
4515 }
4516
4517 /**
4518 * Retrieve extended data from the intent.
4519 *
4520 * @param name The name of the desired item.
4521 *
4522 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004523 * or null if no ArrayList<CharSequence> value was found.
4524 *
4525 * @see #putCharSequenceArrayListExtra(String, ArrayList)
4526 */
4527 public ArrayList<CharSequence> getCharSequenceArrayListExtra(String name) {
4528 return mExtras == null ? null : mExtras.getCharSequenceArrayList(name);
4529 }
4530
4531 /**
4532 * Retrieve extended data from the intent.
4533 *
4534 * @param name The name of the desired item.
4535 *
4536 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004537 * or null if no boolean array value was found.
4538 *
4539 * @see #putExtra(String, boolean[])
4540 */
4541 public boolean[] getBooleanArrayExtra(String name) {
4542 return mExtras == null ? null : mExtras.getBooleanArray(name);
4543 }
4544
4545 /**
4546 * Retrieve extended data from the intent.
4547 *
4548 * @param name The name of the desired item.
4549 *
4550 * @return the value of an item that previously added with putExtra()
4551 * or null if no byte array value was found.
4552 *
4553 * @see #putExtra(String, byte[])
4554 */
4555 public byte[] getByteArrayExtra(String name) {
4556 return mExtras == null ? null : mExtras.getByteArray(name);
4557 }
4558
4559 /**
4560 * Retrieve extended data from the intent.
4561 *
4562 * @param name The name of the desired item.
4563 *
4564 * @return the value of an item that previously added with putExtra()
4565 * or null if no short array value was found.
4566 *
4567 * @see #putExtra(String, short[])
4568 */
4569 public short[] getShortArrayExtra(String name) {
4570 return mExtras == null ? null : mExtras.getShortArray(name);
4571 }
4572
4573 /**
4574 * Retrieve extended data from the intent.
4575 *
4576 * @param name The name of the desired item.
4577 *
4578 * @return the value of an item that previously added with putExtra()
4579 * or null if no char array value was found.
4580 *
4581 * @see #putExtra(String, char[])
4582 */
4583 public char[] getCharArrayExtra(String name) {
4584 return mExtras == null ? null : mExtras.getCharArray(name);
4585 }
4586
4587 /**
4588 * Retrieve extended data from the intent.
4589 *
4590 * @param name The name of the desired item.
4591 *
4592 * @return the value of an item that previously added with putExtra()
4593 * or null if no int array value was found.
4594 *
4595 * @see #putExtra(String, int[])
4596 */
4597 public int[] getIntArrayExtra(String name) {
4598 return mExtras == null ? null : mExtras.getIntArray(name);
4599 }
4600
4601 /**
4602 * Retrieve extended data from the intent.
4603 *
4604 * @param name The name of the desired item.
4605 *
4606 * @return the value of an item that previously added with putExtra()
4607 * or null if no long array value was found.
4608 *
4609 * @see #putExtra(String, long[])
4610 */
4611 public long[] getLongArrayExtra(String name) {
4612 return mExtras == null ? null : mExtras.getLongArray(name);
4613 }
4614
4615 /**
4616 * Retrieve extended data from the intent.
4617 *
4618 * @param name The name of the desired item.
4619 *
4620 * @return the value of an item that previously added with putExtra()
4621 * or null if no float array value was found.
4622 *
4623 * @see #putExtra(String, float[])
4624 */
4625 public float[] getFloatArrayExtra(String name) {
4626 return mExtras == null ? null : mExtras.getFloatArray(name);
4627 }
4628
4629 /**
4630 * Retrieve extended data from the intent.
4631 *
4632 * @param name The name of the desired item.
4633 *
4634 * @return the value of an item that previously added with putExtra()
4635 * or null if no double array value was found.
4636 *
4637 * @see #putExtra(String, double[])
4638 */
4639 public double[] getDoubleArrayExtra(String name) {
4640 return mExtras == null ? null : mExtras.getDoubleArray(name);
4641 }
4642
4643 /**
4644 * Retrieve extended data from the intent.
4645 *
4646 * @param name The name of the desired item.
4647 *
4648 * @return the value of an item that previously added with putExtra()
4649 * or null if no String array value was found.
4650 *
4651 * @see #putExtra(String, String[])
4652 */
4653 public String[] getStringArrayExtra(String name) {
4654 return mExtras == null ? null : mExtras.getStringArray(name);
4655 }
4656
4657 /**
4658 * Retrieve extended data from the intent.
4659 *
4660 * @param name The name of the desired item.
4661 *
4662 * @return the value of an item that previously added with putExtra()
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00004663 * or null if no CharSequence array value was found.
4664 *
4665 * @see #putExtra(String, CharSequence[])
4666 */
4667 public CharSequence[] getCharSequenceArrayExtra(String name) {
4668 return mExtras == null ? null : mExtras.getCharSequenceArray(name);
4669 }
4670
4671 /**
4672 * Retrieve extended data from the intent.
4673 *
4674 * @param name The name of the desired item.
4675 *
4676 * @return the value of an item that previously added with putExtra()
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004677 * or null if no Bundle value was found.
4678 *
4679 * @see #putExtra(String, Bundle)
4680 */
4681 public Bundle getBundleExtra(String name) {
4682 return mExtras == null ? null : mExtras.getBundle(name);
4683 }
4684
4685 /**
4686 * Retrieve extended data from the intent.
4687 *
4688 * @param name The name of the desired item.
4689 *
4690 * @return the value of an item that previously added with putExtra()
4691 * or null if no IBinder value was found.
4692 *
4693 * @see #putExtra(String, IBinder)
4694 *
4695 * @deprecated
4696 * @hide
4697 */
4698 @Deprecated
4699 public IBinder getIBinderExtra(String name) {
4700 return mExtras == null ? null : mExtras.getIBinder(name);
4701 }
4702
4703 /**
4704 * Retrieve extended data from the intent.
4705 *
4706 * @param name The name of the desired item.
4707 * @param defaultValue The default value to return in case no item is
4708 * associated with the key 'name'
4709 *
4710 * @return the value of an item that previously added with putExtra()
4711 * or defaultValue if none was found.
4712 *
4713 * @see #putExtra
4714 *
4715 * @deprecated
4716 * @hide
4717 */
4718 @Deprecated
4719 public Object getExtra(String name, Object defaultValue) {
4720 Object result = defaultValue;
4721 if (mExtras != null) {
4722 Object result2 = mExtras.get(name);
4723 if (result2 != null) {
4724 result = result2;
4725 }
4726 }
4727
4728 return result;
4729 }
4730
4731 /**
4732 * Retrieves a map of extended data from the intent.
4733 *
4734 * @return the map of all extras previously added with putExtra(),
4735 * or null if none have been added.
4736 */
4737 public Bundle getExtras() {
4738 return (mExtras != null)
4739 ? new Bundle(mExtras)
4740 : null;
4741 }
4742
4743 /**
4744 * Retrieve any special flags associated with this intent. You will
4745 * normally just set them with {@link #setFlags} and let the system
4746 * take the appropriate action with them.
4747 *
4748 * @return int The currently set flags.
4749 *
4750 * @see #setFlags
4751 */
4752 public int getFlags() {
4753 return mFlags;
4754 }
4755
Dianne Hackborne7f97212011-02-24 14:40:20 -08004756 /** @hide */
4757 public boolean isExcludingStopped() {
4758 return (mFlags&(FLAG_EXCLUDE_STOPPED_PACKAGES|FLAG_INCLUDE_STOPPED_PACKAGES))
4759 == FLAG_EXCLUDE_STOPPED_PACKAGES;
4760 }
4761
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004762 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004763 * Retrieve the application package name this Intent is limited to. When
4764 * resolving an Intent, if non-null this limits the resolution to only
4765 * components in the given application package.
4766 *
4767 * @return The name of the application package for the Intent.
4768 *
4769 * @see #resolveActivity
4770 * @see #setPackage
4771 */
4772 public String getPackage() {
4773 return mPackage;
4774 }
4775
4776 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004777 * Retrieve the concrete component associated with the intent. When receiving
4778 * an intent, this is the component that was found to best handle it (that is,
4779 * yourself) and will always be non-null; in all other cases it will be
4780 * null unless explicitly set.
4781 *
4782 * @return The name of the application component to handle the intent.
4783 *
4784 * @see #resolveActivity
4785 * @see #setComponent
4786 */
4787 public ComponentName getComponent() {
4788 return mComponent;
4789 }
4790
4791 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08004792 * Get the bounds of the sender of this intent, in screen coordinates. This can be
4793 * used as a hint to the receiver for animations and the like. Null means that there
4794 * is no source bounds.
4795 */
4796 public Rect getSourceBounds() {
4797 return mSourceBounds;
4798 }
4799
4800 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004801 * Return the Activity component that should be used to handle this intent.
4802 * The appropriate component is determined based on the information in the
4803 * intent, evaluated as follows:
4804 *
4805 * <p>If {@link #getComponent} returns an explicit class, that is returned
4806 * without any further consideration.
4807 *
4808 * <p>The activity must handle the {@link Intent#CATEGORY_DEFAULT} Intent
4809 * category to be considered.
4810 *
4811 * <p>If {@link #getAction} is non-NULL, the activity must handle this
4812 * action.
4813 *
4814 * <p>If {@link #resolveType} returns non-NULL, the activity must handle
4815 * this type.
4816 *
4817 * <p>If {@link #addCategory} has added any categories, the activity must
4818 * handle ALL of the categories specified.
4819 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07004820 * <p>If {@link #getPackage} is non-NULL, only activity components in
4821 * that application package will be considered.
4822 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004823 * <p>If there are no activities that satisfy all of these conditions, a
4824 * null string is returned.
4825 *
4826 * <p>If multiple activities are found to satisfy the intent, the one with
4827 * the highest priority will be used. If there are multiple activities
4828 * with the same priority, the system will either pick the best activity
4829 * based on user preference, or resolve to a system class that will allow
4830 * the user to pick an activity and forward from there.
4831 *
4832 * <p>This method is implemented simply by calling
4833 * {@link PackageManager#resolveActivity} with the "defaultOnly" parameter
4834 * true.</p>
4835 * <p> This API is called for you as part of starting an activity from an
4836 * intent. You do not normally need to call it yourself.</p>
4837 *
4838 * @param pm The package manager with which to resolve the Intent.
4839 *
4840 * @return Name of the component implementing an activity that can
4841 * display the intent.
4842 *
4843 * @see #setComponent
4844 * @see #getComponent
4845 * @see #resolveActivityInfo
4846 */
4847 public ComponentName resolveActivity(PackageManager pm) {
4848 if (mComponent != null) {
4849 return mComponent;
4850 }
4851
4852 ResolveInfo info = pm.resolveActivity(
4853 this, PackageManager.MATCH_DEFAULT_ONLY);
4854 if (info != null) {
4855 return new ComponentName(
4856 info.activityInfo.applicationInfo.packageName,
4857 info.activityInfo.name);
4858 }
4859
4860 return null;
4861 }
4862
4863 /**
4864 * Resolve the Intent into an {@link ActivityInfo}
4865 * describing the activity that should execute the intent. Resolution
4866 * follows the same rules as described for {@link #resolveActivity}, but
4867 * you get back the completely information about the resolved activity
4868 * instead of just its class name.
4869 *
4870 * @param pm The package manager with which to resolve the Intent.
4871 * @param flags Addition information to retrieve as per
4872 * {@link PackageManager#getActivityInfo(ComponentName, int)
4873 * PackageManager.getActivityInfo()}.
4874 *
4875 * @return PackageManager.ActivityInfo
4876 *
4877 * @see #resolveActivity
4878 */
4879 public ActivityInfo resolveActivityInfo(PackageManager pm, int flags) {
4880 ActivityInfo ai = null;
4881 if (mComponent != null) {
4882 try {
4883 ai = pm.getActivityInfo(mComponent, flags);
4884 } catch (PackageManager.NameNotFoundException e) {
4885 // ignore
4886 }
4887 } else {
4888 ResolveInfo info = pm.resolveActivity(
Dianne Hackborn9bfb7072009-09-22 11:37:40 -07004889 this, PackageManager.MATCH_DEFAULT_ONLY | flags);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004890 if (info != null) {
4891 ai = info.activityInfo;
4892 }
4893 }
4894
4895 return ai;
4896 }
4897
4898 /**
4899 * Set the general action to be performed.
4900 *
4901 * @param action An action name, such as ACTION_VIEW. Application-specific
4902 * actions should be prefixed with the vendor's package name.
4903 *
4904 * @return Returns the same Intent object, for chaining multiple calls
4905 * into a single statement.
4906 *
4907 * @see #getAction
4908 */
4909 public Intent setAction(String action) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08004910 mAction = action != null ? action.intern() : null;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004911 return this;
4912 }
4913
4914 /**
4915 * Set the data this intent is operating on. This method automatically
Nick Pellyccae4122012-01-09 14:12:58 -08004916 * clears any type that was previously set by {@link #setType} or
4917 * {@link #setTypeAndNormalize}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004918 *
Nick Pellyccae4122012-01-09 14:12:58 -08004919 * <p><em>Note: scheme matching in the Android framework is
4920 * case-sensitive, unlike the formal RFC. As a result,
4921 * you should always write your Uri with a lower case scheme,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004922 * or use {@link Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08004923 * {@link #setDataAndNormalize}
4924 * to ensure that the scheme is converted to lower case.</em>
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004925 *
Nick Pellyccae4122012-01-09 14:12:58 -08004926 * @param data The Uri of the data this intent is now targeting.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004927 *
4928 * @return Returns the same Intent object, for chaining multiple calls
4929 * into a single statement.
4930 *
4931 * @see #getData
Nick Pellyccae4122012-01-09 14:12:58 -08004932 * @see #setDataAndNormalize
4933 * @see android.net.Intent#normalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004934 */
4935 public Intent setData(Uri data) {
4936 mData = data;
4937 mType = null;
4938 return this;
4939 }
4940
4941 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004942 * Normalize and set the data this intent is operating on.
4943 *
4944 * <p>This method automatically clears any type that was
4945 * previously set (for example, by {@link #setType}).
4946 *
4947 * <p>The data Uri is normalized using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004948 * {@link android.net.Uri#normalizeScheme} before it is set,
Nick Pellyccae4122012-01-09 14:12:58 -08004949 * so really this is just a convenience method for
4950 * <pre>
4951 * setData(data.normalize())
4952 * </pre>
4953 *
4954 * @param data The Uri of the data this intent is now targeting.
4955 *
4956 * @return Returns the same Intent object, for chaining multiple calls
4957 * into a single statement.
4958 *
4959 * @see #getData
4960 * @see #setType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004961 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08004962 */
4963 public Intent setDataAndNormalize(Uri data) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04004964 return setData(data.normalizeScheme());
Nick Pellyccae4122012-01-09 14:12:58 -08004965 }
4966
4967 /**
4968 * Set an explicit MIME data type.
4969 *
4970 * <p>This is used to create intents that only specify a type and not data,
4971 * for example to indicate the type of data to return.
4972 *
4973 * <p>This method automatically clears any data that was
4974 * previously set (for example by {@link #setData}).
Romain Guy4969af72009-06-17 10:53:19 -07004975 *
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07004976 * <p><em>Note: MIME type matching in the Android framework is
4977 * case-sensitive, unlike formal RFC MIME types. As a result,
4978 * you should always write your MIME types with lower case letters,
Nick Pellyccae4122012-01-09 14:12:58 -08004979 * or use {@link #normalizeMimeType} or {@link #setTypeAndNormalize}
4980 * to ensure that it is converted to lower case.</em>
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004981 *
4982 * @param type The MIME type of the data being handled by this intent.
4983 *
4984 * @return Returns the same Intent object, for chaining multiple calls
4985 * into a single statement.
4986 *
4987 * @see #getType
Nick Pellyccae4122012-01-09 14:12:58 -08004988 * @see #setTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004989 * @see #setDataAndType
Nick Pellyccae4122012-01-09 14:12:58 -08004990 * @see #normalizeMimeType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07004991 */
4992 public Intent setType(String type) {
4993 mData = null;
4994 mType = type;
4995 return this;
4996 }
4997
4998 /**
Nick Pellyccae4122012-01-09 14:12:58 -08004999 * Normalize and set an explicit MIME data type.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005000 *
Nick Pellyccae4122012-01-09 14:12:58 -08005001 * <p>This is used to create intents that only specify a type and not data,
5002 * for example to indicate the type of data to return.
Dianne Hackbornb3cddae2009-04-13 16:54:00 -07005003 *
Nick Pellyccae4122012-01-09 14:12:58 -08005004 * <p>This method automatically clears any data that was
5005 * previously set (for example by {@link #setData}).
5006 *
5007 * <p>The MIME type is normalized using
5008 * {@link #normalizeMimeType} before it is set,
5009 * so really this is just a convenience method for
5010 * <pre>
5011 * setType(Intent.normalizeMimeType(type))
5012 * </pre>
5013 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005014 * @param type The MIME type of the data being handled by this intent.
5015 *
5016 * @return Returns the same Intent object, for chaining multiple calls
5017 * into a single statement.
5018 *
Nick Pellyccae4122012-01-09 14:12:58 -08005019 * @see #getType
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005020 * @see #setData
Nick Pellyccae4122012-01-09 14:12:58 -08005021 * @see #normalizeMimeType
5022 */
5023 public Intent setTypeAndNormalize(String type) {
5024 return setType(normalizeMimeType(type));
5025 }
5026
5027 /**
5028 * (Usually optional) Set the data for the intent along with an explicit
5029 * MIME data type. This method should very rarely be used -- it allows you
5030 * to override the MIME type that would ordinarily be inferred from the
5031 * data with your own type given here.
5032 *
5033 * <p><em>Note: MIME type and Uri scheme matching in the
5034 * Android framework is case-sensitive, unlike the formal RFC definitions.
5035 * As a result, you should always write these elements with lower case letters,
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005036 * or use {@link #normalizeMimeType} or {@link android.net.Uri#normalizeScheme} or
Nick Pellyccae4122012-01-09 14:12:58 -08005037 * {@link #setDataAndTypeAndNormalize}
5038 * to ensure that they are converted to lower case.</em>
5039 *
5040 * @param data The Uri of the data this intent is now targeting.
5041 * @param type The MIME type of the data being handled by this intent.
5042 *
5043 * @return Returns the same Intent object, for chaining multiple calls
5044 * into a single statement.
5045 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005046 * @see #setType
Nick Pellyccae4122012-01-09 14:12:58 -08005047 * @see #setData
5048 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005049 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005050 * @see #setDataAndTypeAndNormalize
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005051 */
5052 public Intent setDataAndType(Uri data, String type) {
5053 mData = data;
5054 mType = type;
5055 return this;
5056 }
5057
5058 /**
Nick Pellyccae4122012-01-09 14:12:58 -08005059 * (Usually optional) Normalize and set both the data Uri and an explicit
5060 * MIME data type. This method should very rarely be used -- it allows you
5061 * to override the MIME type that would ordinarily be inferred from the
5062 * data with your own type given here.
5063 *
5064 * <p>The data Uri and the MIME type are normalize using
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005065 * {@link android.net.Uri#normalizeScheme} and {@link #normalizeMimeType}
Nick Pellyccae4122012-01-09 14:12:58 -08005066 * before they are set, so really this is just a convenience method for
5067 * <pre>
5068 * setDataAndType(data.normalize(), Intent.normalizeMimeType(type))
5069 * </pre>
5070 *
5071 * @param data The Uri of the data this intent is now targeting.
5072 * @param type The MIME type of the data being handled by this intent.
5073 *
5074 * @return Returns the same Intent object, for chaining multiple calls
5075 * into a single statement.
5076 *
5077 * @see #setType
5078 * @see #setData
5079 * @see #setDataAndType
5080 * @see #normalizeMimeType
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005081 * @see android.net.Uri#normalizeScheme
Nick Pellyccae4122012-01-09 14:12:58 -08005082 */
5083 public Intent setDataAndTypeAndNormalize(Uri data, String type) {
Jesse Wilsonabc43dd2012-05-10 14:29:33 -04005084 return setDataAndType(data.normalizeScheme(), normalizeMimeType(type));
Nick Pellyccae4122012-01-09 14:12:58 -08005085 }
5086
5087 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005088 * Add a new category to the intent. Categories provide additional detail
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005089 * about the action the intent performs. When resolving an intent, only
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005090 * activities that provide <em>all</em> of the requested categories will be
5091 * used.
5092 *
5093 * @param category The desired category. This can be either one of the
5094 * predefined Intent categories, or a custom category in your own
5095 * namespace.
5096 *
5097 * @return Returns the same Intent object, for chaining multiple calls
5098 * into a single statement.
5099 *
5100 * @see #hasCategory
5101 * @see #removeCategory
5102 */
5103 public Intent addCategory(String category) {
5104 if (mCategories == null) {
5105 mCategories = new HashSet<String>();
5106 }
Jeff Brown2c376fc2011-01-28 17:34:01 -08005107 mCategories.add(category.intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005108 return this;
5109 }
5110
5111 /**
Ken Wakasaf76a50c2012-03-09 19:56:35 +09005112 * Remove a category from an intent.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005113 *
5114 * @param category The category to remove.
5115 *
5116 * @see #addCategory
5117 */
5118 public void removeCategory(String category) {
5119 if (mCategories != null) {
5120 mCategories.remove(category);
5121 if (mCategories.size() == 0) {
5122 mCategories = null;
5123 }
5124 }
5125 }
5126
5127 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08005128 * Set a selector for this Intent. This is a modification to the kinds of
5129 * things the Intent will match. If the selector is set, it will be used
5130 * when trying to find entities that can handle the Intent, instead of the
5131 * main contents of the Intent. This allows you build an Intent containing
5132 * a generic protocol while targeting it more specifically.
5133 *
5134 * <p>An example of where this may be used is with things like
5135 * {@link #CATEGORY_APP_BROWSER}. This category allows you to build an
5136 * Intent that will launch the Browser application. However, the correct
5137 * main entry point of an application is actually {@link #ACTION_MAIN}
5138 * {@link #CATEGORY_LAUNCHER} with {@link #setComponent(ComponentName)}
5139 * used to specify the actual Activity to launch. If you launch the browser
5140 * with something different, undesired behavior may happen if the user has
5141 * previously or later launches it the normal way, since they do not match.
5142 * Instead, you can build an Intent with the MAIN action (but no ComponentName
5143 * yet specified) and set a selector with {@link #ACTION_MAIN} and
5144 * {@link #CATEGORY_APP_BROWSER} to point it specifically to the browser activity.
5145 *
5146 * <p>Setting a selector does not impact the behavior of
5147 * {@link #filterEquals(Intent)} and {@link #filterHashCode()}. This is part of the
5148 * desired behavior of a selector -- it does not impact the base meaning
5149 * of the Intent, just what kinds of things will be matched against it
5150 * when determining who can handle it.</p>
5151 *
5152 * <p>You can not use both a selector and {@link #setPackage(String)} on
5153 * the same base Intent.</p>
5154 *
5155 * @param selector The desired selector Intent; set to null to not use
5156 * a special selector.
5157 */
5158 public void setSelector(Intent selector) {
5159 if (selector == this) {
5160 throw new IllegalArgumentException(
5161 "Intent being set as a selector of itself");
5162 }
5163 if (selector != null && mPackage != null) {
5164 throw new IllegalArgumentException(
5165 "Can't set selector when package name is already set");
5166 }
5167 mSelector = selector;
5168 }
5169
5170 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08005171 * Set a {@link ClipData} associated with this Intent. This replaces any
5172 * previously set ClipData.
5173 *
5174 * <p>The ClipData in an intent is not used for Intent matching or other
5175 * such operations. Semantically it is like extras, used to transmit
5176 * additional data with the Intent. The main feature of using this over
5177 * the extras for data is that {@link #FLAG_GRANT_READ_URI_PERMISSION}
5178 * and {@link #FLAG_GRANT_WRITE_URI_PERMISSION} will operate on any URI
5179 * items included in the clip data. This is useful, in particular, if
5180 * you want to transmit an Intent containing multiple <code>content:</code>
5181 * URIs for which the recipient may not have global permission to access the
5182 * content provider.
5183 *
5184 * <p>If the ClipData contains items that are themselves Intents, any
5185 * grant flags in those Intents will be ignored. Only the top-level flags
5186 * of the main Intent are respected, and will be applied to all Uri or
5187 * Intent items in the clip (or sub-items of the clip).
5188 *
5189 * <p>The MIME type, label, and icon in the ClipData object are not
5190 * directly used by Intent. Applications should generally rely on the
5191 * MIME type of the Intent itself, not what it may find in the ClipData.
5192 * A common practice is to construct a ClipData for use with an Intent
5193 * with a MIME type of "*\/*".
5194 *
5195 * @param clip The new clip to set. May be null to clear the current clip.
5196 */
5197 public void setClipData(ClipData clip) {
5198 mClipData = clip;
5199 }
5200
5201 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005202 * Add extended data to the intent. The name must include a package
5203 * prefix, for example the app com.android.contacts would use names
5204 * like "com.android.contacts.ShowAll".
5205 *
5206 * @param name The name of the extra data, with package prefix.
5207 * @param value The boolean data value.
5208 *
5209 * @return Returns the same Intent object, for chaining multiple calls
5210 * into a single statement.
5211 *
5212 * @see #putExtras
5213 * @see #removeExtra
5214 * @see #getBooleanExtra(String, boolean)
5215 */
5216 public Intent putExtra(String name, boolean value) {
5217 if (mExtras == null) {
5218 mExtras = new Bundle();
5219 }
5220 mExtras.putBoolean(name, value);
5221 return this;
5222 }
5223
5224 /**
5225 * Add extended data to the intent. The name must include a package
5226 * prefix, for example the app com.android.contacts would use names
5227 * like "com.android.contacts.ShowAll".
5228 *
5229 * @param name The name of the extra data, with package prefix.
5230 * @param value The byte data value.
5231 *
5232 * @return Returns the same Intent object, for chaining multiple calls
5233 * into a single statement.
5234 *
5235 * @see #putExtras
5236 * @see #removeExtra
5237 * @see #getByteExtra(String, byte)
5238 */
5239 public Intent putExtra(String name, byte value) {
5240 if (mExtras == null) {
5241 mExtras = new Bundle();
5242 }
5243 mExtras.putByte(name, value);
5244 return this;
5245 }
5246
5247 /**
5248 * Add extended data to the intent. The name must include a package
5249 * prefix, for example the app com.android.contacts would use names
5250 * like "com.android.contacts.ShowAll".
5251 *
5252 * @param name The name of the extra data, with package prefix.
5253 * @param value The char data value.
5254 *
5255 * @return Returns the same Intent object, for chaining multiple calls
5256 * into a single statement.
5257 *
5258 * @see #putExtras
5259 * @see #removeExtra
5260 * @see #getCharExtra(String, char)
5261 */
5262 public Intent putExtra(String name, char value) {
5263 if (mExtras == null) {
5264 mExtras = new Bundle();
5265 }
5266 mExtras.putChar(name, value);
5267 return this;
5268 }
5269
5270 /**
5271 * Add extended data to the intent. The name must include a package
5272 * prefix, for example the app com.android.contacts would use names
5273 * like "com.android.contacts.ShowAll".
5274 *
5275 * @param name The name of the extra data, with package prefix.
5276 * @param value The short data value.
5277 *
5278 * @return Returns the same Intent object, for chaining multiple calls
5279 * into a single statement.
5280 *
5281 * @see #putExtras
5282 * @see #removeExtra
5283 * @see #getShortExtra(String, short)
5284 */
5285 public Intent putExtra(String name, short value) {
5286 if (mExtras == null) {
5287 mExtras = new Bundle();
5288 }
5289 mExtras.putShort(name, value);
5290 return this;
5291 }
5292
5293 /**
5294 * Add extended data to the intent. The name must include a package
5295 * prefix, for example the app com.android.contacts would use names
5296 * like "com.android.contacts.ShowAll".
5297 *
5298 * @param name The name of the extra data, with package prefix.
5299 * @param value The integer data value.
5300 *
5301 * @return Returns the same Intent object, for chaining multiple calls
5302 * into a single statement.
5303 *
5304 * @see #putExtras
5305 * @see #removeExtra
5306 * @see #getIntExtra(String, int)
5307 */
5308 public Intent putExtra(String name, int value) {
5309 if (mExtras == null) {
5310 mExtras = new Bundle();
5311 }
5312 mExtras.putInt(name, value);
5313 return this;
5314 }
5315
5316 /**
5317 * Add extended data to the intent. The name must include a package
5318 * prefix, for example the app com.android.contacts would use names
5319 * like "com.android.contacts.ShowAll".
5320 *
5321 * @param name The name of the extra data, with package prefix.
5322 * @param value The long data value.
5323 *
5324 * @return Returns the same Intent object, for chaining multiple calls
5325 * into a single statement.
5326 *
5327 * @see #putExtras
5328 * @see #removeExtra
5329 * @see #getLongExtra(String, long)
5330 */
5331 public Intent putExtra(String name, long value) {
5332 if (mExtras == null) {
5333 mExtras = new Bundle();
5334 }
5335 mExtras.putLong(name, value);
5336 return this;
5337 }
5338
5339 /**
5340 * Add extended data to the intent. The name must include a package
5341 * prefix, for example the app com.android.contacts would use names
5342 * like "com.android.contacts.ShowAll".
5343 *
5344 * @param name The name of the extra data, with package prefix.
5345 * @param value The float data value.
5346 *
5347 * @return Returns the same Intent object, for chaining multiple calls
5348 * into a single statement.
5349 *
5350 * @see #putExtras
5351 * @see #removeExtra
5352 * @see #getFloatExtra(String, float)
5353 */
5354 public Intent putExtra(String name, float value) {
5355 if (mExtras == null) {
5356 mExtras = new Bundle();
5357 }
5358 mExtras.putFloat(name, value);
5359 return this;
5360 }
5361
5362 /**
5363 * Add extended data to the intent. The name must include a package
5364 * prefix, for example the app com.android.contacts would use names
5365 * like "com.android.contacts.ShowAll".
5366 *
5367 * @param name The name of the extra data, with package prefix.
5368 * @param value The double data value.
5369 *
5370 * @return Returns the same Intent object, for chaining multiple calls
5371 * into a single statement.
5372 *
5373 * @see #putExtras
5374 * @see #removeExtra
5375 * @see #getDoubleExtra(String, double)
5376 */
5377 public Intent putExtra(String name, double value) {
5378 if (mExtras == null) {
5379 mExtras = new Bundle();
5380 }
5381 mExtras.putDouble(name, value);
5382 return this;
5383 }
5384
5385 /**
5386 * Add extended data to the intent. The name must include a package
5387 * prefix, for example the app com.android.contacts would use names
5388 * like "com.android.contacts.ShowAll".
5389 *
5390 * @param name The name of the extra data, with package prefix.
5391 * @param value The String data value.
5392 *
5393 * @return Returns the same Intent object, for chaining multiple calls
5394 * into a single statement.
5395 *
5396 * @see #putExtras
5397 * @see #removeExtra
5398 * @see #getStringExtra(String)
5399 */
5400 public Intent putExtra(String name, String value) {
5401 if (mExtras == null) {
5402 mExtras = new Bundle();
5403 }
5404 mExtras.putString(name, value);
5405 return this;
5406 }
5407
5408 /**
5409 * Add extended data to the intent. The name must include a package
5410 * prefix, for example the app com.android.contacts would use names
5411 * like "com.android.contacts.ShowAll".
5412 *
5413 * @param name The name of the extra data, with package prefix.
5414 * @param value The CharSequence data value.
5415 *
5416 * @return Returns the same Intent object, for chaining multiple calls
5417 * into a single statement.
5418 *
5419 * @see #putExtras
5420 * @see #removeExtra
5421 * @see #getCharSequenceExtra(String)
5422 */
5423 public Intent putExtra(String name, CharSequence value) {
5424 if (mExtras == null) {
5425 mExtras = new Bundle();
5426 }
5427 mExtras.putCharSequence(name, value);
5428 return this;
5429 }
5430
5431 /**
5432 * Add extended data to the intent. The name must include a package
5433 * prefix, for example the app com.android.contacts would use names
5434 * like "com.android.contacts.ShowAll".
5435 *
5436 * @param name The name of the extra data, with package prefix.
5437 * @param value The Parcelable data value.
5438 *
5439 * @return Returns the same Intent object, for chaining multiple calls
5440 * into a single statement.
5441 *
5442 * @see #putExtras
5443 * @see #removeExtra
5444 * @see #getParcelableExtra(String)
5445 */
5446 public Intent putExtra(String name, Parcelable value) {
5447 if (mExtras == null) {
5448 mExtras = new Bundle();
5449 }
5450 mExtras.putParcelable(name, value);
5451 return this;
5452 }
5453
5454 /**
5455 * Add extended data to the intent. The name must include a package
5456 * prefix, for example the app com.android.contacts would use names
5457 * like "com.android.contacts.ShowAll".
5458 *
5459 * @param name The name of the extra data, with package prefix.
5460 * @param value The Parcelable[] data value.
5461 *
5462 * @return Returns the same Intent object, for chaining multiple calls
5463 * into a single statement.
5464 *
5465 * @see #putExtras
5466 * @see #removeExtra
5467 * @see #getParcelableArrayExtra(String)
5468 */
5469 public Intent putExtra(String name, Parcelable[] value) {
5470 if (mExtras == null) {
5471 mExtras = new Bundle();
5472 }
5473 mExtras.putParcelableArray(name, value);
5474 return this;
5475 }
5476
5477 /**
5478 * Add extended data to the intent. The name must include a package
5479 * prefix, for example the app com.android.contacts would use names
5480 * like "com.android.contacts.ShowAll".
5481 *
5482 * @param name The name of the extra data, with package prefix.
5483 * @param value The ArrayList<Parcelable> data value.
5484 *
5485 * @return Returns the same Intent object, for chaining multiple calls
5486 * into a single statement.
5487 *
5488 * @see #putExtras
5489 * @see #removeExtra
5490 * @see #getParcelableArrayListExtra(String)
5491 */
5492 public Intent putParcelableArrayListExtra(String name, ArrayList<? extends Parcelable> value) {
5493 if (mExtras == null) {
5494 mExtras = new Bundle();
5495 }
5496 mExtras.putParcelableArrayList(name, value);
5497 return this;
5498 }
5499
5500 /**
5501 * Add extended data to the intent. The name must include a package
5502 * prefix, for example the app com.android.contacts would use names
5503 * like "com.android.contacts.ShowAll".
5504 *
5505 * @param name The name of the extra data, with package prefix.
5506 * @param value The ArrayList<Integer> data value.
5507 *
5508 * @return Returns the same Intent object, for chaining multiple calls
5509 * into a single statement.
5510 *
5511 * @see #putExtras
5512 * @see #removeExtra
5513 * @see #getIntegerArrayListExtra(String)
5514 */
5515 public Intent putIntegerArrayListExtra(String name, ArrayList<Integer> value) {
5516 if (mExtras == null) {
5517 mExtras = new Bundle();
5518 }
5519 mExtras.putIntegerArrayList(name, value);
5520 return this;
5521 }
5522
5523 /**
5524 * Add extended data to the intent. The name must include a package
5525 * prefix, for example the app com.android.contacts would use names
5526 * like "com.android.contacts.ShowAll".
5527 *
5528 * @param name The name of the extra data, with package prefix.
5529 * @param value The ArrayList<String> data value.
5530 *
5531 * @return Returns the same Intent object, for chaining multiple calls
5532 * into a single statement.
5533 *
5534 * @see #putExtras
5535 * @see #removeExtra
5536 * @see #getStringArrayListExtra(String)
5537 */
5538 public Intent putStringArrayListExtra(String name, ArrayList<String> value) {
5539 if (mExtras == null) {
5540 mExtras = new Bundle();
5541 }
5542 mExtras.putStringArrayList(name, value);
5543 return this;
5544 }
5545
5546 /**
5547 * Add extended data to the intent. The name must include a package
5548 * prefix, for example the app com.android.contacts would use names
5549 * like "com.android.contacts.ShowAll".
5550 *
5551 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005552 * @param value The ArrayList<CharSequence> data value.
5553 *
5554 * @return Returns the same Intent object, for chaining multiple calls
5555 * into a single statement.
5556 *
5557 * @see #putExtras
5558 * @see #removeExtra
5559 * @see #getCharSequenceArrayListExtra(String)
5560 */
5561 public Intent putCharSequenceArrayListExtra(String name, ArrayList<CharSequence> value) {
5562 if (mExtras == null) {
5563 mExtras = new Bundle();
5564 }
5565 mExtras.putCharSequenceArrayList(name, value);
5566 return this;
5567 }
5568
5569 /**
5570 * Add extended data to the intent. The name must include a package
5571 * prefix, for example the app com.android.contacts would use names
5572 * like "com.android.contacts.ShowAll".
5573 *
5574 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005575 * @param value The Serializable data value.
5576 *
5577 * @return Returns the same Intent object, for chaining multiple calls
5578 * into a single statement.
5579 *
5580 * @see #putExtras
5581 * @see #removeExtra
5582 * @see #getSerializableExtra(String)
5583 */
5584 public Intent putExtra(String name, Serializable value) {
5585 if (mExtras == null) {
5586 mExtras = new Bundle();
5587 }
5588 mExtras.putSerializable(name, value);
5589 return this;
5590 }
5591
5592 /**
5593 * Add extended data to the intent. The name must include a package
5594 * prefix, for example the app com.android.contacts would use names
5595 * like "com.android.contacts.ShowAll".
5596 *
5597 * @param name The name of the extra data, with package prefix.
5598 * @param value The boolean array data value.
5599 *
5600 * @return Returns the same Intent object, for chaining multiple calls
5601 * into a single statement.
5602 *
5603 * @see #putExtras
5604 * @see #removeExtra
5605 * @see #getBooleanArrayExtra(String)
5606 */
5607 public Intent putExtra(String name, boolean[] value) {
5608 if (mExtras == null) {
5609 mExtras = new Bundle();
5610 }
5611 mExtras.putBooleanArray(name, value);
5612 return this;
5613 }
5614
5615 /**
5616 * Add extended data to the intent. The name must include a package
5617 * prefix, for example the app com.android.contacts would use names
5618 * like "com.android.contacts.ShowAll".
5619 *
5620 * @param name The name of the extra data, with package prefix.
5621 * @param value The byte array data value.
5622 *
5623 * @return Returns the same Intent object, for chaining multiple calls
5624 * into a single statement.
5625 *
5626 * @see #putExtras
5627 * @see #removeExtra
5628 * @see #getByteArrayExtra(String)
5629 */
5630 public Intent putExtra(String name, byte[] value) {
5631 if (mExtras == null) {
5632 mExtras = new Bundle();
5633 }
5634 mExtras.putByteArray(name, value);
5635 return this;
5636 }
5637
5638 /**
5639 * Add extended data to the intent. The name must include a package
5640 * prefix, for example the app com.android.contacts would use names
5641 * like "com.android.contacts.ShowAll".
5642 *
5643 * @param name The name of the extra data, with package prefix.
5644 * @param value The short array data value.
5645 *
5646 * @return Returns the same Intent object, for chaining multiple calls
5647 * into a single statement.
5648 *
5649 * @see #putExtras
5650 * @see #removeExtra
5651 * @see #getShortArrayExtra(String)
5652 */
5653 public Intent putExtra(String name, short[] value) {
5654 if (mExtras == null) {
5655 mExtras = new Bundle();
5656 }
5657 mExtras.putShortArray(name, value);
5658 return this;
5659 }
5660
5661 /**
5662 * Add extended data to the intent. The name must include a package
5663 * prefix, for example the app com.android.contacts would use names
5664 * like "com.android.contacts.ShowAll".
5665 *
5666 * @param name The name of the extra data, with package prefix.
5667 * @param value The char array data value.
5668 *
5669 * @return Returns the same Intent object, for chaining multiple calls
5670 * into a single statement.
5671 *
5672 * @see #putExtras
5673 * @see #removeExtra
5674 * @see #getCharArrayExtra(String)
5675 */
5676 public Intent putExtra(String name, char[] value) {
5677 if (mExtras == null) {
5678 mExtras = new Bundle();
5679 }
5680 mExtras.putCharArray(name, value);
5681 return this;
5682 }
5683
5684 /**
5685 * Add extended data to the intent. The name must include a package
5686 * prefix, for example the app com.android.contacts would use names
5687 * like "com.android.contacts.ShowAll".
5688 *
5689 * @param name The name of the extra data, with package prefix.
5690 * @param value The int array data value.
5691 *
5692 * @return Returns the same Intent object, for chaining multiple calls
5693 * into a single statement.
5694 *
5695 * @see #putExtras
5696 * @see #removeExtra
5697 * @see #getIntArrayExtra(String)
5698 */
5699 public Intent putExtra(String name, int[] value) {
5700 if (mExtras == null) {
5701 mExtras = new Bundle();
5702 }
5703 mExtras.putIntArray(name, value);
5704 return this;
5705 }
5706
5707 /**
5708 * Add extended data to the intent. The name must include a package
5709 * prefix, for example the app com.android.contacts would use names
5710 * like "com.android.contacts.ShowAll".
5711 *
5712 * @param name The name of the extra data, with package prefix.
5713 * @param value The byte array data value.
5714 *
5715 * @return Returns the same Intent object, for chaining multiple calls
5716 * into a single statement.
5717 *
5718 * @see #putExtras
5719 * @see #removeExtra
5720 * @see #getLongArrayExtra(String)
5721 */
5722 public Intent putExtra(String name, long[] value) {
5723 if (mExtras == null) {
5724 mExtras = new Bundle();
5725 }
5726 mExtras.putLongArray(name, value);
5727 return this;
5728 }
5729
5730 /**
5731 * Add extended data to the intent. The name must include a package
5732 * prefix, for example the app com.android.contacts would use names
5733 * like "com.android.contacts.ShowAll".
5734 *
5735 * @param name The name of the extra data, with package prefix.
5736 * @param value The float array data value.
5737 *
5738 * @return Returns the same Intent object, for chaining multiple calls
5739 * into a single statement.
5740 *
5741 * @see #putExtras
5742 * @see #removeExtra
5743 * @see #getFloatArrayExtra(String)
5744 */
5745 public Intent putExtra(String name, float[] value) {
5746 if (mExtras == null) {
5747 mExtras = new Bundle();
5748 }
5749 mExtras.putFloatArray(name, value);
5750 return this;
5751 }
5752
5753 /**
5754 * Add extended data to the intent. The name must include a package
5755 * prefix, for example the app com.android.contacts would use names
5756 * like "com.android.contacts.ShowAll".
5757 *
5758 * @param name The name of the extra data, with package prefix.
5759 * @param value The double array data value.
5760 *
5761 * @return Returns the same Intent object, for chaining multiple calls
5762 * into a single statement.
5763 *
5764 * @see #putExtras
5765 * @see #removeExtra
5766 * @see #getDoubleArrayExtra(String)
5767 */
5768 public Intent putExtra(String name, double[] value) {
5769 if (mExtras == null) {
5770 mExtras = new Bundle();
5771 }
5772 mExtras.putDoubleArray(name, value);
5773 return this;
5774 }
5775
5776 /**
5777 * Add extended data to the intent. The name must include a package
5778 * prefix, for example the app com.android.contacts would use names
5779 * like "com.android.contacts.ShowAll".
5780 *
5781 * @param name The name of the extra data, with package prefix.
5782 * @param value The String array data value.
5783 *
5784 * @return Returns the same Intent object, for chaining multiple calls
5785 * into a single statement.
5786 *
5787 * @see #putExtras
5788 * @see #removeExtra
5789 * @see #getStringArrayExtra(String)
5790 */
5791 public Intent putExtra(String name, String[] value) {
5792 if (mExtras == null) {
5793 mExtras = new Bundle();
5794 }
5795 mExtras.putStringArray(name, value);
5796 return this;
5797 }
5798
5799 /**
5800 * Add extended data to the intent. The name must include a package
5801 * prefix, for example the app com.android.contacts would use names
5802 * like "com.android.contacts.ShowAll".
5803 *
5804 * @param name The name of the extra data, with package prefix.
Bjorn Bringert08bbffb2010-02-25 11:16:22 +00005805 * @param value The CharSequence array data value.
5806 *
5807 * @return Returns the same Intent object, for chaining multiple calls
5808 * into a single statement.
5809 *
5810 * @see #putExtras
5811 * @see #removeExtra
5812 * @see #getCharSequenceArrayExtra(String)
5813 */
5814 public Intent putExtra(String name, CharSequence[] value) {
5815 if (mExtras == null) {
5816 mExtras = new Bundle();
5817 }
5818 mExtras.putCharSequenceArray(name, value);
5819 return this;
5820 }
5821
5822 /**
5823 * Add extended data to the intent. The name must include a package
5824 * prefix, for example the app com.android.contacts would use names
5825 * like "com.android.contacts.ShowAll".
5826 *
5827 * @param name The name of the extra data, with package prefix.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005828 * @param value The Bundle data value.
5829 *
5830 * @return Returns the same Intent object, for chaining multiple calls
5831 * into a single statement.
5832 *
5833 * @see #putExtras
5834 * @see #removeExtra
5835 * @see #getBundleExtra(String)
5836 */
5837 public Intent putExtra(String name, Bundle value) {
5838 if (mExtras == null) {
5839 mExtras = new Bundle();
5840 }
5841 mExtras.putBundle(name, value);
5842 return this;
5843 }
5844
5845 /**
5846 * Add extended data to the intent. The name must include a package
5847 * prefix, for example the app com.android.contacts would use names
5848 * like "com.android.contacts.ShowAll".
5849 *
5850 * @param name The name of the extra data, with package prefix.
5851 * @param value The IBinder data value.
5852 *
5853 * @return Returns the same Intent object, for chaining multiple calls
5854 * into a single statement.
5855 *
5856 * @see #putExtras
5857 * @see #removeExtra
5858 * @see #getIBinderExtra(String)
5859 *
5860 * @deprecated
5861 * @hide
5862 */
5863 @Deprecated
5864 public Intent putExtra(String name, IBinder value) {
5865 if (mExtras == null) {
5866 mExtras = new Bundle();
5867 }
5868 mExtras.putIBinder(name, value);
5869 return this;
5870 }
5871
5872 /**
5873 * Copy all extras in 'src' in to this intent.
5874 *
5875 * @param src Contains the extras to copy.
5876 *
5877 * @see #putExtra
5878 */
5879 public Intent putExtras(Intent src) {
5880 if (src.mExtras != null) {
5881 if (mExtras == null) {
5882 mExtras = new Bundle(src.mExtras);
5883 } else {
5884 mExtras.putAll(src.mExtras);
5885 }
5886 }
5887 return this;
5888 }
5889
5890 /**
5891 * Add a set of extended data to the intent. The keys must include a package
5892 * prefix, for example the app com.android.contacts would use names
5893 * like "com.android.contacts.ShowAll".
5894 *
5895 * @param extras The Bundle of extras to add to this intent.
5896 *
5897 * @see #putExtra
5898 * @see #removeExtra
5899 */
5900 public Intent putExtras(Bundle extras) {
5901 if (mExtras == null) {
5902 mExtras = new Bundle();
5903 }
5904 mExtras.putAll(extras);
5905 return this;
5906 }
5907
5908 /**
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005909 * Completely replace the extras in the Intent with the extras in the
5910 * given Intent.
The Android Open Source Project10592532009-03-18 17:39:46 -07005911 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005912 * @param src The exact extras contained in this Intent are copied
5913 * into the target intent, replacing any that were previously there.
5914 */
5915 public Intent replaceExtras(Intent src) {
5916 mExtras = src.mExtras != null ? new Bundle(src.mExtras) : null;
5917 return this;
5918 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005919
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005920 /**
5921 * Completely replace the extras in the Intent with the given Bundle of
5922 * extras.
The Android Open Source Project10592532009-03-18 17:39:46 -07005923 *
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005924 * @param extras The new set of extras in the Intent, or null to erase
5925 * all extras.
5926 */
5927 public Intent replaceExtras(Bundle extras) {
5928 mExtras = extras != null ? new Bundle(extras) : null;
5929 return this;
5930 }
The Android Open Source Project10592532009-03-18 17:39:46 -07005931
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005932 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005933 * Remove extended data from the intent.
5934 *
5935 * @see #putExtra
5936 */
5937 public void removeExtra(String name) {
5938 if (mExtras != null) {
5939 mExtras.remove(name);
5940 if (mExtras.size() == 0) {
5941 mExtras = null;
5942 }
5943 }
5944 }
5945
5946 /**
5947 * Set special flags controlling how this intent is handled. Most values
5948 * here depend on the type of component being executed by the Intent,
5949 * specifically the FLAG_ACTIVITY_* flags are all for use with
5950 * {@link Context#startActivity Context.startActivity()} and the
5951 * FLAG_RECEIVER_* flags are all for use with
5952 * {@link Context#sendBroadcast(Intent) Context.sendBroadcast()}.
5953 *
Scott Main7aee61f2011-02-08 11:25:01 -08005954 * <p>See the
5955 * <a href="{@docRoot}guide/topics/fundamentals/tasks-and-back-stack.html">Tasks and Back
5956 * Stack</a> documentation for important information on how some of these options impact
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005957 * the behavior of your application.
5958 *
5959 * @param flags The desired flags.
5960 *
5961 * @return Returns the same Intent object, for chaining multiple calls
5962 * into a single statement.
5963 *
5964 * @see #getFlags
5965 * @see #addFlags
5966 *
5967 * @see #FLAG_GRANT_READ_URI_PERMISSION
5968 * @see #FLAG_GRANT_WRITE_URI_PERMISSION
5969 * @see #FLAG_DEBUG_LOG_RESOLUTION
5970 * @see #FLAG_FROM_BACKGROUND
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005971 * @see #FLAG_ACTIVITY_BROUGHT_TO_FRONT
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005972 * @see #FLAG_ACTIVITY_CLEAR_TASK
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005973 * @see #FLAG_ACTIVITY_CLEAR_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005974 * @see #FLAG_ACTIVITY_CLEAR_WHEN_TASK_RESET
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005975 * @see #FLAG_ACTIVITY_EXCLUDE_FROM_RECENTS
5976 * @see #FLAG_ACTIVITY_FORWARD_RESULT
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005977 * @see #FLAG_ACTIVITY_LAUNCHED_FROM_HISTORY
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005978 * @see #FLAG_ACTIVITY_MULTIPLE_TASK
5979 * @see #FLAG_ACTIVITY_NEW_TASK
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005980 * @see #FLAG_ACTIVITY_NO_ANIMATION
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005981 * @see #FLAG_ACTIVITY_NO_HISTORY
The Android Open Source Projectf1e484a2009-01-22 00:13:42 -08005982 * @see #FLAG_ACTIVITY_NO_USER_ACTION
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08005983 * @see #FLAG_ACTIVITY_PREVIOUS_IS_TOP
5984 * @see #FLAG_ACTIVITY_RESET_TASK_IF_NEEDED
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005985 * @see #FLAG_ACTIVITY_REORDER_TO_FRONT
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005986 * @see #FLAG_ACTIVITY_SINGLE_TOP
Dianne Hackborn621e17d2010-11-22 15:59:56 -08005987 * @see #FLAG_ACTIVITY_TASK_ON_HOME
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07005988 * @see #FLAG_RECEIVER_REGISTERED_ONLY
5989 */
5990 public Intent setFlags(int flags) {
5991 mFlags = flags;
5992 return this;
5993 }
5994
5995 /**
5996 * Add additional flags to the intent (or with existing flags
5997 * value).
5998 *
5999 * @param flags The new flags to set.
6000 *
6001 * @return Returns the same Intent object, for chaining multiple calls
6002 * into a single statement.
6003 *
6004 * @see #setFlags
6005 */
6006 public Intent addFlags(int flags) {
6007 mFlags |= flags;
6008 return this;
6009 }
6010
6011 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006012 * (Usually optional) Set an explicit application package name that limits
6013 * the components this Intent will resolve to. If left to the default
6014 * value of null, all components in all applications will considered.
6015 * If non-null, the Intent can only match the components in the given
6016 * application package.
6017 *
6018 * @param packageName The name of the application package to handle the
6019 * intent, or null to allow any application package.
6020 *
6021 * @return Returns the same Intent object, for chaining multiple calls
6022 * into a single statement.
6023 *
6024 * @see #getPackage
6025 * @see #resolveActivity
6026 */
6027 public Intent setPackage(String packageName) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006028 if (packageName != null && mSelector != null) {
6029 throw new IllegalArgumentException(
6030 "Can't set package name when selector is already set");
6031 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006032 mPackage = packageName;
6033 return this;
6034 }
6035
6036 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006037 * (Usually optional) Explicitly set the component to handle the intent.
6038 * If left with the default value of null, the system will determine the
6039 * appropriate class to use based on the other fields (action, data,
6040 * type, categories) in the Intent. If this class is defined, the
6041 * specified class will always be used regardless of the other fields. You
6042 * should only set this value when you know you absolutely want a specific
6043 * class to be used; otherwise it is better to let the system find the
6044 * appropriate class so that you will respect the installed applications
6045 * and user preferences.
6046 *
6047 * @param component The name of the application component to handle the
6048 * intent, or null to let the system find one for you.
6049 *
6050 * @return Returns the same Intent object, for chaining multiple calls
6051 * into a single statement.
6052 *
6053 * @see #setClass
6054 * @see #setClassName(Context, String)
6055 * @see #setClassName(String, String)
6056 * @see #getComponent
6057 * @see #resolveActivity
6058 */
6059 public Intent setComponent(ComponentName component) {
6060 mComponent = component;
6061 return this;
6062 }
6063
6064 /**
6065 * Convenience for calling {@link #setComponent} with an
6066 * explicit class name.
6067 *
6068 * @param packageContext A Context of the application package implementing
6069 * this class.
6070 * @param className The name of a class inside of the application package
6071 * that will be used as the component for this Intent.
6072 *
6073 * @return Returns the same Intent object, for chaining multiple calls
6074 * into a single statement.
6075 *
6076 * @see #setComponent
6077 * @see #setClass
6078 */
6079 public Intent setClassName(Context packageContext, String className) {
6080 mComponent = new ComponentName(packageContext, className);
6081 return this;
6082 }
6083
6084 /**
6085 * Convenience for calling {@link #setComponent} with an
6086 * explicit application package name and class name.
6087 *
6088 * @param packageName The name of the package implementing the desired
6089 * component.
6090 * @param className The name of a class inside of the application package
6091 * that will be used as the component for this Intent.
6092 *
6093 * @return Returns the same Intent object, for chaining multiple calls
6094 * into a single statement.
6095 *
6096 * @see #setComponent
6097 * @see #setClass
6098 */
6099 public Intent setClassName(String packageName, String className) {
6100 mComponent = new ComponentName(packageName, className);
6101 return this;
6102 }
6103
6104 /**
6105 * Convenience for calling {@link #setComponent(ComponentName)} with the
6106 * name returned by a {@link Class} object.
6107 *
6108 * @param packageContext A Context of the application package implementing
6109 * this class.
6110 * @param cls The class name to set, equivalent to
6111 * <code>setClassName(context, cls.getName())</code>.
6112 *
6113 * @return Returns the same Intent object, for chaining multiple calls
6114 * into a single statement.
6115 *
6116 * @see #setComponent
6117 */
6118 public Intent setClass(Context packageContext, Class<?> cls) {
6119 mComponent = new ComponentName(packageContext, cls);
6120 return this;
6121 }
6122
6123 /**
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006124 * Set the bounds of the sender of this intent, in screen coordinates. This can be
6125 * used as a hint to the receiver for animations and the like. Null means that there
6126 * is no source bounds.
6127 */
6128 public void setSourceBounds(Rect r) {
6129 if (r != null) {
6130 mSourceBounds = new Rect(r);
6131 } else {
Daniel Lehmanna5b58df2011-10-12 16:24:22 -07006132 mSourceBounds = null;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006133 }
6134 }
6135
6136 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006137 * Use with {@link #fillIn} to allow the current action value to be
6138 * overwritten, even if it is already set.
6139 */
6140 public static final int FILL_IN_ACTION = 1<<0;
6141
6142 /**
6143 * Use with {@link #fillIn} to allow the current data or type value
6144 * overwritten, even if it is already set.
6145 */
6146 public static final int FILL_IN_DATA = 1<<1;
6147
6148 /**
6149 * Use with {@link #fillIn} to allow the current categories to be
6150 * overwritten, even if they are already set.
6151 */
6152 public static final int FILL_IN_CATEGORIES = 1<<2;
6153
6154 /**
6155 * Use with {@link #fillIn} to allow the current component value to be
6156 * overwritten, even if it is already set.
6157 */
6158 public static final int FILL_IN_COMPONENT = 1<<3;
6159
6160 /**
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006161 * Use with {@link #fillIn} to allow the current package value to be
6162 * overwritten, even if it is already set.
6163 */
6164 public static final int FILL_IN_PACKAGE = 1<<4;
6165
6166 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006167 * Use with {@link #fillIn} to allow the current bounds rectangle to be
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006168 * overwritten, even if it is already set.
6169 */
6170 public static final int FILL_IN_SOURCE_BOUNDS = 1<<5;
6171
6172 /**
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006173 * Use with {@link #fillIn} to allow the current selector to be
6174 * overwritten, even if it is already set.
6175 */
6176 public static final int FILL_IN_SELECTOR = 1<<6;
6177
6178 /**
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006179 * Use with {@link #fillIn} to allow the current ClipData to be
6180 * overwritten, even if it is already set.
6181 */
6182 public static final int FILL_IN_CLIP_DATA = 1<<7;
6183
6184 /**
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006185 * Copy the contents of <var>other</var> in to this object, but only
6186 * where fields are not defined by this object. For purposes of a field
6187 * being defined, the following pieces of data in the Intent are
6188 * considered to be separate fields:
6189 *
6190 * <ul>
6191 * <li> action, as set by {@link #setAction}.
Nick Pellyccae4122012-01-09 14:12:58 -08006192 * <li> data Uri and MIME type, as set by {@link #setData(Uri)},
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006193 * {@link #setType(String)}, or {@link #setDataAndType(Uri, String)}.
6194 * <li> categories, as set by {@link #addCategory}.
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006195 * <li> package, as set by {@link #setPackage}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006196 * <li> component, as set by {@link #setComponent(ComponentName)} or
6197 * related methods.
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006198 * <li> source bounds, as set by {@link #setSourceBounds}.
6199 * <li> selector, as set by {@link #setSelector(Intent)}.
6200 * <li> clip data, as set by {@link #setClipData(ClipData)}.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006201 * <li> each top-level name in the associated extras.
6202 * </ul>
6203 *
6204 * <p>In addition, you can use the {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006205 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006206 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS},
6207 * {@link #FILL_IN_SELECTOR}, and {@link #FILL_IN_CLIP_DATA} to override
6208 * the restriction where the corresponding field will not be replaced if
6209 * it is already set.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006210 *
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006211 * <p>Note: The component field will only be copied if {@link #FILL_IN_COMPONENT}
6212 * is explicitly specified. The selector will only be copied if
6213 * {@link #FILL_IN_SELECTOR} is explicitly specified.
Brett Chabot3e391752009-07-21 16:07:23 -07006214 *
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006215 * <p>For example, consider Intent A with {data="foo", categories="bar"}
6216 * and Intent B with {action="gotit", data-type="some/thing",
6217 * categories="one","two"}.
6218 *
6219 * <p>Calling A.fillIn(B, Intent.FILL_IN_DATA) will result in A now
6220 * containing: {action="gotit", data-type="some/thing",
6221 * categories="bar"}.
6222 *
6223 * @param other Another Intent whose values are to be used to fill in
6224 * the current one.
6225 * @param flags Options to control which fields can be filled in.
6226 *
6227 * @return Returns a bit mask of {@link #FILL_IN_ACTION},
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006228 * {@link #FILL_IN_DATA}, {@link #FILL_IN_CATEGORIES}, {@link #FILL_IN_PACKAGE},
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006229 * {@link #FILL_IN_COMPONENT}, {@link #FILL_IN_SOURCE_BOUNDS}, and
6230 * {@link #FILL_IN_SELECTOR} indicating which fields were changed.
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006231 */
6232 public int fillIn(Intent other, int flags) {
6233 int changes = 0;
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006234 if (other.mAction != null
6235 && (mAction == null || (flags&FILL_IN_ACTION) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006236 mAction = other.mAction;
6237 changes |= FILL_IN_ACTION;
6238 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006239 if ((other.mData != null || other.mType != null)
6240 && ((mData == null && mType == null)
6241 || (flags&FILL_IN_DATA) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006242 mData = other.mData;
6243 mType = other.mType;
6244 changes |= FILL_IN_DATA;
6245 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006246 if (other.mCategories != null
6247 && (mCategories == null || (flags&FILL_IN_CATEGORIES) != 0)) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006248 if (other.mCategories != null) {
6249 mCategories = new HashSet<String>(other.mCategories);
6250 }
6251 changes |= FILL_IN_CATEGORIES;
6252 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006253 if (other.mPackage != null
6254 && (mPackage == null || (flags&FILL_IN_PACKAGE) != 0)) {
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006255 // Only do this if mSelector is not set.
6256 if (mSelector == null) {
6257 mPackage = other.mPackage;
6258 changes |= FILL_IN_PACKAGE;
6259 }
6260 }
6261 // Selector is special: it can only be set if explicitly allowed,
6262 // for the same reason as the component name.
6263 if (other.mSelector != null && (flags&FILL_IN_SELECTOR) != 0) {
6264 if (mPackage == null) {
6265 mSelector = new Intent(other.mSelector);
6266 mPackage = null;
6267 changes |= FILL_IN_SELECTOR;
6268 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006269 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006270 if (other.mClipData != null
6271 && (mClipData == null || (flags&FILL_IN_CLIP_DATA) != 0)) {
6272 mClipData = other.mClipData;
6273 changes |= FILL_IN_CLIP_DATA;
6274 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006275 // Component is special: it can -only- be set if explicitly allowed,
6276 // since otherwise the sender could force the intent somewhere the
6277 // originator didn't intend.
6278 if (other.mComponent != null && (flags&FILL_IN_COMPONENT) != 0) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006279 mComponent = other.mComponent;
6280 changes |= FILL_IN_COMPONENT;
6281 }
6282 mFlags |= other.mFlags;
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006283 if (other.mSourceBounds != null
6284 && (mSourceBounds == null || (flags&FILL_IN_SOURCE_BOUNDS) != 0)) {
6285 mSourceBounds = new Rect(other.mSourceBounds);
6286 changes |= FILL_IN_SOURCE_BOUNDS;
6287 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006288 if (mExtras == null) {
6289 if (other.mExtras != null) {
6290 mExtras = new Bundle(other.mExtras);
6291 }
6292 } else if (other.mExtras != null) {
6293 try {
6294 Bundle newb = new Bundle(other.mExtras);
6295 newb.putAll(mExtras);
6296 mExtras = newb;
6297 } catch (RuntimeException e) {
6298 // Modifying the extras can cause us to unparcel the contents
6299 // of the bundle, and if we do this in the system process that
6300 // may fail. We really should handle this (i.e., the Bundle
6301 // impl shouldn't be on top of a plain map), but for now just
6302 // ignore it and keep the original contents. :(
6303 Log.w("Intent", "Failure filling in extras", e);
6304 }
6305 }
6306 return changes;
6307 }
6308
6309 /**
6310 * Wrapper class holding an Intent and implementing comparisons on it for
6311 * the purpose of filtering. The class implements its
6312 * {@link #equals equals()} and {@link #hashCode hashCode()} methods as
6313 * simple calls to {@link Intent#filterEquals(Intent)} filterEquals()} and
6314 * {@link android.content.Intent#filterHashCode()} filterHashCode()}
6315 * on the wrapped Intent.
6316 */
6317 public static final class FilterComparison {
6318 private final Intent mIntent;
6319 private final int mHashCode;
6320
6321 public FilterComparison(Intent intent) {
6322 mIntent = intent;
6323 mHashCode = intent.filterHashCode();
6324 }
6325
6326 /**
6327 * Return the Intent that this FilterComparison represents.
6328 * @return Returns the Intent held by the FilterComparison. Do
6329 * not modify!
6330 */
6331 public Intent getIntent() {
6332 return mIntent;
6333 }
6334
6335 @Override
6336 public boolean equals(Object obj) {
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006337 if (obj instanceof FilterComparison) {
6338 Intent other = ((FilterComparison)obj).mIntent;
6339 return mIntent.filterEquals(other);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006340 }
The Android Open Source Project9066cfe2009-03-03 19:31:44 -08006341 return false;
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006342 }
6343
6344 @Override
6345 public int hashCode() {
6346 return mHashCode;
6347 }
6348 }
6349
6350 /**
6351 * Determine if two intents are the same for the purposes of intent
6352 * resolution (filtering). That is, if their action, data, type,
6353 * class, and categories are the same. This does <em>not</em> compare
6354 * any extra data included in the intents.
6355 *
6356 * @param other The other Intent to compare against.
6357 *
6358 * @return Returns true if action, data, type, class, and categories
6359 * are the same.
6360 */
6361 public boolean filterEquals(Intent other) {
6362 if (other == null) {
6363 return false;
6364 }
6365 if (mAction != other.mAction) {
6366 if (mAction != null) {
6367 if (!mAction.equals(other.mAction)) {
6368 return false;
6369 }
6370 } else {
6371 if (!other.mAction.equals(mAction)) {
6372 return false;
6373 }
6374 }
6375 }
6376 if (mData != other.mData) {
6377 if (mData != null) {
6378 if (!mData.equals(other.mData)) {
6379 return false;
6380 }
6381 } else {
6382 if (!other.mData.equals(mData)) {
6383 return false;
6384 }
6385 }
6386 }
6387 if (mType != other.mType) {
6388 if (mType != null) {
6389 if (!mType.equals(other.mType)) {
6390 return false;
6391 }
6392 } else {
6393 if (!other.mType.equals(mType)) {
6394 return false;
6395 }
6396 }
6397 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006398 if (mPackage != other.mPackage) {
6399 if (mPackage != null) {
6400 if (!mPackage.equals(other.mPackage)) {
6401 return false;
6402 }
6403 } else {
6404 if (!other.mPackage.equals(mPackage)) {
6405 return false;
6406 }
6407 }
6408 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006409 if (mComponent != other.mComponent) {
6410 if (mComponent != null) {
6411 if (!mComponent.equals(other.mComponent)) {
6412 return false;
6413 }
6414 } else {
6415 if (!other.mComponent.equals(mComponent)) {
6416 return false;
6417 }
6418 }
6419 }
6420 if (mCategories != other.mCategories) {
6421 if (mCategories != null) {
6422 if (!mCategories.equals(other.mCategories)) {
6423 return false;
6424 }
6425 } else {
6426 if (!other.mCategories.equals(mCategories)) {
6427 return false;
6428 }
6429 }
6430 }
6431
6432 return true;
6433 }
6434
6435 /**
6436 * Generate hash code that matches semantics of filterEquals().
6437 *
6438 * @return Returns the hash value of the action, data, type, class, and
6439 * categories.
6440 *
6441 * @see #filterEquals
6442 */
6443 public int filterHashCode() {
6444 int code = 0;
6445 if (mAction != null) {
6446 code += mAction.hashCode();
6447 }
6448 if (mData != null) {
6449 code += mData.hashCode();
6450 }
6451 if (mType != null) {
6452 code += mType.hashCode();
6453 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006454 if (mPackage != null) {
6455 code += mPackage.hashCode();
6456 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006457 if (mComponent != null) {
6458 code += mComponent.hashCode();
6459 }
6460 if (mCategories != null) {
6461 code += mCategories.hashCode();
6462 }
6463 return code;
6464 }
6465
6466 @Override
6467 public String toString() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006468 StringBuilder b = new StringBuilder(128);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006469
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006470 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006471 toShortString(b, true, true, true, false);
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006472 b.append(" }");
6473
6474 return b.toString();
6475 }
6476
6477 /** @hide */
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006478 public String toInsecureString() {
6479 StringBuilder b = new StringBuilder(128);
6480
6481 b.append("Intent { ");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006482 toShortString(b, false, true, true, false);
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006483 b.append(" }");
6484
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006485 return b.toString();
6486 }
Romain Guy4969af72009-06-17 10:53:19 -07006487
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006488 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006489 public String toInsecureStringWithClip() {
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006490 StringBuilder b = new StringBuilder(128);
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006491
6492 b.append("Intent { ");
6493 toShortString(b, false, true, true, true);
6494 b.append(" }");
6495
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006496 return b.toString();
6497 }
6498
6499 /** @hide */
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006500 public String toShortString(boolean secure, boolean comp, boolean extras, boolean clip) {
6501 StringBuilder b = new StringBuilder(128);
6502 toShortString(b, secure, comp, extras, clip);
6503 return b.toString();
6504 }
6505
6506 /** @hide */
6507 public void toShortString(StringBuilder b, boolean secure, boolean comp, boolean extras,
6508 boolean clip) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006509 boolean first = true;
6510 if (mAction != null) {
6511 b.append("act=").append(mAction);
6512 first = false;
6513 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006514 if (mCategories != null) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006515 if (!first) {
6516 b.append(' ');
6517 }
6518 first = false;
6519 b.append("cat=[");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006520 Iterator<String> i = mCategories.iterator();
6521 boolean didone = false;
6522 while (i.hasNext()) {
6523 if (didone) b.append(",");
6524 didone = true;
6525 b.append(i.next());
6526 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006527 b.append("]");
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006528 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006529 if (mData != null) {
6530 if (!first) {
6531 b.append(' ');
6532 }
6533 first = false;
Wink Savillea4288072010-10-12 12:36:38 -07006534 b.append("dat=");
Dianne Hackborn90c52de2011-09-23 12:57:44 -07006535 if (secure) {
6536 b.append(mData.toSafeString());
Wink Savillea4288072010-10-12 12:36:38 -07006537 } else {
6538 b.append(mData);
6539 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006540 }
6541 if (mType != null) {
6542 if (!first) {
6543 b.append(' ');
6544 }
6545 first = false;
6546 b.append("typ=").append(mType);
6547 }
6548 if (mFlags != 0) {
6549 if (!first) {
6550 b.append(' ');
6551 }
6552 first = false;
6553 b.append("flg=0x").append(Integer.toHexString(mFlags));
6554 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006555 if (mPackage != null) {
6556 if (!first) {
6557 b.append(' ');
6558 }
6559 first = false;
6560 b.append("pkg=").append(mPackage);
6561 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006562 if (comp && mComponent != null) {
6563 if (!first) {
6564 b.append(' ');
6565 }
6566 first = false;
6567 b.append("cmp=").append(mComponent.flattenToShortString());
6568 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006569 if (mSourceBounds != null) {
6570 if (!first) {
6571 b.append(' ');
6572 }
6573 first = false;
6574 b.append("bnds=").append(mSourceBounds.toShortString());
6575 }
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006576 if (mClipData != null) {
6577 if (!first) {
6578 b.append(' ');
6579 }
6580 first = false;
6581 if (clip) {
6582 b.append("clip={");
6583 mClipData.toShortString(b);
6584 b.append('}');
6585 } else {
6586 b.append("(has clip)");
6587 }
6588 }
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006589 if (extras && mExtras != null) {
6590 if (!first) {
6591 b.append(' ');
6592 }
6593 first = false;
6594 b.append("(has extras)");
6595 }
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006596 if (mSelector != null) {
6597 b.append(" sel={");
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006598 mSelector.toShortString(b, secure, comp, extras, clip);
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006599 b.append("}");
6600 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006601 }
6602
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006603 /**
6604 * Call {@link #toUri} with 0 flags.
6605 * @deprecated Use {@link #toUri} instead.
6606 */
6607 @Deprecated
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006608 public String toURI() {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006609 return toUri(0);
6610 }
6611
6612 /**
6613 * Convert this Intent into a String holding a URI representation of it.
6614 * The returned URI string has been properly URI encoded, so it can be
6615 * used with {@link Uri#parse Uri.parse(String)}. The URI contains the
6616 * Intent's data as the base URI, with an additional fragment describing
6617 * the action, categories, type, flags, package, component, and extras.
Tom Taylord4a47292009-12-21 13:59:18 -08006618 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006619 * <p>You can convert the returned string back to an Intent with
6620 * {@link #getIntent}.
Tom Taylord4a47292009-12-21 13:59:18 -08006621 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006622 * @param flags Additional operating flags. Either 0 or
6623 * {@link #URI_INTENT_SCHEME}.
Tom Taylord4a47292009-12-21 13:59:18 -08006624 *
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006625 * @return Returns a URI encoding URI string describing the entire contents
6626 * of the Intent.
6627 */
6628 public String toUri(int flags) {
Dianne Hackborn1d442e02009-04-20 18:14:05 -07006629 StringBuilder uri = new StringBuilder(128);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006630 String scheme = null;
6631 if (mData != null) {
6632 String data = mData.toString();
6633 if ((flags&URI_INTENT_SCHEME) != 0) {
6634 final int N = data.length();
6635 for (int i=0; i<N; i++) {
6636 char c = data.charAt(i);
6637 if ((c >= 'a' && c <= 'z') || (c >= 'A' && c <= 'Z')
6638 || c == '.' || c == '-') {
6639 continue;
6640 }
6641 if (c == ':' && i > 0) {
6642 // Valid scheme.
6643 scheme = data.substring(0, i);
6644 uri.append("intent:");
6645 data = data.substring(i+1);
6646 break;
6647 }
Tom Taylord4a47292009-12-21 13:59:18 -08006648
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006649 // No scheme.
6650 break;
6651 }
6652 }
6653 uri.append(data);
Tom Taylord4a47292009-12-21 13:59:18 -08006654
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006655 } else if ((flags&URI_INTENT_SCHEME) != 0) {
6656 uri.append("intent:");
6657 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006658
6659 uri.append("#Intent;");
6660
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006661 toUriInner(uri, scheme, flags);
6662 if (mSelector != null) {
6663 uri.append("SEL;");
6664 // Note that for now we are not going to try to handle the
6665 // data part; not clear how to represent this as a URI, and
6666 // not much utility in it.
6667 mSelector.toUriInner(uri, null, flags);
6668 }
6669
6670 uri.append("end");
6671
6672 return uri.toString();
6673 }
6674
6675 private void toUriInner(StringBuilder uri, String scheme, int flags) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006676 if (scheme != null) {
6677 uri.append("scheme=").append(scheme).append(';');
6678 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006679 if (mAction != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006680 uri.append("action=").append(Uri.encode(mAction)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006681 }
6682 if (mCategories != null) {
6683 for (String category : mCategories) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006684 uri.append("category=").append(Uri.encode(category)).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006685 }
6686 }
6687 if (mType != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006688 uri.append("type=").append(Uri.encode(mType, "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006689 }
6690 if (mFlags != 0) {
6691 uri.append("launchFlags=0x").append(Integer.toHexString(mFlags)).append(';');
6692 }
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006693 if (mPackage != null) {
6694 uri.append("package=").append(Uri.encode(mPackage)).append(';');
6695 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006696 if (mComponent != null) {
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006697 uri.append("component=").append(Uri.encode(
6698 mComponent.flattenToShortString(), "/")).append(';');
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006699 }
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006700 if (mSourceBounds != null) {
6701 uri.append("sourceBounds=")
6702 .append(Uri.encode(mSourceBounds.flattenToString()))
6703 .append(';');
6704 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006705 if (mExtras != null) {
6706 for (String key : mExtras.keySet()) {
6707 final Object value = mExtras.get(key);
6708 char entryType =
6709 value instanceof String ? 'S' :
6710 value instanceof Boolean ? 'B' :
6711 value instanceof Byte ? 'b' :
6712 value instanceof Character ? 'c' :
6713 value instanceof Double ? 'd' :
6714 value instanceof Float ? 'f' :
6715 value instanceof Integer ? 'i' :
6716 value instanceof Long ? 'l' :
6717 value instanceof Short ? 's' :
6718 '\0';
6719
6720 if (entryType != '\0') {
6721 uri.append(entryType);
6722 uri.append('.');
6723 uri.append(Uri.encode(key));
6724 uri.append('=');
6725 uri.append(Uri.encode(value.toString()));
6726 uri.append(';');
6727 }
6728 }
6729 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006730 }
The Android Open Source Project10592532009-03-18 17:39:46 -07006731
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006732 public int describeContents() {
6733 return (mExtras != null) ? mExtras.describeContents() : 0;
6734 }
6735
6736 public void writeToParcel(Parcel out, int flags) {
6737 out.writeString(mAction);
6738 Uri.writeToParcel(out, mData);
6739 out.writeString(mType);
6740 out.writeInt(mFlags);
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006741 out.writeString(mPackage);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006742 ComponentName.writeToParcel(mComponent, out);
6743
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006744 if (mSourceBounds != null) {
6745 out.writeInt(1);
6746 mSourceBounds.writeToParcel(out, flags);
6747 } else {
6748 out.writeInt(0);
6749 }
6750
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006751 if (mCategories != null) {
6752 out.writeInt(mCategories.size());
6753 for (String category : mCategories) {
6754 out.writeString(category);
6755 }
6756 } else {
6757 out.writeInt(0);
6758 }
6759
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006760 if (mSelector != null) {
6761 out.writeInt(1);
6762 mSelector.writeToParcel(out, flags);
6763 } else {
6764 out.writeInt(0);
6765 }
6766
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006767 if (mClipData != null) {
6768 out.writeInt(1);
6769 mClipData.writeToParcel(out, flags);
6770 } else {
6771 out.writeInt(0);
6772 }
6773
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006774 out.writeBundle(mExtras);
6775 }
6776
6777 public static final Parcelable.Creator<Intent> CREATOR
6778 = new Parcelable.Creator<Intent>() {
6779 public Intent createFromParcel(Parcel in) {
6780 return new Intent(in);
6781 }
6782 public Intent[] newArray(int size) {
6783 return new Intent[size];
6784 }
6785 };
6786
Dianne Hackborneb034652009-09-07 00:49:58 -07006787 /** @hide */
6788 protected Intent(Parcel in) {
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006789 readFromParcel(in);
6790 }
6791
6792 public void readFromParcel(Parcel in) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006793 setAction(in.readString());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006794 mData = Uri.CREATOR.createFromParcel(in);
6795 mType = in.readString();
6796 mFlags = in.readInt();
Dianne Hackbornc14b9cc2009-06-17 18:02:12 -07006797 mPackage = in.readString();
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006798 mComponent = ComponentName.readFromParcel(in);
6799
Joe Onoratoc7a63ee2009-12-02 21:13:17 -08006800 if (in.readInt() != 0) {
6801 mSourceBounds = Rect.CREATOR.createFromParcel(in);
6802 }
6803
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006804 int N = in.readInt();
6805 if (N > 0) {
6806 mCategories = new HashSet<String>();
6807 int i;
6808 for (i=0; i<N; i++) {
Jeff Brown2c376fc2011-01-28 17:34:01 -08006809 mCategories.add(in.readString().intern());
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006810 }
6811 } else {
6812 mCategories = null;
6813 }
6814
Dianne Hackbornf5b86712011-12-05 17:42:41 -08006815 if (in.readInt() != 0) {
6816 mSelector = new Intent(in);
6817 }
6818
Dianne Hackborn21c241e2012-03-08 13:57:23 -08006819 if (in.readInt() != 0) {
6820 mClipData = new ClipData(in);
6821 }
6822
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006823 mExtras = in.readBundle();
6824 }
6825
6826 /**
6827 * Parses the "intent" element (and its children) from XML and instantiates
6828 * an Intent object. The given XML parser should be located at the tag
6829 * where parsing should start (often named "intent"), from which the
6830 * basic action, data, type, and package and class name will be
6831 * retrieved. The function will then parse in to any child elements,
6832 * looking for <category android:name="xxx"> tags to add categories and
6833 * <extra android:name="xxx" android:value="yyy"> to attach extra data
6834 * to the intent.
6835 *
6836 * @param resources The Resources to use when inflating resources.
6837 * @param parser The XML parser pointing at an "intent" tag.
6838 * @param attrs The AttributeSet interface for retrieving extended
6839 * attribute data at the current <var>parser</var> location.
6840 * @return An Intent object matching the XML data.
6841 * @throws XmlPullParserException If there was an XML parsing error.
6842 * @throws IOException If there was an I/O error.
6843 */
6844 public static Intent parseIntent(Resources resources, XmlPullParser parser, AttributeSet attrs)
6845 throws XmlPullParserException, IOException {
6846 Intent intent = new Intent();
6847
6848 TypedArray sa = resources.obtainAttributes(attrs,
6849 com.android.internal.R.styleable.Intent);
6850
6851 intent.setAction(sa.getString(com.android.internal.R.styleable.Intent_action));
6852
6853 String data = sa.getString(com.android.internal.R.styleable.Intent_data);
6854 String mimeType = sa.getString(com.android.internal.R.styleable.Intent_mimeType);
6855 intent.setDataAndType(data != null ? Uri.parse(data) : null, mimeType);
6856
6857 String packageName = sa.getString(com.android.internal.R.styleable.Intent_targetPackage);
6858 String className = sa.getString(com.android.internal.R.styleable.Intent_targetClass);
6859 if (packageName != null && className != null) {
6860 intent.setComponent(new ComponentName(packageName, className));
6861 }
6862
6863 sa.recycle();
6864
6865 int outerDepth = parser.getDepth();
6866 int type;
6867 while ((type=parser.next()) != XmlPullParser.END_DOCUMENT
6868 && (type != XmlPullParser.END_TAG || parser.getDepth() > outerDepth)) {
6869 if (type == XmlPullParser.END_TAG || type == XmlPullParser.TEXT) {
6870 continue;
6871 }
6872
6873 String nodeName = parser.getName();
6874 if (nodeName.equals("category")) {
6875 sa = resources.obtainAttributes(attrs,
6876 com.android.internal.R.styleable.IntentCategory);
6877 String cat = sa.getString(com.android.internal.R.styleable.IntentCategory_name);
6878 sa.recycle();
6879
6880 if (cat != null) {
6881 intent.addCategory(cat);
6882 }
6883 XmlUtils.skipCurrentTag(parser);
6884
6885 } else if (nodeName.equals("extra")) {
The Android Open Source Projectf013e1a2008-12-17 18:05:43 -08006886 if (intent.mExtras == null) {
6887 intent.mExtras = new Bundle();
6888 }
6889 resources.parseBundleExtra("extra", attrs, intent.mExtras);
6890 XmlUtils.skipCurrentTag(parser);
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07006891
6892 } else {
6893 XmlUtils.skipCurrentTag(parser);
6894 }
6895 }
6896
6897 return intent;
6898 }
Nick Pellyccae4122012-01-09 14:12:58 -08006899
6900 /**
6901 * Normalize a MIME data type.
6902 *
6903 * <p>A normalized MIME type has white-space trimmed,
6904 * content-type parameters removed, and is lower-case.
6905 * This aligns the type with Android best practices for
6906 * intent filtering.
6907 *
6908 * <p>For example, "text/plain; charset=utf-8" becomes "text/plain".
6909 * "text/x-vCard" becomes "text/x-vcard".
6910 *
6911 * <p>All MIME types received from outside Android (such as user input,
6912 * or external sources like Bluetooth, NFC, or the Internet) should
6913 * be normalized before they are used to create an Intent.
6914 *
6915 * @param type MIME data type to normalize
6916 * @return normalized MIME data type, or null if the input was null
6917 * @see {@link #setType}
6918 * @see {@link #setTypeAndNormalize}
6919 */
6920 public static String normalizeMimeType(String type) {
6921 if (type == null) {
6922 return null;
6923 }
6924
6925 type = type.trim().toLowerCase(Locale.US);
6926
6927 final int semicolonIndex = type.indexOf(';');
6928 if (semicolonIndex != -1) {
6929 type = type.substring(0, semicolonIndex);
6930 }
6931 return type;
6932 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006933
6934 /**
6935 * Migrate any {@link #EXTRA_STREAM} in {@link #ACTION_SEND} and
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006936 * {@link #ACTION_SEND_MULTIPLE} to {@link ClipData}. Also inspects nested
6937 * intents in {@link #ACTION_CHOOSER}.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006938 *
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006939 * @return Whether any contents were migrated.
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006940 * @hide
6941 */
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006942 public boolean migrateExtraStreamToClipData() {
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006943 // Refuse to touch if extras already parcelled
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006944 if (mExtras != null && mExtras.isParcelled()) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006945
6946 // Bail when someone already gave us ClipData
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006947 if (getClipData() != null) return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006948
6949 final String action = getAction();
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006950 if (ACTION_CHOOSER.equals(action)) {
Jeff Sharkey1c297002012-05-18 13:55:47 -07006951 try {
6952 // Inspect target intent to see if we need to migrate
6953 final Intent target = getParcelableExtra(EXTRA_INTENT);
6954 if (target != null && target.migrateExtraStreamToClipData()) {
6955 // Since we migrated in child, we need to promote ClipData
6956 // and flags to ourselves to grant.
6957 setClipData(target.getClipData());
6958 addFlags(target.getFlags()
6959 & (FLAG_GRANT_READ_URI_PERMISSION | FLAG_GRANT_WRITE_URI_PERMISSION));
6960 return true;
6961 } else {
6962 return false;
6963 }
6964 } catch (ClassCastException e) {
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006965 }
6966
6967 } else if (ACTION_SEND.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006968 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006969 final Uri stream = getParcelableExtra(EXTRA_STREAM);
6970 final CharSequence text = getCharSequenceExtra(EXTRA_TEXT);
6971 final String htmlText = getStringExtra(EXTRA_HTML_TEXT);
6972 if (stream != null || text != null || htmlText != null) {
6973 final ClipData clipData = new ClipData(
6974 null, new String[] { getType() },
6975 new ClipData.Item(text, htmlText, null, stream));
6976 setClipData(clipData);
6977 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006978 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006979 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006980 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006981 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07006982
6983 } else if (ACTION_SEND_MULTIPLE.equals(action)) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07006984 try {
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006985 final ArrayList<Uri> streams = getParcelableArrayListExtra(EXTRA_STREAM);
6986 final ArrayList<CharSequence> texts = getCharSequenceArrayListExtra(EXTRA_TEXT);
6987 final ArrayList<String> htmlTexts = getStringArrayListExtra(EXTRA_HTML_TEXT);
6988 int num = -1;
6989 if (streams != null) {
6990 num = streams.size();
6991 }
6992 if (texts != null) {
6993 if (num >= 0 && num != texts.size()) {
6994 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07006995 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07006996 }
6997 num = texts.size();
6998 }
6999 if (htmlTexts != null) {
7000 if (num >= 0 && num != htmlTexts.size()) {
7001 // Wha...! F- you.
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007002 return false;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007003 }
7004 num = htmlTexts.size();
7005 }
7006 if (num > 0) {
7007 final ClipData clipData = new ClipData(
7008 null, new String[] { getType() },
7009 makeClipItem(streams, texts, htmlTexts, 0));
7010
7011 for (int i = 1; i < num; i++) {
7012 clipData.addItem(makeClipItem(streams, texts, htmlTexts, i));
7013 }
7014
7015 setClipData(clipData);
7016 addFlags(FLAG_GRANT_READ_URI_PERMISSION);
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007017 return true;
Jeff Sharkeydd471e62012-05-01 13:07:01 -07007018 }
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007019 } catch (ClassCastException e) {
Jeff Sharkeyf27ea662012-03-27 10:34:24 -07007020 }
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007021 }
Jeff Sharkey3b7d1ef2012-05-14 17:21:10 -07007022
7023 return false;
Jeff Sharkey678d04f2012-03-23 15:41:58 -07007024 }
Dianne Hackbornac4243f2012-04-13 17:32:18 -07007025
7026 private static ClipData.Item makeClipItem(ArrayList<Uri> streams, ArrayList<CharSequence> texts,
7027 ArrayList<String> htmlTexts, int which) {
7028 Uri uri = streams != null ? streams.get(which) : null;
7029 CharSequence text = texts != null ? texts.get(which) : null;
7030 String htmlText = htmlTexts != null ? htmlTexts.get(which) : null;
7031 return new ClipData.Item(text, htmlText, null, uri);
7032 }
The Android Open Source Project54b6cfa2008-10-21 07:00:00 -07007033}